Preface
Revised: Aug 30, 2011, OL-1116-24
This preface describes the objectives of this document and explains how to find additional information
on related products and services. It contains the following sections:
•
Document Objective, page 1
•
Audience, page 1
•
Related Documentation, page 1
•
Obtaining Documentation and Submitting a Service Request, page 2
Document Objective
This guide provides reference information for the Release 9 Man-Machine Language (MML) commands
used to provision the Cisco PGW 2200 Softswitch. Read the system-level documentation supplied with
the system before using this guide.
Audience
This guide is for network operators and administrators who have experience with telecommunications
networks, protocols, and equipment and who have familiarity with data communications networks,
protocols, and equipment.
Related Documentation
This document contains information that is related to Cisco PGW 2200 Softswitch MML commands.
For additional information on other system-level documents, see the documents at this URL:
http://www.cisco.com/en/US/products/hw/vcallcon/ps2027/tsd_products_support_series_home.html
You can find the Cisco PGW 2200 Softswitch Documentation Map at the following URL:
http://www.cisco.com/en/US/products/hw/vcallcon/ps2027/products_documentation_roadmaps_list.ht
ml
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1
Other useful reference publications include:
•
Overviews of the related telephony solutions—Describe the Cisco telephony solutions with which
the Cisco PGW 2200 Softswitch node is associated
•
Provisioning guides for the related telephony solutions—Describe the provisioning steps for the
Cisco telephony solutions with which the Cisco PGW 2200 Softswitch node is associated
•
Solution gateway installation and configuration guides—Describe the steps for installing and
configuring the media gateway for a particular Cisco telephony solution
•
Cisco IP Transfer Point - LinkExtender—Describes the Cisco IP Transfer Point - LinkExtender
(Cisco IPT-L, formerly known as the Cisco Signaling Link Terminal or Cisco SLT) and provides
configuration information
Obtaining Documentation and Submitting a Service Request
For information on obtaining documentation, submitting a service request, and gathering additional
information, see the monthly What’s New in Cisco Product Documentation, which also lists all new and
revised Cisco technical documentation at
http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html
Subscribe to the What’s New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed
and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free
service and Cisco currently supports RSS version 2.0.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
2
OL-1116-24
CH A P T E R
1
MML Command Overview
Revised: Aug 30, 2011, OL-1116-24
This guide describes each of the Man-Machine Language (MML) commands you can use with the
Cisco PGW 2200 Softswitch. Use MML to configure your Cisco PGW 2200 Softswitch, add
components to your system, retrieve information about system components, and perform logging and
tracing.
How to Use This Guide
This guide is a comprehensive reference to the commands. You can use this document to look up detailed
information on all commands, components, parameters, properties, value ranges, and default values. It
should be used in conjunction with the following documents, which provide the provisioning,
maintenance, and troubleshooting procedures that use these MML commands:
•
For information on using MML commands for component provisioning, see
Cisco PGW 2200 Softswitch Release 9 Provisioning Guide (through Release 9.7) at:
http://www.cisco.com/en/US/docs/voice_ip_comm/pgw/9/provisioning/guide/R9prvgde.html
or Cisco PGW 2200 Softswitch Release 9.8 Provisioning Guide at:
http://www.cisco.com/en/US/docs/voice_ip_comm/pgw/9.8/Provisioning/Guide/prvgde98.html
•
For more information on using MML commands for provisioning the dial plan, see
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7) at:
http://www.cisco.com/en/US/docs/voice_ip_comm/pgw/9/dial_plan/guide/dplan.html
or Cisco PGW 2200 Softswitch Release 9.8 Dial Plan Guide at:
http://www.cisco.com/en/US/docs/voice_ip_comm/pgw/9.8/Dial_Plan/Guide/Dplan98.html
•
For more information on using MML commands for maintenance and troubleshooting, see
Cisco PGW 2200 Softswitch Release 9 Operations, Maintenance, and Troubleshooting Guide at:
http://www.cisco.com/en/US/docs/voice_ip_comm/pgw/9/maintenance/guide/omtguide.html
or Cisco PGW 2200 Softswitch Release 9.8 Operations, Maintenance, and Troubleshooting Guide
at:
http://www.cisco.com/en/US/docs/voice_ip_comm/pgw/9.8/Maintenance/Guide/98omtguide.html
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-1
Chapter 1
MML Command Overview
Information Covered in This Chapter
Information Covered in This Chapter
This chapter describes MML command syntax, conventions used with MML commands, and responses
expected from MML. It includes the following sections:
•
MML Command Guidelines, page 1-2
•
MML Basics, page 1-3
•
MML on High-Availability Systems, page 1-5
•
MML Command Conventions, page 1-5
•
Wildcards in MML Commands, page 1-6
•
MML Messages, page 1-7
•
Impact of MML Commands on Cisco PGW 2200 Softswitch Call Processing, page 1-9
MML Command Guidelines
MML commands use the following syntax:
command_name:[component][, component][, component. . .][:Parameter_List][;comments]
When entering MML commands, remember the following:
•
MML component names must be 16 characters or shorter.
•
In general, MML commands are not case sensitive, but some are (ExtCOT is an example of a
case-sensitive command). However, property values are case sensitive.
•
Neither keywords nor value strings need to be enclosed in quotation marks, except where specified
in this guide.
•
Use only one MML command on each line.
•
Anything entered after a semicolon (;) is treated as a comment. This is primarily useful for MML
command scripts.
•
Do not use punctuation (such as the period character) for target names; for example, do not use
test.log as a logging destination.
•
Create an ASCII text file for batch processing of provisioning commands. For more information
about performing batch provisioning, see Cisco PGW 2200 Softswitch Release 9 Provisioning
Guide at:
http://www.cisco.com/en/US/docs/voice_ip_comm/pgw/9/provisioning/guide/R9prvgde.html
Timesaver
MML maintains a history buffer of all MML commands you enter during an MML session. To repeat
your last MML command, press the Up Arrow at the MML prompt to redisplay the command, and press
Enter. Press the Up and Down Arrow keys to scroll through all commands in the history buffer. To
modify and re-enter a command, use the Up Arrow to display the command, and then edit the command
using the keyboard. Press Enter to execute the command.
While viewing a lengthy response to an MML command, press the spacebar to display the next screen
of output text, or press Enter to display the next line.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-2
OL-1116-24
Chapter 1
MML Command Overview
MML Basics
MML Basics
You must start an interactive MML session before you can use MML commands for provisioning,
information retrieval, or troubleshooting. As many as 12 MML sessions can be open at a time, but only
one provisioning session is permitted.
If an MML provisioning session is inactive for 30 minutes, a warning is issued by the
Cisco PGW 2200 Softswitch. After 5 additional minutes of inactivity, the session is terminated.
Note
It is possible to run only one current MML provisioning session on the Cisco PGW 2200 Softswitch, but
other administrative commands can be run from one or more additional MML sessions. However, you
should avoid running simultaneous MML sessions because doing so can affect performance.
Starting an MML Session
Perform the following steps to start an MML session:
Step 1
Caution
Step 2
Log in to the Cisco PGW 2200 Softswitch host computer from a terminal.
Do not log in as UNIX root; if you attempt to start an MML session as the root user, the
Cisco PGW 2200 Softswitch displays a message and MML fails to start.
At a UNIX command prompt, type:
MGC% mml
The Cisco PGW 2200 Softswitch responds with the status of your MML session.
If your UNIX prompt looks similar to the following, your session has started successfully, and you can
begin entering MML commands.
MGC:mml>
If another MML session is running, you receive a message similar to the following:
MGC% mml1: Already in use
Failure to run MML, reason=Entry was already present.
Step 3
To start another MML session, enter the following command:
MGC% mml -s 2
The Cisco PGW 2200 Softswitch responds with an MML session prompt.
Note
The MML command mml -s 2 starts the second MML session, and mml -s 3 starts the third session.
There can be as many as 12 MML sessions open at a time.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-3
Chapter 1
MML Command Overview
MML Basics
Saving an MML Session for Review
To save a provisioning session for later review, perform the following procedure:
Step 1
Create a log file of the provisioning session, cie3, for later review, by entering the following command:
mml> diaglog:pom-log-session-cie3:start
All MML commands entered are now logged to the mml.log file located in /opt/CiscoMGC/var/log
directory.
Step 2
Stop logging the provisioning session, cie3, by entering the following command:
mml> diaglog:pom-log-session-cie3:stop
The log file of the provisioning session can now be reviewed using an ASCII text editor.
Step 3
Create a new configuration, cie3-prov, by entering the following command:
mml> prov-sta::srcver=”new”,dstver=”cie3-prov”
Stopping an MML Session
To stop an MML session, enter the quit command:
MGC mml>quit
MGC%
Killing an MML Session
If an MML session cannot be stopped with the quit command, or if another MML session is running,
you can kill the session by performing the following steps:
Step 1
Close MML by entering the quit command, or telnet to the host server where the MML session is
running.
Step 2
To kill an MML session started by another user, log in as root.
Step 3
At the UNIX prompt, enter the following command:
va-purple% ps -ef | grep mml
The host server responds with information similar to the following:
MGCUSR 17999 17989 0 13:30:44 pts/2 0:00 mml
Step 4
Locate the process entry for the MML session you want to kill, and determine the process number of the
session. In the preceding example, the process number is 17999. Enter the following command:
kill -9 xxxxx
where: xxxxx is the process number of the MML session.
Step 5
To kill multiple MML sessions, enter a UNIX kill command for each MML session. Each session will
have a unique process number.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-4
OL-1116-24
Chapter 1
MML Command Overview
MML on High-Availability Systems
Killing an Orphan Configuration Session
To kill a nonfunctioning configuration session, enter the prov-stp command at the MML prompt.
Note that this command does not activate the new configuration.
Getting Help
To display a list of all MML commands, enter help at the MML prompt.
To get help for a specific command, enter help:<command> at the MML prompt. The following
example shows the help available for clr-tcap-trans:
MGC mml> help:clr-tcap-trans
CLR-TCAP-TRANS -- Clear TCAP Transactions
----------------------------------------Purpose:
This MML command clears all transaction capabilities
application part (TCAP) transactions that are older than
the specified period.
Format:
clr-tcap-trans::T=<number>
Input
Description:
Example:
* number -- The time period, in seconds, after which you
want to clear TCAP transactions.
The MML command shown in the following example clears all
TCAP transactions that are older than 60 seconds:
mml> CLR-TCAP-TRANS::T=60
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M RTRV
“TCAP-01:CLRD=0”
;
MML on High-Availability Systems
To check the state of a high-availability system, you must be using MML on the active server. Although
MML on the standby system shows checkpointed information, the updating is not instantaneous, and it
is not obvious which information gets checkpointed and which does not.
To determine which server is active and which is standby, use the rtrv-ne command.
MML Command Conventions
Conventions used in MML commands are described in this section.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-5
Chapter 1
MML Command Overview
Wildcards in MML Commands
Backus-Naur Conventions
MML commands use the Backus-Naur symbols shown in Table 1-1.
Table 1-1
MML Backus-Naur Conventions
Symbol
Description
|
Pipe indicates that the preceding symbol or the succeeding symbol can occur, but not
both in succession.
[]
Brackets enclose an optional parameter.
{|}
Preceding symbol or succeeding symbol can occur, but not both in succession. There
can be more than two symbols and pipes.
<>
Encloses an identifier to be replaced with appropriate data.
Bellcore TL1 Conventions
The structure of MML is based on the Telcordia (Bellcore) TL1 standard (TR-NWT-831, Operations
Application Message–Operations Applications Messages, Issue 3). Therefore, MML commands can be
interpreted and monitored through a network’s TL1 interface. The TL1 symbols shown in Table 1-2 are
used in MML.
Table 1-2
MML Bellcore TL1 Conventions
Symbol
Description
:
Parameter separator.
::
Empty parameter block.
&
Arguments are grouped together so that one parameter can convey several arguments.
;
End of command (optional). Anything on the same line after this symbol is treated as a
comment.
Wildcards in MML Commands
Some MML commands support the use of wildcards. For software Release 7.4 and earlier, wildcards are
available only as either postfix or prefix to MML names. The syntax for using wildcards with MML
commands is as follows:
<MML command name>:<*><part of TID MML name><*>:[optional parameters]
For example, there are two ways to retrieve administrative states of trunk groups using wildcards:
•
RTRV-ADMIN-STATE:TG* retrieves the administrative state of all trunk groups with MML
names starting with “TG”.
•
RTRV-ADMIN-STATE:*GP retrieves the administrative state of all trunk groups with MML
names ending with “GP”.
The following commands support wildcards:
•
ACK-ALM
•
RTRV-ADMIN-STATE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-6
OL-1116-24
Chapter 1
MML Command Overview
MML Messages
•
RTRV-DEST
•
RTRV-DCHAN
•
RTRV-C7LNK
•
RTRV-IPLNK
•
RTRV-TC
•
SET-ADMIN-STATE
•
SET-DEST-STATE
MML Messages
Messages that MML can display are described in this section.
MML Status Messages
After you enter an MML command, the system performs the task you requested and returns a status
message. Table 1-3 lists the MML status messages and descriptions.
.
Table 1-3
MML Status Messages
Status
Meaning
Definition
COMPLD
Completed
MML received a response from the subsystem on which
it performed the action.
Note
A completed response does not always signify
successful completion. A completed response
can be returned on invalid components, such as
alarms.
RTRV
Retrieve
MML is attempting to retrieve the contents specified.
SUCC
Successful
Successful completion.
SWDC
Waiting for dependent
processes to start
Status message—Waiting for dependent processes to
start.
SWDT
Waiting for dependent
processes to stop
Status message—Waiting for dependent processes to
stop. This is not an error. Enter the rtrv-softw command
to see if the dependent processes have stopped.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-7
Chapter 1
MML Command Overview
MML Messages
MML Error Codes
MML displays error codes if a command cannot be performed. Table 1-4 lists the MML error codes and
descriptions.
Table 1-4
MML Error Message Descriptions
Error Code
Meaning
Definition
DENY
Command denied
The command is recognized, but the system does not
allow you to perform the requested function.
ICNV
Input command not
valid
The MML command is not recognized.
IDNV
Input data not valid
An unknown parameter was entered.
Example:
mml> RESET-CIC:dpc2:cic5
Media Gateway Controller 2000-01-03 15:22:48
M RTRV
IDNV
“dpc2”
/* Input, Data Not Valid */
;
IIDV
Invalid data parameter
An unknown parameter was entered. An incorrect
parameter name has been used in the command, or a
value has been entered incorrectly.
Note
A string value must be surrounded by quotes, and
an integer value must not be surrounded by
quotes.
Example:
mml> RESET-CIC:dpc2:cic5
Media Gateway Controller 2000-01-03 15:22:48
M RTRV
IIDV
“dpc2”
/* Input, Data Not Valid */
;
IISP
Input syntax error
Incorrect syntax was used. A semicolon or comma has
been used incorrectly when entering the command.
Example:
mml> reset-cic:dpc9,cic22
Media Gateway Controller - MGC-01 2000-01-12
M RTRV
IISP
reset-cic:dpc9,
/* Input, Syntax Error */
;
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-8
OL-1116-24
Chapter 1
MML Command Overview
Impact of MML Commands on Cisco PGW 2200 Softswitch Call Processing
Table 1-4
MML Error Message Descriptions (continued)
Error Code
Meaning
Definition
IITA
Invalid target
The requested operation cannot be performed on the
network element component, or the component does not
exist in the system.
Example:
mml> reset-cic:dpc9:CIC=10
Media Gateway Controller - MGC-01 2000-01-12
15:19:51
M RTRV
IITA
"dpc9"
/* Input, Invalid Target */
;
IPRM
Input parameter missing An expected parameter cannot be found.
SABT
Status abort
The command did not finish in the time allocated.
SCNF
Status not found
There are problems with the engine.
SNVS
State not in valid state
The requested operation failed because the component is
not configured to accept the operation. It is possible that
the component is already performing the operation or is
already in the desired state.
SNSP
State not supported
This operation is not supported by the component.
SROF
Status requested
operation failed
The requested operation failed on the component.
Example:
mml> query-cic:dpc1:CIC=1,rng=1
Media Gateway Controller - MGC-01 2002-04-26
11:35:51
M RTRV
SROF
“dpc1”
/* Range is not allowed*/
;
Impact of MML Commands on Cisco PGW 2200 Softswitch Call
Processing
Some MML commands impact Cisco PGW 2200 Softswitch call processing when executed. A small
number of these commands can cause the system to go into an overload condition and limit the number
of incoming calls the Cisco PGW 2200 Softswitch is able to process. For this reason, some MML
commands should be issued only during periods of minimal call traffic. The performance impact of some
MML commands also varies with the number of data objects being accessed.
MML commands have been divided into categories depending on their impact on system performance.
See the “Performance Impact Category” section of a specific MML command for its performance
category and for additional guidelines designed to minimize performance impact. MML performance
impact categories are defined as follows:
•
Category A—These commands have minimal impact on system performance. Multiple MML
sessions are acceptable, and a maximum of four concurrent MML sessions is recommended.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-9
Chapter 1
MML Command Overview
Impact of MML Commands on Cisco PGW 2200 Softswitch Call Processing
•
Category B—These commands have a moderate impact on system performance, because CPU
utilization is high while these commands are executing. A maximum of one active MML session is
recommended.
•
Category C—These commands are similar to those in Category B and have a moderate impact on
system performance. However, CPU utilization is higher than for Category B because these
commands are executed while the system is simultaneously handling call traffic.
•
Category D—These commands have a severe impact on system performance and should be issued
only during a maintenance period when call traffic is minimal.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-10
OL-1116-24
CH A P T E R
1
Session-Level Commands
Revised: Aug 30, 2011, OL-1116-24
This chapter describes the Man-Machine Language (MML) session-level commands for the
Cisco PGW 2200 Softswitch Release 9.
H—Display History
Purpose:
Redisplays a command or a series of commands, depending on whether you enter a
specified number or a range. If no number is specified, the last command is displayed.
Syntax:
h[::<number>[,<number>]]
Input
Description:
Example:
•
number—(First number entered) specifies the first command to redisplay.
•
number—(Second number entered) specifies the last number of a range of
commands to display.
The MML command shown in the following example displays the last successful
command entered:
mml> H
Media Gateway Controller
M RTRV
“RTRV-TC:ALL”
/* command 1 */
;
Example:
- MGC-01 2000-01-12 15:19:51
The MML command shown in the following example displays the third previous
successful command entered:
mml> H::3
Media Gateway Controller
M RTRV
“RTRV-TC:ALL”
/* command 3 */
;
- MGC-01 2000-01-12 15:19:51
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-1
Chapter 1
Session-Level Commands
HELP
Example:
The MML command shown in the following example displays the second through fifth
previous successful commands you entered:
mml> H::2,5
Media Gateway Controller
M RTRV
“RTRV-IPLNK:ALL”
/* command 5 */
“RTRV-SOFTW:ALL”
/* command 4 */
“RTRV-TC:ALL”
/* command 3 */
“STP-AUD”
/* command 2 */
;
- MGC-01 2000-01-12 15:19:51
Comments:
Performance Impact Category: A
Purpose:
Provides either a list of MML commands, descriptions, and values (if no parameter is
given), or a description of a particular command (if the command name is entered as a
parameter).
Syntax:
help[:<command name>]
HELP
Input
Description:
•
command name—Name of the particular command for which you would like to
display a description.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-2
OL-1116-24
Chapter 1
Session-Level Commands
HELP
Example:
The MML command shown in the following example displays help for the SET-LOG
command:
mml> HELP:SET-LOG
MGC-01 - Media Gateway Controller 2001-12-17 15:47:40.705 EST
M RTRV
SET-LOG -- Set Logging Levels
----------------------------Purpose:
Sets the logging level of a process or all processes.
Format:
set-log:<proc>:<log level>
set-log:all:<log level>
Description: * proc -- The various actively and passively monitored
processes running on the Cisco MGC. Use the RTRV-SOFTW:ALL command to
display all processes.
* log level -- Sets the logging level for the specified
process. Logging levels are as follows:
- CRIT -- Critical level messages.
<Press 'SPACE' for next page, 'Enter' for next line or 'q' to quit this
output>
-
-
ERR
-- Error condition messages.
-
WARN
-- Warning condition messages.
-
INFO
-- Informational messages.
-
TRACE -- Trace messages.
DEBUG -- Debug-level messages (lowest level).
Logging at any given level implies upper levels are included. In other
words, setting the INFO logging level also sets the WARN, ERR, and CRIT
levels. The order of the levels shown above can also be viewed as a
verbosity level, in that at CRIT the least information is logged, and at
DEBUG the most information is logged.
Example:
The MML command shown in the following example sets the
logging level of PM-01 process to DEBUG:
mml> SET-LOG:PM-01:DEBUG
Media Gateway Controller - MGC-01 2000-01-16 09:38:03
M CMPLD
“PM-01:DEBUG”
;
Comments:
This command was introduced in Release 7.4 and replaces the
CHG-LOG command.
Note that the process manager (PM-01) is not included in the
“all” parameter, because it is a special process. The
logging level of PM-01 must be set individually, as in the
example above. Also, the DSKM-01 and LOG-01 (the disk
monitor and log server processes, respectively) do not
accept log-level change requests.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-3
Chapter 1
Session-Level Commands
HELP
Example:
The MML command shown in the following example displays the help file displayed if
no parameter is entered:
mml> HELP
ack-alm:<comp>:”<alm cat>”
Acknowledges an alarm category on a
component, or on all components
if comp=all
ack-alm:<comp>:”<alm sev>”
Acknowledges alarms with
alarm sev = <alm sev>
on a component, or on all components
if comp=all
ack-alm:<comp>:”all”
Acknowledges all alarms
on a component, or on all components
if comp=all
ack-alm:<comp>
Acknowledges all alarms
blk-cic:<sigpath>:CIC=<number>[,RNG=<slaves>]
Blocks a circuit or a circuit range
chg-dpl::CUSTGRPID=”<customer group ID>”
Reloads a dialing plan
chg-log:<proc>:<log level>
This command has been replaced by
set-log. Please refer to help on
set-log for further information
clr-meas:<comp>:”<alm cat>”
Resets a measurement category on a
component
clr-tcap-trans::T=<number>
Clears all TCAP transactions
older than value of T in seconds
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
-call:<dest_pc>:cic=<cic>,confirm
Forcefully releases a bearer channel
associated with a single call instance.
numan-add:<comp>:custgrpid=<cust group ID>,<param name>=<param value>,...
Adds an element to a dial plan table
numan-dlt:<comp>:custgrpid=<cust group ID>
Deletes an element from a dial plan
table
numan-ed:<comp>:custgrpid=<cust group ID>,<param name>=<param value>,...
Edits an element in a dial plan table
numan-rtrv:<comp>:custgrpid=<cust group ID>
Retrieves an element from a dial plan
table
numan-rtrv:<comp>:custgrpid=<cust group ID>,"all"
Retrieves all elements from a dial plan
table
prov-add:<comp>:name=<MML name>,<param name>=<param value>,...
Adds the component
prov-add:sippath:name=<MML name>,<param name>=<param value>,...
Adds SIP signal path
prov-add:siplnk:name=<MML name>,<param name>=<param value>,...
Adds SIP signal chan
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-4
OL-1116-24
Chapter 1
Session-Level Commands
HELP
prov-add:siprttrnkgrp:name=<MML name>,<param name>=<param value>,...
Adds SIP route trunk group
prov-add:lnksetprop:name=”<protocol family>”,<param name>=<param value>,...
Provisions linkset property parameters
prov-cpy
Commits provisioning data
prov-dlt:<comp>:name=<MML name>
Deletes the component
prov-dply
Deploys provisioning data
prov-ed:<comp>:name=<MML name>,<param name>=<param value>,...
Modifies the component attributes
prov-exp:<tid>:dirname="<export directory name>"
Exports provisioning data to the given
export directory name
tid can be one of the following:
all
config
signal
trkgrp
trunk
numan
routing
export directory name can be any
directory name, in double quotes,
which will be created under the
cust_specific directory
prov-rtrv:<comp>:name=<MML name> Retrieves the component attributes
prov-rtrv:all
Retrieves all the components
prov-rtrv:siprttrnkgrp:"all"
Retrieves all SIP route trunk group
information
prov-rtrv:session
Retrieves provisioning session
information if one exists
prov-rtrv:variants
Retrieves all variants
prov-rtrv:profiletypes
Retrieves all profile types
prov-sta::srcver=<version>,dstver=<version>,confirm
Starts a provisioning session
prov-stp
Stops the current provisioning
session
prov-stp:<session name>:confirm
Stops the specified provisioning
session
prov-sync
Synchronizes provisioning data
prt-call:<sig path>|<trk grp>:[CIC=<number>|SPAN=<number>[BC=<number>]]
[,LOG=<logname>] [,EVT]
Prints diagnostic information about an
active call into the log file
query-cic:<sigpath>:CIC=<number>[,RNG=<slaves>][,RSLV]
Performs a circuit query for a circuit
or a circuit range with an optional
RESOLVE parameter
quit
Ends the session
r[::<number>]
Repeats a previously entered command
with a specified backward number;
the last command by default
reset-cic:<sigpath>:CIC=<number>[,RNG=<slaves>]
Resets a circuit or a circuit range
rtrv-admin-state:<target>:<param>
Retrieves the administrative state
of the target;
target can be a MGC or gateway or
trunk group or signal path;param can be
one of the following combinations:
[span=number] or
[span=number,]bc=number[,RNG=number]
or
cic=number[,RNG=number]
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-5
Chapter 1
Session-Level Commands
HELP
rtrv-alms
rtrv-alms::CONT
Displays all active alarms
Displays all active alarms and listens
for alarm events until Ctrl-C
rtrv-aud-gw:<sig path MGCP>
Retrieves result of an auditing process
of a gateway
rtrv-aud-gw:all
Retrieves results of auditing processes
of all gateways
rtrv-cfg:<cfg table>
Displays contents of a configuration
table where table can be:
alarmCategories | components |
componentTypes | measCategories |
services | tables
rtrv-cic:<sigpath>:CIC=<number>[,RNG=<slaves>]
Retrieves bearer channels of a signal
path
rtrv-ctr:<comp>:"<meas cat>"
Retrieves a measurement of a component
rtrv-dest:<sigpath>
Retrieves state of a destination
(signal path)
rtrv-dest:all
Retrieves state of all destinations:
point codes and signal paths
rtrv-dns-info:<sig path SIP>
Retrieves DNS cache info
rtrv-iplnk:<IP link>
Displays attributes of an IP link
rtrv-iplnk:all
Displays attributes of all IP links
rtrv-lnk-ctr:<C7 link/set>
Retrieves all measurements of a link or
link set
rtrv-lnk-ctr:all
Retrieves all measurements of all links
rtrv-log:all
Displays logging level of all processes
rtrv-log:<proc>
Displays logging level of a process
rtrv-lset:<C7 link set>
Displays state of a link set
rtrv-lssn:all
Displays state of local SSN
rtrv-mml
Displays all active MML sessions
rtrv-ne
Displays attributes of the Network
Element
rtrv-ne-health
Displays health of the Network Element
(CPU/Memory utilization etc.)
rtrv-ovld
Displays overload level and number of
messages in a queue
rtrv-rssn:all
Displays state of remote SSN
rtrv-rte:<dpc name>
Retrieves all SS7 routes for a point
code
rtrv-rte:all
Retrieves SS7 routes for all point
codes
rtrv-dchan:<D channel | fas link> Displays attributes of a signal
channel
rtrv-dchan:all
Displays attributes of all D channels
rtrv-c7lnk:<C7 link set|C7 link> Displays attributes of a link(set)
rtrv-c7lnk:all
Displays attributes of all signal
channels and link sets
rtrv-sc-trc
Displays the names of all files
currently open for the various traces
in progress
rtrv-softw:<proc>
Displays status of a process or
process group
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-6
OL-1116-24
Chapter 1
Session-Level Commands
HELP
rtrv-softw:all
Displays status of all known processes
rtrv-softw:<point code>
Retrieves all measurements of a point
code
rtrv-sp-ctr:all
Retrieves all measurements of all point
codes
rtrv-spc:<point code>
Retrieves route set of a point code
rtrv-spc:all
Retrieves route sets of all point codes
rtrv-ss7-slt:<C7 link>
Retrieves result of an MTP SLT test on
a link (SS7 only)
rtrv-ss7-srt:<ss7path>:LSET="<C7 link/set>"
Retrieves result of an MTP SRT test on
a point code (Japanese SS7 only)
rtrv-tc:<sig path>&<sig path>... Displays state of bearers per signal
path(s)
rtrv-tc:all
Displays state of all bearers
rtrv-tc-held:<sig path>&<sig path>...
Displays state of bearers per signal
path(s) held by gateway
rtrv-tc-held:all
Displays state of all bearers, held by
gateway
rtrv-tcap-trans
Displays number of active TCAP
transactions
rtrv-thres::"<Meas Cat>"
Displays the threshold settings for
measurement category
set-admin-state:<target>:<param>,LOCK|UNLOCK|RESET
Sets the administrative state of
the target;
target can be a MGC or gateway or
trunk group or signal path;
param can be one of the following
combinations:
[span=number] or
[span=number,]bc=number[,RNG=number]
or
cic=number[,RNG=number]
set-dest-state:<sig path>:IS|OOS... replaced by set-dest
set-dest:<sig path>:IS|OOS|FOOS
Changes service state of signal path
set-iplnk:<IP link>:IS:OOS:FOOS
Changes the services state of an IP link
This command is disabled for NAS links
set-lnk-state:<C7 link/set>:IS|OOS|INH|UNH
Changes service state of a link or a
linkset
set-log:<proc>:<log level>
Sets logging level for process <proc>
set-log:<proc>:DEBUG,CONFIRM
Sets DEBUG logging level for <proc>
set-log:all:<log level>
Sets logging level for all processes.
logLevel can be:
DEBUG | TRACE | INFO | WARN | ERR |
CRIT
set-lssn-state::<SSN>,IS|OOS
Changes service state of a local SSN
set-c7lnk:<C7 IP or TDM SS7 link>:IS|OOS|FOOS|UNH|INH
Changes service state of a SS7 link
set-dchan:<FAS link|d-channel>:IS|OOS
Changes service state of FAS related link
set-spc:<point code>:IS|OOS...
Changes service state of a point code
set-thres::cat="<meas cat>",interval=<seconds>,thres=<value>
Changes the threshold value of
measurement category <meas cat>
for interval to the new value
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-7
Chapter 1
Session-Level Commands
HELP
sta-aud
sta-aud-gw:<sig path MGCP>
sta-aud-gw:all
Starts auditing process
Starts auditing process of a gateway
Starts auditing processes of all
gateways
sta-abn-trc:<sig path>|all:params
Starts dumping diagnostic info for
abnormally terminated calls on entire
MGC or a specified signal path or a
point code ,
optional params are:
CONFIRM - confirms tracing over all or
signal path or point code
(not needed when using span or
trunk - otherwise required)
log="filename" output file name in
the ../var/trace directory
span=x, where x is the span number of
interest
trk=y, where y is the trunk number
tc=c, where c is the traffic channel
of interest
rng=b, where b is the range of spans
prd=n, where n is the period in
seconds that this trace needs to be
run for (default is half minutes or
30 seconds)
sta-dns-info:<sig path SIP>:<param>
Starts retrieve process of DNS cache
sta-dns-purge:<sig path SIP>
Starts purge of DNS cache
sta-sc-trc:<sig path>|<trkgrp>:params
Starts tracing on a signal path or a
point code or a trunk group,
optional params are:
CONFIRM - confirms tracing over a
signal path or point code or trunk
group (not needed when using span or
trunk - otherwise required)
log="filename" output file name in
the ../var/trace directory
span=x, where x is the span number of
interest
trk=y, where y is the trunk number
tc=c, where c is the traffic channel
of interest
rng=b, where b is the range of spans
prd=n, where n is the period in
seconds that this trace needs to be
run for (default is 30 minutes or
1800 seconds)
sta-ss7-slt:<C7 link>
Starts an MTP SLT test on a link
sta-ss7-srt:<ss7path>:LSET="<C7 link/set>"
Starts an MTP SRT test on an ss7path
sta-tcap-trc
Starts TCAP tracing
stp-abn-trc:<sig path>|<trkgrp>
Stops abnormal tracing on a signal path
stp-abn-trc:all
Stops abnormal tracing on all signal paths
stp-aud
Stops auditing process
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-8
OL-1116-24
Chapter 1
Session-Level Commands
PROV-CPY—Copy Provisioning Data
stp-call:<target>:<param>
Stops call(s) in progress for the given
target;
target can be a MGC or gateway or
trunk group or signal path;
param can be one of the following
combinations:
[span=number,]confirm or
[span=number,]bc=number,[RNG=number,]
confirm or
cic=number,[RNG=number,]confirm
stp-sc-trc:<sig path>|<trkgrp>
Stops tracing on a signal path or trunk
group
stp-sc-trc:all
Stops tracing on all signal paths
stp-tcap-trc
Stops TCAP tracing
sw-over::CONFIRM
Forces a switchover to a stand-by
platform
tst-cot:<sigpath>:CIC=<number>
Performs a COT test on a circuit
unblk-cic:<sigpath>:CIC=<number>[,RNG=<slaves>]
Unblocks a circuit or a circuit range
vld-cic:<sigpath>:CIC=<number>
Performs a circuit validation
Comments:
Performance Impact Category: A
For a list of the commands on releases earlier than software Release 9, enter the HELP
command with no parameters on those systems.
PROV-CPY—Copy Provisioning Data
Purpose:
Copies configuration settings from the current provisioning session to the local host
on which the commands are running in a simplex configuration to activate the
configuration. This command, if successful, terminates the current provisioning
session and fails if there is no active provisioning session.
The difference between the PROV-CPY command and the PROV-DPLY command
is that the PROV-DPLY command applies the configuration changes to both hosts in
continuous-service Cisco PGW 2200 Softswitch configurations, and the PROV-CPY
command applies the configuration changes to only the local
Cisco PGW 2200 Softswitch host.
Note
Syntax:
When you provision and add new signaling links or new CICs using the
PROV-CPY command, you must reboot the standby system to synchronize
the new objects in the active system to those on the standby system. Not
rebooting can cause loss of calls after a switchover.
prov-cpy
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-9
Chapter 1
Session-Level Commands
PROV-DPLY—Deploy Provisioning Data
Example:
The MML command shown in the following example copies the configuration
changes from the current session to the simplex Cisco PGW 2200 Softswitch you are
configuring.
mml> PROV-CPY
Comments:
Performance Impact Category: B, C, D; impact depends on changes being committed.
See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for a description of
using the PROV commands for provisioning and for information about components,
parameter names, and parameter values used in provisioning.
PROV-DPLY—Deploy Provisioning Data
Purpose:
Copies configuration settings from the current provisioning session to both
Cisco PGW 2200 Softswitchs in a continuous-service configuration, and this
activates the configuration. If the command is successful, it terminates the current
provisioning session. The command fails if there is no active provisioning session.
Note
The difference between the PROV-CPY command and the PROV-DPLY
command is that the PROV-DPLY command applies the configuration
changes to continuous-service Cisco PGW 2200 Softswitch configurations,
whereas the PROV-CPY command applies the configuration changes to the
Cisco PGW 2200 Softswitch you are configuring.
Syntax:
PROV-DPLY
Example:
The MML command shown in the following example copies the configuration from
the current session to both Cisco PGW 2200 Softswitchs:
mml> PROV-DPLY
Comments:
Perform the PROV-STA command before using this command.
Performance Impact Category: B, C, D. This command is necessary to deploy a new
data configuration; impact depends on the changes being deployed.
Note
Shutting down interfaces during a PROV-DPLY or PROV-SYNC can cause
failover after bouncing. To correct this, shut down both the standby and active
systems and restart them.
See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for a description of
using the PROV commands for provisioning and for information about components,
parameter names, and parameter values used in provisioning.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-10
OL-1116-24
Chapter 1
Session-Level Commands
PROV-EXP—Export Provisioning Data
PROV-EXP—Export Provisioning Data
Purpose:
Exports the current configuration of the Cisco PGW 2200 Softswitch, in
MML-command form, to a file or files. This allows for a system to be primed with a
cloned configuration from an existing system or to be restored to a baseline
configuration. The exported data can be imported by the use of MML’s batch feature.
See the Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for information
about creating an MML batch file.
Syntax:
prov-exp:<tid>:dirname=”<export directory name>”
Input
Description:
•
tid—Types of data. These can be:
– config—Core configuration data, including trunks and trunk group data.
– routing—Routing only.
– numan—Dial plan only.
– trkgrp—Trunk group data only.
– trunk—Trunk data only.
– all—Entire configuration (all data).
•
export directory name—Name of the directory to which the data is exported. This
directory, which must be typed within double quotes, is created as a subdirectory
within the cust_specific directory established at installation.
Since software Release 9.4, the prov-exp command has been modified to extract
global screening data (if any exists) from the TimesTen database after all dial plans
are processed. Global screening data is stored in the following files within the
cust_specific directory:
•
GLBL.awhite
•
GLBL.ablack
•
GLBL.bwhite
•
GLBL.bblack
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-11
Chapter 1
Session-Level Commands
PROV-LOCK—Disable Provisioning
Example:
The MML command shown in the following example exports the following files to
the saved config directory:
•
config.mml
•
export_trunks.dat (optionally created if trunks are defined)
•
export_trkgrp.dat (optionally created if trunk groups are defined)
•
routing.mml
•
<custGrpID>.mml (any number of these depending on the number of dial plans
defined)
•
GLBL.awhite (optionally created if global whitelist screening is defined)
•
GLBL.ablack (optionally created if global blacklist screening is defined)
•
GLBL.bwhite (optionally created if global whitelist screening is defined)
•
GLBL.bblack (optionally created if global blacklist screening is defined)
mml> PROV-EXP:ALL:DIRNAME=”SAVED_CONFIG”
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M COMPLD
To import all configuration data from the directory saved_config exported by this
command, use the UNIX commands shown, in the following order, to execute MML
in batch mode:
mml -b $BASEDIR/etc/cust_specific/saved_config/config.mml
mml -b $BASEDIR/etc/cust_specific/saved_config/routing.mml
mml -b $BASEDIR/etc/cust_specific/saved_config/<CustGrpID>.mml
Comments:
Performance Impact Category: B
This command was introduced in software Release 7.4.
PROV-LOCK—Disable Provisioning
Note
This command is obsolete and is not supported on Releases 9.7(3) and 9.8(1).
Purpose:
Locks the system to disable any provisioning or deployment during an upgrade or
downgrade.
Syntax:
prov-lock::confirm
Input
Description:
•
confirm—Verify that the system is locked and any new or modified provisioning is
disabled.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-12
OL-1116-24
Chapter 1
Session-Level Commands
PROV-RTRV—Retrieve Provisioning Information
Example:
The MML command shown in the following example locks the system disables
provisioning additions, modifications, and deployment:
mml> prov-lock::confirm
Comments:
Performance Impact Category: B
This command disables the prov-add, prov-ed, prov-dlt, prov-sync, prov-cpy, and
prov-dply commands.
PROV-RTRV—Retrieve Provisioning Information
Purpose:
Retrieves information about an existing provisioning session.
Syntax:
prov-rtrv:<comp>:name=<MML name>
prov-rtrv:all
prov-rtrv:<comp>:name="<componentname>"|”all”
prov-rtrv:siprttrnkgrp:”all”
prov-rtrv:session
prov-rtrv:profiletypes
prov-rtrv:variants
prov-rtrv:lnksetprop:name=”<protocol family>”
Input
Description:
•
all—Displays all components that have been provisioned. A provisioning session
is not required.
•
session—Displays information about the provisioning session.
•
variants—Displays a list of the signaling protocols this configuration supports.
A provisioning session is not required.
•
siprttrnkgrp—Retrieves all SIP route trunk group information.
•
lnksetprop—Displays properties for linksets associated with the specified
protocol family.
•
profiletypes—Displays all profile types.
•
comp—Use this parameter when you want to display information about a single
component. Enter the MML component type name for the type of component you
are modifying. The entered parameter must match one of the component types
listed in Cisco PGW 2200 Softswitch Release 9 Provisioning Guide. Use the
PROV-RTRV:ALL command to view TID names that can be entered here.
•
name—MML component name for the component you want to display. Use the
PROV-RTRV:ALL command to view MML component names that can be
entered here.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-13
Chapter 1
Session-Level Commands
PROV-RTRV—Retrieve Provisioning Information
Output
Description:
The output of this command varies, depending on the format selected.
For PROV-RTRV:ALL, the output is the following:
•
SESSION—DSTVER if session exists; otherwise this is “ACTIVE”
•
NAME—MML name of component
•
COMPID—8-digit component ID
•
PARENT NAME—MML name of parent component
•
TID—Target identifier of component
•
DESCRIPTION—Description of the provisioning component
For PROV-RTRV:<comp>:NAME="<component name>", the output is the
following:
•
SESSION—DSTVER if session exists; otherwise this is “ACTIVE”
•
NAME—MML name of component
•
DESC—Description of the component
A wide variety of additional output parameters can appear, depending on the
component selected.
Output
Description:
For PROV-RTRV:SESSION, the output is the following:
•
SRCVER—The specific configuration version, as entered in the PROV-STA
command that created the session.
•
DSTVER—The specific output version, as entered in the PROV-STA command
that created the session.
For PROV-RTRV:VARIANTS, the output is the following:
Example:
•
MDO FILE NAME—Filename of the message definition object file. The MDO
is a file that identifies protocol variants.
•
PROTOCOL FAMILY—Name of the protocol family.
The MML command shown in the following example displays information about the
point code “opc”:
mml> PROV-RTRV:opc:NAME=”opc”
MGC-01 - Media Gateway Controller 2000-08-25 16:28:56
M RTRV
""session=active:ptcode"
/*
NAME = opc
DESC = Origination Point Code
NETADDR = 201.1.100
NETIND = 2
*/
;
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-14
OL-1116-24
Chapter 1
Session-Level Commands
PROV-RTRV—Retrieve Provisioning Information
Example:
The MML command shown in the following example displays information about
variants:
mml> PROV-RTRV:VARIANTS
MGC-01 - Media Gateway Controller 2001-12-17 15:38:04.774 EST
M RTRV
"session=cleanversion:variants"
/*
MDO File name
Protcol Family
Switch Type
-----------------------------------ANSISS7_CLEAR
SS7-ANSI
20
ANSISS7_MCI
SS7-ANSI
0
ANSISS7_SPRINT
SS7-ANSI
0
ANSISS7_STANDARD
SS7-ANSI
0
ATT_41459
ISDNPRI
17
ATT_41459_C2
ISDNPRI
17
BELL_1268
ISDNPRI
22
BELL_1268_C3
ISDNPRI
22
BTNUP_BTNR167
SS7-UK
5
BTNUP_IUP
SS7-UK
5
BTNUP_NRC
SS7-UK
5
DPNSS_BTNR188
DPNSS
26
EISUP
EISUP
0
ETS_300_102
ISDNPRI
27
<Press 'SPACE' for next page, 'Enter' for next line or 'q' to quit this
output>
ETS_300_102_C1
ISDNPRI
27
ETS_300_121
SS7-ITU
0
ETS_300_172
ISDNPRI
29
ETS_300_356
SS7-ITU
0
GR317
SS7-ANSI
0
HKTA_2202
SS7-ITU
0
IETF_DCS
SIP
0
IETF_SIP
SIP
0
ISUPV1_POLI
SS7-ITU
0
ISUPV2_32DIG
SS7-ITU
0
ISUPV2_AUSTRIAN
SS7-ITU
0
ISUPV2_CZECH
SS7-ITU
0
ISUPV2_FINNISH96
SS7-ITU
0
ISUPV2_FRENCH
SS7-ITU
0
ISUPV2_GERMAN
SS7-ITU
0
ISUPV2_JAPAN
SS7-Japan
10
ISUPV2_KPNPB
SS7-ITU
0
ISUPV2_NORWEGIAN
SS7-ITU
0
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-15
Chapter 1
Session-Level Commands
PROV-RTRV—Retrieve Provisioning Information
ISUPV2_NTT
ISUPV2_SPANISH
SS7-Japan
SS7-ITU
0
0
<Press 'SPACE' for next page, 'Enter' for next line or 'q' to quit this
output>
ISUPV2_SWISS
SS7-ITU
0
ISUPV2_SWISS_C2
SS7-ITU
0
ISUPV2_TELEFONICA
SS7-ITU
0
ISUPV2_VIETNAM
SS7-ITU
0
ISUPV3_UK
SS7-UK
0
MGCPCAS
CAS
0
NORTEL_IBN7
SS7-ANSI
0
NTT_INS_1500
ISDNPRI
27
Q721_BASE
SS7-ITU
5
Q721_BRAZILIAN
SS7-ITU
5
Q721_CHINA
SS7-China
5
Q721_FRENCH
SS7-ITU
5
Q721_PHILLIPINE
SS7-ITU
5
Q761_ARGENTINA
SS7-ITU
0
Q761_ARGENTINA_C2
SS7-ITU
0
Q761_AUSTRL
SS7-ITU
0
Q761_AUSTRL_C2
SS7-ITU
0
Q761_BASE
SS7-ITU
0
Q761_BELG_BCOM
SS7-ITU
0
Q761_BELG_MOBI
SS7-ITU
0
<Press 'SPACE' for next page, 'Enter' for next line or 'q' to quit this
output>
Q761_CHILE
SS7-ITU
0
Q761_CHINA
SS7-China
0
Q761_CHINA_MOB
SS7-China
0
Q761_DANISH
SS7-ITU
0
Q761_INDIA
SS7-ITU
0
Q761_KOREAN
SS7-ITU
0
Q761_NEWZEALAND
SS7-ITU
0
Q761_PERU
SS7-ITU
0
Q761_PORTUGAL
SS7-ITU
0
Q761_SIEMENS_MOBI
SS7-ITU
0
Q761_SINGAPORE
SS7-ITU
0
Q761_SINGAPORE_C2
SS7-ITU
0
Q761_TAIWAN
SS7-ITU
0
Q761_THAILAND
SS7-ITU
0
Q767_BASE
SS7-ITU
0
Q767_BRAZIL
SS7-ITU
0
Q767_COLOMBIA
SS7-ITU
0
Q767_GUATEMALA
SS7-ITU
0
Q767_INDONESIA
SS7-ITU
0
Q767_ITAL
SS7-ITU
0
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-16
OL-1116-24
Chapter 1
Session-Level Commands
PROV-RTRV—Retrieve Provisioning Information
<Press 'SPACE' for next page, 'Enter' for next line or 'q' to quit this
output>
Q767_ITAL_INTERCONNECT SS7-ITU
0
Q767_MEXICAN
SS7-ITU
0
Q767_RUSS
SS7-ITU
0
Q767_SPAN
SS7-ITU
0
Q767_SWED
SS7-ITU
0
Q767_TELSTRA
SS7-ITU
0
Q931
ISDNPRI
27
Q931_AUSTRALIA
ISDNPRI
19
Q931_SINGAPORE
ISDNPRI
27
dummy
AVM
0
dummy
MGCP
0
dummy
SGCP
0
dummy
TCAPOverIP
0
dummy
VSI
0
*/
;
Example:
The MML command shown in the following example displays information about
linkset properties:
mml> prov-rtrv:LNKSETPROP:name="ss7-itu"
MGC-01 - Media Gateway Controller 2002-04-19 16:12:54.469 EST
M RTRV
"session=Mist915-S10P15-22MAR02:LNKSETPROP"
/*
mtp2AermEmgThr = 1
mtp2AermNrmThr = 4
mtp2CongDiscard = false
mtp2LssuLen = 1
mtp2MaxAlignRetries = 5
mtp2MaxMsuFrmLen = 272
mtp2MaxOutsFrames = 127
mtp2ProvingEmgT4 = 6
mtp2ProvingNormalT4 = 23
mtp2SuermThr = 64
mtp2T1 = 450
mtp2T2 = 250
mtp2T3 = 20
mtp2T5 = 1
mtp2T6 = 60
mtp2T7 = 10
;
Note
Comments:
To determine the protocol family associated with a linkset, use the
PROV-RTRV:LNKSET:”ALL” command.
Performance Impact Category: B, C; impact depends on the size of the current
configuration and what information is retrieved.
See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for a description of
using the PROV commands for provisioning and for information about components,
parameter names, and parameter values used in provisioning.
If the quotation marks are not used, the following error message is displayed:
/* Input, Invalid Data Parameter */
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-17
Chapter 1
Session-Level Commands
PROV-STA—Start Provisioning Session
PROV-STA—Start Provisioning Session
Purpose:
Establishes a provisioning session. The data files are copied from the source version
to the destination version. The data files are also locked to prevent other users from
making changes.
If there is no active session, you can start a new session. If there is an active session,
you can view the active configuration, but you are blocked from performing other
actions.
Syntax:
Input
Description:
prov-sta::srcver=<version>,dstver=<version>[,confirm]
•
srcver—Selects a specific configuration version as the source for configuration
changes. The srcver variable represents a directory stored in
$BASEDIR/etc/CONFIG_LIB. In place of the configuration version, you can
also enter:
– new—Specifies a new default session configuration; no existing source
configuration is used.
– active—Selects the active configuration as the source for configuration
changes.
•
dstver—Specifies the output version number and directory for the configuration
session results. The destVersionNumber variable represents a directory stored in
$BASEDIR/etc/CONFIG_LIB.
•
confirm—Allows overwriting of existing provisioning directories. In other
words, if the dstver directory exists and this option is not used, an error message
results. If the dstver directory exists and this option is used, the directory is
overwritten.
Note
Example:
A version number is not required within the directory names listed above, but
it does help you keep track of different configuration versions.
The MML command shown in the following example starts a provisioning session
and creates a new configuration named ver1:
mml> PROV-STA::SRCVER=”new”, DSTVER=”ver1”:CONFIRM
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M COMPLD
"PROV-STA"
;
Example:
The MML command shown in the following example starts a provisioning session,
opens the existing configuration named ver1, and overwrites that configuration:
mml> PROV-STA::SRCVER=”ver1”, DSTVER=”ver1”
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-18
OL-1116-24
Chapter 1
Session-Level Commands
PROV-STP—Stop Provisioning Session
Example:
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:
mml> PROV-STA::SRCVER=”ver1”, DSTVER=”ver2”
Comments:
Performance Impact Category: B
See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for a description of
the PROV commands for provisioning and for information about components,
parameter names, and parameter values.
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. This gives you an easy way to return to a known configuration if
there are problems with the new configuration. The new configuration should never
be the destination session.
If the source configuration specified is new, the software does not allow you to
overwrite an existing configuration.
PROV-STP—Stop Provisioning Session
Purpose:
Terminates either a specified session or the current provisioning session, saves the
configuration, and releases the lock on the configuration data files.
Note
Syntax:
Input
Description:
prov-stp
prov-stp:<session name>:confirm
•
session name—Use the PROV-RTRV:SESSION command to display a
provisioning session for this parameter.
•
confirm—If no confirm option is entered, the command is rejected, and you are
notified of the potential performance impact of this command.
Note
Example:
This command does not activate the new configuration. Use the PROV-CPY
or PROV-DPLY command to activate the configuration.
Do not use the confirm option unless you enter the MML session ID.
The MML command shown in the following example terminates the current
provisioning session:
mml> PROV-STP
Media Gateway Controller
M COMPLD
"PROV-STP"
;
Comments:
- MGC-01 2000-01-12 15:19:51
Performance Impact Category: B
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-19
Chapter 1
Session-Level Commands
PROV-SYNC—Synchronize Provisioning Data
PROV-SYNC—Synchronize Provisioning Data
Purpose:
Copies the active configuration from the active Cisco PGW 2200 Softswitch host to
the standby Cisco PGW 2200 Softswitch host, ensuring that both
Cisco PGW 2200 Softswitch hosts are using the same configuration.
Note
When you provision and add new signaling links or new CICS using the
PROV-CPY command, you must reboot the standby system to synchronize
the new objects in the active system to the standby. Not rebooting can cause
loss of calls after a switch over.
Syntax:
prov-sync
Example:
The MML command shown in the following example copies the configuration from
the active Cisco PGW 2200 Softswitch to the standby Cisco PGW 2200 Softswitch:
mml> PROV-SYNC
Comments:
Performance Impact Category: C, D; impact depends on the size of the data being
synchronized.
Note
Shutting down interfaces during a PROV-DPLY or PROV-SYNC can cause
failover after bouncing. To correct this, shut down both the standby and active
systems and restart them.
PROV-UNLOCK—Re-enable Provisioning
Note
This command is obsolete and is not supported on Releases 9.7(3) and 9.8(1).
Purpose:
Unlocks the system when provisioning has been disabled by the use of the prov-lock
command, during a system upgrade or downgrade.
Syntax:
prov-unlock
Example:
The MML command shown in the following example unlocks the system after a system
upgrade or downgrade is complete:
mml> prov-unlock
Comments:
Performance Impact Category: B
This command enables the prov-add, prov-ed, prov-dlt, prov-sync, prov-cpy, and
prov-deply commands after they have been disabled by the prov-lock command.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-20
OL-1116-24
Chapter 1
Session-Level Commands
QUIT—End Session
QUIT—End Session
Purpose:
Ends the MML session.
Syntax:
quit
Example:
mml> QUIT
Comments:
Performance Impact Category: A
R—Repeat Previously Entered Command
Purpose:
Repeats a previously entered command.
Syntax:
r[::<number>]
Input
Description:
number—The command to repeat. For example, a value of 3 repeats the command
issued before the two preceding commands. The default value is 1, which repeats the
previous command.
Example:
The MML command shown in the following example repeats the preceding command
(this is the same as using the up arrow):
mml> R
Example:
The MML command shown in the following example repeats the third to the last
command:
mml> R::3
Comments:
Performance Impact Category: A
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-21
Chapter 1
Session-Level Commands
R—Repeat Previously Entered Command
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-22
OL-1116-24
CH A P T E R
1
Commands for Operations, Maintenance, and
Troubleshooting
Revised: Aug 30, 2011, OL-1116-24
This chapter describes the Machine-Man Language (MML) commands for operations, maintenance, and
troubleshooting on the Cisco PGW 2200 Softswitch Release 9.
ACK-ALM—Acknowledge Alarm
Purpose:
Acknowledges that an alarm category on a component is recognized, but the alarm is
not cleared. If this is the last current alarm of a specific severity, the associated alarm
relay is turned off.
Syntax:
ack-alm:<comp>
ack-alm:<comp>:”<alm cat>”
ack-alm:<comp>:”<alm sev>”
Input
Description:
•
comp—The component that is generating the alarm. Components are described in
Cisco PGW 2200 Softswitch Release 9 Provisioning Guide. See the
“RTRV-CTR—Retrieve Measurement Counter” section on page 1-21 to retrieve a
list of system components. This value can also be ALL for all components. If a
component is used but no alarm category or severity is used, all alarms for the
component are acknowledged.
•
alm cat—The alarm category, or the text that appears in the body of the alarm. See
the “RTRV-ALMS—Retrieve Active Alarms” section on page 1-11 to retrieve all
active alarms.
•
alm sev—The alarm severity, as it appears in the body of the alarm. See the
“RTRV-ALMS—Retrieve Active Alarms” section on page 1-11 to retrieve all
active alarms.
Note
The terms for alarm category and severity are case sensitive, and they must
be in quotation marks.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-1
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
BLK-CIC—Block a Circuit or a Circuit Range
Example:
The command in the following example acknowledges a Config Fail alarm for the I/O
channel manager process:
mml> ACK-ALM:IOCM-01:”CONFIG FAIL”
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M COMPLD
;
Comments:
Performance Impact Category: A
The format of the alarm category name must be the same as the format of the alarm
category name retrieved with the RTRV-ALMS command (which is why the alarm
category must be in uppercase).
This command allows wildcarding.
BLK-CIC—Block a Circuit or a Circuit Range
Purpose:
Blocks a circuit or range of circuits from carrying calls.
Syntax:
blk-cic:<sig path>:CIC=<number>[,RNG=<range>]
Input
Description:
Example:
•
sig path—MML component name of a signal path created with the
prov-add:sigpath command.
•
number—A valid circuit identification code (CIC).
•
range—A number such that number + range is a valid CIC. All circuits between
number and number + range are blocked.
The MML command shown in the following example blocks CIC 1353 on signal path
ss7svc1:
mml> BLK-CIC:ss7svc1:CIC=1353
MGC-01 - Media Gateway Controller 2001-02-08 10:21:11
M COMPLD
“ss7svc1”
;
Comments:
Performance Impact Category: B
Enter the RTRV-TC:ALL command (or the RTRV-CIC command) to see whether
CICs were blocked.
Blocking a single CIC causes a BLO message to be sent to the destination SSP. Blocking
a range of CICs causes a GBL message to be sent to the destination SSP. The range
option can be used only to block CICs within a given trunk (T1 or E1).
To unblock a CIC, use the UNBLK-CIC command.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-2
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
CLR-MEAS—Reset a Measurement Category
CLR-MEAS—Reset a Measurement Category
Purpose:
Resets a measurement category of a component.
Syntax:
clr-meas:<comp>:”<meas cat>”
Input
Description:
•
comp—The component being measured. See the “RTRV-CALLIM—Retrieves
the Call Limiting Function Status” section on page 1-16 to retrieve a list of
system components.
•
meas cat—Logical identifier that selects the measurement category.
To retrieve a current list of measurement categories, use the MML command
prov-rtrv.
Example:
The MML command shown in the following example resets the
line-interface-severely-errored seconds measurement category on component stp3:
mml> CLR-MEAS:stp3
Media Gateway Controller
M COMPLD
;
Comments:
- MGC-01 2000-01-12 15:19:51
Performance Impact Category: A
Components are described in Cisco PGW 2200 Softswitch Release 9 Provisioning
Guide. For a description of measurement categories, see Cisco PGW 2200 Softswitch
Release 9 Operations, Maintenance, and Troubleshooting Guide.
CLR-TCAP-TRANS—Clear TCAP Transactions
Purpose:
Clears all transaction capabilities application part (TCAP) transactions that are older
than the specified period.
Syntax:
clr-tcap-trans::T=<number>
Input
Description:
T—The time period, in seconds, after which you should clear TCAP transactions. The
integer range is 0 to 2147483647 in Release 9.7(3) and earlier releases.
In Release 9.8(1), the integer range is 3601 to 2147483647. In Release 9.8(1), if the
value is set to less than 3601, the command is ignored.
Example:
The MML command shown in the following example clears all TCAP transactions
that are older than 3601 seconds:
mml> CLR-TCAP-TRANS::T=3601
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M RTRV
“TCAP-01:CLRD=0”
;
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-3
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
DIAGLOG—Diagnostics Log
DIAGLOG—Diagnostics Log
Purpose:
Starts and stops event logging into a diagnostics log.
Syntax:
diaglog:<file name>:START | STOP
Input
Description:
Example:
•
file name—The user-defined name of the log file. Do not use punctuation, such as
the period character (.), to create a suffix. The default logging directory is
$BASEDIR/var/log, where $BASEDIR is specified at installation.
•
START | STOP—Instructs the Cisco PGW 2200 Softswitch whether to start or stop
logging.
The MML command shown in the following example starts logging into the diagnostics
log named test:
mml> DIAGLOG:test:start
Media Gateway Controller
M COMPLD
;
Comments:
- MGC-01 2000-01-12 15:19:51
See Cisco PGW 2200 Softswitch Release 9 Messages Reference Guide for more
information about log files.
KILL-CALL—Terminate a Call
Purpose:
Resolves a stuck or hung CIC associated with a single call instance or a range of calls
on the Cisco PGW 2200 Softswitch. Forcefully releases a bearer channel associated
with a single call instance that cannot be returned to the idle state with the reset-cic or
stp-call commands.
Note
Syntax:
This command only releases bearer channels locally on the
Cisco PGW 2200 Softswitch. No SS7 messages are sent to the remote call side
(destination point code or destination MGW).
kill-call:<sigpath>:CID=eisip_callid,nodeid=nodeid,confirm
kill-call:{sigpath|target}:[span=number,]confirm
kill-call:{sigpath|target}:[span=number,][BC=number,][RNG=number,]confirm
kill-call:{sigpath|target}:CIC=number of CIC,[RNG=number,]confirm
kill-call:{sigpath|target}:CID=sip call id,confirm
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-4
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
PRT-CALL—Print Call
Input
Description:
•
sigpath—MML name of the SS7 or ISDN-PRI signal path associated with the stuck
CIC.
•
target—MML name of the media gateway controller, gateway, or trunk group
associated with the stuck span and bearer channel.
•
span—Number of the affected span.
•
BC—Number of the affected bearer channel.
•
RNG—Number that represents a range of affected bearer channels or CICs.
•
CIC—Number of the affected Circuit Identification Code.
•
CID—Unique call identifier.
Example:
mml> KILL-CALL:eisup-sigpath:cid="454545",nodeid=28871553,confirm
mml> KILL-CALL:sip-sigpath:
cid="[email protected]",confirm
mml> KILL-CALL:ss7svc1:CIC=1,confirm
mml> KILL-CALL:tg-4444:confirm
mml> KILL-CALL:sip-sigpath:CID=”[email protected]”, confirm
Comments:
Performance Impact Category: D
Before using this command, attempt to manually clear the call with the reset-cic and
stp-call commands. See Cisco PGW 2200 SoftswitchRelease 9 Operations,
Maintenance, and Troubleshooting Guide for information about resolving a stuck or
hung CIC.
PRT-CALL—Print Call
Purpose:
Prints diagnostic information about an active call to a log file.
Syntax:
prt-call:{sigpath}:[CIC=number,|span=number,][BC=number,|CID=number,]
LOG=”log name”
prt-call:<sigpath>:CIC=<n>|span=<n>[bc=<n>][,LOG=<logname>][,EVT]]
prt-call:<sigpath>:CID=<eisup_callid>,nodeid=<nodeid>,LOG=<logname>
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-5
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
PRT-CALL—Print Call
Input
Description:
•
sigpath—Corresponding MML name for any of the following component types:
– Signal path of in-band TDM up to MUX and then time switched to TDM media
and sent to Cisco PGW 2200 Softswitch
– Signal path of in-band TDM signaling up to CU and then encapsulated and sent
over IP to the Cisco PGW 2200 Softswitch
– Signal path of in-band TDM signaling up to NAS and then converted to NI2
and sent to the Cisco PGW 2200 Softswitch over IP (that is, FE
box<-sig/tdm->NAS<-NI2/IP-> MGC)
– Signal path or route set associated with the SS7 destination PC
– Signal path for EISUP
Example:
•
cic—The ISUP circuit identification code number.
•
span—spanId is a 16-bit value that identifies an ISDN/PRI physical cable.
•
bc—The non-ISUP bearer channel number. BC is used for non-ISUP trunks;
otherwise use CIC.
•
cid—Unique call identifier.
•
log—The name of an ASCII log file to which the output is written. The name given
in this parameter is used as a prefix to the actual name of the file, which includes
the signal path name and date and time. If no log filename is provided, a default
name consisting of the signal path and date and time is created. The extension of
these log files is prt and the files are located in the ../var/trace directory.
•
evt—Reserved for future use.
The MML command shown in the following example prints information about hung
calls to a file:
mml> PRT-CALL:DMS100-PC:CIC=124
Media Gateway Controller 2000-06-14 11:02:39
M COMPLD
"dms100-pc"
;
The output for this prt-call command is the file
$BASEDIR/var/trace/pc_20000614110239.prt.
The MML command shown in the following example prints information about hung
calls to a file:
mml> PRT-CALL:BH581-1:SPAN=0,BC=1
Media Gateway Controller 2000-06-14 11:10:22
M COMPLD
"bh581-1"
;
The MML command shown in the following example prints information about hung
calls to a file:
mml> PRT-CALL:BH581-1:SPAN=0,BC=1,LOG="BH581-PRINT"
Media Gateway Controller 2000-06-14 11:10:59
M COMPLD
"bh581-1"
;
The output for this prt-call command is the file
$BASEDIR/var/trace/bh581-print_bh581-1_20000614111059.prt
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-6
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
QUERY-CIC—Execute Circuit Query
Example:
mml> prt-call:eisup-sigpath:cid="5954",nodeid=28871553,log="logname"
mml> prt-call:sip-sigpath:cid="[email protected]"
,log="logname"
mml> PRT-CALL:ss7svc1:cic=1,LOG=”log1”
mml> PRT-CALL:pri-sigpath:span=1,BC=2,LOG=”log2”
mml> PRT-CALL:sip-sigpath:CID=”[email protected]”,
LOG=”logsip”
Comments:
Performance Impact Category: C
This command allows wildcards on signal paths.
QUERY-CIC—Execute Circuit Query
Purpose:
Executes a circuit status query for a circuit or a circuit range.
Note
Syntax:
Input
Description:
Example:
Not all SS7 variants support the querying of circuit identification codes
(CICs). If this command is executed on a signaling service that is configured
for an SS7 variant that does not support the querying of CICs, an error code,
SABT, is returned when the query operation times out.
query-cic:<sig path>:CIC=<number>[,RNG=<range>][,RSLV]
•
sig path—MML component name of a signal path created with PROV-ADD.
•
number—A valid CIC.
•
range—A number such that number + range is a valid CIC. All circuits between
number and number + range are queried.
•
rslv—For ANSI SS7 circuits, if this parameter is on, the system attempts to
resolve differences between the Cisco PGW 2200 Softswitch CIC state and the
remote switch CIC state. For ITU SS7 circuits, this parameter is ignored.
The MML command shown in the following example queries CICs 20 through 24 on
the signal path. In this example, CIC=24 is a case in which the local primary state and
secondary state differ.
mml> QUERY-CIC:ss7svc1:CIC=20,RNG=4
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M RTRV
"ss7svc1:CIC=20;LPST=IS;LSST=IDLE;RPST=IS;RSST=IDLE"
"ss7svc1:CIC=21;LPST=IS;LSST=IDLE;RPST=IS;RSST=IDLE"
"ss7svc1:CIC=22;LPST=IS;LSST=IDLE;RPST=IS;RSST=IDLE"
"ss7svc1:CIC=23;LPST=IS;LSST=IDLE;RPST=IS;RSST=IDLE"
"ss7svc1:CIC=24;LPST=OOS;LSST=IDLE_LOC_BLOC;RPST=IS;RSST=IDLE"
;
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-7
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RESET-CIC—Reset a Circuit or a Circuit Range
Output
Description:
•
CIC—Circuit identification code.
•
LPST—Primary state.
– IS—In service.
– OOS—Out of service.
– TRNS—Transient; the state is currently being changed.
•
LSST—Local secondary state.
– N/A—Not available.
– UNEQUIPPED—Unequipped.
– IC_BUSY—Incoming is busy.
– IC_BUSY_LOC_BLOC—Incoming is busy, blocked locally.
– IC_BUSY_REM_BLOC—Incoming is busy, blocked remotely.
– IC_BUSY_BOTH_BLOC—Incoming is busy, blocked both remotely and
locally.
– OG_BUSY—Outgoing is busy.
– OG_BUSY_LOC_BLOC—Outgoing is busy, blocked locally.
– OG_BUSY_REM_BLOC—Outgoing is busy, blocked remotely.
– OG_BUSY_BOTH_BLOC—Outgoing is busy, blocked both remotely and
locally.
– IDLE—The circuit is idle, available for use.
– IDLE_LOC_BLOC—Idle, blocked locally.
– IDLE_REM_BLOC—Idle, blocked remotely.
– IDLE_BOTH_BLOC—Idle, blocked both locally and remotely.
Comments:
•
RPST—Remote primary state (states are same as LPST, above).
•
RSST—Remote secondary state (states are same as LSST, above).
Performance Impact Category: B
If the remote states and local states are the same, only the remote states are shown in
the output.
RESET-CIC—Reset a Circuit or a Circuit Range
Purpose:
Resets or activates a circuit or a range of circuits.
Syntax:
reset-cic:<sig path>:CIC=<number>[,RNG=<range>]
Input
Description:
•
sig path—MML component name of a signal path created with PROV-ADD.
•
number—A valid circuit identification code (CIC).
•
range—A number such that number + range is a valid CIC. All circuits between
number and number +range are reset.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-8
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-ADMIN-STATE—Retrieve Administrative State
Example:
The MML command shown in the following example resets CICs 1000 to 1002 on
signal path ss7svc1
mml> RESET-CIC:SS7SVC1:CIC=1000,RNG=2
MGC-01 - Media Gateway Controller 2001-02-08 12:36:47
M COMPLD
"ss7svc1"
Comments:
Performance Impact Category: B
RTRV-ADMIN-STATE—Retrieve Administrative State
Purpose:
Provides the following summary report:
•
Inferred target state:
– If all circuits are locked, the inferred target administrative state is locked.
– If at least one circuit is unlocked, the inferred target administrative state is
unlocked.
– If there is a mixture of locked and shutdown, the inferred target administrative
state is shut down.
Syntax:
•
Number of bearer channels that are in locked state.
•
Number of bearer channels that are in unlocked state.
•
Number of bearer channels that are in shutdown state.
rtrv-admin-state:<mgc>
rtrv-admin-state:<gway>
rtrv-admin-state:<trkGrp>
rtrv-admin-state:<sig path>
rtrv-admin-state:<sigPath>:span=x
rtrv-admin-state:<sigPath>:span=x,BC=y[,RNG=z]
rtrv-admin-state:<sigPath>:CIC=x[,RNG=y]
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-9
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-ADMIN-STATE—Retrieve Administrative State
Input
Description:
Target parameters are as follows:
•
mgc—Corresponding MML name of media gateway controller.
•
gway—Corresponding MML name for media gateway. Not all media gateway types
are applicable. Supported types are CU, MUX, MGW, and AVM external nodes.
•
trkgrp—trkGrp is applicable only for time-division multiplexing (TDM). Allow the
corresponding MML name for component type "0020".
Note
•
When specifying the trunk group number, enter the prefix tg-.
Example: rtrv-admin-state:tg-404
sigpath—Corresponding MML name for any of the following component types:
– Signal path of in-band TDM up to MUX and then time switched to TDM media
and sent to the Cisco PGW 2200 Softswitch
– Signal path of in-band TDM signaling up to CU and then encapsulated and sent
over IP to the Cisco PGW 2200 Softswitch
– Signal path of in-band TDM signaling up to NAS and then converted to NI2
and sent to the Cisco PGW 2200 Softswitch over IP (that is, FE
box<-sig/tdm->NAS<-NI2/IP-> Cisco PGW 2200 Softswitch
– Signal path or route set associated with SS7 destination PC
– Signal path for EISUP
Output
Description:
•
span—A 16-bit value that identifies an ISDN/PRI physical cable.
•
bc—The non-ISUP bearer channel number. BC is used for non-ISUP trunks;
otherwise use CIC.
•
cic—The ISUP circuit identification code number.
•
rng—The range of either bearer channels or circuit identification codes.
•
PST—Primary administrative state:
– LOCK—Locked state
– UNLOCK—Unlocked state
– SHUTDOWN—Shutdown state
•
LOCK—Number of bearer channels in locked state.
•
UNLOCK—Number of bearer channels in unlocked state.
•
SHUTDOWN—Number of bearer channels in shutdown state.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-10
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-ALMS—Retrieve Active Alarms
Example:
The MML command shown in the following example retrieves for signal path ss7svc1
the primary state (PST=), the number of bearer channels in locked state (LOCK=), the
number of bearer channels in unlocked state (UNLOCK=), and the number of bearer
channels in shutdown state (SHUTDOWN=):
mml> RTRV-ADMIN-STATE:SS7SVC1
MGC-01 - Media Gateway Controller 2001-02-08 12:39:57
M COMPLD
"ss7svc1:PST=UNLOCK,LOCK=0,UNLOCK=1207,SHUTDOWN=0"
;
Comments:
Performance Impact Category: C
This command allows wildcarding.
RTRV-ALMS—Retrieve Active Alarms
Purpose:
Displays all active alarms.
Syntax:
rtrv-alms
rtrv-alms::cont
Input
Description:
cont—Tells the system to display alarm events until Ctrl-C is pressed.
Output
Description:
See Cisco PGW 2200 Softswitch Release 9 Messages Reference Guide for a description
of each of the alarms and recommended actions.
Alarm severity levels (SEV=) are as follows:
•
Critical (CR)
•
Major (MJ)
•
Minor (MN)
•
Informational
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-11
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-ALMS—Retrieve Active Alarms
Example:
The MML command shown in the following example displays the names of all active
alarms:
mml> RTRV-ALMS
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M RTRV
"IOCM-01: 1999-09-30 15:54:05.891,"
"IOCM-01:ALM=\"Config Fail\",SEV=MN"
"FOD-01: 1999-09-30 15:54:01.211,"
"FOD-01:ALM=\"FailoverPeerLost\",SEV=MJ"
"dpc1: 1999-09-30 15:54:04.223,ALM=\"PC UNAVAIL\",SEV=MJ"
"dpc2: 1999-09-30 15:54:04.229,ALM=\"PC UNAVAIL\",SEV=MJ"
"dpc3: 1999-09-30 15:54:03.382,ALM=\"PC UNAVAIL\",SEV=MJ"
"dpc5: 1999-09-30 15:54:04.243,ALM=\"PC UNAVAIL\",SEV=MJ"
"ls1link2: 1999-09-30 15:54:03.808,ALM=\"SC FAIL\",SEV=MJ"
"ls2link2: 1999-09-30 15:54:04.119,ALM=\"SC FAIL\",SEV=MJ"
"ls3link1: 1999-09-30 15:54:04.121,"
"ls3link1:ALM=\"Config Fail\",SEV=MN"
"ls3link2: 1999-09-30 15:54:04.131,"
"ls3link2:ALM=\"Config Fail\",SEV=MN"
"ls3link2: 1999-09-30 15:54:04.132,ALM=\"SC FAIL\",SEV=MJ"
"ls5link1: 1999-09-30 15:54:04.150,"
"ls5link1:ALM=\"Config Fail\",SEV=MN"
"ls5link1: 1999-09-30 15:54:04.151,ALM=\"SC FAIL\",SEV=MJ"
;
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-12
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-ASSOCIATION—Display State of SCTP Association
Example:
The MML command shown in the following example displays the names of active
alarms and new alarm events until you press Ctrl-C:
mml> RTRV-ALMS::cont
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M RTRV
"IOCM-01: 1999-09-30 15:54:27.892,"
"IOCM-01:ALM=\"Config Fail\",SEV=MN"
"FOD-01: 1999-09-30 15:54:01.211,"
"FOD-01:ALM=\"FailoverPeerLost\",SEV=MJ"
"dpc1: 1999-09-30 15:54:04.223,ALM=\"PC UNAVAIL\",SEV=MJ"
"dpc2: 1999-09-30 15:54:04.229,ALM=\"PC UNAVAIL\",SEV=MJ"
"dpc3: 1999-09-30 15:54:03.382,ALM=\"PC UNAVAIL\",SEV=MJ"
"dpc5: 1999-09-30 15:54:04.243,ALM=\"PC UNAVAIL\",SEV=MJ"
"ls3link1: 1999-09-30 15:54:04.121,"
"ls3link1:ALM=\"Config Fail\",SEV=MN"
"ls3link2: 1999-09-30 15:54:04.131,"
"ls3link2:ALM=\"Config Fail\",SEV=MN"
"ls3link2: 1999-09-30 15:54:04.132,ALM=\"SC FAIL\",SEV=MJ"
"ls5link1: 1999-09-30 15:54:04.150,"
"ls5link1:ALM=\"Config Fail\",SEV=MN"
"ls5link1: 1999-09-30 15:54:04.151,ALM=\"SC FAIL\",SEV=MJ"
;
/* Listening for alarm events... (Ctrl-C to stop) */
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
** "dpc1:ALM=\"PC UNAVAIL\",STATE=CLEARED"
;
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
** "dpc2:ALM=\"PC UNAVAIL\",STATE=CLEARED"
;
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
A "ls1link1:ALM=\"CHAN BAD TOT 15\",STATE=CLEARED"
;
Ctrl-C
^C/* Ctrl-C pressed */
mml>
Comments:
Performance Impact Category: A
RTRV-ASSOCIATION—Display State of SCTP Association
Purpose:
Displays the primary and secondary states of an SCTP association.
Syntax:
rtrv-association:assoc_name
rtrv-association:all
Input
Description:
•
Assoc_name—MML name of a previously configured SCTP association.
•
All—All associations
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-13
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-AUD-GW—Retrieve Auditing of MGCP Gateway
Output
Description:
SCTP Association—MML name of SCTP association specified.
PST—Primary state; valid values are:
– INB—Installed busy; association has been created but has not yet been
commanded IN or OOS with the set-association command.
– IS—In service
– OOS—Out of service
SST—Secondary state; valid values are:
– COOS—Commanded out of service
– STBY—The local platform state is standby
– CONF—Out of service because of a configuration failure
Example:
The MML command shown in the following example retrieves the state of all
associations:
mml> rtrv-association:all
MGC-01 - Media Gateway Controller 2001-01-01 18:57:26
M RTRV
"assoc1:IS"
"assoc2:OOS,COOS"
;
Comments:
Performance Impact Category: A
RTRV-AUD-GW—Retrieve Auditing of MGCP Gateway
Purpose:
Retrieves the auditing of an MGCP gateway started by the STA-AUD-GW command.
Note
The STA-AUDIT-GW and RTRV-AUDIT-GW commands are no longer
supported as of Release 9.6(1)
Syntax:
rtrv-aud-gw:<sig path MGCP>
rtrv-aud-gw:all
Input
Description:
sig path MGCP—Retrieves the auditing of an MGCP signal path created with the
PROV-ADD:MGC command.
all—Retrieves the auditing of all MGCPs.
Output
Description:
•
PASS—The audit was successful.
– <text>—This is text returned from the Input-Output Channel Controller
(IOCC). It can include endpoint name, connections ID, or other text
explaining the result.
•
FAIL—The audit was unsuccessful.
– <text>—This is text returned from the IOCC. It can include endpoint name,
connection IDs, or other text explaining the result.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-14
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-C7LNK—Retrieve Attributes of a Linkset
Example:
The MML command shown in the following example retrieves the results of an audit
started on SP1-MGCP1:
mml> RTRV-AUD-GW:SP1-MGCP1
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M COMPLD
"SP1-MGCP1:Audit gw received at 2000-01-12 15:19:51
Audit GW PASSED
pass pn
pass pt - not alarmed
pass sl - not alarmed
pass nl
pass bp
pass cp
pass rp
pass nb
pass uc
pass ic
pass us
pass is"
;
Comments:
Performance Impact Category: C
RTRV-C7LNK—Retrieve Attributes of a Linkset
Purpose:
Retrieves the attributes of a link or a linkset.
Syntax:
rtrv-c7lnk:<C7 linkset|C7 link>
rtrv-c7lnk:all
Input
Description:
•
c7 linkset—The provisioning component C7 link, aTDM link used in a linkset, or
a linkset. See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for a
description of C7 linksets. Use the RTRV-LSET command, described in the
“RTRV-LSET—Retrieve Linkset Service State” section on page 1-33, to retrieve
a list of linksets.
•
all—Retrieves the attributes of all links and linksets.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-15
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-CALLIM—Retrieves the Call Limiting Function Status
Output
Description:
•
LID—Link or linkset ID
•
PST—Primary state; valid values are:
– AOOS—The system has taken the resource out of service
– INB—Installed busy (resource has been created but not yet commanded IS or
OOS via the SET-C7LNK command)
– IS—In service
– COOS—Commanded out of service
– FOOS—Forced out of service
– OOS—Out of service
– TRNS—Transient; the state is currently being changed
– UNK—Unknown
Example:
The MML command shown in the following example retrieves the attributes of SS7
link 0 for linkset 1:
mml> RTRV-C7LNK:SS7LK0-1
MGC-01 - Media Gateway Controller 2000-11-19 21:28:45
M RTRV
"ss7lk0-1:lnkset1,LID=0:IS"
/* SS7 link 0 for lnkset1 to 2600-8 */
;
Comments:
Performance Impact Category: A
RTRV-CALLIM—Retrieves the Call Limiting Function Status
Purpose:
Retrieves the MGCP Scripting Support on the Cisco PGW 2200 Softswitch function
status for the whole Cisco PGW 2200 Softswitch.
Syntax:
rtrv-callim
Output
Description:
ENABLE | DISABLE—Instructs the Cisco PGW 2200 Softswitch to either enable or
disable call limiting.
Example:
The MML command shown in the following example displays the state of this feature:
mml> rtrv-callim:
MGC-01 - Media Gateway Controller 2004-03-22 19:49:54.998 PST M
"ENGG-01:ENABLE"
;
Comments:
RTRV
Performance Impact Category: A
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-16
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-CALLINFO—Display Call IDs of EISUP/SIP
RTRV-CALLINFO—Display Call IDs of EISUP/SIP
Purpose:
Displays the EISUP/SIP call IDs of all EISUP/SIP calls on the PGW system.This
command replaces the rtrv-sip command.
Syntax:
rtrv-callinfo:target:[all|eisup|sip|ip|TDM]| [,calltime=minutes] [,detail]
Input
Description:
•
target—MML name of the media gateway controller, gateway, or trunk group
associated with the call.
•
all—Displays all calls from the target using EISUP/SIP protocols. Half calls can be
retrieved with this option.
Note
The Cisco PGW 2200 Softswitch can perform multi-leg services. A normal
call has two call legs. Each call leg is a half call leg. When a new call leg is
added by a service, a whole new call is created to handle this call leg. Call
sides determine how to handle these call legs. After that, redundant call
sides are deleted in one of more call instances. You may have the
originating side of one call interworking with the terminating side of
another. A special counting of these multi-leg calls is introduced to avoid
that twice the number of calls in progress is counted when the actual traffic
is 50% of the total call instances.
•
eisup—Displays EISUP-to-EISUP calls from the target.
•
sip—Displays SIP-to-SIP calls from the target.
•
ip—Displays SIP, EISUP, or H323 calls from the target.
•
TDM—Displays all SIP-to-TDM protocol calls, including SS7, ISDN, DPNSS, and
QSIG calls from the target.
•
calltime—Displays calls that have been established on the system for at least the
specified period, in minutes. For example, calltime=120 displays all calls
established for 2 hours or more.
•
detail—Displays the To and From numbers.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-17
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-CALLINFO—Display Call IDs of EISUP/SIP
Examples:
mml>
mml>
mml>
mml>
rtrv-callinfo:eisup-sigpath:all
rtrv-callinfo:eisup-sigpath:ip
rtrv-callinfo:all:timerperiod=120
rtrv-callinfo:sip:timerperiod=120,detail
when a call has video media, rtrv-callinfo:all:detail will has the following
corresponding output:
mml> rtrv-callinfo:all:detail
Retrieving results. This could take a few moments...
MGC-01 - Media Gateway Controller 2009-12-22 02:01:46.946 EST
M RTRV
"sip-path:CallID=6,Call_Type=REAL,CgPN=1965,CdPN=6781955"
"sip-path:CALL_STA=2009-12-22 02:01:31 EST"
"sip-path:[email protected]"
"sip-path:CALL=IN,MediaIPAddr=10.0.50.81,MediaPort=20012,Codec=PCMU"
"sip-path:VideoMediaIPAddr=10.0.50.81,VideoMediaPort=20014,VideoCodec=H264"
"sip-path:[email protected]"
"sip-path:CALL=OUT,MediaIPAddr=10.0.50.3,MediaPort=20024,Codec=PCMU"
"sip-path:VideoMediaIPAddr=10.0.50.3,VideoMediaPort=20026,VideoCodec=H264"
If the call has no video media, the following output will display:
mml> rtrv-callinfo:all:detail
Retrieving results. This could take a few moments...
MGC-01 - Media Gateway Controller 2009-12-21 23:27:56.556 EST
M RTRV
"sip-path:CallID=9,Call_Type=REAL,CgPN=1965,CdPN=6781955"
"sip-path:CALL_STA=2009-12-21 23:27:41 EST"
"sip-path:[email protected]"
"sip-path:CALL=IN,MediaIPAddr=10.0.50.81,MediaPort=20084,Codec=PCMA"
"sip-path:[email protected]"
"sip-path:CALL=OUT,MediaIPAddr=10.0.50.3,MediaPort=20094,Codec=PCMA"
When a call has transcoding service, different codecs are used on every call side. In the
following example, codec on the originating leg is PCMA(g711a), and codec on the
terminating leg is G729.
mml> rtrv-callinfo:all:detail
Retrieving results. This could take a few moments...
MGC-01 - Media Gateway Controller 2009-12-22 02:05:46.040 EST
M RTRV
"sip-path:CallID=8,Call_Type=REAL,CgPN=1965,CdPN=6781955"
"sip-path:CALL_STA=2009-12-22 02:05:33 EST"
"sip-path:[email protected]"
"sip-path:CALL=OUT,MediaIPAddr=10.0.182.2,MediaPort=16550,Codec=g729"
"sip-path:[email protected]"
"sip-path:CALL=IN,MediaIPAddr=10.0.182.2,MediaPort=16544,Codec=pcma"
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-18
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-CFG—Retrieve Configuration Table
For SIP B2BUA, different call legs are supported for each call side in a call. In the
following example, CID (Call ID to SIP) of originating side is different from that of the
terminating side.
mml> rtrv-callinfo:all:detail
Retrieving results. This could take a few moments...
MGC-01 - Media Gateway Controller 2009-12-22 02:05:46.040 EST
M RTRV
"sip-path:CallID=8,Call_Type=REAL,CgPN=1965,CdPN=6781955"
"sip-path:CALL_STA=2009-12-22 02:05:33 EST"
"sip-path:[email protected]"
"sip-path:CALL=OUT,MediaIPAddr=10.0.182.2,MediaPort=16550,Codec=g729"
"sip-path:[email protected]"
"sip-path:CALL=IN,MediaIPAddr=10.0.182.2,MediaPort=16544,Codec=pcma"
Comments:
Performance Impact Category: D
The RTRV-CALLINFO command enables you to display the call IDs of all EISUP/SIP
calls on the system. Optional parameters enable you to display the To and From
numbers or to display calls established longer than a specified time period. The
PRT-CALL and KILL-CALL commands are updated to support EISUP-to-EISUP
Calling.
RTRV-CFG—Retrieve Configuration Table
Comments
This command is no longer supported. The command prov-rtrv replaces it.
RTRV-CIC—Retrieve Bearer Channels
Purpose:
Retrieves bearer channel information for one or more circuits that are identified by a
signal path.
Syntax:
rtrv-cic:<sig path>:cic=<number>[,rng=<range>]
Input
Description:
•
sig path—MML component name of a signal path component.
•
number—A valid circuit identification code (CIC).
•
range—A number such that number + range is a valid CIC. All circuits between
number and number + range are displayed.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-19
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-CIC—Retrieve Bearer Channels
Output
Description:
•
<SIG PATH>—MML component name of a signal path component.
•
CIC—Circuit identification code.
•
PST—Primary state.
– IS—In service.
– OOS—Out of service.
•
CALL—Call state.
– IDLE—Circuit is idle, available for use.
– OOS—Out of service.
– IS—In service
•
GW_STAT—State of the gateway.
– CARRIER_FAILURE—Carrier has failed.
– GW_HELD—The call has been held at the gateway.
– CXN_IS—The connection is in service.
– CXN_OOS_ACTIVE—The connection is out of service on the active
system.
– CXN_OOS_STANDBY—The connection is out of service on the standby
system.
– INTERFACE_DISABLED
•
BLK—Blocking state
– GATEWAY—Locally blocked because of a gateway event (for example,
RSIP or a group service message).
– LOCAUTO—Hardware blocking type; the circuit is blocked by an external
message generated by a network element outside the media gateway.
– LOCMAN—Blocked manually by MML. This is removable by the
UNBLK-CIC or RESET-CIC command.
– LOCUNK—Locally blocked for unknown reasons. (This indicates a
potential software problem. Acircuit has become blocked but the software
did not track the cause of the blocking.)
– NONE—There is no block on the CIC. DS0 is available for use.
– REMAUTO—Remotely auto blocked.
– REMMAN—Remotely manually blocked.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-20
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-CTR—Retrieve Measurement Counter
Example:
The MML command shown in the following example retrieves bearer channel
information for CICs 276 through 281 on signal path SS7SVC1:
mml> RTRV-CIC:SS7SVC1:CIC=276,RNG=5
MGC-13 - Media Gateway Controller 2000-08-30 14:42:10
M RTRV
"ss7svc1:CIC=276,PST=IS,CALL=IDLE,GW_STAT=CXN_IS,BLK=NONE"
"ss7svc1:CIC=277,PST=IS,CALL=IDLE,GW_STAT=CXN_IS,BLK=NONE"
"ss7svc1:CIC=278,PST=IS,CALL=IDLE,GW_STAT=CXN_IS,BLK=NONE"
"ss7svc1:CIC=279,PST=IS,CALL=IDLE,GW_STAT=CXN_IS,BLK=NONE"
"ss7svc1:CIC=280,PST=IS,CALL=IDLE,GW_STAT=CXN_IS,BLK=NONE"
"ss7svc1:CIC=281,PST=IS,CALL=IDLE,GW_STAT=CXN_IS,BLK=NONE"
;
Comments:
Performance Impact Category: B, C; impact depends on number of CICs queried.
RTRV-CTR—Retrieve Measurement Counter
Purpose:
Displays a measurement counter for a component.
Syntax:
rtrv-ctr:<comp>:"<meas cat>"
Input
Description:
Output
Description:
Example:
•
comp—The MML name of the component you want to examine. Use the prov-rtrv
command described in the “PROV-RTRV—Retrieve Provisioning Information”
section on page 1-13 to retrieve a list of system components.
•
meas cat—Logical identifier that selects the measurement category or
measurement group. For a list of measurement categories, see the
“RTRV-CALLIM—Retrieves the Call Limiting Function Status” section on
page 1-16 to retrieve a list of measurement categories. For descriptions of
measurements, see Cisco PGW 2200 Softswitch Release 9 Provisioning Guide.
•
<COMP>—Component
•
CAT—Measurement category
•
BCKT—Bucket, which is the measurement interval defined as 15 minutes,
60 minutes, or 24 hours
•
VAL—Value measured
The MML command shown in the following example displays measurement counters
for the component ALGG-01:
mml> rtrv-ctr:ALGG-01
Media Gateway Controller 1999-02-18 15:38:50
M RTRV
"ALGG-01:CAT=\BCKT=\"b_prof_std15\",VAL=1000"
"ALGG-01:CAT=\BCKT=\"b_prof_std60\",VAL=2000"
"ALGG-01:CAT=\BCKT=\"b_prof_std24\",VAL=2000"
;
Comments:
Performance Impact Category: A
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-21
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-DCHAN—Retrieve D-Channel Status
RTRV-DCHAN—Retrieve D-Channel Status
Purpose:
Displays attributes of a D-channel or all D-channels.
Syntax:
rtrv-dchan:<D channel | fas link>
rtrv-dchan:all
Input
Description:
Output
Description:
•
dchannel—D-channel.
•
fas link—Facility associated signaling service or signaling past a particular
destination when you use either ISDN-PRI or DPNSS.
•
all—Displays attributes of all D-channels.
•
LID—Link ID.
•
PRI—Priority rate interface priority; this is an integer, either 0 or 1.
•
STBY—This is the standby D-channel.
•
PST—This is the primary D-channel. Valid values are:
– AOOS—The system has taken the resource out of service.
– INB—Installed busy (resource has been created but not yet commanded IS or
OOS by the SET-DCHAN command).
– IS—In service.
– MOOS—Manually taken out of service.
– OOS—Out of service.
– TRNS—Transient; the state is currently being changed.
– UNK—Unknown.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-22
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-DEST—Retrieve Destination
Example:
The MML command shown in the following example displays the attributes of
D-channel 1:
mml> RTRV-DCHAN:DCHAN-1
Media Gateway Controller 2000-06-05 16:42:56
M RTRV
"dchan-1:sigpath,LID=0:PRI,backup=dchan-2:STBY"
;
When the D-channel is associated with an FAS signaling path, the system returns a
message similar to the following:
mml> rtrv-dchan:dchan-1
Media Gateway Controller 2000-03-26 20:26:18
M RTRV
"dchan-1:fas1,LID=0:IS"
;
In this response, fas1 is the signaling path, or a logical grouping of D-channels
(equivalent to a linkset). The LID is the line identifier, or the logical line ID of the
D-channel within the signaling path (equivalent to the SLC in SS7). IS is the primary
service state of the D-channel.
When the D-channel is associated with an NFAS signaling path, the system returns a
message similar to the following:
mml> rtrv-dchan:dchan-1
Media Gateway Controller 2000-03-26 20:26:18
M RTRV
"dchan-1:nfas1,LID=0:PRI,backup=dchan-2:STBY"
;
In this response, nfas1 is the signaling path, or a logical grouping of D-channels
(equivalent to a linkset). The LID is the line identifier, or the logical line ID of the
D-channel within the signaling path (equivalent to the SLC in SS7). The next field
indicates whether the specified D-channel is the primary (PRI) channel or the standby
(STBY). Finally, the backup field specifies the MML name of the D-channel that is
configured as the backup to the specified D-channel.
Note
Comments:
Backup D-channels are not supported for QSIG/Q.931 Over BRI Backhaul
D-channels.
Performance Impact Category: A
RTRV-DEST—Retrieve Destination
Purpose:
Retrieves information about one or more destinations.
Syntax:
rtrv-dest:<sig path>
rtrv-dest:all
Input
Description:
•
sig path—The MML name of the logical signal channel for which you want to
display information. These should be signal path DSS IP, signal path NAS
entities, or rapath.
•
all—Displays information about all external point codes and signal paths.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-23
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-DEST—Retrieve Destination
Output
Description:
•
<SIG PATH>—Signal path
•
PKG—Protocol family
•
ASSOC—Associated channels
– UNK—Unknown.
– SWITCHED—The destination is switched, not associated.
– <CHANNEL>—The channel with which the destination is associated.
•
PST—Primary state; valid values are:
– AOOS—The system has taken it out of service.
– INB—Installed busy (resource has been created but not yet commanded IS
or OOS by the SET-DEST-STATE command).
– IS—In service.
– MOOS—Manually taken out of service.
– OOS—Out of service.
– TRNS—Transient; the state is currently being changed.
– UNK—Unknown.
•
SST—Secondary state valid values are:
– UND—Undefined
– CRTE—Created
– DLT—Deleted
– CIS—Commanded in service
– COOS—Commanded out of service
– FLD—Failed
– RSTO—Restored
– RST—Reset
– CONG—Congestion
– FOOS—Forced out of service
– CINH—Commanded to the inhibited state
– CUINH—Commanded to the uninhibited state
– CEA—Commanded into emergency alignment
– EIS—Engine in service
– EOOS—Engine out of service
Note
If the rtrv-dest MML command is entered after a switchover has occurred, the
state of some of the signaling services might be listed as undefined (UND).
UND is the default state for a signaling service when the system starts. In this
instance, UND indicates that the Cisco PGW 2200 Softswitch has not
received a service state message for the associated signaling service since the
switchover occurred. No user action is required.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-24
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-DNS-INFO—Retrieve DNS Cache
Example:
The MML command shown in the following example retrieves the destination of
signal path ss7svc1:
mml> RTRV-DEST:SS7SVC1
MGC-01 - Media Gateway Controller 2001-02-08 13:06:29
M RTRV
"ss7svc1:PKG=SS7-ANSI,ASSOC=SWITCHED,PST=IS,SST=RSTO"
;
The MML command shown in the following example retrieves the destination of
racluster signal path:
mml> RTRV-DEST:racluster1
MGC-01 - Media Gateway Controller 2006-08-08 13:06:29
M RTRV
“racluster1:PKG=MGCP,ASSOC=SWITCHED,PST=IS,SST=RSTO”
Comments:
Performance Impact Category: C
This command supports wildcarding.
RTRV-DNS-INFO—Retrieve DNS Cache
Purpose:
Retrieves information from a domain name server (DNS) cache.
Syntax:
rtrv-dns-info:<sip-sig path>
Input
Description:
•
sig path sip—MML name of SIP signal path.
Output
Description:
•
<IO CARD>—Input/output card.
•
<DOMAIN NAME>—URL (universal resource locator)
•
<IP ADDRESS>—IP address
•
<TIME TO LIVE>—TTL
•
<CACHE ENTRY COUNT>—Cache size
•
<CACHE ENTRY COUNT>—Cache usage
•
<IP ADDRESS OF DNS SERVER 1>—DNS 1 address
•
<IP ADDRESS OF DNS SERVER 2>—DNS 2 address
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-25
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-EQPT—Retrieve Service State of a Component
Example:
The MML command in the following example presents DNS information for the SIP
signal path:
mml> rtrv-dns-info:sip-sigpath
Media Gateway Controller - MGC-01 2000-12-30 14:27:48
M RTRV
/*
DNS 1 address 193.12.77.2
DNS 2 address 193.21.9.76
Cache size = 280
Cache usage = 81
Local TTL = 240
*/
;
Comments:
Performance Impact Category: A.
You must execute the STA-DNS-INFO command before using the
RTRV-DNS-INFO command.
RTRV-EQPT—Retrieve Service State of a Component
Comments:
This command is no longer supported.
RTRV-H248:CNTXS:SIGPATH—Retrieve H.248 Sigpath
Information (Release 9.7(3))
Purpose:
Displays all H.248 context information in one sigpath or all the terminations in each
context.
Syntax:
rtrv-h248:cntxs:sigpath=”h248-sigpath-name",cntxid="all/context id"
Input
Description:
Example:
•
sigpath-name—Name of the H.248 signal path, the route of a signal channel that
carries signaling data.
•
cntxid—Context ID.
The MML command shown in the following example displays all context information
for the h248-sigpath-01 signal path:
mml> rtrv-h248:cntxs:sigpath=”h248-sigpath-01”,cntxid=”ll”
Comments:
Performance Impact Category: A
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-26
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-IPLNK—Retrieve Attributes of an IP Link
RTRV-IPLNK—Retrieve Attributes of an IP Link
Purpose:
Displays the attributes of an NAS, MGCP, SIP, or EISUP IP link.
Syntax:
RTRV-IPLNK:<IP LINK>
RTRV-IPLINK:all
Input
Description:
•
<IP LINK>—MML component name of a previously configured IP link.
•
all—Displays the measurements for all links.
Output
Description:
•
<PARENT NAME>—IP link name.
•
<PST>—Primary state; valid values are:
– AOOS—The system has taken the resource out of service.
– INB—Installed busy (resource has been created but not yet commanded IS or
OOS by the SET-IPLNK command).
– IS—In service.
– COOS—Commanded out of service.
– FOOS—Forced out of service.
– OOS—Out of service.
– OFF_DUTY—Redundant link.
– TRNS—Transient; the state is currently being changed.
– UNK—Unknown.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-27
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-IPLNK—Retrieve Attributes of an IP Link
Example:
The MML command shown in the following example displays the measurements for all
links:
mml> RTRV-IPLNK:ALL
MGC-01 - Media Gateway Controller 2001-01-01 18:57:26
M RTRV
"mgcplk3:IS"
"mgcplk4:IS"
"eisuplk2:IS"
"lnkmgx5-30:OOS"
"mgcplk381011:IS"
"mgcplk381012:IS"
"mgcplk381010:IS"
The MML command shown in the following example displays the measurements for all
links on a standby mode:
mml> RTRV-IPLNK:ALL
MGC-01 - Media Gateway Controller 2003-06-16 14:47:33.390 EST
M RTRV
"lhsi-silver:IS"
"lsip1-venus-1:IS"
"lnk1-eisup-node2:OOS"
"lnk2-eisup-node2:OOS"
"lnk1-eisup-node3:IS"
"lnk2-eisup-node3:OOS"
"lnk3-eisup-node3:IS"
"lnk4-eisup-node3:OOS"
"mgcpsvc-5350-31-2:IS,OFF_DUTY"
"mgcplnk-5350-31-1:IS"
"mgcplnk-5350-30-2:IS,OFF_DUTY"
"mgcplnk-5350-30-1:IS"
"l5850-30-1:IS"
"l5850-30-2:IS,OFF_DUTY"
"l5850-31-2:IS"
"l5850-31-1:IS,OFF_DUTY"
"lsip2-venus-1:IS,OFF_DUTY"
"mgcpsvc-5350-32-1:IS"
The MML command shown in the following example retrieves the state of all IP links:
mml> rtrv-iplnk:all
MGC-01 - Media Gateway Controller 2003-01-07 09:36:38.485 EST
M RTRV
“nas1link1:IS”
“nas2link1:OOS”
“c7-slt1-1:IS”
“c7-slt2-1:IS”
mml> rtrv-iplnk:nas1link1
MGC-01 - Media Gateway Controller 2003-01-07 09:38:10.821 EST
M RTRV
“nas1link1:IS”
/*link 1 to nas*/
Comments:
Performance Impact Category: A
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-28
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-IPROUTE—Display Primary and Secondary States of an IP Route
RTRV-IPROUTE—Display Primary and Secondary States of an IP
Route
Purpose:
Displays the primary and secondary states of an IP route.
Syntax:
rtrv-iproute:ip_route_name
rtrv-iproute:all
Input
Description:
Output
Description:
•
Ip_route_name—MML name of a previously configured IP route.
•
All—Retrieves the primary state of all IP routes.
IP route—MML name of the specified IP route.
PST—Primary state; valid values are:
– IS—In service
– OOS—Out of service
SST—Secondary state; valid values are:
– COOS—Commanded out of service
– STBY—The local platform state is standby
– OFF_DUTY—The link is available for use but is not currently being used.
– CONF—The link is out of service because of a configuration failure.
Example:
The MML command shown in the following example retrieves the state of all IP
routes:
mml> rtrv-iproute:all
MGC-01 - Media Gateway Controller 2002-06-25 15:13:40.983 EST
M RTRV
"iproute1:IS"
"iproute2:IS"
Comments:
Performance Impact Category: A
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-29
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-LICS—DISPLAY LICENSES
RTRV-LICS—DISPLAY LICENSES
Purpose:
Displays the number of licenses to which you are entitled, the number of these
licenses that are currently used, and the number of free licenses that are available.
This MML command runs on an active PGW and retrieves the license information. If
you run it on a standby PGW, you can correctly retrieve only the base license
information; other types of license are displayed as unentitled on a standby PGW.
Syntax:
rtrv-lics:base
rtrv-lics:Interface
rtrv-lics:configure
rtrv-lics:runtime
rtrv-lics:SBEinterface
rtrv-lics:TimesTen License
rtrv-lics:all
Input
Description:
Output
Description:
•
base—Base license information
•
interface—Interface license information
•
configure—Configuration TDM Ports license information
•
runtime—Run-time license information
•
all—All license information
•
Entitled—Indicates if the interface is licensed and the number of licenses.
•
Used—Indicates if the interface is used and the number of licenses provisioned.
•
Available—Indicates the number of unused licenses.
•
Run-time license
– Entitled license number—Number of licenses
– Current usage—Runtime counter of call legs
– Peak usage (15 min)—Measurement of peak usage (15-minute span)
– Peak usage (60 min)—Measurement of peak usage (60-minute span)
– Peak usage (24 hours)—Measurement of peak usage (24-hour span)
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-30
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-LOCLABEL
Example:
The MML command shown in the following example displays all license information:
mml>rtrv-lics:all
------------------------------------------------------------------------PGW Internal Lab License
9.8 permanent
-----------------------------------------------------------------Interface Name
Entitled
Provisioned
SS7Interface
Y
Y
PRIInterface
Y
N
PBXInterface
Y
Y
INAPInterface
Y
Y
LIInterface
Y
N/A
SBEInterface
Y
N/A
-----------------------------------------------------------------Configure TDM Ports
Entitled
Provisioned
Available
Call Control
5000000
77
4999923
-----------------------------------------------------------------------------TimesTen License
Entitled
Provisioned
Available
10000
5000
5000
------------------------------------------------------------------------------Run Time License
TDMPorts
SIP
H323
Entitled Number
5000000
5000000
5000000
Current Usage
0
0
0
Peak Usage(15 min)
0
0
0
-------------------------------------------------------------------------
Comments:
Performance Impact Category: A
RTRV-LOCLABEL
Purpose:
Displays the measurements of a location label.
Syntax:
rtrv-loclabel:loclabel name
rtrv-loclabel:all
rtrv-loclabel:all:percent=number
Input
Description:
Output
Description:
•
loclabel name—Retrieves the measurements of a location label.
•
All—Retrieves the measurements of all location labels
•
All:percent=number—Retrieves the measurements for all location labels that
used labels within the percentage.
•
loc1—location label name.
•
loc2—defined call limit number
•
loc3—active call number</syntax>
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-31
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-LOG
Example:
The MML command that follows displays the measurements for all location labels:
mml> rtrv-loclabel:all
MGC-01 - Media Gateway Controller 2001-01-01 18:57:26
M RTRV
"loc1:LIMIT=100,ACTIVE=0"
“loc2:LIMIT=500,ACTIVE=400”
“loc3:LIMIT=1000,ACTIVE=50”</examples>
Comments:
Performance Impact Category: A
Purpose:
Displays the logging level of a process or of all processes.
Syntax:
rtrv-log:all
rtrv-log:<proc>
RTRV-LOG
Input
Description:
•
all—Displays the logging levels of all processes.
•
proc—The various actively and passively monitored processes running on the
Cisco PGW 2200 Softswitch. See the “SET-LOG—Set Logging Levels” section on
page 1-66 for a list of logging levels. Use the RTRV-SOFTW:ALL command to
display all processes.
See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for more information.
Output
Description:
•
<PROCESS>—Process name
– CRIT—Critical
– WARN—Warning
– ERR—Error
– TRACE—Trace
– INFO—Informational
– DEBUG—Debug
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-32
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-LSET—Retrieve Linkset Service State
Example:
The MML command shown in the following example retrieves the logging level of the
process manager (PM-01) process:
mml> RTRV-LOG:PM-01
Media Gateway Controller
M RTRV
"PM-01:DEBUG"
;
Comments:
- MGC-01 2000-01-16 09:38:03
Performance Impact Category: A
The process manager (PM-01) is not included in the all parameter, because this is a
special process. For the logging level of PM-01 to be retrieved, it must be used
individually, as in the preceding example.
For the software Release 7.4, two processes do not support log-level commands:
DSKM-01 and LOG-01. For these two processes, the following message is returned:
/*Function not supported*/
RTRV-LSET—Retrieve Linkset Service State
Purpose:
Syntax:
Retrieves the service state of a linkset.
rtrv-lset:<linkset>
Input
Description:
•
<linkset>—The provisioning component C7 link, a TDM link used in a linkset, or
a linkset. See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for a
description of C7 linksets. Use the prov-rtrv command, described in the
“PROV-RTRV—Retrieve Provisioning Information” section on page 1-13, for a list
of linksets.
Output
Description:
•
AOOS—The system has taken the resource out of service.
•
INB—Installed busy (resource has been created but not yet commanded IS or OOS
by the set-dest command).
•
IS—In service.
•
MOOS—Manually taken out of service.
•
OOS—Out of service.
•
TRNS—Transient; the state is currently being changed.
•
UNK—Unknown.
Example:
The MML command shown in the following example retrieves the service state of
linkset ls1:
mml> RTRV-LSET:ls1
Media Gateway Controller
M RTRV
MOOS
;
Comments:
- MGC-01 2000-01-12 15:19:51
Performance Impact Category: A
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-33
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-LSSN—Retrieve State of All Local SSNs
RTRV-LSSN—Retrieve State of All Local SSNs
Purpose:
Displays the state of all local SSNs (LSSNs).
Syntax:
rtrv-lssn:all
Output
Description:
•
<process>—Name of process
•
<lssn>—Name of local subsystem number
•
pst—Primary state
– is—In service
– oos—Out of service
Example:
The MML command shown in the following example displays all local SSNs:
mml> RTRV-LSSN:all
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M RTRV
"TCAP-01:SSN=1,PST=IS"
"TCAP-01:SSN=2,PST=OOS"
;
Comments:
Performance Impact Category: A
RTRV-MML—Retrieve Active MML Sessions
Purpose:
Displays all active MML sessions, their session numbers, and the user IDs of the
session originators.
Syntax:
rtrv-mml
Output
Description:
•
MML1—Session number
– <username>—UNIX username of session owner
•
MML2—Session number
– <username>—UNIX username of session owner
Example:
The MML command shown in the following example shows all active MML sessions:
mml> RTRV-MML
Media Gateway Controller
M RTRV
mml5:guest
;
Comments:
- MGC-01 2000-01-12 15:19:51
Performance Impact Category: A
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-34
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-NE—Retrieve Network Element Attributes
RTRV-NE—Retrieve Network Element Attributes
Purpose:
Displays information about the Cisco PGW 2200 Softswitch hardware, software, and
current state (active or standby).
Syntax:
RTRV-NE
Output
Description:
•
Type—Type of controller.
•
Hardware Platform—Hardware platform.
•
Vendor—Cisco PGW 2200 Softswitch vendor.
•
Location—Controller machine name.
•
Version—Controller software version.
•
Platform State—Use of controller.
– ACTIVE—The controller in use.
– STANDBY—The redundant controller.
Example:
The MML command shown in the following example displays information about the
Cisco PGW 2200 Softswitch:
mml> RTRV-NE
Media Gateway Controller - MGC-01 2000-01-12 12:00:47
M RTRV
"Type:MGC"
"Hardware platform:sun4u sparc SUNW,Ultra-30"
"Vendor:"Cisco Systems, Inc.""
"Location:Media Gateway Controller - MGC-01"
"Version:"7.3(10).r2""
"Platform State:ACTIVE"
;
Comments:
Performance Impact Category: A
RTRV-NE-HEALTH—Retrieve Network Element Health
Purpose:
Displays the health information of the Cisco PGW 2200 Softswitch network element.
This includes information about physical and virtual memory allocation, as well as CPU
percentages showing the available computing resources, proc/memory utilization,
machine congestion level, congestion reason, active alarm statistics, and call processing
statistics.
Syntax:
rtrv-ne-health
rtrv-ne-health::sys
rtrv-ne-health::callp
rtrv-ne-health::load
rtrv-ne-health::all
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-35
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-NE-HEALTH—Retrieve Network Element Health
Input
Description:
•
sys—Retrieves the top-level status of the Cisco PGW 2200 Softswitch host and the
number of active alarms, arranging the alarms in order of severity.
•
callp—Retrieves:
– Machine congestion level (MCL)
– Current number of calls in progress
– Current call attempt rate over the previous few seconds
– Number of successful calls over the last 15-, 60-, and 1440-minute collection
intervals
– Number of failed call setups over the last 15-, 60-, and 1440-minute collection
intervals
•
load—Retrieves:
– MCL
– CPU utilization
– Free memory
– Percentage of used disk space by partition
Output
Description:
•
all—All of the above indicators.
•
MEMORY:REAL—Total amount of physical memory that can be allocated for use
by processes. (It does not include memory reserved for use by the kernel.)
•
MEMORY:FREE—Amount of unallocated physical memory.
•
MEMORY: SWAP IN USE—Amount of swap area on the disk that is being used.
•
MEMORY: SWAP FREE—Amount of swap area on the disk that is still available.
•
CPU STATES—Fractions of the total available computing resources. These must
total 100 percent.
– IDLE—Percentage of CPU resources available
– USER—Percentage consumed by users
– KERNEL—Percentage used by the kernel
– IOWAIT—Percentage used by the input-output wait process
– SWAP—Percentage of CPU used in swap activity
•
CALL: SIPLicRej TOT— SIP call rejected because of run-time license
management.
•
CALL: H323LicRej TOT—H323 call rejected because of run-time license
management.
•
CALL: TDMLicRej TOT—TDM call rejectedbecause of run-time license
management.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-36
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-NE-HEALTH—Retrieve Network Element Health
Example:
The MML command shown in the following example retrieves the state of the
Cisco PGW 2200 Softswitch network:
mml> RTRV-NE-HEALTH
MGC-01 - Media Gateway Controller 2000-06-07 12:47:44
M RTRV
Memory: 8192M real, 469M free, 214M swap in use, 1833M swap free
CPU states: 80.5% idle,
0.0% swap
;
6.7% user, 11.2% kernel, 1.6% iowait,
The command in the following example displays the status of the
Cisco PGW 2200 Softswitch host and the number of active alarms listed in order of
severity:
mml> RTRV-NE-HEALTH::SYS
Media Gateway Controller 2000-06-07 16:39:41
M RTRV
"Platform State:ACTIVE"
"2 critical, 4 major, 8 minor active alarms"
;
The command in the following example displays all the health information of the
network element:
mml> RTRV-NE-HEALTH:ALL
MGC-01 - Media Gateway Controller 2005-03-14 17:44:55.336 PST
M COMPLD
"Platform State:ACTIVE"
"0 critical, 1 major, 0 minor active alarms"
"Machine Congestion Level = MCL 1, Reason: queue length"
"Current in progress calls = 7924, call attempts = 65 cps"
"CPU 0 Utilization = 50 % CPU 1 Utilization = 52 %"
"CPU 2 Utilization = 54 % CPU 3 Utilization = 49 %"
"Memory (KB): 14333880 Free virtual, 18827672 Total virtual, 16777216
Total real"
"Interval (minutes)
15
60
1440"
"CALL: SuccCall TOT
62689
62689
62689"
"CALL: FailCall TOT
113
113
113"
"Filesystem
kbytes
used
avail capacity Mounted on"
"/dev/dsk/c1t0d0s0
1490047 159084 1271362
12%
/"
"/dev/dsk/c1t0d0s5
66262523 43311518 22288380
67%
/opt"
;
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-37
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-OVLD—Retrieve Overload Level
Example:
The command in the following example displays the status of the
Cisco PGW 2200 Softswitch host and the number of calls rejected by license failure. If
a call is rejected by license, the corresponding LicRej measurement is increased, and
CALL: SuccCall TOT is increased. CALL: FailCall TOT is not increased, because there
is no protocol outage for this call flow.
mml> RTRV-NE-HEALTH::ALL
MGC-01 - Media Gateway Controller 2006-05-18 08:21:02.581 EDT
M COMPLD
''Platform State:ACTIVE''
''0 critical, 19 major, 0 minor active alarms''
''Machine Congestion Level = MCL 0 (No Congestion), Reason: not
applicable''
''Current in progress calls = 0, half calls = 0, full calls = 0, call
attempts = 0 cps''
''CPU 0 Utilization = 0 % CPU 1 Utilization = 2 %''
''Memory (KB): 4921240 Free virtual, 6193264 Total virtual, 2096696 Total
real''
''Interval (minutes) 15 60 1440''
''CALL: SuccCall TOT 0 0 0''
''CALL: FailCall TOT 0 0 0''
''CALL: SIPLicRej TOT 0 0 0''
''CALL: H323LicRej TOT 0 0 0''
''CALL: TDMLicRej TOT 0 0 0''
''Filesystem kbytes used avail capacity Mounted on''
''/dev/dsk/c0t2d0s0 1986446 467404 1459449 25% /''
''/dev/dsk/c0t2d0s5 57416722 11775209 45067346 21% /opt''
;
RTRV-OVLD—Retrieve Overload Level
Purpose:
Displays the machine congestion level, congestion reason, and number of messages
rejected caused by far end congestion.
Syntax:
rtrv-ovld
Output
Description:
Example:
•
<COMPONENT>—MML component name
•
MCL—Machine congestion level
•
Congestion Reason
•
Calls rejected
The MML command shown in the following example displays the congestion level and
number of calls rejected:
mml> RTRV-OVLD
Media Gateway Controller - MGC-01 2006-01-12 15:19:51
M RTRV
"ENGG-01: MCL=0,Calls Rejected=10"
“tg-1000: Far End Congestion: Calls Rejected=5”
;
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-38
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-RASERVER (Release 9.7(3))
RTRV-RASERVER (Release 9.7(3))
Purpose:
Displays the status of one or more RADIUS servers. Only one RADIUS server can be
in service at any given time.
Syntax:
rtrv-raserver:name=server-name
Input
Description:
•
server-name—The name of the RADIUS accounting server for which you want
to display status.
Output
Description:
•
IS—In service
•
IS—Off duty
•
OOS—Out of service
Example:
mml> rtrv-raserver:raserver1
MGC-13 - Media Gateway Controller 2006-08-30 14:42:10
M RTRV
"raserver1, ST=IS "
;
mml> rtrv-raserver:all
MGC-13 - Media Gateway Controller 2003-08-30 14:42:10
M RTRV
“raserver1, ST=IS”
“raserver2, ST=IS,OFF_DUTY”
;
RTRV-RSSN—Retrieve State of All Remote SSNs
Purpose:
Displays the state of all remote SSNs (RSSNs).
Syntax:
rtrv-rssn:all
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-39
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-RTE—Retrieve Route
Output
Description:
•
<link>—Name of link
•
<RSSN>—Remote subsystem number
•
PC—Point code(s)
•
SSN—Subsystem number
•
PST—Primary state
– IS—In service
– OOS—Out of service
Example:
The MML command in the following example displays the state of all remote SSNs:
mml> RTRV-RSSN:all
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M RTRV
"stp1:PC=007.007.007,SSN=1,PST=OOS"
"stp2:PC=008.008.008,SSN=1,PST=OOS"
"stp3:PC=009.009.009,SSN=2,PST=OOS"
;
RTRV-RTE—Retrieve Route
Purpose:
Retrieves all SS7 routes for a point code or for all point codes.
Syntax:
rtrv-rte:<dpc name>
rtrv-rte:all
Input
Description:
•
dpc name—The MML component name of a destination point code
•
all—Retrieves all SS7 routes for all point codes
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-40
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-SC-TRC—Retrieve Names of Open Signal Channel Traces
Output
Description:
•
<PC>—Target point code
•
<LINKSET>—Linkset ID
•
APC—Adjacent point code
•
PRIO—Priority set for the routes
•
PST—Primary state; valid values are:
– AOOS—The system has taken the resource out of service.
– INB—Installed busy (resource has been created but not yet commanded IS
or OOS by the SET-DEST command).
– IS—In service.
– MOOS—Manually taken out of service.
– OOS—Out of service.
– TRNS—Transient; the state is currently being changed.
– UNK—Unknown.
•
SST—Secondary state; valid values are:
– NA—Cause not available.
– LINS—Linkset failure.
– PRHB—C7 prohibited (PGW has received a transfer-prohibited message or
TFP from the STP).
– RSTR—C7 restricted (PGW has received a transfer-restricted message or
TFR from the STP).
Example:
The MML command shown in the following example retrieves the routes for
destination point code PC-002. The output shows that PC-002 is the target, LS01 is
the linkset ID, APC=000.0028.007 is the adjacent point code, and PRIO is the priority
set for the routes.
mml> RTRV-RTE:PC-002
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M RTRV
PC-002:LS01,APC=000.028.007,PRIO=1,PST=IS,SST=NA
Comments:
Performance Impact Category: A
RTRV-SC-TRC—Retrieve Names of Open Signal Channel Traces
Purpose:
Displays the names of all files currently open for traces in progress or the stop reason
of the last trace file. The three normal stop reasons are : MCL reaches, prd expires,
and autostop. See the “STA-SC-TRC—Start Trace” section on page 1-73 and the
“STP-SC-TRC—Stop One or All Traces” section on page 1-80 for information on
starting and stopping traces.
Syntax:
rtrv-sc-trc
rtrv-sc-trc::stopreason
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-41
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-SGP—Display the Primary and Secondary States of an SGP
Output
Description:
Example:
Names of all files currently open for traces in progress.
•
The MML command shown in the following example displays the filenames of open
traces:
mml> RTRV-SC-TRC
Media Gateway Controller 2000-03-21 15:28:03
M RTRV
"RTRV-SC-TRC:Trace in progress for the following files:
../var/trace/_dpc1_19991221131108.btr
../var/trace/sigtest_dpc2_19991221131109.btr
"
;
Comments:
Performance Impact Category: B
RTRV-SGP—Display the Primary and Secondary States of an
SGP
Purpose:
Displays the primary and secondary states of one or all SS7 SGPs.
Syntax:
rtrv-sgp:sgp_name
rtrv-sgp:all
Input
Description:
Output
Description:
•
Isgpe_name—MML name of a previously configured SGP.
•
all—Retrieves the primary state of all SGPs.
IP route—MML name of the specified IP route.
PST—Primary state; valid values are:
– INB—Installed busy (resource is being created, its state has not been
determined yet).
– IS—In service.
– OOS—Out of service.
SST—Secondary state; valid values are:
– STBY—The local platform state is standby.
– CONF—The link is out of service because of a configuration failure.
Example:
The MML command shown in the following example retrieves the state of all SGPs:
mml> rtrv-sgp:all
MGC-01 - Media Gateway Controller 2003-01-25 15:13:40.983 EST
M RTRV
"sgp1:IS"
"sgp2:IS"
Comments:
Performance Impact Category: A
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-42
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-SIP—Display Call IDs of SIP Calls
RTRV-SIP—Display Call IDs of SIP Calls
Comments:
This command is no longer supported. The command prov-callinfo replaces it.
RTRV-SOFTW—Retrieve Software Status for a Process
Purpose:
Displays the status of one process or all processes.
Syntax:
rtrv-softw:<proc>
rtrv-softw:all
Input
Description:
•
proc—The MML name of a process or process group.
•
all—Displays the status of all processes.
Output
Description:
•
<PROCESS>—Process name
•
STATUS OF PROCESS
– UNKNOWN—State of the process is unknown.
– STOPPED—Process is not running.
– INIT—Process is being initialized.
– INIT CMPL—Initialization has been completed.
– CUT WAIT—Cutover has occurred, waiting. (This state is momentary and
unlikely to be seen.)
– RUNNING—Process is running.
– LOCKED—Process is locked.
– CUT MASTER—Process is the master in a cutover situation. (This state is
momentary and unlikely to be seen.)
– CUT SLAVE—Process is the slave in a cutover situation. (This state is
momentary and unlikely to be seen.)
– TERM—Process is terminating.
– RUNNING ACTIVE—Process is running on the active system.
– RUNNING STANDBY—Process is running on the standby system.
– RUNNING OOS—Process is running, but out of service.
– RUNNING IN N/A STATE—Process is running, but in a not available state.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-43
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-SPC—Retrieve Point Code
Example:
The MML command shown in the following example displays the status of all processes
and process groups:
mml> RTRV-SOFTW:all
Media Gateway Controller - MGC-02 2000-01-17 11:37:23
M RTRV
"CFM-01:RUNNING ACTIVE"
"ALM-01:RUNNING ACTIVE"
"MM-01:RUNNING ACTIVE"
"AMDMPR-01:RUNNING ACTIVE"
"CDRDMPR-01:RUNNING ACTIVE"
"DSKM-01:RUNNING IN N/A STATE"
"MMDB-01:RUNNING IN N/A STATE"
"POM-01:RUNNING ACTIVE"
"MEASAGT:RUNNING ACTIVE"
"OPERSAGT:RUNNING ACTIVE"
"PROVSAGT:RUNNING ACTIVE"
"PRIL3-1:RUNNING IN N/A STATE"
"Replic-01:RUNNING ACTIVE"
"ENG-01:RUNNING ACTIVE"
"IOCM-01:RUNNING ACTIVE"
"TCAP-01:RUNNING IN N/A STATE"
"IOCC-ASP:RUNNING IN N/A STATE"
"FOD-01:RUNNING IN N/A STATE"
"MGCP-1:RUNNING IN N/A STATE"
"EISUP-1:RUNNING IN N/A STATE"
"SS7-A-1:RUNNING IN N/A STATE"
"SS7-I-1:RUNNING IN N/A STATE"
;
Comments:
Performance Impact Category: A
RTRV-SPC—Retrieve Point Code
Purpose:
Displays the route set for one provisioning component point code or the route sets of all
point codes.
Syntax:
rtrv-spc:<sigpath>
rtrv-spc:all
Input
Description:
•
sig path—The MML component name of a provisioning component signal path.
•
all—Displays information for all signal paths.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-44
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-SP-CTR—Retrieve SS7/C7 Signaling Point Measurements
Output
Description:
•
SIG PATH—The MML component name of a provisioning component signal path.
•
DPC—Destination point code
•
DNW—Network indicator
•
OPC—Originating point code
•
<PST>—Primary state; valid values are:
– AOOS—The system has taken the resource out of service.
– INB—Installed busy (resource has been created but not yet commanded IS or
OOS by the SET-SPC command).
– IS—In service.
– MOOS—Manually taken out of service.
– OOS—Out of service.
– TRNS—Transient; the state is currently being changed.
– UNK—Unknown.
Example:
The MML command shown in the following example retrieves a list of all destination
point codes:
mml> RTRV-SPC:all
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M RTRV
"dpc1:DPC=012.012.012,DNW=2:OPC=011.011.011:IS"
"dpc2:DPC=013.013.013,DNW=2:OPC=011.011.011:IS"
"dpc3:DPC=014.014.014,DNW=2:OPC=011.011.011:AOOS"
"dpc5:DPC=111.111.111,DNW=2:OPC=011.011.011:AOOS"
"stp1:DPC=007.007.007,DNW=2:OPC=011.011.011:IS"
"stp2:DPC=008.008.008,DNW=2:OPC=011.011.011:IS"
"stp3:DPC=009.009.009,DNW=2:OPC=011.011.011:AOOS"
;
Comments:
Performance Impact Category: A
RTRV-SP-CTR—Retrieve SS7/C7 Signaling Point Measurements
Purpose:
Returns measurement data for one SS7 signaling point or for all SS7 signaling points.
The measurements are displayed in the same format as for RTRV-CTR.
Syntax:
rtrv-sp-ctr:<ss7 service>
rtrv-sp-ctr:all
Input
Description:
•
•
ss7 service—The MML component name of a single SS7 signal service.
all—Displays measurements for all signal points.
Note
RTRV-CTR:<ss7 service>:<group> is a related command.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-45
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-SS7-SLT—Retrieve SS7 SLT Test Results
Output
Description:
Example:
•
<COMP>—Component.
•
CAT—Measurement category. For a list of measurement categories, see
meascategories in the “RTRV-CALLIM—Retrieves the Call Limiting Function
Status” section on page 1-16. For descriptions of measurements, see
Cisco PGW 2200 Softswitch Release 9 Provisioning Guide.
•
INT—Measurement interval.
•
VAL—Value measured.
The MML command shown in the following example retrieves all measurements for
point code svc1:
mml> RTRV-SP-CTR:ss7svc1
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M RTRV
"ss7svc1:CAT=\"C7SP: XMIT MSU DROP/RTE\",INT=1800,V
"ss7svc1:CAT=\"ISUP: RCV CGBA TOT\",INT=300,VAL=0"
"ss7svc1:CAT=\"ISUP: RCV CGBA TOT\",INT=1800,VAL=0"
"ss7svc1:CAT=\"ISUP: RCV RLC TOT\",INT=300,VAL=555"
"ss7svc1:CAT=\"ISUP: RCV RLC TOT\",INT=1800,VAL=203
"ss7svc1:CAT=\"ISUP: RCV CGB TOT\",INT=300,VAL=0"
"ss7svc1:CAT=\"ISUP: RCV CGB TOT\",INT=1800,VAL=0"
"ss7svc1:CAT=\"ISUP: XMIT PAM TOT\",INT=300,VAL=0"
"ss7svc1:CAT=\"ISUP: XMIT PAM TOT\",INT=1800,VAL=0"
"ss7svc1:CAT=\"ISUP: XMIT CGBA TOT\",INT=300,VAL=0"
"ss7svc1:CAT=\"ISUP: XMIT CGBA TOT\",INT=1800,VAL=0
"ss7svc1:CAT=\"ISUP: RCV CRM TOT\",INT=300,VAL=0"
"ss7svc1:CAT=\"ISUP: RCV CRM TOT\",INT=1800,VAL=0"
"ss7svc1:CAT=\"ISUP: RCV REL TOT\",INT=300,VAL=0"
"ss7svc1:CAT=\"ISUP: RCV REL TOT\",INT=1800,VAL=0"
"ss7svc1:CAT=\"ISUP: XMIT CGUA TOT\",INT=300,VAL=0"
"ss7svc1:CAT=\"ISUP: XMIT CGUA TOT\",INT=1800,VAL=0"
;
Comments:
Performance Impact Category: A
RTRV-SS7-SLT—Retrieve SS7 SLT Test Results
Purpose:
Retrieves the results of a signal link test.
Syntax:
rtrv-ss7-slt:<C7 link>
Input
Description:
•
c7 link—The MML component name of a signal channel configured for SS7. See
Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for more information
about configuring a signal channel.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-46
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-SS7-SRT—Retrieve SS7 SRT Test Results
Output
Description:
•
<C7 LINK>—The MML component name of the C7 link where the test is
performed.
•
TEST PASSED
•
TEST FAILED. Reasons for failure can be any of the following:
– TEST TIMEOUT
– LINK INACTIVE
– LINKSET INACTIVE
– ROUTE UNAVAILABLE
– INVALID TEST PATTERN
– INVALID SLC
– FLOW CONTROL ON
– UNKNOWN REASON
Example:
•
<COMPLETION TIME>.
•
TEST RUNNING.
The MML command shown in the following example retrieves a signal link test started
by the command STA-SS7-SLT:LS1LINK1:
mml> RTRV-SS7-SLT:LS1LINK1
Media Gateway Controller - MGC-01 2000-01-12 15:18:41
M RTRV
"ls1link1:TEST PASSED; COMPLETED 15:18:34"
;
Comments:
Performance Impact Category: A
RTRV-SS7-SRT—Retrieve SS7 SRT Test Results
Purpose:
Retrieves the results of a Japanese signal route test on an ss7path. The rtrv result has
three possibilities: TEST PASSED, TEST FAILED, and TEST RUNNING.
Syntax:
rtrv-ss7-srt:<ss7path>:LSET="<C7 link/set>"
Input
Description:
•
ss7path—The MML component name of an adjacent ss7path configured for
Japanese SS7.
•
C7 link/set—The MML provisioning component name of a linkset or C7 IP link or
TDM link used in a linkset.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-47
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-SS7-SRT—Retrieve SS7 SRT Test Results
Output
Description:
•
<C7 LINK>—The MML component name of the C7 link the test is performed
upon.
•
TEST PASSED
•
TEST FAILED (reasons for failure can be any of the following:)
– TEST TIMEOUT
– LINK INACTIVE
– LINKSET INACTIVE
– ROUTE UNAVAILABLE
– INVALID TEST PATTERN
– INVALID SLC
– FLOW CONTROL ON
– UNKNOWN REASON
Example:
•
<COMPLETION TIME>
•
TEST RUNNING
The MML command shown in the following example retrieves the results of a signal
route test run with the command STA-SS7-SRT:SS7PATH1:LSET="LS1".
mml> RTRV-SS7-SRT:SS7PATH1:LSET="LS1"
Media Gateway Controller - MGC-01 2000-01-12 15:20:09
M RTRV
"ss7path1:TEST FAILED; TEST TIMEOUT; COMPLETED 15:20:01"
;
Comments:
Performance Impact Category: A
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-48
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-TC—Retrieve Bearer States
RTRV-TC—Retrieve Bearer States
Purpose:
Adds a filter to the rtrv-tc command so that it can display available bearer states.
Syntax:
rtrv-tc:all:[STAT]
rtrv-tc:tg:[STAT]
rtrv-tc:sigpath:[STAT]
rtrv-tc:tg:[[pst=value][,call=value][,gw_stat=value][,blk=value][,used]]
rtrv-tc:sigpath:[[pst=value][,call=value][,gw_stat=value][,blk=value]
[,used]]
Input
Description:
•
all—Displays the bearer states for all signal paths.
•
sigpath—Logical signal destination, such as SS7 point code, FAS path, IP FAS
path, or DPNSS path. See Cisco PGW 2200 Softswitch Release 9 Provisioning
Guide for more information about signal destinations.
– call—Displays the status of the call: IDLE, IN, or OUT (call direction).
– pst—Displays the primary states such as AOOS.
– used—Displays only the CICs for currently active calls.
– STAT—Displays the number of CICs per trunk group, shows whether the
CIC is coming into the system (IN) or is going out of the system (OUT), and
indicates the block status of the active CICs.
Note
•
If you issue the rtrv-tc command with the STAT parameter, you cannot
add any other parameter to the command syntax. If you try to do it, the
system will return an error message.
tg— Specifies a particular trunk group.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-49
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-TC—Retrieve Bearer States
Output
Description:
•
<SIGPATH>—MML component name of a signal path
•
CIC—Circuit identification code
•
PST—Primary state; valid values are:
– AOOS—The resource has been taken out of service by the system.
– INB—Installed busy (resource has been created but not yet commanded IS
or OOS by the SET-DEST command).
– IS—In service.
– MOOS—Manually taken out of service.
– OOS—Out of service.
– TRNS—Transient; the state is currently being changed.
– UNK—Unknown.
•
CALL—Call state; valid values are:
– IDLE—Circuit is idle, available for use.
– OUT—Out of service.
– IN—In service.
Note
•
If the Cisco PGW 2200 Softswitch sends out CGB, CGU, or GRS, because a
group of CICs (such as a E1) is blocked, unblocked, or reset by gateway or
MML command, a call will be created on the first CIC of the group and send
the message out. The call remains in the CALL=IN status until it receives
ACK from the remote side. This is an indication that the answer has not been
received for the ISUP signalling message. If the remote side doesn't send
ACK back and the call has been in CALL=IN status for a long time, you can
use the kill-call command to restore the first CIC to CALL=IDLE state.
GW_STAT—State of the gateway; valid values are:
– CARRIER_FAILURE—Carrier has failed.
– GW_HELD—The call has been held at the gateway.
– CXN_IS—The connection is in service.
– CXN_OOS_ACTIVE—The connection is out of service on the active
system.
– CXN_OOS_STANDBY—The connection is out of service on the standby
system.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-50
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-TC—Retrieve Bearer States
•
BLK—Blocking state; valid values are
– GATEWAY—Locally blocked because of a gateway event (for example,
RSIP or a group service message).
– LOCAUTO—Hardware blocking type; the circuit is blocked, by an external
message generated by a network element outside the media gateway.
– LOCMAN—Blocked manually by MML. This is removable by the
UNBLK-CIC or the RESET-CIC command.
– LOCUNK—Locally blocked for unknown reasons. (This indicates a
potential software problem. A circuit has become blocked but the software
did not track the cause of the blocking.)
– NONE—There is no block on the CIC. DS0 is available for use.
– REMAUTO—Remotely auto blocked.
– REMMAN—Remotely blocked manually.
Note
All the BLK valid values, except for LOCMAN and NONE, are only
applicable to SS7 sigpath.
Note
For PRI sigpath, the valid values of BLK are LOCMAN and NONE. For PRI
path with NI or ATT_41459 variant, since Release 9.7(3) S27P27, REMMAN
is also applicable.
•
CALL_STA—The call start time.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-51
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-TC—Retrieve Bearer States
Example:
The MML command shown in the following example displays the bearer channels
states for signal paths CIC1 to CIC62:
mml> rtrv-tc:ss7svc1:pst=OOS,call=IDLE,gw_stat=CXN_OOS_ACTIVE,blk=NONE
MGC-01 - Media Gateway Controller 2007-12-12 10:12:51.860 CST M RTRV
"ss7svc1:CIC=1,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=2,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=3,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=4,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=5,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=6,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=7,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=8,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=9,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=10,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=11,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=12,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=13,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=14,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=15,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=16,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=17,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=18,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
.
"ss7svc1:CIC=21,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=22,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=23,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=24,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=25,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=26,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=27,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=28,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=29,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
.
"ss7svc1:CIC=59,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=60,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=61,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
"ss7svc1:CIC=62,PST=OOS,CALL=IDLE,GW_STAT=CXN_OOS_ACTIVE,BLK=NONE"
;
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-52
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-TC—Retrieve Bearer States
Example:
The MML command shown in the following example displays the bearer channel of
a particular trunk group:
mml> rtrv-tc:tg-1001:
MGC-01 - Media Gateway Controller 2009-02-18 16:33:22.470 EST
M RTRV
"tg-1001:CIC=1,PST=IS,CALL=IDLE,GW_STAT=CXN_IS,BLK=NONE"
"tg-1001:CIC=2,PST=IS,CALL=IDLE,GW_STAT=CXN_IS,BLK=NONE"
"tg-1001:CIC=3,PST=IS,CALL=IDLE,GW_STAT=CXN_IS,BLK=NONE"
"tg-1001:CIC=4,PST=IS,CALL=IDLE,GW_STAT=CXN_IS,BLK=NONE"
"tg-1001:CIC=5,PST=IS,CALL=IDLE,GW_STAT=CXN_IS,BLK=NONE"
"tg-1001:CIC=6,PST=IS,CALL=IDLE,GW_STAT=CXN_IS,BLK=NONE"
;
The MML command shown in the following example shows the information
displayed when you issue the command and specify a particular trunk group and enter
the STAT parameter:
mml> rtrv-tc:tg-1001:STAT
MGC-01 - Media Gateway Controller 2009-02-18 16:33:22.470 EST
M RTRV
"tg-1001:CSV=ss7path,CIC_NUM=31, NONE_BLOCK =29,BLOCK=2
IN=10,
OUT=6,
LOCAUTO=0
LOCMAN=1
GATWAY=1
REMAUTO=0
REMMAN=0
LOCUNK=0
The MML command shown in the following example shows the information
displayed when you issue the command and specify a signaling path (in signaling
nailed-up mode) and the STAT parameter:
mml> rtrv-tc:ss7path:STAT
MGC-01 - Media Gateway Controller 2009-02-18 16:33:22.470 EST
M RTRV
"ss7path:CIC_NUM=31, NONE_BLOCK =29,BLOCK=2
IN=10,
OUT=6,
LOCAUTO=0
LOCMAN=1
MATE_UNVAIL=1
REMAUTO=0
REMMAN=0
LOCUNK=0
The MML command shown in the following example displays the status of CICs on
an ss7 signaling path:
mml> rtrv-tc:ss7path:USED
MGC-01 - Media Gateway Controller 2009-01-19 13:23:29.320 EST
M RTRV
"ss7path:CIC=1,PST=IS,CALL=IN,GW_STAT=CXN_IS,BLK=NONE,
CALL_STA=2009-01-19 13:20:30.219 CST"
"ss7path:CIC=3,PST=IS,CALL=OUT,GW_STAT=CXN_IS,BLK=NONE,
CALL_STA=2009-01-19 13:21:37.321 CST"
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-53
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-TCAP-TRANS—Retrieve TCAP Transactions
Comments:
Performance Impact Category: C; avoid issuing RTRV-TC:ALL for large
configurations.
This command supports wildcarding.
RTRV-TCAP-TRANS—Retrieve TCAP Transactions
Purpose:
Displays the number of active TCAP transactions.
Syntax:
rtrv-tcap-trans
Output
Description:
Example:
•
<TCAP name>—The TCAP name.
•
TRANS—Number of active transactions.
The MML command shown in the following example displays the number of active
TCAP transactions:
mml> RTRV-TCAP-TRANS
Media Gateway Controller
M RTRV
"TCAP-01:TRANS=0"
;
Comments:
- MGC-01 2000-01-12 15:19:51
Performance Impact Category: A
RTRV-TC-HELD—Retrieve States of Bearer Channels Held by
Gateway
Note
This command has been replaced by the rtrv-tc command for Releases 9.7(3) and 9.8(1). See the
“RTRV-TC—Retrieve Bearer States” section on page 1-49 for further information.
Purpose:
Displays the state of bearer channels per signal path held by gateway or it displays the
states of all bearer channels held by gateway.
Syntax:
rtrv-tc-held:<sig path>&<sig path>...
rtrv-tc-held:all
Input
Description:
•
sig path—Logical signal destination, such as SS7 point code, FAS path, IP FAS
path, or DPNSS path. See Cisco PGW 2200 Softswitch Release 9 Provisioning
Guide for more information about signaling destinations.
•
all—Displays the bearer states for all signal paths.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-54
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-TC-HELD—Retrieve States of Bearer Channels Held by Gateway
Output
Description:
•
<POINT CODE>—MML component name of a point code provisioning
component
•
CIC—Circuit identification code
•
PST—Primary state; valid values are:
– AOOS—The system has taken the resource out of service.
– INB—Installed busy (resource has been created but not yet commanded IS
or OOS by the SET-DEST command).
– IS—In service.
– MOOS—Manually taken out of service.
– OOS—Out of service.
– TRNS—Transient; the state is currently being changed.
– UNK—Unknown.
•
CALL—Call state; valid values are:
– IDLE—Circuit is idle, available for use.
– OOS—Out of service.
– IS—In service.
•
GW_STAT—State of the gateway; valid values are:
– CARRIER_FAILURE—Carrier has failed.
– GW_HELD—The call has been held at the gateway.
– CXN_IS—The connection is in service.
– CXN_OOS_ACTIVE—The connection is out of service on the active
system.
– CXN_OOS_STANDBY—The connection is out of service on the standby
system.
•
BLK—Blocking state; valid values are:
– GATEWAY—Locally blocked because of a gateway event (for example,
RSIP or a group service message).
– LOCAUTO—Hardware blocking type; the circuit is blocked by an external
message generated by a network element outside the media gateway.
– LOCMAN—Blocked manually by MML. This is removable by the
UNBLK-CIC or RESET-CIC command.
– LOCUNK—Locally blocked for unknown reasons. (This indicates a
potential software problem. A circuit has become blocked, but the software
did not track the cause of the blocking.)
– NONE—There is no block on the CIC. DS0 is available for use.
– REMAUTO—Remotely auto blocked.
– REMMAN—Remotely blocked manually.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-55
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-THRES—Retrieve Threshold Values
Example:
The MML command shown in the following example displays the state of bearer
channels on signal path DPC1:
mml> RTRV-TC-HELD:dpc1
Media Gateway Controller
M RTRV
“dpc1”
;
Comments:
- MGC-01 2000-01-12 15:19:51
This command accepts wildcarding.
RTRV-THRES—Retrieve Threshold Values
Purpose:
Retrieves threshold settings for measurement categories.
Syntax:
rtrv-thres::<meas cat>
Input
Description:
•
meas cat—Logical identifier that selects the measurement category. For a list of
measurement categories, see meascategories in the “RTRV-CALLIM—Retrieves
the Call Limiting Function Status” section on page 1-16.
Output
Description:
•
INTERVAL—Time interval.
•
TYPE—Threshold type.
•
CLRTHRES—Threshold at which alarm is cleared.
•
ALMTHRES—Threshold at which alarm is set.
•
ALM—Alarm category.
Example:
The MML command shown in the following example retrieves threshold settings for
the line-interface-severely-errored seconds measurement category:
mml> rtrv-thres::"SIP: RETX MSG TOT"
MGC-01 - Media Gateway Controller 2008-10-24 01:40:57.770 EDT
M RTRV
"SIP: RETX MSG TOT"
":INT=1800,"
":type=upper,clrthres=100,almthres=125,alarmcat=\"SIP: RE-XMIT MSG
TOT\""
;
Comments:
Performance Impact Category: A
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-56
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
RTRV-VIRT-TC—Retrieve DPNSS Virtual Bearer Channel Status (Release 9.6(1) and 9.7(3))
RTRV-VIRT-TC—Retrieve DPNSS Virtual Bearer Channel Status
(Release 9.6(1) and 9.7(3))
Purpose:
Displays the same output as the rtrv-tc command except that it eliminates the SPAN
and GW_STAT fields.
Syntax:
rtrv-virt-tc:dpnss-path
Output
Description:
•
VTC—The virtual channel number.
•
CALL—The status of the call: IDLE, IN, or OUT (call direction).
•
PST—Primary state; valid values are
– AOOS—The resource has been taken out of service by the system.
– INB—Installed busy (resource has been created but not yet commanded IS
or OOS by the SET-DEST command).
– IS—In service.
– MOOS—Manually taken out of service.
– OOS—Out of service.
– TRNS—Transient; the state is currently being changed.
– UNK—Unknown.
•
BLK—Blocking state
– NONE—There is no block on the CIC. DS0 is available for use.
•
Example:
TRANS—Number of active transactions.
The MML command shown in the following example displays information for a
DPNSS virtual bearer channel:
mml> rtrv-virt-tc:dpnss-path-1:
M
Comments:
MGC-01 - Media Gateway Controller 2009-01-19 13:36:14.202 CST
RTRV
"dpnss-path-1:VTC=33,CALL=IDLE,PST=IS,BLK=NONE"
"dpnss-path-1:VTC=34,CALL=IDLE,PST=IS,BLK=NONE"
"dpnss-path-1:VTC=35,CALL=IDLE,PST=IS,BLK=NONE"
"dpnss-path-1:VTC=36,CALL=IDLE,PST=IS,BLK=NONE"
"dpnss-path-1:VTC=37,CALL=IDLE,PST=IS,BLK=NONE"
"dpnss-path-1:VTC=38,CALL=IDLE,PST=IS,BLK=NONE"
Performance Impact Category: D
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-57
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
SET-ADMIN-STATE—Set Administrative State
SET-ADMIN-STATE—Set Administrative State
Purpose:
Locks the use of resources for future call creation or unlocks bearer channel resources
to make them available for future call creation. A resource can be specified as an entire
Cisco PGW 2200 Softswitch, a gateway, a signal path, a trunk group, a span, or an
individual trunk. Use this command also to unlock a set resource.
Syntax:
set-admin-state:<mgc>:lock|unlock|reset
set-admin-state:<gway>:lock|unlock|reset
set-admin-state:<trkgrp>:lock|unlock|reset
set-admin-state:<sigpath>:lock|unlock|reset
set-admin-state:<sigpath>:span=x:lock|unlock|reset
set-admin-state:<sigpath>:span=x,bc=y[,rng=z]:lock|unlock|reset
set-admin-state:<sigpath>:cic=x[,rng=y]:lock|unlock|reset
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-58
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
SET-ADMIN-STATE—Set Administrative State
Input
Description:
Target parameters are as follows:
•
mgc—Corresponding MML name of the Cisco PGW 2200 Softswitch.
•
gway—Corresponding MML name for the media gateway. Not all media gateway
types are applicable. Supported types are CU, MUX, MGW, and AVM external
nodes.
•
trkgrp—Applicable only for time-division multiplexing (TDM). Use the
corresponding MML name for component type "0020".
Note
•
When specifying the trunk group number, enter the prefix tg-.
Example: set-admin-state:tg-404:lock
sigpath—Corresponding MML name for any of the following component types:
– Signal path of in-band TDM up to MUX and then time switched to TDM media
and sent to the Cisco PGW 2200 Softswitch.
– Signal path of in-band TDM signaling up to CU and then encapsulated and sent
over IP to the Cisco PGW 2200 Softswitch.
– Signal path of in-band TDM signaling up to NAS and then converted to NI2
and sent to the Cisco PGW 2200 Softswitch over IP (that is, FE
box<-sig/tdm->NAS<-NI2/IP-> MGC).
– Signal path or route set associated with the SS7 destination PC.
– Signal path for EISUP.
•
span—A 16-bit value that identifies an ISDN/PRI physical cable. The span defaults
to 0xFFFF if it is not in the parameter list of SET-ADMIN-STATE, the target
signal path is a valid target for span, and a "bc" or "rng" parameter is specified.
•
bc—A numeric value that identifies the non-ISUP bearer channel number. BC is
used for non-ISUP trunks; otherwise use CIC.
•
cic—A numeric value that identifies the ISUP CIC number.
•
rng—The range of either bearer channel or CIC.
•
lock—Bearer channel(s) are available for call processing. If bearer channel state is
set to lock, calls go into pending state where calls remain up until one party
voluntarily releases the call. New calls cannot use locked bearer channels.
•
unlock—Bearer channel(s) are unavailable for call processing. If the bearer channel
state is set to unlock, the resource becomes available. New calls are allowed to use
the unlocked bearer channels.
•
reset—Clears local and remote blocking and takes on the blocking view of remote
side. This option is not permitted for span, BC or LISUP, FAS, IP, and Layer 3
signaling paths.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-59
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
SET-ADMIN-STATE—Set Administrative State
Example:
The MML command shown in the following example locks CICs 10 through 13 on
dpc1:
mml> SET-ADMIN-STATE:DPC1:CIC=10,RNG=3,LOCK
MGC-01 - Media Gateway Controller 2000-09-12 13:59:30
M COMPLD
"dpc1"
;
The MML command shown in the following example clears local and remote blocking
for dpc-inet2 and takes on the blocking view of the remote side:
mml> set-admin-state:dpc-inet2:reset,confirm
Media Gateway Controller 2000-06-20 11:21:57
M COMPLD
"dpc-inet2"
;
The MML command shown in the following example locks all bearer channels on
nassrv1:
mml> set-admin-state:nassrv1:lock
Media Gateway Controller - MGC-02 2000-02-22 13:41:42
M COMPLD
"nassrv1"
;
Note
In software Release 9.7(3) S27P27, an enhancement of the command
set-admin-state was added. It enables local and remote blocking of bearer
channels for the PRI sigpath with NI or ATT_41459 variant. And the
Cisco PGW 2200 Softswitch sends out SERVICE message to inform the remote
side of the block status of the channel.
The following shows an example of blocking a bearer channel for PRI path with NI or
ATT_41459 variant:
1.
The MML command shown in the following example blocks a bearer channel on
the PRI sigpath ipfas-sh-daisy:
mml> set-admin-state:ipfas-sh-daisy:bc=1,span=65535,lock,confirm
2.
The Cisco PGW 2200 Softswitch sends out a SERVICE message with status=OOS.
The output of the following command shows the status of the PRI sigpath
ipfas-sh-daisy:
mml> rtrv-tc:ipfas-sh-daisy:
"ipfas-sh-daisy:TC=1,CALL=IN,GW_STAT=CXN_IS,PST=IS,SPAN=65535,
BLK=LOCMAN"
3.
The Cisco PGW 2200 Softswitch receives a SERVICE ACK message. The output
of the following command shows that the BLK of bearer channel is still LOCMAN:
mml> rtrv-tc:ipfas-sh-daisy:
"ipfas-sh-daisy:TC=1,CALL=IDLE,GW_STAT=CXN_IS,PST=IS,SPAN=65535,
BLK=LOCMAN"
The following shows an example of unblocking a bearer channel for PRI path with NI
or ATT_41459 variant:
1.
The MML command shown in the following example unblocks a bearer channel on
the PRI sigpath ipfas-sh-daisy:
mml> set-admin-state:ipfas-sh-daisy:bc=1,span=65535,unlock,confirm
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-60
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
SET-ADMIN-STATE—Set Administrative State
2.
The Cisco PGW 2200 Softswitch sends out a SERVICE message with status=IN.
The output of the following command shows the status of the PRI sigpath
ipfas-sh-daisy:
mml> rtrv-tc:ipfas-sh-daisy:
"ipfas-sh-daisy:TC=1,CALL=IN,GW_STAT=CXN_IS,PST=IS,SPAN=65535,
BLK=LOCMAN"
3.
The Cisco PGW 2200 Softswitch receives a SERVICE ACK message. The output
of the following command shows that the BLK of bearer channel is set to NONE:
mml> rtrv-tc:ipfas-sh-daisy:
"ipfas-sh-daisy:TC=1,CALL=IDLE,GW_STAT=CXN_IS,PST=IS,SPAN=65535,
BLK=NONE"
If the remote side blocks a bearer channel, the Cisco PGW 2200 Softswitch receives a
SERVICE message with status=OOS. The output of the following command shows that
the BLK of the bearer channel is set to REMMAN. The Cisco PGW 2200 Softswitch
sends back a SERVICE ACK message with status=OOS.
mml> rtrv-tc:ipfas-sh-daisy:
"ipfas-sh-daisy:TC=1,CALL=IDLE,GW_STAT=CXN_IS,PST=IS,SPAN=65535,BLK=REMMAN"
If the remote side releases the bearer channel, the Cisco PGW 2200 Softswitch receives
a SERVICE message with status=IS. The BLK of the bearer channel is set to NONE.
The Cisco PGW 2200 Softswitch sends back a SERVICE ACK message with status=IS.
mml> rtrv-tc:ipfas-sh-daisy:
"ipfas-sh-daisy:TC=1,CALL=IDLE,GW_STAT=CXN_IS,PST=IS,SPAN=65535,BLK=NONE"
If a bearer channel is blocked both locally and remotely, the BLK of the bearer channel
is set to LOCMAN+REMMAN:
mml> rtrv-tc:ipfas-sh-daisy:
"ipfas-sh-daisy:TC=1,CALL=IDLE,GW_STAT=CXN_IS,PST=IS,SPAN=65535,
BLK=LOCMAN+REMMAN"
When the remote side unblocks the bearer channel which is still locally blocked, BLK
of bearer channel becomes LOCMAN. The Cisco PGW 2200 Softswitch sends out a
SERVICE ACK message with status=OOS.
mml> rtrv-tc:ipfas-sh-daisy:
"ipfas-sh-daisy:TC=1,CALL=IDLE,GW_STAT=CXN_IS,PST=IS,SPAN=65535,BLK=LOCMAN"
Comments:
Performance Impact Category: B
This command supports wildcarding. A platform info log is generated every time the
set-admin-state command is entered. One alarm is generated every time the
set-admin-state command is entered at the Cisco PGW 2200 Softswitch gateway,
signal path, or trunk group level.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-61
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
SET-ASSOCIATION—Changing SCTP Association Primary State
SET-ASSOCIATION—Changing SCTP Association Primary State
Purpose:
Changes the primary state of an SCTP association.
Syntax:
set-association:assoc_name:PST[,confirm]
Input
Description:
Example:
•
assoc_name—MML name of a previously configured SCTP association.
•
PST—Desired primary state; valid values are IS, OOS, or FOOS
•
confirm—Verify desired state. This parameter must be used when the primary
state desired is OOS.
The MML command shown in the following example changes the primary state of an
association to out of service:
mml> set-association:assoc1:OOS,confirm
Comments:
Performance Impact Category: A
SET-C7LNK—Change the Service State of an SS7 Link
Purpose:
Changes the service state of an SS7 link to IS (in service), OOS (out of service),
FOOS (forced out of service), UNH (uninhibit SS7 link), or INH (inhibit SS7 link).
Syntax:
set-c7lnk:<c7 ip or tdm ss7 link>:is|oos|foos|unh|inh
Input
Description:
Example:
•
c7 ip or tdm ss7 link—This is the logical signal link, such as SS7 point code, FAS
path, IP FAS path, or DPNSS path.
•
is—In service
•
oos—Out of service
•
foos—Forced out of service
•
unh—Uninhibit SS7 link
•
inh—Inhibit SS7 link
The MML command shown in the following example sets the C7 IP link lnkset1 into
service:
mml> SET-C7LNK:LNKSET1:IS
MGC-01 - Media Gateway Controller 2001-01-01 18:40:25
M COMPLD
"ss7lk0-1"
;
Comments:
Performance Impact Category: C
This command supports wildcarding. See Cisco PGW 2200 Softswitch Release 9
Provisioning Guide for more information about signal links.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-62
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
SET-CALLIM—Sets the Call Limiting Function
SET-CALLIM—Sets the Call Limiting Function
Purpose:
Sets the MGCP Scripting Support on the PGW 2200 feature for the whole
Cisco PGW 2200 Softswitch.
Syntax:
set-callim:lim_status
Input
Description:
•
lim_status—Sets the MGCP Scripting Support on the PGW 2200 function for the
Cisco PGW 2200 Softswitch to enabled or disabled.
•
enable | disable—Instructs the Cisco PGW 2200 Softswitch to either enable or
disable call limiting.
Output
Description:
Varies
Example:
The MML command shown in the following example enables call limiting:
mml> set-callim:enable
devmgc122 mml> set-callim:enable
MGC-01 - Media Gateway Controller 2004-03-22 19:40:47.595 PST M
"ENGG-01"
;
Comments:
RTRV
Performance Impact Category: A
SET-DCHAN—Change the Service State of a D-Channel Link
Purpose:
Changes the service state of a D-channel link to IS (in service) or OOS (out of service).
Syntax:
set-dchan:<fas link | d-channel>:is|oos
Input
Description:
•
fas link—MML name of the fas link.
•
is—In service.
•
oos—Out of service.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-63
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
SET-DEST—Set the Service State of a Signal Path
Example:
The MML command shown in the following example sets the service state of link
DChan-1 to in service:
mml> SET-DCHAN:DCHAN-1:IS
MGC-01 - Media Gateway Controller 2001-01-01 18:40:25
M COMPLD
"dchan-1"
;
Comments:
Performance Impact Category: C
This command was introduced in software Release 9. It uses wildcarding. It replaces
SET-SC-STATE.
See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for more information
about provisioning D-channel links.
SET-DEST—Set the Service State of a Signal Path
Purpose:
Changes the service state of a DSS IP or NAS signal path to IS (in service) or OOS (out
of service).
Syntax:
set-dest:<sig path>:IS|OOS
Input
Description:
sig path—Signal path. This is the logical signaling destination, such as SS7 point code,
FAS path, IP FAS path, or DPNSS path.
Example:
•
is—In service.
•
oos—Out of service.
The MML command shown in the following example sets the service state of ASP to
out of service:
mml> SET-DEST:ASP:OOS
Comments:
Performance Impact Category: A
This command supports wildcarding.
First shut down the D channel on the NAS before issuing the command
SET-DEST:NASLINK:OOS.
This command replaces the SET-DEST-STATE command in software Release 7.12 and
earlier. Use the SET-IPLNK command to change the service state of a SIP, EISUP, or
MGCP IP link to in-service (IS), out-of-service (OOS), or forced out-of-service
(FOOS).
The set-dest command should be used only while you are dynamically reconfiguring the
system. Do not use the set-dest command to take a signaling service OOS during a
maintenance session, because all calls associated with the specified signaling service
are dropped. You should instead use the blk-cic command to block the CICs associated
with the signaling service when you need to perform maintenance.
See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for more information.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-64
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
SET-IPLNK—Change the Service State of an IP Link
SET-IPLNK—Change the Service State of an IP Link
Purpose:
Changes the service state of an MGCP, EISUP, or SIP IP link to the in-service (IS),
out-of-service (OOS), or forced out-of-service (FOOS) state.
Syntax:
set-iplnk:<ip link>:is|oos|foos
set-iplnk:<mgcp-ip link>:is|oos|foos:confirm
set-iplnk:ip link:PST,<confirm>
Input
Description:
•
Ip link—MML component name of a previously configured IP link.
•
PST—Desired primary state:
– IS—In service
– OOS—Out of service
– FOOS—Forced out of service
Confirm—Enter this parameter when the PST is changed to OOS or FOOS
•
Note
Example:
Do not issue this command for an Cisco PGW 2200 Softswitch host in Standby
mode.
The MML command shown in the following example sets an IP link into service:
mml> SET-IPLNK:MGCPLK4:IS, confirm
MGC-01 - Media Gateway Controller 2001-01-01 18:59:03
M COMPLD
"mgcplk4"
;
The MML command shown in the following example changes the primary state of an
IP link to out of service:
mml> set-iplnk:iplnk1:OOS,confirm
MGC-02 - Media Gateway Controller 2002-06-20 17:34:46.430 EST
M COMPLD
;
Comments:
Performance Impact Category: C
This command was introduced in software Release 9 and replaces SET-SC-STATE and
SET-DEST-STATE. It uses wildcarding.
SET-IPROUTE—Changing IP Route Primary State
Purpose:
Changes the primary and secondary states of an IP route.
Syntax:
set-iproute:ip_route_name:pst[,confirm]
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-65
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
SET-LOG—Set Logging Levels
Input
Description:
•
IP_rout_name—MML name of a previously configured IP route.
•
PST—Desired primary state; valid values are IS, OOS, or FOOS
•
Confirm—Must be used when you set the primary state to OOS to verify the new
state. An IP route in any of the following states can be commanded OOS:
– IS
– OOS,CONF
– OOS,OFF_DUTY
– OOS,STBY.
Example:
The MML command shown in the following example changes the primary state of an
IP route to OOS:
mml> set-iproute:iproute1:oos,confirm
Comments:
Performance Impact Category: A
SET-LOG—Set Logging Levels
Purpose:
Sets the logging level of a process or of all processes.
Syntax:
set-log:<proc>:<log level>
set-log:all:<log level>,confirm
Input
Description:
•
proc—The various actively and passively monitored processes running on the
Cisco PGW 2200 Softswitch. Use the RTRV-SOFTW:ALL command to display
all processes.
•
log level—Sets the logging level for the specified process. Logging levels are as
follows:
– crit—Critical level messages.
– err—Error condition messages.
– warn—Warning condition messages.
– info—Informational messages.
– trace—Trace messages.
– debug—Debug-level messages (lowest level). A CONFIRM parameter is
required for the DEBUG log level. Do not set this log level unless directed to
by the Cisco TAC.
Logging at any given level implies upper levels are included. In other words, setting
the INFO logging level also sets the WARN, ERR, and CRIT levels. The order of
the levels shown above can also be viewed as an order of verbosity levels, in that at
CRIT the least information is logged, and at DEBUG the most information is
logged.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-66
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
SET-LSSN-STATE—Set State of Local SSN
Example:
The MML command shown in the following example sets the logging level of PM-01
process to DEBUG:
mml> SET-LOG:PM-01:DEBUG
MGC-01 - Media Gateway Controller 2001-01-05 11:37:51
M COMPLD
"PM-01"
;
Comments:
Performance Impact Category: D; if logging level is set to DEBUG, TRACE, or INFO,
call processing performance can be severely impacted.
This command was introduced in software Release 7.4 and replaces the CHG-LOG
command.
The process manager (PM-01) is not included in the “all” parameter, because this is a
special process. The logging level of PM-01 must be set individually, as in thepreceding
example.
Also, DSKM-01 (the disk monitor process) does not accept log-level change requests.
See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for more information
about processes.
SET-LSSN-STATE—Set State of Local SSN
Purpose:
Sets the state of a local SSN to IS or OOS.
Syntax:
set-lssn-state::<SSN>,IS|OOS
Input
Description:
Example:
•
<ssn>—The SSN name, as defined in the provisioned component SS7
subsystem. Use the PROV-RTRV:SS7SUBSYS:"ALL" command's "Name"
field to find a valid SSN name.
•
IS—In service
•
OOS—Out of service
The MML command shown in the following example sets the local SSN lnp to IS:
mml> SET-LSSN-STATE::LNP,IS
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M RTRV
"TCAP-01"
;
Comments:
Performance Impact Category: C
See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for more information
about components.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-67
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
SET-SPC—Set Signal Point Code State
SET-SPC—Set Signal Point Code State
Purpose:
Changes the service state of a signal point code to IS or OOS.
Syntax:
set-spc:<point code>:IS|OOS...
Input
Description:
Example:
•
point code—Signal point code.
•
IS—In service
•
OOS—Out of service
The MML command shown in the following example changes the service state of stp1
to OOS (out of service):
mml> SET-SPC:STP1:OOS
Media Gateway Controller
M COMPLD
"stp1"
;
Comments:
- MGC-01 2000-01-12 15:19:51
Performance Impact Category: C
SET-THRES—Set Threshold Values
Purpose:
Changes the threshold settings for a measurement category for a particular interval to
a new value.
Note
Syntax:
Input
Description:
Example:
This command can be used only to change a predefined threshold setting.
SET-THRES::CAT=”<Meas Cat>”, INTERVAL=<SECONDS>,THRES=<VALUE>
•
cat—Logical identifier that specifies the measurement category. For a list of
measurement categories, use the prov-rtrv MML command.
•
interval—Measurement interval.
•
thres—Threshold at which an alarm is set.
The MML command shown in the following example sets the threshold values for the
line-interface-severely-errored seconds measurement category to 1800 seconds and
the threshold to 125:
mml> set-thres::cat="SIP: RETX MSG TOT",interval=1800, thres=125
MGC-01 - Media Gateway Controller 2008-10-24 01:40:37.543 EDT
M COMPLD
"SIP: RETX MSG TOT"
;
Comments:
Performance Impact Category: A
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-68
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
SND—Send Message to External Process
SND—Send Message to External Process
Comments:
This command is no longer supported.
STA-ABN-TRC—Start Abnormal Trace
Purpose:
Prints the state machine global variable of a particular call, as well as external event
information, to a file.
Syntax:
sta-abn-trc:<sigpath|all>[,log=<xyz>][,prd=n],confirm
Input
Description:
•
sigpath—Corresponding MML name for any of the following component types:
– Signal path of in-band TDM up to MUX and then time switched to TDM
media and sent to Cisco PGW 2200 Softswitch
– Signal path of in-band TDM signaling up to CU and then encapsulated and
sent over IP to the Cisco PGW 2200 Softswitch
– Signal path of in-band TDM signaling up to NAS and then converted to NI2
and sent to the Cisco PGW 2200 Softswitch over IP (that is, FE
box<-sig/tdm->NAS<-NI2/IP->Cisco PGW 2200 Softswitch)
– Signal path or route set associated with SS7 destination PC
– Signal path for EISUP
Example:
•
all—Indicates that the start trace command needs to be applied to the whole
Cisco PGW 2200 Softswitch, in which case only one trace file is generated.
•
log—The log parameter accepts the name (xyz in this example) of an ASCII log
file to which the output is written. The name given in this parameter is used as a
prefix to the actual name of the file, which includes the signal path name and date
and time. If no log filename is provided, a default name consisting of the signal
path name and date and time is created. The extension of these log files is prt and
they are located in the ../var/trace directory.
•
prd—The period, in seconds, for which this trace is enabled, during which time
any abnormal calls are traced. If this optional parameter is not used, the period
defaults to 30 seconds.
•
confirm—If no confirm option is entered, the command is rejected, and you are
notified of the potential performance impact of this command.
The MML commands shown in the following examples print information about
various abnormal calls:
mml> STA-ABN-TRC:ALL:CONFIRM
Media Gateway Controller 2000-05-26 07:02:11
M COMPLD
"all"
;
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-69
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
STA-AUD—Start Auditing Process
mml> STA-ABN-TRC:AM401A-PC:CONFIRM,TC=4
Media Gateway Controller 2000-05-26 07:14:06
M DENY
SROF
"am401a-pc:Trace active for the following file(s):
../var/trace/_20000526071406.abn
"
/* Component already exists */
;
Comments:
Performance Impact Category: B, C. Impact depends on how many abnormal calls are
occurring and on the number of gateways configured.
This command accepts wildcards on signal paths.
STA-AUD—Start Auditing Process
Purpose:
Starts the auditing process on all calls. The auditing process stops automatically when
it is completed.
Syntax:
sta-aud
Example:
The MML command shown in the following example starts the auditing process on
all calls:
mml> STA-AUD
Media Gateway Controller
M RTRV
"ENGG-01"
;
Comments:
- MGC-01 2000-01-12 15:19:51
Performance Impact Category: C.
If you suspect a stuck or hung CIC, see Cisco PGW 2200 Softswitch Release 9
Operations, Maintenance, and Troubleshooting Guide for information on
troubleshooting the Cisco PGW 2200 Softswitch node.
STA-AUD-CIC—Start CIC State Auditing Process
Purpose:
Start a CIC audit.
Syntax:
sta-aud-cic
Input
Description:
•
sta—Start
•
aud—Audit
•
cic—Circuit
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-70
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
STA-AUD-GW—Start Auditing of MGCP Gateway
Example:
mml> sta-aud-cic
MGC-01 - Media Gateway Controller 2004-08-13 10:05:27.997 EST
M COMPLD
"MGC-01"
;
Comments:
CDB 1071 is configurable in XECfgParm.dat if you add it in engine, CDRmessageType.
If CDB 1110 is configured, CDB 1071 is suppressed.
STA-AUD-GW—Start Auditing of MGCP Gateway
Purpose:
Syntax:
Input
Description:
Example:
Starts the auditing of an MGCP gateway. There is no stop command at this time. To
retrieve the output of this audit, issue the RTRV-AUD-GW command.
Note
The STA-AUDIT-GW and RTRV-AUDIT-GW commands are no longer
supported as of Release 9.6(1).
Note
This command works only on gateways that support the Simple Resource
Coordination Protocol (SRCP).
sta-aud-gw:<sig path MGCP>
sta-aud-gw:all
•
sig path MGCP—MGCP signal path created with the PROV-ADD MGC
command.
•
all—All MGCP gateways.
The MML command shown in the following example starts the auditing of T-1-16:
mml> STA-AUD-GW:T-1-16
Media Gateway Controller
M COMPLD
;
Comments:
- MGC-01 2000-01-12 15:19:51
Performance Impact Category: C
STA-AUD-H248—Start Audit of H.248 Gateway (Release 9.7(3))
Purpose:
Starts an audit of an H.248 gateway.
Syntax:
sta-aud-h248:terms:sigpath=”h248_sigpath1”,cntxId=”Context_id",
termId="termid"
sta-aud-h248:cntxs:sigpath="h248_sigpath1",cntxId="ContextId"
sta-aud-h248:gateway:sigpath="h248_sigpath1"
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-71
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
STA-DNS-INFO—Start Retrieve Process of DNS Cache
Input
Description:
Example:
•
cntxId—For sta-aud-h248:terms:sigpath can be ALL or a specified context ID.
Use 0 to specify NULL context ID.
•
cntxId—For sta-aud-h248:cntxs:sigpath can be specified context ID. ALL context
ID or 0 context ID is not allowed.
•
termId—Can be a specified termination ID or a wildcard. If you use a wildcard,
termId can have, at most, one “*”, for example, termId=“DS/OC3_1/T1_1/*” is
allowed, but termId=“DS/OC3_1/*/*” is not allowed.
The MML command shown in the following example starts an audit on an H.248
gateway on sigpath H248-sigpath-01:
mml> sta-aud-h248:gateway:sigpath=”h248-sigpath-01”
Comments:
Performance Impact Category: C.
STA-DNS-INFO—Start Retrieve Process of DNS Cache
Purpose:
Starts the retrieve process of DNS cache information. The information is retrieved
with the RTRV-DNS-INFO command.
Syntax:
sta-dns-info:<sig path sip>:<param>
Input
Description:
Example:
•
sig path sip—MML name of SIP signal path
•
param—URL | cache entry number | null string
The MML command shown in the following example starts the retrieve process for
SIP-sigPath:
mml> STA-DNS-INFO:SIP-SIGPATH:""
Media Gateway Controller - MGC-01 2000-12-30 14:27:48
M COMPLD
"sip-sigpath"
;
Comments:
Performance Impact Category: A
STA-DNS-PURGE—Start Purge of DNS Cache
Purpose:
Starts the purge of a DNS cache.
Syntax:
sta-dns-purge:<sig path sip>
Input
Description:
•
sig path SIP—MML name of the SIP signal path.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-72
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
STA-SC-TRC—Start Trace
Example:
The MML command shown in the following example starts a purge of the DNS cache
for SIP-sigPath:
mml> STA-DNS-PURGE:SIP-SIGPATH
Media Gateway Controller - MGC-01 2000-12-30 14:27:48
M COMPLD
"sip-sigpath"
;
Comments:
Performance Impact Category: A.
You must execute the STA-DNS-INFO command before you use the
STA-DNS-PURGE command.
STA-SC-TRC—Start Trace
Purpose:
Starts a protocol conversion trace on a signal path or a point code. You typically perform
a trace when calls are failing, and the engine is the suspected source of the problem.
In Release 9.7(3), adds some enhanced functions to the original per call trace, including
collecting per call trace on calling/called party number, adding MCL setting, capturing
long duration calls, collecting call trace on cause value and fixing per call trace on a
particular sigPath/Span/cic (or trunkgroup/trunk) combination.
Syntax:
sta-sc-trc:<sig path>:[log="filenameprefix"][,prd=n],confirm
sta-sc-trc:<sig path>:span=x[,rng=y][,log="filenameprefix"][,prd=n]
sta-sc-trc:<sig path>:span=x[,tc=y][,rng=z][,log="filenameprefix"][,prd=n]
sta-sc-trc:<trkgrp>:[log="filenameprefix"][,prd=n],confirm
sta-sc-trc:<trkgrp>:trk=x[,rng=y][log="filenameprefix"][,prd=n]
In the active node:
sta-sc-trc:<sigpath>:[span=x][,rng=y][,tc=z][,rng=w][,anubmer=”callingparty
number”][,bnumber=”calledpartynumber”][,causevalue=c]
[,incompleteoverlapnumber][,duration=d][,mcl=m][,autostop][,prd=n]
[,log=”log”],confirm
sta-sc-trc:<trunkgroup>:[trk=x][,rng=y][,anubmer=”callingpartynumber"]
[,bnumber=”calledpartynumber"][,causevalue=c][,incompleteoverlapnumber]
[,duration=d][,mcl=m][,autostop][,prd=n][,log=”log"],confirm
In the standby node:
sta-sc-trc:<sigpath>:[span=x][,rng=y][,tc=z][,rng=w][,mcl=m][,prd=n]
[,log=”log”],confirm
sta-sc-trc:<trunkgroup>:[trk=x][,rng=y][,mcl=m][,prd=n][,log=”log"],confirm
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-73
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
STA-SC-TRC—Start Trace
Input
Description:
•
sigpath—Logical signal destination, such as SS7 point code, FAS path, IP FAS
path, or DPNSS path.
•
span—Span ID. Span is used with rng and sigpath. It is the E1/T1 ID for
NFAS-ISDN, ffff for SS7 and DPNSS; FAS-ISDN can use either a real value (range
is 0 to 65535)or ffff, depending on the format of the channel identifier information
element used by the switch or PBX. Hex >= 0 and <= ffff.
•
rng—Range. Range is 0 to 65535. Default value is 0. When used with "span=x"
rng=y is an optional range of spans beginning with x and continuing for y spans.
When used with "tc=y" rng=z is an optional range of traffic channels beginning with
y and continuing for z traffic channels. When used with "trk=x" rng=y is an optional
range of contiguous trunks to trace, starting with trunk x and ending with trunk y.
•
tc—Traffic channel of interest in integer (range is 0 to 65535) form. It is used with
rng, span, and sigpath.
•
anumber—Original/pre-modified calling party number. Can be up to 32 digits.
Possible digits are 0123456789abcdefABCDEF*. The anumber is supported with
a wildcard (*) at the end.
•
bnumber—Original/pre-modified called party number. Can be up to 32 digits.
Possible digits are 0123456789abcdefABCDEF*. The bnumber is supported with
a wildcard (*) at the end.
•
causevalue—The internal cause value. Range is 1 to 300.
•
incompleteoverlapnumber—Incomplete-number overlap call. These overlap calls
fail, but number is still not complete, and without enough number analysis result to
decide whether to record them.
•
duration—Call duration in seconds. Range is 3600 to 2147483.The value must be
not more than prd. If a call's duration is greater than this value, this trigger is
matched. XECfgParm.dat adds one new parameter
(CallNumberToWriteIntoTracefile) to limit the calls number (default is 200) to
write their buffer into trace file while stopping the call trace.
•
mcl—MCL. Possible value: 1: stop trace once MCL reaches MCL1; 2: stop trace
once MCL reaches MCL2; 3: stop trace once MCL reaches MCL3. 0: not stop trace
when MCL occurs. Default value: 1.
•
autostop—Stop trace once any one required call trace (i.e. all input triggers are
matched) is collected. Note: If trigger "duration" is input or none of trace triggers
is input, autostop must not be input.
•
prd—Trace period in seconds. Range is 0 to 2147483. Default value is 1800. Stops
the trace when the call trace running time reaches this value.
•
confirm—If no confirm option is entered, the command is rejected and you are
notified in a message of the potential performance impact of this command. This is
required for a signal path level trace or a trunk group level trace because of the
potential performance impact of tracing at these levels.
•
trunkgroup—Logical trunk group of interest. See Cisco PGW 2200 Softswitch
Release 9 Provisioning Guide for more information.
Note
When specifying the trunk group number, enter the prefix tg-.
Example: sta-sc-trc:tg-404:log="test"prd=60,confirm
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-74
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
STA-SC-TRC—Start Trace
•
log—Logfile name prefix. The trace files are created and written to a file whose
name can vary, depending on how the command is invoked. (A system log message
is generated for each trace started. The filenames created as part of the
STA-SC-TRC command are contained in the log messages.) If the log= parameter
is used, the value of this parameter is treated as a prefix in the filename. For
example, for STA-SC-TRC:<TRKGRP>:LOG="trace1", the filename would be
trace1_<trkgrp>_<sig path>_yyyymmddhhmmss.btr, where yyyymmddhhmmss in
the filename represents the time (GMT) at which the file is created. All trace files
have a ".btr" extension and are output to the $BASEDIR/var/trace directory.
If no LOG parameter is used, default filenames are used for each sta-sc-trc
command. For example, for STA-SC-TRC:<TRKGRP>:CONFIRM, the filename
would be <trkgrp>_<sig path>_yyyymmddhhmmss.btr.
For STA-SC-TRC<SIG PATH>:CONFIRM the filename would be
<sig path>_yyyymmddhhmmss.btr.
•
Example:
trk—Trunk number. This is either a trunk number within the trunk group of interest
or the starting trunk of a range.
Trace the call with calling number 7300 and called number 7000 at sigpath ss7svc6:
mml> sta-sc-trc:ss7svc6,anumber="7300",bnumber="7000",confirm
Trace the call with calling number 7300 and if this required call trace is collected then
stop trace:
mml> sta-sc-trc:ss7svc6,anumber="7300",autostop,confirm
Trace the calls at sigpath ss7svc6 CIC=22~30 and stop trace when MCL reaches MCL2:
mml> sta-sc-trc:ss7svc6,span=65535,tc=22,rng=8,mcl=2,confirm
Trace the calls with internal cause value 44 at sigpath ss7svc6
mml> sta-sc-trc:ss7svc6,causevalue=44,confirm
Trace the calls that are set with overlap flag and called number is not complete but failed
at sigpath ss7svc6:
mml> sta-sc-trc:ss7svc6,bnumber="7000",incompleteoverlapnumber, confirm
Trace the calls with call duration > 3 hours for 12 hours in trunkgroup tg-6006:
mml> sta-sc-trc:tg-6006,duration=10800,prd=43200,confirm
The MML command shown in the following example starts a capture session for all
PDUs going through the signal path identified as T-1-16 and stores the trace log in the
$BASEDIR/var/trace/T-1-16_yyyymmddyyhhmmss.log file:
mml> STA-SC-TRC:T-1-16
The MML command shown in the following example starts a capture session for the
signal path identified as T-2-18. It runs for 600 seconds (10 min) and stores the output
in /var/trace/test_yyyymmddyyhhmmss.trc:
mml> STA-SC-TRC:T-2-18:LOG=TEST.TRC,PRD=600
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-75
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
STA-SS7-SLT—Start MTP SLT Test on a Link
Error Code:
Comments:
•
COMPLD—Path has started tracing.
•
SNVS—Error opening the file; trace cannot be performed because the path is
already being traced.
Performance Impact Category: C, D. Impact depends on scope of trace.
On successful completion, all protocol data unit (PDU) traffic on the path is captured in
a log file. This MML command succeeds regardless of the service state of the path.
See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for more information
about signal destinations.
STA-SS7-SLT—Start MTP SLT Test on a Link
Purpose:
Starts an MTP signal link test on a link.
Syntax:
sta-ss7-slt:<c7 link>
Input
Description:
Example:
•
c7 link—The MML component name of a signal channel (linkset, C7 IP link, or
TDM link used in a linkset).
The MML command shown in the following example starts a signal link test on link
ls1link1. The result of this test is retrieved by the command rtrv-ss7-slt:ls1link1.
mml> STA-SS7-SLT:SLT:LS1LINK1
Media Gateway Controller - MGC-01 2000-01-12 15:18:34
M RTRV
"ls1link1"
;
Comments:
Performance Impact Category: A
See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for more information
about signal channels.
STA-SS7-SRT—Start MTP SRT Test on an SS7PATH
Purpose:
Starts an MTP signal route test on an ss7path configured for Japanese SS7.
Syntax:
sta-ss7-srt:<ss7path>:lset="<c7 linkset>"
Input
Description:
•
ss7path—The MML component name of an ss7path.
•
c7 linkset—The provisioning component C7 link, TDM link used in a linkset, or
linkset.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-76
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
STA-TCAP-TRC—Start TCAP Tracing
Example:
The MML command shown in the following example starts a signal route test on
ss7path1 with C7 linkset ls1. The result of this test is retrieved by the command
RTRV-SS7-SRT:SS7PATH1:LSET=“LS1”.
mml> STA-SS7-SRT:SS7PATH1:LSET-”LS1”
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M RTRV
"ss7path1"
;
Comments:
Performance Impact Category: A
See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for a description of C7
linksets. Use the RTRV-LSET command to retrieve a list of linksets.
STA-TCAP-TRC—Start TCAP Tracing
Purpose:
Starts TCAP tracing.
Syntax:
STA-TCAP-TRC
Example:
The MML command shown in the following example starts TCAP tracing:
mml> STA-TCAP-TRC
Media Gateway Controller
M RTRV
"TCAP-01"
;
Comments:
- MGC-01 2000-01-12 15:19:51
Performance Impact Category: C
STP-ABN-TRC—Stop Abnormal Trace
Purpose:
Stops abnormal calls tracing initiated by the STA-ABN-TRC command.
Syntax:
stp-abn-trc:<sigpath|all>
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-77
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
STP-AUD—Stop Auditing Process
Input
Description:
•
sigpath—Corresponding MML name for any of the following component types:
– Signal path of in-band TDM up to MUX and then time switched to TDM
media and sent to Cisco PGW 2200 Softswitch
– Signal path of in-band TDM signaling up to CU and then encapsulated and
sent over IP to the Cisco PGW 2200 Softswitch
– Signal path of in-band TDM signaling up to NAS and then converted to NI2
and sent to the Cisco MGC over IP (that is, FE
box<-sig/tdm->NAS<-NI2/IP->MGC)
– Signal path or route set associated with SS7 destination PC
– Signal path for EISUP
•
Example:
all—Indicates that all abnormal traces currently running on the
Cisco PGW 2200 Softswitch are to be stopped.
The MML command shown in the following example stops all abnormal traces
running on the Cisco PGW 2200 Softswitch:
mml> STP-ABN-TRC:ALL
Media Gateway Controller 2000-05-26 07:02:11
M COMPLD
"ALL:Trace stopped for the following files:
../var/trace/_20000526070211.abn
"
;
Comments:
Performance Impact Category: A
This command accepts wildcards on signal paths.
STP-AUD—Stop Auditing Process
Purpose:
Stops the auditing process started with the STA-AUD command.
Syntax:
STP-AUD
Example:
The MML command shown in the following example stops all auditing processes
started with the STA-AUD command:
mml> STP-AUD
Media Gateway Controller
M RTRV
"ENGG-01"
;
Comments:
- MGC-01 2000-01-12 15:19:51
Performance Impact Category: A
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-78
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
STP-CALL—Stop Calls
STP-CALL—Stop Calls
Purpose:
Stops calls in progress for a specified signal channel or destination point code. It first
attempts to gracefully stop calls, and, if unsuccessful, it forcefully releases the calls.
By default, all traffic channels are affected.
Syntax:
stp-call:<mgc>:confirm
stp-call:<gway>:confirm
stp-call:<trkgrp>:confirm
stp-call:<sigpath>:confirm
stp-call:<sigpath>:span=x,confirm
stp-call:<sigpath>:span=x,bc=y[,rng=z],confirm
stp-call:<sigpath>:cic=x[,rng=y],confirm
Input
Description:
Target parameters are as follows:
•
mgc—Corresponding MML name of the Cisco PGW 2200 Softswitch.
•
gway—Corresponding MML name for the media gateway. Not all media gateway
types are applicable. Supported types are CU, MUX, MGW, and AVM external
nodes.
•
trkgrp—Applicable only for time-division multiplexing (TDM). Use the
corresponding MML name for component type "0020".
Note
•
When specifying the trunk group number, enter the prefix tg-.
Example: stp-call:tg-404:confirm
sigpath—Corresponding MML name for any of the following component types:
– Signal path of in-band TDM up to MUX and then time switched to TDM
media and sent to the Cisco PGW 2200 Softswitch
– Signal path of in-band TDM signaling up to CU and then encapsulated and
sent over IP to the Cisco PGW 2200 Softswitch
– Signal path of in-band TDM signaling up to NAS and then converted to NI2
and sent to the Cisco PGW 2200 Softswitch over IP (that is, FE
box<-sig/tdm->NAS<-NI2/IP-> MGC)
– Signal path or route set associated with SS7 destination PC
– Signal path for EISUP
•
span—spanId is a 16-bit value that identifies an ISDN/PRI physical cable.
•
bc—Numeric value that identifies the non-ISUP bearer channel number. BC is
used for non-ISUP trunks; otherwise use CIC.
•
cic—Numeric value that identifies the ISUP circuit identification code number.
•
rng—Range of either the bearer channel or the CIC.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-79
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
STP-SC-TRC—Stop One or All Traces
Example:
The MML command shown in the following example stops calls in progress for signal
channel PC-2-2-2-2:
mml> STP-CALL:PC-2-2-2-2:CONFIRM
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
;
Comments:
Performance Impact Category: C
STP-SC-TRC—Stop One or All Traces
Purpose:
Stops a protocol conversion trace session on one signal path or on all signal paths.
Syntax:
stp-sc-trc:<sig path>
stp-sc-trc:<trkgrp>
stp-sc-trc:all
Input
Description:
•
sig path—Logical identifier for a signal path.
•
trkgrp—Logical identifier for a trunk group.
When specifying the trunk group number, enter the prefix tg-.
Example: stp-sc-trc:tg-404
•
Example:
all—Stops all traces.
The MML command shown in the following example stops a trace session on the path
identified as T-1-1:
mml> STP-SC-TRC:T-1-1
The MML command shown in the following example stops all active trace sessions:
mml> STP-SC-TRC:all
Media Gateway Controller 2000-03-21 15:28:03
M COMPLD
"ALL:Trace stopped for the following files:
../var/trace/_dpc1_20000321152752.btr
"
;
Comments:
Performance Impact Category: A
STP-TCAP-TRC—Stop TCAP Tracing
Purpose:
Stops TCAP tracing that has been started with the STA-TCAP-TRC command.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-80
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
SW-OVER—Manual Switchover
Syntax:
stp-tcap-trc
Example:
The MML command shown in the following example stops TCAP tracing:
mml> STP-TCAP-TRC
Media Gateway Controller
M RTRV
"TCAP-01"
;
- MGC-01 2000-01-12 15:19:51
SW-OVER—Manual Switchover
Purpose:
Enables a switchover from an active to a standby system. You cannot use the sw-over
command when the provisioning is new.
Syntax:
sw-over::confirm
Example:
The MML command shown in the following example enables a switchover from the
active system to the standby system:
mml> SW-OVER::CONFIRM
Media Gateway Controller
M COMPLD
;
Comments:
- MGC-01 2000-01-12 15:19:51
Performance Impact Category: D. Established calls are retained on forced switchover,
and calls that are currently being set up may be dropped.
TST-COT—Manual COT
Purpose:
Executes a continuity test on a specified remote switch circuit.
Syntax:
tst-cot:<sigpath>:CIC=<number>
Input
Description:
•
sigpath—MML component name of a provisioning component signal path.
•
cic=number—A numeric value that identifies the ISUP circuit identification code
number.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-81
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
UNBLK-CIC—Unblock a Circuit or a Circuit Range
Example:
The MML command shown in the following example executes a continuity test on
C7S-01 CIC-5:
mml> TST-COT:C7S-01:CIC=5
Media Gateway Controller - MG-01 2000-01-12 15:19:51
M COMPLD
;
Comments:
Performance Impact Category: B.
If a continuity test fails, use the BLK-CIC command to block the CIC until the
problem is identified and corrected. After a successful continuity test, use the
UNBLK-CIC command to unblock the CIC.
UNBLK-CIC—Unblock a Circuit or a Circuit Range
Purpose:
Unblocks a circuit or a range of circuits that have been blocked with the BLK-CIC
command.
Syntax:
unblk-cic:<sigpath>:cic=<number>[,rng=<range>]
Input
Description:
Example:
•
sigpath—MML component name of a provisioning component signal path.
•
number—A valid circuit identification code (CIC).
•
range—A number such that number + range is a valid CIC. All circuits between
number and number + range are unblocked. The range should not span trunks. For
example, to unblock all the CICs from 60 through 90, the number would be 60 and
the range would be 30.
The MML command shown in the following example unblocks CICs 5 through 15 for
signal path ss7svc1:
mml> UNBLK-CIC:ss7svc1:CIC=5,RNG=10
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M COMPLD
"dpc1"
;
Comments:
Performance Impact Category: B
VLD-CIC—Validate a Circuit
Purpose:
Validates a circuit on a specified signal path and CIC.
Note
Syntax:
In software releases prior to and including 9.3(2), this command is supported
only for SS7PATHs running the ANSI protocol.
vld-cic:<sigpath>:cic=<number>
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-82
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
VLD-CIC—Validate a Circuit
Input
Description:
Example:
•
sigpath—MML component name of a signal path associated with the CIC.
•
number—A valid circuit identification code.
The MML command shown in the following example validates a circuit on SS7SVC1
CIC-105:
ml> VLD-CIC:SS7SVC1:CIC=105
Media Gateway Controller - MGC-01 2000-03-07 09:35:19
M RTRV
“ss7svc1:CIC=105,PASSED”
;
Example:
The MML command shown in the following example shows the MML response for a
circuit that has failed validation:
mml> VLD-CIC:SS7SVC1:CIC=1314
MGC-01 - Media Gateway Controller 2001-02-08 13:54:04
M RTRV
"ss7svc1:CIC=1314,FAIL"
;
Comments:
Performance Impact Category: B
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-83
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
VLD-CIC—Validate a Circuit
Output
Description:
LOC: Values associated with the Cisco PGW 2200 Softswitch.
REM: Values associated with the destination exchange. Valid values for these fields
are:
•
GRP—Circuit group carrier indicator. The values in these fields should be the
same in the LOC and REM lines. Valid values are:
– UNK—Unknown circuit group carrier type
– ANL—Analog circuit group carrier type
– DIG—Digital circuit group carrier type
– AND—Analog and digital circuit group carrier type
•
SEIZ—Double seizing indicator. The values for this field in the LOC line should
be logically opposite to the value for the REM line. Valid values are:
– NONE—No circuit control. When one line is set to NONE, the other should
be set to ALL.
– ALL— All circuit control. When one line is set to ALL, the other should be
set to NONE.
– EVEN— Even circuit control. When one line is set to EVEN, the other
should be set to ODD.
– ODD—Odd circuit control. When one line is set to ODD, the other should be
set to EVEN.
•
ALM—Alarm carrier indicator. The values in these fields should be the same in
the LOC and REM lines. Valid values for this field are:
– UNK—Unknown alarm carrier
– SOFT—Software alarm carrier
– HARD—Hardware alarm carrier
•
COT—Continuity check requirements indicator. The values in these fields should
be the same in the LOC and REM lines. Valid values are:
– UNK—Unknown continuity check requirements
– NONE—No continuity check requirements
– STAT—Statistical continuity check requirements
– PERC—Per call continuity check requirements
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-84
OL-1116-24
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
VLD-CIC—Validate a Circuit
•
TRK—Trunk number. This field is always displayed in the LOC line. It is only
displayed in the REM line when the circuit identification names for the
Cisco PGW 2200 Softswitch and the destination exchange do not match.
•
A_CLLI—Common language location identifier (CLLI) for either the destination
exchange or the Cisco PGW 2200 Softswitch. CLLIs for each are sorted
alphanumerically, and the A_CLLI field is populated with the CLLI that is first
alphanumerically. This field is always displayed in the LOC line. It is only
displayed in the REM line when the circuit identification names for the
Cisco PGW 2200 Softswitch and the destination exchange do not match.
•
Z_CLLI—CLLI code assigned to the Cisco PGW 2200 Softswitch for either the
destination exchange or the Cisco PGW 2200 Softswitch. CLLIs for each are
sorted alphanumerically, and the Z_CLLI field is populated with the CLLI that is
last alphanumerically. This field is always displayed in the LOC line. It is only
displayed in the REM line when the circuit identification names for the
Cisco PGW 2200 Softswitch and the destination exchange do not match.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-85
Chapter 1
Commands for Operations, Maintenance, and Troubleshooting
VLD-CIC—Validate a Circuit
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-86
OL-1116-24
CH A P T E R
1
PROV: Commands for Provisioning Signaling and
Trunking Components
Revised: Aug 30, 2011, OL-1116-24
This chapter describes the Machine-Man Language (MML) commands for provisioning components on
the Cisco PGW 2200 Softswitch Release 9. After the introductory section, the commands for each
component are grouped together, and the information is displayed in alphabetical order by component.
Tip
The prov-add command adds (creates) an instance of a component.
The prov-dlt command deletes (removes) an instance of a component.
The prov-ed command edits (modifies) an instance of a component.
The prov-rtrv command retrieves (displays) information about one or more instances of a component.
The first section provides general information about the MML command syntax. The remaining sections
are in alphabetical order by component.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-1
Chapter 1
Command Syntax for Provisioning Signaling and Trunking Components
PROV: Commands for Provisioning Signaling and Trunking Components
Command Syntax for Provisioning Signaling and Trunking
Components
This section shows the general syntax for component provisioning commands.
Purpose:
Provisions a component to the Cisco PGW 2200 Softswitch configuration.
Syntax:
prov-add:<comp>:name=”<MML name>”,<param name>=<param value>,...
prov-dlt:<comp>:name=”<MML name>”,...
prov-ed:<comp>:name=”<MML name>”,<param name>=<param value>,...
prov-rtrv:<comp>:name=”<MML name>”,<param name>=<param value>,...
prov-rtrv:<comp>:name=”<MML name>”|”all”,...
prov-rtrv:all
Input
Description:
•
comp—MML component name for the type of configuration you are creating. The component type must
match one of the component types listed in Cisco PGW 2200 Softswitch Release 9 Provisioning Guide. For
software Release 7.4(8) and later, <comp> can be EXTNODE. If <comp> is EXTNODE, then the <param
name> TYPE must be present and needs to take a set of values (see the second example below).
•
name—MML component name for the new object you are creating (as many as ten characters).
•
param name—The name of a valid configuration parameter for the specified component type. Parameter
names are listed in Cisco PGW 2200 Softswitch Release 9 Provisioning Guide.
•
param value—The value you want to assign to the parameter. If the parameter value is a string, it should
be surrounded by quotation marks.
To define more than one parameter, enter additional param name=param value descriptions on the command
line.
Examples:
The MML command shown in the following example adds the origination point code for the
Cisco PGW 2200 Softswitch configuration:
mml> PROV-ADD:opc:NAME="opc",DESC="Point code of CP1",netaddr="0.0.1", netind=2,type=”TRUEOPC”
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M COMPLD
"opc"
;
The MML command shown in the following example adds an external node to the Cisco PGW 2200 Softswitch
configuration:
mml> PROV-ADD:EXTNODE:NAME="TOTO2",DESC="TATA",TYPE="MGX8260"
Media Gateway Controller - MGC-02 2000-05-08 18:05:55
M COMPLD
"extnode"
;
Comments:
Performance Impact Category: B
See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for a description of using the PROV commands
for provisioning and for information about components, parameter names, parameter descriptions, and
parameter values.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-2
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
ACCRESPCAT—Automatic Congestion Control (ACC) Response Categories
ACCRESPCAT—Automatic Congestion Control (ACC) Response
Categories
Purpose:
Provision an ACC response category.
Syntax:
prov-add:accrespcat:name="cat_name"[,field_name=value,field_name=value...]
prov-dlt:accrespcat:name="cat_name"
prov-ed:accrespcat:name="cat_name"[,field_name=value,field_name=value...]
prov-rtrv:accrespcat:name="cat_name"
prov-rtrv:accrespcat:"all"
Input
Description:
•
cat_name—MML name for the ACCRC.
•
field_name—ACCRC field that is used to specify a percentage of calls that are released when a
congestion indication of a particular ACL level is received from an adjacent signaling point. The
following fields can be configured:
– acl1drcant—Specifies the percentage of calls defined in value that are released when an ACL
indication of 1 is received from an adjacent signaling point and this trunk group is configured as a
direct route from that signaling point.
– acl1drskip—Specifies the percentage of calls defined in value that are re-routed to an alternate
trunk group when an ACL indication of 1 is received from an adjacent signaling point.
– acl1arcant—Specifies the percentage of calls defined in value that are released when an ACL
indication of 1 is received from an adjacent signaling point and this trunk group is configured as an
alternate route from that signaling point.
– acl1arskip—Specifies the percentage of calls defined in value that are re-routed to an alternate
trunk group when an ACL indication of 1 is received from an adjacent signaling point.
– acl2drcant—Specifies the percentage of calls defined in value that are released when an ACL
indication of 2 is received from an adjacent signaling point and this trunk group is configured as a
direct route from that signaling point.
– acl2drskip—Specifies the percentage of calls defined in value that are re-routed to an alternate
trunk group when an ACL indication of 2 is received from an adjacent signaling point.
– acl2arcant—Specifies the percentage of calls defined in value that are released when an ACL
indication of 2 is received from an adjacent signaling point and this trunk group is configured as an
alternate route from that signaling point.
– acl2arskip—Specifies the percentage of calls defined in value that are re-routed to an alternate
trunk group when an ACL indication of 2 is received from an adjacent signaling point.
– acl3drcant—Specifies the percentage of calls defined in value that are released when an ACL
indication of 3 is received from an adjacent signaling point and this trunk group is configured as a
direct route from that signaling point.
– acl3drskip—Specifies the percentage of calls defined in value that are re-routed to an alternate
trunk group when an ACL indication of 3 is received from an adjacent signaling point.
– acl3arcant—Specifies the percentage of calls defined in value that are released when an ACL
indication of 3 is received from an adjacent signaling point and this trunk group is configured as an
alternate route from that signaling point.
– acl3arskip—Specifies the percentage of calls defined in value that are re-routed to an alternate
trunk group when an ACL indication of 3 is received from an adjacent signaling point.
•
value—Percentage of calls that are released. The valid range is 0 through 100.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-3
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
APC—Adjacent Point Code
Output
Description:
Example:
•
COMPLD—Provision succeeds.
•
DENY— Provision fails.
The MML command shown in the following example adds an ACC response category:
mml> prov-add:accrespact:name="cat1",acl1drcant=20,acl1drskip=20,acl1arcant=10,acl1arskip=10
MGC-01 - Media Gateway Controller 2009-11-25 10:47:38.222 EST
M COMPLD
"accrespcat"
;
APC—Adjacent Point Code
Purpose:
Add, delete, or edit an APC.
Syntax:
prov-add:apc:name="name", desc="description", netaddr=”addr”, netind=num
prov-dlt:apc:name="name"
prov-ed:apc:name="name", desc="description", netaddr=”addr”, netind=num
Input
Description:
Example:
•
name—Enter a name for the component. The name can be as many as 20 characters long and can contain
numbers, letters, and the dash (-) symbol. The name should begin with a letter.
•
desc—Enter a long name up to 128 alphanumeric characters in length.
•
netaddr—Enter the network address in dot notation.
•
netind—Enter the network indicator number. The default value is 0.
To add an APC named apc1, enter the following command:
mml> prov-add:apc:NAME="apc1",DESC="apc1",NETADDR="1.2.4",NETIND=2
To delete an APC named apc1, enter the following command:
mml> prov-dlt:apc:NAME="apc1"
To edit an APC named apc1, enter the following command:
mml> prov-ed:apc:NAME="apc1",DESC="apc1",NETADDR="1.2.5",NETIND=3
ASSOCIATION—SCTP Association
Purpose:
Configures an SCTP association between the Cisco PGW 2200 Softswitch and an external node.
Syntax:
prov-add:association:name=”association name”,desc=”description”,type=”signaling type”,
sgp=”process”,ipaddr1=”ip address”,<ipaddr2=”ip address”,>port=value,peeraddr1=”ip address”,
<peeraddr2=”ip address”>,<peerport=value>,extnode=”external node”,<iproute1=”ip route”>,
<iproute2=”ip route”>,<rcvwin=value>,<maxinitretrans=value>,<maxinitrto=value>,
<maxretrans=value>,<cumsackto=timeout value>,<bundleto=timeout value>, <minrto=timeout
value>,<maxrto=timeout value>,<hbto=value>,ipprecedence=precedence,dscp=code point,
<maxretransdest=value>
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-4
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
ASSOCIATION—SCTP Association
Input
Description:
•
Name—Name of the association. Enter an alphanumeric string up to 20 characters in length.
•
Desc—Description of the association. This parameter can be up to 128 characters in length.
•
Type—Association type. Enter one of the following:
– IUA
– M3UA
– SUA
– H248 (The option “H248” is introduced in software Release 9.7(3). Configures the H.248 transport
protocol as SCTP. The type in “association.dat” can be used to indicate H.248.)
•
SGP—MML name of a previously configured Signaling Gateway Process. (Enter “N/A” for H.248 SCTP
connection.)
•
Port—Local Stream Control Transmission Protocol (SCTP) port. Enter an integer in the range 1025 to
65535. The default varies based on the protocol type selected.
– The default is 9900 for IUA.
– The default is 2905 for M3UA.
– The default is 14001 for SUA.
This is an optional parameter.
•
Peeraddr1—Highest priority destination address, expressed in dot notation.
•
Peeraddr2—(Optional) Lowest priority destination address, expressed in dot notation. The default value
for this parameter is 0.0.0.0.
•
Ipaddr1—First local address represented by one of the following property names defined in the
XECfgParm.dat file:
– IP_Addr1
– IP_Addr2
– IP_Addr3
– IP_Addr4
•
Ipaddr2—(Optional) Second local address represented by one of the following property names defined in
the XECfgParm.dat file:
– IP_Addr1
– IP_Addr2
– IP_Addr3
– IP_Addr4
•
Peerport—(Optional) Destination (peer) SCTP port:
– Enter a number. Range is 1025 to 65535.
– The default is 9900 for IUA.
– The default is 2905 for M3UA.
– The default is 14001 for SUA.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-5
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
ASSOCIATION—SCTP Association
•
Extnode—MML name of a previously configured external node.
•
Iproute1—(Optional) MML name of a previously configured IP route.
•
Iproute2—(Optional) MML name of a previously configured IP route.
•
Rcvwin—(Optional) Number of bytes to advertise for the local receive window.
– Enter a number in the range 1500 to 65535.
– The default is 18000.
•
Maxinitretrans—(Optional) Maximum number of times to retransmit SCTP INIT message.
– Enter a number in the range 0 to 100.
– An entry of 0 chooses the SCTP internal default.
– The default is 10.
•
Maxinitrto—(Optional) Maximum initial timer retransmission value.
– Enter a number in the range 300 to 3000.
– An entry of 0 chooses the SCTP internal default.
– The default is 2000.
•
Maxretrans—(Optional) Maximum number of retransmissions over all destination addresses before the
association is declared to have failed.
– Enter a number in the range 1 to 10
– This value must not exceed MAXRETRANSDEST * the number of destinations.
– The default is 5.
•
Cumsackto—(Optional) Maximum time after a datagram is received before a SCPT SACK is sent, in
milliseconds.
– Enter a number in the range 100 to 500.
– The default is 300.
•
Bundleto—(Optional) Maximum time SCTP waits for other outgoing datagrams for bundling, in
milliseconds.
– Enter a number in the range 100 to 600.
– The default is 100.
•
Minrto—(Optional) Minimum value for the retransmission timer, in milliseconds.
– Enter a number in the range 300 to 3000.
– The default is 300.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-6
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
ASSOCIATION—SCTP Association
•
Maxrto—(Optional) Maximum value for the retransmission timer, in milliseconds.
– Enter a number in the range 1000 to 10,000.
– The default is 3000.
•
Hbto—(Optional) Time between heartbeats, in milliseconds. The heartbeat is this value plus the current
retransmission timeout value.
– Enter a number in the range 300 to 10,000.
– Enter 0 to disable this parameter.
– The default is 2000.
•
Ipprecedence—Internet Protocol Precedence. Enter one of the following:
– ROUTINE (default)
– PRIORITY
– IMMEDIATE
– FLASH
– FLASH-OVERRIDE
– CRITICAL
– INTERNET
– NETWORK
•
DSCP—(Optional) Time between heartbeats, in milliseconds. The heartbeat is this value plus the current
retransmission timeout value. Valid values are in the range from 300 to 10000, or 0. A value of 0 means
that the heartbeat is disabled. The default value is 2000.
– EF101110—Expedited Forwarding
– AF11001010—Assured Forwarding Class 1 Low Drop Precedence
– AF12001100—Assured Forwarding Class 1 Medium Drop Precedence
– AF13001110—Assured Forwarding Class 1 High Drop Precedence
– AF21010010—Assured Forwarding Class 2 Low Drop Precedence
– AF22010100—Assured Forwarding Class 2 Medium Drop Precedence
– AF23010110—Assured Forwarding Class 2 High Drop Precedence
– AF31011010—Assured Forwarding Class 3 Low Drop Precedence
– AF32011100—Assured Forwarding Class 3 Medium Drop Precedence
– AF33011110—Assured Forwarding Class 3 High Drop Precedence
– AF41100010—Assured Forwarding Class 4 Low Drop Precedence
– AF42100100—Assured Forwarding Class 4 Medium Drop Precedence
– AF43100110—Assured Forwarding Class 4 High Drop Precedence
– N/A (default)
•
Maxretransdest—(Optional) Maximum number of retransmissions to a destination address
(PEERADDR1 or PEERADDR2) before it is declared failed. Enter a value in the range 1 to 10; the default
is 3.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-7
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
ATMPROFILES—ATM Profiles
Example:
The MML command shown in the following example creates an association between an
Cisco PGW 2200 Softswitch and a NAS:
mml> prov-add:association:name="nasassoc2",ipaddr1="IP_Addr1",ipaddr2="IP_Addr2",
peeraddr1="10.82.80.30",peeraddr2="10.82.81.30",extnode="va-5300-37",type="IUA",
iproute1="iprte1",iproute2="iprte2"
The MML command shown in the following example configures the H.248 transport protocol as SCTP:
mml> prov-add:association: NAME="h248-sctp1",DESC="link 1 to VXSM-01",type="H248",
ipaddr1="IP_Addr1", port=2944, peeraddr1="10.0.0.3",peerport=2944, extnode="h248-VXSM-01"
Comments:
Performance Impact Category: A
ATMPROFILES—ATM Profiles
Purpose:
Add, delete, edit, or retrieve an ATM profile in routeAnalysis.dat.
Syntax:
prov-add:atmprofiles:name="atm profiles name",atmprofiles="ATM profiles string"
prov-dlt:atmprofiles:name="atm profiles name"
prov-ed:atmprofiles:name="atm profiles name",atmprofiles="ATM profiles string"
prov-rtrv:atmprofiles:name="atm profiles name",atmprofiles="ATM profiles string"
Input
Description:
Example:
•
name—The MML name of the ATM profile. It has a string length 1 to 20 in quotes. Alphanumerics and
dashes are allowed. The name must start with a character.
•
atmprofiles—ATM profiles string. It has a string length of 0 to 128.
The MML command shown in the following example adds the atmprofile atmprof1 to ITU1.
mml> prov-add:atmprofiles:name="atmprof1",atmprofiles="ITU1;custom100"
$ATMProfiles
# CiscoMGC: 01
#name ATMProfiles
atmprof1 ITU1;custom100
The MML command shown in the following example deletes the atm profile.
mml> prov-dlt:atmprofiles:name="atmprof1"
The MML command shown in the following example edits the atm profile.
mml> prov-ed:atmprofiles:name="atmprof1",atmprofiles="ITU1;custom200"
The MML command shown in the following example displays the atm profile.
mml> prov-rtrv:atmprofiles:name="atmprof1",atmprofiles="ITU1;custom100"
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-8
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
AXLSERVER—AXL Server
AXLSERVER—AXL Server
Purpose:
Add—Sets the AXL server on the PGW to IS/OS.
Delete—Deletes the AXL server on the PGW.
Edit—Changes the state of the AXL server on the PGW.
Retrieve—Retrieves the state of the AXL server on the PGW.
Note
Syntax:
Input
Description:
Example:
A ctipath cannot have more than two AXL servers.
prov-add:axlserver:name="name",desc="description",ctipath=”ctisigpath”,ipaddr1=“localipaddr”,
<ipaddr2=”ipaddress”>,port=value,peeraddr1=”ipaddress”,peeraddr2=”ipaddress”,
peerport=”ctimgrport”,iproute1=”iproute1”[,iproute2=”iproute2”],username=”username”,
password=”password”
prov-dlt:axlserver:name="name"
prov-ed:axlserver:name="name",desc="description",username=”username”,password=”password”
prov-rtrv:axlserver:name="name"|"all"
•
name—MML name of the AXL server.
•
desc—Description of the AXL server.
•
ctipath—Name of an existing CTI sigpath.
•
ipaddr1—Local IP address of the CTI manager.
•
ipaddr2—(Optional) Second local IP address of the CTI manager.
•
port—IP port.
•
peeraddr1—First peer address of the CTI manager.
•
peeraddr2—Second peer address of the CTI manager.
•
peerport—Peer CTI manager port.
•
iproute1—Name of the first IP route.
•
iproute2—(Optional) Name of the second IP route.
•
username—User’s name. Can be a string up to 128 characters.
•
password—User’s password. Can be a string up to 128 characters.
The MML command shown in the following example sets the AXL server:
mml> prov-add:axlserver:name="axlserver", desc ="AXL server",ctipath =”ctisigpath”,
ipaddr1=“IP_addr1”, ipaddr2=“IP_addr2”, port=1, peeraddr1=”161.44.1.1”, peeraddr2=”161.44.1.5”,
iproute1=”ip1”, iproute2="iprte2", username=”admin”, password =”cisco”
The MML command shown in the following example deletes the AXL server:
mml> prov-dlt:axlserver:name="axlserver"
The MML command shown in the following example modifies the AXL server:
mml> prov-ed:axlserver:name="axlserver",desc ="AXL server",username =”admin”,password =”cisco”
The MML command shown in the following example retrieves the state of the AXL server:
mml> prov-rtrv:axlserver:name="axlserver"
Comments:
Property Domain—SIGPATH
Protocol Family—CTI
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-9
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
BEARERCAP—Bearer Capability
BEARERCAP—Bearer Capability
Purpose:
Add—Configures the bearer capability.
Delete—Deletes components or parameters in the bearer capability function.
Edit—Edits the bearer capability function.
Retrieve—Retrieves either all or a specified set of configured bearer capability attributes.
Syntax:
Input
Description:
Example:
prov-add:bearercap:name=”one”,bearercap=”tmrvalue1;tmrvalue2;tmrvalue3”
prov-dlt:bearercap:name=”name”
prov-ed:bearercap:name=”one”,bearercap=”tmrvalue1;tmrvalue2;tmrvalue3”
prov-rtrv:bearercap:{”all”|name=”bearer1”}
•
name—Bearer capability name. Up to 20 alphanumeric characters.
•
bearercap—Series of transmission medium requirements (TMR) values separated by semicolons.
•
all—Specifies all configured bearer capability attributes.
The MML commands shown in the following example provision bearer capability attributes:
mml> PROV-ADD:bearercap:name=”bearer1”,bearercap=”12;05;31”
mml> PROV-ADD:siprttrnkgrp:name=”2222”,url=”128.107.132.143”,svrr=0,sipproxyport=5060,
version=”2.0”,cutthrough=1,extsupport=1,bearercapname=”bearer1”
mml> PROV-ADD:rttrnkgrp:name=”1”,type=1,reattempts=3,queuing=0,cutthrough=1,
bearercapname=”bearer1”
The MML command shown in the following example deletes bearer capability functionality:
mml> PROV-DLT:bearercap:name=”one”
The MML command shown in the following example changes the TMR values in the bearer capability
function:
mml> PROV-ED:bearercap:name=”one”,bearercap=”4;5;6”
BRIPATH—BRI Signaling Service
Purpose:
Create a BRI signaling service.
Syntax:
prov-add:bripath:name="BRI Path Name",extnode="External Node Name",
desc="Description of the BRI Path",mdo="MDO",side="Call Side",
custgrpid="Customer Group ID",crlen=Call Reference Length
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-10
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
C7IPLNK—C7 IP Link
Input
Description:
•
name—The name you want to give to the QSIG/Q.931 over BRI Backhaul signaling service. The name
can be as many as 20 characters long and can contain numbers, letters, and the dash (-) symbol. The
name should begin with a letter.
•
desc—An assigned name. It can be as many as 128 alphanumeric characters in length.
•
extnode—MML name of a previously defined QSIG/Q.931 BRI voice gateway external node.
•
mdo—MDO filename, from the following list:
– ETS_300_102
– Q931
– ETS_300_172
Output
Description:
Example:
•
side—Q.931 call model side, user for user side and network for network side; (network).
•
custgrpid—VNET ID, a four-digit ID; (0000).
•
crlen—Call reference length; Valid values: 0 through 2. The value indicates the number of bytes in the
call reference length (0).
•
COMPLD—Provision succeeds.
•
DENY— Provision fails.
The MML command shown in the following example adds a BRI path:
mml> prov-add:bripath:name="brisvc1",extnode="bri-2600-1",desc="BRI service to
C2600",mdo="ETS_300_172",side="network",custgrpid="V123",crlen=2
MGC-01 - Media Gateway Controller 2009-11-25 10:47:38.222 EST
M COMPLD
"bripath"
;
C7IPLNK—C7 IP Link
Purpose:
Create a C7 IP link.
Syntax:
prov-add:c7iplnk:name="C7 IP Link Name",desc="C7 IP Link Description",
sessionset="Session Set Name",lnkset="Link Set Name",slc=Signaling Link Code,
pri=Priority,timeslot=Timeslot
Input
Description:
•
name—MML name of the C7 IP link. Up to 10 alphanumeric characters with an alpha character at the
beginning.
•
desc—The description of the C7 IP link. Up to 128 alphanumeric characters.
•
sessionset—The name of sessionset that encapsulates the SS7 messages for this link.
•
lnkset—Displays the linkset to which this link belongs.
•
slc—Unique identifier for the link. Corresponds to the Signaling Link Code (SLC) received from the
carrier. (Default = 0.)
•
pri—Identifies the priority value of the link. Give links same priority for load sharing. (Default = 1.)
•
timeslot—Identifies the WIC port of the Cisco SLT for the link. (Default = 0.)
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-11
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
CHARGE—Charge Table
Output
Description:
Example:
•
COMPLD—Provision succeeds.
•
DENY— Provision fails.
The MML command shown in the following example creates a C7 IP link
mml> prov-add:c7iplnk:name="C7Ip-1",desc="C7Iplink-1 in ls1",pri=1,slc=0,lnkset="ls1",
sessionset="SessionSet-1",timeslot=0
MGC-01 - Media Gateway Controller 2008-03-04 10:47:38.222 EST
M COMPLD
"c7iplnk"
;
CHARGE—Charge Table
Purpose:
Create an entry in the charge table.
Syntax:
prov-add:charge:chorig="value",chdest=1,dow=Day of Week,tariffdesc="Tariff Description"
Input
Description:
Output
Description:
Example:
•
chorig—Charge origins are integer values (1-9999). The value can be set incrementally when planning
the data build or you can choose to use any valid value at any time.
•
chdest—Charge destination.
•
dow—(Optional) Day of the Week, or holiday1 through 3. Default = 0.
•
tariffdesc—Tariff descriptor for Advice of Charge (AOC). Up to 62 alphanumeric characters. You can
use a signal tariff descriptor, or space-separated tariff descriptor and timechange (for example, trfId1
tmChg1) with maximum 11 tariff descriptors. The timechange values must be divisable by 15.
•
COMPLD—Provision succeeds.
•
DENY— Provision fails.
In the following example, calls from charge origin 1000 to charge destination 1000 use a tariff ID of 3 from
0000-0700, 4 from 0700-1800 and 3 from 1800 to 2400 from Monday to Friday. Saturday and Sunday are
charged at a fixed rate using tariff Id 3.
mml> prov-add:charge:chorig=1000,chdest=1000,tariffdesc="3 0700 4 1800 3"
mml> prov-add:charge:chorig=1, chdest=1, dow=”SATURDAY”, tariffdesc="3"
mml> prov-add charge:chorig=1, chdest=1, dow=”SUNDAY”, tariffdesc="3"
MGC-01 - Media Gateway Controller 2009-11-25 10:47:38.222 EST
M COMPLD
"charge"
;
CODECSTRING—Codec Selection
Purpose:
Add, delete, edit, or retrieve a codec selection.
Syntax:
prov-add:codecstring:name=”name of codec”,codecstring=”codecstring”
prov-dlt:codecstring:name=”name of codec”
prov-ed:codecstring:name=”name of codec”,codecstring=”codecstring”
prov-rtrv:codecstring:name=”name of codec”
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-12
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
CONDRTE—Conditional Routing Table
Input
Description:
Example:
•
name—Name of the codec, a string that can be up to 20 alphanumeric characters in length.
•
codecstring—A series of codec choices separated by semicolons. This entry can be up to 140 characters
in length.
The MML commands shown in the following example provisions the codec result type:
mml> PROV-ADD:codecstring:name=”codec1”,codecstring=”G.726-32;G.729b-L”
mml> NUMAN-ADD:resulttable:custgrpid=”T001”,resulttype=”codec”,dw1=”codec1”,dw2=”1”,
setname=”ra1”,name=”res1”
The MML command shown in the following example deletes the codec string “codec1”:
mml> PROV-DLT:codecstring:name=”codec1”
The MML command shown in the following example edits the codec string choices:
mml> PROV-ED:codecstring:name=”codec1”,codecstring=”G.726-32;G.729b-L”
Comments:
Specified codecs are not validated.
CONDRTE—Conditional Routing Table
Purpose:
Add—Configures the conditional routing table.
Delete—Deletes an entry from the conditional routing table or deletes the entire table.
Edit—Edits the conditional routing table.
Retrieve—Retrieves the conditional route, an entry in the conditional routing table, or all entries in the table.
Syntax:
Input
Description:
prov-add:condrte:name=”one”,dow=”day”,condrtedesc=”descone”
prov-dlt:condrte:name=”condName”,<dow=”default”>
prov-ed:condrte:name=”one”,dow=”day”,condrtedesc=”descone”
prov-rtrv:condrte:name=”condName”
prov-rtrv:condrte:name=”condName”, dow=”default”
prov-rtrv:condrte:”all”
•
name—Conditional routing name; up to 20 alphanumeric characters.
•
dow—Day of the week. For the PROV-ADD command, enter Default. Valid values:
– DEFAULT
– MONDAY
– TUESDAY
– WEDNESDAY
– THURSDAY
– FRIDAY
– SATURDAY
– HOL1
– HOL2
– HOL3
•
condrtedesc—Description of the conditional routing table (previously configured).
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-13
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
CONDRTEDESC—Conditional Routing Table Description
Example:
The MML commands shown in the following example configure the conditional routing table:
mml> PROV-ADD:condrte:name=”one”, dow=”default”, condrtedesc=”descone”
The MML command shown in the following example deletes the conditional routing table:
mml> PROV-DLT:CONDRTE:NAME=”condName1”
The MML command shown in the following example adds an entry for hol1 to conditional route one:
mml> PROV-ED:condrte:name=”one”, dow=”hol1”, condrtedesc=”descone”
The MML command shown in the following example displays the named conditional route:
mml> PROV-RTRV:CONDRTE:NAME=”condName”
Comments:
A conditional route description name must be configured before any conditional route can be connected to it.
Performance Impact Category: B, C. Impact depends on the size of the current configuration and what
information is retrieved.
CONDRTEDESC—Conditional Routing Table Description
Purpose:
Add, edit, or retrieve the conditional routing table description.
Syntax:
prov-add:condrtedesc:name=”descone”,primary=”ON”,rtlistname=”three”|percname=”name”}
prov-ed:condrtedesc:name=”descone”,starttime=”0000”,endtime=”1200”[,primary=”ON”]
{,rtlistname=”name”|perc=”name”}
prov-rtrv:condrtedesc:name=”descone”
Input
Description:
•
name—Conditional routing table description.
•
starttime—Enter a value from 0000 to 2359.
•
primary—The primary entry for the percentage-based routing name.
For the PROV-ADD command, either enter ON, or do not specify this component.
For the PROV-ED command, this entry specifies the primary route. Either STARTTIME and ENDTIME
or PRIMARY with a value of ON is supported.
Example:
•
rtlistname—Routing list name. Enter up to 20 alphanumeric characters (previously configured).
•
percname—Percentage-based routing name (previously configured).
The MML command shown in the following example configures the conditional routing table:
mml> PROV-ADD:condrtedesc:name:”descone”,rtlistname=”three”
The MML command shown in the following example adds another time period to the conditional route
description “desctwo”:
mml> PROV-ED:condrtedesc:name=”desctwo”,starttime=”1200”,endtime=”2345”,rtlistname=”three”
Comments:
A conditional route description name must be configured before any conditional route can be connected to it.
A total of five route list names and percentage-based routing names can be configured in a conditional route
description.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-14
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
CTIMGR—CTI Manager
CTIMGR—CTI Manager
Purpose:
Add, delete, edit, or retrieve the CTI manager on the PGW to IS/OS.
Note
Syntax:
A CTI path cannot have more than two CTI managers.
prov-add:ctimgr:name="name",desc="description",ctipath=”ctisigpath”,ipaddr1=“localipaddr”
[,ipaddr2=”ipaddress”],port=value,peeraddr1=”ipaddress”,peeraddr2=”ipaddress”,
peerport=”ctimgrport”,iproute1 =”iproute1”[,iproute2=”iproute2”],username=”username”,
password=”password”,ctiversion=“version”
prov-dlt:ctimgr:name="name"
prov-ed:ctimgr:name="name",desc="description",ctipath="ctisigpath",ipaddr1="localipaddr",
peeraddr1="ipaddress",iproute1="iproute1",username="username",password="password",
ctiversion="version"
prov-rtrv:ctimgr:name="name"
Input
•
name—The MML name of the CTI manager.
Description:
•
desc—The description of the CTI manager.
•
ctisigpath—The name of an existing CTI sigpath.
•
ipaddr1—The local IP address of the CTI manager.
•
ipaddr2—(Optional) The second local IP address of the CTI manager.
•
port—IP port.
•
peeraddr1—The first peer address of the CTI manager.
•
peeraddr2—(Optional) The second peer address of the CTI manager.
•
peerport—Peer CTI manager port.
•
iproute1—The name of the first IP route.
•
iproute2—The name of the second IP route. This is an optional parameter.
•
username—The name of the user. Can be a string up to 128 characters.
•
password—The password used by the user. Can be a string up to 128 characters.
•
ctiversion—The version of the CTI manager. Can be a string up to 20 characters.
Example:
The MML command shown in the following example enables the CTI Manager on the PGW:
mml> prov-add:ctimgr:name="ctimgr",desc ="CTI manager 1",ctipath=”ctisigpath”,
ipaddr1=“IP_addr1”,peeraddr1 =”161.44.1.1”,iproute1=”ip1”,username=”admin”,password=”cisco”,
ctiversion=”5”
The MML command shown in the following example deletes the CTI Manager on the PGW:
mml> prov-dlt:ctimgr:name="axlserver"
The MML command shown in the following example enables the CTI Manager on the PGW:
mml> prov-ed:ctimgr:name="ctimgr",desc ="CTI manager 1",ctipath="ctisigpath",
ipaddr1="IP_addr1",peeraddr1="161.44.1.1",iproute1="ip1",username="admin",password="cisco",
ctiversion="5"
The MML command shown in the following example retrieves the state of the CTI Manager:
mml> prov-rtrv:ctimgr:name="axlserver"
Comments:
Property domain—SIGPATH
Protocol family—CTI
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-15
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
CTIPATH—CTI Path
CTIPATH—CTI Path
Purpose:
Add, delete, edit, or retrieve the CTI sigPath.
Note
Syntax:
The CTI sigPath can have up to eight CTI paths. Only one CTI path is allowed per CCM cluster.
prov-add:ctipath:name="name”,desc="description",extnode=”clustername”,MDO=”QBE”
prov-dlt:ctipath:name="name”
prov-ed:ctipath:name="name”,desc="description"
prov-rtrv:ctipath:name="name”|"all”
Input
•
name—The MML name of the CTI path.
Description:
•
description—The description of the CTI path.
•
extnode—The MML name of a previously defined external node.
•
mdo—The QBE sigpath. QBE is the default. PGW creates a QBE channel controller for each CTI path.
Example:
The MML command shown in the following example enables the CTI Manager on the PGW:
mml> prov-add:ctipath:name="ctipath”,desc="CTI path",extnode=”CCMCLUSTER”,MDO=”QBE”
The MML command shown in the following example deletes the CTI manager on the PGW:
mml> prov-dlt:ctipath:name="ctipath”
The MML command shown in the following example modifies the CTI sigPath on the PGW:
mml> prov-ed:ctipath:name ="ctipath"
The MML command shown in the following example retrieves information on an existing CTI sigpath on the
PGW:
mml> prov-rtrv:ctipath:name="ctipath”
Comments:
Property Domain—SIGPATH
Protocol Family—CTI
DCHAN—D-Channel
Purpose:
Add, delete, edit, or retrieve a D-channel used on the Cisco PGW 2200 Softswitch.
Syntax:
prov-add:dchan:name="name", desc="description", svc="BRI", pri=1,
[sessionset="ssetname"|tcplink="lnkname"], sigslot=sslot, sigport=sport, subunit=sunit
prov-dlt:dchan:name="name"
prov-ed:dchan:name="name", desc="description", svc="BRI", pri=1,
[sessionset="ssetname"|tcplink="lnkname"], sigslot=sslot, sigport=sport, subunit=sunit
prov-rtrv:dchan:name="name"|”all”
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-16
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
DCHAN—D-Channel
Input
Description:
•
name—Name you want to give to the D-channel. The name can be as many as 20 characters long and can
contain numbers, letters, and the dash (-) symbol. The name should begin with a letter.
•
desc—Description of the D-channel.
•
pri—Priority. 1 through 65535. Default value is 1.
•
svc—MML name of previously configured signaling service (IPFAS or QSIG/Q.931 over BRI Backhaul
only).
•
sessionset—MML name of a previously provisioned session set (used for PRI connections only). This
parameter is used only for D-channels associated with IPFAS signaling services.
•
tcplink—MML name of a previously provisioned backhaul TCP link (used for BRI connections only).
This parameter is used only for D-channels associated with QSIG/Q.931 over BRI Backhaul signaling
services.
•
sigslot—Physical slot on the Cisco media gateway on which the link is terminated.
– For Cisco 2600, 3600, and 3700 series MGWs, the valid values are integers from 0 to 63. Default
value is 0.
– For all other MGWs, the valid values are integers from 0 to 15. Default value is 0.
Note
This parameter must be set to 0 for QSIG/Q.931 over BRI backhaul D-channels when the associated
external node is a Cisco 17xx.
Note
This parameter must be set to 0 when VXSM is the external node TYPE selection.
•
sigport—Physical port of the associated slot on the Cisco media gateway. Valid values are integers from
0 to 336. Must be 0–167 for non-VXSM external node types, or 1–336 for VXSM external node type.
Default value is 0.
Note
This parameter can be set to either 0 or 1 for QSIG/Q.931 Over BRI Backhaul D-channels.
Note
When VXSM is the selected external node TYPE parameter, SIGSLOT must be set to 0, and the
SIGPORT value is an integer of 1 through 336.
•
subunit—Physical subunit on the Cisco MGW. Valid values are 0 through 3, and 99. The value 99 is added
in software Release 9.7(3). The value 99 is only for onboard 2-tuple T1/E1 controller on
NM-HDV2-1T1/E1, NM-HDV2-2T1/E1, and so on. Default value is 0.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-17
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
DNSPARAM—Domain Name System Parameters
Provisioning The following rules apply when you are creating or editing D-channels:
Rules:
• Backup D-channels for QSIG/Q.931 Over BRI Backhaul signaling services are not supported.
Example:
•
The priority for QSIG/Q.931 Over BRI Backhaul D-channels should be set to 1.
•
Session sets are used only in support of IPFAS D-channels.
•
TCP links are used only in support of QSIG/Q.931 Over BRI Backhaul D-channels.
•
Up to 1000 D-channels can be provisioned against a single IP address and port combination used by your
Backhaul TCP links. Because the Cisco PGW 2200 Softswitch supports a maximum of two IP address and
port combinations, you can provision a maximum of 1000 D-channels for a QSIG/Q.931 Over BRI
Backhaul signaling service.
•
For an external node TYPE selection of VXSM, the SIGPORT range is 1-336 and SIGSLOT must be set
to 0.
The MML command shown in the following example provisions an IP link:
mml> prov-add:dchan:NAME="bridchan1",DESC="QSIG BRI D channel 1", SVC="BRI", PRI="1",
TCPLINK="britcp1", sigslot="4", sigport="1", subunit="1"
The MML command shown in the following example deletes a D-channel:
mml> prov-dlt:dchan:NAME="bridchan1"
The MML commands shown in the following examples modify D-channels:
mml> prov-ed:dchan:name=''ipfas-pod1-1x'',sigport=1
MGC-01 - Media Gateway Controller 2008-02-18 11:28:24.016 CST
M COMPLD
''dchan''
mml> prov-ed:dchan:name=''ipfas-pod1-1x'',sigport=336
MGC-01 - Media Gateway Controller 2008-02-18 11:28:26.290 CST
M COMPLD
''dchan''
;
mml> prov-ed:dchan:name="ipfas-pod1-1x",sigport=338 SIGSLOT:
mml> prov-ed:DCHAN:NAME="ipfas-pod1-1x",sigport=0
MGC-01 - Media Gateway Controller 2007-11-13 04:57:39.901 EST
M DENY
SROF
"DCHAN:ipfas-pod1-1x:SIGPORT should be 1-336"
/* Status, Requested Operation Failed on the component */
DNSPARAM—Domain Name System Parameters
Purpose:
Provision domain name system (DNS)-related parameters to support SIP URL.
Syntax:
prov-add:dnsparam:dnsserver1="DNS Server 1",dnsserver2="DNS Server 2",
cachesize="Cache Size",ttl="DNS Time to Live", policy="Policy",
querytimeout="Query Timeout",keepalive="Keep Alive Time"
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-18
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
DOMAINPROF—Domain Profile (Release 9.8(1))
Input
Description:
Output
Description:
Example:
•
dnsserver1—IP address of primary DNS server.
•
dnsserver2—IP address of secondary DNS server. This is an optional parameter.
•
cachesize—Maximum number of cache entries used to hold DNS entries. Valid value is any integer
greater than 0. The default value is 500.
•
ttl—Time-to-live interval for DNS entries, expressed in seconds. Valid value is any integer greater than
0. The default value is 3600.
•
policy—Policy type used for selecting DNS entries. Valid values are hierarchy and round-robin. The
default value is hierarchy.
•
querytimeout—Timeout interval for DNS queries, expressed in milliseconds. Valid value is any integer
greater than 0. The default value is 1000.
•
keepalive—Time interval to determine whether DNS server is responding, expressed in seconds. Valid
value is any integer greater than 0. The default value is 30.
•
COMPLD—Provision succeeds.
•
DENY— Provision fails.
The MML command shown in the following example provisions DNS parameters:
mml> prov-add:dnsparam:dnsserver1="serv1",dnsserver2="serv2",cachesize="500",
ttl="3600",policy="hierarchy,querytimeout="1000",keepalive="30"
MGC-01 - Media Gateway Controller 2009-11-25 10:47:38.222 EST
M COMPLD
"dnsparam:
WARNING: Restart is needed to activate property(s): DnsServer1 DnsServer2 CacheSize TTL
QueryTimeout KeepAlive”
;
DOMAINPROF—Domain Profile (Release 9.8(1))
Purpose:
Create an entry in the domain table.
Syntax:
prov-add:domainprof:domain=”Domain Name",type="Inbound or Outbound",
profile=”Domain Profile Name”
Input
Description:
Output
Description:
Example:
•
domain—Domain name used to analyze traffic
•
type—Direction of the profile (inbound or outbound)
•
profile—Name of a domain profile that is used for the domain name
•
COMPLD—Provision succeeds.
•
DENY— Provision fails.
The MML command shown in the following example creates a domain profile:
mml> prov-add:domainprof:domain=''cisco.com'',type=''INBOUND'',profile=”dpf1”
MGC-01 - Media Gateway Controller 2008-03-04 10:47:38.222 EST
M COMPLD
''domainprof''
;
Comments:
Performance impact category A applies to the commands used to manage the domain table.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-19
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
DPC—Destination Point Code
DPC—Destination Point Code
Purpose:
Add, delete, or edit a DPC.
Syntax:
prov-add:dpc:name="name", desc="description", netaddr=”addr”, netind=num
prov-dlt:dpc:name="name"
prov-ed:dpc:name="name", desc="description", netaddr=”addr”, netind=num
Input
Description:
Example:
•
name—Name for the component. The name can be as many as 20 characters long and can contain
numbers, letters, and the dash (-) symbol. The name should begin with a letter.
•
desc—Description up to128 alphanumeric characters in length.
•
netaddr—Network address in dot notation.
•
netind—Network indicator number. The default value is 0.
To add a DPC named dpc1, enter the following command:
mml> prov-add:dpc:NAME="dpc1",DESC="dpc1",NETADDR="1.1.5",NETIND=2
To delete a DPC named dpc1, enter the following command:
mml> prov-dlt:dpc:NAME="dpc1"
To edit a DPC named dpc1, enter the following command:
mml> prov-ed:dpc:NAME="dpc1",DESC="dpc1",NETADDR="1.2.3",NETIND=2
DPNSSPATH—DPNSS Signaling Service
Purpose:
Add, delete, or edit a DPNSS path backhauled over IP to a media gateway.
Syntax:
prov-add:dpnsspath:name="name", desc="description", extnode=”mgw”, mdo=”dpnss_btnr188”,
custgrpid=”idnum”, sigslot=sslot, sigport=sport, subunit=sunit
prov-dlt:dpnsspath:name="name"
prov-ed:dpnsspath:name="name", desc="description", custgrpid=”idnum”, sigslot=sslot,
sigport=sport, subunit=sunit
prov-dlt:dpnsspath:name="name"|”all”
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-20
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
DPNSSPATH—DPNSS Signaling Service
Input
Description:
•
name—Name you want to give to the DPNSS signaling service. The name can be as many as 20 characters
long and can contain numbers, letters, and the dash (-) symbol. The name should begin with a letter.
•
desc—Description. It can be as many as 128 alphanumeric characters in length.
•
extnode—MML name of a previously defined DPNSS external node.
•
custgrpid—vnet ID (virtual network identification) a four-digit ID; (0000).
•
sigslot—Physical slot on the Cisco media gateway on which the link is terminated.
– For Cisco 2600, 3600, and 3700 series media gateways, the valid values are integers from 0 to 63.
Default value is 0.
– For all other media gateways, the valid values are integers from 0 to 15. Default value is 0.
•
sigport—Physical port of the associated slot on the Cisco media gateway. Valid values are integers from
0 to 167. Default value is 0.
•
subunit—Physical subunit on the Cisco MGW. Valid values are 0 through 3, and 99. The value 99 is added
in software Release 9.7(3). The value 99 is only for onboard 2-tuple T1/E1 controller on
NM-HDV2-1T1/E1, NM-HDV2-2T1/E1, and so on. Default value is 0.
Provisioning The following attributes cannot be modified:
Rules:
• NAME
•
EXTNODE
The following rules apply when you are creating or editing DPNSS signaling paths:
Example:
•
The maximum number of combined DPNSSPATHs and NASPATHs per IUA External Node is
IUA.maxSigPathsPerExtNode=112 from XECfgParm.dat. Because DPNSSPATHs and NASPATHs can
share the same association, the existing IUA.maxNasPathsPerExtNode is renamed to
IUA.maxSigPathsPerExtNode to support both.
•
The maximum number of combined DPNSSPATHs and IUA NASPATHs is IUA.maxSigPaths=1500 from
XECfgParm.dat. The existing IUA.maxNasPaths is renamed to IUA.maxSigPaths to support both with the
same validation limit.
•
Check the maximum number of external nodes with IUA type using the parameter
IUA.maxExtNodes=256. This parameter is shared by both naspath and dpnsspath. The existing parameter
IUA.maxNasExtNodes is renamed to IUA.maxExtNodes.
•
An ASSOCIATION must be defined with same EXTNODE attribute as the DPNSSPATH. If this
ASSOCIATION hasn’t been defined when the DPNSSPATH is added/edited, a warning is issued. If the
ASSOCIATION still has not been defined when provisioning session is copied or deployed, an error
message is generated and the copy or deployment is stopped.
•
If the ASSOCIATION with the same EXTNODE value as the DPNSSPATH is deleted, a warning message
is issued to inform the user that the DPNSSPATH must also be deleted. If it has not been deleted when the
provisioning session is copied or deployed, an error message is generated and the copy or deployment is
stopped.
mml> prov-add:dpnsspath:name="brisvc1”, extnode="dpnss-01", desc="DPNSS service",
mdo=”dpnss_btnr188”, custgrpid=”V123”, sigslot=4, sigport=1, subunit=1
mml> prov-dlt:dpnsspath:name="brisvc1"
mml> prov-ed:dpnsspath:name="brisvc1", sigslot=3
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-21
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
EISUPPATH—EISUP Sigpath
EISUPPATH—EISUP Sigpath
Purpose:
Add an EISUP sigpath.
Syntax:
prov-add:EISUPPATH:name="name",desc="description", EXTNODE="eisup1", MDO="EISUP|EISUP_96VER",
custgrpid="custgrpid", origlabel="origlabel", termlabel="termlabel"
Input
Description:
Example:
•
name—Name of the EISUP sigpath. Enter as many as 20 alphanumeric characters and enclose in straight
quotes. Begin the name with a letter character. The name can be as many as 20 characters and can contain
numbers, letters, and the dash (-) symbol.
•
desc—Name up to128 alphanumeric characters in length.
•
EXTNODE—External node name assigned to the media gateway you are configuring.
•
MDO—Valid message definition object (MDO) file protocol name. You can use either EISUP or
EISUP_96VER. Use EISUP with PGW 2200 Release 9.7 or later, and use EISUP_96VER with PGW 2200
Release 9.6.
•
custgrpid—Customer Group ID. Enter a four-digit ID; the default is 0000.
•
origlabel—Origination Location Label.
•
termlabel—Termination Location Label.
To add an E-ISUP signaling service to the media gateway configuration, use the PROV-ADD command as
follows:
mml> prov-add:eisuppath:name="eisupsrv1",extnode="extseq1",desc="EISUP Service to Ext Seq Node1
EXTNODE—External Node
Purpose:
Provisions the external node with which the Cisco PGW 2200 Softswitch communicates.
Syntax:
prov-add:extnode:name=”name”,desc=”description”,type=”external node type”,
isdnsigtype=”ISDN signaling type”,group=group number
prov-dlt:extnode:name=”name”
prov-ed:extnode:name=”name”,desc=”description”
prov-rtrv:extnode:name=”name”
Input
Description:
•
Name—MML name of the external node. Enter an alphanumeric value up to 20 characters in length that
starts with an alphabetic character.
•
Desc—Description of the external node. Enter a value up to 128 characters in length.
•
Type—One of the valid external node type. This parameter is case sensitive. Valid values are listed in
Table 1-1.
•
Isdnsigtype—ISDN signaling type. Enter one of the following:
– IUA
Note
The maximum number of external nodes with an ISDNSIGTYPE of IUA is 256.
– N/A (default)
•
Group—M3UA or SUA group number.
– Enter a number in the range 1 to 100 for M3UA or SUA nodes.
– Enter 0 for nodes that do not support M3UA or SUA nodes.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-22
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
EXTNODE—External Node
Example:
The MML command shown in the following example provisions an AS5300 NAS, va-5300-37, as an external
node:
mml> prov-add:extnode:name=”va-5300-37”,type=”AS5300",desc="IUA",isdnsigtype="IUA"
The following command adds a RADIUS accounting server as an external node:
mml> prov-add:extnode:name=”ranode1”
mml> prov-rtrv:extnode:name=”ranode1”
MGC-01 - Media Gateway Controller 2006-11-22 02:26:30.736 EST
M RTRV
''session=radius-magnolia:extnode''
/*
NAME = ranode1
DESC = notSet
TYPE = RACLUSTER
ISDNSIGTYPE = N/A
GROUP = 0
*/
The MML command shown in the following example deletes the external node:
mml> prov-dlt:extnode:name="va-5300-37"
The MML command shown in the following example edits the external node:
mml> prov-ed:extnode:name="va-5300-37",desc="IUA"
Comments:
Only one racluster type extnode is supported. This is checked at the add operation.
Table 1-1 lists the external node types. supported by the Cisco PGW 2200 Softswitch. In the
prov-add:extnode command, the valid values for the TYPE parameter are listed in the first column
(ExtNode MML Type). The other columns indicate which sigpath types the Cisco PGW 2200 Softswitch
supports for the external node.
You can retrieve this same information by looking at the extnode.dat file on your system. The file is
typically saved in the directory /opt/CiscoMGC/etc/.
Tip
Table 1-1
External Node Types for Cisco PGW 2200 Softswitch Software
ExtNode MML
Type
SGCP
MGCP
IPFAS
IUA
BRI
NAS
MGCP
ANNO
MGCP
IVR
SUA
Other
AS5200
—
—
IPFAS
—
—
NAS
—
—
—
—
AS5300
SGCP
MGCP
IPFAS
IUA
—
NAS
MGCP
ANNO
MGCP
IVR
—
—
AS5350
SGCP
MGCP
IPFAS
IUA
—
NAS
MGCP
ANNO
MGCP
IVR
—
BSMV0
AS5400
SGCP
MGCP
IPFAS
IUA
—
NAS
MGCP
ANNO
MGCP
IVR
—
BSMV0
AS5800
—
—
IPFAS
—
—
NAS
MGCP
ANNO
—
—
—
AS5850
—
MGCP
IPFAS
IUA
—
NAS
MGCP
ANNO
MGCP
IVR
—
—
AS7200
SGCP
MGCP
IPFAS
—
—
NAS
—
—
—
—
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-23
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
EXTNODE—External Node
Table 1-1
External Node Types for Cisco PGW 2200 Softswitch Software (continued)
ExtNode MML
Type
SGCP
MGCP
IPFAS
IUA
BRI
NAS
MGCP
ANNO
MGCP
IVR
SUA
Other
ASR1000
—
MGCP
IPFAS
IUA
BRI
—
—
—
—
H248, DTMF, UDP,
TCP, ETSI_NAPT,
ITU_IPNAPT,
EVPND
C1751
—
MGCP
IPFAS
IUA
BRI
—
—
—
—
—
C1760
—
MGCP
IPFAS
IUA
BRI
—
—
—
—
—
C2600
SGCP
MGCP
IPFAS
IUA
BRI
—
—
—
—
—
C2610XM
—
MGCP
IPFAS
IUA
BRI
—
—
—
—
—
C2611XM
—
MGCP
IPFAS
IUA
BRI
—
—
—
—
—
C2620XM
—
MGCP
IPFAS
IUA
BRI
—
—
—
—
—
C2621XM
—
MGCP
IPFAS
IUA
BRI
—
—
—
—
—
C2650XM
—
MGCP
IPFAS
IUA
BRI
—
—
—
—
—
C2651XM
—
MGCP
IPFAS
IUA
BRI
—
—
—
—
—
C2691
—
MGCP
IPFAS
IUA
BRI
—
—
—
—
—
C2801
—
MGCP
IPFAS
IUA
BRI
—
—
—
—
—
C2811
—
MGCP
IPFAS
IUA
BRI
—
—
—
—
—
C2821
—
MGCP
IPFAS
IUA
BRI
—
—
—
—
—
C2851
—
MGCP
IPFAS
IUA
BRI
—
—
—
—
—
C3600
SGCP
MGCP
IPFAS
—
—
—
—
—
—
—
C3640
—
MGCP
IPFAS
IUA
BRI
—
—
—
—
—
C3640A
—
MGCP
IPFAS
IUA
BRI
—
—
—
—
—
C3660
SGCP
MGCP
IPFAS
IUA
BRI
NAS
—
—
—
—
C3725
—
MGCP
IPFAS
IUA
BRI
—
—
—
—
—
C3745
—
MGCP
IPFAS
IUA
BRI
—
—
—
—
—
C3825
—
MGCP
IPFAS
IUA
BRI
—
—
—
—
—
C3845
—
MGCP
IPFAS
IUA
BRI
—
—
—
—
—
C7200
—
MGCP
IPFAS
IUA
BRI
—
—
—
—
H248, DTMF, UDP,
TCP, ETSI_NAPT,
ITU_IPNAPT,
EVPND
C7600
—
MGCP
IPFAS
IUA
BRI
—
—
—
—
H248, DTMF, UDP,
TCP, ETSI_NAPT,
ITU_IPNAPT,
EVPND
C12000
—
MGCP
IPFAS
IUA
BRI
—
—
—
—
H248, DTMF, UDP,
TCP, ETSI_NAPT,
ITU_IPNAPT,
EVPND
CAT8510
SGCP
MGCP
—
—
—
—
—
—
—
—
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-24
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
EXTNODETYPES—External Nodes
Table 1-1
External Node Types for Cisco PGW 2200 Softswitch Software (continued)
ExtNode MML
Type
SGCP
MGCP
IPFAS
IUA
BRI
NAS
MGCP
ANNO
MGCP
IVR
SUA
Other
CAT8540
SGCP
MGCP
—
—
—
—
—
—
—
—
CRS1
—
MGCP
IPFAS
IUA
BRI
—
—
—
—
H248, DTMF, UDP,
TCP, ETSI_NAPT,
ITU_IPNAPT,
EVPND
H323
—
—
—
—
—
—
—
—
—
EISUP
ITP
—
—
—
—
—
—
—
—
SUA
M3UA
LIMD
—
—
—
—
—
—
—
—
—
LI
LS1010
SGCP
MGCP
—
—
—
—
—
—
—
—
MC3810
—
MGCP
IPFAS
—
—
—
—
—
—
—
MGC
—
—
—
—
—
—
—
—
—
EISUP
MGX8260
—
MGCP
IPFAS
—
—
NAS
—
—
—
—
MGX8850
SGCP
MGCP
IPFAS
—
—
—
—
—
—
—
RACLUSTER
—
—
—
—
—
—
—
—
—
RA
SCP
—
—
—
—
—
—
—
—
—
TCAPIP
SLT
—
—
—
—
—
—
—
—
—
BSMV0
UNKNOWN
—
—
—
—
—
—
—
—
—
UNKNOWN
VISM
SGCP
MGCP
IPFAS
—
—
—
—
—
—
—
VXSM
SGCP
MGCP
IPFAS
IUA
—
—
MGCP
ANNO
—
—
M3UA, H248,
IPANNO, IPTONE,
CODEC, DTMF,
UDP, SCTP
EXTNODETYPES—External Nodes
Purpose:
Retrieves the external nodes connected to the media gateway.
Syntax:
prov-rtrv:extnodetypes
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-25
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
EXTNODETYPES—External Nodes
Output
Description:
MGC-01 -- Media Gateway Controller 2010-02-25 10:44:40.285 PST
M RTRV
“Session = 0312:extnodetypes”
/*
External Node Type Supported Sigpath Type(s)
------------------ ------------------------AS5200
IPFAS NAS
AS5300
SGCP MGCP IPFAS NAS IUA MGCPANNO MGCPIVR
AS5350
SGCP MGCP IPFAS NAS BSMV0 IUA MGCPANNO MGCPIVR
AS5400
SGCP MGCP IPFAS NAS BSMV0 IUA MGCPANNO MGCPIVR
AS5800
IPFAS NAS MGCPANNO
AS5850
IPFAS NAS MGCPANNO MGCP IUA MGCPIVR
AS7200
SGCP MGCP IPFAS NAS
ASR1000
H248 DTMF UDP TCP ETSI_NAPT ITU_IPNAPT EVPND
C12000
H248 DTMF UDP TCP ETSI_NAPT ITU_IPNAPT EVPND
C1751
MGCP IPFAS IUA BRI
C1751_OLD
MGCP IPFAS IUA BRI
C1760
MGCP IPFAS IUA BRI
C1760_OLD
MGCP IPFAS IUA BRI
C2600
SGCP MGCP IPFAS IUA BRI
C2600_OLD
SGCP MGCP IPFAS IUA BRI
C2610XM
MGCP IPFAS IUA BRI
C2610XM_OLD
MGCP IPFAS IUA BRI
C2611XM
MGCP IPFAS IUA BRI
C2611XM_OLD
MGCP IPFAS IUA BRI
C2620XM
MGCP IPFAS IUA BRI
C2620XM_OLD
MGCP IPFAS IUA BRI
C2621XM
MGCP IPFAS IUA BRI
C2621XM_OLD
MGCP IPFAS IUA BRI
C2650XM
MGCP IPFAS IUA BRI
C2650XM_OLD
MGCP IPFAS IUA BRI
C2651XM
MGCP IPFAS IUA BRI
C2651XM_OLD
MGCP IPFAS IUA BRI
C2691
MGCP IPFAS IUA BRI
C2691_OLD
MGCP IPFAS IUA BRI
C2801
MGCP IPFAS IUA BRI
C2811
MGCP IPFAS IUA BRI
C2821
MGCP IPFAS IUA BRI
C2851
MGCP IPFAS IUA BRI
C3600
SGCP MGCP IPFAS NAS IUA
C3640
MGCP IPFAS IUA BRI
C3640A
MGCP IPFAS IUA BRI
C3660
SGCP MGCP IPFAS NAS IUA BRI
C3725
MGCP IPFAS IUA BRI
C3725_OLD
MGCP IPFAS IUA BRI
C3745
MGCP IPFAS IUA BRI
C3745_OLD
MGCP IPFAS IUA BRI
C3825
MGCP IPFAS IUA BRI
C3745
MGCP IPFAS IUA BRI
C7200
H248 DTMF UDP TCP ETSI_NAPT ITU_IPNAPT EVPND
C7600
H248 DTMF UDP TCP ETSI_NAPT ITU_IPNAPT EVPND
CAT8510
MGCP SGCP
CAT8540
MGCP SGCP
CCMCLUSTER
N/A
CRS1
H248 DTMF UDP TCP ETSI_NAPT ITU_IPNAPT EVPND
H323
EISUP
ITP
M3UA SUA
LTMD
LI
LS1010
MGCP SGCP
MC3810
MGCP IPFAS
MGC
EISUP
MGX8260
MGCP IPFAS NAS
MGX8850
MGCP SGCP IPFAS
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-26
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
FILES—File Importing or Exporting
RACLUSTER
SCP
SLT
TALISS7
UNKNOWN
VISM
VXSM
*/
;
Example:
RA
TCAPIP
BSMV0
SS7SG
UNKNOWN
MGCP SGCP IPFAS
MGCP SGCP IPFAS IUA H248 MGCPANNO M3UA IPANNO IPTONE CODEC DTMF UDP SCTP
The MML command shown in the following example displays the external nodes:
mml> PROV-RTRV:extnodetypes
Comments:
The prov-rtrv:extnodetypes command is a special retrieve command that is used in the same MML help
session as other special retrieve commands such as:
•
prov-rtrv:session—Retrieves provisioning session information.
•
prov-rtrv:variants—Retrieves all variants.
•
prov-rtrv:profiletypes—Retrieves all profile types.
FILES—File Importing or Exporting
Purpose:
Import or export a file. The following .dat files are affected:
•
files.dat
•
trunkGroup.dat
•
bearerChan.dat
•
bearerChanSwithced.dat,
•
dialplan.dat
•
<custGrpId>.dialPlan (<custGrpId> = customer group ID)
Database can also be affected by the files component.
Syntax:
prov-add:files:name="File Type",type="File Name",action="Action on the File"
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-27
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
FILES—File Importing or Exporting
Input
Description:
•
name—File type.
– bcfile = bearer channel file
– tkgfile = trunk group file
– awhitefile = A-number white list file
– bwhitefile = B-number white list file
– ablackfile = A-number black list file
– bblackfile = B-number black list file
– portnumfile = ported number file
– numanfile = dial plan file
– achgoriginfile = A-number charge origin file
– anumdpselfile = A-number dial plan selection file
– announcementfile = announcement file
– scriptfile = script file
– cliprefixfile = calling line identity (CLI) prefix file
– ipaddrfile = IP address file
– h323idfile = H.323 ID file
– fullnumtransfile = full number translation file
– taglistfile = tag list file
– tagvaluefile = tag value file
– desttransfile = destination translation file
– routeselectionfile = route selection file
Output
Description:
Example:
•
file—File name. The file should be present in the etc/cust_specific directory.
•
action—Action on the file, import or export. Importing a file is converting customer files into .dat files.
Exporting a file is converting .dat files into customer files.
•
COMPLD—Provision succeeds.
•
DENY— Provision fails.
mml> prov-add:files:name="bcfile",file="trunkCust.dat",action="import"
MGC-01 - Media Gateway Controller 2008-03-04 10:47:38.222 EST
M COMPLD
"files:WARNING: All existing trunk groups have been replaced with the ones in the imported
file.
All existing bearer channels have been deleted. Please import bearer channels associated with
new trunk groups."
;
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-28
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
GTDPARAM—Generic Transparency Descriptor (GTD) Parameters
GTDPARAM—Generic Transparency Descriptor (GTD)
Parameters
Purpose:
Provision the GTD parameters.
Syntax:
prov-add:gtdparam:name="MML Name",gtdparamstring="GTD Parameter String",
overridestring="OverrideString"
prov-dlt:gtdparam:name="MML Name"
prov-ed:gtdparam:name="MML Name",gtdparamstring="GTD Parameter String",
overridestring="OverrideString"
prov-rtrv:gtdparam:name="MML Name"
prov-rtrv:gtdparam:"all"
Input
Description:
•
name—The name you want to give to the component. The name can be as many as 20 characters long
and can contain numbers, letters, and the dash (-) symbol. The name should begin with a letter.
•
gtdparamstring—A string of parameters that defines the ISUP messages and parameters that are
transparently transported by the Cisco PGW 2200 Softswitch. The maximum length of the string is 460
characters. The valid values are as follows:
– ALL
– Individual ISUP parameter codes (a complete list of valid ISUP parameter codes can be found in
Table 1-2).
Output
Description:
Example:
•
overridestring—GTD override fields string. The maximum length of the string is 256 characters.
•
COMPLD—Provision succeeds.
•
DENY— Provision fails.
mml> prov-add:gtdparam:name="ISUP",gtdparamstring="All"
MGC-01 - Media Gateway Controller 2008-03-04 10:47:38.222 EST
M COMPLD
"gtdparam"
;
Table 1-2 lists the GTD parameters in alphabetical order.
Table 1-2
GTD Parameters
GTD Parameter
GTD Parameter Description
ACL
Automatic Congestion Level
ADI
Access Delivery Information
APP
Application Transport
ATP
Access Transport
BCI
Backward Call Indicators
BSG
Business Group
BVN
Backward GVNS
CAI
Cause Indicators
CCN
CCNR Possible Indicator
CCS
Call Completion Service Setup
CDI
Call Diversion Information
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-29
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
GTDPARAM—Generic Transparency Descriptor (GTD) Parameters
Table 1-2
GTD Parameters (continued)
GTD Parameter
GTD Parameter Description
CDN
Called Directory Number
CDT
Call Diversion Treatment Indicators
CGL
Calling Geodetic Location
CGN
Calling Party Number
CHI
Call History Information
CHN
Charge Number
CIC
Circuit Identification (Call Instance) Code
CID
Carrier Identification
CIN
Called IN Number
CMI
Call Modification Indicators
CNF
Conference Treatment Indicator
CNN
Connected Number
CNR
Connection Request
COL
Collect Call Request
COR
Correlation Identity
CPC
Calling Party Category
CPN
Called Party Number
CRF
Call Reference
CSI
Carrier Selection Information
CSP
Carrier Service Provider Information
CTI
Continuity Indicators
CTN
Call Transfer Number
CTR
Call Transfer Reference
DIS
Display Information
ECI
Echo Control Information
EGR
Egress
EVI
Event Information Indicators
FAI
Facility Indicators
FCI
Forward Call Indicators
FDC
Known Field Compatibility Information
FVN
Forward GVNS
GCI
Global Call Identification
GEA
Generic Address
GED
Generic Digits
GEN
Generic Name
GIC
Closed User Group Interlock Code
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-30
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
GTDPARAM—Generic Transparency Descriptor (GTD) Parameters
Table 1-2
GTD Parameters (continued)
GTD Parameter
GTD Parameter Description
GNO
Generic Notification
GRF
Generic Reference
HOC
Hop Counter
HTR
Hard To Reach
INI
Information Indicators
IRI
Information Request Indicators
ISC
Originating ISC point Code
JUR
Jurisdiction
LON
Location Number
LPI
Loop Prevention Indicator
LSP
Local Service Provider Information
MCI
Message Compatibility Information
MCR
MCID Response indicator
MLP
MLPP precedence
MRI
MCID Request Indicator
NET
Network Transport
NMC
Network Management Controls
NOC
Nature of Connection Indicators
NPF
Number Portability Forward Information
NRN
Network Routing Number
NSF
Network Specific Facilities
OBI
Optional Backward Call Indicators
OCI
Original Called IN Number
OCN
Original Called Number
OCT
Call Offering Treatment Indicators
OFI
Optional Forward Call Indicators
OLI
Originating Line Information
OSI
Operator Services Information
OTN
Outgoing Trunk Group Number
PBI
Pivot Backward Information
PCA
Pivot Capability
PCI
Parameter Compatibility Information
PCT
Pivot Counter
PDC
Propagation Delay Counter
PFI
Pivot Forward Information
PRI
Pivot Routing Indicator
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-31
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
GTDPARAM—Generic Transparency Descriptor (GTD) Parameters
Table 1-2
GTD Parameters (continued)
GTD Parameter
GTD Parameter Description
PRN
Protocol Name
PVS
Pivot Status
QOR
Query On Release Capability
RBI
Redirect Backward Information
RCT
Redirect Counter
RDC
Redirect Capability
RDS
Redirect Status
RFI
Redirect Forward Information
RGN
Redirecting Number
RMO
Remote Operations
RNI
Redirection Information
RNN
Redirection Number
RNR
Redirection Number Restriction
SCF
SCF ID
SCI
Service Code Indicator
SEA
Service Activation
SEG
Segmentation Indicator
SPC
Signaling Point Code
SPR
Special Processing Request
SRI
Suspend/Resume Indicators
SUN
Subsequent Number
TID
Transaction ID
TMP
Transmission Medium Required Prime
TMR
Transmission Medium Required
TMU
Transmission Medium Used
TNS
Transit Network Selection
TRR
Transaction Request
UCI
UID Capability Indicators
UFC
Unknown Field Compatibility Information
UID
UID Indicators
USI
User Service Information
USP
User Service Information Prime
UTI
User Teleservice Information
UUI
User-To-User Indicators
UUS
User-To-User Information
VER
Version of GTD
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-32
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
GWPOOL—Gateway Pool (Release 9.8(1))
GWPOOL—Gateway Pool (Release 9.8(1))
Purpose:
Adds a gateway pool in the Cisco PGW 2200 Softswitch.
Syntax:
prov-add:GWPOOL:NAME=”gatewaypoolid”,DESC=”description”,PROFILE=”gateway pool profile”
Input
Description:
Example:
Comments:
•
NAME—Gateway pool ID, which is an integer in the range 1–9999. The values 2–100 are reserved for
future use.
•
DESC—Gateway pool description, this description can be up to 128 characters long.
•
PROFILE—MML name of a previously configured gateway pool.
prov-add:GWPOOL:NAME=”101”, DESC=”DBE gateway pool”, PROFILE=”GWPool_profile1”
•
Gateway pool ID 1 identifies the global default VXSM gateway pool.
•
Customer can use the MML command prov-ed to change the gateway pool profile. In this case, the new
gateway pool profile is checked against all gateways in this gateway pool. Also, you can use the
command prov-ed to change the gateway pool description.
•
prov-dlt:GWPOOL. The associated board gateways are disassociated with this gateway pool first.
H248PATH—H.248 Signaling Protocol Service
Purpose:
Provisions the H.248 signaling protocol service. The parameters are stored in sigPath.dat, which contains
the EXTNODE compID.
Syntax:
prov-add:H248PATH:NAME=”path name”, DESC=”H248 path description”, EXTNODE=”external node”,
LABEL=”loclbl1”
Note
Input
Description:
•
The parameter “LABEL“ is added in software Release 9.8(1).
NAME—MML name of a H.248 path. This name can be up to 20 alphanumeric characters in length.
– Special characters allowed are quotes (“).
– The name must start with an alphabetic character.
Example:
•
DESC—H.248 path description. This description can be up to 128 characters in length.
•
EXTNODE—MML name of a previously configured external node.
•
LABEL—Call limiting label for this gateway. The parameter “LABEL“ is added in software Release
9.8(1).
The MML command shown in the following example provisions the sigpath h249-sigpath-01 for the
EXTNODE h248-VXSM-01:
mml> prov-add:H248PATH:NAME=”h248-sigpath-01”, DESC=”Service to H248”, EXTNODE=”h248-VXSM-01”
mml> prov-add:H248PATH:NAME=”h248-sigpath-01”, DESC=”Service to H248”,EXTNODE=”h248-VXSM-01”,
LABEL=”loclbl1”
Comments:
Performance Impact Category: A
•
LABEL is used only to control the simultaneous contexts on a gateway. The same label cannot be used
elsewhere on a sigPath/trunk group/dialplan.
•
Only the IP-IP context is counted for this label. Provision LABEL only for DBE.
Note
Because a VXSM can be used simultaneously as a TDM gateway, never add LABEL for a VXSM
gateway.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-33
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
HOLIDAY—Charge Holiday
HOLIDAY—Charge Holiday
Purpose:
Provision the Charge Holiday List.
Syntax:
prov-add:holiday:date=”date",hday="hday"
prov-dlt:holiday:date=”date"
prov-ed:holiday:date=”date",hday="hday"
prov-rtrv:holiday:date=”date"
prov-rtrv:holiday:”all”
Input
Description:
•
date—The date of holiday, in the form at YYYY.MM.DD.
•
hday—The holiday value. Valid values: HOL1, HOL2, and HOL3.
Output
Description:
•
COMPLD—Provision succeeds.
•
DENY— Provision fails.
Example:
The MML command shown in the following example inserts a holiday date into the Charge Holiday list and
designates it as a "hol1," "hol2," or "hol3":
mml> prov-add:holiday:date="2001.12.25",hday="hol1"
The MML command shown in the following example deletes the existing holiday date (2001.12.31) from
the Charge Holiday list:
mml> prov-dlt:holiday:date="2001.12.31"
The MML command shown in the following example changes the holiday date (2001.12.25) from "hol1" to
a "hol2":
mml> prov-ed:holiday:date="2001.12.25",hday="hol2"
The MML command shown in the following example retrieves the existing holiday date (2001.12.31) from
the Charge Holiday list:
mml> prov-rtrv:holiday:date="2001.12.31"
The MML command shown in the following example retrieves all existing holiday dates from the Charge
Holiday list:
mml> prov-rtrv:holiday:"all"
INSERVICE—Intelligent Network Service
Purpose:
Provisions intelligent network service information.
Syntax:
prov-add:inservice:name=”name”, skortcv=value, gtorssn=”routebygt|routebyssn”,
gtformat=”nogt|gtttnbrenc|gttt|gtonly|unknown|”, msname=”generic_lnp”
prov-dlt:inservice:name=”name”
prov-ed:inservice:name=”name”,skortcv=value,gtorssn=”title or number”, gtformat=”format”,
msname=”name”
prov-rtrv:inservice:<name=”file name”>|<“all”>
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-34
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
INSIPHEADER—Inbound SIP Header (Release 9.8(1))
Input
Description:
•
name—Name of the intelligent network service. Enter an alphanumeric string up to 20 characters in
length.
•
skortcv—Service key. Range is 0 to 65535. Default is 0.
•
gtorssn—Global title or subsystem number. Enter one of the following:
– routebygt—Routes by global title.
– routebyssn—Routes by subsystem number. With this value, GTFORMAT must be NOGT.
•
gtformat—Global title format. Enter one of the following:
– nogt—No global title. Enter this value when routing by subsystem number. This value must be NOGT
if the GTORSSN parameter is ROUTEBYSSN.
– gtttnbrenc—Uses the global title translation type numbering encoding scheme.
– gttt—Uses the global title translation type.
– gtonly—Uses the global title only.
– unknown—Unknown.
•
msname—Message sending name. Enter an alphanumeric string up to 20 characters in length.
– This name must already exist in the MessageSendingName table in trigger.dat.
– Each MSNAME can only have one entry in the intelligent network service table.
•
Example:
All—All intelligent network services.
mml> prov-add:inservice:name=”serviceone”,skortcv=37,gtorssn=”routebygt”, gtformat=”gttt”,
msname=”generic_lnp”
mml> prov-dlt:inservice:name=”serviceone”
mml> prov-ed:inservice:name=”serviceone”,skortcv=255
mml> prov-rtrv:inservice:”all”
MGC-01 - Media Gateway Controller 2003-01-01 18:57:26
M RTRV
NAME
SKORTCV
GTORSSN
GTFORMAT
MSNAME
ansi-aix-800-npa
4
ROUTEBYGT
GTTT
ansi-aix-800-npa
ansi-aim-800-npa-nxxx 5
ROUTEBYGT
GTTT ansi-aim-800-npa-nxxx
cs1-inap-cli-initdp
1
ROUTEBYSSN
NOGT
cs1-inap-cli-initdp
inap-freephon-initdpp 0
ROUTEBYSSN
NOGT inap-freephon-initdpp
INSIPHEADER—Inbound SIP Header (Release 9.8(1))
Purpose:
Syntax:
Adds an inbound SIP header table.
prov-add:insipheader: name="Header Table Name", header=”Header Name”, message="Message Name",
index=”Index”, cond=”Condition”, cdw1=”Condition Word 1”, cdw2=”Condition Word 2”,
cdw3=”Condition Word 3”, cdw4=”Condition Word 4”, treat=”treatment”, tdw1=”treatment word 1”,
tdw2=”treatment word 2”, tdw3=”treatment word 3”, tdw4=”treatment word 4”
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-35
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
IPFASPATH—IPFAS Transport Service
Input
Description:
•
name—Name of the SIP header table.
•
header—Name of a SIP header that the PGW uses to modify traffic.
•
message name—Name of the SIP message that triggers a customized action. The value must be the name
of a SIP request or response message.
•
index—Order in which the PGW applies SIP header table entries. If a SIP header matches more than
one entry in the SIP Header Table, the PGW applies the entry with the lowest index value.
•
cond—Defines how the PGW uses the SIP header table entry to analyze traffic. This field requires one
or more entries in the Condition DW fields.
•
cdw1–4—Tags the PGW uses to analyze SIP traffic.
•
treat—Action that the PGW takes when the SIP header is present.
•
tdw1–4—Data words that describe how the PGW applies the treatment settings.
Note
Output
Description:
For more information about applying inbound SIP headers, see SIP Profiles feature module.
•
COMPLD—Provision succeeds.
•
DENY— Provision fails.
Example:
mml> prov-add:insipheader:name="insipht1",message="INVITE",cond=2,treat=1, cdw1="user=phone",
header="User-Agent"
MGC-01 - Media Gateway Controller 2008-03-04 10:47:38.222 EST
M COMPLD
''insipheader''
;
Comments:
Performance impact category C applies to the commands used to create, delete, and edit inbound SIP header
tables.
IPFASPATH—IPFAS Transport Service
Purpose:
Provision the FAS over IP transport service or signaling path from a media gateway to a
Cisco PGW 2200 Softswitch.
Syntax:
prov-add:ipfaspath:name=”name",desc="description",extnode=”External Node Name”,
mdo=”Protocal Variant",custgrpid=”Cusomer Group ID",side=”call model side",
abflag=”DPNSS side",crlen=”Call Reference Length",origlabel=”Origination Location
Label",termlabel=”Termination Location Label"
prov-dlt:ipfaspath:name=”name"
prov-ed:ipfaspath:name=”name",desc="description",mdo=”Protocal Variant",
custgrpid=”Cusomer Group ID",side=”call model side",abflag=”DPNSS side",
crlen=”Call Reference Length",origlabel=”Origination Location Label",
termlabel=”Termination Location Label"
prov-rtrv:ipfaspath:name=”name"
prov-rtrv:ipfaspath:"all"
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-36
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
IPGW—IP Gateway (Release 9.8(1))
Input
Description:
•
name—Unique component name used in MML commands. The name can be up to 20 alphanumeric
characters. No special characters other than hyphen are allowed. The name should begin with an
alphabetic character.
•
desc—Description. The description can be up to 128 alphanumeric characters. No special characters
other than hyphen are allowed. The name should begin with an alphabetic character.
•
extnode—External node name. MML name of a previously defined external node or index of the
external node for SNMP.
•
mdo—MDO file name. Valid protocol name from variants.dat.
•
custgrpid—Customer group ID. Four digit ID; (0000).
•
side—Q.931 call model side. User for user side and network for network side; (network).
•
abflag—DPNSS side. a or b side, n for not applicable; (n).
•
crlen—Call reference length. 1 for 1 byte or 2 for 2 byte call reference length; (0).
•
origlabel—Originating call control (OCC) side location label. Used for Call Limiting feature.
•
termlabel—Terminating call control (TCC) side location label. Used for Call Limiting feature.
Note
Output
Description:
Example:
The parameters, origlabel and termlabel, are added in software Release 9.6(1).
•
COMPLD—Provision succeeds.
•
DENY— Provision fails.
The MML command shown in the following example adds an IPFAS transport service to the media gateway
configuration:
mml> prov-add:ipfaspath:name="ipfassvc1",extnode="nas1",desc="PRI Backhaul Service to NAS1",
mdo="ETSI_300_172",custgrpid="1111",abflag="a",crlen=1
IPGW—IP Gateway (Release 9.8(1))
Purpose:
Add a border gateway to a gateway pool.
Syntax:
prov-add:IPGW:POOLID=”gateway pool id”,GW=”external node”,VRF=”VRF name”
Input
Description:
Example:
Comments:
•
POOLID—Gateway pool ID, which is an integer in the range of 1–9999.
•
GW—MML name of previously configured gateway.
•
VRF—VRF name. This description can be up to 30 characters long.
mml> prov-add: IPGW:POOLID=”100", GW=”dbe-01”, VRF=”sip_in_100”
•
For a VXSM gateway, never provision the VRF field.
•
The parameters are stored in the data file gwPools.dat, which contains the EXTNODE compID.
•
To add a gateway to the global default VXSM gateway pool, enter DEFAULT in the POOLID field.
•
Use the MML command prov-dlt:IPGW to remove a border gateway from the gateway pool. If a
gateway is going to be removed, it should be removed from each gateway pool first.
•
To change the VRF field use the MML command prov-ed:IPGW.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-37
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
IPINMAPPING—IP In Trunk Mapping
IPINMAPPING—IP In Trunk Mapping
Purpose:
Provision mapping between a single SIP or EISUP interface and multiple IP trunk groups using incoming
IP address, subnet mask, and port number.
Syntax:
prov-add:ipinmapping:name=”name",desc="description",sigsvc=”SIP/EISUP sigpath",
allowedIP="Allowed IP Address",allowedIPNetMask="Allowed Net Mask",
sipport=”Allowed SIP Port”,trnkgrpnum=”Trunk Group Number”
prov-dlt:ipinmapping:name=”name"
prov-ed:ipinmapping:name=”name",desc="description",allowedIP="Allowed IP Address",
allowedIPNetMask="Allowed Net Mask",sipport=”Allowed SIP Port”,
trnkgrpnum=”Trunk Group Number”
prov-rtrv:ipinmapping:name=”name"
prov-rtrv:ipinmapping:”all"
Input
Description:
Output
Description:
Example:
•
name—A unique name used to describe the ipinmapping rule entry.
•
desc—Description.
•
sigsvc—SIP sigpath or EISUP sigpath. The signal path to which the ipinmapping rule applies.
•
allowedIP—Allowed IP Address. The incoming SIP IP address allowed on the trunk. This parameter is
optional.
•
allowedIPNetMask—Allowed Net Mask. The subnet mask allowed on the trunk. This parameter is
optional. If this parameter is blank, the Cisco PGW 2200 Softswitch uses the default subnet mask value
of 255.255.255.255.
•
sipport—Allowed SIP Port. The SIP TCP or UDP port number allowed on the trunk. This parameter is
for SIP sigpaths only. The sipport parameter is optional.
•
Trnkgrpnum—Trunk group number.
•
COMPLD—Provision succeeds.
•
DENY— Provision fails.
The MML command shown in the following example maps IP traffic to a trunk group:
mml> Prov-add:ipinmapping:name="sipinmapping-1",sigsvc="sippath-1", allowedIP="10.0.14.145",
sipport=5063, trnkgrpNum=1000
The MML command shown in the following example maps Multiple IP ranges to a single trunk group:
mml> prov-add:ipinmapping:name="sipinmapping-1",sigsvc="sippath-1", allowedIP="10.0.14.145",
allowedIPNetmask="255.255.255.128", trnkgrpNum=1040
IPLNK—IP Link
Purpose:
Provisions an IP link used by the Cisco PGW 2200 Softswitch to communicate with an access control device.
Syntax:
prov-add:iplnk:name=”association name“,desc=“description“,port=number,pri=priority,
peeraddr=“remote IP address“,peerport=remote port,ipaddr=“local address“,svc=“sig service“,
iproute=“IP route“
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-38
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
IPROUTE—Static IP Route
Input
Description:
•
name—Association name. Alphanumeric string up to 20 characters in length.
•
desc—IP link description. String up to 128 characters in length.
•
port— Local port number. IP port number. Range: 1 to 1024.
•
pri—Priority. Integer greater than 0. Default is 1.
•
peeraddr—Remote IP address; the default is 0.0.0.0. This can be specified as a hostname or as a DNS
name.
•
peerport—Remote port number. Enter a valid IP port number in the range 1025 to 65535. Enter 2427 for
MGCP.
•
ipaddr—Local logical IP address.
•
svc—Signaling service that this IP link supports. Enter the MML name of a previously defined signaling
service:
– NASPATH
– EISUPPATH
– MGCPPATH
– H248PATH (Added in Release 9.7(3))
•
Example:
iproute—MML name of a previously defined IP route.
The MML command shown in the following example provisions an IP link:
mml> prov-add:iplnk:name="nas1-lnk1",ipaddr="IP_Addr1",port=3001,peeraddr="10.82.80.29",
peerport=3001,pri=1,iproute="iprte1",svc="nassvc1"
The MML command shown in the following example configures the H.248 transport protocol as UDP:
mml> prov-add:IPLNK:NAME="h248-udp1",DESC="link 1 to VXSM-01",SVC=" h248-sigpath-01",
IPADDR="IP_Addr1",PORT=2944,PEERADDR="10.82.81.194", PEERPORT=2944,PRI=1
Comments:
Performance Impact Category: A
The support of provisioning H.248 Transport Protocol as UDP was added in Release 9.7(3). There is a new
parameter SVC that refers to H248PATH. This property uses sigChanDevIp.dat and sigChanDev.dat. The
sessionset type in sigChanDevIp.dat could be used to indicate H248_UDP.
IPROUTE—Static IP Route
Purpose:
Provisions a static IP route.
Syntax:
prov-add:iproute:name=”IP route name“,desc=”IP route description”,dest="IP address",
netmask="IP address",nexthop="IP address", ipaddr="local IP address",pri="priority"
prov-dlt:iproute:name=”IP route name“
prov-ed:iproute:name=”IP route name“,desc=”IP route description”,dest="IP address",
netmask="IP address",nexthop="IP address", ipaddr="local IP address",pri="priority"
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-39
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
IPROUTE—Static IP Route
Input
Description:
•
Name—IP route name. Alphanumeric string up to 20 characters in length.
•
Desc—Description of IP route. String up to 128 characters in length.
•
Dest—IP address or hostname of destination. IP address in decimal dot notation or a hostname that is up
to 32 characters in length.
•
Netmask—(Optional) Subnet mask of destination. IP address in decimal dot notation; the default is
255.255.255.255.
•
Nexthop—IP address of next hop router or one of the following property names defined in the
XECfgParm.dat file:
– IP_NextHop
– IP_NextHop2
– IP_NextHop3
– IP_NextHop4
– IP_NextHop5
– IP_NextHop6
– IP_NextHop7
– IP_NextHop8
– IP_Addr1
– IP_Addr2
– IP_Addr3
– IP_Addr4
The IP Address should be in decimal dot notation and the hostname must be less than or equal to 32
characters.
•
IPAddr—Local IP address represented by one of the following property names defined in the
XECfgParm.dat file:
– IP_Addr1
– IP_Addr2
– IP_Addr3
– IP_Addr4
•
Example:
Pri—Priority. Integer in the range 1 to 65535; the default is 1.
The MML command shown in the following example provisions a static IP route:
mml> prov-add:iproute:name="iprte1",desc="IP Route 1",dest="10.82.80.0",
netmask="255.255.255.0",nexthop="10.82.82.1", ipaddr="IP_Addr1",
The MML command shown in the following example deletes a static IP route:
mml> prov-dlt:iproute:name="iprte1"
The MML command shown in the following example edits a static IP route:
mml> prov-ed:iproute:name="iprte1",dest="10.82.80.0",netmask="255.255.255.0",
nexthop="10.82.82.1", ipaddr="IP_Addr1",desc="IP Route 1"
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-40
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
LINEXLATE—Line Translation
LINEXLATE—Line Translation
Purpose:
Add, delete, or, edit—Add, delete, or edit the linexlate.dat file.
Retrieve—Retrieves one or all NOA translate table entries.
Syntax:
Input
Description:
prov-add:linexlate:name=”file name”,desc=”file description”,svc=”signal path”,
parameter=”value”,direction=”value”,number=”value”,intnoa=value,extnoa=value
prov-dlt:linexlate:name=”file name”
prov-ed:linexlate:name=”file name”,desc=”file description”
prov-rtrv:linexlate:name=”file name”|”all”
•
Name—Name of the file. Alphanumeric string up to 20 characters in length.
•
Desc—Description of the file. This parameter can be up to 128 characters in length.
•
SVC—MML name of a previously defined signal service.
•
Parameter—Parameter or field in the protocol message. 1 for Nature of Address (NOA).
•
Direction—Direction of the message in relation to the PGW.
– IN for messages entering the PGW.
– OUT for messages leaving the PGW.
•
Number—Represents a string in the protocol message.
– called
– calling
– original called
– redirecting
– redirection
– generic
•
Intnoa—Any valid internal call context NOA value in the range 0 to 127.
•
Extnoa—The external value of the NOA in the range 0 to 127.
•
All—All NOA table entries.
Example:
mml> prov-add:linexlate:name=”noa1”,desc=”noa in calling 10”, svc=”ss7svc1”,parameter=”1”,
direction=”in”,number=”calling”,intnoa=17,extnoa=10
mml> prov-dlt:linexlate:name=”noa1”
mml> prov-ed:linexlate:name=”noa1”,desc=”noa in calling 10”
mml> prov-rtrv:linexlate:name=”all”
Name ExtNum SvcName Parameter Direction Number IntNum
noa1 10 ss7svc1 NOA IN Called 17
noa2 11 ss7svc2 NOA OUT Called 17
noa3 8 ss7svc1 NOA IN Calling 29
Comments:
For a list of internal call context NOA values, see Appendix A of Cisco PGW 2200 Softswitch Release 9.8
Provisioning Guide.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-41
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
LIPATH—Lawful Intercept Signaling Service
LIPATH—Lawful Intercept Signaling Service
Purpose:
Provision the LI signaling service.
Syntax:
prov-add:lipath:name=”Name",desc="description",extnode=”External Node Name”
prov-dlt:lipath:name=”Name"
prov-ed:lipath:name=”Name",desc="description"
prov-rtrv:lipath:name=”Name"
prov-rtrv:lipath:”all"
Input
Description:
Output
Description:
Example:
•
name—Unique ID of this component and component name used in MML commands.
•
desc—Component description.
•
extnode—The name of a previously defined external node.
•
COMPLD—Provision succeeds.
•
DENY— Provision fails.
mml> prov-add:LIPATH:NAME="SigPath_Name", DESC="description", EXTNODE="LI_node_name"
LNKSET—Link Set
Purpose:
Provision a link set.
Syntax:
prov-add:lnkset:name="Link Set Name",desc="Description",apc="Adjacent Point Code Name",
proto="Protocol Family Name", type="Link Set Type"
prov-dlt:lnkset:name="Link Set Name"
prov-ed:lnkset:name="Link Set Name",desc="Description",proto="Protocol Family Name",
type="Link Set Type"
prov-rtrv:lnkset:name="Link Set Name"
prov-rtrv:lnkset:"all"
Input
Description:
•
name—MML name of the link set. Up to 10 alphanumeric characters with an alpha character at the
beginning.
•
desc—The description of the linkset. Up to 128 alphanumeric characters.
•
apc—Identifies the adjacent point codes components for the SS7 node providing the linkset.
•
proto—Identifies the protocol family associated with this linkset. (Default = SS7-ANSI.)
•
type—Identifies how the signaling link is terminating on the Cisco PGW 2200 Softswitch.
– TDM
– IP
Output
Description:
Example:
•
COMPLD—Provision succeeds.
•
DENY— Provision fails.
mml> prov-add:lnkset:name="ls1",desc="Link Set to apc1",apc="apc1",proto="SS7-China",
type="TDM"
MGC-01 - Media Gateway Controller 2009-11-25 10:47:38.222 EST
M COMPLD
"lnkset"
;
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-42
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
LNKSETPROP—Linkset Properties
LNKSETPROP—Linkset Properties
Purpose:
Provisions linkset properties.
Syntax:
prov-add:lnksetprop:name=”name“,layerRetries=”retries“,layerTimer=”time“,sendAfterRestart=”mess
ages“,slsTimer=”time“,sstTimer=”time“,dialogRange=”range“,standard=”version“
prov-dlt:lnksetprop:name=”<protocol family>”
prov-rtrv:lnksetprop:name=”<protocol family>”
Input
Description:
Example:
•
Name—Protocol family name.
•
layerRetries—Number of times to resend request to adjacent layer without getting a response.
•
layerTimer—Time (in tenths of a second) to wait for a response from adjacent layer.
•
sendAfterRestart—Number of queued messages to send (in one group) to MTP3 after restart end.
•
slsTimer— Time (in tenths of a second) to maintain the same signal linkset in class 1 (connectionless)
messages.
•
sstTimer—Time (in tenths of a second) between the sending of consecutive Subsystem StatusTest (SST)
messages to an unavailable remote subsystem.
•
dialogRange—TCAP transaction ID range.
•
Standard—Version of protocol standard supported.
The MML command shown in the following example provisions linkset properties:
mml> prov-add:lnksetprop:name="SS7-ITU",layerRetries="6",layerTimer="6",
sendAfterRestart="6",slsTimer="6",sstTimer="302",dialogRange="2",standard="ITU90"
The MML command shown in the following example displays information about linkset properties:
mml> prov-rtrv:LNKSETPROP:name="ss7-itu"
MGC-01 - Media Gateway Controller 2002-04-19 16:12:54.469 EST
M RTRV
"session=Mist915-S10P15-22MAR02:LNKSETPROP"
/*
mtp2AermEmgThr = 1
mtp2AermNrmThr = 4
mtp2CongDiscard = false
mtp2LssuLen = 1
mtp2MaxAlignRetries = 5
mtp2MaxMsuFrmLen = 272
mtp2MaxOutsFrames = 127
mtp2ProvingEmgT4 = 6
mtp2ProvingNormalT4 = 23
mtp2SuermThr = 64
mtp2T1 = 450
mtp2T2 = 250
mtp2T3 = 20
mtp2T5 = 1
mtp2T6 = 60
mtp2T7 = 10
;
Note
Comments:
To determine the protocol family associated with a linkset, use the PROV-RTRV:LNKSET:”ALL”
command.
Performance Impact Category: B, C. Impact depends on the size of the current configuration and what
information is retrieved.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-43
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
LOCLABEL—Location Label
LOCLABEL—Location Label
Purpose:
Add, delete, edit, or retrieve the location labels.
Syntax:
prov-add:loclabel:name=”name”, desc=”description”, calllimit=call limit
prov-dlt:loclabel:name=”name”
prov-ed:loclabel:name=”name”, desc=”description”, calllimit=call limit
prov-rtrv:loclabel:name=”name”, desc=”description”, calllimit=call limit
Input
Description:
Example:
•
name—The MML name of the location label being provisioned. The name can be as many as 20
alphanumeric characters. No special characters other than hyphen are allowed. The name should begin
with a letter.
•
desc—An assigned name. It can be as many as 128 alphanumeric characters in length.
•
calllimit—Maximum number of calls allowed on one location label. Range: 0 to 6000. Default is 0.
The MML command shown in the following example adds the location label named loclbl1:
mml> prov-add:loclabel:name="loclbl1",desc="local label 4",calllimit=4567
MGC-01 - Media Gateway Controller 2004-03-22 19:40:47.595 PST M RTRV
"ENGG-01"
;
The MML command shown in the following example adds the location label named loclbl1:
mml> prov-dlt:loclabel:name=”loclbl1”
MGC-01 - Media Gateway Controller 2004-03-22 19:40:47.595 PST M
"ENGG-01"
;
RTRV
The MML command shown in the following example modifies the location label named loclbl1:
mml> prov-ed:loclabel:name="loclbl1",desc="local label 4",calllimit=4567
MGC-01 - Media Gateway Controller 2004-03-22 19:40:47.595 PST M RTRV
"ENGG-01"
;
The MML command shown in the following example displays the location label named loclbl1:
mml> prov-rtrv:loclabel:name="loclbl1",desc="local label 4",calllimit=4567
MGC-01 - Media Gateway Controller 2004-03-22 19:40:47.595 PST M RTRV
"ENGG-01"
;
Comments:
Performance Impact Category: A
M3UAKEY—M3UA Routing Key
Purpose:
Add, delete, or edit an M3UA routing key.
Syntax:
prov-add:m3uakey:name=”key name”,desc=”key description”,opc=”origination”,dpc=”destination”,
routingcontext=value,si=service indicator,networkappearance=value
prov-dlt:m3uakey:name=”key name”
prov-ed:m3uakey:name=”key name”,desc=”key description”
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-44
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
M3UAROUTE—M3UA Route
Input
Description:
•
Name—Name of the M3UA routing key. Alphanumeric string up to 20 characters in length.
•
Desc—Description of the M3UA routing key. This parameter can be up to 128 characters in length.
•
OPC—MML name of a previously defined origination point code.
•
DPC—(Optional) MML name of a previously defined destination point code.
•
RoutingContext—This value must be a unique integer in the range 0 to 4294967295. Two M3UAKEYs or
SUAKEYs cannot have the same routing context value. The default is 0.
•
SI—Service indicator. Enter one of the following:
– ISUP
– TUP
– N/A (default)
This is an optional parameter.
•
Example:
NetworkAppearance—(Optional) This value must be in the range 0 to 32767. The default is 0, which
indicates an invalid network appearance.
mml> prov-add:m3uakey:name=”key1”,desc=”first key”,opc=”opc2”,dpc=”dpc2”,routingcontext=23,
si=ISUP,networkappearance=8387
mml> prov-dlt:m3uakey:name=”key1”
mml> prov-ed:m3uakey:name=”key1”,desc=”first key”
M3UAROUTE—M3UA Route
Purpose:
Add, delete, or edit an M3UA route.
Syntax:
prov-add:m3uaroute:name=”route name”,desc=”route description”,dpc=”destination”,
extnode=”external node”,opc=”origination”,pri=priority
prov-dlt:m3uaroute:name=”route name”
prov-ed:m3uaroute:name=”route name”,<desc=”route description”,><dpc=”destination”,>
<extnode=”external node”,><opc=”origination”,> <pri=priority>
Input
Description:
Example:
•
Name—Name of the M3UA route. Alphanumeric string up to 20 characters in length.
•
Desc—Description of the M3UA route. This parameter can be up to 128 characters in length.
•
DPC—MML name of a previously defined destination point code. The DPC must have an SS7PATH
service with the M3UAKEY defined.
•
Extnode—MML name of a previously defined external node which supports M3UA signaling.
•
OPC—MML name of a previously defined origination point code.
•
PRI—M3UA Route Priority. This parameter is a 1- to 2-integer value: 1 is the default value, 1 is higher
priority, 2 is lower priority.
mml> prov-add:m3uaroute:name=”route1”,desc=”first”,dpc=”dpc1”,extnode=”mgx-8260”,opc=”opc1”,
pri=1
mml> prov-dlt:m3uaroute:name=”route1”
mml> prov-ed:m3uaroute:name=”route1”,desc=”first”,dpc=”dpc1”,extnode=”mgx-8260”,opc=”opc1”,
pri=1
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-45
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
MCLCALLREJECT—Machine Congestion Level Percentage
MCLCALLREJECT—Machine Congestion Level Percentage
Purpose:
Edit or retrieves the machine congestion level call rejection percentage value.
Syntax:
prov-ed:mclcallreject:name=”MCL name”,callreject=”value”
prov-rtrv:mclcallreject:{name=”MCL name”|”all”}
Input
Description:
•
name—One of the following MCL names:
– MCL1
– MCL2
– MCL3
Example:
•
callreject—Percentage of incoming calls to drop because of congestion when local machine congestion
level is MCL1, MCL2, or MCL3.
•
all—All MCL values.
The MML command shown in the following example changes the percentage of calls to reject for this MCL
name:
mml> PROV-ED:mclcallreject:name=”mcl1”,callreject=”25”
The MML command shown in the following example retrieves the percentage of calls rejected for MCL1,
MCL2, and MCL3:
mml> prov-rtrv:mclcallreject:"all"
MGC-01 - Media Gateway Controller 2003-03-06 10:07:22.096 PST
M RTRV
"session=1221:mclcallreject"
/*
Name
CallReject
-------------------- ---------mcl1
25
mcl2
50
mcl3
100
*/
;
Comments:
The Cisco PGW 2200 Softswitch maintains an internal measurement of its own current congestion level
referred to as the machine congestion level (MCL). The mclCallReject.dat file contains a value that defines
the call reject percentage in different MCLs.
The calculation of the current MCL value (in the mclCallReject.dat file) is based on several factors, including
queue lengths, call rate, and CPU utilization.
Note
Because the MCL call reject values are set to system defaults, there are no PROV-ADD or PROV-DLT
versions of this command.
MCLTHRESHOLD—Machine Congestion Level Thresholds
Purpose:
Edit or retrieve the onset and abatement MCL threshold values.
Syntax:
prov-ed:mclthreshold:name=”MCL name”, <mcl1onset=value,mcl1abate=value,>|
<mcl2onset=value,mcl2abate=value,>|<mcl3onset=value,mcl3abate=value>
prov-rtrv:mclthreshold:{name=”threshold factor”|”all”}
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-46
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
MCLTHRESHOLD—Machine Congestion Level Thresholds
Input
Description:
•
name—Existing threshold factor name:
– callrate
– cpu
– memoryaddress
– queuelen
– virtualmemory
Enter an alphanumeric string up to 16 characters in length.
Example:
•
mcl1onset—Exceeding this value causes MCL1 onset because of the specified threshold factor.
•
mcl1abate—Falling below this value causes MCL1 to change to MCL0 because of the specified threshold
factor.
•
mcl2onset—Exceeding this value causes MCL2 onset because of the specified threshold factor.
•
mcl2abate—Falling below this value causes MCL2 to change to MCL1 because of the specified threshold
factor.
•
mcl3onset—Exceeding this value causes MCL3 onset because of the specified threshold factor.
•
mcl3abate—Falling below this value causes MCL3 to change to MCL2 because of the specified threshold
factor.
The MML command shown in the following example changes the onset and abatement thresholds for MCL1
CPU utilization:
mml> PROV-ED:mclthreshold:name=”memoryaddress”,mcl1onset=84,mcl1abate=80,mcl2onset=88,
mcl2abate=82,mcl3onset=93,mcl3abate=85
The MML command shown in the following example retrieves the onset and abatement thresholds for all MCL
factors:
mml> prov-rtrv:mclthreshold:"all"
MGC-01 - Media Gateway Controller 2003-03-06 10:08:46.692 PST
M RTRV
"session=1221:mclthreshold"
/*
Name
Mcl1Onset Mcl1Abate Mcl2Onset Mcl2Abate Mcl3Onset Mcl3Abate
------------- --------- --------- --------- --------- --------- --------callrate
0
0
0
0
0
0
cpu
82
75
90
77
95
85
memoryaddress 84
80
88
82
93
85
queuelen
75
60
80
70
85
75
virtualmemory 80
75
85
80
90
80
*/
;
Comments
The Cisco PGW 2200 Softswitch maintains an internal measurement of its own current congestion level
referred to as the machine congestion level (MCL). The mclThreshold.dat table contains default onset and
abate values of different contributing factors for MCL.
Note
Because the threshold values are set to system defaults, there are no PROV-ADD or PROV-DLT
versions of this command.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-47
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
METERTARIFF—Meter Tariff
METERTARIFF—Meter Tariff
Purpose:
Populates the meterTariff table.
Syntax:
prov-add:meterTariff:tariffid=<0-511>,pulseOnAns=<0-15>,interval=<integer range>,
numPulses=<0-255>,chargeApp=<0/1>,aocInd=<0/1>,MaxCalllen=<0-240>,tariffType=<0-15>
prov-dlt:meterTariff:tariffid=<id>
prov-ed:meterTariff:tariffid=<id>,pulseOnAns=<>,interval=<>,numPulses=<>,chargeApp=<>,aocInd=<>
,MaxCalllen=<>,tariffType=<>
rov-rtrv:metertariff:tariffid=<id>
prov-rtrv:metertariff:”all”
Input
Description:
Example:
•
tariffid—Independently definable integer (0–511).
•
pulseOnAns—Number of pulses on Answer.
•
interval—Interval between consecutive MPMs. The integer range is 500 to 3600000.
•
numPulses—Number of periodic pulses that are sent when the timing interval expires.
•
chargeApp—At timer expiration, the associated pulses are sent, and then the normal periodic interval
timer is initiated.
•
aocInd—Indicates whether the charge data is used by the receiving switch for charging purposes or for
advice of charge. This parameter is used to populate the backward MPM and is not acted upon by the PGW
2200.
•
MaxCalllen—Represents the number of call minutes the call can last.
•
tariffType—Tariff type. Only tariff type 0000 (tariff type not indicated) is used.
mml> prov-add:metertariff:tariffid=1,pulseOnAns=5,
interval=1000,numPulses=5,chargeApp=1,aocInd=1,MaxCalllen=100,tariffType=0
mml> prov-dlt:m3uaroute:name=”route1”
mml> prov-ed:metertariff:traiffid=”1”,pulseOnAns=”5”,interval=”10”,numPulses=”5”,chargeApp=”1”,
aocInd=”1”,MaxCalllen=”100”,tariffType=”0”
mml> prov-rtrv:metertariff:”all”
mml> prov-rtrv:metertariff:tariffid=”1”
MGCPPATH—MGCP Signaling Service
Purpose:
Syntax:
Input
Description:
Example:
Adds an MGCP signaling service or signaling path to a trunking gateway.
prov-add:mgcppath:name=”name”,extnode=”node name”,desc=”description”
•
name–Unique name for this signaling service. Enter up to 20 alphanumeric characters and enclose in
straight quotes. You can use hyphens (-). Begin the name with a letter character.
•
extnode–External node name assigned to the media gateway you are configuring.
•
desc–Description.
The MML command in the following example adds the MGCP signaling link mgcpsrv1 to the cu1 media
gateway configuration:
mml> prov-add:mgcppath:name="mgcpsrv1",extnode="cu1",desc="MGCP Service to CU 1"
Comments:
Use the PROV-RTRV command to verify that the MGCP signaling service was added.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-48
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
MLTIPFAS—Multiple IPFAS Signaling Services
MLTIPFAS—Multiple IPFAS Signaling Services
Purpose:
Provision multiple IPFAS or IPNFAS signaling paths and D-channels to a particular destination using either
ISDN-PRI or DPNSS.
Syntax:
prov-add:mltipfas:name="name",desc="description",extnode=”External Node Name”,
mdo=”Protocal Variant",custgrpid=”Cusomer Group ID",side=”call model side",
pathsize=”Path Size",sessionset=”Session Set Name",sigslot=”Sigslot",sigport=”Sigport",
origlabel=”origlabel”,termlabel=”termlabel”
Input
Description:
•
name—Name used to derive IPFAS or IPNFAS and D-channel MML names.
•
desc—Component description.
•
extnode—External node name. MML name of a previously defined external node or index of the
external node for SNMP.
•
mdo—MDO file name. Valid protocol name from variants.dat. Limited to any MDO variant from either
the ISDNPRI or DPNSS protocol families.
•
custgrpid—Customer group ID. Four digit ID; (0000).
•
side—Q.931 call model side. User for user side and network for network side; (network).
•
pathsize—Number of IPFAS paths.
•
sessionset—Name of a previously configured Session Set.
•
sigslot—Physical slot on the gateway where the T1/E1 is plugged.
•
sigport—Physical port on the gateway on the slot.
•
origlabel—Originating call control (OCC) side location label. Used for Call Limiting feature.
•
termlabel—Terminating call control (TCC) side location label. Used for Call Limiting feature.
Note
Output
Description:
Example:
The parameters, origlabel and termlabel, are added in software Release 9.6(1).
•
COMPLD—Provision succeeds.
•
DENY— Provision fails.
mml> prov-add:MLTIPFAS:NAME="bhsvc1",extnode="bh1",SIDE="user",mdo="ETS_300_102",
custgrpid="2222",pathsize=2,sigslot=1,SIGPORT=0,IPADDR1="IP_Addr1",PORT=7007,
PEERADDR1="17.0.0.11",PEERPORT=7007
MLTTRNKGRP—Multiple Trunk Groups
Purpose:
Provision multiple PRI trunk groups and bearer channels.
Syntax:
prov-add:trnkgrp:name="name",clli="clli",svc="signalling serviece",
numtrnkgrp="number of trunk groups", spansize="span size",cic="cic",cu=”external node name”,
endpoint=”end point”
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-49
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
NAILEDTRNK—Nailed Trunks
Input
Description:
Output
Description:
Example:
•
name—A numeric identifier for the trunk group. An integer from 1 through 9999.
•
clli—Common language location identifier that identifies the trunk group. This can be up to 11
alphanumerical digits.
•
svc—The MML name of the signaling service associated with or controlling the trunk group.
•
numtrnkgrp—Number of trunk groups.
•
spansize—Number of trunks per span.
•
cic—Circuit Identifier Code.
•
cu—MML name of previously defined Coding nit.
•
endpoint—Text description of the trunk endpoint. An endpoint value is typically composed of an
interface, a timeslot, and a domain nam.
•
COMPLD—Provision succeeds.
•
DENY— Provision fails.
mml> prov-add:mlttrnkgrp:name="1000",svc="bsc1",clli="5300E4011",numtrnkgrp=2,spansize=4,
trnkmemnum=1,span=0,cic=1,endpoint="S10/DS1-0/1@mgx-8850,cu="mgx-east"
NAILEDTRNK—Nailed Trunks
Purpose:
Syntax:
Input
Description:
Example:
Adds nailed trunks.
prov-add:nailedtrnk:name="Trunk ID",srcsvc="source service",srctimeslot=source timeslot,
dstsvc="destination service",srcspan=source span,dstspan=destination span,
dsttimeslot=destination timeslot,spansize=Span Size
•
name—Trunk group ID. A numeric identifier for the trunk group. Value range: an integer from 0 through
65535.
•
srcsvc—Used to look up the source service component ID. The MML name of a previously defined
signaling service.
•
srcspan—Corresponds to the source span ID. Value range: an integer from 1 through 65535 or ffff
(default). This value is converted from decimal to hexadecimal, except when the value is ffff.
•
srctimeslot—Corresponds to the source time slot. Value range: an integer from 1 through 65535. This
value is converted from decimal to hexadecimal, except when the value is ffff.
•
dstsvc—Used to look up the destination service component ID. The MML name of a previously defined
signaling service.
•
dstspan—Corresponds to the destination span ID. Value range: an integer from 1 through 65535 or ffff
(default). This value is converted from decimal to hexadecimal, except when the value is ffff.
•
dsttimeslot—Corresponds to the destination time slot. Value range: an integer from 0 through 65535. This
value is converted from decimal to hexadecimal, except when the value is ffff.
•
spansize—Span size. Indicates the number of trunks per span. Value: 1 (default) through 24 for T1, or 1
through 31 for E1.
The MML command in the following example adds a nailed trunk named “101”:
mml> prov-add:nailedtrnk:name="101",srcsvc="ss7svc1",srctimeslot=101,
dstsvc="nassrv1",dstspan=3,dsttimeslot=1
Comments:
Use the PROV-RTRV command to verify that the nailed trunk was added.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-50
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
NASPATH—Signaling Path Between the Cisco PGW 2200 Softswitch and a NAS
NASPATH—Signaling Path Between the
Cisco PGW 2200 Softswitch and a NAS
Purpose:
Provisions a signaling path between the Cisco PGW 2200 Softswitch and a NAS.
Syntax:
prov-add:naspath:name=”naspath name”,desc=”description”,extnode="node",custgrpid=”group id”,
sigslot=slot number,sigport=port number
prov-dlt:naspath:name=”naspath name”
Input
Description:
Example:
•
Name—NASPath name.
•
Desc—Description of the NASPath. This parameter can be up to 128 characters in length.
•
Extnode—MML name of a previously defined external node.
•
Custgrpid—Customer group ID. Enter a four-digit ID; the default is 0000.
•
Sigslot—Physical slot on the NAS defining the NFAS group. Enter an integer in the range 0 to 63; the
default is 0. This is an optional parameter.
•
Sigport— Physical port on the NAS defining the NFAS group. Enter an integer in the range 0 to 167; the
default is 0. This is an optional parameter.
The MML command shown in the following example provisions a NASPath between the
Cisco PGW 2200 Softswitch and an external node:
mml> prov-add:naspath:name="nassvc2",desc=”second path”,extnode="va-5300-37",sigslot=0,
sigport=0
The MML command shown in the following example deletes a naspath between the
Cisco PGW 2200 Softswitch and an external node:
mml> prov-dlt:naspath:name="nassvc2"
OPC—Originating Point Code
Purpose:
Add or delete an OPC.
Syntax:
prov-add:opc:name="name", desc="description", netaddr=”addr”, netind=num, type=”trueopc”
prov-dlt:opc:name="name"
Input
Description:
Example:
•
name—Enter a name for the component. The name can be as many as 20 characters long and can contain
numbers, letters, and the hyphen (-) symbol. The name should begin with a letter.
•
desc—Enter a long name up to 128 alphanumeric characters in length.
•
netaddr—Enter the network address in dot notation.
•
netind—Enter the network indicator number. The default value is 0.
•
type—Set to trueopc to support M3UA and SUA interfaces.
To add an OPC named opc1, enter the following command:
mml> prov-add:opc:NAME="opc1",DESC="originating pc 1",NETADDR="1.2.4",NETIND=2,type=”trueopc”
To delete an OPC named opc1, enter the following command:
mml> prov-dlt:opc:NAME="opc1"
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-51
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
OUTSIPHEADER—Outbound SIP Header (Release 9.8(1))
OUTSIPHEADER—Outbound SIP Header (Release 9.8(1))
Purpose:
Adds an outbound SIP header table.
Syntax:
prov-add:outsipheader:name="Header Table Name",header=”Header Name”,message="Message Name",
policy=”Policy”,index=”Index”,cond=”Condition”,cdw1=”ConditionWord1”,cdw2=”ConditionWord2”,
cdw3=”ConditionWord3”,cdw4=”ConditionWord4”,treat=”treatment”,tdw1=”treatmentword1”,
tdw2=”treatmentword2”,tdw3=”treatmentword3”,tdw4=”treatmentword4”
Input
Description:
•
name—The name of the SIP header table.
•
header—The name of a SIP header that the PGW uses to modify traffic.
•
message name—The name of the SIP message that triggers a customized action. The value must be the
name of a SIP request or response message.
•
policy—Defines the B2BUA mode applied to the call/trunk group.
•
index—Defines the order in which the PGW applies SIP header table entries. If a SIP header matches
more than one entry in the SIP Header table, the PGW applies the entry with the lowest Index value.
•
cond—Defines how the PGW uses the SIP header table entry to analyze traffic. This field requires one
or more entries in the Condition DW fields.
•
cdw1–4—The tags the PGW uses to analyze SIP traffic. You can define up to four tags for each row in
the SIP header table. SIP table header treatments take effect only if a message matches all the Condition
DW fields.
•
treat—The action that the PGW takes when the SIP header is present.
•
tdw1–4—Data words that describe how the PGW applies the treatment settings. For values 2–3 in the
Treatment field, Treatment DW1 defines the response code used to reject the request. For values 4–6 in
the Treatment field, Treatment DW1–4 define the tag the PGW applies. You can apply up to four tags
for each row in the SIP header table.
Note
Output
Description:
For more information about applying inbound SIP headers, see SIP Profiles feature module.
•
COMPLD—Provision succeeds.
•
DENY— Provision fails.
Example:
mml> prov-add:outsipheader:name=''outsipht1'',header=''Diversion'',message=''INVITE'',cond=1,
treat=1,cdw1=''xyf2'',policy=0,index=1
MGC-01 - Media Gateway Controller 2008-03-04 10:51:22.260 EST
M COMPLD
''outsipheader''
;
Comments:
Performance impact category C applies to the commands used to create, delete, and edit outbound SIP
header tables.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-52
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
PERCRTE—Percentage-Based Routing Table
PERCRTE—Percentage-Based Routing Table
Purpose:
Add—Provisions a percentage-based routing table.
Delete—Deletes components or parameters in the percentage-based routing table.
Edit—Edits the percentage-based routing table.
Retrieve—Retrieves either all percentage-based routes or one specific (configured) percentage-based route.
Syntax:
Input
Description:
prov-add:percrte:name=”desctwo”{,rtlistname=”name”|condrtename=”name”}[,ovrflwset=”ON”]
[,primary=”ON”]
prov-dlt:percrte:name=”desctwo”
prov-ed:percrte:name=”desctwo”[,load=”value”][,rtlistname=”name”][,condrtename=”name”]
[,ovrflwset=”ON”][,overflow=”ON”][,primary=”ON”]
prov-rtrv:percrte:{”all”|name=”routename”}
•
name—Percentage-based routing name. Up to 20 alphanumeric characters.
•
load—Enter a value from 0 to 100 (percentage). Either LOAD or OVERFLOW must be specified.
•
rtlistname—Route list name which was previously configured.
A percentage route can have up to five entries for load, and each load has a rtlistname or a condrtename.
You can add more loads (up to five) by using the PROV-ED command.
•
condrtename—Conditional route name (previously configured).
•
ovrflwset—Selects overflow support. Enter ON or OFF; the default is ON.
•
overflow—Overflow entry for the percentage-based routing table.
In a PROV-ED command, this entry specifies the overflow route. Enter OFF or ON; the default is OFF.
Either LOAD or OVERFLOW with a value of ON is supported.
•
primary—Primary entry for the percentage-based routing table. Enter ON or OFF; the default is ON.
In a PROV-ADD command, either do not specify this component or set it to ON.
•
all—Specifies all configured percentage-based routes.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-53
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
PRICHARGE—PRI Charge Table
Example:
The MML command shown in the following example provisions a percentage-based route:
mml> PROV-ADD:percrte:name=”one”,rtlistname=”one”,ovrflwset=”ON”,primary=”ON”
The MML command shown in the following example deletes route list “three” from percentage-based route
“two”:
mml> PROV-DLT:percrte:name=”two”,rtlistname=”three”
The MML command in the following example deletes the entire percentage-based routing table.
mml> PROV-DLT:percrte:name=”two”
The MML commands shown in the following example allocate load among percentage-based routes:
mml> PROV-ED:percrte:name=”one”,rtlistname=”three”,load=25
mml> PROV-ED:percrte:name=”one”,condrtename=”todtwo”,load=25
mml> PROV-ED:percrte:name=”one”,condrtename=”todthree”,overflow=”ON”
The following MML command retrieves all the configured percentage-based routes:
mml> PROV-RTRV:percrte:”all”
The following MML command retrieves percentage-based route “one”:
mml> PROV-RTRV:percrte:name=”one”
Comments:
Entries in the percentage-based route table are stored in ascending order.
PRICHARGE—PRI Charge Table
Purpose:
Add, edit, delete, and retrieve an entry in the PRI Charge table for PRI AOC supplementary services.
Syntax:
prov-add:pricharge:chorig=<1-9999>,chdest=<1-9999>,dow="<monday-sunday, hol1, hol2, hol3>",
stariffdesc="<tariff 1 timeChange 1 - tariff n timeChange n>",
dtariffdesc="<tariff 1 timeChange 1 - tariff n timeChange n>",
etariffdesc="<tariff 1 timeChange 1 - tariff n timeChange n>"
prov-ed:pricharge:chorig=<1-9999>,chdest=<1-9999>,dow="<monday-sunday, hol1, hol2, hol3>",
stariffdesc="<tariff 1 timeChange 1 - tariff n timeChange n>",
dtariffdesc="<tariff 1 timeChange 1 - tariff n timeChange n>",
etariffdesc="<tariff 1 timeChange 1 - tariff n timeChange n>"
prov-dlt:pricharge:chorig=<1-9999>,chdest=<1-9999>,dow="<monday-sunday, hol1, hol2, hol3>"
prov-rtrv:pricharge:chorig=<1-9999>,chdest=<1-9999>,dow="<monday-sunday, hol1, hol2, hol3>"
prov-rtrv:pricharge:“all”
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-54
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
PRICHARGE—PRI Charge Table
Input
Description:
•
Note
If no value is entered for chorig, then the charge origin is assumed to be 0 for any origin that has the
same destination and no other charge origin specified.
•
chdest—The charge destination. Indicates the numeric designation for the charge destination of the call.
Value range: 1 through 9999.
•
dow—The day of week. Indicates the day of week for which the charge applies. Value range: Default,
Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, HOL1, HOL2, or HOL3.
Note
If no value is entered for dow, then the charge is assumed to be 0 for any day of the week where no
other indication is given.
•
stariffdesc—The AOC-S tariff description. The tariff description indicates to the calling private branch
exchange (PBX) or end office of the charge for the call through the network, from the start of the call.
•
dtariffdesc—The AOC-D tariff description. The tariff description indicates to the calling PBX or end
office of the charge for the call through the network, during the call.
•
etariffdesc—The AOC-E tariff description. The tariff description indicates to the calling PBX or end
office of the charge for the call through the network, at the end of the call.
Note
Output
Description:
chorig—The charge origin. Indicates the numeric designation for the charge origin of the call. Value
range: 1 through 9999.
The tariffs to be applied are from the Tariff table with their associated durations. Up to five tariff
changes can be specified per day. The format for the time change field is HHMM, where MM must
be divisible by 15 (that is, 15-minute increments; for example, 2015). The time change value must
be 2400 if the last field is a time change value.
•
COMPLD—Provision succeeds.
•
DENY— Provision fails.
Example:
mml> prov-add:pricharge:chorig=2,chdest=2,dow="HOL1",stariffdesc="1 1815 3 2100 2"
Comments:
The Charge table entry format for the preceding MML command is:
2 2 8 "1 1815 3 2100 2"
This indicates that the Charge Origin is 2; the Charge Destination is 2; the Day of week is HOL1, Tariff ID
1 is applicable until 1815; Tariff ID 3 is applicable until 2100; and Tariff ID 2 is applicable until the end of
the day. A time change does not have to be entered as the last change value, but if it is entered, it must be
2400.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-55
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
PRITARIFF—PRI Tariff Table
PRITARIFF—PRI Tariff Table
Purpose:
Add, edit, delete, and retrieve an entry in the PRI Tariff table for PRI AOC supplementary services.
Syntax:
prov-add:pritariff:tariffid=<range 1-9999>, schargeditem=<AocSChargedItemRange>,
dcallstate=<AocDCallStateRange>,ecallstate=<AocECallStateRange>,sca=<1-10>,
srecchrg=<AocSRecordedChrgRange>,drecchrg=<AocDRecordedChrgRange>,
erecchrg=<AocERecordedChrgRange>,currency=<IA51-10>,amount=<0-16777215>,
amtmult=<AmountMultiplierRange>,timelen=<0-16777215>,timescale=<TimeScaleRange>,
granularity=<0-16777215>,granularityscale=<GranularityTimeScaleRange>,
vol=<VolumeRange>,scu=<1-32767>,billingid=<BillingIdRange>,chargingunits=<0-16777215>,
duration=<0-16777215>,ratetype=<0-1>,initialtariff=<up to 3 tariffs>
prov-ed:pritariff:tariffid=<range 1-9999>, schargeditem=<AocSChargedItemRange>,
dcallstate=<AocDCallStateRange>,ecallstate=<AocECallStateRange>,sca=<1-10>,
srecchrg=<AocSRecordedChrgRange>,drecchrg=<AocDRecordedChrgRange>,
erecchrg=<AocERecordedChrgRange>,currency=<IA51-10>,amount=<0-16777215>,
amtmult=<AmountMultiplierRange>,timelen=<0-16777215>,timescale=<TimeScaleRange>,
granularity=<0-16777215>,granularityscale=<GranularityTimeScaleRange>,
vol=<VolumeRange>,scu=<1-32767>,billingid=<BillingIdRange>,chargingunits=<0-16777215>,
duration=<0-16777215>,ratetype=<0-1>,initialtariff=<up to 3 tariffs>
prov-dlt:pritariff:tariffid=<range 1-9999>
prov-rtrv:pritariff:tariffid=<range 1-9999>|“all”
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-56
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
PRITARIFF—PRI Tariff Table
Input
Description:
•
tariffid—The tariff ID. This is the tariff identifier configured as part of the tariff descriptor. Value range:
1 through 9999.
•
schargeditem—The AOC-S charged item. Indicates the function for which the caller is billed. Value
range: 0 through 4. Where 0 = Basic Communication; 1 = Call Attempt; 2 = Call Setup; 3 = User-to-user
information; 4 = Operation of Supplemental Services.
•
sca—Special Charging Agreement. Indicates the AOC-S special charging arrangement. Value range: 1
through 10. Where the user defines each value.
•
srecchrg—The AOC-S recorded charge. Indicates the AOC-S charge recording configuration. Value
range: 1 through 6. Where 1 = Duration rate; 2 = Flat Rate; 3 = Volume Rate; 4 = Free Of Charge; 5 =
Info Not Available; 6 = Special.
•
drecchrg—The AOC-D recorded charge. Indicates the AOC-D charge recording configuration. Values:
1 through 3. Where: 1 = Charging Unit; 2 = Currency Unit, and 3 = Free Of Charge.
•
erecchrg—The AOC-E recorded charge. Indicates the AOC-E charge recording configuration. Values:
1 through 3. Where: 1 = Charging Unit; 2 = Currency Unit, and 3 = Free Of Charge.
•
currency—The currency used for billing. Indicates the currency name used for billing the call. Value
range: 1 through 10 alphabetical characters.
•
amount—The amount of currency billed. Indicates the amount of the charge in the selected currency.
Value range: 0 through 16777215.
•
amtmult—The amount multiplier. The currency amount multiplier for billing. Value range: 0 through 6.
Where: 0 = 0.001; 1 = 0.01; 2 = 0.1; 3 = 1; 4 = 10; 5 = 100; 6 = 1000.
•
timelen—The time length. The time length is the time duration for the call charge. The scale
representing this time length is determined by the timescale field. Value range: 0 through 16,777,215.
•
timescale—The time scale. Indicates the time units used for billing the call. Value range: 0 through 6.
Where: 0 = 0.01 second; 1 = 0.1 second; 2 = 1 second; 3 = 10 seconds; 4 = 1 minute; 5 = 1 hour; 6 = 24
hours.
•
granularity—The granularity length. Indicates the number of time units (in granularity time scale) for
the call duration. Value range: 0 through 16777215.
•
granularityscale—The granularity time scale. Indicates the time scale granularity used to measure the
call duration. Value range: 0 through 6. Value range: 0 = 0.01 second; 1 = 0.1 second; 2 = 1 second; 3
= 10 seconds; 4 = 1 minute; 5 = 1 hour; 6 = 24 hours.
•
vol—The volume unit. Indicates the unit used for measuring the call. Where: 0 = Octet; 1 = Segment;
2 = Message.
•
scu—The special charging unit. The special charging unit indicates the charging association. Value
range: 0 through 32767.
•
billingid—The ID of the billing type being used. Value range: 0 through 7. Where 0 = Normal; 1 =
Reverse; 2 = Credit Card; 3 = Call Forwarding Unconditional; 4 = Call Forwarding Busy; 5 = Call
Forwarding No Response; 6 = Call Deflection; 7 = Call Transfer.
•
chargingunits—The charging units. The number of charging units for the defined time length. Value
range: 1 through 16777215.
•
duration—The duration. Time period, in milliseconds, this tariff remains in effect. A 0 value indicates
an ongoing tariff (the tariff does not expire after a fixed duration). Value range: 0 through 16777215.
•
ratetype—The rate type. The rate type is either a flat rate (0), or a duration-based rate (1).
•
initialtariff—The initial tariff. A list of up to 3 tariffs that are applied before this tariff is applied.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-57
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
PROFILE—Profile (Release 9.8(1))
Output
Description:
Example:
•
COMPLD—Provision succeeds.
•
DENY— Provision fails.
mml> prov-add:pritariff:tariffid=99,schargeditem=2,sca=1,srecchrg=2, 4zzzdrecchrg=<1-3>,
erecchrg=<1-3>,currency=<IA51-10>,amount=<0-16777215>, amtmult=<0-6>,timelen=<0-16777215>,
timescale=<0-6>,granularity=<0-16777215>,granularityscale=<GranularityTimeScaleRange>,
vol=<0-2>,scu=<0-32767>,billingid=<0-7>,chargingunits=<0-16777215>,duration=<0-16777215>,
ratetype=<0-1>,initialtariff=<up to 3 tariffs>
PROFILE—Profile (Release 9.8(1))
Purpose:
Creates a profile.
Syntax:
prov-add:profile:name=“profile name”,type=“PROFILE TYPE”,variant=”variant“,validation=“ON”,
base=“existing profile”,cat=“Category”,topologyhidingenabled=“enablevalue”,trustlevel=“level”
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-58
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
PROFILE—Profile (Release 9.8(1))
Input
Description:
•
name—Name of the new profile.
•
type—Type of profile you wish to create. The available options are:
– GRPROFILE—Trunk group profile
– ISUPTMRPROFILE—ISUP signal path profile
– SIPPROFILE
– EISUPPROFILE
– DOMAINPROFILE
– COMMONPROFILE
– GWPOOLPROFILE
Note
SIPPROFILE, EISUPPROFILE, DOMAINPROFILE, COMMONPROFILE, AND
GWPOOLPROFILE were added in software Release 9.8(1).
•
Variant—Valid protocol name from the variants.dat file. Variant is needed only for
ISUPTMRPROFILE.
•
validation—Indicates if profile property validation is enabled or disabled. Valid values are ON and OFF.
Note
Validation can be disabled only for ISUP timer profiles.
•
base—The name of an existing profile used to create the new profile. The properties of the existing
profile are copied to the new profile. This parameter was added in software Release 9.8(1).
•
cat—A property category name which is used to filter the provisioning properties. This parameter
allows you to apply a command to a subset of provisioning properties. Valid values are:
– A&R
– Billing
– Media
– Misc
– Number
– SIP
– Timer
•
topologyhidingenabled—Indicates if topology hiding is enabled. Valid values are:
– 0 (based on trustLevel value)
– 1 (disabled)
– 2 (enabled)
•
trustlevel—Defines the trust level assigned to a profile. Valid values are:
– 0 (trusted)
– 1 (nontrusted)
Output
Description:
•
COMPLD—Provision succeeds.
•
DENY— Provision fails.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-59
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
RAPATH—RADIUS Accounting Server Signal Path (Release 9.7(3))
Example:
The MML command shown in the following example provisions ISUP properties T1 and T2 for the
Q767_Singapore protocol variant:
mml> prov-add:profile:name="set1",type="ISUPTMRPROFILE",
variant="Q767_Singapore",T1="5",T2=”7”
The MML command shown in the following example provisions a SIP profile:
mml> prov-add:profile:name=”spf1”, type=”SIPPROFILE”, validation=”ON”, cat=”SIP”,
topologyhidingenabled="2", trustlevel="1"
MGC-01 - Media Gateway Controller 2008-03-04 10:47:38.222 EST
M COMPLD
''profile''
;
The MML command shown in the following example provisions a new gateway pool profile:
mml> prov-add:PROFILE:NAME=”VXSM-Profile1”,TYPE=”GWPOOLPROFILE”, VALIDATION=”ON”,
Cat=”Profile”,GatewayAnnSupport=”1”, GatewayToneSupport=”1”,GatewayDTMFSupport="1",
GatewayCodecSupport=”1”, GatewaySelectionMethod="1"
Comments:
After an ISUPTMRPROFILE is created, it must be attached to a signal path by the PROV-ADD command.
prov-add:sigpathprof:name=”<signal path name>”,isuptmrprofile=”<ISUP signal path profile
name>”
For the preceding example, the command to attach the profile to the signal path ss7svc1 is:
prov-add:sigpathprof:name=”ss7svc1”,isuptmrprofile=”set1”
Use the PROV-RTRV:VARIANTS command for a list of protocol variants (configured for your system),
and see the ISUP properties configurable for a specific variant.
The base property is new in Release 9.8(1) and allows you to create a new profile based on an existing
profile. To use this property, set the base property to the name of an existing profile. You can set additional
properties to override the values copied from the original profile.
The parameters are stored in the data file profiles.dat.
RAPATH—RADIUS Accounting Server Signal Path
(Release 9.7(3))
Purpose:
Adds a RADIUS accounting server signal path.
Syntax:
prov-add:rapath:name=sigpath,desc=description,extnode=ra-name
Input
Description:
Output
Description:
•
sigpath—The MML name of the RADIUS accounting server signal path. Enter an alphanumeric value
up to 20 characters in length that starts with an alphabetic character.
•
description—An assigned name. It can be as many as 128 alphanumeric characters in length.
•
ra-name—The MML name of a previously defined external node.
•
COMPLD—Provision succeeds
•
DENY— Provision fails
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-60
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
RASERVER—RADIUS Accounting Server (Release 9.7(3))
Example:
mml> prov-add:rapath:name=”racluster1”
MGC-01 - Media Gateway Controller 2006-11-22 02:31:57.559 EST
M RTRV
''session=radius-magnolia:rapath''
/*
NAME = racluster1
DESC = Radius accounting server cluster
EXTNODE = ranode1
*/
Comments:
The following rules apply when creating, deleting, or editing of the rapath:
•
Only one rapath is allowed. This check is done at the add operation.
•
The rapath cannot be edited.
•
A racluster type extnode must be added before the rapath can be added. This check is done at the add
rapath operation.
•
A raserver must be defined when rapath is defined. This check is done at prov-cpy time.
•
All raservers that are associated with rapath must be deleted before a rapath can be deleted. This check
is done at the rapath delete operation.
RASERVER—RADIUS Accounting Server (Release 9.7(3))
Purpose:
Adds a RADIUS accounting server.
Syntax:
prov-add:raserver:name=server-name, desc=description,svc=sigpath,
ipaddr=local-address,port=local-port,peeraddr=ra-address, peerport=ra-port,
[iproute=iproute],order=order, key=key,[timeout=timeout],[retrycount=retrycount]
Input
Description:
•
server-name—Name of the RADIUS server.
•
description—Assigned name. It can be as many as 128 alphanumeric characters in length.
•
sigpath—Name of RAPATH (RADIUS Accounting Server Signal Path). The raserver component
supports this command and associates a RADIUS accounting sigpath to this channel.
•
local-address—Local IP address of the Cisco PGW 2200 Softswitch.
•
local-port—Local port number.
•
ra-address—IP address of the RADIUS server, expressed in dot notation.
•
ra-port—Remote port number of the RADIUS server.
•
iproute—MML name of a previously defined IP route. This is an optional parameter.
•
order—Order of the server as primary server. The range is 1 to 99. The order with the lowest value is
selected as primary server. PGW does not allow equal order and displays an error to prevent a provision
of same order. This check is done when a raserver is added.
•
key—Shared key for encryption used for this server. The length of the key is 1 to 20. Alphanumerics
and dashes are allowed. The key must start with a character.
•
timeout—Duration in seconds before the RADIUS packet is retransmitted. Timeout is equal to or
greater than 1.This is an optional parameter.
•
retrycount—Number of times that PGW retransmits a packet before giving up. The range is 1 to 10. The
default value is 2. This is an optional parameter.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-61
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
RTLIST—Route Lists
Output
Description:
•
COMPLD—Provision succeeds
•
DENY—Provision fails
Example:
mml> prov-add:raserver:name=”raserver1”
MGC-01 - Media Gateway Controller 2006-11-22 02:30:05.403 EST
M RTRV
“session=radius-magnolia:raserver”
/*
NAME = raserver1
DESC = radius accounting server1
SVC = racluster1
IPADDR = IP_Addr2
PORT = 9595
PEERADDR = 10.74.50.171
PEERPORT = 1646
IPROUTE =
ORDER = 1
KEY = Cisco-h323
TIMEOUT = 5
RETRYCOUNT = 2
*/
Comments:
The following rules apply when you are creating, deleting, or editing a RASERVER:
•
The maximum number of RASERVERs is 5.
•
RAPATH must be added before RASERVER can be added. This is checked at the add RASERVER
operation.
•
To delete the only RASERVER, you must also delete the RAPATH. This is checked at the prov-cpy or
prov-dply time.
•
For you to add or edit the second RASERVER, the PORT must match the port for the first
RASERVER. This is checked at the add/edit RASERVER operation.
•
The PGW uses PORT from <local-port> to <local-port + <number of port>>.
•
The Operator must try to prevent PORT conflict from <local-port> to <local-port + <number of port>>
•
IPADDR, PORT, PEERADDR, PEERPOT, ORDER, KEY, TIMEOUT, and RETRYCOUNT are
mandatory. IPROUTE is optional.
RTLIST—Route Lists
Purpose:
Provision a route list.
Syntax:
prov-add:rtlist:name=”route list name“, rtname=”route name“, distrib=”OFF|ON“
prov-dlt:rtlist:name=”route list name“, rtname=”route name“
prov-ed:rtlist:name=”route list name“, rtname=”route name“, nextrtname=”next route name“,
distrib=”OFF|ON“
prov-rtrv:rtlist:name=”route list name“
prov-rtrv:rtlist:”all”
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-62
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
RTTRNK—Route Trunk
Input
Description:
Example:
•
Name—Route list name.
•
Rtname—Route name. Name of an existing route.
•
Nextrtname—Next route name. Name of an existing route.
•
Distrib—Sequential distribution. Values are Off (default) for sequential trunk group selection or On for
random trunk group selection.
The MML command shown in the following example provisions a route list:
mml> prov-add:rtlist:name=”rtlist1910“,rtname=”rt1910“,distrib=”OFF“
RTTRNK—Route Trunk
Purpose:
Associating a route with a trunk group.
Syntax:
prov-add:rttrnk:name=”name”,trnkgrpnum=”trunk group number”,weightedtg=”weighted trunk group”
prov-dlt:rttrnk:name=”name”,trnkgrpnum=”trunk group number”
prov-ed:rttrnk:name=”name”,trnkgrpnum=”trunk group number”,nexttrkgrp=”next trunk group”,
weightedtg=”weighted trunk group”
prov-rtrv:rttrnk:name=”name”
prov-rtrv:rttrnk:”all”
Input
Description:
Example:
•
Name—Route name.
•
Trnkgrpnum—Trunk group number
•
Nexttrkgrp—Next trunk group.
•
Weightedtg—Weighted trunk group indicator.
The MML command shown in the following example provisions a route list:
mml> prov-add:rttrnk:name="rt1910",trnkgrpnum=501910
mml> prov-ed:rttrnk:name="route1",trnkgrpnum=2222,weightedtg="ON"
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-63
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
RTTRNKGRP—Route Trunk Group
RTTRNKGRP—Route Trunk Group
Purpose:
Add—Specifies the percentage of trunks in a routing trunk group that are reserved for incoming calls.
Edit—Edits the routing trunk group.
Syntax:
Input
Description:
prov-add:rttrnkgrp:name=”one”[,type=trunk group type][,reattempts=number][,queuing=seconds]
[,cutthrough=number][,bearercapname=”name”]
prov-ed:rttrnkgrp:name=”one”{[,type=”trunk group type”][,reattempts=”number”]
[,queuing=”seconds”][,cutthrough=”number”][,bearercapname=”name”]}
•
Name—Trunk group number.
•
Type—Trunk group type. Valid values are:
– 0—General
– 1—ISUP
– 3—TUP
– 4—IP
– 5—ATM
– 6—DPNSS
– 7—PRI
– 8—BTNUP
– 9—IP_SIP
– 10—SIP_IN
Example:
•
Reattempts—Number of times to reattempt trunk group selection. Valid values are 0 through 5.
•
Queuing— Time (in seconds) that the call will be queued. Valid values are 0 through 120.
•
Cutthrough—Identifies the point in the call process where the trunk is seized from end point to end.
Ranges from 0 to 3. the default is 0.
•
Resincperc—Percentage of bandwidth reserved for incoming calls. Valid values are 0 through 100.
•
bearercapname—Bearer capability name (previously configured).
The MML command shown in the following example provisions the percentage of trunks in routing trunk
group 1000 to 80:
mml> prov-add:rttrnkgrp:name="1000",type="0",reattempts="5",queuing="1",cutthrough="1",
resincperc="80"
The MML commands shown in the following example provision bearer capability attributes:
mml> PROV-ADD:bearercap:name=”bearer1”,bearercap=”12;05;31”
mml> PROV-ADD:siprttrnkgrp:name=”2222”,url=”128.107.132.143”,svrr=0,sipproxyport=5060,
version=”2.0”,cutthrough=1,extsupport=1,bearercapname=”bearer1”
mml> PROV-ADD:rttrnkgrp:name=”1”,type=1,reattempts=3,queuing=0,cutthrough=1,
bearercapname=”bearer1”
The MML command shown in the following example changes the bearer capability name for the routing trunk
group:
mml> PROV-ED:rttrnkgrp:name=”one”,bearercapname=”bearer3”
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-64
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
SESSIONPROP—SS7 Session Property
SESSIONPROP—SS7 Session Property
Purpose:
Provisions an SS7 session property component.
Syntax:
prov-add:sessionprop:name=”name”, rudpNumRetx=”rudpnumretx”,rudpRetxTimer=”rudpretxtimer”,
rudpwindowsz=value
Input
Description:
Example:
•
name—Name of the SS7 session; up to 20 alphanumeric characters.
•
rudpnumretx—The maximum number for retransmission count; range: 1-100; Def=2.
•
rudpretxtimer—The retransmission timeout value; range: 2 through 100.
•
rudpwindowsz—The maximum number of unacknowledged segments in the RUDP window. Value range:
2 through 64.
The MML command shown in the following example creates a session property:
mml> prov-add:sessionprop:name=”sess8-2”, rudpNumRetx=”8”, rudpRetxTimer=”8”, rudpwindowsz=5
Comments:
Performance Impact Category: B
SESSIONSET—Sessionset
Purpose:
Add, delete, or edit a sessionset, a pair of backhaul IP links used by the Cisco PGW 2200 Softswitch to
communicate with an external node that supports IPFAS or BSMV0.
Syntax:
prov-add:sessionset:name=”sessionset name“,ipaddr1=”ipaddress”,ipaddr2=”ipaddress”,port=number,
peeraddr1=”ipaddress”,peeraddr2=”ipaddress”,peerport=”peer ip port”,extnode=”external node”,
iproute1=”iproute”,iproute2=”iproute”, type=”external node type”
prov-dlt:sessionset:name=”sessionset name“
prov-ed:sessionset:name=”sessionset name“,desc=”sessionset description”,ipaddr1=”ipaddress”,
ipaddr2=”ipaddress”,port=number,peeraddr1=”ipaddress”,peeraddr2=”ipaddress”,
peerport=”peer ip port”,iproute1=”iproute”,iproute2=”iproute”
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-65
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
SESSIONSET—Sessionset
Input
Description:
•
Name—MML name of a sessionset. This name can be up to 20 alphanumeric characters in length.
– Special characters allowed are quotes (" ").
– The name must start with an alphabetic character.
•
Desc—Sessionset description. This description can be up to 128 characters in length.
•
IPAddr1—Local logical IP address 1.
•
IPAddr2—Local logical IP address 2.
•
Port—Local port number in the range 1025 to 65535.
– Enter a value that is different from that specified for any ASSOCIATION, IPLNK, or SIPLNK
command.
– Enter a value that is different from that specified for another session set.
•
Peeraddr1—Destination IP address 1. You can also specify a hostname or DNS name. The default is
0.0.0.0.
•
Peeraddr2—Destination IP address 2. You can also specify a hostname or DNS name. The default is
0.0.0.0.
•
Peerport—Destination port number in the range 1025 to 65535.
•
Extnode—MML name of previously configured external node.
•
IProute1—MML name of previously configured IP route. The IPADDR value must match IPADDR1 of
the session set.
•
IProute2—MML name of previously configured IP route. The IPADDR value must match IPADDR2 of
the session set.
•
Type—External node type for this sessionset.
– Enter BSMV0 for C7 session sets.
– Enter IPFAS for IPFAS session sets.
Example:
The MML command shown in the following example provisions a sessionset used by the
Cisco PGW 2200 Softswitch to communicate:
mml> prov-add:sessionset:name="slt1",ipaddr1="IP_Addr1",ipaddr2="IP_Addr2",port=7000,
peeraddr1="10.82.80.188",peeraddr2="10.82.81.165",peerport=7000, extnode="va-2600-165",
type="BSMV0",iproute1="iprte1",iproute2="iprte2"
The MML command shown in the following example deletes a session set:
mml> prov-dlt:sessionset:name="slt1"
The MML command shown in the following example edits a sessionset used by the
Cisco PGW 2200 Softswitch to communicate with an external node:
mml> prov-ed:sessionset:name="slt1",ipaddr1="ip_addr1",ipaddr2="ip_addr2", port=7000,
peeraddr1="10.82.80.188",peeraddr2="10.82.81.165",peerport=7000,extnode="va-2600-165",
type="bsmv0",iproute1="iprte1", iproute2="iprte2"
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-66
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
SGP—SS7 Signaling Gateway Process
SGP—SS7 Signaling Gateway Process
Purpose:
Add, delete, or edit an SS7 Signaling Gateway Process (SGP).
Syntax:
prov-add:sgp:name=”key name",desc="key description",extnode="external node"
prov-dlt:sgp:name=”key name"
prov-ed:sgp:name=”key name"<,desc="key description">
Input
Description:
Example:
•
name—Name of the SGP. Enter an alphanumeric string up to 20 characters in length.
•
desc—Description of the SGP. This parameter can be up to 128 characters in length.
•
extnode—MML name of previously configured external node.
mml> prov-add:sgp:name="sgp1",desc="first sgp",extnode="va-2600-165"
mml> prov-dlt:sgp:name="sgp1"
mml> prov-ed:sgp:name="sgp1",desc="first sgp"
SIGPATHPROF—Signaling Service Profile
Purpose:
Provision the signaling service profile.
Syntax:
prov-add:sigpathprof:name=”Name",isuptmrprofile="Inbound or Outbound"
Input
Description:
•
name—Signaling service name.
•
isuptmrprofile—ISUP timer profile name.
Output
Description:
•
COMPLD—Provision succeeds.
•
DENY— Provision fails.
Example:
The MML commands shown in the following example create an ISUP timer profile and attach it to a
signaling service:
mml> prov-add:profile:name="mtp3profile1",type="isuptmrprofile",variant="ISUPV2_FRENCH",
T1="14000",T12="14000",T13="20000",T14="70000",T15="200000",T16="50000",T17="950000",T18="700
00",T19="50000",T2="280000",T20="70000",T21="20000",T22="70000",T23="50000",T24="900",T25="90
0",T26="50000",T27="200000",T28="9000",T33="16000",T34="1000",T35="10000",T36="16000",T38="12
0000",T5="50000",T6="70000",T7="40000",T8="25000",T9="50000"
mml> prov-add:sigpathprof:name="ss7svc1",isuptmrprofile="mtp3profile1"
Comments:
ISDN User Part (ISUP) timer profile properties allow property values, listed in “ISUP Timers” section on
page 1-116 to be overridden for the specified protocol.
When configuring an ISUP timer profile, you can attach a profile to a signaling service, but both the profile
and the signaling service must belong to the same variant (see the “Protocol Variants” section on page 1-134
for a list of variant names). However, you can create a profile even though the signaling service does not
exist.
A profile must be created before a signaling service can be associated with the profile.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-67
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
SIGSVCPROP—Signaling Service Properties
SIGSVCPROP—Signaling Service Properties
Purpose:
Provision signaling service properties.
Syntax:
prov-add:sigsvcprop:name="111",gninclude=”gninclude”,od32digitsupport=”value”,
SipToIsupRatio="value",IsupToSipRatio="value"
prov-dlt:sigsvcprop:name=”name”,”property name”
prov-ed:sigsvcprop:name=”name”,AllowH323Hairpin="{0|1}",od32digitsupport=”value”,
CustomerVPNid="id”,CallForwardRerouteDisabled=“int”,ContactListOrder=”value”,
SipToIsupRatio="value",IsupToSipRatio="value",SipRedirAnalysisMethod=”value”
prov-rtrv:sigsvcprop:name=”name”
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-68
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
SIGSVCPROP—Signaling Service Properties
Input
Description:
•
Name—Name of an existing signaling service. Enter an alphanumeric string up to 20 characters in length.
•
AllowH323Hairpin—enable or disable H.323 inter working on the H.323 signal path. Valid values are:
– 0—Disable
– 1—Enable
•
gninclude—Indicates whether or not to include the generic number in an IAM. Values: 0 or 1. This
parameter was added in software Release 9.8(1).
– 0 does not include the generic number. This is the default.
– 1 includes the generic number.
•
OD32digitsupport—Enter one of the following:
– 1 enables overdecadic and 32-digit support. This is the default.
– 0 disables overdecadic and 32-digit support.
•
CustomerVPNid—A string of 1 to 8 alphanumeric characters. The default value is 00000000. If no value
is given, the system responds as if no VPN ID were present.
•
CallForwardRerouteDisabled—Valid property values. Default value is 0.
– 0 = Call forwarding reroute enabled
– 1= Call forwarding reroute disabled
•
ContactListOrder—The ContactListOrder defines the order in which the target list is appended, once a
new Contact header is received in another 300, 301, 0r 302 response message. Values are:
– 1—At the beginning of the list. This is the default.
– 2—At the end of the list.
– 3—Replace the list with the new list.
•
SipRedirAnalysisMethod—Defines how the PGW handles the SIP redirection target. Values are:
– 0—Conditional analysis, which performs digit analysis if the host in the 302 response message is the
PGW domain; otherwise route the call directly to the 302 address. This is the default.
– 1—Always perform digit analysis.
– 2—Never perform digit analysis.
•
SipToIsupRatio—The SIP to ISUP ratio property. Values are:
– 0—The mapping is disabled.
– 1 through 4—The mapping ratio value.
•
IsupToSipRatio—The ISUP to SIP ratio property. Values are:
– 0—The mapping is disabled.
– 1 through 4—The mapping ratio value.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-69
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
SIGSVCPROP—Signaling Service Properties
Example:
The MML command shown in the following example enables H.323 inter working on the EISUP-HSI-1 signal
path:
mml> PROV-ED:sigsvcprop:name="EISUP-HSI-1",AllowH323Hairpin="1"
The MML commands shown in the following example provision signaling service properties:
mml> prov-add:sigsvcprop:name="111",gninclude=1"
mml> prov-add:sigsvcprop:name=”1000”,od32digitsupport=”1”
mml> prov-dlt:sigsvcprop:name=”1000”,”od32digitsupport”
mml> prov-ed:sigsvcprop:name=”1000”,od32digitsupport=”1”, CustomerVPNid ="AB1GB1Z1”,
CallForwardRerouteDisabled ="1"
The MML commands shown in the following example sets and retrieves the state of the ContactListOrder:
sh-bamboo mml> prov-ed:sigsvcprop:name="sip-path",contactlistorder="2"
MGC-01 - Media Gateway Controller 2005-11-01 09:56:29.916 EST
M COMPLD
"sigsvcprop"
;
sh-bamboo mml> prov-rtrv:sigsvcprop:name="sip-path"
MGC-01 - Media Gateway Controller 2005-11-01 09:56:42.654 EST
M RTRV
"session=chgcontac:sigsvcprop"
/*
ContactListOrder = 2
*/
The MML commands shown in the following example sets and retrieves the state of the
SipRedirAnalysisMethod:
sh-bamboo mml> prov-ed:sigsvcprop:name="sip-path",SipRedirAnalysisMethod="2"
MGC-01 - Media Gateway Controller 2005-11-01 09:56:29.916 EST
M COMPLD
"sigsvcprop"
;
sh-bamboo mml> prov-rtrv:sigsvcprop:name="sip-path"
MGC-01 - Media Gateway Controller 2005-11-01 09:56:42.654 EST
M RTRV
"session=chgcontac:sigsvcprop"
/*
SipRedirAnalysisMethod = 2
*/
The MML command shown in the following example sets the SIP to ISUP ratio to 1 and the ISUP to SIP ratio
2:
mml> prov-ed:sigsvcprop:name="sip-path",SipToIsupRatio="1",IsupToSipRatio="2"
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-70
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
SIPIVERSION—SIP-I Version and MDO Variant (Release 9.8(1))
SIPIVERSION—SIP-I Version and MDO Variant (Release 9.8(1))
Purpose:
Add—Adds an entry in the sipIVersion.dat file.
Delete—Deletes an entry within a SIP-I mapping profile in the sipIVersion.dat file.
Edit—Edits an entry within a SIP-I mapping profile in the sipIVersion.dat file.
Retrieve—Displays the information for one entry within a SIP-I mapping profile in the sipIVersion.dat file.
Syntax:
Input
Description:
prov-add:sipiversion:profilename="SIP-I mapping profile name",
version="SIP-I version in Content-Type",mdo="SIP-I variant name"
prov-dlt:sipiversion:profilename="SIP-I mapping profile name",
version="SIP-I version in Content-Type"
prov-ed:sipiversion:profilename="SIP-I mapping profile name",
version="SIP-I version in Content-Type",mdo="SIP-I variant name"
prov-rtrv:sipiversion:profilename="SIP-I mapping profile name",
version="SIP-I version in Content-Type"
•
PROFILENAME—MML name of a SIP-I mapping profile. This name can be up to 20 alphanumeric
characters in length.
– The name must start with an alphabetic character.
Example:
•
VERSION— SIP-I version defined by the operator and used in the SIP-I message Content-Type header
field. One SIP-I mapping profile can have more than one SIP-I version defined on the PGW. This
parameter value can be up to 128 characters in length.
•
MDO—SIP-I variant name mapped to the SIP-I message ParamContent field. This name can be up to
40 alphanumeric characters.
The MML command shown in the following example adds a mapping from SIP-I version X-UKISUP to
SIP-I variant ISUPV3_UK_SIPI in the SIP-I mapping profile BT:
mml> prov-add:sipiversion:profilename="BT", version="X-UKISUP",mdo="ISUPV3_UK_SIPI"
The MML command shown in the following example deletes the mapping for the SIP-I version X-UKISUP
in the SIP-I mapping profile BT:
mml> prov-dlt:sipiversion:profilename="BT",version="X-UKISUP"
The MML command shown in the following example edits the mapping from SIP-I version “X-UKISUP”
to SIP-I variant ISUPV3_UK_SIPI in the SIP-I mapping profile BT:
mml> prov-ed:sipiversion:profilename="BT",version="X-UKISUP", mdo="ISUPV3_UK_SIPI"
The MML command shown in the following example displays the information of the entry for SIP-I version
X-UKISUP in the SIP-I mapping profile BT:
mml> prov-rtrv:sipiversion:profilename="BT",version="X-UKISUP"
Comments:
Performance Impact Category: A
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-71
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
SIPLNK—SIP IP Link
SIPLNK—SIP IP Link
Purpose:
Edits a SIP IP link used by the Cisco PGW 2200 Softswitch to communicate with a SIP proxy server.
The PROV-ED:siplnk command is no longer supported as of Release 9.7(3)
Note
Syntax:
Input
Description:
prov-ed:siplnk:name=“sip ip link name”,desc=”sip ip link description”,port=number,
pri=priority,IPAddr=”IP address”
Name—MML name of SIP IP link. Enter up to 20 alphanumeric characters.
•
– Special characters allowed are quotes (“ “).
– The name must start with an alphabetic character.
•
Desc—Description of SIP IP link. Enter up to 128 characters.
•
Port—Local port number.
– Enter a valid port number up to 1024.
– For SIP, enter 5060.
Example:
•
Pri—Priority. Enter an integer greater than 0.
•
IPAddr—Local logical IP address.
The MML command shown in the following example edits a SIP IP link:
mml> prov-ed:siplnk:name=”siplnk-1”,ipaddr=”IP_Addr1”,port=5060,pri=1
SIPPATH—SIP Signaling Service
Purpose:
Provision SIP signaling service or signaling path to SIP proxy servers.
Syntax:
prov-add:sippath:name=”Name",desc="description",mdo="Protocal Variant",
origlabel="Origination Location Label",termlabel=”Termination Location Label”
prov-dlt:sippath:name=”Name"
prov-ed:sippath:name=”Name",desc="description",origlabel="Origination Location Label",
termlabel=”Termination Location Label”
prov-rtrv:sippath:name=”Name"
prov-rtrv:sippath:”all"
Input
Description:
•
name—Unique component name used in MML commands. The name can be up to 20 alphanumeric
characters. No special characters other than "-" are allowed. The name should begin with an alphabetic
character.
•
desc—Description. The description can be up to 128 alphanumeric characters. No special characters
other than "-" are allowed. The name should begin with an alphabetic character.
•
mdo—MDO file name. Valid protocol name from variants.dat.
•
origlabel—Originating call control (OCC) side location label. Used for Call Limiting feature.
•
termlabel—Terminating call control (TCC) side location label. Used for Call Limiting feature.
Note
Output
Description:
Example:
The parameters, origlabel and termlabel, are added in software Release 9.6(1).
•
COMPLD—Provision succeeds.
•
DENY— Provision fails.
mml> prov-add:sippath:name="sip-path",mdo="IETF_SIP",desc="SIP sigpath"
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-72
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
SIPRTTRNKGRP—SIP Routing Trunk
SIPRTTRNKGRP—SIP Routing Trunk
Purpose:
Add or edit the SIP routing trunk group.
Syntax:
prov-add:siprttrnkgrp:name=”one”,url=”ipaddress”,srvrr=number,sipproxyport=udp port,
version=”sip version”[,cutthrough=number][,extsupport=sip extension][,bearercapname=”name”]
prov-ed:siprttrnkgrp:name=”one”,url=”ipaddress”|,srvrr=”srv dns name”|,
sipproxyport=”udp port”|,version=”sip version”|,cutthrough=”number”|,
extsupport=”sip extension”|,bearercapname=”name”}
Input
Description:
•
name—SIP Route Trunk Group Name.
•
url—SIP proxy service address in the format of IP address, host name, or DNS name.
•
srvrr—URL is SRV DNS Name. Enter 0 or 1; the default is 0.
•
sipproxyport—Sip Proxy Port.
•
sipver—SIP version of the SIP proxy server.
•
cutthrough—Enter a value in the range 0 to 3; the default is 0.
•
extsupport—Supported SIP extension. Enter 0 or 1; the default is 0.
•
bearercapname—Bearer capability name (previously configured).
•
domainbasedrtgsupport—Support for Domain based routing (non E164).0=False (non-E.164 calls not
permitted), 1=True (non-E.164 calls permitted), Default is 0. This parameter was added in software
Release 9.8(1).
Note
Example:
Ensure that the remote trunk matches this configuration.
The MML commands shown in the following examples provision bearer capability attributes:
mml> PROV-ADD:bearercap:name=”bearer1”,bearercap=”12;05;31”
mml> PROV-ADD:siprttrnkgrp:name=”2222”,url=”128.107.132.143”,svrr=0,sipproxyport=5060,
version=”2.0”,cutthrough=1,extsupport=1,bearercapname=”bearer1”
mml> PROV-ADD:rttrnkgrp:name=”1”,type=1,reattempts=3,queuing=0,cutthrough=1,
bearercapname=”bearer1”
mml> prov-add:siprttrnkgrp:name="TgName",type=9,sipurl="<sipurl>",portnum=<portnum>,
sipver="<sipver>",cutthrough=<cutthrough>,extsupport=<extsupport>,issvr=<issvr>,
bearercapindex=<bearercapindex>,domainbasedrtgsupport=<domainbasedrtgsupport>
The MML command shown in the following example changes the bearer capability name for the SIP routing
trunk group:
mml> PROV-ED:siprttrnkgrp:name=”2222”,bearercapname=”bearer2”
SS7PATH—SS7/M3UA Signaling Service
Purpose:
Syntax:
Provisions an SS7/M3UA signaling service.
•
For SS7 service, set OPC.
•
For M3UA service, set M3UAKEY.
prov-add:ss7path:name=”node name”,desc=”node description”,dpc=”destination point code”,
opc=”origination point code”,mdo=”variant”,custgrpid=”id”,side=”call model”,
m3uakey=”name of key”,origlabel="loclbl1",termlabel="loclbl2"
prov-ed:ss7path:name=”node name”,desc=”node description”,opc=”origination point code”,
mdo=”variant”,custgrpid=”id”,side=”call model”,m3uakey=”name of key”
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-73
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
SS7ROUTE—SS7 Route
Input
Description:
•
name—Name of the signaling service. Enter an alphanumeric string up to 20 characters in length.
•
desc—Description of the signaling service. This parameter can be up to 128 characters in length.
•
side—Q.931 call model side.
– Enter User for the user side.
– Enter Network for the network side (default).
Example:
•
MDO—MDO file name. Enter any MDO variant from the SS7 protocol family.
•
DPC—MML name of a previously defined destination point code.
•
custgrpid—Customer group ID. Enter a four-digit ID; the default is 0000.
•
OPC—MML name of a previously defined origination point code.
•
M3uakey—MML name of a previously configured M3UAKEY.
•
origlabel—MML name for a previously configured LOCLABEL.
•
termlabel—MML name for a previously configured LOCLABEL.
mml> prov-add:ss7path:name=”ss7path1”,desc=”ss7 path”,dpc=”dpc1”,mdo=”ANSI SS7_STANDARD”,
custgrpid=”3343”,side=”network”,m3uakey=”key3”
mml> prov-ed:ss7path:name=”ss7path1”,desc=”ss7 path”,opc=”opc1”,mdo=”ANSI SS7_STANDARD”,
custgrpid=”3343”,side=”network”,m3uakey=”key3”
SS7ROUTE—SS7 Route
Purpose:
Provisions an SS7 route.
Syntax:
prov-add:ss7route:name=”name”,desc=”description”,dpc=”destination point code”,
opc=”origination point code”,lnkset=”link set”,PRI=”priority”
Input
Description:
Example:
•
name—Unique name for this route. Enter as many as 20 alphanumeric characters and enclose in straight
quotes. Hyphens (-) can be used.
•
desc—Text description of this route. Enter as many as 128 characters and enclose in straight quotes.
•
DPC—Destination point code. Enter the MML name of a previously defined destination point code for a
remote switch.
•
OPC—Originating point code (must be a true OPC). Enter the MML name of a previously defined
originating point code for this MGC node.
•
LNKSET—Linkset that leads to the destination device. Enter the MML name of a previously defined
linkset.
•
PRI—SS7 route priority. Enter an integer that is greater than 0. One (1) is the highest priority level. When
two SS7 routes share the same priority level, traffic is shared by both routes. Default = 1.
mml> prov-add:ss7route:name="rte1DPC1",opc="OPC",dpc="DestSW1PC",lnkset="linkset1",pri=1,
desc="route 1 to DestSW1 thru STP-A"
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-74
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
SS7SUBSYS—SS7 Subsystem
SS7SUBSYS—SS7 Subsystem
Purpose:
Add, delete, or edit an SS7 subsystem. It is used for specifying mated STPs and for providing LNP support
through an SCP.
Syntax:
prov-add:ss7subsys:name=”subsystem name”,desc=”subsystem description”,svc=”service”,
proto=”protocol family”,matedapc=”adjacent point of apc”,pri=priority,localssn=subsystem,
stpscpind=index,transproto=”transport protocol”,<remotessn=subsystem>
prov-dlt:ss7subsys:name=”subsystem name”
prov-ed:ss7subsys:name=”subsystem name”,desc=”subsystem description”,proto=”protocol family”,
matedapc=”adjacent point of apc”,pri=priority,localssn=subsystem,
transproto=”transport protocol”,<opc=”origination”|,suakey=”routing key”>,<remotessn=subsystem>
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-75
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
SS7SUBSYS—SS7 Subsystem
Input
Description:
•
Name—Name of the SS7 subsystem. Enter an alphanumeric string up to 20 characters in length.
•
Desc—Description of the SS7 subsystem. This parameter can be up to 128 characters in length.
•
SVC—Enter one of the following:
– MML name of a previously defined adjacent point code
– MML name of a previously defined TCAP/IP service
•
PROTO—Protocol family.
– When creating an AIN subsystem, enter either SS7-ANSI or SS7-ITU.
– When mating STP pairs, enter one of the following: SS7-ANSI, SS7-China, SS7-ITU, SS7-Japan, or
SS7-UK.
•
Matedapc—MML name of a previously defined adjacent point code. This parameter is used only when
you are mating STP pairs.
•
Pri—Priority entered as an integer that is greater than 0. The default is 1. This parameter is used only when
you are creating AIN subsystems.
•
Localssn—Subsystem number entered as an integer in the range 2 to 254.
– For SS7-ANSI, SS7-ETSI, or SS7-ITU, enter any value other than 0.
– For mating two STPs, enter 0.
The default is 0.
•
Stpscpind—The STP/SCP index used for IN triggers. Enter an integer greater than 0; the default is 0. This
parameter is used only when you are creating AIN subsystems.
•
Transproto—Transport protocol. Enter one of the following:
– SCCP (default)
– SUA
This parameter is used only when creating AIN subsystems.
•
OPC—MML name of a previously defined origination point code. This parameter is not used if SUAKEY
is specified.
•
Suakey—MML name of a previously defined routing key. This is an optional parameter used only for
SUA. This parameter is not used if OPC is specified.
•
Remotessn—(Optional) Subsystem number entered as an integer in the range 2 to 254.
– For SS7-ANSI, SS7-ETSI, OR SS7-ITU, enter any value other than 0.Default is 0.
Example:
mml> prov-add:ss7subsys:name=”prepaid”,desc=”prepaid rte-ssn 48”,svc=”scp”,proto=”ss7-itu”,
stpscpind=2,transproto=”sua”,suakey=”suakey1”,remotessn=48
mml> prov-dlt:ss7subsys:name=”prepaid”
mml> prov-ed:ss7subsys:name=”prepaid”,desc=”prepaid rte-ssn 48”,proto=”ss7-itu”,
transproto=”sua”,suakey=”suakey1”,remotessn=48
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-76
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
SUAKEY—SUA Routing Key
SUAKEY—SUA Routing Key
Purpose:
Add, delete, or edit an SUA routing key.
Syntax:
prov-add:suakey:name=”key name”,desc=”key description”,opc=”origination”,apc=”adjacent point”,
localssn=value,routingcontext=value,networkappearance=value
prov-dlt:suakey:name=”key name”
prov-ed:suakey:name=”key name”,desc=”key description”
Input
Description:
Example:
•
Name—Name of the SUA routing key. Enter an alphanumeric string up to 20 characters in length.
•
Desc—Description of the SUA routing key. This parameter can be up to 128 characters in length.
•
OPC—MML name of a previously defined origination point code.
•
APC—MML name of a previously defined adjacent point code. This is an optional parameter.
•
Localssn—Enter a value in the range 2 to 254.
•
Routingcontext—This value must be a unique integer in the range 0 to 2147483647. Two M3UAKEYs or
SUAKEYs cannot have the same routing context value.The default is 0.
•
Networkappearance—This value must be in the range 0 to 32767. The default is 0, which indicates an
invalid network appearance. This is an optional parameter.
mml> prov-add:suakey:name=”key1”,desc=”first key”,opc=”opc7”’apc=”apc77”,localssn=123,
routingcontext=7054,networkappearance=80
mml> prov-dlt:suakey:name=”key1”
mml> prov-ed:suakey:name=”key1”,desc=”first key”
SUAROUTE—SUA Route
Purpose:
Add—Uses SUA to sends an SS7 message to a particular destination.
Delete—Deletes an SUA route.
Edit—Edits an SUA route.
Syntax:
Input
Description:
Example:
prov-add:suaroute:name=”route name”,desc=”route description”,apc=”destination”,
extnode=”external node”,opc=”origination”,remotessn=”ssn of destination”
prov-dlt:suaroute:name=”route name”
prov-ed:suaroute:name=”route name”,desc=”route description”<,apc=”destination”>
<,extnode=”external node”><,opc=”origination”><,remotessn=”ssn of destination”>
•
Name—Name of the SUA route. Enter an alphanumeric string up to 20 characters in length.
•
Desc—Description of the SUA route. This parameter can be up to 128 characters in length.
•
APC—MML name of a previously defined adjacent point code. The APC must have an SS7SUBSYS
service with an SUAKEY defined.
•
Extnode—MML name of a previously defined external node.
•
OPC—MML name of a previously defined origination point code.
•
Remotessn—Remote subsystem number of destination. Enter either 0 or a number in the range 2 to 254.
mml> prov-add:suaroute:name=”route1”,desc=”first”,apc=”apc1”,extnode=”mgx-8260”,opc=”opc1”,
remotessn=”7”
mml> prov-dlt:suaroute:name=”route1”
mml> prov-ed:suaroute:name=”route1”,desc=”first”,apc=”apc1”,extnode=”mgx-8260”,opc=”opc1”,
remotessn=”7”
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-77
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
SWITCHTRNK—Multiple Switched Trunks
SWITCHTRNK—Multiple Switched Trunks
Purpose:
Add, delete, edit, or retrieve multiple switched trunks to the Cisco PGW 2200 Softswitch configuration. The
trunk (switched bearer channel) component is used for provisioning multiple switched trunks.
Syntax:
prov-add:switchtrnk:name="1",trnkgrpnum="1000",span="ffff",cic=25,cu="gw1",spansize=6,
endpoint="S0/DS1-1/6@li-5300-3"
prov-dlt:switchtrnk:name="1",
prov-ed:switchtrnk:name="1",trnkgrpnum="1000",span="ffff",cic=25,cu="gw1",spansize=6,
endpoint="S0/DS1-1/6@li-5300-3"
prov-rtrv:switchtrnk:name="1", trnkgrpnum="1000",span="ffff",cic=25,cu="gw1",spansize=6,
endpoint="S0/DS1-1/6@li-5300-3"
Input
Description:
Example:
•
Name—A numeric identifier for the trunk group. Range is from 1–9999.
•
trnkgrpnum—Trunk group number. The integer range is >= 0 and < 65536. This parameter is mandatory
for all operations;
•
span—Span ID. Value range: an integer from 1 through 65535 or ffff. (Not required for TDM.)
•
cic—Circuit identifier code. Identifies the trunk time slot or circuit identification code. Value range: an
integer from 0 through 65535.
•
cu—Coding unit. Identifies the coding unit MML name that was previously defined for the VISM card
(this is the external node created for MGCP or SGCP).
•
spansize—Span size. Indicates the number of trunks per span. Value: 1 through 24 for T1, or 1 through
31 for E1.
•
endpoint—End point. Text description of the trunk end point (typically a VISM card). Enter as many as
128 characters and enclose in straight quotes.
mml> prov-add:switchtrnk:name="1",trnkgrpnum="1000",span="ffff",cic=25,cu="gw1",spansize=6,
endpoint="S0/DS1-1/6@li-5300-3"
mml> prov-dlt:switchtrnk:name="1",
mml> prov-ed:switchtrnk:name="1",trnkgrpnum="1000",span="ffff",cic=25,cu="gw1",spansize=6,
endpoint="S0/DS1-1/6@li-5300-3"
mml> prov-rtrv:switchtrnk:name="1",trnkgrpnum="1000",span="ffff",cic=25,cu="gw1",spansize=6,
endpoint="S0/DS1-1/6@li-5300-3"
TARIFF—Tariff
Purpose:
Provision entries in the Tariff table.
Syntax:
prov-add:tariff:tariffid=”Tariff ID",tariffrate="Tariff rate",scalefactor=”Scale factor”
prov-dlt:tariff:tariffid=”Tariff ID"
prov-ed:tariff:tariffid=”Tariff ID",tariffrate="Tariff rate",scalefactor=”Scale factor”
prov-rtrv:tariff:tariffid=”Tariff ID"
prov-rtrv:tariff:”all"
Input
Description:
Output
Description:
•
tariffid—Tariff ID. Integer from 1 through 9999.
•
tariffrate—Tariff rate. Integer from 1 through 999999.
•
scalefactor—A multiplication factor that is applied to the tariff rate. Integer; 0, 1, 2, 3, 249, 250, 251,
252, 253, 254, or 255.
•
COMPLD—Provision succeeds.
•
DENY— Provision fails.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-78
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
TCPLNK—TCP Link
Example:
The MML command shown in the following example inserts an entry in the Tariff list:
mml> prov-add:tariff:tariffid=1010,tariffrate=1010,scalefactor=3
The MML command shown in the following example changes the previous entry from "scalefactor3" to
"scalefactor2":
mml> prov-ed:tariff:tariffid=1010,tariffrate=1020,scalefactor=2
The MML command shown in the following example deletes the existing entry from the Tariff list:
mml> prov-dlt:tariff:tariffid=1010
The MML command shown in the following example retrieves the specified entry from the Tariff list:
mml> prov-rtrv:tariff:tariffid=1010
The MML command shown in the following example retrieves all existing entries from the Tariff list:
mml> prov-rtrv:tariff:”all”
Comments:
Performance impact category A applies to the commands used to manage the domain table.
TCPLNK—TCP Link
Purpose:
Provision the backhaul TCP link, which represents a static IP route.
Syntax:
prov-add:tcplnk:name=”Name",desc=”description",extnode=”External Node Name",
ipaddr=”Local IP Address",port=”IP Port",peeraddr=”Peer Address",
peerport=”Peer IP Port",type="TCP Link Type",iproute=”IP Route Name”
prov-dlt:tcplnk:name=”Name"
prov-ed:tcplnk:name=”Name",ipaddr=”Local IP Address",port=”IP Port",
peeraddr=”Peer Address",peerport=”Peer IP Port",iproute=”IP Route Name”
prov-rtrv:tcplnk:name=”Name"
prov-rtrv:tcplnk:”all"
Input
Description:
Output
Description:
•
name—Unique component name used in MML commands.
•
desc—Component description.
•
extnode—Name of a previously provisioned Cisco BRI voice gateway.
•
ipaddr—Local IP address. IP_Addr1, IP_Addr2, IP_Addr3, or IP_Addr4.
•
port—Port number. Integer1024 through 65535.
•
peeraddr—Highest priority destination address.
•
peerport—Destination port number. Integer1024 through 65535.
•
type—Identifies the type of signaling service associated with this link. Must be set to BRI.
•
iproute—(Optional) Name of a previously provisioned IP route.
•
COMPLD—Provision succeeds.
•
DENY— Provision fails.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-79
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
TOS—TOS Value (Release 9.7(3))
Example:
The MML command shown in the following example deletes a Backhaul TCP link named britcp1:
mml> prov-dlt:tcplnk:NAME="britcp1"
Comments:
The following rules apply when you are creating or editing ISDN BRI signaling services:
•
You must define the TYPE parameter as PRI. If the TYPE parameter is not defined as PRI when the
TCPLINK is added/edited, a warning is issued. If the TYPE parameter is not defined as PRI when the
provisioning session is copied or deployed, an error message is generated and the copy or deployment
is stopped.
•
You must define the TCPLINK parameter with the same EXTNODE attribute that its associated
BRIPATH has. If the TCPLNK is not defined when the BRIPATH is added/edited, a warning is issued.
If the TCPLINK is not defined when the provisioning session is copied or deployed, an error message
is generated and the copy or deployment is stopped.
•
If the TCPLINK with the same EXTNODE value as the BRIPATH is deleted, a warning message is
issued to inform you that the BRIPATH must also be deleted. If the BRIPATH is not deleted when the
provisioning session is copied or deployed, an error message is generated and the copy or deployment
is stopped.
•
Only two combinations of local IP address and port number can be used per
Cisco PGW 2200 Softswitch. Once you have identified two unique local IP address and port number
combinations, all subsequent Backhaul TCP links must use one of those combinations.
TOS—TOS Value (Release 9.7(3))
Purpose:
Add—Sets a global dscp value to signaling traffic.
Delete—Deletes changes and sets the global dscp value of signaling traffic to the default CS3.
Edit—Changes the global dscp value for the signaling traffic.
Retrieve—Retrieves the global dscp value of the signaling traffic.
Syntax:
Input
Description:
PROV-ADD:tos:dscp=cs3
prov-dlt:tos:assoc_name | all
prov-ed:tos:dscp=cs3
PROV-RTRV:tos:
•
assoc_name—MML name of a previously configured SCTP association.
•
all—All QoS values
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-80
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
TRNKGRP—Trunk Group
Output
Description:
tos—QoS value.
dscp—differential service code point; valid values are:
•
BE
•
CS1
•
CS2
•
CS3
•
CS4
•
AF11
•
AF21
•
AF31
•
AF41
Default value is CS3.
Example:
The MML command shown in the following example adds the default value of CS3 to the signaling traffic:
mml> prov-add:tos:dscp=CS3
The MML command shown in the following example deletes the existing dscp value for signaling traffic
and sets it back to the default value of CS3:
mml> prov-dlt:tos
The MML command shown in the following example changes the value of signaling traffic to AF31:
mml> prov-ed:tos:dscp=AF31
The MML command shown in the following example retrieves the dscp value for the signaling traffic:
mml> prov-rtrv:tos:dscp=CS3
Comments:
Performance Impact Category: A
TRNKGRP—Trunk Group
Purpose:
Add, delete, or edit a trunk group to the Cisco PGW 2200 Softswitch configuration.
Syntax:
prov-add:trnkgrp:name="trunk group number",clli="clli",svc="signalling serviece",type="trunk
group type", selseq="selection sequence",qable="queuable",origlabel=”origination location
label”,termlabel=”termination location label”
prov-dlt:trnkgrp:name="trunk group number"
prov-ed:trnkgrp:name="trunk group number",clli="clli",svc="signalling serviece",type="trunk
group type", selseq="selection sequence",qable="queuable",origlabel=”origination location
label”,termlabel=”termination location label”
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-81
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
TRNKGRP—Trunk Group
Input
Description:
•
name—A numeric identifier for the trunk group. An integer from 1 through 9999.
•
clli—Common language location identifier that identifies the trunk group. This can be up to 11
alphanumerical digits.
•
svc—The MML name of the signaling service associated with or controlling the trunk group.
•
type—Identifies the trunk group type. Values:
– TDM_GEN—Used with SS7 signaling services with switch types not equal to 0, 5, 20, 23, or 40.
– TDM_ISUP—Used with SS7 signaling services with switch types of 0, 20, 23, or 40.
– TDM_CAS—Currently not supported.
– TDM_TUP—Used with SS7 signaling services with switch type of 5.
– IP—Used with EISUP signaling service.
– ATM—Used with VSI path signaling service.
– TDM_DPNSS—Used with DPNSS protocol family signaling services
– TDM_ PRI—Used with ISDN PRI protocol family signaling services.
– TDM_BTNUP—Used with SS7 signaling services with switch type of 5.
– IP_SIP—Used for SIP signaling services at the terminating side.
– SIP_IN—Used for SIP signaling services at the originating side (only one such trunk group can be
configured on each MGC node).
– CTI—Used with CTI signaling services.
Switch type values are:
– 0 = No switch-specific logic for the signaling path.
– 5 = BTNUP
– 10 = SS7 Japan
– 17 = 5ESS
– 20 = SS7 Clear
– 22 = NI2
– 23 = SS7 ANSI
– 26 = DPNSS
– 27 = NET5
– 29 = QSIG MASTER
– 30 = QSIG SLAVE
– 40 = SS7 ITU
•
selseq—Specifies the trunk selection sequence. The Cisco PGW 2200 Softswitch uses the CICs within
a trunk group according to the sequence specified by the SELSEQ value. You can provision this value
to reduce the chance of glare when the system selects a trunk.
– ASC = Ascending. The system selects the available CICs in ascending order starting from the
lowest CIC number (for example, 1, 2, 3 ...).
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-82
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
TRNKGRP—Trunk Group
– CASC = Cyclic ascending. The system selects the next available CIC in ascending order based on
the most recently selected CIC. For example, if the most recently selected CIC is CIC 5, the system
selects CIC 6, even if CIC 1 is available.
– CDESC = Cyclic descending. Similar to CASC, but in descending order based on the most recently
selected CIC. For example, if the last selected CIC is number 18, the system selects CIC 17, even
if CIC 31 is available.
– DESC = Descending. Similar to ASC, but in descending order starting from the highest CIC number
(for example, 31, 30, 29 ...).
– EASC = Even ascending, then odd ascending. The system selects the first available even CIC in
ascending order (for example, 2, 4, 6 ...). If no even CIC is available in the trunk group, the system
selects the first available odd CIC in ascending order (for example, 1, 3, 5 ...).
– EDECS = Even descending, then odd descending. Similar to EASC, but in descending order. The
system selects the first available even CIC in descending order (for example, 30, 28, 26 ...). If no
even CIC is available in the trunk group, the system selects the first available odd CIC in descending
order (for example, 31, 29, 27 ...).
– ITU2 = ITU method 2. The system selects the trunk according to the procedure in ITU-T
Recommendation Q.764, paragraph 2.9.1.3 Method 2.
– LIDL = Least idle (default). The system selects the least idle (most recently used) CIC.
– MIDL = Most idle. The system selects the most idle (least recently used) CIC.
– OASC = Odd ascending, then even ascending. The system selects the first available odd CIC in
ascending order (for example, 1, 3, 5 ...). If no odd CIC is available in the trunk group, the system
selects the first available even CIC in ascending order (for example, 2, 4, 6...).
– ODESC = Odd descending, then even descending. Similar to OASC, but in descending order. The
system selects the first available odd CIC in descending order (for example, 31, 29, 27 ...). If no odd
CIC is available in the trunk group, the system selects the first available even CIC in descending
order (for example, 30, 28, 26 ...).
– RDM = Random. The system selects a CIC at random.
Note
When the trunk selection sequence (SELSEQ) is set to its default value, LIDL (least idle), there is a
risk that the Cisco PGW 2200 Softswitch will select a significant number of temporarily unavailable
trunks, which causes calls to fail. This kind of call failure can happen when an overloaded media
gateway responds to the Cisco PGW 2200 Softswitch with a temporary MGCP error (400 to 499),
or the Cisco PGW 2200 Softswitch does not receive a response from the media gateway in time. We
recommend that you set SELSEQ to a value other than LIDL.
•
qable—Determines if queuing is used on the trunk during call processing. Value range: Y for yes or N
for no (default).
•
origlabel—Defines the originating label for the trunk group.
•
termlabel—Defines the terminating label for the trunk group.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-83
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
TRNKGRPPROF—Trunk Group Profile
Example:
To add a trunk group to the Cisco PGW 2200 Softswitch configuration, use the PROV-ADD command as
follows:
mml> prov-add:trnkgrp:name="1000",clli="tttt-ss-xxx",svc="ss7svc1",type="tdm_gen",
selseq="lidl",qable="n"
The MML command shown in the following example deletes the specified trunk group:
mml> prov-dlt:trnkgrpprof:name="1000"
To modify a trunk group, use the PROV-ED command as follows:
mml> prov-ed:trnkgrp:name="1000",clli="tttt-ss-xxx",svc="ss7svc1",type="tdm_gen",
selseq="lidl",qable="n"
TRNKGRPPROF—Trunk Group Profile
Purpose:
Attaches a trunk group profile to a trunk group.
Syntax:
prov-add:trnkgrpprof:name="trunk group number",grprofile="GR profile name" (For Release
9.7(3))
prov-add:trnkgrpprof:name="trunk group number",profile="trunk group profile name" (For
Release 9.8(1))
Input
Description:
•
name—Name of an existing trunk group.
•
grprofile—Name of an existing GR profile.
•
profile—Name of an existing trunk group profile.
Note
Example:
A profile must be created before a trunk group can be associated with the profile.
The MML command shown in the following example attaches the trunk group profile “profile1“ to the trunk
group “1000“:
mml> prov-add:trnkgrpprof:name="1000",grprofile="profile1"
The MML command shown in the following example attaches the trunk group profile “spf1“ to the trunk
group “1“:
mml> prov-add:trnkgrpprof:name="1",profile="spf1"
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-84
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
TRNKGRPPROP—Trunk Group Properties
TRNKGRPPROP—Trunk Group Properties
Purpose:
Provisions trunk group properties.
Syntax:
prov-add:trnkgrpprop:name=”name”,AOCInvokeType=”value“,AOCDefaultTariffId=”value“,
custgrpid=”<customer group ID>“,npa=”<trunkgroup npa>“,cotpercentage=”[0-255]“,
ringnoanswer=”value“, Ta1TimePeriod=”value“,Ta2TimePeriod=”value“,Ta3TimePeriod=”value“,
ExpiryWarnToneType=”value“, ExpiryWarnToneDur=”value”, SubscribeNotifySupport=subvalue,
UnsolicitedNotifyMethod=unsolvalue, MinEventSubscribeDuration=minvalue,
MaxSubscriptionDuration=maxvalue,sipMimebodySupport=value, gtdcaptypeprop=”string”,
GtdMsgFmt=”format”,IsupTransEarlyBackwardDisabled=value, od32digitsupport=”value”,
populateSDPInfoInCDR=value,InSessionTimer=value, OutSessionTimer=value,defaultpn=”value”,
defaultpnnoa=”value”,defaultpnnpi=”value”, defaultpnpres=”value”,enableipscreening=”value”,
sipipsource=”value”,GtdCapTypeProp=”string”,IsupTransparencyDisabled=value,
CustomerVPNid ="id",CustomerVPNOnNetTblNum="int",CustomerVPNOffNetTblNum ="int",
FeatureTransparencyDisabled=“int”, CallForwardRerouteDisabled ="int",adigitccrm=“adigitccrm”,
DtmfCap=”DtmfCap”, GWDefaultCodecString="GWDefaultCodecString"
prov-ed:trnkgrpprop:name=”name”,AOCInvokeType=”value“,AOCDefaultTariffId=”value“,
custgrpid=”<customer group ID>“,npa=”<trunkgroup npa>“,cotpercentage=”[0-255]“,
ringnoanswer=”value“, Ta1TimePeriod=”value“,Ta2TimePeriod=”value“,Ta3TimePeriod=”value“,
ExpiryWarnToneType=”value“, ExpiryWarnToneDur=”value”, SubscribeNotifySupport=subvalue,
UnsolicitedNotifyMethod=unsolvalue, MinEventSubscribeDuration=minvalue,
MaxSubscriptionDuration=maxvalue,sipMimebodySupport=value, gtdcaptypeprop=”string”,
GtdMsgFmt=”format”,IsupTransEarlyBackwardDisabled=value, od32digitsupport=”value”,
populateSDPInfoInCDR=value,InSessionTimer=value, OutSessionTimer=value,defaultpn=”value”,
defaultpnnoa=”value”,defaultpnnpi=”value”, defaultpnpres=”value”,enableipscreening=”value”,
sipipsource=”value”,GtdCapTypeProp=”string”,IsupTransparencyDisabled=value,
CustomerVPNid ="id",CustomerVPNOnNetTblNum="int",CustomerVPNOffNetTblNum ="int",
FeatureTransparencyDisabled=“int”, CallForwardRerouteDisabled ="int",adigitccrm=“adigitccrm”,
DtmfCap=”DtmfCap”, GWDefaultCodecString="GWDefaultCodecString"
prov-dlt:trnkgrpprop:name=”name”,”property name 1”[,”property name 2”],...[,”property name n”]
prov-rtrv:trnkgrpprop:name=”name”
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-85
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
TRNKGRPPROP—Trunk Group Properties
Input
Description:
•
Name—Name of an existing trunk group. Enter an alphanumeric string up to 20 characters in length.
•
AOCInvokeType—Allows configuration of whether or not the AOC Supplementary services are applicable
on a per call basis or for all calls. Values: 1 (on a per call basis the default) or 2 (for all calls).
•
AOCDefaultTariffId—Allows configuration of the default tariff ID to be applied when AOCInvokeType is
configured for all calls (that is, AOCInvokeType = 2). Value range: 1 (default) through 9999.
•
Custgrpid—Customer group ID.
•
NPA—Numbering plan area associated with the trunk group.
•
Cotpercentage—Continuity test percentage. Valid value is between 0 and 100.
•
ringNoanswer—Indicates the time, in seconds, ringing is allowed to occur. Valid value is an integer
between 0 and 255 seconds.
•
Ta1TimePeriod—Period of time before credit expiration that the SCP is notified. Valid values are between
1 and 180 seconds.
•
Ta2TimePeriod—Period of time before credit expiration that a warning tone/announcement is played.
Valid values are between 1 and 180 seconds.
•
Ta3TimePeriod— Period of time before credit expiration that the SSF waits for an SCP response. Valid
values are between 1 and 180 seconds.
•
ExpiryWarnToneType— String value of the expiration warning tone. Valid values are any MGCP event
names.
•
ExpiryWarnToneDur—Duration of the expiration warning. Valid values are between 1 and 5 seconds.
•
Subscribenotifysupport—Enter one of the following:
– 0 disables the subscribe/notify method (default).
– 1 enables the subscribe/notify method.
•
Unsolicitednotifymethod—Enter one of the following:
– 0 disables the unsolicited notify method (default).
– 1 enables the unsolicited notify method.
•
Mineventsubscribeduration—Enter an integer within the range 40 milliseconds (default) to 3600
milliseconds.
•
Maxsubscriptionduration—Enter an integer within the range 0 milliseconds (default) to 3600
milliseconds.
•
Sipmimebodysupport—Specifies the type of data processing required. Enter one of the following:
– 0—None (default).
– 1—SIP-T supported. All trunk groups on the SIP-T call must have this value selected.
– 2—SIP-GTD supported. All trunk groups on the SIP-GTD call must have this value selected.
– 3—Only SIP-I supported on the incoming trunk group, SIP and SIP-I supported on the outgoing trunk
group.
– 4—SIP and SIP-I supported on both the incoming and outgoing trunk groups.
•
Gtdcaptypeprop—Points to a subset of GTD parameters.
– t0—No GTD parameter string.
– Any other string points to an entry in the gtdParam.dat file.
•
Gtdmsgfmt—Specifies the GTD message format mode. Enter one of the following:
– c—Compact mode (default).
– v—Verbose mode.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-86
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
TRNKGRPPROP—Trunk Group Properties
Input
Description:
•
Isuptransparency disable—Enables disabling of the ISUP transparency feature for a particular trunk
group. Enter one of the following:
– 1—True; ISUP transparency feature is disabled (default).
– 0—False; ISUP transparency feature is enabled.
•
Isuptransearlybackwarddisabled—Specifies whether the egress Cisco PGW 2200 Softswitch is to send
an early backward message immediately after receiving the call setup message with GTD information
about the outgoing protocol variant. Enter one of the following:
– 0—Enable (default)
– 1—Disable
•
OD32digitsupport—Enter one of the following:
– 1 enables overdecadic and 32-digit support. This is the default.
– 0 disables overdecadic and 32-digit support.
•
Populatesdpinfoincdr—Enables or disables the extraction of SDP information from SDP. Extracted SDP
information is placed in call detail records (CDRs). Enter one of the following:
– 0—Disable SDP information extraction (default).
– 1—Enable SDP information extraction.
•
InSessionTimer—Specifies the maximum session time (in milliseconds) allowed for a SIP call originated
by the Cisco PGW 2200 Softswitch. This value affects performance. Enter any value greater than 0. The
default is 1800000 milliseconds.
•
OutSessionTimer—Specifies the maximum session time (in milliseconds) allowed for a SIP call
terminated by the Cisco PGW 2200 Softswitch. This value affects performance. Enter any value greater
than 0. The default is 1800000 milliseconds.
•
Defaultpn—Specifies a default presentation number for the incoming trunk group. Enter an overdecadic
digit string consisting of 1 through 20 digits.
If this property is not specified, the default is NULL.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-87
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
TRNKGRPPROP—Trunk Group Properties
•
Defaultpnnoa—Specifies the default presentation number NOA value. The default is 0. Enter one of the
following:
– 1—NOA_NONE
– 2—NOA_UNKNOWN
– 3—NOA_SUBSCRIBER
– 4—NOA_NATIONAL
– 5—NOA_INTERNATIONAL
– 6—NOA_NETWORK
– 7—NOA_MERIDIAN
– 8—NOA_ABBR
– 9—NOA_UNIQUE_3DIG_NAT_NUM
– 10—NOA_ANI
– 11—NOA_NO_ANI_RECD
– 12—NOA_NON_UNIQUE_SUBSCRIBER
– 13—NOA_NON_UNIQUE_NATIONAL
– 14—NOA_NON_UNIQUE_INTERNATIONAL
– 15—NOA_OPRREQ_TREATED
– 16—NOA_OPRREQ_SUBSCRIBER
– 17—NOA_OPRREQ_NATIONAL
– 18—NOA_OPRREQ_INTERNATIONAL
– 19—NOA_OPRREQ_NO_NUM
– 20—NOA_CARRIER_NO_NUM
– 21—NOA_950_CALL
– 22—NOA_TEST_LINE_CODE
– 23—NOA_INT_INBOUND
– 24—NOA_NAT_OR_INTL_CARRIER_ACC_CODE_INC
– 25—NOA_CELL_GLOBAL_ID_GSM
– 26—NOA_CELL_GLOBAL_ID_NMT_900
– 27—NOA_CELL_GLOBAL_ID_NMT_450
– 28—NOA_CELL_GLOBAL_ID_AUTONET
– 29—NOA_PORTED_NUMBER
– 30—NOA_PISN_SPECIFIC_NUMBER
– 31—NOA_UK_SPECIFIC_NUMBER
– 32—NOA_SPARE
– 33—NOA_MCI_VNET
– 34—NOA_INTERNATIONAL_OPR_TO_OPR_OUTSIDE_WZI
– 35—NOA_INTERNATIONAL_OPR_TO_OPR_INSIDE_WZI
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-88
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
TRNKGRPPROP—Trunk Group Properties
– 36—NOA_DIRECT_TERMINATION_OVERFLOW
– 37—NOA_ISN_EXTENDED_INTERNATIONAL_TERMINATION
– 38—NOA_TRANSFER_ISN_TO_ISN
– 39—NOA_CREDIT_CARD
– 40—NOA_DEFINED_IN_SSUTR
– 41—NOA_DEFINED_IN_SSUTR2
– 42—RESERVED
– 43—NOA_DISCARDED
•
Defaultpnnpi—Specifies the default presentation number NPI value. The default is 0. Enter one of the
following:
– 0—Not used
– 1—NPI_NONE
– 2—NPI_E164
– 3—NPI_DATA
– 4—NPI_TELEX
– 5—NPI_PNP
– 6—NPI_NATIONAL
– 7—NPI_TELEPHONY
– 8—NPI_MARITIME_MOBILE
– 9—NPI_LAND_MOBILE
– 10—NPI_ISDN_MOBILE
•
Defaultpnpres—Specifies the default presentation number value. The default is 0. Enter one of the
following:
– 0—Not used
– 1—PRES_NO_INDICATION
– 2—PRES_ALLOWED
– 3—PRES_RESTRICT
– 4—PRES_UNAVAIL
•
Enableipscreening—Instructs the incoming trunk group to select dial plan based on IP address, source ID,
and CLI prefix tables. The default is 0. Enter one of the following:
– 0—No dial plan lookup
– 1—Requires dial plan lookup
•
Sipipsource—Instructs MDL to use IP packet source address or IP address from SDP in INVITE message
to select the dial plan for SIP calls.
– 0—IP packet source address
– 1—IP address from SDP
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-89
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
TRNKGRPPROP—Trunk Group Properties
•
id—A string of 1–8 alphanumeric characters. The default value is 00000000. An absence of property is
treated as if no VPN ID were present.
•
int—Valid property values are 0–8. The default value is 0. Absence of property is treated as if no VPN
on-net table number were present.
– 1—Dictates that completely transparent operation is required or the call does not complete.
– 2—Sets to feature transparency preferred by a nontransparent destination. Can be used if necessary
to complete the call.
– 3—Sets to feature transparency preferred by a nontransparent destination. Can be used if necessary
to complete the call.
– 4—Sets to feature transparency preferred by a nontransparent destination. Can be used if necessary
to complete the call.
– 5—Sets to indicate that the attempted feature is removed from the onward routed call, and the
indicator is informed of this.
– 6—Sets to release a feature call.
– 7—Sets to release a feature call.
– 8—Sets to remove the feature string and continue.
•
int—Valid property values. Default value is 0.
– 0 = Feature Transparency enabled
– 1= Feature Transparency disabled
•
adigitccrm—The matching digits to remove from the A-number. This parameter was added in software
Release 9.7(3).
•
DtmfCap-Sets the DTMF capability of the specified egress trunk group. This parameter was added in
software Release 9.7(3). Valid values are:
– 0—Ignore DTMF capability
– 1—RFC 2833 DTMF capability
– 2—Out of band DTMF capability
•
GWDefaultCodecString—Enables the IOCC-MGCP or IOCC-H248 to send the ordered series of codec
choices separated by semicolons. Values are: NULL, G.711u, G.711a, G.726-32, G.726-24, G.726-16,
G.729, G.729a, G.729b, G.729b-L, G.723.1-H, G.723.1-L, G.723.1a-L, G.GSM-F, G.GSM-H, or
G.GSM-eF. String length 1 to 140. This parameter was added in software Release 9.7(3).
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-90
OL-1116-24
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
TRNKGRPPROP—Trunk Group Properties
Example:
The MML command shown in the following example provisions INAP properties:
mml> prov-add:trnkgrpprop:name="1000",custgrpid="V123",npa="703", cotpercentage="10",
ringnoanswer="200",Ta1TimePeriod="40",Ta2TimePeriod="50",
Ta3TimePeriod="5",ExpiryWarnToneType="TEST",ExpiryWarnToneDur="3"
The MML command shown in the following example provisions the trunk group properties:
mml> prov-add:trnkgrpprop:name=”3333”,SubscribeNotifySupport=1, UnsolicitedNotifyMethod=1,
MinEventSubscribeDuration=200,MaxSubscriptionDuration=3600,custgrpid=”1111”,
sipmimebodysupport=1,gtdcaptypeprop=”t3”,gtdmsgfmt=”c”,isuptransearlybackwarddisabled=0,
od32digitsupport=”1”, CustomerVPNid ="ABIGBIZ1", CustomerVPNOnNetTblNum ="2",
CustomerVPNOffNetTblNum ="5",FeatureTransparencyDisabled =”2”, CallForwardRerouteDisabled ="1"
The MML command shown in the following example retrieves the state of trunk group properties for a specific
trunk group.
mml> prov-rtrv:trnkgrpprop:name=”8000”
MGC-01 - Media Gateway Controller 2005-09-22 11:22:27.176 EDT
M RTRV
''session=adigitccrm1:trnkgrpprop''
/*
ACCRespCatName = default
ACCRespCntlInhibit = 0
ACLDur = 5
ADigitCCPrefix = 0
ADigitCCrm = 12345
AInternationalPrefix = NULL
...
...
...
The MML command shown in the following example sets the specified egress trunk group DTMF capability:
mml> prov-add:trnkgrpprop:name="1111",DtmfCap="1"
The MML command shown in the following example provisions CODEC G.723 on a trunk group:
mml> prov-add:trnkgrpprop:name="1100",custgrpid="1111", GWDefaultCodecString="G723"
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-91
Chapter 1
PROV: Commands for Provisioning Signaling and Trunking Components
TRNKGRPPROP—Trunk Group Properties
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-92
OL-1116-24
CH A P T E R
1
NUMAN: Commands for Provisioning Dial Plan
Components
Revised: Aug 30, 2011, OL-1116-24
This chapter describes the Man-Machine Language (MML) commands for provisioning the dial plan on
the Cisco PGW 2200 Softswitch Release 9. After the introductory section, “NUMAN-ADD—Add Dial
Plan Element” section on page 1-1, the commands for each dial plan component are grouped together,
and the information is displayed in alphabetical order by component.
Note
numan = Number analysis
Tip
The numan-add command adds (creates) an instance of a component.
The numan-dlt command deletes (removes) an instance of a component.
The numan-ed command edits (modifies) an instance of a component.
The numan-rtrv command retrieves (displays) information about one or more instances of a component.
NUMAN-ADD—Add Dial Plan Element
Purpose:
Adds an element to a dial plan table.
Syntax:
numan-add:<comp>:custgrpid=”<cust group ID>”,<param name>=<param value>,...
Input
Description:
•
comp—The component being added to the dial plan.
•
custgrpid—Customer group ID.
See Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide for information about how to use the
NUMAN-ADD command for dial plan provisioning and for a description of components, parameter names,
parameter descriptions, and parameter values.
Example:
The MML command shown in the following example is used in building a digit modification table:
Comments:
Performance Impact Category: B, C. Impact depends on the size of the dial plan.
mml> numan-add:digmodstring:custgrpid=”T001”,name=”digmod1”,digstring=”703484”
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-1
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
ABLACK—A-digit Tree Black List
ABLACK—A-digit Tree Black List
Purpose:
Provision the A-digit tree black list.
Syntax:
numan-add:ablack:custgrpid=”custgrpid”,cli=”cli”
numan-dlt:ablack:custgrpid=”custgrpid”,cli=”cli”
numan-rtrv:ablack:custgrpid=”custgrpid”,cli=”cli”
Input
Description:
Example:
•
custgrpid—Customer group ID. ID of an existing dial plan.
•
cli—Calling line identifier.
The MML command shown in the following example adds an ABLACK list entry and the required parameters
to the dial plan:
mml> numan-add:ablack:custgrpid="t100",cli="919472432"
ACHGORIGIN—A-number Charge Origin
Purpose:
Provision the A-number charge origin.
Syntax:
numan-add:achgorigin:custgrpid=”custgrpid”,cli=”cli”,corigin=”call origin”
numan-dlt:achgorigin:custgrpid=”custgrpid”,cli=”cli”
numan-ed:achgorigin:custgrpid=”custgrpid”,cli=”cli”,corigin=”call origin”
numan-rtrv:achgorigin:custgrpid=”custgrpid”,cli=”cli”
Input
Description:
Example:
•
custgrpid—Customer group ID. ID of an existing dial plan.
•
cli—Calling line identifier.
•
corigin—Call origin. Integer range 1 to 9999.
The MML command shown in the following example inserts an entry in the Charge Origin list:
mml> numan-add:achgorigin:custgrpid="t001",cli="6123456789",corigin=1
The MML command shown in the following example changes the previous CLI entry, "6123456789," to
"02087568000" :
mml> numan-ed:achgorigin:custgrpid="t001",cli="02087568000",corigin=1
The MML command shown in the following example deletes the existing entry from the Charge Origin list:
mml> numan-dlt:achgorigin:custgrpid="t001",cli="02087568000"
The MML command shown in the following example retrieves the specified entry from the Charge Origin list:
mml> numan-rtrv:achgorigin:custgrpid="t001",cli="02087568000"
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-2
OL-1116-24
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
ADIGTREE—A-digit Tree
ADIGTREE—A-digit Tree
Purpose:
Provision the A-digit tree table.
Syntax:
numan-add:adigtree:custgrpid=”custgrpid”,callside=”callside”,digitstring=”digitstring”,
setname=”setname”
numan-dlt:adigtree:custgrpid=”custgrpid”,callside=”callside”,digitstring=”digitstring”,
partial=”YES|NO”
numan-ed:adigtree:custgrpid=”custgrpid”,callside=”callside”,digitstring=”digitstring”,
setname=”setname”
numan-rtrv:adigtree:custgrpid=”custgrpid”,callside=”callside”,digitstring=”digitstring”
numan-rtrv:adigtree:“all“
Input
Description:
•
custgrpid—Customer group ID. ID of an existing dial plan.
•
call side—Indicates if the call side is originating or terminating.
•
digitstring—All the digits in a calling number or called number. Cannot use with NEXTNODE, DIGIT,
or INDEX.
•
setname—MML name of the result set.
•
partial—Specify whether to delete only specified digit string from a digit tree or to delete all partial
matching digit trees. Valid values:
– YES—Delete only the specified number from the digit tree.
– NO—Delete all of the numbers starting with a specified digit string from a digit tree.
Note
Example:
For the numan-dlt:adigtree and the numan-dlt:bdigtree commands, use the partial parameter carefully.
Since Release 9.7(3) S30P30, the partial parameter is mandatory. You have to specify it YES or NO
explicitly. When you are not specifying partial parameter, command returns with error.
The MML command shown in the following example adds an A-number digit tree:
mml> numan-add:adigtree:custgrpid="5555",callside="originating",digitstring="301",
setname="setloc1"
ANNOUNCEMENT—Tone and Announcement Table
Purpose:
Provision the tone and announcement table.
Syntax:
numan-add:announcement:annid=”annid”,gwtype=”gwtype”,playDuration=”playDuration”,
repeat=”repeat”,interval=”interval”,locationstring=”locationstring”
numan-dlt:announcement:annid=”annid”,gwtype=”gwtype”
numan-ed:announcement:annid=”annid”,gwtype=”gwtype”,playDuration=”playDuration”,
repeat=”repeat”,interval=”interval”,locationstring=”locationstring”
numan-rtrv:announcement:annid=”annid”,gwtype=”gwtype”
numan-rtrv:announcement:”all”
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-3
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
ANOA—A Nature of Address
Input
Description:
Example:
•
annid—Announcement ID.
•
gwtype—Value that is part of an enumerated set identifying the gateway type.
•
playDuration—Intended duration of play (seconds).
•
repeat—Number of times to play announcement.
•
interval—The silence interval duration between playing repeats (milliseconds).
•
locationstring—Indicate to the gateway the audio file to be loaded for playing.
The MML command shown in the following example adds an announcement:
mml> numan-add:announcement:annid=123,gwtype="AS5400",playduration="30",repeat="2",
interval="3",locationstring="xyz.aud"
The MML command shown in the following example edits an announcement:
mml> numan-ed:announcement:annid=123,gwtype="AS5400",locationstring="welcome.aud"
The MML command shown in the following example deletes an announcement:
mml> numan-dlt:announcement:annid=123,gwtype="AS5400"
The MML command shown in the following example retrieves an announcement:
mml> numan-rtrv:announcement:annid=123,gwtype="AS5400"
ANOA—A Nature of Address
Purpose:
Provision the calling number Nature of Address (NOA) table.
Syntax:
numan-add:anoa:custgrpid=”custgrpid”,noavalue=”noavalue”,npiblock=”npiblock”,setname=”setname”
numan-dlt:anoa:custgrpid=”custgrpid”,noavalue=”noavalue”
numan-ed:anoa:custgrpid=”custgrpid”,noavalue=”noavalue”,npiblock=”npiblock”,setname=”setname”
numan-rtrv:anoa:custgrpid=”custgrpid”,noavalue=”noavalue”
numan-rtrv:anoa:”all”
Input
Description:
Example:
•
custgrpid—Customer group ID. ID of an existing dial plan.
•
noavalue—The NOA value.
•
npiblock—The NPI block value.
•
setname—MML name of the result set.
The MML command shown in the following example adds a NOA value and the required parameters to the
dial plan. For any NOA value that is configured, either an NPI block or a result set must be specified.
mml> numan-add:anoa:custgrpid="t100",noavalue=3,npiblock=1
mml> numan-add:anoa:custgrpid="t001",noavalue=4,setname="set3"
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-4
OL-1116-24
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
ANPI—A Number Plan Indicator
ANPI—A Number Plan Indicator
Purpose:
Provision the calling number Numbering Plan Indicator (NPI) table.
Syntax:
numan-add:anpi:custgrpid=”custgrpid”,npiblock=”npiblock”,blockvalue=”blockvalue”,
setname=”setname”
numan-dlt:anpi:custgrpid=”custgrpid”,npiblock=”npiblock”
numan-ed:anpi:custgrpid=”custgrpid”,npiblock=”npiblock”,blockvalue=”blockvalue”,
setname=”setname”
numan-rtrv:anpi:custgrpid=”custgrpid”,npiblock=”npiblock”
numan-rtrv:anpi:”all”
Input
Description:
Example:
•
custgrpid—Customer group ID. ID of an existing dial plan.
•
npiblock—The NPI block.
•
blockvalue—The NPI block value.
•
setname—MML name of the result set.
The MML command shown in the following example adds an NPI with a CustGrpID of "t001," an NPI block
of 1, a received NPI block value of 108, and a result set name of "set1," to the dial plan:
mml> numan-add:anpi:custgrpid="t001",npiblock=101,blockvalue=1,setname="set1"
ANUMDPSEL—A-number Dial Plan Selection
Purpose:
Provision the A-number dial plan selection list.
Syntax:
numan-add:anumdpsel:custgrpid=”custgrpid”,cli=”cli”,newdp=”newdp”
numan-dlt:anumdpsel:custgrpid=”custgrpid”,cli=”cli”
numan-ed:anumdpsel:custgrpid=”custgrpid”,cli=”cli”,newdp=”newdp”
numan-rtrv:anumdpsel:custgrpid=”custgrpid”,cli=”cli”
Input
Description:
Example:
•
custgrpid—Customer group ID. ID of an existing dial plan.
•
cli—Calling line identifier.
•
newdp—New dial plan customer group ID. ID of an existing dial plan.
The MML command shown in the following example inserts the A-number dial plan dp07 into the dial plan
selection list:
mml> numan-add:anumdpsel:custgrpid="t001",cli="1234567",newdp="dp07"
AWHITE—A-digit Tree White List
Purpose:
Provision the A-digit tree white list.
Syntax:
numan-add:awhite:custgrpid=”custgrpid”,cli=”cli”
numan-dlt:awhite:custgrpid=”custgrpid”,cli=”cli”
numan-rtrv:awhite:custgrpid=”custgrpid”,cli=”cli”
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-5
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
BBLACK—B-digit Tree Black List
Input
Description:
Example:
•
custgrpid—Customer group ID. ID of an existing dial plan.
•
cli—Calling line identifier.
The MML command shown in the following example adds an AWHITE list and the required parameters to the
dial plan:
mml> numan-add:awhite:custgrpid="t100",cli="919472123"
BBLACK—B-digit Tree Black List
Purpose:
Provision the B-digit tree black list.
Syntax:
numan-add:bblack:custgrpid=”custgrpid”,cli=”cli”,svcname=”svcname”
numan-dlt:bblack:custgrpid=”custgrpid”,cli=”cli”,svcname=”svcname”
numan-rtrv:bblack:custgrpid=”custgrpid”,cli=”cli”,svcname=”svcname”
Input
Description:
Example:
•
custgrpid—Customer group ID. ID of an existing dial plan.
•
cli—Calling line identifier.
•
svcname—MML name of the previously defined service.
The MML command shown in the following example adds an BBLACK list entry and the required parameters
to the dial plan:
mml> numan-add:bblack:custgrpid="t100",cli="9194724321",svcname="FreePhone"
BC—Bearer Capability
Purpose:
Provision the bearer capability table entries.
Syntax:
numan-add:bc:custgrpid=”custgrpid”,name=”name”,ocval=”ocval”
numan-dlt:bc:custgrpid=”custgrpid”,name=”name”
numan-ed:bc:custgrpid=”custgrpid”,name=”name”,ocval=”ocval”
numan-rtrv:bc:custgrpid=”custgrpid”,name=”name”|,”all”
Input
Description:
Example:
•
custgrpid—Customer group ID. ID of an existing dial plan.
•
name—Bearer capability name.
•
ocval—Octet coding value.
The MML command shown in the following example adds the BC table entry:
mml> numan-add:BC:cusgrpid="dpl1",name="bc-04",ocval="9090A3"
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-6
OL-1116-24
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
BDIGTREE—B-digit Tree
BDIGTREE—B-digit Tree
Purpose:
Provision the B-digit tree entries.
Syntax:
numan-add:bdigtree:custgrpid=”custgrpid”,callside=”callside”,digitstring=”digitstring”,
setname=”resultset name”
numan-dlt:bdigtree:custgrpid=”custgrpid”,callside=”callside”,digitstring=”digitstring”,
partial=”YES|NO”
numan-ed:bdigtree:custgrpid=”custgrpid”,callside=”callside”,digitstring=”digitstring”,
setname=”resultset name”
numan-rtrv:bdigtree:custgrpid=”custgrpid”,callside=”callside”,digitstring=”digitstring”
numan-rtrv:bdigtree:”all”
Input
Description:
•
custgrpid—Customer group ID. ID of an existing dial plan.
•
callside—Call side. Values: originating (origination side) and terminating (termination side.
•
digitstring—Digit string. String length 1 to 32.
•
setname—Name of an existing result set.
•
partial—Specify whether to delete only specified digit string from a digit tree or to delete all partial
matching digit trees. Valid values:
– YES—Delete only the specified number from the digit tree.
– NO—Delete all of the numbers starting with a specified digit string from a digit tree.
Note
For the numan-dlt:adigtree and the numan-dlt:bdigtree commands, use the partial parameter carefully.
Since Release 9.7(3) S30P30, the partial parameter is mandatory. You have to specify it YES or NO
explicitly. When you are not specifying partial parameter, command returns with error.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-7
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
BDIGTREE—B-digit Tree
Example:
The MML command shown in the following example does not specify the partial parameter and returns an
error:
mml> numan-dlt:bdigtree:custgrpid="1111",callside="originating",digitstring="2"
MGC-01 - Media Gateway Controller 2010-01-11 05:40:17.940 EST M DENY
SROF
"bdigtree:Partial value must be YES or NO It is manadatory Param"
/* Status, Requested Operation Failed on the component */
;
The MML command shown in the following example deletes only the number 23 from the B digit tree within
the dial plan 1111:
mml> numan-dlt:bdigtree:custgrpid="1111",callside="originating",digitstring="23",partial="YES"
MGC-01 - Media Gateway Controller 2010-01-11 05:46:40.670 EST M COMPLD
"bdigtree"
;
mml> numan-rtrv:bdigtree:custgrpid="1111",callside="originating",digitstring="2",
setname="rset235"
MGC-01 - Media Gateway Controller 2010-01-11 05:47:26.119 EST M RTRV
"session=sip_provision_alok:bdigtree"
/*
digitString
callSide
-----------------2
originating
PointInDigitString
-----------------235
ResultSetName
------------rset235
resultName
resultType
dw1
dw2
dw3
dw4
nextResult
-----------------------------------rtab235
ROUTE
rlst235
0
0
0
0
*/
The MML command shown in the following example deletes all numbers starting with a “23” digit string from
the B digit tree within the dial plan 1111:
mml> numan-dlt:bdigtree:custgrpid="1111",callside="originating",digitstring="23",partial="NO"
MGC-01 - Media Gateway Controller 2010-01-11 05:49:48.986 EST M COMPLD
"bdigtree:WARNING: All partial matching digit tree are removed"
;
mml> numan-rtrv:bdigtree:custgrpid="1111",callside="originating",digitstring="23",
setname="rset235"
MGC-01 - Media Gateway Controller 2010-01-11 05:50:28.378 EST M DENY
SROF
"session=sip_provision_alok:bdigtree:The digit string:23:is not currently configured"
/* Status, Requested Operation Failed on the component */
;
mml> numan-rtrv:bdigtree:custgrpid="1111",callside="originating",digitstring="235",
setname="rset235"
MGC-01 - Media Gateway Controller 2010-01-11 05:50:38.119 EST M DENY
SROF
"session=sip_provision_alok:bdigtree:The digit string:235:is not currently configured"
/* Status, Requested Operation Failed on the component */
Comments:
As a convenience, for the adigtree and the bdigtree components, the "NUMAN-DLT" command allows you to
delete all of the numbers starting with a digit string.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-8
OL-1116-24
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
BNOA—B Nature of Address
BNOA—B Nature of Address
Purpose:
Provision the called number NOA table.
Syntax:
numan-add:bnoa:custgrpid=”custgrpid”,noavalue=”noavalue”,npiblock=”npiblock”,setname=”setname”
numan-dlt:bnoa:custgrpid=”custgrpid”,noavalue=”noavalue”
numan-ed:bnoa:custgrpid=”custgrpid”,noavalue=”noavalue”,npiblock=”npiblock”,setname=”setname”
numan-rtrv:bnoa:custgrpid=”custgrpid”,noavalue=”noavalue”
numan-rtrv:bnoa:”all”
Input
Description:
Example:
•
custgrpid—Customer group ID. ID of an existing dial plan.
•
noavalue—The NOA value.
•
npiblock—The NPI block value.
•
setname—MML name of the result set.
The MML command shown in the following example adds a NOA value and the required parameters to the
dial plan:
mml> numan-add:bnoa:custgrpid="5555",noavalue=4,setname="setloc3"
BNPI—B Number Plan Indicator
Purpose:
Provision the called number NPI table.
Syntax:
numan-add:bnpi:custgrpid=”custgrpid”,npiblock=”npiblock”,blockvalue=”blockvalue”,
setname=”setname”
numan-dlt:bnpi:custgrpid=”custgrpid”,npiblock=”npiblock”
numan-ed:bnpi:custgrpid=”custgrpid”,npiblock=”npiblock”,blockvalue=”blockvalue”,
setname=”setname”
numan-rtrv:bnpi:custgrpid=”custgrpid”,npiblock=”npiblock”,”all”
Input
Description:
Example:
•
custgrpid—Customer group ID. ID of an existing dial plan.
•
npiblock—The NPI block.
•
blockvalue—The NPI block value.
•
setname—MML name of the result set.
The MML command shown in the following example adds an NPI with a CustGrpID of "T002," an NPI block
of 1, and a result set name of "VpnCust1," to the dial plan:
mml> numan-add:bnpi:custgrpid="T002",npiblock=1,setname="VpnCust1"
BWHITE—B-digit Tree White List
Purpose:
Provision the B-digit tree white list.
Syntax:
numan-add:bwhite:custgrpid=”custgrpid”,cli=”cli”,svcname=”svcname”
numan-dlt:bwhite:custgrpid=”custgrpid”,cli=”cli”,svcname=”svcname”
numan-rtrv:bwhite:custgrpid=”custgrpid”,cli=”cli”,svcname=”svcname”
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-9
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
CAUSE—Cause Table (Release 9.7(3))
Input
Description:
Example:
•
custgrpid—Customer group ID. ID of an existing dial plan.
•
cli—Calling line identifier.
•
svcname—MML name of the previously defined service.
The MML command shown in the following example adds an BWHITE list and the required parameters to the
dial plan:
mml> numan-add:bwhite:custgrpid="t100",cli="9194721234",svcname="FreePhone"
CAUSE—Cause Table (Release 9.7(3))
Purpose:
Add—Adds one entry to the cause table.
Delete—Deletes an element from a dial plan table.
Edit—Edits one entry in the cause table. The parameters, locationblock and setname, cannot be provisioned
the same time.
Syntax:
Input
Description:
numan-add:cause:custgrpid="customer group ID",causevalue="x", locationblock=x
numan-add:cause:custgrpid="customer group ID",causevalue="x",setname="ResultSetName"
numan-dlt:cause:custgrpid=”cust group ID”
numan-ed:cause:custgrpid="Natl",causevalue=0,locationblock=1
numan-ed:cause:custgrpid="Natl",causevalue=3,setname="chCause"
•
custgrpid—The customer group ID, which is a previously defined 4-digit alphanumeric string.
•
name—The result table index name.
•
causevalue—The cause value. Integer, where x = 1–173. The value 0 is added to enable using a wildcard
for the cause value. A cause value of 0 is the default cause value.
•
locationblock—The location block number.
•
setname—The result set name.
Note
The locationblock and the setname cannot be provisioned the same time.
Output
Description:
Varies.
Examples:
The MML command shown in the following example deletes an element from a dial plan table:
mml> numan-dlt:resultset:custgrpid="T001",name="ra4"
mml> numan-ed:cause:custgrpid="Natl",causevalue=0,locationblock=1
mml> numan-ed:cause:custgrpid="Natl",causevalue=3,setname="chCause"
Comments:
Performance Impact Category: A
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-10
OL-1116-24
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
CLIIPADDRESS—Calling Line Identity IP Address
CLIIPADDRESS—Calling Line Identity IP Address
Purpose:
Add, delete, or edit a Calling Line Identity (CLI) IP address entry.
Note
Syntax:
Input
Description:
Example:
Provision CLIPREFIX before CLIIPADDRESS and H323IDDIVFROM. See the
“CLIPREFIX—Calling Line Identity Prefix” section on page 1-11.
numan-add:cliipaddress:custgrpid=”custgrpID”,ipaddr=”IPaddress”,subnetmask=”IPaddress”,
clisetname=”name”
numan-dlt:cliipaddress:custgrpid=”custgrpID”,ipaddr=”IPaddress”
numan-ed:cliipaddress:custgrpid=”custgrpID”,ipaddr=”IPaddress”,subnetmask=”IPaddress”,
clisetname=”name”
•
Custgrpid—Customer group ID. Enter a four-character alphanumeric string.
•
Ipaddr—IP address for the CLI, or DEFAULT.
•
Subnetmask—Subnet mask address for the CLI. The default is 255.255.255.255.
•
Clisetname—Name of the CLI prefix set. Enter an alphanumeric string up to four characters in length.
mml> numan-add:cliipaddress:custgrpid=”T002”,ipaddr=”10.2.2.3”,subnetmask=”255.255.255.0”,
clisetname=”ty”
mml> numan-dlt:cliipaddress:custgrpid=”T002”,ipaddr=”default”
mml> numan-ed:cliipaddress:custgrpid=”T002”,ipaddr=”default”,subnetmask=”255.255.255.0”,
clisetname=”ty”
CLIPREFIX—Calling Line Identity Prefix
Purpose:
Add, delete, or edit a Calling Line Identity (CLI) prefix entry.
Note
Syntax:
Input
Description:
Example:
Provision CLIPREFIX before CLIIPADDRESS and H323IDDIVFROM.
numan-add:cliprefix:clisetname=”name”,cliprefix=”value string”,custgrpid=”id”
numan-dlt:cliprefix:clisetname=”name”,cliprefix=”value string”
numan-ed:cliprefix:clisetname=”name”,cliprefix=”value string”,custgrpid=”id”
•
Clisetname—Name of the CLI prefix set. Enter an alphanumeric string up to 4 characters in length.
•
Cliprefix—Enter a CLI prefix up to 20 overdecadic digits in length or DEFAULT.
•
Custgrpid—Customer group ID. Enter a four-character alphanumeric string.
mml> numan-add:cliprefix:clisetname=”x”,cliprefix=”1844260”,custgrpid=”csco”
mml> numan-dlt:cliprefix:clisetname=”x”,cliprefix=”default”
mml> numan-ed:cliprefix:clisetname=”x”,cliprefix=”default”,custgrpid=”csco”
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-11
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
CPC—Calling Party Category
CPC—Calling Party Category
Purpose:
Add—Provisions the calling party category (CPC).
Delete—Deletes elements in the calling party category (CPC).
Edit—Edits elements in the calling party category (CPC).
Syntax:
Input
Description:
Example:
numan-add:cpc:custgrpid=”customer group id”,cpcvalue=number,setname=”result set name”
numan-dlt:cpc:custgrpid=”customer group id”,cpcvalue=number
numan-ed:cpc:custgrpid=”customer group id”,cpcvalue=number,setname=”result set name”
•
custgrpid—The customer identifier (customer group ID). It is a four-character alphanumeric field and is
not validated by MML.
•
cpcvalue—Enter a value in the range 0 to 255. There is no default value.
•
setname—Name of the result set.
The MML command shown in the following example provisions the CPC:
mml> NUMAN-ADD:cpc:custgrpid=”T001”,cpcvalue=14,setname=”payphone”
The MML command shown in the following example deletes the CPC value for customer group T001:
mml> NUMAN-DLT:cpc:custgrpid=”T001”,cpcvalue=”3”
The MML command shown in the following example edits the CPC value:
mml> NUMAN-ED:cpc:custgrpid=”T001”,cpcvalue=10,setname=”payphone”
CRPTMESG—Call Reporting Message (Release 9.7(3))
Purpose:
Add, delete, edit, or retrieve a customized Call Reporting message.
Syntax:
numan-add:crptmesg:index=1,msgstr="Emergency Call"
numan-dlt:crptmesg:index=1,msgstr=”Fire Alarm”
numan-ed:crptmesg:index=1,msgstr=”Fire Alarm”
numan-rtrv:crptmesg:"all"
numan-rtrv:crptmesg:index=1
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-12
OL-1116-24
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
CUSTOMERVPNID—Customer VPN ID
Input
Description:
Example:
•
index—Identifies the defined string. The Cisco PGW 2200 Softswitch associates the index with the
corresponding message string when it sends a trap to the SNMP manager.
•
msgstr—The character string that constitutes the customized message.
The following sample MML command adds the customized message, “Emergency Call”:
mml>numan-add:crptmesg:index=1,str="Emergency Call"
The following sample MML command deletes a customized message:
mml> numan-dlt:crptmesg:index=1,msgstr=”Fire Alarm”
The following sample MML command modifies a customized message.
mml> numan-ed:crptmesg:index=1,msgstr=”Fire Alarm”
The following sample MML command retrieves all customized messages that have been created by the
operator issuing the numan-add:crptmesg MML command.
mml> numan-rtrv:crptmesg:"all"
The following sample MML command retrieves the customized message associated with the specified index.
mml> numan-rtrv:crptmesg:index=1
CUSTOMERVPNID—Customer VPN ID
Purpose:
Provision the B-digit tree white list.
Syntax:
numan-add:customervpnid:custgrpid=”custgrpid”,name=”vpn ID”
numan-dlt:customervpnid:custgrpid=”custgrpid”,name=”vpn ID”
numan-rtrv:customervpnid:custgrpid=”custgrpid”,name=”vpn ID”
Input
Description:
Example:
•
custgrpid—Customer group ID. ID of an existing dial plan.
•
name—Customer VPN ID (8-digit alphanumeric character string).
The MML command shown in the following example provisions the customer VPN ID table:
mml> numan-add:customervpnid:custgrpid="T002",name="Abbey"
DEFRESULTSET—Default Result Set
Purpose:
Provision the default result set.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-13
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
DESTTRANS—Destination Translation Table (Release 9.8(1))
Syntax:
Input
Description:
numan-add:defresultset:custgrpid=”custgrpid”,resulttype=”resulttype”,dw1=”dataword1”,
dw2=”dataword2”
numan-dlt:defresultset:custgrpid=”custgrpid”
numan-ed:defresultset:custgrpid=”custgrpid”,resulttype=”resulttype”,dw1=”dataword1”,
dw2=”dataword2”
numan-rtrv:defresultset:custgrpid=”custgrpid”
•
custgrpid—Customer group ID. ID of an existing dial plan.
•
resulttype—Result type. Valid values: BLACKLIST, CAUSE, and ROUTE.
•
dw1—First data word.
– For resulttype = BLACKLIST, dw1 = screening criteria. Valid values: 1—CLI, 2—Dial address,
3—CPC, 4—NOA, 5—TMR, 6—TNS.
– For resulttype = CAUSE, dw1 = cause code. Valid values: 0 (do not change cause value received from
line in CAUSE analysis); 1–300 (cause value,).
– For resulttype = ROUTE, dw1 = route list.
•
dw2—Second data word.
– For resulttype = CAUSE, dw2 = location value. Valid values: 0 (use default value if not present in
Line Msg, else use Line Msg); 1–15 (use provisioned number).
DESTTRANS—Destination Translation Table (Release 9.8(1))
Purpose:
Add or retrieve an entry in the destination username/domain translation table. For more information about the
destination username/domain translation table, see Domain Based Routing feature module.
Syntax:
numan-add:desttrans: custgrpid="custgrpid",destdmnstring=“destdmnstring”,svcname=“svcname”,
displayname=“displayname”,username=“username”,domainname=“domainname”,
uriparameters=“uriparameters”
numan-rtrv:desttrans: custgrpid="custgrpid",svcname=“svcname”,destdmnstring=“destdmnstring”
numan-rtrv:desttrans:“all”
Input
Description:
•
custgrpid—Customer group ID. A 4-digit alphanumeric string (enclosed in straight quotes) to identify the
dial plan.
•
destdmnstring—The destination username ([email protected]) or domain name (example.com).
•
svcname—The MML name of a service.
•
displayname—The display name for the user, such as UserOffice.
Note
RFC 3261 provides two formats for this parameter: a quoted string or a series of tokens. To use a series
of tokens, enter the displayname in normal MML syntax. To use a quoted string, use the escape
sequence %22. For example, the display name “UserOffice” (including quotation marks) is
“%22UserOffice%22”.
•
username—A username.
•
domainname—The new domain name.
•
uriparameters—URI parameters that the PGW adds to the header.
Note
•
The uriparameters value must start with a semicolon.
all—All entries in the DESTTRANS table.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-14
OL-1116-24
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
DIALPLAN—Customer-created Dial Plan
Output
Description:
Examples:
•
COMPLD—Provision succeeds
•
DENY—Provision fails
The MML command shown in the following example retrieves one entry in the destination username/domain
translation table:
mml> numan-add:desttrans: custgrpid="dp11", destdmnstring=“[email protected]”,svcname=“destgroup1”,
displayname=“BobOffice”,username=“bjones”,domainname=“example.com”,uriparameters=“;USER=phone”
MGC-01 - Media Gateway Controller 2008-08-01 16:40:09.168 EDT
M COMPLD
"Desttrans"
;
The MML command shown in the following example retrieves one entry in the destination username/domain
translation table:
mml> numan-rtrv:desttrans: custgrpid=”dp11”,svcname=”destgroup1”,destdmnstring=”cisco.com“
MGC-01 - Media Gateway Controller 2008-08-01 16:43:09.101 EDT
M RTRV
"session=sessionname:desttrans"
/*
CustGrpId ServiceName DestUserDomain NewDisplay NewUser NewDomain NewUriParameters
------------------------------------------------------------------------dp11
destgroup1 [email protected] BobOffice bjones example.com ;USER=phone
*/
;
Comments:
Performance impact category: A
DIALPLAN—Customer-created Dial Plan
Purpose:
Provision the customer-created dial plan.
Syntax:
numan-add:dialplan:custgrpid="custgrpid”,overdec="overdec"
numan-dlt:dialplan:custgrpid="custgrpid”,contentonly
numan-rtrv:dialplan:
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-15
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
DIGMODSTRING—Digit Modification String
Input
Description:
Examples:
•
custgrpid—Customer group ID. A 4-digit alphanumeric string (enclosed in straight quotes) to identify the
dial plan.
•
overdec—Indicates the overdecadic status only when adding a dial plan.
•
contentonly—Clear content or the whole dialplan file. When contentonly is set to "true", deletion of the
contents of a dial plan (for example, cleans all dial plan sections except the service and dpselection section
of the dial plan file) without first deleting dial plan dependencies is permitted. This allows dial plan
contents to be changed, even though dependencies may exist, and then restored before deploying the
provisioning changes. If contentonly is set to "false" (the default), all dependencies must be eliminated
before the dial plan can be deleted.
The MML command shown in the following example adds the dial plan component and the required custgrpid
parameter:
mml> numan-add:dialplan:custgrpid="t100"
The MML command shown in the following example deletes the contents of a dial plan:
mml> numan-dlt:dialplan:custgrpid="T003",contentonly="true"
The MML command shown in the following example deletes a dial plan. The whole dial plan file can be
deleted only if there are no dependencies.
mml> numan-dlt:dialplan:custgrpid="T001"
DIGMODSTRING—Digit Modification String
Purpose:
Provision the digit modification string table.
Syntax:
numan-add:digmodstring:custgrpid="custgrpid”,name="name",digstring="digitstring"
numan-dlt:digmodstring:custgrpid="custgrpid”,name="name"
numan-ed:digmodstring:custgrpid="custgrpid”,name="name",digstring="digitstring"
numan-rtrv:digmodstring:custgrpid="custgrpid”,name="name",”all”
Input
Description:
Examples:
•
custgrpid—Customer group ID. A 4-digit alphanumeric string (enclosed in straight quotes) to identify the
dial plan.
•
name—MML name of the digit modification string.
•
digstring—Digit string.
The MML command shown in the following example adds the digit string "1045" to the DIGMODSTRING
list in the dial plan:
mml> numan-add:digmodstring:custgrpid="t100",name="digname1",digstring="1045"
DMNMODSTRING—Domain String Table (Release 9.8(1))
Purpose:
Add or retrieve an entry in the domain strings table. For more information about the DRP, see Domain Based
Routing feature module.
Syntax:
numan-add:dmnmodstring:custgrpid="custgrpid”, name="tablename", dmnstring="dmnstring”
numan-rtrv:dmnmodstring:custgrpid="custgrpid”, name="tablename"
numan-rtrv:dmnmodstring:“all”
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-16
OL-1116-24
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
DRPTABLE—Domain Routing Policy Table (Release 9.8(1))
Input
Description:
Output
Description:
Examples:
•
custgrpid—Customer group ID. A 4-digit alphanumeric string (enclosed in straight quotes) to identify the
dial plan.
•
name—The MML name of the source modification string.
•
dmnstring—The domain name to modify, such as cisco.com or example.com.
•
all—Displays all entries in the domain strings table.
•
COMPLD—Provision succeeds
•
DENY—Provision fails
The MML command shown in the following example retrieves one entry in the domain strings table:
mml> numan-add:dmnmodstring:custgrpid=”T002”, name=”dmn1”, dmnstring=”example.com”
MGC-01 - Media Gateway Controller 2008-08-04 10:22:29.141 EDT
M COMPLD
"dmnmodstring"
;
The MML command shown in the following example retrieves one entry in the domain strings table:
mml> numan-rtrv:dmnmodstring:custgrpid="dp11", name="dmn1"
MGC-01 - Media Gateway Controller 2008-08-04 10:23:44.807 EDT
M RTRV
"session=sessionname:dmnmodstring"
/*
dmnName
dmnString
--------------example.com
cisco.com
*/
;
Comments:
Performance impact category: A
DRPTABLE—Domain Routing Policy Table (Release 9.8(1))
Purpose:
Add or retrieve an entry in the domain routing policy (DRP) table. For more information about the DRP, see
Domain Based Routing feature module.
Syntax:
numan-add:drptable:custgrpid="custgrpid”, drpstepnum=”drpstepvalue”, setname=”dmnrtgset1”
numan-rtrv:drptable:custgrpid="custgrpid”, drpstepnum=”drpstepvalue”
numan-rtrv:drptable:“all”
Input
Description:
Output
Description:
•
custgrpid—Customer group ID. A 4-digit alphanumeric string (enclosed in straight quotes) to identify the
dial plan.
•
drpstepnum—The step number in the DRP table (1–6).
•
setname—The result set that the PGW executes at the given step of the DRP table.
•
all—All entries in the route selection table
•
COMPLD—Provision succeeds
•
DENY—Provision fails
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-17
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
DPSEL—Dial Plan Selection
Examples:
The MML command shown in the following example retrieves one entry in the DRP table:
mml> numan-add:drptable: custgrpid=“T002”, drpstepnum=“1”, setname=“dmnrtgset1”
MGC-01 - Media Gateway Controller 2008-08-01 16:40:09.168 EDT
M COMPLD
"Drptable"
;
The MML command shown in the following example retrieves one entry in the DRP table:
mml> numan-rtrv:drptable:custgrpid="T002”, drpstepnum=1
MGC-01 - Media Gateway Controller 2008-08-01 16:54:51.010 EDT
M RTRV
"session=sessionname:drptable"
/*
stepIndex
resultSetName
--------------------1
dmnRtgExitSet
*/
;
Comments:
Performance impact category: A
DPSEL—Dial Plan Selection
Purpose:
Provision the dial plan selection list.
Syntax:
numan-add:dpsel:custgrpid="custgrpid”, newdp=”newdp”
numan-dlt:dpsel:custgrpid="custgrpid”, newdp=”newdp”
numan-rtrv:dpsel:custgrpid="custgrpid”
numan-rtrv:dpsel:“all”
Input
Description:
Examples:
•
custgrpid—Customer group ID. A 4-digit alphanumeric string (enclosed in straight quotes) to identify the
dial plan.
•
newdp—New dial plan customer group ID.
The MML command shown in the following example adds the dial plan selection list:
mml> numan-add:dpsel:custgrpid="t001",newdp="dp07"
Comments:
Performance impact category: A
FULLNUMBERTRANS—Full Number Translation (Release 9.7(3))
Purpose:
Add a digit string to the Full Number Translation table.
Syntax:
numan-add:fullnumbertrans:svcname="Service Name",numbtype=”Number Type”,
digstring="Original Digits”,translatednum="Translated Digits"
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-18
OL-1116-24
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
H323IDDIVFROM—H323 ID, Division Header, or From Field
Input
Description:
•
svcname—A unique service name string for full number translation entries. Maximum length of string:
10 characters.
•
numtype—Identifier for the number type (1–5). Maximum length of integers: 1 digit. It is one of the
following values:
1—called party number
2—calling party number
3—redirecting number
4—calling party number and redirecting number
5—original called number
Note
•
digstring—The digit string that is to be translated. Maximum length of integers: 20 digits.
•
translatednum—The translated digit string. Maximum length of integers: 20 digits.
Note
Example:
The numtype value of 5 is added in the Cisco PGW 2200 Softswitch Release 9.8(1) S7P7.
Digit strings stored in the full number translation table are case insensitive. That is to say, if digit
strings that you provisioned contain alphabetic characters, the TimesTen database saves them as
uppercase characters in the full number translation table.
The MML command shown in the following example enables full number translation for result types:
mml> numan-add:fullnumbertrans:svcname="freephone",numbtype=1,digstring="1234",
translatednum="54321"
Comments:
Performance Impact Category: A
H323IDDIVFROM—H323 ID, Division Header, or From Field
Purpose:
Add, delete, or edit the H323 ID, Division header, or From field.
Note
Syntax:
Input
Description:
Example:
Provision CLIPREFIX before CLIIPADDRESS and H323IDDIVFROM. See the
“CLIPREFIX—Calling Line Identity Prefix” section on page 1-11.
numan-add:h323iddivfrom:custgrpid=”customer ID”,h323iddivfrom=”field”,clisetname=”name”
numan-dlt:h323iddivfrom:custgrpid=”customer ID”,h323iddivfrom=”field”
numan-ed:h323iddivfrom:custgrpid=”customer ID”,h323iddivfrom=”field”,clisetname=”name”
•
Custgrpid—Customer group ID. Enter a four-character alphanumeric string.
•
H323iddivfrom—H323 ID, Division header, or From field.
•
Clisetname—Name of the CLI prefix set. Enter an alphanumeric string up to 4 characters in length.
mml> numan-add:h323iddivfrom:custgrpid=”T002”,h323iddivfrom=”123abcdefgh”,clisetname=”x”
mml> numan-dlt:h323iddivfrom:custgrpid=”T002”,h323iddivfrom=”123abcdefgh”
mml> numan-ed:h323iddivfrom:custgrpid=”T002”,h323iddivfrom=”123abcdefgh”,clisetname=”x”
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-19
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
HLC—High Layer Compatibility
HLC—High Layer Compatibility
Purpose:
Provision the HLC table entry.
Syntax:
numan-add:hlc:custgrpid=”customer ID”,name=”HLC name”,ocval=”ocval”
numan-dlt:hlc:custgrpid=”customer ID”,name=”HLC name”
numan-ed:hlc:custgrpid=”customer ID”,name=”HLC name”,ocval=”ocval”
numan-rtrv:hlc:custgrpid=”customer ID”,name=”HLC name”,”all”
Input
Description:
•
Custgrpid—Customer group ID. Enter a four-character alphanumeric string.
•
name—High Layer Compatibility name.
•
ocval—Octet coding value. Default value is 1.
1—HLC_TELEPHONT
4—HLC_FAX_GP_2_3
33—HLC_FAX_GP_4_CLASS_1
36—HLC_FAX_GP_4_CLASS_2_3
40—HLC_TELEX_F220
49—HLC_TELEX_F200
50—HLC_SYNTAX_VIDEOTEXT
51—HLC_INTERNATIONAL_VIDEOTEXT
53—HLC_TELEX_F60
56—HLC_MHS_X400
65—HLC_OSI_X200
94—HLC_RESERVED_MAINTENANCE
95—HLC_RESERVED_MANAGEMENT
127—HLC_RESERVED
Example:
The MML command shown in the following example adds the HLC table entry:
mml> numan-add:HLC:cusgrpid="dpl1",name="hlc-04",ocval="9184"
LOCATION—Location
Purpose:
Provision the location table entry.
Syntax:
numan-add:location:custgrpid=”customer ID”,locationblock=”locationblock”,
blockvalue=”blockvalue”,setname=”setname”
numan-dlt:location:custgrpid=”customer ID”,locationblock=”locationblock”
numan-ed:location:custgrpid=”customer ID”,locationblock=”locationblock”,
blockvalue=”blockvalue”,setname=”setname”
numan-rtrv:location:custgrpid=”customer ID”,locationblock=”locationblock”,”all”
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-20
OL-1116-24
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
PORTTBL—Ported Numbers Table
Input
Description:
Example:
•
Custgrpid—Customer group ID. Enter a four-character alphanumeric string.
•
locationblock—The location block.
•
blockvalue—The location block value. This value should be one less than the intended internal value.
•
setname—Result set name.
The MML command shown in the following example adds the LOCATION and sets up the Location with a
CustGrpID of t001, a locationblock of 1, a block value of 8, and a result set name of "set8":
mml> numan-add:location:custgrpid="t001",locationblock=1,blockvalue="8",setname="set8"
PORTTBL—Ported Numbers Table
Purpose:
Adds an entry to the PORTTBL list of your dial plan.
Syntax:
numan-add:porttbl:digitstring=”digitstring”,routenum=”route number”,
minlength=minimum length,maxlength=maximum length
Input
Description:
•
digitstring—Called number. B-Number digits (can be post normalization or modification).
•
routenum—(Optional) Routing number prefix for ported numbers.
•
minlength—(Optional) Specifies minimum length for call origination from this traffic path. Value range
is 0-20. Default is 0. The minlength must not be greater than the maxlength.
•
maxlength—(Optional) Specifies the maximum length for call origination from this traffic path. Value
range is 0–20. Default is 0.
Note
Example:
The TimesTen table (by numan-add:porttbl) can hold 20 digits, but usually the input called number
should not exceed 19 digits. If it is more than 19 digits, the DB_XLATED might not behave as
expected. There is a special case that 20 digits are supported. For the overlap mode, you input a
called number of 19 digits. If the Cisco PGW 2200 Softswitch searches the TimesTen table and
returns a unique match, you enter the last digit (the 20th digit). If it matches the returned called
number, the DB_XLATED result can behave as expected.
The MML command shown in the following example shows the parameters needed to configure an entry in
the PortedTable according to the new table schema.
mml> numan-add:porttbl:digitstring=“1444234567",routenum=“5555", minlength=13, maxlength=16
The minlength and maxlength values created here relate to the B-Number post database reading. They do
not relate to the incoming digits received from line.
This example is shown to provide full information; in practice, Bulk-loading from a file prepared off-line is
used.
Comments:
Performance Impact Category: A
See Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide for information about how to use the
NUMAN-ADD command for dial plan provisioning and for a description of components, parameter names,
parameter descriptions, and parameter values.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-21
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
PREFIXCONVERT—Prefix Convert (Release 9.8(1))
PREFIXCONVERT—Prefix Convert (Release 9.8(1))
Purpose:
Add, delete, or retrieve a prefix convert entry.
Syntax:
numan-add:prefixconvert:cdpnprefix=”cdpnprefix”,cgpnprefix=”cgpnprefix”,
acgpnprefix=”acgpnprefix”,previousnoa=”previousnoa”,previousprefix=”previousprefix”,
newprefix=”newprefix”[,newnoa=”newnoa”][,newaddconprefix=”newaddconprefix”]
[,newaddconnoa=”newaddconnoa”]
numan-dlt:prefixconvert:cdpnprefix=”cdpnprefix”,cgpnprefix=”cgpnprefix”,
acgpnprefix=”acgpnprefix”,previousnoa=”previousnoa”,previousprefix=”previousprefix”
numan-rtrv:prefixconvert:cdpnprefix=”cdpnprefix”,cgpnprefix=”cgpnprefix”,
acgpnprefix=”acgpnprefix”,previousnoa=”previousnoa”,previousprefix=”previousprefix”
numan-rtrv:prefixconvert:”all”
Input
Description:
•
cdpnprefix—Called party number prefix. Default value is “DEFAULT”.
•
cgpnprefix—Calling party number prefix. Default value is “DEFAULT”.
•
acgpnprefix—Additional calling party number prefix. Default value is “DEFAULT”.
•
previousnoa—Connected number NOA. Default value is 0.
•
previousprefix—Connected number or redirection number prefix that will be changed, not null.
•
newprefix—The changed prefix for connected number or redirection number.
•
newnoa—(Optional) New connected number NOA.
•
newaddconnoa—(Optional) New additional connected number NOA. If not empty, additional
connected number is inserted on top of connected number as generic number.
•
newaddconprefix—(Optional) New additional connected number prefix. If empty, the received
connected number digits are used as digits for the additional connected number. If not empty, this prefix
followed by received connected number digits are used as digits for the additional connected number.
•
all—All prefix convert entries.
Note
Example:
If cdpnprefix, cgpnprefix, or acgpnprefix are not specified, they will be assigned with DEFAULT
values.
The following sample MML command adds a prefix convert entry:
mml> numan-add:prefixconvert:cdpnprefix="8012",cgpnprefix="8001",acgpnprefix="8002",
previousprefix="8012",previousnoa="4", newprefix="648012",newnoa="4",newaddconprefix="74",
newaddconnoa="4"
The following sample MML command deletes a prefix convert entry:
mml> numan-dlt:prefixconvert:cdpnprefix="8012",cgpnprefix="8001",acgpnprefix="8002",
previousprefix="8012",previousnoa="4"
The following sample MML command retrieves a prefix convert entry:
mml> numan-rtrv:prefixconvert:cdpnprefix="8012",cgpnprefix="8001",acgpnprefix="8002",
previousprefix="8012",previousnoa="4"
Comments:
Performance Impact Category: A
Note
The prefix modifications are based on the original calling/called/generic number received on the
originating side.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-22
OL-1116-24
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
RESULTSET—Result Set
RESULTSET—Result Set
Purpose:
Provision the result set in the Result Set table.
Syntax:
numan-add:resultset:custgrpid=”custgrpid”,name=”name”
numan-dlt:resultset:custgrpid=”custgrpid”,name=”name”
numan-rtrv:resultset:custgrpid=”custgrpid”,name=”name”,”all”
Input
Description:
Example:
•
custgrpid—The customer group ID, which is a previously defined 4-digit alphanumeric string.
•
name—The result set name.
The MML command shown in the following example adds a result set:
mml> numan-add:resultset:custgrpid="T001",name="CSCO111"
RESULTTABLE—Result Table
Purpose:
Add—Adds a new result to the result table in the dial plan.
Delete—Deletes the result table to use the default values.
Retrieve—Retrieves the result table.
Syntax:
Input
Description:
numan-add:resulttable:custgrpid=”customer group ID”,name=”result name”,resulttype=”ResultType”,
dw1=”value”,dw2=”value”,dw3=”value”,dw4=”value”,setname=”ResultSet Name”
numan-dlt:resulttable:custgrpid="customer group ID",name="result name",setname="ResultSet Name"
numan-rtrv:resulttable:custgrpid="customer group ID",name="result name",
setname=”Resultset Name”,"all"
•
custgrpid—The customer group ID, which is a previously defined 4-digit alphanumeric string.
•
name—The result table index name.
•
resulttype—The result type.
•
dw1—data word.
Note
•
See Cisco PGW 2200 Softswitch Release 9.8 Dial Plan Guide for a complete list of all result types and
descriptions of data words.
setname—The result set name.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-23
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
RESULTTABLE—Result Table
Examples:
The following example MML commands add the Gateway Pool in A Number Analysis:
mml> numan-add:resultset:custgrpid="1111",name="set1"
mml> numan-add:resulttable:custgrpid="1111",resulttype="GATEWAYPOOL",dw1="100",dw2="3",
dw3="101",dw4="1",setname="set1",name="rt1"
mml> numan-add:adigittree:custgrpid="1111",digitstring="1",callside="originating",setname="set1"
The following example MML commands add the Gateway Pool in B Number Analysis for Media Anchor
Bypass:
mml> numan-add:resultset:custgrpid="1111",name="set2"
mml> numan-add:resulttable:custgrpid="1111",resulttype="GATEWAYPOOL",dw1="100",dw2="3",
dw3="101",dw4="1",setname="set2",name="rt2"
mml> numan-add:bdigittree:custgrpid="1111",digitstring="1",callside="originating",setname="set2"
The following example MML command adds the A_NUM_DP_TABLE result in to the dial plan result table:
mml> Numan-add:resulttable:custgrpid=”1111”,resulttype=”a_num_dp_table”, dw1=5,
name=”anumdp01”,setname=”resultset1”
•
dw1 = 5 indicates that a database longest match query searches down from the currently received number
of digits to a digit length of 5 for potential matches.
•
If dw1 is omitted or set to zero, the existing functionality with exact matching will apply.
The following example MML command adds the new DB_XLATED result to the result table in the dial plan:
mml> Numan-add:resulttable:custgrpid=”1111”,resulttype=”DB_XLATED”,dw1=6,dw2=dp01,dw3=dp02,
name=”dbTrans01”,setname=”resultset1”
•
dw1 = 6 indicates that any longest match search searches down from the currently received number of digits
to a digit length of 6 for potential matches.
•
dw2 and dw3, respectively, indicate the dial plan to move into according to matching (dp01) or not
matching (dp02).
The following example MML command adds the CAUSE result type to map the received cause and location
value into the user’s preferred cause and location value:
mml> numan-add:resultset:custgrpid=”Nat1”,setname=”chCause”
mml> numan-add:resulttable:custgrpid=”Nat1”,setname=”chCause”,resulttype=”CAUSE”,
name=”cause1”,dw1=91,dw2=7
mml> numan-add:cause;custgrpid=”Nat1”,causevalue=40,resultset=”chCause”
The following example MML command adds a SCRIPT result type to the Result table in support of the MGCP
Scripting Support on the Cisco PGW 2200 Softswitch feature:
mml> numan-add:resulttable:custgrpId="1111",name="result61",resulttype="SCRIPT",dw1="10",
dw2="1",dw3="1",setname="set1"
The MML command shown in the following example provisions Polish ISUP version 2:
mml> NUMAN-ADD:resulttable:custgrpid="T002",name="result1",resulttype="CHARGE",dw3=”4”,
setname="setone"
The MML command shown in the following example provisions the INAP prepaid services IN_Trigger:
mml> numan-add:resulttable:custgrpid="T002", name="result1", resulttype="retry_action",
dw1="reattempt",setname="setfour"
mml> numan-dlt:resultset:custgrpid="Nat1",setname="chCause"
mml> numan-dlt:resulttable:custgrpid="Nat1",setname="chCause",name="cause1"
mml> numan-dlt:cause;custgrpid="Nat1",causevalue=40,resultset="chCause"
mml> numan-rtrv:resulttable:custgrpid="Nat1",name="cause1"
Comments:
Performance Impact Category: A. The existing AOCEnabled property must be set to 1.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-24
OL-1116-24
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
ROUTESEL— Route Selection Table (Release 9.8(1))
ROUTESEL— Route Selection Table (Release 9.8(1))
Purpose:
Add or retrieve an entry in the route selection table. For more information about the route selection table, see
Domain Based Routing feature module.
Syntax:
numan-add:routesel:custgrpid="custgrpid",destdmnstring=”destdmnstring”,
srcdmnstring=”srcdmnstring”,svcname=”svcname”, rtlistname=”rtlistname”
numan-rtrv:routesel:custgrpid="custgrpid", destdmnstring=”destdmnstring”,
srcdmnstring=”srcdmnstring”, svcname=”svcname”, rtlistname=”rtlistname”
numan-rtrv:routesel:“all”
Input
Description:
Output
Description:
Examples:
•
custgrpid—Customer group ID. A 4-digit alphanumeric string (enclosed in straight quotes) to identify the
dial plan.
•
destdmnstring—Destination username ([email protected]) or domain name (domain.com).
•
srcdmnstring—Source username ([email protected]) or domain name (example.com).
•
svcname—MML name of a service.
•
rtlistname—MML name of a route list.
•
all—All entries in the ROUTSEL table.
•
COMPLD—Provision succeeds
•
DENY—Provision fails
The MML command shown in the following example adds one entry in the route selection table:
mml> numan-add:routesel:custgrpid="dpl1",destdmnstring=”cisco.com”, srcdmnstring=”example.com”,
svcname=”svcname”, rtlistname=”rtlistcisco1”
MGC-01 - Media Gateway Controller 2008-08-04 10:30:27.394 EDT
M COMPLD
"routesel"
;
The MML command shown in the following example retrieves one entry in the route selection table:
mml> numan-rtrv:routesel:custgrpid="dpl1",destdmnstring=”cisco.com”,
srcdmnstring=”example.com”,svcname=”svcname”, rtlistname=”rtlistcisco1”
MGC-01 - Media Gateway Controller 2008-08-04 10:33:15.042 EDT
M RTRV
"session=sessionname:routesel"
/*
CustGrpId ServiceName DestUserDomain SrcUserDomain
Route List Name
--------- -------------------------------------------------------------dp11
destgroup1
cisco.com
[email protected] rtlist60
*/
;
Comments:
Performance impact category: A
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-25
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
RTEHOLIDAY—Route Holiday Table
RTEHOLIDAY—Route Holiday Table
Purpose:
Add—Adds a conditional route to the route holiday table.
Delete—Deletes an entry from the route holiday table.
Edit—Edits an entry in the route holiday table.
Retrieve—Retrieves an entry or all entries in the route holiday table.
Syntax:
Input
Description:
numan-add:rteholiday:custgrpid=”Customer group ID”,date=”yyyy.mm.dd”,hday=”holN”
numan-dlt:rteholiday:custgrpid=”Customer group ID”,date=”yyyy.mm.dd”
numan-ed:rteholiday:custgrpid=”Customer group ID”,date=”yyyy.mm.dd”,hday=”holN”
numan-rtrv:rteholiday:custgrpid=”Customer group ID”,date=”yyyy.mm.dd”
numan-rtrv:rteholiday:custgrpid=”Customer group ID”,"all"
•
custgrpid—The customer identifier (customer group ID). It is a four-character alphanumeric field and is
not validated by MML.
•
date—The date of the holiday, in the format yyyy.mm.dd.
•
hday—Day of holiday. Valid values can be one of the following strings:
– Hol1
– Hol2
– Hol3
Example:
The MML command shown in the following example is used to add a holiday entry:
mml> numan_add:rteholiday:custgrpid=”Too2”,date=”2001.08.12”,hday=”hol2”
The MML command shown in the following example deletes an entry from the route holiday table:
mml> numan-dlt:rteholiday:custgrpid="T001",date=”2001.08.12”
The MML command shown in the following example edits an entry in the route holiday table:
mml> numan-ed:rteholiday:custgrpid="T001",date=”2001.18.21”,hday="hol3"
The MML command shown in the following example retrieves a specific entry in the route holiday table:
mml> numan-rtrv:rteholiday:custgrpid=”mml1”
MGC-01 - Media Gateway Controller 2001-10-03 12:02:02
M RTRV
''session=tcr_2:rteholiday''
/*
Date Holiday Index
---- ------------2002.01.28 Hol1
2002.01.31 Hol1
2002.11.28 Hol1
*/
;
Comments:
Performance Impact Category: B, C. Impact depends on the size of the dial plan.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-26
OL-1116-24
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
SCRIPT—Script Table
SCRIPT—Script Table
Purpose:
Adds an entry to the Script table in support of the MGCP Scripting Support on the
Cisco PGW 2200 Softswitch feature.
Syntax:
numan-add:script:scriptid=ScriptId,gwtype="gwtype",scripttype=scripttype,
locationstring="location",scriptparamString="scriptparamString"
Input
Description:
•
ScriptId—The script identification (ID) of this script entry. It corresponds to the ID referenced in dw1, for
the SCRIPT result type. This is an integer.
•
GwType—Indicates the gateway type. This is an alphanumeric string that can be as many as 10 characters.
Valid string values for this field are:
– AS5300
– AS5400
– AS5350
– AS5850
– UNKNOWN
Note
•
Together, the ScriptId and the GWType form the key to the Script table.
ScriptType—Indicates the script type to be invoked and is used as the language type in the signal request
parameter S: for the script invocation. (For example, S: script/tcl or S:script/java, is based on this field.)
You provision the support of specific script types, which depend on the IOS gateway. This is an integer.
Valid integer values and their types are:
1 = JAVA
2 = PERL
3 = TCL (default)
4 = VXML
5 = XML
Example:
•
Location—The URL showing the location of the script entered as a string. The format of this string can
vary, depending on the gateway type and its configuration. This information is used in the script invocation
command to the gateway. The user provisions this field in the format that the associated gateway supports.
This field is limited to 128 alphanumeric characters. No default is provided for this field.
•
ScriptparamString—This is an optional field that is entered as a string. The information provided in this
string is used as is in the script invocation command to the gateway. The string format and the information
provided here conform to the specific gateway script requirements. No validation is performed on the
string. This field is limited to 128 alphanumeric characters. No default is provided for this field.
mml> numan-add:script:scriptid=16,gwtype="AS5400",scripttype=3,
locationstring="tftp://sample.tcl",scriptparamString="language=English,pinLength=5"
Media Gateway Controller - MGC-01 2003-01-12 15:19:51
M COMPLD
;
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-27
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
SERVICE—Service
SERVICE—Service
Purpose:
Provision the service table.
Syntax:
numan-add:service:custgrpid=”custgrpid”,name=”service name”
numan-dlt:service:custgrpid=”custgrpid”,name=”service name”
numan-rtrv:service:custgrpid=”custgrpid”,name=”service name”,”all”
Input
Description:
Example:
•
custgrpid—Customer group ID. A 4-digit alphanumeric string (enclosed in straight quotes) to identify the
dial plan.
•
name—Service name.
The MML command shown in the following example adds a service to the dial plan:
mml> numan-add:service:custgrpid="t001",name="Washington"
SOURCEBLACK—Source Domain Blacklist Table
(Release 9.8(1))
Purpose:
Add or retrieve an entry in the source domain blacklist table. For more information about the source blacklist
table, see Domain Based Routing feature module.
Syntax:
numan-add:sourceblack:custgrpid="custgrpid", srcdmnstring=”srcdmnstring”, svcname=”svcname”
numan-rtrv:sourceblack:custgrpid="custgrpid", srcdmnstring=”srcdmnstring”, svcname=”svcname”
numan-rtrv:sourceblack:“all”
Input
Description:
Output
Description:
•
custgrpid—Customer group ID. A 4-digit alphanumeric string (enclosed in straight quotes) to identify the
dial plan.
•
srcdmnstring—The source username ([email protected]) or domain name (example.com).
•
svcname—The MML name of a service.
•
all—All entries in the SOURCEBLACK table.
•
COMPLD—Provision succeeds
•
DENY—Provision fails
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-28
OL-1116-24
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
TAG—Tag (Release 9.8(1))
Examples:
The MML command shown in the following example adds one entry in the source blacklist table:
mml> numan-add:sourceblack:custgrpid="dp11", svcname="destgroup1", srcdmnstring="cisco.com"
MGC-01 - Media Gateway Controller 2008-08-04 10:35:41.680 EDT
M COMPLD
"sourceblack"
;
The MML command shown in the following example retrieves one entry in the source blacklist table:
mml> numan-rtrv:sourceblack:custgrpid="dp11", svcname="destgroup1", srcdmnstring="cisco.com"
MGC-01 - Media Gateway Controller 2008-08-04 10:37:11.471 EDT
M RTRV
"session=sessionname:sourceblack"
/*
CustGrpId
ServiceName
SourceUserDomain
------------------------------------------------------------------------dp11
destgroup1
cisco.com
*/
;
Comments:
Performance impact category: A
TAG—Tag (Release 9.8(1))
Purpose:
Add—Adds a tag to a tag list.
Retrieve—Retrieves a tag from the tag list table.
Syntax:
Input
Description:
Output
Description:
numan-add:tag:name="tag_name",value="tag_value",taglistname="tag_list_name"
numan-rtrv:tag:name="tag_name”,value="tag_value”
numan-rtrv:tag:"all”
•
name—The name associated with the specified tag.
•
value—The value associated with the specified tag.MML name of a service.
•
taglistname—The tag list to which the specified tag is added.
•
all—Displays all entries in the tag list table.
•
COMPLD—Provision succeeds
•
DENY—Provision fails
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-29
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
TAGLIST—Tag List (Release 9.8(1))
Example:
The MML command shown in the following example adds the specified tag to the specified tag list.
mml> numan-add:tag:name="tag1",value="codec",taglistname="tag_list_name"
MGC-01 - Media Gateway Controller 2009-06-23 17:35:34.424 CST
M COMPLD
''tag''
;
The MML command shown in the following example retrieves one entry from the tag list table:
mml> numan-rtrv:tag:name="tag1",value="codec"
MGC-01 - Media Gateway Controller 2009-06-23 17:37:09.906 CST
M RTRV
''session=GCT:tag''
/*
tagname tagvalue taglistid
----------- ---------- -------------------tag1 codec 9
*/
;
Comments:
Performance impact category: A, B.
TAGLIST—Tag List (Release 9.8(1))
Purpose:
Add—Adds a tag list to a tag list table.
Retrieve—Retrieves entries in the tag list table
Syntax:
numan-add:taglist:name="tag_list_name",type="type_value"
numan-rtrv:taglist:name="tag_liat_name”,type="type_value”
Input
Description:
•
name—The name for the tag list.
•
type—The tag list type value, which specifies whether the tag list is for a trunk group or for a dialplan
Output
Description:
•
COMPLD—Provision succeeds
•
DENY—Provision fails
Examples:
The MML command shown in the following example adds a new tag list to the tag list table.
mml> numan-add:taglist:name="sipcall", type=1
MGC-01 - Media Gateway Controller 2009-06-23 17:33:50.277 CST
M COMPLD
''taglist''
;
The MML commands shown in the following examples retrieve a tag list from the tag list table:
mml> numan-rtrv:taglist:name=”tag_list_name”,type=”0”
MGC-01 - Media Gateway Controller 2009-06-23 17:36:12.723 CST
M RTRV
''session=GCT:taglist''
/*
taglistname type taglistid
----------- ---------- -------------tag_list_name 0 9
*/
;
Comments:
Performance impact category: A, B.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-30
OL-1116-24
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
TERMTBL—Number Termination Table
TERMTBL—Number Termination Table
Purpose:
Provision the Number Termination table
Syntax:
numan-add:termtbl:digitstring="digitstring", rtlistname="rtlistname"
numan-dlt:termtbl:digitstring="digitstring"
numan-ed:termtbl:digitstring="digitstring", rtlistname="rtlistname"
numan-rtrv:termtbl:digitstring="digitstring"
Input
Description:
Examples:
•
digitstring—The called number.
•
rtlistname—The route list name.
The MML command shown in the following example adds an entry to the TERMTBL list and the required
parameters to your dial plan:
mml> numan-add:TERMTBL:digitstring="34567",RTLISTNAME="dallas"
TMR—Transmission Medium Requirements
Purpose:
Add—Provisions transmission medium requirements (TMR).
Delete—Deletes elements in the TMR.
Edit—Edits elements in the TMR.
Syntax:
Input
Description:
Example:
numan-add:tmr:tmrvalue=”TMR value”,custgrpid=”customer group id”,setname=”result set name”
numan-dlt:tmr:tmrvalue=”TMR value”,custgrpid=”customer group id”
numan-ed:tmr:tmrvalue=”TMR value”,custgrpid=”customer group id”,setname=”result set name”
•
tmrvalue—Enter a number in the range 0 to 255. There is no default for this entry.
•
custgrpid—The customer identifier (customer group ID). It is a four-character alphanumeric field and is
not validated by MML.
•
setname—Name of the result set.
The MML command shown in the following example provisions the TMR table:
mml> NUMAN-ADD:tmr:tmrvalue=1,custgrpid=”T001”,setname=”tmrsetone”
The MML command shown in the following example deletes the customer group ID:
mml> NUMAN-DLT:tmr:tmrvalue=2,custgrpid=”T002”
The MML command shown in the following example edits the TMR value:
mml> NUMAN-ED:tmr:tmrvalue=2,custgrpid=”T001”,setname=”tmrsetone”
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-31
Chapter 1
NUMAN: Commands for Provisioning Dial Plan Components
TNS—Transit Network Selection
TNS—Transit Network Selection
Purpose:
Add—Provisions transit network selection (TNS).
Delete—Deletes elements in the TNS.
Edit—Edits elements in the TNS.
Syntax:
Input
Description:
Example:
numan-add:tns:tnsvalue=”TNS value”,custgrpid=”customer group id”,setname=”result set name”
numan-dlt:tns:tnsvalue=”TNS value”,custgrpid=”customer group id”
numan-ed:tns:tnsvalue=”TNS value”,custgrpid=”customer group id”,setname=”result set name”
•
tnsvalue—Enter a number in the range 000 to FFFFFFFF. There is no default for this entry.
•
custgrpid—The customer identifier (customer group ID). It is a four-character alphanumeric field and is
not validated by MML.
•
setname—Name of the result set.
The MML command shown in the following example provisions the TNS table:
mml> NUMAN-ADD:tns:tnsvalue=”333”,custgrpid=”T001”,setname=”tnssetone”
The MML command shown in the following example deletes the customer group ID:
mml> NUMAN-DLT:tns:tnsvalue=”7”,custgrpid=”T002”
The MML command shown in the following example edits the TNS value:
mml> NUMAN-ED:tns:tnsvalue=”333”,custgrpid=”T001”,setname=”tnssetone”
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-32
OL-1116-24
CH A P T E R
1
Properties
Revised: Aug 30, 2011, OL-1116-24
Properties are configurable entities within the Cisco PGW 2200 Softswitch system. These entities can
be equipment, circuits, protocols, or software.
Properties take the following syntax:
PropertyName = PropertyValue
PropertyName can be designated either by *.propertyName or by protocolFamily.propertyName, for
example:
*.BInternationalPrefix
SS7-ANSI.mtp3tstSltmT2
This chapter describes these property names and their associated values in the following sections:
•
Property Components, page 1-1
•
Property List, page 1-4
•
ISUP Timers, page 1-116
•
Protocol Variants, page 1-134
Property Components
There are several components that have large numbers of associated properties. In each of these cases,
the set of associated properties is provisioned as a property component:
•
Linkset Properties, page 1-2
•
SS7 Signaling Service Properties, page 1-2
•
Trunk Group Properties, page 1-3
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-1
Chapter 1
Properties
Property Components
Linkset Properties
The linkset property component type (LINKSETPROP) represents the configuration parameters that you
can use to tune linkset communications. These properties apply to all linksets you create. You do not
have to enter these values.
The linkset properties are listed below. For the list of components applicable to each of these properties
and descriptions of these properties, see Table 1-1.
DialogRange, layerretries, layertimer, mtp3ApcMtpRstrtT21, mtp3ApcMtpRstrtT28, mtp3ClearTfc,
mtp3DlnkConnAckT7, mtp3FrcUnhT13, mtp3InhAckT14, mtp3LocInhTstT20, mtp3LocInhTstT22,
mtp3MaxSltTries, mtp3MsgPriority, mtp3MtpRstrtT20, mtp3MtpRstrtT24, mtp3RepeatRstrtT26,
mtp3T12, mtp3T13, mtp3T14, mtp3T20, mtp3T21, mtp3T22, mtp3T7, mtp3Tc, mtp3TfrUsed,
mtp3TraSntT29, mtp3tstSltmT1, mtp3tstSltmT2, mtp3tstsrtat10, mtp3UnhAckT12, reference,
rudpNumRetx, rudpRetxTimer, rudpWindowSz, SendAfterRestart, slsTimer, sltmT1, sltmT2, Srtat10.
SS7 Signaling Service Properties
The SS7 signaling service properties component types (SIGSVCPROP) serve as configuration
parameters that you can use to tune signaling service communications. These properties apply to all SS7
signaling services you create. You do not have to enter these values.
The SS7 signaling service properties are listed below. For the list of components applicable to each of
these properties and descriptions of these properties, see Table 1-1.
ACCRespCatName, ACCRespCntlInhibit, ACLDur, ADigitCCPrefix, ADigitCCrm, adjDestinations,
AInternationalPrefix, AlarmCarrier, allowCRMCRA, allowEXM, AllowH323Hairpin, ANationalPrefix,
Anumnormalise, AOCDMinPeriodicTimerDuration, AOCEnabled, AOCNodeID, atpInclude,
AuditWhenSscIs, BcInitState, BDigitCCPrefix, BDigitCCrm, BInternationalPrefix, BNationalPrefix,
BothwayWorking, CallForwardRerouteDisabled, CallHoldInterworkingEnabled,
CarrierInfoTransferBackward, CarrierInfoTransferForward, carrierSelectInclude, CCOrigin,
CctGrpCarrier, CGBA2, CGBA2, cgpnForceIncomplete, cgpnInclude, cgpnPres, CgpnPresRes,
ChargeAreaInformation, ChargeOrigin, chnNonGeo, chnOlipInclude, cipInclude, cipNonGeo,
CircHopCount, CLIDefaultAllowed, CLISelect, CliSelectionForCodeOfPractice3, CNAPService,
COLDefaultAllowed, CompressionType, congProc, ContactListOrder, CorrelationCallIDFormat,
CotInTone, CotOnTerminatingSupport, CotOutTone, CotPercentage, CustomerVPNid,
CustomerVPNOffNetTblNum, CustomerVPNOnNetTblNum, defaultBC, DefaultCARIDNatNetIdPlan,
DefaultCARIDNetId, DefaultCARIDNetType, DefaultCHG, DefaultCHGNOA, DefaultCHGNPI,
DefaultDN, DefaultDNNOA, DefaultDNNPI, DefaultDNPres, DefaultDNSI, DefaultOLI, DefaultTmr,
delayTimer, DeselOutCicCDRGenerate, DisableQSIGReleaseMethod,
DpnssRORoutingNumberLength, EchoCanRequired, EnableCCBSpathReservation,
ExpiryWarnToneDur, ExpiryWarnToneType, ExtCOT, DefaultFCINatInd, FastConnect, FAXsupport,
FeatureTransparencyDisabled, ForwardCLIinIAM, ForwardSegmentedNEED,
FT_IncomingPFXdigitsInsert, FT_IncomingPFXdigitsRemove, FT_OutgoingPFXdigitsInsert,
FT_OutgoingPFXdigitsRemove, gapInclude, GatewayAnnouncementPackageSupport, GatewayName,
GenerateRedirectionNumber, GenericPurposeString, GLARE, gnInclude, GRA2, GRSEnabled,
GRSonSSCEnabled, GtdCapTypeProp, GtdMsgFmt, GWDefaultAudioCodecString,
GWNetworkContinuity, GWProtocolVersion, h248BulkAudit, h248CongestionEnable,
h248ControlInterval, h248DomainNameRemote, H248GatewayReserveValue,
h248GWStdbyHeartbeatInterval, h248inactivitytimer, h248InitFill, h248initialrtt,
h248InitLeakAmount, h248LeakInterval, h248LocalIpInterfacePollCount, h248longtimer,
h248MaxFill, h248maxretries, h248mgcexectimer, h248mgcpendlimit, h248mgcprovresptimer,
h248mgexectimer, h248mgpendlimit, h248OverloadEnable, h248profilename, h248profileversion,
h248RemoteIpPollCount, h248SplashAmount, h248TargetolRate, h248TermPendPeriod, h248TimerT1,
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-2
OL-1116-24
Chapter 1
Properties
Property Components
h248txnpendrespcount, H323AdjunctLink, H323Destination, HandlePresUnavail, hopOn,
InbandInfoAvailable, InhibitIncomingCallingNameDisplay, InhibitIncomingConnectedNameDisplay,
InhibitIncomingConnectedNumberDisplay, InhibitOutgoingCallingNameDisplay,
InhibitOutgoingConnectedNameDisplay, InhibitOutgoingConnectedNumberDisplay,
InhibitSipFromMapping, InitEndpointsAsEnabled, IPInScreening, IPTermNumGroups,
IPTermNumInterfaces, IPTermNumTerms, IsupToSipRatio, IsupTransEarlyACMEnable,
IsupTransEarlyBackwardDisabled, IsupTransparencyDisabled, jipDefault, jipInclude, lapdDropErr,
lapdKval, lapdN200, lapdN201, lapdT200, lapdT203, LocalAnnBehavior, LocationNumber,
LoopAvoidanceCounter, LoopAvoidanceSupport, MapCLItoSipHeader, MapRNMethod,
MaxCBRequest, maxMessageLength, MgcpBehavior, mgcpBulkAudit, mgcpDomainNameLocal,
mgcpDomainNameRemote, mgcpGWRspAckTimeout, mgcpGWStdbyHeartbeatInterval,
mgcpHeartbeatInterval, mgcpLocalIpInterfacePollCount, mgcpMaxRspAckToBuffer,
mgcpRemoteIpPollCount, mgcpRetxCount, mgcpRetxTimer, mgcpRsvpErrHandling,
mgcpRsvpPackage, MidCallServiceCustID, mtp3Queue, MWIInvokeTimerT1, MwiStringOFF,
MwiStringON, NATTraversalMethod, NatureOfAddrHandling, NewDiversionHdrRequired,
NFASImplicitInterfaceId, Normalization, notificationInclude, ocnInclude, OD32DigitSupport,
OmaxDigits, OminDigits, OmitCgPnFromUnavailable, Ooverlap, OverlapDigitTime, OwnClli,
OwnRoutingNumber, PostConnectToneDuration, PostConnectToneValue, PropagateSvcMsgBlock,
ProtocolidandVariantidProv, QSIGTunnelVariant, QsigVariant, radiuskey, radiusretrycount,
radiustimeout, redirCapInclude, redirCounterInclude, RedirectingNbrMap, RedirectingNbrSupport,
redirInfoInclude, RedirMax, RedirNumForAnalysis, ReleaseMode, respectSipUriUserParm,
restartTimer, rnInclude, RORequestDelayTimer, RouteId, RoutePref, SdpXmitToH323Trigger,
SendAddressInCgpn, SendDtmfBeforeConnect, serviceCodeInclude, sgcpRetxCount, sgcpRetxTimer,
SipCallHoldMethod, SipDtmfContentType, SipRedirAnalysisMethod, SipReferForSingleStepXfer,
SipSatelliteIndEnable, SipToIsupRatio, spanId, srcpAuditGwInterval, srcpAuditLineInterval,
srcpHeartbeatInterval, srcpIpPortLocal, srcpIpPortRemote, srcpRemoteAuditGwInterval,
srcpRetxCount, srcpRetxTimer, sRtpSupported, srtTimer, SSCTInvokeTimerT1, STdigitforCDPN,
STdigitforCLI, SuppressCHGNtoCGPNMapping, SuppressCLIDigits, SwitchID, T309Time,
T310Time, Ta1TimePeriod, Ta2TimePeriod, Ta3TimePeriod, TbufferDigitLength,
TCAPOverIPKpAlive, TCAPOverIPKpOpcod, TCAPOverIPKpTimer, TCAPOverIPTcpConn,
TimeOutCBNU, TimeOutCBWF, TlinkAlignTime, TmaxDigits, TminDigits, Toverlap,
TransferAwaitConnect, transReqInclude, unavailProc, UUIEProtocolDiscriminator, variant,
VOIPPrefix, XmitCallingName.
Trunk Group Properties
The trunk group property component (TRNKGRPPROP) includes the following properties:
accrespcatname, accrespcntlinhibit, acldur, adigitccprefix, adigitccrm, ainternationalprefix,
anationalprefix, anumnormalise, aocdefaulttariffid, aocenabled, aocinvoketype, atmconnectiontype,
bdigitccprefix, bdigitccrm, binternationalprefix, bnationalprefix, bnumnormalise, btechprefix,
callforwardreroutedisabled, carrierscreening, ccorigin, cgpnpresres, chargeorigin, cliselect,
cliselectionforcodeofpractice3, clli, compressiontype, cotpercentage, custgrpid, customervpnid,
customervpnoffnettblnum, customervpnonnettblnum, defaultcaridnatnetidplan, defaultcaridnetid,
defaultcaridnettype, defaultchg, defaultchgnoa, defaultchgnpi, defaultdn, defaultdnnoa, defaultdnnpi,
defaultdnpres, defaultdnsi, defaultoli, defaultpn, defaultpnnoa, defaultpnnpi, defaultpnpres,
detectfaxmodemtone, dpnssroroutingnumberlength, dtmfcap, echocanrequired,
enableccbspathreservation, expirywarntonedur, expirywarntonetype, extcot, faxsupport,
featuretransparencydisabled, gatewayrbtonesupport, glare, gtdcaptypeprop, gtdmsgfmt,
gwdefaultatmprofile, gwdefaultaudiocodecstring, h248gatewayreservevalue,
inhibitincomingcallingnamedisplay, inhibitincomingconnectednamedisplay,
inhibitincomingconnectednumberdisplay, inhibitoutgoingcallingnamedisplay,
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-3
Chapter 1
Properties
Property List
inhibitoutgoingconnectednamedisplay, inhibitoutgoingconnectednumberdisplay,
isuptransearlybackwarddisabled, isuptransparencydisabled, loopavoidancecounter,
loopavoidancesupport, lrndigitccprefix, lrndigitccrm, maxacl, midcallcpinterval, midcallservicecustid,
mwistringoff, mwistringon, networktype, npa, od32digitsupport, omaxdigits, omindigits, ooverlap,
origcarrierid, overlapdigittime, ownroutingnumber, packagetype, playannouncement,
populatesdpinfoincdr, propagatedelaycounter, referredirectingind, referredirectingnoa, ringnoanswer,
satelliteind, screenfailaction, sdpxmittoh323trigger, sendaddressincgpn, srtpallowed, ta1timeperiod,
ta2timeperiod, ta3timeperiod, tmaxdigits, tmindigits, toverlap, trunkgrouptaglabel, waitanswertimer,
waitorigsdptimer, waittermsdptimer, xmitcallingname.
Property List
Table 1-1 lists the configurable Cisco PGW 2200 Softswitch Release 9 properties and their definitions
according to their associated component. In this table, associated components include signaling path,
protocol family, trunk group, linkset, session, and profile.
Note
The Release 9.8 feature SIP Profiles replaces all existing SIP and EISUP trunk group properties with
equivalent SIP and EISUP profile properties. To configure the listed SIP and EISUP properties, use a
SIP or EISUP profile (prov-add:profile). For more information about SIP and EISUP profiles, see
Cisco PGW 2200 Softswitch Release 9.8 Provisioning Guide.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-4
OL-1116-24
Chapter 1
Properties
Property List
Property Definitions
Table 1-1 contains an alphabetical listing of the Cisco PGW 2200 Softswitch properties and their
definitions.
Properties with the Protocol Family Prefix
In a provisioning session, those properties with the protocolFamily prefix may be overridden by a
link set component. The overridden property is then written to properties.dat as
LinkSetMMLName.propertyName.
Properties Prefixed by an Asterisk (*)
Those default properties prefixed by an “*” may be overridden by a signal path (or Service) component
that is defined in sigPath.dat. The overridden property will be written to properties.dat as
mmlcomponentname.propertyname.
Table 1-1
Property Definitions
Property
Definition
*.AccNetInfo
Indicates the access information of the
P-Access-Network-Info header. This property can be
provisioned on a trunk group, in a SIP or EISUP profile, or a
domain profile.
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
—
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
Valid values: string (1 to 63 characters) or none.
COMMONPROFILE
Default value: none.
DOMAINPROFILE
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
*.AccNetInfoType
—
Indicates the access type of the P-Access-Network-Info
header. This property can be provisioned on a trunk group, in
a SIP or EISUP profile, or a domain profile.
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
Valid values: string (1 to 63 characters) or none.
COMMONPROFILE
Default value: none.
DOMAINPROFILE
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
*.ACCRespCat
Name
Specifies the ACC Response Controls listed in the ACC
Response Category table.
SS7-ANSI
SS7-ANSI
SS7-ITU
SS7-ITU
TRUNKGROUP
TRUNKGROUP
COMMONPROFILE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-5
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
Property
Definition
*.ACCRespCntl
Inhibit
Turns on or off Automatic Congestion Control control
procedures based on the Automatic Congestion Level value
received by the Cisco PGW 2200 Softswitch from a linked
switch. Values: 0 (off) or 1 (on).
SS7-ANSI
SS7-ANSI
SS7-China
SS7-China
SS7-ITU
SS7-ITU
Default: 0
SS7-Japan
SS7-Japan
SS7-UK
SS7-UK
TRUNKGROUP
TRUNKGROUP
COMMONPROFILE
*.ACLDur
Specifies the duration in seconds that the Automatic
Congestion Level is in effect when the
Cisco PGW 2200 Softswitch receives an ACL indication from
a linked switch.
Values are integers greater than zero.
SS7-ANSI
SS7-ANSI
SS7-China
SS7-China
SS7-ITU
SS7-ITU
SS7-Japan
SS7-Japan
Default: 5
SS7-UK
SS7-UK
TRUNKGROUP
TRUNKGROUP
EISUPPROFILE
*.ADigitCCPrefix
Controls functionality that applies a country code prefix to the DPNSS
calling party number before sending the call forward.
ISDNPRI
Values are 0 (disabled) or 1 (enabled).
MGCP
Default: 0
SS7-ANSI
DPNSS
H248
ISDNPRI (BRI)
MGCP
SS7-China
SIP
SS7-ITU
SS7-ANSI
SS7-Japan
SS7-China
SS7-UK
SS7-ITU
TRUNKGROUP
SS7-Japan
SS7-UK
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-6
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
Property
Definition
*.ADigitCCrm
Provides a country code digit string to which leading digits of TRUNKGROUP
CgPN, GN_ACgPN, RDN, OCN and PN can be compared. If
the digits match, those digits are removed from the front of
that number. The NOA codes of that number is set to National.
This modification is made before the call is sent forward.
Values are NULL (default) or null, or a maximum 5-digit
string.
DPNSS
Valid values: 1 through 99999.
SS7-ITU
Default: NULL
SS7-Japan
This property is added in software Release 9.6(1).
SS7-UK
ISDNPRI (BRI)
MGCP
SS7-ANSI
SS7-China
TRUNKGROUP
Note
EISUPPROFILE
The country code digits won't be stripped if the
presentation number doesn't have a + sign to indicate
international call.
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
*.adjDestinations
Number of adjacent destination point codes. Value range: 1
through 256.
SS7-ANSI
SS7-ANSI
Default: 16
*.AInternational
Prefix
Determines the prefix of the outgoing calling number when
DPNSS
NOA = International. Value range: NULL or a numeric string. ISDNPRI
Default: NULL
MGCP
DPNSS
H248
ISDNPRI (BRI)
SS7-ANSI
MGCP
SS7-China
SS7-ANSI
SS7-ITU
SS7-China
SS7-Japan
SS7-ITU
SS7-UK
SS7-Japan
TRUNKGROUP
SS7-UK
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-7
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.AlarmCarrier
Indicates the method of alarm carrier so that circuit validation SS7-ANSI
tests may be fully compliant with ANSI T1.113. Values are:
Associated
Components for
Release 9.8
SS7-ANSI
COMMONPROFILE
0 = unknown (default)
1 = software carrier
2 = hardware carrier
*.allowCRMCRA
SS7-ANSI
Indicates whether or not to allow the use of the Circuit
Reservation Message (CRM) and Circuit Reservation
TRUNKGROUP
Acknowledgement message (CRA). Values: 0 (for no) or 1 (for
yes).
SS7-ANSI
COMMONPROFILE
GRPROFILE
Default: 1
*.AllowEXM
Indicates whether or not to allow the use of the Exit Message
(EXM). Values: 0 (for no) or 1 (for yes).
SS7-ANSI
SS7-ANSI
TRUNKGROUP
COMMONPROFILE
Default: 1
*.AllowH323Hair
pin
GRPROFILE
EISUP
Allow H.323 hairpinning. Allows the
Cisco PGW 2200 Softswitch to interconnect H.323-originated TRUNKGROUP
and H.323-terminated calls by the HSI component. Values: 0
(not allowed) or 1 (allowed).
EISUP
EISUPPROFILE
COMMONPROFILE
Default: 0
*.ANationalPrefix
Determines the prefix of the outgoing calling number when
NOA = National. Value range: NULL or a numeric string.
Default: NULL
DPNSS
DPNSS
ISDNPRI
H248
MGCP
ISDNPRI (BRI)
SS7-ANSI
MGCP
SS7-China
SS7-ANSI
SS7-ITU
SS7-China
SS7-Japan
SS7-ITU
SS7-UK
SS7-Japan
TRUNKGROUP
SS7-UK
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-8
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
Associated
Components for
Release 9
through 9.7
*.AnchorMedia
Defines the media anchor policy on this IP trunk group.
—
Associated
Components for
Release 9.8
EISUPPROFILE
SIPPROFILE
Valid values:
•
1—Never anchor media on the IP trunk group.
COMMONPROFILE
•
2—Optional. The policy function determines whether to
anchor media on the IP trunk group.
DOMAINPROFILE
•
3—Always anchor media on the IP trunk group.
Default: 1
This property is added in software Release 9.8(1).
*.AnchorPolicy
Defines the media anchor policy in the policy function.
Determines whether to enable a gateway pool on an IP trunk
group. The anchor policy applies only to an egress IP trunk
group.
—
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Valid values:
•
0—Do not enable the SPDM to change gateway pool
usage. In response to a service check failure, the SPDM
does not enable use of the gateway pool even if the
AnchorMedia property is set to Optional on this trunk
group. Consequently, the Cisco PGW 2200 Softswitch
tries the next trunk group.
•
1—The SPDM enables use of the gateway pool on an IP
trunk if the AnchorMedia property is set to Optional. If
the enabled gateway pool satisfies the service
requirement, the SPDM enables the
Cisco PGW 2200 Softswitch to use the gateway pool.
Default: 0
This property is added in software Release 9.8(1).
*.Announcement
Option
Specifies whether playing an announcement to the originating —
side is mandatory. This applies only to an ingress IP trunk
group.
•
0—Playing an announcement is optional.
•
1—Playing an announcement is mandatory.
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default: 0
This property is added in software Release 9.8(1).
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-9
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
Property
Definition
*.Anumnormalise
TRUNKGROUP
Anumnormalise indicates that A-number (CgPn)
normalization is appropriate based on the NOA value and the
leading digits of the A-number. Leading digits 0 or 00 are the
only accepted digits. Valid values: 0 (disabled) or 1 (enabled),
SS7-ITU
Default: 0
EISUPPROFILE
This property is added in software Release 9.4(1) and is a
European feature only.
SIPPROFILE
SS7-UK
TRUNKGROUP
COMMONPROFILE
DOMAINPROFILE
*.AOCDefault
TariffId
TRUNKGROUP
Allows configuration of the default tariff ID to be applied
when AOCInvokeType is configured for all calls (that is,
AOCInvokeType = 2). Value range: 1 (default) through 9999.
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
Default: 1
COMMONPROFILE
DOMAINPROFILE
*.AOCEnabled
Determines if Advice of Charge handling would be applied to a
call.
Values:
SS7-ITU
SS7-ITU
TRUNKGROUP
TRUNKGROUP
0 = AOC is not enabled
1 = AOC is enabled
Default: 0 (not enabled).
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
*.AOCInvokeType
TRUNKGROUP
Allows configuration of whether or not the AOC
Supplementary services are applicable on a per call basis or
for all calls. Values: 1 (on a per call basis the default) or 2 (for
all calls).
TRUNKGROUP
Default: 1
COMMONPROFILE
EISUPPROFILE
SIPPROFILE
DOMAINPROFILE
*.AOCNodeID
This property is included in the Advice of Charge message to SS7-ITU
identify the node in the network that is activating the AOC
SS7-UK
service to this call. The subfiles (x/y/z) are limited to the range
0 to 214-1
SS7-ITU
SS7-UK
COMMONPROFILE
Values: 0 to 16383 – 0 to 16383 – 0 to 16383
Default: 0 to 0 to 0
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-10
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.AtmConnection
Type
Controls the value of the connection type parameter (ct:) in the TRUNKGROUP
local connection options. AtmConnectionType affects
originating and terminating ATM call legs.
Note
Associated
Components for
Release 9.8
TRUNKGROUP
COMMONPROFILE
ATM profile negotiation can work over Extended
ISUP (EISUP) too.
Valid values:
•
1 (AAL1)
•
2 (AAL1_SDT)
•
3 (AAL1_UDT)
•
4 (AAL2)
•
5 (AAL 3/4)
•
6 (AAL5)
Default value: 4 (AAL2)
*.atpInclude
Indicates whether or not to include the Access Transport
Parameter in an IAM. Values: 0 (for no) or 1 (for yes).
SS7-ANSI
COMMONPROFILE
TRUNKGROUP
GRPROFILE
Default: 0
*.AuditWhenSscIs
Specifies if the Cisco PGW 2200 Softswitch (the engine) will MGCP
perform an audit on the endpoints of the gateway associated
with this cxnSigPath when the Cisco PGW 2200 Softswitch
receives an In Service (IS) Service State Change (SSC)
message. When the value = True, the audit is performed
automatically to update the endpoint when the connection is
available, which may introduce too much traffic for large
gateways (MGX8260, VISM) and cause a performance
impact. When the value = False, the endpoint is brought up in
service until a manual audit is performed or after a call is
received before the actual endpoint state is determined. Values
are: True (1) or False (0).
ISDNPRI (BRI)
MGCP
Default: False
*.BcInitState
The initial status the Cisco PGW 2200 Softswitch places its
nailed up bearer channels following application restart. The
MGW can override this status with GSM messages. Values
are: IS (in service) or OOS (out of service).
DPNSS
DPNSS
ISDNPRI
ISDNPRI (BRI)
Default: IS
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-11
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.BDigitCCPrefix
Controls functionality that applies a country code prefix to the DPNSS
called party number before sending the call forward.
ISDNPRI
Values are: 0 (disabled) or 1 (enabled).
MGCP
Default: 0
SS7-ANSI
Associated
Components for
Release 9.8
DPNSS
H248
ISDNPRI (BRI)
MGCP
SS7-China
SIP
SS7-ITU
SS7-ANSI
SS7-Japan
SS7-China
SS7-UK
SS7-ITU
TRUNKGROUP
SS7-Japan
SS7-UK
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
*.BDigitCCrm
Provides a country code digit string to which the called party
number leading digits can be compared, and if matched have
those digits removed from the front of the number. This
modification is made before sending the call forward. Values
are: NULL (default) or null, or a maximum 5-digit string.
DPNSS
DPNSS
ISDNPRI
H248
MGCP
ISDNPRI (BRI)
SS7-ANSI
MGCP
SS7-China
SIP
SS7-ITU
SS7-ANSI
SS7-Japan
SS7-China
SS7-UK
SS7-ITU
TRUNKGROUP
SS7-Japan
SS7-UK
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-12
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.BInternational
Prefix
DPNSS
Determines the prefix of the outgoing called number when
NOA = International. Value range: NULL or a numeric string.
ISDNPRI
Default: NULL
MGCP
Associated
Components for
Release 9.8
DPNSS
H248
ISDNPRI (BRI)
SS7-ANSI
MGCP
SS7-China
SS7-ANSI
SS7-ITU
SS7-China
SS7-Japan
SS7-ITU
SS7-UK
SS7-Japan
TRUNKGROUP
SS7-UK
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
*.BNationalPrefix
Determines the prefix of the outgoing called number when
NOA = National. Value range: NULL or a numeric string.
DPNSS
DPNSS
ISDNPRI
H248
Default: NULL
MGCP
ISDNPRI (BRI)
SS7-ANSI
MGCP
SS7-China
SS7-ANSI
SS7-ITU
SS7-China
SS7-Japan
SS7-ITU
SS7-UK
SS7-Japan
TRUNKGROUP
SS7-UK
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-13
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
Property
Definition
*.Bnumnormalise
Indicates that B-number (CdPn) normalization is appropriate TRUNKGROUP
based on the NOA value and the leading digits of the
B-number. Leading digits 0 or 00 are the only accepted digits.
Valid values: 0 (disabled) or 1 (enabled).
EISUPPROFILE
Default: 0
COMMONPROFILE
This property is added in software Release 9.4(1) and is a
European feature only.
DOMAINPROFILE
Specifies if bothway release / circuit-free handling for BTNUP DPNSS
protocol is enabled. Set to 0 to disable. Values: 0 or 1.
ISDNPRI
Default: 1
SS7-ANSI
DPNSS
*.Bothway
Working
*.BTechPrefix
TRUNKGROUP
SIPPROFILE
ISDNPRI (BRI)
SS7-ANSI
SS7-China
SS7-China
SS7-ITU
SS7-ITU
SS7-Japan
SS7-Japan
SS7-UK
SS7-UK
TRUNKGROUP
Provides a digit string to be used as a Tech Prefix to the
B-number when sending the call forward. Valid values: any
integer.string from one digit (minimum) through 16
(maximum) digits. The Tech Prefix uses overdecadic digits B
and C and maps them to * and # respectively. The Tech Prefix
and a separator are appended to the beginning of the
B-number.
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
This property is added in software Release 9.5(2)
*.CallForward
RerouteDisabled
Disables Call Forwarding rerouting for all calls on the
Cisco PGW 2200 Softswitch. Valid values: 0 (reroute
enabled) or 1 (reroute disabled).
Default: 0
This property is added in software Release 9.4(1).
DPNSS
DPNSS
EISUP
EISUP
ISDNPRI
ISDNPRI (BRI)
TRUNKGROUP
TRUNKGROUP
COMMONPROFILE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-14
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.CallHoldInter
workingEnabled
EISUP
Indicates whether Cisco PGW 2200 Softswitch interworks
call hold and TP between SIP/H.323, EISUP, and ISUP. When
SIP
this property is configured as disabled,
Cisco PGW 2200 Softswitch drops HOLD and TP indications
coming from the ISUP side. If the property is configured
enabled, Cisco PGW 2200 Softswitch maps the ISUP side
HOLD and TP to SIP Re-Invite.
Associated
Components for
Release 9.8
EISUP
SIP
Valid values:
•
0—TDM to IP hold interworking disabled (but IP to TDM
hold interworking enabled)
•
1—Bidirection hold interworking enabled
•
2—IP to TDM hold interworking disabled (but TDM to IP
hold interworking enabled)
•
3—Bidirection hold interworking disabled
Default Value: 1
Dynamically Reconfigurable: yes
*.CallTagList
Indicates the tag list for a specified trunk group. You define the —
CallTagList property by issuing an MML command. The
property is saved in a TimesTen database table.
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
Value: String (32 alpha/numeric characters)
COMMONPROFILE
Default: NULL
This property is added in software Release 9.8(1).
*.CarrierInfo
TransferBackward
Japan ISUP; mandatory in ACM and ANM. If it is not present, SS7-Japan
it is generated using the default value. Value range: As many
as 25 characters.
SS7-Japan
Default: 00FC05FE03000231
*.CarrierInfo
TransferForward
SS7-Japan
Japan ISUP; mandatory in IAM. If it is not present, it is
generated using the default value. Value range: As many as 25
characters.
SS7-Japan
Default: 00FB05FE03000231
*.CarrierScreening Determines if carrier screening and selection is to be applied
on this call (using the carrier translation table).
Values:
TRUNKGROUP
TRUNKGROUP
COMMONPROFILE
0 = Do not apply
1 = Apply carrier selection
Default: 0
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-15
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.carrierSelect
Include
SS7-ANSI
Indicates whether or not to include the carrier selection
information parameter in an IAM. Values: 0 (for no) or 1 (for
TRUNKGROUP
yes).
SS7-ANSI
COMMONPROFILE
GRPROFILE
Default: 0
*.CCOrigin
Associated
Components for
Release 9.8
Provides against the origin trunk group of a call the country
code digits, which if needed can be prefixed on a number
before sending the call forward. Only required when the
property domain is SigPath or LinkSet. Values: NULL or a
maximum 5-digit string.
DPNSS
DPNSS
ISDNPRI
H248
MGCP
ISDNPRI (BRI)
SS7-ANSI
MGCP
Default: NULL
SS7-China
SIP
SS7-ITU
SS7-ANSI
SS7-Japan
SS7-China
SS7-UK
SS7-ITU
TRUNKGROUP
SS7-Japan
SS7-UK
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
*.CctGrpCarrier
Indicates the method of circuit group carrier so that circuit
validation tests may be fully compliant with ANSI T1.113.
Values are:
SS7-ANSI
SS7-ANSI
COMMONPROFILE
0 = unknown
1 = analog
2 = digital (default)
3 = digital & analog
*.CGBA2
Determines if group (0) or Individual (1) circuit group
blocking acknowledgments (CGBAs) are required before the
blocking is considered successful. Only applicable to ANSI
SS7, IBN7, and CTUP protocols. Values: 0 or 1. (Only
available in software Release 9.3(2) and later.)
DPNSS
DPNSS
ISDNPRI
ISDNPRI (BRI)
SS7-ANSI
SS7-ANSI
SS7-China
SS7-China
When set to 1, a significant performance impact occurs SS7-ITU
for individual circuit supervision messages during
SS7-Japan
maintenance or during a failure condition.
SS7-UK
Default: 0
TRUNKGROUP
Note
SS7-ITU
SS7-Japan
SS7-UK
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-16
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.cgpnForce
Incomplete
Provides a configurable option to set the Calling Party Number
Incomplete Indicator field within IAM to Incomplete for all
calls. A new sigPath property (*.cgpnForceIncomplete) has
been created to enable this functionality. This property is read
by the protocol when packing the Calling Party Number
parameter in an outgoing message. If the property is set, then
the protocol overrides the Call Context value so that the
Incomplete Indicator is Incomplete (1).
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
EISUP
EISUP
SS7-China
SS7-China
SS7-ITU
SS7-ITU
SS7-Japan
SS7-Japan
SS7-UK
SS7-UK
COMMONPROFILE
Valid values are: 0 (default) (disable function and allow the
protocol to set its value normally) and 1 (incomplete).
This newly patched property is only available in properties.dat
in the /opt/CiscoMGC/etc/CONFIG_LIB/new directory.
*.cgpnInclude
Indicates whether or not to include the CGPN in the IAM on
the originating trunk group. Values: 0 (no) or 1 (yes).
SS7-ANSI
SS7-ANSI
TRUNKGROUP
COMMONPROFILE
Default: 1
*.CgpnPres
GRPROFILE
SS7-ANSI
Determines if the incoming called number presentation
indication is to be overridden. Values: 0 (False) for leave as-is TRUNKGROUP
or 1 (True) for set to presentation restricted.
COMMONPROFILE
GRPROFILE
Default: 0
*.CgpnPresRes
SS7-ANSI
Calling party number restricted. Determines if the incoming SS7-ANSI
called number presentation indication is to be overridden.
SS7-ITU
Value range: 0 (False) (default) for leave as-is, or 1 (True) for
SS7-UK
set to presentation restricted.
TRUNKGROUP
SS7-ANSI
SS7-ITU
SS7-UK
TRUNKGROUP
COMMONPROFILE
*.ChargeArea
Information
This property is mandatory for Japan ISUP and it has to be
changed for different areas. It allows changing charge area
information for different locations. Value range: As many as
25 characters.
SS7-Japan
SS7-Japan
SS7-ITU
SS7-ITU
TRUNKGROUP
TRUNKGROUP
Default: 010203
*.ChargeOrigin
Specifies the charge origin. The craftperson decides what
value of charge origin is to be used. Value range: 0 to 9999
Default: 0
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-17
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
CheckANumData
NOA
checks for A Number nature of address and modify National
Indicator Flag
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
mdl-SIP
.Default value is 0 and possible values are 0 and 1.
CheckANumDataNOA ( 0=disable, 1= enable)
This property is used to modify National indicator flag only
when the incoming message is a SIPI invite(SIP - ISUP
embedded message)
*.checkClear
ChannelCodecIn
SDP
—
Use this property to control whether the Cisco PGW 2200
Softswitch checks the clear channel codec in the SDP of the
first incoming SIP INVITE message to conclude that a call is
a data call. This property is provisioned in SIP profiles. Valid
values: boolean.
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
0 = no clear channel codec check in the SDP.
1 = performs the clear channel codec check in the SDP.
Default value: 0.
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
*.CheckSipTgrp
Param
—
Use this property to control whether the Cisco PGW 2200
Softswitch checks the tgrp parameter in the request line of the
first incoming SIP INVITE message to conclude that a call is
a data call. This property is provisioned in SIP profiles.
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Valid values: boolean.
0 = does not check the tgrp parameter in the request line.
1 = checks the tgrp parameter in the request line.
Default value: 0.
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
*.chnNonGeo
Indicates whether or not to include the Charge Number in an SS7-ANSI
IAM on all calls to non-geographic numbers. The geographic
TRUNKGROUP
nature of a number is determined by the Address Class
analysis result value. Values: 0 (for no) or 1 (for yes).
SS7-ANSI
COMMONPROFILE
GRPROFILE
Default: 0
*.chnOlipInclude
SS7-ANSI
Indicates whether or not to include Charge Number and
Originating Line Info as a pair in the IAM. Values: 0 (for no) TRUNKGROUP
or 1 (for yes).
Default: 0
SS7-ANSI
COMMONPROFILE
GRPROFILE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-18
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.cipInclude
Indicates whether or not to include the Carrier Identification
Parameter (CIP) in an IAM. Values: 0 (for no) or 1 (for yes).
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
SS7-ANSI
SS7-ANSI
TRUNKGROUP
COMMONPROFILE
Default: 0
*.cipNonGeo
GRPROFILE
Indicates whether or not to include the CIP in an IAM on all
calls to non-geographic numbers. Values: 0 (for no) or 1 (for
yes).
SS7-ANSI
SS7-ANSI
TRUNKGROUP
COMMONPROFILE
GRPROFILE
Default: 0
*.CircHopCount
Set a maximum value for the number of hops before a call
must be completed.
Valid values: 0-31
Note
EISUP
EISUP
SS7-ANSI
SS7-ANSI
TRUNKGROUP
SS7-ITU
When set to 0, the property is disabled.
SS7-UK
COMMONPROFILE
Default: 0
*.CLIDefault
Allowed
If set to TRUE then it adjusts the presentation restricted field
in the CLI to Presentation Allowed; if FALSE then it takes the
mapped value from the OCC or TCC protocol side or the
default value from the Map for this field if there is no received
value from the other protocol side. Values: TRUE or FALSE
SS7-ANSI
SS7-ANSI
SS7-ITU
SS7-ITU
SS7-Japan
SS7-Japan
SS7-UK
SS7-UK
Default: FALSE
*.ClcIsdnPack
COMMONPROFILE
Determines whether the CLC_ISDN should be passed when
originating side is SIP. This property should be set on the
terminating side. Valid values:
SIP
—
0—Do not pass CLC_ISDN.
1—If originating protocol is SIP, pack CLC_ISDN(3) in the
outgoing message.
Default value: 0.
This property is added in software Release 9.7(3) S32P32.
*.ClcTransparency Determines whether the Cisco PGW 2200 Softswitch transits DPNSS
CLC_ISDN or CLC_PSTN transparently when both
originating and terminating side are DPNSS. The property
should be set on the terminating side. Valid values:
—
0—PGW does not transit CLC_ISDN or CLC_PSTN
1—PGW transits CLC_ISDN or CLC_PSTN transparently
Default: 0
This property is added in software Release 9.7(3) S30P30.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-19
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
Property
Definition
*.CLIPEss
Sets the Calling Line Identity Presentation Essential
operation. 0—Do not request CLI., 1—Request CLI if not
already provided and drop the call if CLI is not provided, or
2—Request CLI if not already provided and continue with the
call even if CLI is not provided.
DPNSS
DPNSS
EISUP
EISUP
ISDNPRI
ISDNPRI (BRI)
SS7-ANSI
SS7-ANSI
Value range: 0, 1, or 2.
SS7-China
SS7-China
Default: 0
SS7-ITU
SS7-ITU
SS7-Japan
SS7-Japan
SS7-UK
SS7-UK
COMMONPROFILE
*.CLISelect
This is used to determine the presentation number. Values: CLI SS7-China
or GENERICNUM.
SS7-ITU
Default: CLI
SS7-Japan
SS7-China
SS7-ITU
SS7-Japan
SS7-UK
SS7-UK
TRUNKGROUP
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
*.CliSelectionFor
CodeOfPractice3
Provision the level of calling line identity (CLI) that you want TRUNKGROUP
the PGW 2200 to use when sending the calling line identities
(such as Calling Party Number or Generic Number parameter)
to the next exchange. Valid values for this property are in the
range 0-2 (Default 0).
ISDNPRI (BRI)
Valid values for the property
CliSelectionForCodeOfPractice3:
COMMONPROFILE
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
DOMAINPROFILE
0—Indicates no specific CLI selection (default)
1—Indicates single CLI selection. Sends only the CLI.
2—Indicates dual CLI selection. Sends the CLI; or the PGW
2200 send the CLI and the PN.
3—Indicates CBI bit transparency over DSS1.
Set the property CliSelectionForCodeOfPractice3 to 0 or 2 to
meet your service-provider requirements.
*.CLLI
Specifies the common language location identifier (CLLI).
Default: NULL
TRUNKGROUP
TRUNKGROUP
COMMONPROFILE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-20
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.CNAPService
Indicates whether name mapping between ISUP and NAS is
enabled.
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
SS7-ANSI
SS7-ANSI
SSI-ITU
SS7-China
Values:
•
0 = CNAP Service is disabled.
•
1 = CNAP Service is enabled.
SSI-ITU
SS7-Japan
SS7-UK
Default: 0
*.COLDefault
Allowed
If set to TRUE then it adjusts the presentation restricted field SSI-ITU
in the connected line Id to Presentation Allowed; if FALSE
SS7-Japan
then it takes the mapped value from the OCC or TCC protocol
side or the default value from the Map for this field if there is SS7-UK
no received value from the other protocol side. Values: TRUE
or FALSE
SSI-ITU
SS7-Japan
SS7-UK
COMMONPROFILE
Default: FALSE
*.commonprofile
Contains a pointer to a Common Profile.
—
EISUPPROFILE
SIPPROFILE
Valid values: String. Enter the name of an existing Common
Profile.
Default value: NULL
Dynamically reconfigurable: Yes
This property is added in software Release 9.8(1).
*.Compression
Type
Compression type. Indicates the G.711 compression type used DPNSS
on the trunk. Values are: 0 (none), 1 (mu-law), 2 (A-law), or 3
ISDNPRI
(clear channel).
MGCP
Default: 1
TRUNKGROUP
DPNSS
ISDNPRI (BRI)
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
*.confusion
A flag indicating whether or not to send the Confusion
message when an unrecognized message type is received.
Values: 0 (for no) or 1 (for yes).
SS7-ANSI
SS7-ANSI
TRUNKGROUP
COMMONPROFILE
GRPROFILE
Default: 0
*.congProc
Indicates the procedure to follow when there is congestion on SS7-ANSI
ISUP circuits. This value is taken from the originating trunk TRUNKGROUP
group and used when reattempting occurs. Values: ALTRTE
(alternate routing) or BLO (blocking).
SS7-ANSI
COMMONPROFILE
GRPROFILE
Default: ALTRTE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-21
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
Associated
Components for
Release 9
through 9.7
SIP
*.ContactListOrder Defines the order in which the target list is appended, once
new Contact headers are received in a 300, 301, or 302
response message. Values are 1 (default)-At the beginning of
the list, 2-At the end of the list, or 3-Replace the list with the
new list. Valid values: 1 through 3.
Associated
Components for
Release 9.8
SIP
Default value:1
*.CorrelationCall
IDFormat
Indicates the type of correlation identifier sent in the call
establishment message. Values: 0 (H.323) or 1 (SIP).
DPNSS
DPNSS
ISDNPRI
ISDNPRI (BRI)
Default: 0
Receive tone for continuity test (COT) hardware. The tone to DPNSS
listen for when doing a COT. Enter value in Hz. Values: 1780 ISDNPRI
or 2010.
SS7-ANSI
Default: 2010
SS7-China
*.CotInTone
*.CotOn
Terminating
Support
DPNSS
ISDNPRI (BRI)
SS7-ANSI
SS7-China
SSI-ITU
SSI-ITU
SS7-Japan
SS7-Japan
SS7-UK
SS7-UK
Determines if the terminating side does not fully support COT. SSI-ITU
If the terminating side does not support COT, the
Cisco PGW 2200 Softswitch waits for the COT result from the
originating switch and then forwards the IAM to the
terminating side. Values: 0 (COT special handling is required)
or 1 (COT is fully supported on the terminating side).
SSI-ITU
Default: 1
*.CotOutTone
Transmit tone for COT hardware. The tone that is produced.
Enter value in Hz. Values: 1780 or 2010.
Default: 2010
DPNSS
DPNSS
ISDNPRI
ISDNPRI (BRI)
SS7-ANSI
SS7-ANSI
SS7-China
SS7-China
SSI-ITU
SSI-ITU
SS7-Japan
SS7-Japan
SS7-UK
SS7-UK
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-22
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
Associated
Components for
Release 9
through 9.7
*.CotPercentage
Statistical COT. Value range: 0 through 100%.
DPNSS
DPNSS
Default: 0
ISDNPRI
ISDNPRI (BRI)
SS7-ANSI
SS7-ANSI
SS7-China
SS7-China
SSI-ITU
SSI-ITU
SS7-Japan
SS7-Japan
SS7-UK
SS7-UK
TRUNKGROUP
TRUNKGROUP
Associated
Components for
Release 9.8
COMMONPROFILE
*.CustGrpId
*.CustomerVPNid
*.CustomerVPN
OffNetTblNum
TRUNKGROUP
ID of customer associated with a particular trunk group
(previously called VNET ID). Maps to trunk group property
CustGrpId. Values are any alphanumeric with length of 4, or 0
if not defined.
EISUPPROFILE
Default: 0000
COMMONPROFILE
Assigns a VPN ID to a trunk group or system. Valid values: 1 DPNSS
through 8 alphanumeric character string.
EISUP
Default: 00000000
ISDNPRI
DPNSS
This property is added in software Release 9.4(1).
QSIG
TRUNKGROUP
TRUNKGROUP
COMMONPROFILE
DPNSS
DPNSS
Allows assignment of a VPN off-net profile table index to a
particular trunk group. Value range: 1 through 8
EISUP
1 (Indicates that completely transparent operation is required
ISDNPRI
or the call will not complete.)
2 (Sets to feature transparency preferred by a nontransparent QSIG
destination can be used if necessary to complete the call.)
TRUNKGROUP
3 (Sets to feature transparency preferred by a nontransparent
destination can be used if necessary to complete the call.)
4 (Sets to feature transparency preferred by a nontransparent
destination can be used if necessary to complete the call.)
5 (Sets to indicate that the attempted feature will be removed
from the onward routed call, and the indicator is informed of
this.)
6 (Sets to release a feature call.)
7 (Sets to release a feature call.)
8 (Sets to remove the feature string and continue.)
TRUNKGROUP
SIPPROFILE
EISUP
ISDNPRI (BRI)
EISUP
ISDNPRI (BRI)
TRUNKGROUP
COMMONPROFILE
Default: 0
This property is added in software Release 9.4(1). The range
changed to 1-8 and the default changed to 5 in software
Release 9.6(1)
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-23
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.CustomerVPN
OnNetTblNum
Allows assignment of a VPN on-net profile table index to a
particular trunk group. Value range: 1 through 8
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
DPNSS
DPNSS
EISUP
1 (Indicates that completely transparent operation is required ISDNPRI
or the call will not complete.)
2 (Sets to feature transparency preferred by a nontransparent QSIG
destination can be used if necessary to complete the call.)
TRUNKGROUP
3 (Sets to feature transparency preferred by a nontransparent
destination can be used if necessary to complete the call.)
4 (Sets to feature transparency preferred by a nontransparent
destination can be used if necessary to complete the call.)
5 (Sets to indicate that the attempted feature will be removed
from the onward routed call, and the indicator is informed of
this.)
6 (Sets to release a feature call.)
7 (Sets to release a feature call.)
8 (Sets to remove the feature string and continue.)
EISUP
ISDNPRI (BRI)
TRUNKGROUP
COMMONPROFILE
Default: 0
This property is added in software Release 9.4(1). The range
changed to 1-8 and the default changed to 5 in software
Release 9.6(1)
Cutthrough
Possible Values: 0 through 3; (0)
0 = Undefined
1 = Seize - call is through connected a seize, not applicable
ROUTING TRUNK
ROUTING
TRUNK GROUP GROUP
SIP TRUNK
GROUP
SIP TRUNK GROUP
SS7-ANSI
SS7-ANSI
TRUNKGROUP
COMMONPROFILE
2 = ACM - call is through connected at ACM
3 = ANM - call is through connected at ANM
*.defaultBC
Default bearer capability. Indicates the coding used by the
User Service Information parameter in the outgoing IAM
message.
For the SS7-UK protocol family, setting the property to
3_1_KHZ, converts the outgoing ISDN 3.1 kHz (CAT3) call
over BTNUP Trunk Group to ISDN speech (CAT2) call.
Values are: SPEECH or 3_1_KHZ.
GRPROFILE
Default: SPEECH
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-24
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
Property
Definition
*.DefaultCARID
NatNetIdPlan
EISUP
Maps to trunk group property DefaultCARIDNatNetIdPlan
(Default Carrier Identifier National Network Identifier Plan).
SS7-ANSI
Values are: 0 (NOTUSED),
TRUNKGROUP
1 (NATIONAL_NETWORK_ID_NATIONAL
CARRIER_ACCESS_CODE),
2 (NATIONAL_NETWORK_ID_PLAN_2_DIGIT),
3 (NATIONAL_NETWORK_ID_PLAN_3_DIGIT), or
4 (NATIONAL_NETWORK_ID_PLAN_4_DIGIT).
EISUP
Default: 0
DOMAINPROFILE
EISUP
Maps to trunk group property DefaultCARIDNetId (Default
Carrier Identifier Network Identifier). Values are: 2 to 4 digits or
SS7-ANSI
NULL.
TRUNKGROUP
Default: 00
EISUP
*.DefaultCARID
NetId
SS7-ANSI
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
SS7-ANSI
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
*.DefaultCARID
NetType
Maps to trunk group property DefaultCARIDNetType
(Default Carrier Identifier Network Type). Values: 0
(NOTUSED),
1 (NETWORK_USER_SPECIFIED),
2 (NETWORK_NATIONAL),
3 (NETWORK_INTERNATIONAL), or
4 (NETWORK_CCITT).
EISUP
EISUP
SS7-ANSI
SS7-ANSI
TRUNKGROUP
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
Default: 0
DOMAINPROFILE
*.DefaultCHG
Maps to trunk group property DefaultCHG (Default Charge
Number). Values are: 1 to 16 digits or NULL.
Default: 0
Note
For an SS7 trunk group, if you set this property to a
value other than the default (0), you must also set the
properties *.DefaultCHGNOA and *.DefaultCHGNPI
to non-default values.
EISUP
EISUP
SS7-ANSI
ISDNPRI (BRI)
TRUNKGROUP
SS7-ANSI
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-25
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.DefaultCHG
NOA
Maps to trunk group property DefaultCHGNOA (Default
Charge Number NOA). Values are: 0 (NOTUSED),
1 (CHNOA_ANI_CGSUB_SUB_NUM),
2 (CHNOA_ANI_NOT_AVAIL),
3 (CHNOA_ANI_CGSUB_NAT_NUM),
4 (CHNOA_ANI_CDSUB_SUB_NUM),
5 (CHNOA_ANI_CDSUB_NO_NUM), or
6 (CHNOA_ANI_CDSUB_NAT_NUM).
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
EISUP
EISUP
SS7-ANSI
ISDNPRI (BRI)
TRUNKGROUP
SS7-ANSI
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
Default: 0
Note
*.DefaultCHGNPI
COMMONPROFILE
For an SS7 trunk group, if you set this property to a
value other than the default (0), you must also set the
properties *.DefaultCHG and *.DefaultCHGNPI to
non-default values.
Maps to trunk group property DefaultCHGNPI (Default
Charge Number NPI). Values are: 0 (NOTUSED),
1 (NPI_NONE),
2 (NPI_E164),
3 (NPI_DATA),
4 (NPI_TELEX),
5 (NPI_PNP),
6 (NPI_NATIONAL),
7 (NPI_TELEPHONY),
8 (NPI_MARITIME_MOBILE),
9 (NPI_LAND_MOBILE), or
10 (NPI_ISDN_MOBILE).
DOMAINPROFILE
EISUP
EISUP
SS7-ANSI
ISDNPRI (BRI)
TRUNKGROUP
SS7-ANSI
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default: 0
Note
For an SS7 trunk group, if you set this property to a
value other than the default (0), you must also set the
properties *.DefaultCHG and *.DefaultCHGNOA to
non-default values.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-26
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.DefaultCPC
Add a new trunk group property DefaultCPC. If not NULL and —
within the specified range (0-20), pass this information on the
Egress IAM.Values are:
Associated
Components for
Release 9.8
EISUP
SS7-ANSI
TRUNKGROUP
0 (NOTUSED),
1 (CLASS_LANG_UNKNOWN),
2 (CLASS_LANG_ENGLISH),
3 (CLASS_LANG_RUSSIAN),
4 (CLASS_LANG_FRENCH),
5 (CLASS_LANG_GERMAN),
6 (CLASS_LANG_SPANISH),
7 (CLASS_LANG_ITALIAN),
8(CLASS_LANG_DUTCH),
9(CLASS_LANG_CHINESE),
10 ( CLASS_LANG_JAPANESE),
11 (CLASS_LANG_ARABIC),
12 (CLASS_LANG_GREEK),
13 (CLASS_LANG_PORTUGESE),
14 (CLASS_LANG_NORWEGIAN),
15 (CLASS_LANG_SWEDISH),
16 (CLASS_LANG_HUNGARIAN),
17 (CLASS_LANG_ADMIN1),
18(CLASS_LANG_ADMIN2),
19(CLASS_LANG_ADMIN3), or
20 (CLASS_LANG_MARTIAN)
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default:0
This property is added in software Release 9.8(1).
*.DefaultDN
Maps to trunk group property DefaultDN (Default Directory EISUP
Number). This property is needed on the Trunk Group if it is a SS7-ANSI
switched call and on the SigPath if it is a nailed call. Values
TRUNKGROUP
are: 1 to 14 digits or NULL.
EISUP
Default: 0
EISUPPROFILE
SS7-ANSI
TRUNKGROUP
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-27
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.DefaultDNNOA
Default Directory Number NOA. Values are
0 (NOTUSED),
1 (NOA_NONE),
2 (NOA_UNKNOWN),
3 (NOA_SUBSCRIBER),
4 (NOA_NATIONAL),
5 (NOA_INTERNATIONAL),
6 (NOA_NETWORK),
7 (NOA_MERIDIAN),
8 (NOA_ABBR),
9 (NOA_UNIQUE_3DIG_NAT_NUM),
10 (NOA_ANI),
11 (NOA_NO_ANI_RECD),
12 (NOA_NON_UNIQUE_SUBSCRIBER),
13 (NOA_NON_UNIQUE_NATIONAL),
14 (NOA_NON_UNIQUE_INTERNATIONAL),
15 (NOA_OPRREQ_TREATED),
16 (NOA_OPRREQ_SUBSCRIBER),
17 (NOA_OPRREQ_NATIONAL),
18 (NOA_OPRREQ_INTERNATIONAL),
19 (NOA_OPRREQ_NO_NUM),
20 (NOA_CARRIER_NO_NUM),
21 (NOA_950_CALL),
22 (NOA_TEST_LINE_CODE),
23 (NOA_INT_INBOUND),
24 (NOA_NAT_OR_INTL_CARRIER_ACC_CODE_INC),
25 (NOA_CELL_GLOBAL_ID_GSM),
26 (NOA_CELL_GLOBAL_ID_NMT_900),
27 (NOA_CELL_GLOBAL_ID_NMT_450),
28 (NOA_CELL_GLOBAL_ID_AUTONET),
29 (NOA_PORTED_NUMBER),
30 (NOA_PISN_SPECIFIC_NUMBER),
31 (NOA_UK_SPECIFIC_ADDRESS),
32 (NOA_SPARE),
33 (NOA_MCI_VNET),
34 (NOA_INTERNATIONAL_OPR_TO_
OPR_OUTSIDE_WZI),
35 (NOA_INTERNATIONAL_OPR_TO_
OPR_INSIDE_WZI),
36 (NOA_DIRECT_TERMINATION_OVERFLOW),
37 (NOA_ISN_EXTENDED_
INTERNATIONAL_TERMINATION),
38 (NOA_TRANSFER_ISN_TO_ISN),
39 (NOA_CREDIT_CARD),
40 (NOA_DEFINED_IN_SSUTR),
41 (NOA_DEFINED_IN_SSUTR2),
42 (RESERVED), or 43 (NOA_DISCARDED). Default: 0.
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
EISUP
EISUP
SS7-ANSI
SS7-ANSI
TRUNKGROUP
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-28
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.DefaultDNNPI
Maps to trunk group property DefaultDNNPI (Default
Directory Number NPI). Values are: 0 (NOTUSED),
1 (NPI_NONE),
2 (NPI_E164),
3 (NPI_DATA),
4 (NPI_TELEX),
5 (NPI_PNP),
6 (NPI_NATIONAL),
7 (NPI_TELEPHONY),
8 (NPI_MARITIME_MOBILE),
9 (NPI_LAND_MOBILE), or
10 (NPI_ISDN_MOBILE).
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
EISUP
EISUP
SS7-ANSI
SS7-ANSI
TRUNKGROUP
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default: 0
*.DefaultDNPres
EISUP
Maps to trunk group property DefaultDNPres (Default
Directory Presentation Indicator). Values are: 0 (NOTUSED), SS7-ANSI
1 (PRES_NO_INDICATION),
TRUNKGROUP
2 (PRES_ALLOWED),
3 (PRES_RESTRICT), or
4 (PRES_UNAVAIL).
Default: 0
EISUP
SS7-ANSI
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
*.DefaultDNSI
Maps to trunk group property DefaultDNSI (Default Directory EISUP
Screening Indicator). Values are: 0 (NOTUSED),
SS7-ANSI
1(SI_NONE),
TRUNKGROUP
2 (SI_USER_PROVIDED_NOT_VERIFIED),
3 (SI_USER_PROVIDED_VERIFIED_
PASSED),
4 (SI_USER_PROVIDED_VERIFIED_
FAILED), or
5 (SI_NETWORK_PROVIDED).
EISUP
SS7-ANSI
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default: 0
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-29
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.DefaultFCINat
Ind
Provisions the FCI A bit (national call indicator) integer. If
you do not configure this property, the SIP module uses the
default value. Both ISUP and TUP use this property. For the
eisup national indicator transparency, the
Cisco PGW 2200 Softswitch checks for the existence of a
national indicator. If a national indicator exists, the
Cisco PGW 2200 Softswitch uses it rather than generate it
from the NOA.
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
SIP
SIP
Valid Values:
•
0 = national call
•
1 = international call
Default: 0 (indicates that the call will be treated as national
call)
Dynamically Reconfigurable: yes
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-30
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.DefaultOLI
Maps to trunk group property DefaultOLI (Default
Originating Line Information). Values: 0 (NOTUSED),
1 (OLI_POTS),
2 (OLI_MULTIPARTY_LINE),
3 (OLI_ANI_FAILURE),
4 (OLI_STATION_LEVEL_RATING),
5 (OLI_SPECIAL_OPERATOR_REQ),
6 (OLI_AIOD),
7 (OLI_COIN_DATABASE),
8 (OLI_800_SERVICE_CALL),
9 (OLI_COIN),
10 (OLI_PRISON_INMATE_SERVICE),
11 (OLI_INTERCEPT_BLANK),
12 (OLI_INTERCEPT_TROUBLE),
13 (OLI_INTERCEPT_REGULAR),
14 (OLI_TELCO_OPERATOR_CALL),
15 (OLI_OUTWATS),
16 (OLI_TRS_1),
17 (OLI_TRS_2),
18 (OLI_TRS_3),
19 (OLI_CELLULAR_SVC_1),
20 (OLI_CELLULAR_SVC_2),
21 (OLI_CELLULAR_SVC_ROAMING),
22 (OLI_PRIVATE_PAYSTATIONS),
23 (OLI_ACCESS_FOR_VPN_TYPES_OF_SVC),
24 (OLI_INTERLATA_RESTRICTED),
25 (OLI_TESTCALL),
26 (OLI_TOLLFREE_FROM_PAYSTATIO),
27 (OLI_CUSTOMER_SPECIFIC_1),
28 (OLI_CUSTOMER_SPECIFIC_2),
29 (OLI_INTERLATA_RESTRICTED_HOTEL), or
30 (OLI_INTERLATA_RESTRICTED_COINLESS).
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
EISUP
EISUP
SS7-ANSI
SS7-ANSI
TRUNKGROUP
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default: 0
*.DefaultPN
Enables the incoming trunk group to have a default PN if the
incoming call does not have one, overdecadic digits are
supported. Valid values: overdecadic digit string from 1
through 20 digits.
TRUNKGROUP
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
Default: NULL
COMMONPROFILE
This property is added in software Release 9.4(1).
DOMAINPROFILE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-31
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.DefaultPNNOA
Default Presentation Number NOA value. Values are
0 (NOT USED) - default, 1 (NOA_NONE),
2 (NOA_UNKNOWN), 3 (NOA_SUBSCRIBER),
4 (NOA_NATIONAL), 5 (NOA_INTERNATIONAL),
6 (NOA_NETWORK), 7 (NOA_MERIDIAN),
8 (NOA_ABBR), 9 (NOA_UNIQUE_3DIG_NAT_NUM),
10 (NOA_ANI), 11 (NOA_NO_ANI_RECD),
12 (NOA_NON_UNIQUE_SUBSCRIBER),
13 (NOA_NON_UNIQUE_NATIONAL),
14 (NOA_NON_UNIQUE_INTERNATIONAL),
15 (NOA_OPRREQ_TREATED),
16 (NOA_OPRREQ_SUBSCRIBER),
17 (NOA_OPRREQ_NATIONAL),
18 (NOA_OPRREQ_INTERNATIONAL),
19 (NOA_OPRREQ_NO_NUM),
20 (NOA_CARRIER_NO_NUM),
21 (NOA_950_CALL), 22 (NOA_TEST_LINE_CODE),
23 (NOA_INT_INBOUND),
24 (NOA_NAT_OR_INTL_CARRIER_ACC_CODE_INC),
25 (NOA_CELL_GLOBAL_ID_GSM),
26 (NOA_CELL_GLOBAL_ID_NMT_900),
27 (NOA_CELL_GLOBAL_ID_NMT_450),
28 (NOA_CELL_GLOBAL_ID_AUTONET),
29 (NOA_PORTED_NUMBER),
30 (NOA_PISN_SPECIFIC_NUMBER),
31 (NOA_UK_SPECIFIC_ADDRESS), 32 (NOA_SPARE),
33 (NOA_MCI_VNET),
34 (NOA_INTERNATIONAL_OPR_TO_
OPR_OUTSIDE_WZI),
35 (NOA_INTERNATIONAL_OPR_TO_
OPR_INSIDE_WZI),
36 (NOA_DIRECT_TERMINATION_OVERFLOW),
37 (NOA_ISN_EXTENDED_
INTERNATIONAL_TERMINATION),
38 (NOA_TRANSFER_ISN_TO_ISN),
39 (NOA_CREDIT_CARD),
40 (NOA_DEFINED_IN_SSUTR),
41 (NOA_DEFINED_IN_SSUTR2), 42 (RESERVED),
43 (NOA_DISCARDED),
44 (NOA_NETWORK_RN_CONCAT_WITH_CDPN),
45 (NOA_NAT_NUM_WITH_SELECT_OF_CARR),
46 (NOA_INT_NUM_WITH_SELECT_OF_CARR),
47 (NOA_NATIONAL_SPARE_2),
48 (NOA_PORTED_NUMBER_OR_
SCREENED_FOR_PORTING),
49 (NOA_SPECIAL_NUMBER),
50 (NOA_NATL_NUM_TRANSIT_NETWORK_SELECT),
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
TRUNKGROUP
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-32
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.DefaultPNNOA
51 (NOA_INTL_NUM_TRANSIT_NETWORK_SELECT),
52 (NOA_SPAIN),
53 (NOA_PARTIAL_CALLING_LINE_ID),
54 (NOA_NETWORK_RN_NSN_FORMAT, or
55 (NOA_NETWORK_RN_NETWORK_
SPECIFIC_FORMAT)
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
TRUNKGROUP
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default: 0
This property is added in software Release 9.4(1).
*.DefaultPNNPI
Displays the default Presentation Number NPI value. Valid
values: 0 through 10.
TRUNKGROUP
TRUNKGROUP
EISUPPROFILE
0 (NOTUSED) (default),
1 (NPI_NONE),
2 (NPI_E164),
3 (NPI_DATA),
4 (NPI_TELEX),
5 (NPI_PNP),
6 (NPI_NATIONAL),
7 (NPI_TELEPHONY),
8 (NPI_MARITIME_MOBILE),
9 (NPI_LAND_MOBILE), or
10 (NPI_ISDN_MOBILE)
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default: 0
This property is added in software Release 9.4(1).
*.DefaultPNPres
Displays the Default Presentation Number Presentation
Indicator value.
TRUNKGROUP
TRUNKGROUP
EISUPPROFILE
Valid values: 0 through 4.
SIPPROFILE
0 (NOTUSED) (default),
1 (PRES_NO_INDICATION),
2 (PRES_ALLOWED),
3 (PRES_RESTRICT), or
4 (PRES_UNAVAIL)
COMMONPROFILE
DOMAINPROFILE
Default: 0
This property is added in software Release 9.4(1).
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-33
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.DefaultTmr
This string property provisions the Transmission medium
requirement (TMR).
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
SIP
SIP
Valid Values:
•
SPEECH
•
UNRES_64K
•
AUDIO_3K
Default: SPEECH
Dynamically Reconfigurable: Yes
*.DelayedOfferTo
EarlyOffer
Interworking
This property applies to SIP calls for the called side only. The —
property indicates whether or not the
Cisco PGW 2200 Softswitch will include SDP in an initial
INVITE message if the Cisco PGW 2200 Softswitch does not
receive SDP in a message from the calling side. Provision this
property on the TCC SIP trunk group.
SIPPROFILE
DOMAINPROFILE
Valid values:
•
0—No SDP
•
1—Dummy SDP is provisioned
Default value: 0
This property is added in software Release 9.8(1).
*.delayTimer
Set a delay timer from TIOS to Engine when ISDN sigpath has DPNSS
changed service state so the Engine will not be affected by a ISDNPRI
“bouncing” link.
DPNSS
ISDNPRI (BRI)
This is supported for ISDN Q.931/Q.921/RLM and ISDN
Backhaul (Corsair) protocols only.
Default: 30
*.DeselOutCic
CDRGenerate
Controls whether the Cisco PGW 2200 Softswitch generates a TRUNKGROUP
Deselect Outgoing Circuit CDR for SIP.
SIP
Values:
•
True = The Cisco PGW 2200 Softswitch adds a Deselect
Outgoing Circuit CDR to the cdr.bin file.
•
False = The Cisco PGW 2200 Softswitch does not add a
Deselect Outgoing Circuit CDR to the cdr.bin file.
Default: True
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-34
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.dialogRange
TCAP transaction ID range (for example, 1 through 10000) for SS7-ANSI
a specific subsystem. A string of 1 to 21 ASCII characters. An
SS7-ITU
entry of zero (0) means the entire range. This property can be
provisioned for SS7-ANSI and SS7-ITU.
Associated
Components for
Release 9.8
SS7-ANSI
SS7-ITU
For example, if you set dailogrange=”1” for
proto=”SS7-ANSI” all the linksets created by this command
have dialogrange set to 1.
Command examples:
prov-ed:lnksetprop:name="SS7-ANSI", dialogrange="abc"
prov-add:name="test-lset",proto="SS7-ANSI"
Default: 0
*.DisableQSIG
ReleaseMethod
Indicates the QSIG release method. An H.225 signaling
EISUP
connection can be released with a single Release Complete
TRUNKGROUP
message instead of a three-stage QSIG release sequence. This
is only applicable to release procedures initiated by the
Cisco PGW 2200 Softswitch. The
Cisco PGW 2200 Softswitch accepts receipt of either type of
release method.
EISUP
EISUPPROFILE
COMMONPROFILE
Valid Values:
•
0 —Normal QSIG release is enabled for QSIG tunneling
•
1 —Normal QSIG release is disabled for QSIG tunneling
Default Value: 0
*.DpnssRO
RoutingNumber
Length
DPNSS
For DPNSS-QSIG PR ROO interworking, the DPNSS RO
routing number and call reference are concatenated and in
TRUNKGROUP
QSIG they are separate fields. An indication of where the
divide point is between the fields is an optional parameter in
the DPNSS specification. It is therefore necessary to provide a
configurable definition of how to split these two fields.
DPNSS
TRUNKGROUP
COMMONPROFILE
Valid Values: 2-10
Default Value: 4
*.DtmfCap
Defines the DTMF capability of the egress trunk group.
DPNSS
TRUNKGROUP
Valid values:
TRUNKGROUP
EISUPPROFILE
•
0—Ignore DTMF capability
SIPPROFILE
•
1—RFC 2833 DTMF capability
COMMONPROFILE
•
2—Out of band DTMF capability
DOMAINPROFILE
Default Value: 0
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-35
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.DummyAudio
CodecString
Specifies the dummy codec list in an H.248 add request when —
neither remote SDP nor a local codec is provisioned. This
property applies only for a DBE. Values are NULL, G.711u,
G.711a, G.726-32, G.726-24, G.726-16, G.729, G.729a,
G.729b, G.729b-L, G.723.1-H, G.723.1-L, G.723.1a-L,
G.GSM-F, G.GSM-H, and G.GSM-eF. You must separate the
values in the dummy codec list with separated by semicolons.
Associated
Components for
Release 9.8
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Valid values: a string from 1–140 characters
Default dummy codec string:
G.711u;G.711a;G.726-32;G.726-24;G.726-16;G.729;G.729a;
G.729b;G.729b-L;G.723.1-H;G.723.1-L;G.723.1a-L;G.GSMF; G.GSM-H;G.GSM-eF
This property is added in software Release 9.8(1).
*.DummyVideo
CodecString
Specifies the dummy video codec list in an H.248 add request —
when neither remote SDP nor a local codec is provisioned.
This property applies only for a DBE. Values are: NULL;
H.264; H263; H261; H263-1988; JPEG; MPV; CelB; MP2T;
nv, separated by semicolons.
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Valid values: a string from 1–140 characters
This property is added in software Release 9.8(1).
*.EchoCan
Required
Echo Canceller Required. Specifies whether to send a
modify-connection message (MDCX) for echo control. Enter
a value of 0 or 1 for EchoCanRequired on the trunk group or
sigpath.
EISUP
DPNSS
MGCP
EISUP
SS7-ANSI
ISDNPRI (BRI)
The Cisco PGW 2200 Softswitch follows the following
procedure for an SS7 terminated call after the call is answered.
If the Cisco PGW 2200 Softswitch receives a call-in-progress
message (CPG) with backward call indicators (BCI) from the
SS7 side, it takes the specified action.
SS7-China
SS7-ANSI
SS7-ITU
SS7-China
SS7-Japan
SS7-ITU
SS7-UK
SS7-Japan
If EchoCanRequired=1 on the originating side:
TRUNKGROUP
SS7-UK
•
If the echo control device (ECD) indicator = 0 in BCI,
send MDCX with e: on
•
If the ECD = 1 in BCI, send MDCX with e: off
If EchoCanRequired=0 on the originating side (default):
•
If EchoCanRequired=0 on the terminating side, do not
send an MDCX for echo control
•
If EchoCanRequired=1 on the terminating side,
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
– If ECD = 1 in incoming ACM, do not send e:on in
MDCX
– If ECD = 0 in incoming ACM, send e:on in MDCX.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-36
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.EnableCCBS
pathReservation
Allows configuration of the Path Reservation option for each
QSIG destination. In the case of EISUP, this is valid for HSI
destinations only.
Valid Values:
•
0—CCBS with Path Reservation is disabled
•
1 —CCBS with Path Reservation is enabled
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
EISUP
EISUP
QSIG
ISDNPRI (BRI)
TRUNKGROUP
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
Default Value: 0
DOMAINPROFILE
*.EnableIP
Screening
Enables the incoming trunk group to select a dial plan based TRUNKGROUP
on the IP address, source ID, and CLI prefix tables. Valid
values: 0 (no dial plan lookup) or 1 (require dial plan lookup).
DOMAINPROFILE
This property is added in software Release 9.4(1).
Maps to trunk group property ExpiresTimer. The timer value (in TRUNKGROUP
milliseconds) used in the Expire header of SIP messages. Value
range: any value greater than 0.
ExpiryWarnTone
Type
Expiry warning tone duration, in seconds. Value range: 1
through 5.
COMMONPROFILE
SS7-ITU
SS7-ITU
TRUNKGROUP
TRUNKGROUP
Default: 1
COMMONPROFILE
String defining the tone to be applied to warn that the assigned SS7-ITU
call duration is almost expired. Value range: Any valid MGCP TRUNKGROUP
event name.
SS7-ITU
TRUNKGROUP
COMMONPROFILE
Default: NULL
*.ExtCOT
SIPPROFILE
DOMAINPROFILE
Default: 60000
ExpiryWarnTone
Dur
SIPPROFILE
COMMONPROFILE
Default: 0
*.ExpiresTimer
EISUPPROFILE
Determines the type of COT handling for the specified
destination. Values: 0 (no COT), loop, or transponder.
DPNSS
DPNSS
ISDNPRI
ISDNPRI (BRI)
Default: Loop
SS7-ANSI
SS7-ANSI
SS7-China
SS7-China
SS7-ITU
SS7-ITU
SS7-Japan
SS7-Japan
SS7-UK
SS7-UK
TRUNKGROUP
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-37
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.FastConnect
DPNSS
The purpose of this property is to allow/disallow the signal
being sent to LCM when a CALL PROCEEDING, a
ISDNPRI
PROGRESS and an ALERTING message is received from the
MGW. Values:
Associated
Components for
Release 9.8
DPNSS
ISDNPRI (BRI)
0 = Normal behavior, enable all signals to LCM.
1 = Disable signals to LCM when a Call proceeding message
is received from the MGW.
2 = Disable signals to LCM when a Call Proceeding or a
Progress message are received from the MGW.
3 = Disable signals to LCM when a Call Proceeding or a
Progress or an Alerting message is received from the MGW.
Default: 0
*.FAXsupport
Indicates if T.38 FAX calls are supported on the trunk group.
This property must be enabled on the incoming and outgoing
trunk groups for T.38 fax calls to be successfully routed.
Values are: 0 (none) or 1 (T.38 Fax).
DPNSS
DPNSS
EISUP
EISUP
ISDNPRI
ISDNPRI (BRI)
Default: 0
SS7-ANSI
SS7-ANSI
SS7-ITU
SS7-ITU
TRUNKGROUP
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
*.Feature
Transparency
Disabled
Disables QSIG Feature Transparency for all calls on the
Cisco PGW 2200 Softswitch. Valid values: 0 (Feature
Transparency enabled) or 1 (Feature Transparency disabled).
Default: 0
This property is added in software Release 9.4(1).
DPNSS
DPNSS
EISUP
EISUP
ISDNPRI
ISDNPRI (BRI)
TRUNKGROUP
TRUNKGROUP
EISUPPROFILE
COMMONPROFILE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-38
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.ForwardCLIin
IAM
Set to 1 if outgoing IAM should contain the Calling Line
Identity, if available. Only applicable for BTNUP when
interworking from other protocols. Values: 0 or 1.
Default: 0
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
DPNSS
DPNSS
ISDNPRI
ISDNPRI (BRI)
SS7-ANSI
SS7-ANSI
SS7-China
SS7-China
SS7-ITU
SS7-ITU
SS7-Japan
SS7-Japan
SS7-UK
SS7-UK
COMMONPROFILE
*.Forward
SegmentedNEED
DPNSS
Set to 0 to disable the forwarding of segmented NEED
messages within the BTNUP_NRC protocol. If segmenting is ISDNPRI
disabled, all mandatory DPNSS information elements are
packed into a single BTNUP NEED message. Values: 0 or 1. SS7-ANSI
Default: 1
*.FromField
DPNSS
ISDNPRI (BRI)
SS7-ANSI
SS7-China
SS7-China
SS7-ITU
SS7-ITU
SS7-Japan
SS7-Japan
SS7-UK
SS7-UK
Maps to trunk group property FromField. Displays the name TRUNKGROUP
used in the SIP “From” field when the calling party number is
marked private. Value range: any alphanumeric string.
COMMONPROFILE
Default: anonymous
*.FT_Incoming
PFXdigitsInsert
This property indicates the number of digits in the string that DPNSS
is inserted before the diversion digits in a service string when
the Cisco PGW 2200 Softswitch receives DPNSS messages in
Feature Transparency mode.
DPNSS
Valid values: NULL or a digit string of 1 through 6 ASCII
(0-9) characters
Default: NULL
*.FT_Incoming
PFXdigitsRemove
This property indicates the number of diversion digits in a
service string that are removed when the
Cisco PGW 2200 Softswitch receives DPNSS messages in
Feature Transparency mode.
DPNSS
DPNSS
Valid values: 0 through 6
Default:0
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-39
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.FT_Outgoing
PFXdigitsInsert
This property indicates the number of digits in the string that DPNSS
is inserted before the diversion digits in a service string when
the Cisco PGW 2200 Softswitch sends DPNSS messages in
Feature Transparency mode.
Associated
Components for
Release 9.8
DPNSS
EISUP
Valid values: NULL, or a digit string of 1 through 6 ASCII
(0-9) characters
Default: NULL
*.FT_Outgoing
PFXdigitsRemove
This property indicates the number of diversion digits in a
service string that are removed when the
Cisco PGW 2200 Softswitch sends DPNSS messages in
Feature Transparency mode.
DPNSS
DPNSS
EISUP
Valid values: 0 through 6
Default: 0
*.gapInclude
Indicates whether or not to include the Generic Address
Parameter in an IAM. Values: 0 (for no) or 1 (for yes).
SS7-ANSI
SS7-ANSI
TRUNKGROUP
COMMONPROFILE
Default: 0
*.Gateway
Announcement
PackageSupport
Indicates whether the gateway supports the MGCP
Announcement package.
GRPROFILE
MGCP
H248
MGCP
Valid values:
•
0 = Announcement package is not supported
•
1 = Announcement package is supported
Default: 1
*.GatewayAnn
Support
Specifies whether the gateway pool supports playing an
announcement package to the IP side. Valid values:
•
0—Not supported
•
1—Supported
—
GWPOOLPROFILE
—
GWPOOLPROFILE
This property is added in software Release 9.8(1).
*.GatewayCodec
Support
Specifies whether the gateway pool supports transcoding for
IP-to-IP traffic. Valid values:
•
0—Not supported
•
1—Supported
This property is added in software Release 9.8(1).
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-40
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
—
GWPOOLPROFILE
Used to identify the Gateway in the CDR record, that is
whatever this value is set to will be placed in the CDR.
AVM
AVM
MGCP
H248
Default: N/A
SGCP
MGCP
VSI
SGCP
Property
Definition
*.GatewayDTMF
Support
Describes the DTMF capability support for a gateway pool.
Valid values:
•
0—Not supported
•
1—RFC 2833
•
2—Inband and RFC 2833
This property is added in software Release 9.8(1).
*.GatewayName
VSI
*.GatewayPool
Associates the default gateway pool with an IP trunk group so —
that media can be anchored on this gateway pool.
Valid values: Any integer from 0–9999
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
Default: 0 (indicates that there is no gateway pool associated
with this IP trunk group)
DOMAINPROFILE
This property is added in software Release 9.8(1).
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-41
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
Associated
Components for
Release 9
through 9.7
*.GatewayRBTone Indicates whether gateway ringback tones are supported by the TRUNKGROUP
Support
remote gateway on a given trunk group and connection type.
Valid values:
•
0 —Dose not support local tone application
•
1 —Local tone application support for MGCP/EISUP
calls using MDCX connection method
•
2 —Local tone application support for MGCP/EISUP
calls using RQNT connection method
•
3 —Local tone application support for MGCP/EISUP and
MGCP/MGCP calls using MDCX connection method
•
4 —Local tone application support for MGCP/MGCP
calls using MDCX connection method
•
5—Enable calls to work as a hairpin call with no
ring-back tone
Note
An incorrect configuration mismatch on this property
can result in calls without ringback tones applied.
Note
For a value of 1 or 2, the ring back tone is not supplied
toward the PSTN side if PI=8 is present in the Alert or
Call Progress messages coming from the H.323 side.
Note
For a value of 3 or 4, hairpin calls, which originate and
terminate on the same IOS gateway, the hairpin call
function is disabled for the trunk group. All MGCP
terminating calls are treated as non-hairpin calls, and
local ring back tone is supported.
Associated
Components for
Release 9.8
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default: 0
Property values 3 and 4 are added in software Release 9.5(2)
*.Gateway
SelectionMethod
Specifies the border gateway selection method within a
gateway pool. Valid values:
—
GWPOOLPROFILE
Specifies whether the gateway pool supports playing a tone to —
the IP side. Valid values:
GWPOOLPROFILE
•
0—Sequence
•
1—Round robin
This property is added in software Release 9.8(1).
*.GatewayTone
Support
•
0—Does not support tone
•
1—Supports tone
This property is added in software Release 9.8(1).
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-42
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.GatewayVideo
Support
use this property to control whether a gateway pool supports
video traffic.
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
—
GWPOOLPROFILE
Valid values: boolean (0 = does not support, 1 = supports).
Default value: 0.
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
*.Generate
Redirection
Number
Determines whether the Cisco PGW 2200 Softswitch includes TRUNKGROUP
the redirection number in the Address Complete Message
(ACM) SS7 message.
Note
SS7-ITU
COMMONPROFILE
This property was introduced in release 9.5(2), patch
gs69nn62.
Valid values:
•
0 = redirection number is not included in the ACM
message
•
1 = redirection number is included in the ACM message
Default: 1
*.GenNumInclude
Enables or disables the mapping of the Generic Number to the —
user field of a P-ASSERTED-ID Header in a SIP INVITE.
Valid Values:
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
•
1—Map the Generic Number in IAM to the user field of
the P-ASSERTED-ID in a SIP INVITE. (Generic Number
Handling Enabled)
•
0—Do not map the Generic Number to the user field of the
P-ASSERTED-ID in a SIP INVITE. (Generic Number
Handling Disabled)
Default Value: 0
Property Domain: SIP PROFILE
Protocol Family: SIP
Provisioning example:
mml>
prov-ed:profile:name="sip-prof1",GenNumInclude="1"
Note
To enable the Generic Number Handling feature,
provision the mapclitosipheader property to the
value 3.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-43
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.GenTimerT1
Maps to trunk group property GenTimerT1. The T1 timer
value (in milliseconds) for SIP messages other than INVITE.
Value range: any value greater than 0.
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
TRUNKGROUP
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default: 500
*.GenTimerT2
Maps to trunk group property GenTimerT2. The T2 timer
value (in milliseconds) for SIP messages other than INVITE.
Value range: any value greater than 0.
TRUNKGROUP
COMMONPROFILE
DOMAINPROFILE
Default: 4000
*.GLARE
Call Collision Handling. Value range:
DPNSS
0 = No glare handling; also known as yield to all double ISDNPRI
seizures. Call collision results in a REL sent to both calls.
SS7-ANSI
Note
Both ends of a link can be given this option.
SS7-China
•
•
Note
•
Note
•
Note
1 = The Cisco PGW 2200 Softswitch has control of all
circuits and any call collisions are handled by this
Cisco PGW 2200 Softswitch. It ignores incoming IAMs
and proceeds with its own calls as normal.
Only one end of a link can be designated with this
option.
SIPPROFILE
DPNSS
ISDNPRI (BRI)
SS7-ANSI
SS7-China
SS7-ITU
SS7-ITU
SS7-Japan
SS7-Japan
SS7-UK
SS7-UK
TRUNKGROUP
TRUNKGROUP
COMMONPROFILE
2 = Highest point code controls the even circuits.
Depending on the OPC of the
Cisco PGW 2200 Softswitches, the side that has the
higher point code will control the even circuits, while the
side with the lower point code will control the odd
circuits.
Both ends of a link can be given this option.
3 = No control. The Cisco PGW 2200 Softswitch
specified with this option does not control any circuits.
The Cisco PGW 2200 Softswitch accepts incoming IAMs
from the side with control.
This option is usually used along with the remote node
designated with control.
Default: 0
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-44
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.gnInclude
Indicates whether or not to include the Generic Name in an
IAM. Values: 0 (for no) or 1 (for yes).
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
SS7-ANSI
SS7-ANSI
TRUNKGROUP
COMMONPROFILE
Default: 0
GRPROFILE
This property applies to ANSI SS7 only. The applicable MDO
files are ANSISS7_2K, ANSISS7_92, ANSISS7_C2,
ANSISS7_C3, ANSISS7_E1, ANSISS7_STANDARD, and
GR317.
*.GRA2
*.grprofile
Determines if paired (0) or single (1) group reset
acknowledgments (GRAs) are required before the reset is
considered successful. Only applicable to ANSI SS7, IBN7,
and CTUP protocols. Values: 0 or 1.
DPNSS
DPNSS
ISDNPRI
ISDNPRI (BRI)
SS7-ANSI
SS7-ANSI
Default: 0
SS7-China
SS7-China
SS7-ITU
SS7-ITU
SS7-Japan
SS7-Japan
SS7-UK
SS7-UK
—
EISUPPROFILE
Contains a pointer to a GRPROFILE.
SIPPROFILE
Valid values: String. Enter the name of an existing GRprofile.
Default value: NULL
Dynamically reconfigurable: Yes
*.GRSEnabled
This property is assigned to an SS7 point code type signal
path. Enables Group Reset and Blocking procedure at point
code initialization. Synchronizes the
Cisco PGW 2200 Softswitch bearer channel blocking state
with that of the end office.
SS7-ANSI
SS7-ANSI
SS7-China
SS7-China
SS7-ITU
SS7-ITU
SS7-Japan
SS7-Japan
If True, GRS messages are sent for all CICs associated with
the point code. If False, GRS messages are not sent. Values:
true or false.
SS7-UK
SS7-UK
Default: false
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-45
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
Property
Definition
*.GRSonSSC
Enabled
This property (available in software Release 9.4(1) patch 8 and SS7-ANSI
above) is assigned to an SS7 point code type signal path.
SS7-China
Enables Group Reset on Service State Change procedure at
SS7-ITU
point code initialization. Values: false or true.
SS7-ANSI
SS7-Japan
SS7-Japan
SS7-UK
SS7-UK
Note
When the far end receives the GRS message, any
active calls are released on the point code, as per
ITU-T Recommendation Q.764.
SS7-China
SS7-ITU
If true, the GRS message is sent to the far end point code for
all CICs associated with the point code after the point code
was put in-service again.
If false, the GRS message is not sent.
Default: false
*.GtdCapTypeProp This property is used by the Cisco PGW 2200 Softswitch as a DPNSS
pointer to the subset of GTD parameters that the user desires ISDNPRI
to support. Value range: t0 (no GTD support) to any string of
1 through 20 characters that identifies a GTD parameter string. TRUNKGROUP
*.GtdMsgFmt
DPNSS
ISDNPRI (BRI)
TRUNKGROUP
Default: t0
COMMONPROFILE
Indicates the GTD message format mode. The format can be DPNSS
only compact. Compact mode is the short format and the field ISDNPRI
names are not passed in the GTD parameter string. Value: c
TRUNKGROUP
(compact).
DPNSS
Default: c
SIPPROFILE
ISDNPRI (BRI)
TRUNKGROUP
COMMONPROFILE
DOMAINPROFILE
*.GWDefaultATM
Profile
Defines an initial list of profiles for a given trunk group to use —
for ATM profile negotiation.
Valid values:
•
A list of profile names separated by semicolons such as
<Profile1>;<Profile2>;<ProfileN>.
•
NULL
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default value: NULL
Note
If this property is set to NULL, the
Cisco PGW 2200 Softswitch does not influence ATM
profile negotiation.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-46
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
Property
Definition
*.GWDefault
AudioCodecString
Gateway default audio codec string. Enables the IOCC-MGCP —
to send the ordered series of codec choices separated by
semicolons. Refer to your gateway documentation for a list of
supported codec names. The following values represent some
of the more common codec names.
H248
Values: NULL, G.711a, G.711u, G.729, G.729a, and G.729b
SIPPROFILE
Additional values: G.726-32, G.726-24, G.726-16, G.729b-L,
G.723.1-H, G.723.1-L, G.723.1a-L, G.GSM-F, G.GSM-H,
and G.GSM-eF
COMMONPROFILE
MGCP
TRUNKGROUP
EISUPPROFILE
DOMAINPROFILE
Default: NULL
This property is added in software Release 9.8(1).
*.GWDefault
CodecString
Note
This property is deleted in software Release 9.8(1).
Enables the IOCC-MGCP to send the ordered series of codec
choices separated by semicolons. Refer to your gateway
documentation for a list of supported codec names. The
following values represent some of the more common codec
names.
MGCP
—
TRUNKGROUP
Values: NULL, G.711a, G.711u, G.729, G.729a, and G.729b.
Default: NULL
*.GWDefaultVideo Gateway default video codec string. Enables the IOCC-MGCP —
CodecString
or IOCC-H248 to send the ordered series of codec choices
separated by semicolons. Refer to your gateway
documentation for a list of supported codec names. The
following values represent some of the more common codec
names.
Values are: NULL, H.264; H263; H261; H263-1988; JPEG;
MPV; CelB; MP2T and nv.
H248
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default: NULL
This property is added in software Release 9.8(1).
*.GWNetwork
Continuity
This property enables or disables the network continuity test
on the VISM. Values: 0 or 1.
MGCP
H248
MGCP
Default: 0
*.GWProtocol
Version
The MGCP protocol version to use when communicating with MGCP
the gateway.
H248
MGCP
Values: MGCP 0.1 or MGCP 1.0, which was added in software
Release 9.5(2).
Default: MGCP 0.1
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-47
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.h248BulkAudit
This property indicates whether bulk audit is supported on the TRUNKGROUP
associated gateway.
Associated
Components for
Release 9.8
H248
Valid values (boolean):
•
0 = not supported
•
1 = supported
Default value: 1
Dynamically reconfigurable: yes
*.h248Congestion
Enable
TRUNKGROUP
H248
TRUNKGROUP
This property specifies the default H.248 remote domain
name. Use it to append to the audit command and send it to the
remote gateway.
H248
This property specifies whether a congestion control
procedure is enabled for that GW.
Valid values (boolean):
•
0 = not enabled
•
1 = enabled
Default value: 0
Dynamically reconfigurable: yes
*.h248Domain
NameRemote
Value range: any valid domain name or NULL.
Valid values: string (up to 127 characters)
Default value: NULL
Dynamically reconfigurable: no
*.H248Gateway
ReserveValue
Note
This property is deleted in Release 9.8S6P6 and later. TRUNKGROUP
This property allows H.248 to send ADD commands with the
Reserve Value of on or off to indicate whether the MG should
reverse resource or not. This property applies only to the
originating MG; for the terminating side, the Reserve Value is
always off.
H248
TRUNKGROUP
COMMONPROFILE
Valid values:
•
0 = do not reserve resource
•
1 = reserve resource
Default value: 0
Dynamically reconfigurable: yes
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-48
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.h248GWStdby
HeartbeatInterval
TRUNKGROUP
This property specifies the interval time, in seconds, that
enables the Cisco PGW 2200 Softswitch to send a heartbeat to
complete a health check on the remote gateway using the
standby IP link.
Associated
Components for
Release 9.8
H248
Valid values: integer (0 to 30 seconds)
Default value: 30
Dynamically reconfigurable: no
*.h248inactivity
timer
TRUNKGROUP
H248
TRUNKGROUP
H248
This property specifies a poll count that defines the number of TRUNKGROUP
attempts to reach the remote GW for each configured local IP
interface.
H248
This property specifies the allowable period of silence in
milliseconds.
Valid values: integer (greater than 1000)
Default value: 5000
Dynamically reconfigurable: no
*.h248initialrtt
This property indicates the H.248 initial RTT (Round-Trip
Time) value in milliseconds.
Valid values: integer (larger than 10)
Default value: 1000
Subsystem: MEGACO IOCC
Dynamically reconfigurable: no
*.h248LocalIpPoll
Count
Valid values: integer (0 to 30)
Default value: 6
Dynamically reconfigurable: no
*.h248longtimer
This property indicates the H.248 long timer period.
TRUNKGROUP
H248
TRUNKGROUP
H248
Valid values: integer
Default value: 30
Dynamically reconfigurable: no
*.h248maxretries
This property indicates the maximum number of
retransmissions that can be performed by the peer.
Valid values: integer (from 7 to 11)
Default value: 11
Dynamically reconfigurable: no
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-49
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.h248mgcexec
timer
TRUNKGROUP
This property is used in calculating the normal
Cisco PGW 2200 Softswitch execution time (measured in
milliseconds). This property specifies the interval at which the
Cisco PGW 2200 Softswitch sends a Transaction Pending
message back to the MG if a transaction request on the
Cisco PGW 2200 Softswitch is pending.
Associated
Components for
Release 9.8
H248
Valid values: any integer
Default value: 500
Dynamically reconfigurable: no
*.h248mgcpend
limit
This property indicates the number of transactions pending
that can be received from the Cisco PGW 2200 Softswitch.
TRUNKGROUP
H248
TRUNKGROUP
H248
TRUNKGROUP
H248
TRUNKGROUP
H248
Valid values: integer
Default value: 10
Dynamically reconfigurable: no
*.h248mgcprov
resptimer
This property sets the provisional response timer value
(measured in milliseconds). The default value is the normal
Cisco PGW 2200 Softswitch execution time plus network
delay.
Valid Values: any integer
Default Value: 600
Dynamically Reconfigurable: no
*.h248mgexec
timer
This property specifies the interval at which the
Cisco PGW 2200 Softswitch receives a response to
transactions from the MG. Network delay is excluded.
Valid values: any integer
Default value: 500
Dynamically reconfigurable: no
*.h248mgpend
limit
This property indicates the number of transactions pending
that the Cisco PGW 2200 Softswitch can receive.
Valid values: integer
Default value: 10
Dynamically reconfigurable: no
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-50
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
TRUNKGROUP
H248
TRUNKGROUP
H248
TRUNKGROUP
H248
This property specifies the interval (in milliseconds) at which TRUNKGROUP
the MG sends congestion notification to
Cisco PGW 2200 Softswitch if the MG is in a congestion
state.
H248
Definition
*.h248profilename This property specifies the profile name that defines how the
Cisco PGW 2200 Softswitch uses the H.248.1 protocol and
the functionality that the MG supports. The profile specifies
the H.248.1 options used.
Valid values: string (up to 64 characters)
Default value: NULL
Dynamically reconfigurable: no
*.h248profile
version
This property specifies the H.248 profile version.
Valid values: integer (1 to 99)
Default value: 1
Dynamically reconfigurable: no
*.h248RemoteIp
PollCount
This property specifies a poll count defining the number of
retry audit messages that the Cisco PGW 2200 Softswitch
sends to the remote gateway.
Valid values: integer (0 to 30)
Default value: 72
Dynamically reconfigurable: no
*.h248TimerT1
Valid values: integer (0 to 100)
Default value: 0
Dynamically reconfigurable: yes
*.h248txnpend
respcount
This property indicates the number of pending transactions
that can be received from the
MG/Cisco PGW 2200 Softswitch.
TRUNKGROUP
H248
Valid values: integer
Default value: 11
Dynamically reconfigurable: no
*.H323Adjunct
Link
Identifies an EISUP link that is connected to an H.323 adjunct EISUP
platform. Values are: 0 (EISUP link is not connected to an
H.323 adjunct platform) or 1 (an EISUP link is connected to
an H.323 adjunct platform).
EISUP
Default: 0
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-51
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.H323Destination Identifies the primary and alternative IP Address and Port of
the H323 destination.
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
EISUP
EISUP
EISUPPROFILE
Valid Values:
•
COMMONPROFILE
The primary and the alternative IP address and port of the
H323 destination, in the format
xxx.xxx.xxx.xxx[:port][xxx.xxx.xxx.xxx:port]
Default value:
•
NULL
This value indicates the Non-RAS feature is inactive on
this trunk group.
Dynamically reconfigurable: Yes
This property is added in software Release 9.7(3).
*.HandlePres
Unavail
*.HoldTimer
EISUP
When Presentation Restricted Indicator is set to address
unavailable, remove address digits from calling party number. SS7-ANSI
Otherwise keep the address digits intact. Value range: T (true)
SS7-ITU
or F (false).
Indicates the maximum time length (in milliseconds) a SIP call
can be put on hold. Maps to trunk group property HoldTimer.
Value range: any value greater than 0.
TRUNKGROUP
EISUP
SS7-ANSI
SS7-ITU
SIPPROFILE
COMMONPROFILE
Default: 300000
*.hopOn
A flag indicating whether or not to enable the hop counter.
Values: 0 (for no) or 1 (for yes).
SS7-ANSI
SS7-ANSI
TRUNKGROUP
COMMONPROFILE
Default:1
*.InhibitIncoming
CallingName
Display
Inhibits support of incoming calling name display in DPNSS
and EISUP(HSI) protocols. Values are: 1 inhibit incoming
calling name display or 0 enable incoming calling name
display.
GRPROFILE
DPNSS
DPNSS
EISUP
EISUP
TRUNKGROUP
ISDNPRI (BRI)
Default: 0
TRUNKGROUP
This property is added in software Release 9.6(1).
EISUPPROFILE
COMMONPROFILE
*.InhibitIncoming
ConnectedName
Display
Inhibits support of the incoming connected name display for
call transfer in DPNSS and EISUP (HSI) protocols. Values
are: 1 inhibit outgoing connected name display or 0 enable
outgoing connected name display.
DPNSS
DPNSS
EISUP
EISUP
TRUNKGROUP
TRUNKGROUP
Default: 0
EISUPPROFILE
This property is added in software Release 9.5(2).
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-52
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
Property
Definition
*.InhibitIncoming
ConnectedNumber
Display
Inhibits support of the incoming connected number display for DPNSS
call transfer in DPNSS and EISUP (HSI) protocols. Values
EISUP
are: 1 inhibit outgoing connected name display or 0 enable
TRUNKGROUP
outgoing connected name display.
DPNSS
Default: 0
EISUPPROFILE
This property is added in software Release 9.6(1).
SIPPROFILE
EISUP
TRUNKGROUP
COMMONPROFILE
DOMAINPROFILE
*.InhibitOutgoing
CallingName
Display
Inhibits support of outgoing calling name display in DPNSS
and EISUP(HSI) protocols. Values are: 1 inhibit incoming
calling name display or 0 enable incoming calling name
display.
DPNSS
—
EISUP
TRUNKGROUP
Default: 0
This property is added in software Release 9.6(1).
Note
*.InhibitOutgoing
ConnectedName
Display
This property is not implemented on Release 9.7(3).
Inhibits support of the outgoing connected name display for
call transfer in DPNSS and EISUP (HSI) protocols. Values
are: 1 inhibit outgoing connected name display or 0 enable
outgoing connected name display.
DPNSS
DPNSS
EISUP
EISUP
TRUNKGROUP
TRUNKGROUP
Default: 0
EISUPPROFILE
This property is added in software Release 9.5(2).
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
*.InhibitOutgoing
ConnectedNumber
Display
Inhibits support of the outgoing connected number display for DPNSS
call transfer in DPNSS and EISUP (HSI) protocols. Values
EISUP
are: 1 inhibit outgoing connected name display or 0 enable
TRUNKGROUP
outgoing connected name display.
DPNSS
Default: 0
EISUPPROFILE
This property is added in software Release 9.6(1).
SIPPROFILE
EISUP
TRUNKGROUP
COMMONPROFILE
DOMAINPROFILE
*.InhibitPasson
Specifies whether to inhibit pass-on of unrecognized
messages/parameters. Values are:
•
0 = pass on unrecognized messages/parameters (allow
pass-on)
•
1 = do not pass on unrecognized messages/parameters
(inhibit passon)
EISUP
—
Default: 0
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-53
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.InhibitSipFrom
Mapping
This property determines the mapping from the incoming SIP SIP
message to the ISUP CLI. This property is for PSTN
emulation services (SIP/SIP-I).
If the remote party ID or P-Asserted-ID header is present and
the InhibitSipFromMapping property = 1, then disable
mapping the SIP From header to the generic number. If the
remote party ID or P-Asserted-ID header is not present and the
InhibitSipFromMapping property = 1, then disable mapping
the SIP From header to the calling party number.
Associated
Components for
Release 9.8
SIP
SIPPROFILE
COMMONPROFILE
Valid Values:
•
0—If the PAID/RPID E164 number is present, map the
PAID/RPID to CgPN, map the E164 number in username
in From header to GN (additional CgPN). If the
PAID/RPID E164 number is not present, map the E164
number in username in From header to CgPN.
•
1—Ignore the From header, map PAID/RPID E164
number to CgPN.
•
2—Ignore the PAID/RPID, map the E164 number in
username in From header to CgPN.
•
3—If the PAID/RPID E164 number is present, map the
PAID/RPID to CgPN, map the E164 number in Display
name in From header to GN (additional CgPN). If the
PAID/RPID E164 number is not present, map the E164
number in username in From header to ISUP CgPN, and
map the E164 number in displayname in From header to
GN (additional CgPN)
•
4—If the PAID/RPID E164 number is present, map the
PAID/RPID to CgPN, map the E164 number in username
in From header to GN (additional CgPN). If the
PAID/RPID E164 number is not present, ignore the From
header.
•
5—If the PAID/RPID E164 number is present, map the
PAID/RPID to CgPN, and map the E164 number in
username in From header to GN (additional CgPN). If the
PAID/RPID E164 number is not present, map the E164
number in the username in From header to ISUP CgPN,
and map the E164 number in displayname in From header
to GN (additional CgPN).
Note
The value 4 is available only in Release 9.7(3). The
value 5 is available only in Release 9.8(1).
Default Value: 0
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-54
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.InitEndpoints
AsEnabled
MGCP
Specifies if the Cisco PGW 2200 Softswitch (the engine)
initializes its endpoint objects (corresponding to those on the
gateway) as enabled or disabled. For gateways that send RSIP
messages at initialization to inform
Cisco PGW 2200 Softswitch of their endpoint state, set to
False; all others set to True. This property value is dynamically
editable using MML commands.
Associated
Components for
Release 9.8
H248
MGCP
Values: TRUE (1) or FALSE (0)
Default: True
*.InSessionTimer
Indicates the maximum session time (in milliseconds) allowed TRUNKGROUP
for a SIP call that originated by the Cisco PGW 2200 Softswitch.
Maps to trunk group property InSessionTimer. This value may
require being increased to 1800000 to reduce performance
impact. Value range: any value greater than 0.
Note
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
In software Release 9.4(1), this is the minimum session
time interval.
Default: 1800000
*.insideVrfName
Specifies the VrfName for leg 2 or leg 3 in an IP-to-IP gateway —
call.
This property is added in software Release 9.8(1).
*.insipheadertable
Contains a pointer to an inbound SIP header table.
EISUPPROFILE
SIPPROFILE
DOMAINPROFILE
—
SIPPROFILE
DOMAINPROFILE
Valid values: String. Enter the name of an existing inbound
SIP Header table.
Default value: NULL
Dynamically reconfigurable: Yes
This property is added in software Release 9.8(1).
*.InviteAttempts
Defines the transmission times for INVITE requests.
SIP
SIPPROFILE
Valid Values: integer (1-15)
TRUNKGROUP
COMMONPROFILE
DOMAINPROFILE
Default: 7
Dynamically Reconfigurable: yes
*.InviteTimerT1
Indicates the T1 timer (in milliseconds) for the INVITE message, TRUNKGROUP
as specified for SIP. Maps to trunk group property InviteTimerT1.
Value range: any value greater than 0.
Default: 1000
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-55
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.InviteWaitTimer
Defines the timer (in milliseconds) of waiting for final
response of INVITE requests.
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
SIP
SIPPROFILE
TRUNKGROUP
COMMONPROFILE
Valid Values: integer (10000-500000)
DOMAINPROFILE
Default Value: 200000
Dynamically Reconfigurable: yes
IOCC.chkPtPort
IOCC
IP port number used to checkpoint events to standby MGC.
Value range: 1025 to 65535. This cannot conflict with other IP
port assignments.
IOCC
Default: 0
IOCC.port
IOCC
IP port number used to send and receive events. This is
generally overridden by a protocol (for example, RLM). Value
range: 1025 to 65535. This cannot conflict with other IP port
assignments.
IOCC
Default: 3000
*.IOI
Specifies the IOI for a trunk group. This property overrides the —
*.IOI parameter value in the XECfgParm.dat file. This
property can be provisioned on a trunk group, in a SIP or
EISUP profile, or a domain profile.
TRUNKGROUP
Valid values: string (1 to 63 characters) or none.
COMMONPROFILE
Default value: none.
DOMAINPROFILE
EISUPPROFILE
SIPPROFILE
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-56
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.ipinscreening
Indicates whether the Cisco PGW 2200 Softswitch processes
incoming SIP and EISUP traffic using the incoming trunk
groups defined using the ipinmapping provisioning
component.
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
EISUP
EISUP
SIP
SIP
—
H248
—
H248
Valid values:
•
0 = The ipinmapping function is disabled.
•
1 = The ipinmapping function is enabled. The
Cisco PGW 2200 Softswitch discards incoming traffic
that does not match an existing ipinmapping entry. The
Cisco PGW 2200 Softswitch evaluates messages using
the source IP address and destination port.
•
2 = The ipinampping function is enabled. The
Cisco PGW 2200 Softswitch processes incoming traffic
that does not match an existing ipinmapping entry using
the default incoming trunk group.
Note
If a message matches multiple ipinmapping table
criteria, the Cisco PGW 2200 Softswitch applies the
most detailed match.
Default value: 0
*.IPTermNum
Groups
According to the ETSI profile, an RTP termination ID
conforms to the format ip/group id/interface id/id. This
property specifies the largest group number provisioned on
this gateway.
Valid values: An integer from 0–255. (0 specifies that the
group field for the RTP termination ID is not used.)
Default: 255
This property is added in software Release 9.8(1).
*.IPTermNum
Interfaces
According to the ETSI profile, an RTP termination ID
conforms to the format ip/group id/interface id/id. This
property specifies the number of interfaces that are
provisioned for this gateway.
Valid values: an integer from 0–8.
Default: 0. (0 specifies that the interface field for RTP
termination ID is not used.)
This property is added in software Release 9.8(1).
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-57
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.IPTermNum
Terms
—
According to the ETSI profile, an RTP termination ID
conforms to the format ip/group id/interface id/id. This
property specifies the number of terminations that are allowed
in a particular group ID and interface ID.
Associated
Components for
Release 9.8
H248
Valid values: an integer from 1–1364
Default: 1364
This property is added in software Release 9.8(1).
*.IsdnNSF
Indicates the network specific facilities parameter for ISDN
PRI.
TRUNKGROUP
TRUNKGROUP
—
SIPPROFILE
Specify an integer from 0–256.
0–255: Directly mapping to 0x00-0xFF in the outgoing
message.
256: No NSF in the outgoing message.
Default: 256
*.isuptmrProfile
This property indicates the Level 2 ISUP TMR profile that is
attached to a SIP profile.
Valid values: any string up to 128 characters in length.
Default value: NULL.
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
*.IsupToSipRatio
Set the ratio of Max_Forwards to Hop Counter for a call from SIP
ISUP to SIP.
SIP
Valid values: 0 through 4. 0 indicates the mapping does not
function.
Default value: 0
*.IsupTransEarly
ACMEnable
Indicates a special Address Complete Message (ACM) to PRI ISDNPRI
message mapping when an early ACM does not map to a PRI
message. Values: 0 no mapping (default), 1 PROGRESS
message is sent with Progress description value of 9. Enable
GTD to ensure ISUP transparency, or 2 ALERTING message
sent.
ISDNPRI (BRI)
Default: 0
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-58
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Definition
*.IsupTransEarly
Indicates if the egress Cisco PGW 2200 Softswitch is to send ISDNPRI
BackwardDisabled an end-to-end message, called Early Backward Call Setup
Message, immediately after receiving the call setup message
with GTD information about the outgoing protocol variant.
Values: 0 (enable) or 1 (disable).
Default: 1
Associated
Components for
Release 9.8
DPNSS
ISDNPRI (BRI)
TRUNKGROUP
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
*.Isup
Transparency
Disabled
SS7-ANSI
Permits disabling of the ISUP Transparency feature for a
particular trunk group. Values:1 (True) the ISUP Transparency SS7-ITU
feature is disabled, or 0 (False) the ISUP Transparency feature
TRUNKGROUP
is enabled.
SS7-ANSI
Default: 1
EISUPPROFILE
SS7-ITU
TRUNKGROUP
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
*.ItpAction
Request
TRUNKGROUP
The ItpActionRequest property indicates that the
Cisco PGW 2200 Softswitch should send a customized SIP
invite to the ITP to return the location of a mobile subscriber.
Setting this property to map-app indicates that the
Cisco PGW 2200 Softswitch should send a customized SIP
invite to the ITP to return the location of a mobile subscriber.
The customized SIP invite causes the ITP to send a MAP query
to the service provider HLR for the mobile subscriber’s
current mobile station roaming number (MSRN). The
Cisco PGW 2200 Softswitch then routes the call to the closest
Gateway MSC based upon the new MSRN.
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
If the Cisco PGW 2200 Softswitch is unable to optimize the
call routing based on the MSRN, it continues to route calls
based on using the mobile subscriber’s MSISDN (telephone
number). The Cisco PGW 2200 Softswitch routes calls based
on an MSISDN using cause analysis.
Values: Null or map-app
Default: Null
*.jipDefault
Indicates the default JIP value to be sent when jipInclude = 1 SS7-ANSI
and no JIP value is present. If the value is 0, jipDefault is
TRUNKGROUP
treated as if no value is present. Value range: 0 through 9.
Default: 0
SS7-ANSI
COMMONPROFILE
GRPROFILE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-59
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.jipInclude
Indicates whether or not to include the Jurisdiction
Information Parameter (JIP) in an IAM. Values: 0 (for no) or
1 (for yes).
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
SS7-ANSI
SS7-ANSI
TRUNKGROUP
COMMONPROFILE
GRPROFILE
Default: 0
*.lapdDropErr
DPNSS
Boolean to determine if some LAPD sequence errors are
discarded. This is used in large IP networks where the latency ISDNPRI
may cause LAPD sequence errors. According to Q.921, this
will cause the link layer to reset. This parameter allows
sequence errors to be discarded without resetting the link.
Values: true or false.
DPNSS
ISDNPRI (BRI)
Default: false.
*.lapdKval
*.lapdN200
*.lapdN201
*.lapdT200
Number of outstanding frames in Q.921 transmission window. DPNSS
Value range: 1 to 127.
ISDNPRI
Default: 7
DPNSS
Maximum number of retransmissions of a Q.921 frame. Value DPNSS
range: 0 to 10.
ISDNPRI
Default: 6
DPNSS
Maximum number of octets in a Q.921 frame.
DPNSS
DPNSS
Default: 260
ISDNPRI
ISDNPRI (BRI)
Maximum wait time for a LAPD frame acknowledgement
before retransmission. Value range: 10 to 60, in tenths of a
second increments.
DPNSS
DPNSS
ISDNPRI
ISDNPRI (BRI)
ISDNPRI (BRI)
ISDNPRI (BRI)
Default: 10
*.lapdT203
*.layerRetries
Maximum time the Q.921 link is idle before sending a frame. DPNSS
Value range: 50 to 600, in tenths of a second increments.
ISDNPRI
Default: 500
DPNSS
Maximum number of retransmissions for TCAP/SCCP
queries. Value range: 0 through 5, where 0 = No retries.
SS7-ANSI
SS7-ANSI
SS7-ITU
SS7-ITU
SS7-ANSI
SS7-ANSI
SS7-ITU
SS7-ITU
ISDNPRI (BRI)
Default: 2
*.layerTimer
Time (in tenths of a second) to wait for a response from
adjacent layer (SS7 controller, TCAP to SCCP); tailor when
layers are not resident on same processor. Value range: 0
through 10, where 0 = Disabled and 10 = 1 second.
Default: 10
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-60
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
Property
Definition
*.LocalAnn
Behavior
Allow suppression of the early ACM (indicating in-band
information is available) to allow overlap dialing to begin the
pre-call announcement as soon as the route is determined, and
still allow additional address information to be received in
SAMs.
SS7-ANSI
DPNSS
SS7-China
ISDNPRI (BRI)
SS7-ITU
SIP
SS7-Japan
SS7-ANSI
Values: 0 (disabled) or 1 (enabled),
SS7-UK
SS7-China
Default: 0
SS7-ITU
Valid values are:
SS7-Japan
•
Note
•
Note
1—Play announcement after enough digits have been
received to determine a route. Early ACM is not sent
before playing the announcement (it is assumed that the
voice path is already cut back after IAM). The call is
routed after the announcement is played.
SS7-UK
When overlap sending is also used, depending on the
number dialed, some users might receive the pre-call
announcement while the final digits are being dialed.
2—route the call after enough digits have been received to
determine a route. Play the announcement after an address
complete indication (ACM) is received from the
terminating side. This method was introduced by this
feature.
When you are using this option, the
Cisco PGW 2200 Softswitch might force an enbloc,
which can result in an unacceptable post-dial delay.
This property is added in software Release 9.5(2). In Release
9.7(3), this property name was changed from
AnnSuppressInbandInfo to LocalAnnBehavior.
*.LocalPort
TRUNKGROUP
Maps to trunk group property LocalPort. Indicates the UDP
port used by Cisco PGW 2200 Softswitch to send or receive
SIP messages. Valid range: any valid port number greater than
1024.
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default: 5060
*.LocationNumber The default outgoing number used if a location number is not SS7-ITU
present in an incoming call. (This is used in protocols Q761
and Q767.)
SS7-ITU
COMMONPROFILE
Default: 0
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-61
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.LoopAvoidance
Counter
Loop Avoidance counter for DPNSS. Value range: 0 through
25.
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
DPNSS
DPNSS
TRUNKGROUP
TRUNKGROUP
Default 0.
COMMONPROFILE
This property is added in software Release 9.6(1).
*.LoopAvoidance
Support
Indicates if the Loop Avoidance feature is supported in
DPNSS or not. Values are: 0 not supported or 1 supported.
DPNSS
DPNSS
TRUNKGROUP
TRUNKGROUP
Default: 0
COMMONPROFILE
This property is added in software Release 9.6(1).
*.LRNDigitCC
Prefix
This property specifies a country code digit string to which the —
RNDigitCCrm is compared if the NOA code is International.
If the digits match, the matched digits are removed from the
location routing number and the NOA code is set to National.
This is an incoming trunk group property. This property is for
PSTN emulation services (SIP/SIP-I).
TRUNKGROUP
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Valid values: NULL or any string up to 5 digits.
Default value: NULL.
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
*.LRNDigitCCrm
This property specifies a country code digit string to which the —
RNDigitCCrm is compared if the NOA code is International.
If the digits match, the matched digits are removed from the
location routing number and the NOA code is set to National.
This is an incoming trunk group property. This property is for
PSTN emulation services (SIP/SIP-I).
TRUNKGROUP
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Valid values: NULL or any string up to 5 digits.
Default value: NULL.
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
*.MacCBRequest
Maximum number of call back requests allowed in the queue
for the CTI sigpath. Value range: 1 through 50.
CTI-QBE
CTI-QBE
Default: 10
This property is added in software Release 9.6(1).
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-62
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.MapCLItoSipHe
ader
Determines the mappings from the ISUP calling party number SIP
to the outgoing SIP message. Valid Values:
TRUNKGROUP
• 0—The calling party number is put in the outgoing SIP
From header if number presentation is allowed. If the
calling party number presentation is restricted, then the
SIP outgoing From header is also controlled by the
cgpnInclude property.
Associated
Components for
Release 9.8
SIP
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
– If cgpnInclude = 0, and the SIP network is un-trusted,
the From header has SIP URI as: Anonymous
<sip:[email protected]>
– If cgpnInclude = 1, and the SIP network is trusted,
and honors the anonymous setting by not passing the
CLI to the SIP end point, the From header has URI as
Anonymous <sip:CGPN@PGW_HOST>
•
1—The calling party number is mapped to the remote
party ID, with screen and privacy values. If an additional
calling party number is present in the generic number, it is
mapped to the SIP From header.
•
2—Map the calling party number to the Remote-Party-ID
header only when the calling party number presentation is
allowed. For handling the additional calling party number
in the generic number, the operation is the same as for a
value of 1.
•
3—The calling party number is mapped to the P-Asserted
ID, with privacy header value ID, if necessary. If an
additional calling party number is present in the generic
number, it is mapped to the SIP From header.
Note
If the calling party number presentation is allowed,
there is no privacy header. If the calling party number
presentation is restricted, there is a privacy header
with a value ID.
•
4—Map the calling party number to the P-Asserted ID
header only when the calling party number presentation is
allowed. For handling the additional calling party number
in the generic number, the operation is the same as for a
value of 3.
•
5—MAP_ACLI_INTO_FROM_AND_PAID. For
ISUP-PGW-SIP calls, the PAID and From headers of
Invite message are mapped from ACgPN of IAM.
Note
The value 5 is added in software Release 9.8(1) S7P7.
Default Value: 0
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-63
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
Note
MapRNMethod
Associated
Components for
Release 9
through 9.7
This property is specifically designed for ISUP-SIP
call interworking and may not be perfectly applicable
for some SIP-SIP rare case scenarios. For eg: If there
is A number modification by DialPlan and after that
302 redirect occurs, in that case it might not show the
modified A number and displays the original A
number, if mapclitosipheader has value other than 0.
So for non-interworking call (SIP-SIP), recommended
value for mapclitosipheader is "0".
Determines the mappings between the EISUP or ISUP RN and EISUP
the SIP message headers or EISUP RN.
SIP
Valid Values:
TRUNKGROUP
• 0—Do not map the RN to the SIP header. Do not map the
RN to the EISUP RN parameter.
•
•
Associated
Components for
Release 9.8
EISUP
SIP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
1—Map the RN to the Diversion header. Map the RN to
the EISUP RN parameter.
DOMAINPROFILE
2—Map the RN to the Diversion header only when RN
presentation is allowed. Map the RN to the EISUP RN
parameter only when the RN presentation is allowed.
Default Value: 1
*.MaxACL
Indicates the Cisco PGW 2200 Softswitch congestion level (if
greater than zero) in the ISUP release message using the ACL
parameter. The purpose of this parameter is to map between
the Cisco PGW 2200 Softswitch congestion levels and the
destination switch congestion levels. This mapping is as
follows:
Max ACL
Current Machine
ACL Value
configuration
Congestion
in Release
value
Level
Message
-------------------------------------------------0
0,1,2,3
Not Present
2
0
Not Present
1
1
2
2
3
2
3
0
Not Present
1
1
2
2
3
3
SS7-ANSI
SS7-ANSI
SS7-China
SS7-China
SS7-ITU
SS7-ITU
SS7-Japan
SS7-Japan
SS7-UK
SS7-UK
TRUNKGROUP
TRUNKGROUP
COMMONPROFILE
Valid values: 0, 2, or 3.
Default: 3
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-64
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.MaxForwards
Maps to trunk group property MaxForwards. Indicates the
maximum number of SIP forwards allowed. Value range: any
value greater than 0.
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
TRUNKGROUP
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default: 70
*.maxMessage
Length
Maximum length of message to MTP3. This value must be less SS7-ANSI
than the value for mtp2MaxMsuFrmLen. Value range: 0
through 272.
SS7-ANSI
Default: 250
*.MaxRedirectCnt
TRUNKGROUP
Maps to trunk group property MaxRedirectCnt (maximum
redirect count). Indicates the maximum number of SIP message
redirections allowed. Value range: any value greater than 0.
COMMONPROFILE
Default: 5
*.MaxSubscription Sets the maximum duration of a subscription (in milliseconds) TRUNKGROUP
Duration
before a re-subscription is required.
Value range: Any integer from 0 through 3600.
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default: 0
This property is added in software Release 9.4(1).
*.MGCDomain
Maps to trunk group property MGCDomain. Indicates the
Cisco PGW 2200 Softswitch domain name used in SIP
messages. Value range: any valid domain name or NULL.
TRUNKGROUP
COMMONPROFILE
DOMAINPROFILE
Default: NULL
*.MgcpBehavior
SIPPROFILE
Regulates the Cisco PGW 2200 Softswitch engine behavior to MGCP
allow different MGCP gateway types to return different codes
for the same error. Values: 0 or 2.
•
0—No action
•
1—Resolves a connection conflict between the
Cisco PGW 2200 Softswitch and a media gateway to
allow a circuit to be used after a CRCX failure (return
code 501) by clearing the call; VISM and MGX8260.
•
2—Resolves a connection conflict between the
Cisco PGW 2200 Softswitch and a media gateway to
allow a circuit to be used after a CRCX failure (return
code 502) by forcing a delete and reconnection; 5300,
5400, other IOS-based servers, and VXSM.
MGCP
Default: 0
Note
Additional differences can be handled by adding
enumerated values.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-65
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
Associated
Components for
Release 9
through 9.7
*.mgcpBulkAudit
Specifies whether bulk audit is supported. Valid values:
MGCP
MGCP
MGCP
Specifies the MGCP local domain name or IP address the
system uses in the N: tag. The Cisco PGW 2200 Softswitch
includes an N: tag in the outbound NTFY message to identify
the domain or IP address of the active
Cisco PGW 2200 Softswitch after a switchover.
MGCP
•
1—Indicates that bulk audit is supported on a gateway.
•
0—Indicates that bulk audit is not supported on a gateway.
Associated
Components for
Release 9.8
Valid values: 0 or 1
Default value: 0
*.mgcpDomain
NameLocal
•
If you set the value to a domain name, such as
pgw.cisco.com, the system sets the N: tag as N: <domain
name>: port, for example, N: pgw.cisco.com:2427.
•
If you set the value to activelink, the system sets the N: tag
as N: <IP address of the active link>:port, for example, N:
10.22.33.33:2427. In general, there are two IP links for an
MGCP sigpath, one active and the other standby. If you
specify activelink, the system uses the active link for the
N: tag.
•
If you do not set a value, or you set the value to NULL, the
system does not create an N: tag.
Value: String (domain name, activelink, or NULL)
Default: NULL
*.mgcpDomain
NameRemote
Default MGCP remote domain name. It is used to append to
the audit command to send to the remote gateway.
MGCP
MGCP
*.mgcpGWRspAck Enables the Cisco PGW 2200 Softswitch to discard respAcks MGCP
Timeout
in the buffer for which the gateway no longer expects
acknowledgements. Value range: any positive value (in
seconds).
MGCP
Default: [email protected]
Default: 30
Note
*.mgcpGWStdby
HeartbeatInterval
Set this value to the same duration as the gateway’s
command/response timeout value.
This interval time, in seconds, enables the
Cisco PGW 2200 Softswitch to send the standby heartbeat to
complete a health check on the remote gateway. Value range:
0 to 30 seconds.
MGCP
MGCP
Default: 30 seconds
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-66
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
MGCP
MGCP
MGCP
MGCP
Enables the Cisco PGW 2200 Softswitch to buffer the number MGCP
of response acknowledgements specified by this property
before tagging them in the K-parameter in the next mgcp
command. Value range: 0 (disable) to any positive value.
MGCP
Property
Definition
*.mgcpHeartbeat
Interval
Indicates how often the MGCP protocol should heartbeat the
gateway. Value range: 0 through 1000.
Default: 1
Note
To prevent MGCP IP links from flapping, set this to a
minimum value of 4 when the
Cisco PGW 2200 Softswitch 2200 call agent is
working with a Cisco MGX8260.
*.mgcpLocalIp
This poll count defines the number of attempts to be
InterfacePollCount performed to reach the remote GW using each configured
local IP interface. Value range: any positive value.
Default: 6
*.mgcpMaxRsp
AckToBuffer
Default: 0
*.mgcpRemoteIp
PollCount
This poll count defines the number of retry audit messages to MGCP
be sent to the remote gateway. Value range: any positive value.
MGCP
Default: 3
*.mgcpRetxCount
A limit on the number of retransmissions before declaring
failure. (MGCP protocol.) Value range: 0 through 10.
MGCP
MGCP
MGCP
MGCP
Default: 3
*.mgcpRetxTimer
A limit on the time to wait for a response from a gateway
before retransmitting the message. (MGCP protocol.) Value
range: 0 through 60000.
Default: 2000
Note
*.MGCSipVersion
To prevent possible hung calls on a MGW, the
recommended value is 4000.
Maps to trunk group property MGCSipVersion. The version of TRUNKGROUP
SIP protocol supported by the Cisco PGW 2200 Softswitch.
Value range: any valid SIP version.
COMMONPROFILE
DOMAINPROFILE
Default: 2.0
Note
SIPPROFILE
For Cisco PGW 2200 Softswitch software earlier than
Release 9.7, set this value to SIP/2.0.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-67
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.MidCallCodec
Select
Enables codec selection on SIP midcall media update
messages such as ReINVITE and UPDATE. Values are:
•
0 (disable)
•
1 (enable)
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
TRUNKGROUP
SIPPROFILE
COMMONPROFILE
Default: 0
*.MidCallCP
Interval
*.MidCallService
CustID
Enables or disables mid-call checkpointing. When it is
enabled, you can specify the interval (in minutes) between
checkpointing events in the connected state. Valid values: 0
(disabled) (default) through 60.
TRUNKGROUP
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
Default value: 0
COMMONPROFILE
This property is added in software Release 9.5(2).
DOMAINPROFILE
This is a 4-digit, alphanumeric character string that indicates DPNSS
which dial plan is used for mid-call service analysis. If this
ISDNPRI
property value is 0000, no mid-call service is supported. Valid
SIP
range: 0000-any 4-digit alphanumeric character string.
DPNSS
Valid Values: 0000-any 4-digit alphanumeric character string. SS7-ANSI
SS7-ANSI
Default: 0000
SS7-ITU
ISDNPRI (BRI)
SIP
SS7-ITU
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
*.MinEvent
SubscribeDuration
Defines the minimum duration (in milliseconds) for which a
telephony event can be subscribed.
Value range: 40 through 3600.
TRUNKGROUP
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default: 40
This property is added in software Release 9.4(1).
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-68
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.MlppNamespace
Presents namespaces that are supported on the SIP trunk.
Individual namespaces are separated by commas.
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
—
SIPPROFILE
COMMONPROFILE
For SIP to ISUP interworking, the system attempts to match
namespaces defined by this property with namespaces
included in the Resource-Priority Header of an INVITE
message. If the system detects a match, it relays the MLPP
information to the ISUP trunk. If the system does not detect a
match, but does receive a Require message that contains a
Resource-Priority tag, the system generates message
417–Unknown Resource-Priority Response.
Note
DOMAINPROFILE
This property does not apply to SIP to SIP
interworking.
Valid value: For this implementation of the feature, the valid
value is “q735”.
Default value: “ ” (null)
This property is added in software Release 9.8(1) S10P10.
*.MlppNI
Specifies the NI1. For SIP to ISUP interworking, the system —
attempts to match the value of this property with the NI value
in the MLPP Precedence parameter, which is included in a
received IAM message.
TRUNKGROUP
If the system detects a match, it relays the information to the
egress trunk. If the system does not detect a match, it ignores
the MLPP information and does not relay it to the egress trunk.
Valid values: a Telephony Country Code (for example, “049”
for German ISUPv2, which is the recommended value for this
feature.)
Default value: “ ” (null)
This property is added in software Release 9.8(1) S10P10.
*.MlppSupport (for Instructs the system to relay or ignore MLPP information
ISUP)
received in an IAM message over the ingress ISUP trunk.
Also instructs the system to relay MLPP information received
from the ingress trunk to the egress ISUP trunk. Alternatively,
the system ignores the MLPP information and does not relay
the information to the egress ISUP trunk.
—
TRUNKGROUP
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Valid values:
•
0—Do not relay MLPP information
•
1—Relay MLPP information
Default value: 0
This property is added in software Release 9.8(1) S10P10.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-69
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.MlppSupport (for Instructs the system to relay or ignore MLPP information
SIP)
received in a SIP message over the ingress SIP trunk.
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
—
TRUNKGROUP
Also instructs the system to relay MLPP information received
from the ingress trunk to the egress SIP trunk. Alternatively,
the system ignores the MLPP information and does not relay
the information to the egress SIP trunk.
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Valid values:
•
0—Do not relay MLPP information
•
1—Relay MLPP information
Default value: 0
This property is added in software Release 9.8(1) S10P10.
*.MWIInvoke
TimerT1
ISDNPRI
A millisecond timer, as specified by ROSE, that is used to
invoke the message waiting indicator (MWI) supplementary
service. This property is used for communication with a VoIP
gateway connected to a QSIG PBX. Valid values: 0 through
20000 (this value is in milliseconds)
ISDNPRI (BRI)
Default: 15000
This property is added in software Release 9.5(2).
*.MWIStringOFF
Number used within the network to turn off a message waiting DPNSS
indicator, specific to DPNSS signaling services. This property TRUNKGROUP
is used for communication with a VoIP gateway connected to
a DPNSS PBX. Valid values: a string, with a minimum length
of 1 and a maximum length of 32 characters.
DPNSS
TRUNKGROUP
COMMONPROFILE
Default: NULL
This property is added in software Release 9.5(2).
*.MWIStringON
Number used within the network to turn on a message waiting DPNSS
indicator, specific to DPNSS signaling services. This property TRUNKGROUP
is used for communication with a VoIP gateway connected to
a DPNSS PBX. Valid values: a string, with a minimum length
of 1 and a maximum length of 32 characters.
DPNSS
TRUNKGROUP
COMMONPROFILE
Default: NULL
This property is added in software Release 9.5(2).
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-70
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
Property
Definition
*.NATTraversal
Enabled
Specifies whether the Cisco PGW 2200 Softswitch performs —
NAT traversal in an add or modify request. The detailed NAT
traversal method depends on the provisioning of the sigPath
property NATTraversalMethod.
EISUPPROFILE
Valid values:
DOMAINPROFILE
•
0—NAT traversal is not enabled.
•
1—NAT traversal is enabled.
SIPPROFILE
COMMONPROFILE
Default: 0
This property is added in software Release 9.8(1).
*.NATTraversal
Method
Specifies the NAT traversal method that the
Cisco PGW 2200 Softswitch applies to the gateway.
—
ISDNPRI (BRI)
Valid values:
•
0—Apply NAT traversal using the ETSI NAT traversal
package.
•
1—Apply NAT traversal using the IP NAPT package
according to H248.37.
Default: 0
This property is added in software Release 9.8(1).
*.NatureOfAddr
Handling
Determines whether or not to perform preanalysis. Values: 0 or DPNSS
1.
ISDNPRI
Default: 0
SS7-ANSI
*.NetSuspendResu Indicates whether or not the Cisco PGW 2200 Softswitch
meMap2Invite
maps a mid-call ISUP SUSPEND/RESUME, with a
network-initiated value, to a SIP Re-Invite.
DPNSS
ISDNPRI (BRI)
SS7-ANSI
SS7-China
SS7-China
SS7-ITU
SS7-ITU
SS7-Japan
SS7-Japan
SS7-UK
SS7-UK
TRUNKGROUP
SIPPROFILE
COMMONPROFILE
Valid Values:
0—Do not map ISUP SUSPEND/RESUME to SIP Re-Invite
1—Map ISUP SUSPEND/RESUME (network initiate) to SIP
Re-Invite (similar to Hold/TP service).
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-71
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.NetworkType
Specifies whether the underlying network uses ATM or IP. The TRUNKGROUP
NetworkType parameter allows the
Cisco PGW 2200 Softswitch to determine which
protocol-specific parameters to send to gateways.
Note
Associated
Components for
Release 9.8
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
NetworkType populates the network type parameter
(nt:) in the local connection parameters, which is used
for the originating and terminating legs of all calls.
DOMAINPROFILE
Valid values: 0 (IP), 1 (ATM), 2 (IN)
Default value: 0 (IP)
*.NFASImplicit
InterfaceId
Used when an incoming ISDN message containing a Channel ISDNPRI
identification information element identifier with bit 7 of octet
3 set to 0 (Interface implicitly identified) as the implied
interface ID value. Value range: 0 through 127.
ISDNPRI (BRI)
Default = 65535
This property is added in software Release 9.5(2).
*.NonInviteRe
qAttempts
Defines the transmission times for non-INVITE requests
SIP
SIPPROFILE
Valid Values: integer (1-15)
TRUNKGROUP
COMMONPROFILE
DOMAINPROFILE
Default Value: 11
Dynamically Reconfigurable: yes
*.Normalization
*.notification
Include
Normalization of dialed number to unknown. Set to 0 for
disabled and 1 for enabled. Values: 0 or 1.
DPNSS
DPNSS
ISDNPRI
ISDNPRI (BRI)
Default: 0
SS7-ANSI
SS7-ANSI
SS7-China
SS7-China
SS7-ITU
SS7-ITU
SS7-Japan
SS7-Japan
SS7-UK
SS7-UK
Indicates whether or not to include the Notification parameter SS7-ANSI
in the Call Progress (CPG) message. Values: 0 (for no) or 1
TRUNKGROUP
(for yes).
Default: 0
*.Npa
Numbering plan area. Indicates the NPA code associated with TRUNKGROUP
the incoming trunk group. Value range: 0 (none), or 200
through 999.
Default: 0
SS7-ANSI
COMMONPROFILE
GRPROFILE
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-72
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.ocnInclude
Indicates whether or not to include the Original Called
Number in an IAM. Values: 0 (for no) or 1 (for yes).
*.OD32Digit
Support
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
SS7-ANSI
SS7-ANSI
TRUNKGROUP
COMMONPROFILE
Default: 0
GRPROFILE
Allows 32 digits and overdecadic digits support for the ANSI, SS7-ANSI
Q.761, and Q.767 protocol variants. Values: 0 (disabled) or 1 SS7-China
(enabled).
SS7-ITU
Default: 1
SS7-Japan
This property is added in software Release 9.4(1).
SS7-UK
SS7-ANSI
TRUNKGROUP
SS7-China
SS7-ITU
SS7-Japan
SS7-UK
TRUNKGROUP
COMMONPROFILE
*.OMaxDigits
Specifies maximum number of digits to receive for overlap
digit processing for call origination from this traffic path.
Value range: 0 through system maximum.
Default: 24
DPNSS
DPNSS
EISUP
EISUP
ISDNPRI
ISDNPRI (BRI)
SIP
SIP
SS7-ANSI
SS7-ANSI
SS7-China
SS7-China
SS7-ITU
SS7-ITU
SS7-Japan
SS7-Japan
SS7-UK
SS7-UK
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-73
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.OMinDigits
Specifies minimum number of digits to receive for overlap
digit processing for call origination from this traffic path.
Value range: 0 through system maximum.
Default: 0
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
DPNSS
DPNSS
EISUP
EISUP
ISDNPRI
ISDNPRI (BRI)
SIP
SIP
SS7-ANSI
SS7-ANSI
SS7-China
SS7-China
SS7-ITU
SS7-ITU
SS7-Japan
SS7-Japan
SS7-UK
SS7-UK
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
*.OmitCgPnFrom
Unavailable
SIP
SIP
Set to 1 to enable overlap signaling for call origination from
this traffic path. Value range: 0 through system maximum.
DPNSS
DPNSS
EISUP
EISUP
Default: 0
ISDNPRI
ISDNPRI (BRI)
SIP
SIP
SS7-ANSI
SS7-ANSI
SS7-China
SS7-China
SS7-ITU
SS7-ITU
SS7-Japan
SS7-Japan
SS7-UK
SS7-UK
Determines if mapping between the SIP From header to the
IAM calling party number is enabled when the SIP message
header From is “unavailable”. Values are: 0 (enabled) or 1
(disabled).
Default = 0
This property is added in software Release 9.5(2).
*.OOverlap
TRUNKGROUP
EISUPPROFILE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-74
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.OrigCarrierId
Supplies the CarrierId digit string for a trunk group that can
then be referenced against any CarrierID received in the
incoming message. This is used to support the carrier
screening capability, as handled in the protocol. Value range:
up to five digits.
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
TRUNKGROUP
TRUNKGROUP
COMMONPROFILE
Default: 00
*.outboundDomain Indicates the source that the Cisco PGW 2200 Softswitch uses —
ProfileSource
for the outbound domain name.
SIPPROFILE
Valid values:
•
0 = If available, the Cisco PGW 2200 Softswitch uses the
domain used for routing as introduced by the
domain-based routing feature. Otherwise, the
Cisco PGW 2200 Softswitch uses the domain of the SIP
trunk group.
•
1 = The Cisco PGW 2200 Softswitch uses the domain of
the SIP trunk group.
Default value: 0
Dynamically reconfigurable: Yes
This property is added in software Release 9.8(1).
*.OutSessionTimer Maps to trunk group property OutSessionTimer. The
TRUNKGROUP
maximum session time (in milliseconds) allowed for a SIP call
terminated by the Cisco PGW 2200 Softswitch. This value
may require being increased to reduce performance impact.
Valid range: any value greater than 0.
Note
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
In software Release 9.4(1), this is the maximum session
expiration value.
Default: 1800000
*.outsideVrfName
Specifies the VrfName for leg 1 or leg 4 in an IP-to-IP gateway —
call.
This property is added in software Release 9.8(1).
*.outsipheader
table
Contains a pointer to an outbound SIP header table.
Valid values: String. Enter the name of an existing outbound
SIP header table.
EISUPPROFILE
SIPPROFILE
DOMAINPROFILE
—
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default value: NULL
Dynamically reconfigurable: Yes
This property is added in software Release 9.8(1).
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-75
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.OverlapDigit
Time
Overlap interdigit timer. The time to wait for the rest of the
digits.
Value range: 0 through 60.
Default: 6
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
DPNSS
DPNSS
EISUP
EISUP
ISDNPRI
ISDNPRI (BRI)
SS7-China
SIP
SS7-ITU
SS7-China
SS7-Japan
SS7-ITU
SS7-UK
SS7-Japan
SS7-UK
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
*.OwnClli
Specifies the common language location identifier (CLLI).
SS7-ANSI
SS7-ANSI
DPNSS
DPNSS
EISUP
EISUP
ISDNPRI
ISDNPRI (BRI)
TRUNKGROUP
TRUNKGROUP
Default: na
*.OwnRouting
Number
Defines the routing or network number of the
Cisco PGW 2200 Softswitch in a PBX network that requires
Route Optimization or Path Replacement capabilities. The
presence or absence of this property indicates if this service is
enabled/disabled for a signalling path.
Valid range: Alphanumeric string up to 32 digits.
COMMONPROFILE
Default: NULL
This property was added in software Release 9.6(1).
*.PackageType
Maps to trunk group property PackageType. Determines MDL TRUNKGROUP
MGCP message handling according to the CAS trunk group
package. Value range: any alphabetical string.
TRUNKGROUP
COMMONPROFILE
Default: BL
*.Play
Announcement
Specifies whether the Cisco PGW 2200 Softswitch plays an
early announcement on a given trunk group. Valid values:
•
0—The announcement function is disabled for the trunk
group.
•
An integer value greater than 0 specifies the Integer
Announcement Identity.
TRUNKGROUP
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default value: 0
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-76
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Associated
Components for
Release 9
through 9.7
Definition
*.populateSDPInfo Enables or disables the extraction of information from Session TRUNKGROUP
InCDR
Description Protocol (SDP). Extracted SDP information is
populated in call detail records (CDRs). Values: 0 (disabled)
or 1 (enabled).
Associated
Components for
Release 9.8
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
Default: 0
COMMONPROFILE
This property is added in software Release 9.4(1).
DOMAINPROFILE
*.PostConnectTone Indicates the duration for which the tone is to be played in the DPNSS
Duration
bearer channel immediately after connect. Value range: 0
ISDNPRI
through 16000 (in milliseconds).
DPNSS
ISDNPRI (BRI)
Default: 0
*.PostConnectTone Indicates if the post-connect tone is to be played in the bearer DPNSS
Value
channel immediately after connect. Value range: 0 through 12.
ISDNPRI
Default: 0
*.PropagateDelay
Counter
This property indicates the propagation delay increase value —
(measured in milliseconds) which the
Cisco PGW 2200 Softswitch adds to the propagation delay of
the incoming message. The outgoing message carries the
calculation result. This property is for PSTN emulation
services (SIP-I).
DPNSS
ISDNPRI (BRI)
TRUNKGROUP
COMMONPROFILE
Valid values: integer (0 to 255).
Default value: 0.
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
*.PropagateSvc
MsgBlock
Indicates the type of blocking messages supported. If true,
DPNSS
protocols supporting group blocking send individual blocking
ISDNPRI
messages. If false, protocols supporting group blocking
RLM
continue to send group blocking messages.
Note
DPNSS
ISDNPRI (BRI)
This sigpath property is useful only for switching
(nailed) solutions.
Values: true or false.
Default: false
*.Protocolidand
VariantidProv
Indicates whether or not to carry variant information over
EISUP. Valid values: 1(protocol and variant information will
be carried), 0(only protocol information will be carried).
EISUP
EISUP
Default: 0.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-77
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.QSIGTunnel
Variant
Controls the QSIG tunnel capability across outbound EISUP EISUP
(HSI) interfaces and specifies which protocol variant is used.
TRUNKGROUP
Valid Values:
•
0—QSIG tunneling is disabled
•
1—QSIG tunneling is enabled
Associated
Components for
Release 9.8
EISUP
EISUPPROFILE
COMMONPROFILE
Default Value: 0
radiuskey
Radius Server shared secret key. Default: 0000000000000000. LI
LI
radiusretrycount
The number of times the accounting packet need to be re-sent. LI
Default: 3.
LI
radiustimeout
The timeout to wait for a response from the mediation device, LI
in milliseconds. Default: 5.
LI
*.redirCapInclude
Indicates whether or not to include the Redirect Capability in SS7-ANSI
an IAM. Values: 0 (for no) or 1 (for yes).
TRUNKGROUP
Default: 0
SS7-ANSI
Indicates whether or not to include the Redirect Counter in an SS7-ANSI
IAM. Values: 0 (for no) or 1 (for yes).
TRUNKGROUP
Default: 0
SS7-ANSI
A flag used for passing the Original Called Number (OCN) or DPNSS
the Redirecting Number to the Redirecting Number field in the ISNDPRI
Q.931+ protocol. Values: 0 or 1.
DPNSS
*.redirCounter
Include
*.RedirectingNbr
Map
COMMONPROFILE
GRPROFILE
COMMONPROFILE
GRPROFILE
ISNDPRI (BRI)
Default: 0
*.redirInfoInclude
Indicates whether or not to include the Redirection Info in an
IAM. Values: 0 (for no) or 1 (for yes).
Default: 0
SS7-ANSI
SS7-ANSI
TRUNKGROUP
COMMONPROFILE
GRPROFILE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-78
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.RedirMax
ISDNPRI
Specifies the maximum allowable value of the redirection
counter parameter available in some C7 signaling systems
SS7-ANSI
before the call is force-released. Used to prevent routing loops
SS7-China
in certain applications.
Associated
Components for
Release 9.8
ISDNPRI (BRI)
SIP
SS7-ANSI
Default: 5
SS7-ITU
SS7-China
Value range prior to Release 9.7(3) S22P22: 0 to system
maximum.Value range for Release 9.7(3) S22P22 and later:
SS7-Japan
SS7-ITU
SS7-UK
SS7-Japan
1–5:
SS7-UK
•
OCC—Allow the specified number (1–5) of redirections
before the call is force-released.
•
TCC—Reset the redirect counter to 5 if it is < 1 or > 5.
COMMONPROFILE
0:
•
OCC—Allow the redirection counter to have any value
from 1 to 7.
•
TCC—If the redirection counter is set to a value 0–7, set
it as is; if the redirection counter is greater than 7, reset it
to 7.
OCC = Originating (side) call control.
TCC = Terminating (side) call control.
*.RedirNumFor
Analysis
This is an integer that indicates whether the
EISUP
Cisco PGW 2200 Softswitch performs number analysis based
SIP
on redirecting number (where applicable).
EISUP
SIP
Valid values:
•
0—Do not use the redirecting number for number
analysis.
•
1—Use the redirecting number for number analysis
without support of redirecting number modification
(RMODDIG disabled).
•
2—Use the redirecting number for number analysis with
support of redirecting number modification (RMODDIG
enabled).
•
3-Use the redirecting number for number analysis no
matter with or without support of redirecting number
modification(both AMODDIG and RMODDIG enabled)
Default value: 0
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-79
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.ReferRedirecting Redirecting indicator of Redirection Information in ITU SS7
Ind
REL message for blind transfer by SIP REFER.
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
SIP
TRUNKGROUP
SS7-ITU
Value range:
0—No redirection
1—Call rerouted
2—Call rerouted, all redirection information presentation
restricted
3—Call diverted
4—Call diverted, all redirection information presentation
restricted
5—Call rerouted, redirection number presentation restricted
6—Call diversion, redirection number presentation restricted
*.ReferRedirecting NOA value of redirection number in ITU SS7 REL message
NOA
for blind transfer by sip REFER. Use internal NOA value.
TRUNKGROUP
TRUNKGROUP
DPNSS
DPNSS
ISDNPRI
ISDNPRI (BRI)
SS7-ANSI
SS7-ANSI
SS7-China
SS7-China
SS7-ITU
SS7-ITU
SS7-Japan
SS7-Japan
SS7-UK
SS7-UK
Value range:
1—NOA_NONE
2—NOA_UNKNOWN
3—NOA_SUBSCRIBER
4—NOA_NATIONAL
5—NOA_INTERNATIONAL
*.ReleaseMode
Defines the type of releasing. Asynchronous clearing allows
both OCC and TCC sides to clear independently; circuits are
freed earlier in the release sequence. Synchronous clearing
requires that the clearing at the two sides is synchronized.
Note
There may be times when synchronous clearing is
more appropriate for a Cisco PGW 2200 Softswitch
configuration, for example, when supplementary
service signaling contained in clearing messages
requires transporting between the two sides.
Valid values: Async or Sync. If migrating from a previous
software version, async, ASYNC, sync, and SYNC are also
valid values. (This property value is determined by the
engine.SysVirtualSwitch parameter setting.)
Default: Async
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-80
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.respectSipUriU
serParm
TRUNKGROUP
Allows the Cisco PGW 2200 Softswitch to ignore the
p-asserted-id and remote-party-id headers if user=phone value
is not present.
Associated
Components for
Release 9.8
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Valid values:
•
0—The Cisco PGW 2200 Softswitch always processes
the p-asserted-id and remote-party-id headers.
•
1—The Cisco PGW 2200 Softswitch ignores the
p-asserted-id and remote-party-id headers if the
user=phone value is not present.
Default value: 0
*.Response
Attempts
Defines the transmission times for response.
SIP
SIPPROFILE
Valid Values: integer (1-15)
TRUNKGROUP
COMMONPROFILE
DOMAINPROFILE
Default Value: 11
Dynamically Reconfigurable: y
*.restartTimer
Time (in tenths of a second) to pause before sending next
group of messages to MTP3 after restart. Value range: 0
through 100, where 0 = Disabled and 10 = 1 second.
SS7-ANSI
SS7-ANSI
—
SIPPROFILE
Default: 10
*.RestrictPresIfNo
PAID
This property indicates whether the
Cisco PGW 2200 Softswitch sets the CgPN Address
Presentation Restricted Identifier (APRI) of the outgoing
ISUP message to presentation restricted when the incoming
SIP-I message does not contain the P-Asserted-Identity
header. This property is for PSTN emulation services
(SIP/SIP-I).
COMMONPROFILE
DOMAINPROFILE
Valid values: boolean
•
0 = If the incoming SIP-I message does not contain the
P-Asserted-Identity header, the
Cisco PGW 2200 Softswitch sets the CgPN APRI of the
outgoing ISUP message according to the ITU-T
Recommendation Q1912.5.
•
1 = If the incoming SIP-I message does not contain the
P-Asserted-Identity header, the
Cisco PGW 2200 Softswitch sets the CgPN APRI of the
outgoing ISUP message to presentation restricted.
Default value: 0.
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-81
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
Associated
Components for
Release 9
through 9.7
*.RetransMethod
Defines the re-transmission method.
SIP
SIPPROFILE
Valid Values:
TRUNKGROUP
COMMONPROFILE
•
1 = exponential
•
2 = linear
Associated
Components for
Release 9.8
DOMAINPROFILE
Default Value: 1
Dynamically Reconfigurable: yes
*.RetryAfterTimer
Maps to trunk group property RetryAfterTimer. Indicates the TRUNKGROUP
time (in milliseconds) the Cisco PGW 2200 Softswitch waits
before successfully retrying a SIP call. Value range: any value
greater than 0.
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default: 90000
*.RingNoAnswer
Ring no answer. Indicates the time, in seconds, ringing is
allowed to occur. Value range: 0 through 600.
TRUNKGROUP
TRUNKGROUP
COMMONPROFILE
Default: 255
*.RltPrefixLength
Length of the prefix to be removed from the RLT redirection —
number before the number is sent to ISUP side. Valid value
must be larger than 0. Value of 0 means no redirection number
manipulation is enabled. If the value is larger than or equal to
the total length of the redirection number,
Cisco PGW 2200 Softswitch automatically ignores this
configuration.
TRUNKGROUP
Value Range: 0–255.
Default value: 0.
This property is added in Release 9.8(1) S9P9.
*.rnInclude
Indicates whether or not to include the Redirecting Number in SS7-ANSI
an IAM. Values: 0 (for no) or 1 (for yes).
TRUNKGROUP
Default:0
*.RORequestDelay Specifies the time delay before sending out Route
Timer
Optimization requests.
DPNSS
SS7-ANSI
COMMONPROFILE
GRPROFILE
DPNSS
Valid Values: Integer, range 0–1000
Default value: 0
*.RouteId
This property is needed so that the user/customer can specify SS7-ITU
a route ID to overwrite the ID received in the RIN parameter
in the IAM from the OCC side. Value range: 0 through 65355.
SS7-ITU
Default: 0
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-82
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
Associated
Components for
Release 9
through 9.7
*.RoutePref
Determines the preferred route. Value range: 0 through 9.
DPNSS
DPNSS
0 = No Preference (default)5 = IP Preferred
ISDNPRI
ISDNPRI (BRI)
1 = ATM Essential6 = IP Excluded
SS7-ANSI
SS7-ANSI
2 = ATM Preferred7 = TDM Essential
SS7-China
SS7-China
3 = ATM Excluded8 = TDM Preferred
SS7-ITU
SS7-ITU
4 = IP Essential9 = TDM Excluded
SS7-Japan
SS7-Japan
Default: 0
SS7-UK
SS7-UK
The maximum number of RUDP retransmissions count.
Value range: 1 through 100.
EISUP
DPNSS
ISDNPRI
ISDNPRI (BRI)
Default: 2
SS7-ANSI
SS7-ANSI
SS7-China
SS7-China
SS7-ITU
SS7-ITU
SS7-Japan
SS7-Japan
SS7-UK
SS7-UK
*.rudpNumRetx
Associated
Components for
Release 9.8
SESSION
*.rudpRetxTimer
The retransmission timeout. Value range: 2 through 100.
EISUP
DPNSS
Default: 6
ISDNPRI
ISDNPRI (BRI)
SS7-ANSI
SS7-ANSI
SS7-China
SS7-China
SS7-ITU
SS7-ITU
SS7-Japan
SS7-Japan
SS7-UK
SS7-UK
SESSION
*.rudpWindowSz
The maximum number of unacknowledged segments in the
RUDP window. Value range: 2 through 64.
ISDNPRI
ISDNPRI (BRI)
SS7-ANSI
SS7-ANSI
Default: 32
SS7-China
SS7-China
SS7-ITU
SS7-ITU
SS7-Japan
SS7-Japan
SS7-UK
SS7-UK
SESSION
SESSION
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-83
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.SatelliteInd
Satellite indicator. Indicates if the trunk is going over a
satellite. Values are: 0 (no) or 1 (yes).
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
TRUNKGROUP
TRUNKGROUP
SIPPROFILE
Default: 0
COMMONPROFILE
SESSION
TRUNKGROUP
*.ScreenFailAction Screen fail action. Indicates if an action is to be performed
when a screening failure occurs. Values are: 0 (no) or 1 (reject
call).
TRUNKGROUP
COMMONPROFILE
Default: 0
DPNSS
DPNSS
ISDNPRI
ISDNPRI (BRI)
SS7-ANSI
SS7-ANSI
Value range: 0 through 4. 0 = terminating seizure, 1 = Address SS7-China
complete, 2 = Alerting or Inband information available, or 3 = SS7-ITU
Answer. 4 =ACM with interworking or inbandinfo or ISDN
SS7-Japan
not all the way
SS7-UK
Default: 0
SS7-China
*.SdpXmitToH323 Indicates the point in a call when the
Trigger
Cisco PGW 2200 Softswitch sends the Session Destination
Protocol (SDP) from the terminating call leg to the H.323
Signaling Interface (HSI).
This property is added in software Release 9.4(1).
TRUNKGROUP
SS7-ITU
SS7-Japan
SS7-UK
TRUNKGROUP
EISUPPROFILE
*.SendAddressIn
Cgpn
Determines if the CLI digits are sent in the outgoing calling SS7-ANSI
party number parameter. Value is: 0 (False) for do not include
SS7-ITU
address digits in calling party number parameter, or 1 (True)
for including address digits in calling party number parameter. SS7-UK
Default: 1
TRUNKGROUP
SS7-ANSI
SS7-ITU
SS7-UK
TRUNKGROUP
COMMONPROFILE
*.sendAfterRestart Number of queued messages to send (in one group) to MTP3 SS7-ANSI
after restart end. This value, combined with the sendTimer,
SS7-ITU
controls the amount of data sent to MTP3 after restart ends. If
too much data is sent to MTP3 after restart, MTP3 could be
flooded. Value range: 0 through 256.
SS7-ANSI
SS7-ITU
Default: 16
*.SendDtmfBefore Determines if the DTMF signal is sent out to the terminating EISUP
Connect
call side before the connection is set up. Value is: 0 for the
DTMF to be sent to the TCC only after the connection is set
up, or 1 for the DTMF to be sent to the TCC after the ACM is
received.
EISUP
Default:0
This property is added in software Release 9.6(1).
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-84
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.serviceCode
Include
Indicates whether or not to include the Service Code
parameter in an IAM. Values are: 0 (for no) or 1 (for yes).
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
SS7-ANSI
SS7-ANSI
TRUNKGROUP
COMMONPROFILE
Default: 0
*.sgcpRetxCount
GRPROFILE
Number of times an SGCP msg is retried upon failure. Value
range: 1 to 4.
SGCP
SGCP
SGCP
SGCP
Default: 3
*.sgcpRetxTimer
Timer interval in milliseconds, between invocations of the
SGCP retry timer. Value range: 0 to 3000.
Default: 1000
*.SipCallHold
Method
Indicates which call hold method the
SIP
Cisco PGW 2200 Softswitch uses.
Cisco PGW 2200 Softswitch has two SIP call hold methods.
One is according to RFC2543, setting c=0.0.0.0, the other is
according to RFC3264, setting a=sendonly or a=inactive. Both
are supported, but when Cisco PGW 2200 Softswitch initiates
call hold, there must be a rule to follow. This provision
determines how Cisco PGW 2200 Softswitch handles a
received call hold request from the ISUP/HSI side, but if an
RFC2543 call hold request is received before
Cisco PGW 2200 Softswitch sends a call hold request,
Cisco PGW 2200 Softswitch sets itself in RFC2543 call hold
method even if it is configured to RFC3264. If an RFC3264
call hold request is received before
Cisco PGW 2200 Softswitch sends a call hold request,
Cisco PGW 2200 Softswitch sets itself in RFC3264 call hold
method even if it is configured to RFC2543.
SIP
Valid Values:
•
0 (RFC3264 method: "a=sendonly")
•
1 (RFC2543 method: "c=0.0.0.0")
Default Value: 0
Property Domain: _X_SigPath
Protocol Family: SIP
Dynamically Reconfigurable: yes
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-85
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.SIPCOLPReq
Enabled
This property specifies whether the COLP request for
SIP-originated calls is enabled or not. This property is for
PSTN emulation services (SIP/SIP-I).
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
—
SIPPROFILE
COMMONPROFILE
Values: boolean (0 = not enabled, 1 = enabled).
Default value: 0.
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
*.SipDtmfContent
Type
This property determines the Content-Type header and the
SDP content of INFO requests Cisco PGW 2200 Softswitch
sends.
SIP
SIP
TRUNKGROUP
SIPPROFILE
COMMONPROFILE
Valid values:
•
0 = Sets the Content-Type header to
audio/telephone-event
•
1 = Sets the Content-Type header to
application/dtmf-relay
DOMAINPROFILE
Default value: 0
*.SipEgressEarly
DialogRelType
This property indicates whether the
Cisco PGW 2200 Softswitch sends the CANCEL message or
the BYE message for the Early Dialog release. This property
is for Q.1912.5 compliance.
—
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Valid values: boolean (0 = send the CANCEL message, 1 =
send the BYE message).
Default value: 0.
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-86
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.SipEgressGN2
FromScreenInd
This property controls how the Cisco PGW 2200 Softswitch
maps the generic number to the SIP From header. This
property is for PSTN emulation services (SIP/SIP-I).
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
—
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Valid values: integer (from 0 to 3)
•
0 = UPVP and UPNV—If the screen indicator
sub-parameter in the incoming ISUP message is UPVP or
UPNV and the property value is 0, the
Cisco PGW 2200 Softswitch maps the generic number to
the SIP From header.
•
1 = UPVP—If the screen indicator sub-parameter in the
incoming ISUP message is UPVP and the property value
is 1, the Cisco PGW 2200 Softswitch maps the generic
number to the SIP From header.
•
2 = UPNV—If the screen indicator sub-parameter in the
incoming ISUP message is UPNV and the property value
is 2, the Cisco PGW 2200 Softswitch maps the generic
number to the SIP From header.
•
3 = always mapping—If the property value is 3, the
Cisco PGW 2200 Softswitch always maps the generic
number to the SIP From header.
Default value: 0.
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-87
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.sipEgress
RoutingControl
Defines the preferred SIP header used for egress routing
decisions, based on the initial SIP INVITE message.
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
TRUNKGROUP
SIP
Valid Values:
•
1 = Allow Request-Line Modification (strict router
behavior)
The Cisco PGW 2200 Softswitch modifies the SIP header
with routing changes and ignores any pre-existing routes.
The Cisco PGW 2200 Softswitch does not include an
explicit route in the initial INVITE message.
•
2 = Allow Request-Line Modification
The Cisco PGW 2200 Softswitch handles egress routing
as follows:
– The Cisco PGW 2200 Softswitch removes the first
route in any pre-existing route set (after removal of
any Route: matching the
Cisco PGW 2200 Softswitch Domain) and uses it in
the Request-Line, if present.
– If further routes exist, the
Cisco PGW 2200 Softswitch forwards the remaining
routes. If the Cisco PGW 2200 Softswitch did not
receive additional routes, it uses the analysis routing
changes in the request-line.
•
3 = Protect Request-Line URI
The Cisco PGW 2200 Softswitch inserts an explicit
Route: header into the route set if the routing is different
from the Request-Line. This setting requires that the next
hop device act as a loose router.
•
4 = Protect Request-Line URI
The Cisco PGW 2200 Softswitch removes all existing
Route: Headers and inserts an explicit Route: header if
routing is different from the Request-Line. This setting
requires that the next hop device act as a loose router.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-88
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property
*.sipEgress
RoutingControl
Property Definitions (continued)
Definition
•
5 = Protect Request-Line URI
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
TRUNKGROUP
SIP
—
SIPPROFILE
The Cisco PGW 2200 Softswitch handles egress routing
as follows:
– If a pre-existing route set exists, the
Cisco PGW 2200 Softswitch removes the first route
if it matches the Cisco PGW 2200 Softswitch’s
Domain, and forwards the headers of any existing
routes. The Cisco PGW 2200 Softswitch discards any
routing changes encountered during analysis,
honoring trunk group selection only.
– If no route-set exists but analysis has changed
routing, the Cisco PGW 2200 Softswitch inserts an
explicit route, leaving the request-line unchanged.
Default: 1
Note
*.SipICANCEL
EncapREL
If the sipRoutingMode XECfgParm parameter is set to
0 (strict-router), sipEgressRoutingControl must be set
to 1.
This property indicates whether the encapsulated REL
message is required or not in the CANCEL message.
COMMONPROFILE
This property is a non-essential SIP-I-specific property.
DOMAINPROFILE
Valid values: boolean (0 = not required, 1 = required).
Default value: 0.
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
*.SipICLICOL
Preference
This property indicates which parameters the CLI/Connect
number takes as preference, SIP header or ISUP parameters.
This property is a non-essential SIP-I-specific property.
—
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Valid values: boolean.
•
0 = CLI/Connect number takes SIP header parameters as
preference.
•
1 = CLI/Connect number takes ISUP parameters as
preference.
Default value: 0.
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-89
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.SipIConfusion
Handling
This property indicates whether to terminate the ISUP
confusion message or transport this message transparently.
This property is a non-essential SIP-I-specific property.
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
—
SIPPROFILE
Valid value: boolean.
•
0 = terminate the ISUP confusion message.
•
1 = transport the ISUP confusion message transparently.
COMMONPROFILE
DOMAINPROFILE
Default value: 0.
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
*.SipIEgress
Handling
This property indicates the value of handling the disposition —
parameter in the Content-Disposition header field of the ISUP
MIME body in SIP-I messages. This property is set on
outgoing trunk groups with SIP-I support. If it is set to 2,
"handling=required" is always added to the INVITE
Content-Disposition header. If it is set to 0,
"handling=required" is added only if there is a
to-be-encapsulated IAM message with user-to-user
information; otherwise, "handling=optional" is added. This
property is an essential SIP-I-specific property.
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Valid value: integer (from 0 to 2)
•
0 = Content-Disposition header is
"Content-Disposition:signal; handling=required" only if
there is a to-be-encapsulated IAM message with
user-to-user information; otherwise, Content-Disposition
header is "Content-Disposition:signal;
handling=optional".
•
1 = Content-Disposition header is
"Content-Disposition:signal; handling=optional".
•
2 = Content-Disposition header is
"Content-Disposition:signal; handling=required".
Default value: 1.
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-90
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.SipIEgressISUP
Version
This property indicates the version sub-parameter used in the —
Content-Type header field for SIP-I messages on the outgoing
SIP trunk group. This property is an essential SIP-I-specific
property.
Associated
Components for
Release 9.8
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Valid values: NULL or any string up to 128 characters in
length.
Default value: NULL.
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
*.SipIEgressMDO
This property indicates the SIP-I variant name on the outgoing —
SIP trunk group. This property is an essential SIP-I-specific
property.
Valid values: NULL or any string up to 40 alphanumeric
characters.
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default value: NULL.
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
*.SipIFacility
RejectHandling
This property indicates whether to terminate the ISUP facility —
reject message or transport this message transparently. This
property is a non-essential SIP-I-specific property.
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Valid values: boolean.
•
0 = terminate the ISUP facility reject message.
•
1 = transport the ISUP facility reject message
transparently.
Default value: 0
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
*.SipIIngress
VersionMAP
This property indicates the SIP-I mapping profile name which —
is defined in the SIP profile name field of the sipIVersion.dat
file. This property is an essential SIP-I-specific property.
Valid values: NULL or the string defined in the SIP-I mapping
profile name field of the sipIVersion.dat file, like BT.
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default value: NULL.
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-91
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.SipIngressLNP
Handling
This property controls whether the
Cisco PGW 2200 Softswitch maps the SIP routing number
and the telephone number to the called party number and the
generic address ISUP parameters. This property is for PSTN
emulation services (SIP/SIP-I).
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
—
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Valid values: boolean (0 = no mapping, 1 = mapping)
Default value: 0.
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
*.sipIngress
RoutingControl
Defines the preferred SIP header used for ingress routing
decisions as determined from the initial INVITE message.
TRUNKGROUP
Valid Values:
•
1 = Explicit Route header
•
2 = Request Line
•
3 = To: header
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default Value: 2
Note
*.SipInsertReason
Header
If the sipRoutingMode XECfgParm parameter is set to
0 (strict-router), only option 2 is valid.
This property indicates whether a reason header containing the —
cause code is required or not. This property is for Q.1912.5
compliance.
Valid values: integer (from 0 to 2)
•
0 = do not insert the reason header.
•
1 = add the reason header in Q.850 format.
•
2 = add the reason header in ANSI format.
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default value: 0.
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
*.SipIPSource
TRUNKGROUP
Indicates for the Cisco PGW 2200 Softswitch to use the IP
packet source address or IP address from Session Description
Protocol (SDP) in the INVITE message to make the dial plan
selection for SIP calls. Valid values: 0 (use the IP packet
source address) or 1 (use the IP address from SDP).
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default: 0
This property is added in software Release 9.4(1).
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-92
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.SipIToiw2
This property indicates the Toiw2 timer value measured in
seconds. This property is for Q.1912.5 compliance.
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
—
SIPPROFILE
COMMONPROFILE
Valid values: integer (from 4 to 14).
DOMAINPROFILE
Cause for initiation: Sending of INVITE.
Termination criterion: On receipt of 18x, or 200 OK INVITE.
Action At expiry: Send early ACM
Default value: 4.
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
*.sipMimeBody
Support
This property indicates how SIP, SIP-T, SIP-GTD, and SIP-I
are supported on a trunk group. Valid values:
•
0 = only SIP supported
•
1 = SIP-T supported
•
2 = SIP-GTD supported
•
3 = Only SIP-I is supported on the incoming trunk group.
SIP and SIP-I are supported on the outgoing trunk group
•
4 = SIP and SIP-I are supported on both the incoming and
outgoing trunk groups
TRUNKGROUP
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default: 0
Note
For Release 9.7, if you set sipMimeBodySupport to 2
on originating side, the Cisco PGW 2200 Softswitch
does not check the value of sipMimeBodySupport on
terminating side. It will transit incoming SIP-GTD
messages recived from originating call control (OCC)
to terminating call control (TCC).
For Release 9.8, if you set SipMimeBodySupport to 2
on terminating side, the Cisco PGW 2200 Softswitch
will use CC container to build the outgoing SIP-GTD
messages. If SipMimeBodySupport is NOT set to 2,
the Cisco PGW 2200 Softswitch will send out SIP
messages, not SIP-GTD messages.
This property is added in software Release 9.4(1).
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-93
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
SIP
SIP
SIP
Enables/disables special handling for SIP REFER, which is
required to support the single-step call transfer (SSCT)
supplementary service. This property is used for SIP signaling
services when supporting communication with a VoIP gateway
connected to a QSIG PBX. Valid values: 0 (Standard SIP
REFER) or 1 (SIP REFER to support SSCT).
SIP
Property
Definition
*.SipRedir
AnalysisMethod
Specifies whether the Cisco PGW 2200 Softswitch performs
B-number analysis on the number returned in a 302 contact.
This property is useful if a redirect returns a contact that the
Cisco PGW 2200 Softswitch cannot analyze.
Valid values:
*.SipReferFor
SingleStepXfer
•
0 = If the host listed in the 302 contact is the
Cisco PGW 2200 Softswitch host, perform digit analysis.
(conditional)
•
1 = The Cisco PGW 2200 Softswitch does not perform
digit analysis on the called party number (B number).
•
2 = The Cisco PGW 2200 Softswitch does not perform
digit analysis on the calling party number (B number).
Default: 0
This property is added in software Release 9.5(2).
*.SipSatelliteInd
Enable
This property is added in software Release 9.7(3) S5P5
SIP
SIP
Specifies whether to set the satellite_circuit_in_connection
indicator to 1 in the IAM for SIP to SS7 calls. (According to
ITU-T Recommendation Q.1912.5, Table 4, Satellite Indicator
should be set to 1 for SIP to SS7 calls.)
This property allows you to set the
satellite_circuit_in_connection indicator to 0 or 1 according to
your specific requirements.
Valid values: 0, 1
Default value: 1
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-94
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.SipTgrpLabel
Use this property to specify the clear channel routing class in —
SIP signaling. When you set the CheckSipTgrpParam property
to 1, the value of the tgrp parameter in the first incoming SIP
INVITE message must match this property value. This
property is provisioned in SIP profiles.
Associated
Components for
Release 9.8
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Valid values: string (1 to 64 bytes string) or NULL (does not
check the tgrp parameter).
Default value: ccdata.
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
*.SipToIsupRatio
Set the ratio of Max_Forwards to Hop Counter for a call from SIP
SIP to ISUP.
SIP
Valid values: 0 through 4. 0 indicates the mapping does not
function.
Default value: 0
*.siptransportmode Specifies the transport protocol permitted for a trunk group.
—
Valid values:
•
0 = UDP
•
1 = TCP
•
2 = DYNAMIC
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default value: 0
Dynamically reconfigurable: Yes
Note
This property can be overridded based on values
provisioned for the *.SipUDP2TCPByteXover
property.
This property is added in software Release 9.8(1).
*.SipTrunkContext Use this property to specify a namespace on the trunk group. —
When you set the CheckSipTgrpParam property to 1, the value
of the trunk-context parameter in the first incoming SIP
INVITE message must match this property value. This
property is provisioned in SIP profiles.
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Valid values: string (1 to 64 bytes) or NULL (does not check
the trunk-context parameter).
Default value: NULL.
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-95
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.SipUPDATESup
port
—
Associate this SIP profile property with a SIP trunk group.
This property indicates whether or not the Cisco PGW 2200
inserts the UPDATE method into the ALLOW header during
initial dialog exchanges preliminary to establishing a call. If
you set this property to 1 (the default), the system inserts the
UPDATE method into the ALLOW header. If you set this
property to 0, the system does not insert the UPDATE method
into the ALLOW header.
Associated
Components for
Release 9.8
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
When the dialog advances to an exchange of 200 OK
messages, this property setting is no longer a factor in the
exchange of call signaling messages.
Valid values: 0 and 1
0—Do not insert the UPDATE method in the ALLOW header
1—Insert the UPDATE method in the ALLOW header
*.SipUDP2TCP
ByteXover
Determines the SIP message size (in bytes) above which the
Cisco PGW 2200 Softswitch switches to TCP transport. This
property applies to outgoing SIP traffic only.
—
Valid values:
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
0—The Cisco PGW 2200 Softswitch does not switch from
UDP to TCP regardless of the SIP message size.
1-10000—The Cisco PGW 2200 Softswitch switches to TCP
transport for messages above the specified size (in bytes).
Default value: 0
Note
This property overrides the siptransportmode
parameter.
This property is added in software Release 9.8(1).
Time (in tenths of a second) to maintain the same signal linkset SS7-ANSI
in class 1 (connectionless) messages. This is the type of
SS7-ITU
service provided by the SCCP layer. Value range: 0 through
600, where 0 = Disabled and 300 = 30 seconds.
*.slsTimer
SS7-ANSI
SS7-ITU
Default: 300
*.spanId
*.srcpAuditGw
Interval
E1/T1 ID for FAS and DPNSS, ffff for SS7. Value range: Hex DPNSS
0 through ffff.
ISDNPRI
Default: ffff
DPNSS
Indicates how often the SRCP protocol should perform a GW MGCP
audit on the gateway, in seconds. Value range: 0 through 1000.
MGCP
ISDNPRI (BRI)
Default: 10
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-96
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.srcpAuditLine
Interval
Indicates how often the SRCP protocol should perform a line MGCP
audit on the gateway, in seconds. Value range: 0 through 1000.
Associated
Components for
Release 9.8
MGCP
Default: 10
*.srcpHeartbeat
Interval
Indicates how often the SRCP protocol should heartbeat the
gateway, in seconds. Value range: 0 to 1000.
MGCP
MGCP
MGCP
Local IP port to which the SRCP protocol should bind to
receive messages from the gateway. Setting this value to zero
turns off srcp.
MGCP
Default: 10
*.srcpIpPortLocal
Default: 0
*.srcpIpPort
Remote
Remote IP port to which the SRCP protocol should send
messages.
MGCP
MGCP
MGCP
MGCP
MGCP
MGCP
MGCP
MGCP
Default: 2428
*.srcpRemote
AuditGwInterval
Indicates how often the SRCP protocol should perform an
audit on remote gateway, in seconds. Value range: 0 through
1000.
Default: 10
*.srcpRetxCount
A limit on the number of retransmissions before declaring
failure. Value range: 0 through 10.
Default: 3
*.srcpRetxTimer
A limit on the time to wait for a response from a gateway
before retransmitting the message, in milliseconds. Value
range: 0 through 60000.
Default: 1000
*.sRtpAllowed
This property controls whether the trunk group supports SRTP —
or not. This property is provisioned as either a trunk group
property or a SIP profile property.
Valid values: boolean (0 = does not support, 1 = supports).
TRUNKGROUP
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default value: 0.
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1)
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-97
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.sRtpSupported
This property indicates whether a media gateway supports
SRTP or not. This property is provisioned on an MGCP
sigPath.
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
—
MGCP
Valid values: boolean (0 = does not support, 1 = supports).
Default value: 0.
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1)
SS7-ANSI
Time (in tenths of a second) between sending Subsystem
Route Test message (SRT) to remote subsystems. Value range:
0 through 3000, where 0 = disabled and 300 = 30 seconds.
*.srtTimer
SS7-ANSI
Default: 300
*.SSCTInvoke
TimerT1
ISDNPRI
A millisecond timer, as specified by ROSE, that is used to
invoke the single-step call transfer (SSCT) supplementary
service. This property is used for communication with a VoIP
gateway connected to a QSIG PBX. Valid values: from 50000
to 180000 (in milliseconds)
ISDNPRI (BRI)
Default Value: 50000
This property is added in software Release 9.5(2).
*.sstTimer
SS7-ANSI
Time (in tenths of a second) between sending Subsystem
Route Test message (SRT) to remote subsystems. Value range: SS7-ITU
0 through 3000, where 0 = disabled and 300 = 30 seconds.
SS7-ANSI
SS7-ITU
Default: 300
*.standard
Version of protocol standard supported for this STP/SCP.
SS7-ANSI
SS7-ANSI
Defaults: SS7-ANSI = ANSI96,
SS7-ITU = ITU96,
SS7-ITU
SS7-ITU
ANSI96,
ITU96,
ANSI92,
ITU92
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-98
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property
Property Definitions (continued)
Definition
*.STdigitforCDPN Specifies whether a stop digit is applied to the called party
number during call processing. This property was introduced
in Cisco PGW 2200 Softswitch version 9.6(1).
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
TRUNKGROUP
SS7-ITU
This property applies to Q.767 only.
Note
Values:
•
0 = Stop digit applied to IAM and SAM
If the Cisco PGW 2200 Softswitch is in en bloc mode, it
applies the stop digit to the called party number in the
IAM (Initial Address Message). If the
Cisco PGW 2200 Softswitch is in overlap mode, it applies
the stop digit to the called party number in the SAM
(Subsequent Address Message).
•
1 = Stop digit applied to SAM only
If the Cisco PGW 2200 Softswitch is in en bloc mode, it
does not apply the stop digit to the calling party number
in the IAM (Initial Address Message). If the
Cisco PGW 2200 Softswitch is in overlap mode, it applies
the stop digit to the called party number in the SAM
(Subsequent Address Message).
•
2 = Stop digit not applied to IAM or SAM
The Cisco PGW 2200 Softswitch does not apply the stop
digit to the called party number in either the IAM (Initial
Address Message) or the SAM (Subsequent Address
Message), regardless of whether the
Cisco PGW 2200 Softswitch is in en bloc or overlap
mode.
Default: 0
*.STdigitforCLI
Indicates during call processing whether or not a stop digit is SS7-China
applied to the calling number. Values: 0 (no stop digit is
applied to the calling number) or 1 (a stop digit is applied to
the calling number and the Calling Line Identity parameter D
bit is set to 0 specifying “No Indication”).
Note
SS7-China
Only valid for Q721_CHINA.
Default: 0
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-99
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.SubscribeNotify
Support
Determines if the SIP Subscribe/Notify methods for solicited TRUNKGROUP
notification of SIP DTMF digits is enabled or disabled.
Valid Values:
•
0 = Subscribe/Notify methods disabled
•
1 = Subscribe/Notify methods enabled
Associated
Components for
Release 9.8
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default: 0
This property is added in software Release 9.4(1).
*.Support183
Maps to trunk group property Support183. Indicates how the
Cisco PGW 2200 Softswitch supports 183 response code.
This property is for Q.1912.5 compliance.
TRUNKGROUP
Valid values: integer (from 0 to 5).
•
0 = 183 not supported
•
1 = Q1912.5 supported without SDP in 180 message
•
2 = Q1912.5 supported with InbandInfo check
•
3 = 183 supported
•
4 = always send 183
•
5 = Q1912.5 supported
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default value: 3.
Dynamically reconfigurable: yes.
*.supportKPML
SIP profile property. Indicates whether the
—
Cisco PGW 2200 Softswitch relays or ignores the KPML
information received in SIP message on the ingress SIP Trunk.
Also, indicates whether KPML information received from
ingress trunk shall be relayed or ignored on the egress SIP
trunk.
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Valid values:
•
0—KPML information is relayed
•
1—KPML information is ignored
Default value: 0.
*.SupportReliable
100
Maps to trunk group property SupportReliable100. Indicates if TRUNKGROUP
the Cisco PGW 2200 Softswitch supports reliable100
response code. Values are: TRUE or FALSE.
Default: FALSE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-100
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Associated
Components for
Release 9
through 9.7
Definition
—
*.SupportTelURIin SIP profile property. Indicates whether the
PAID
Cisco PGW 2200 Softswitch supports tel URI in PAID header.
When the SupportTelURIinPAID property is set to 0 on the sip
profile, the PAID will not be passed in the IAM as CLI. When
this property is set to 1 on the sip profile, the PAID
information will be passed in the IAM as CLI.
Associated
Components for
Release 9.8
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Valid values:
0—Disable.
1—Enable.
Default value: 0.
This property is added in software Release 9.8(1) S10P10.
*.SuppressCHGN
toCGPNMapping
Suppresses charge number-to-calling party number mapping
in the outgoing SETUP message, when no calling party
number is supplied on the incoming call side. Values are:
•
0—If there is no calling party number in the incoming
IAM message, the charge number (if available) is mapped
into the calling party number in the outgoing SETUP
message.
•
1—If there is no calling party number in the incoming
message, no calling party number is included in the
outgoing SETUP message (that is, the charge
number-to-calling party number mapping is suppressed).
ISDNPRI
ISDNPRI (BRI)
DPNSS
DPNSS
EISUP
EISUP
ISDNPRI
ISDNPRI (BRI)
SS7-ITU
SS7-ITU
SS7-Japan
SS7-Japan
SS7-UK
SS7-UK
Default: 0
*.SuppressCLI
Digits
Suppresses the calling party number. Values are: 0 (do not
suppress but leave the calling number intact) or 1 (remove
calling party number so no number is forwarded).
Default: 0 (do not suppress)
COMMONPROFILE
*.SwitchID
The switch number for the Cisco PGW 2200 Softswitch.
SS7-ANSI
SS7-ANSI
MGCP
DPNSS
Default: 0
*.T309Time
For timer NT309. In pri_10.mdl. Value range: 6000 through
900000, in milliseconds.
ISDNPRI (BRI)
Default: 90000
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-101
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.T310Time
MGCP
For timer 310, which is started when the Call Proceeding
message is received by the Cisco PGW 2200 Softswitch and is
stopped when the Alerting, Progress, Connect, or Disconnect
messages are received. Value range: 3000 through 120000, in
milliseconds.
Associated
Components for
Release 9.8
DPNSS
ISDNPRI (BRI)
Default: 10000
*.T_CCR
Timer for continuity check request.
SS7-ANSI
SS7-ANSI
*.T_CCRR
Timer for continuity check recheck request.
SS7-ANSI
SS7-ANSI
*.T_CGB
Wait timer for circuit group block message.
SS7-ANSI
SS7-ANSI
*.T_CGBA
Wait timer for circuit group block ACK message.
SS7-ANSI
SS7-ANSI
*.T_CRA
Timer for circuit reservation acknowledgment.
SS7-ANSI
SS7-ANSI
*.T_CVT
Timer for circuit validation test. Default: 0 (milliseconds).
SS7-ANSI
SS7-ANSI
*.T_GRS
Wait timer for circuit group reset message.
SS7-ANSI
SS7-ANSI
*.Ta1TimePeriod
Time period, in seconds, before credit expiry that the SCP is
notified. Value range: 1 through 180.
SS7-ITU
SS7-ITU
TRUNKGROUP
Default: 20
*.Ta2TimePeriod
Time period, in seconds, before credit expiry that a warning
tone or announcement is played. Value range: 1 through 180.
COMONPROFILE
SS7-ITU
TRUNKGROUP
Default: 30
*.Ta3TimePeriod
Time period, in seconds, before credit expiry that the
Cisco PGW 2200 Softswitch awaits an SCP response. Value
range: 1 through 180.
COMONPROFILE
SS7-ITU
COMONPROFILE
Limits the maximum number of digits allowed in the outgoing SS7-China
IAM and SAM.
SS7-ITU
Valid Values: 0 through 32. 0 disables the feature.
SS7-UK
Default Value: 0
*.TimeOutCBNU
SS7-ITU
TRUNKGROUP
Default: 3
*.TBufferDigit
Length
SS7-ITU
SS7-China
SS7-ITU
SS7-UK
COMMONPROFILE
Sets the timer out value for Call Back When Not Used against CTI-QBE
the CTI sigpath, in minutes. Value range: 100 through 1500.
CTI-QBE
Default: 100
This property is added in software Release 9.6(1).
*.TimeOutCBWF
Sets the timer out value for Call Back When Free again the
CTI sigpath, in minutes. Value range: 100 through 1500.
CTI-QBE
CTI-QBE
Default: 100
This property is added in software Release 9.6(1).
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-102
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.TlinkAlignTime
Configurable timer for all Q.761, Q.767, and ANSI protocols. SS7-ANSI
Value range: 0 (disables the timer) to n (in milliseconds).
SS7-ITU
Default: 0
SS7-UK
Associated
Components for
Release 9.8
EISUP
SIP
SS7-ANSI
SS7-ITU
SS7-UK
COMMONPROFILE
*.TMaxDigits
DPNSS
Specifies maximum number of digits to receive for overlap
digit processing for call termination to this traffic path. Value EISUP
range: 0 through system maximum.
ISDNPRI
Default: 24
SS7-ANSI
DPNSS
EISUP
ISDNPRI (BRI)
SIP
SS7-China
SS7-ANSI
SS7-ITU
SS7-China
SS7-Japan
SS7-ITU
SS7-UK
SS7-Japan
SS7-UK
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
*.TMinDigits
DPNSS
Specifies minimum number of digits to receive for overlap
digit processing for call termination to this traffic path. Value
EISUP
range: 0 through system maximum.
ISDNPRI
Default: 0
SS7-ANSI
DPNSS
EISUP
ISDNPRI (BRI)
SIP
SS7-China
SS7-ANSI
SS7-ITU
SS7-China
SS7-Japan
SS7-ITU
SS7-UK
SS7-Japan
SS7-UK
TRUNKGROUP
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-103
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.ToneOption
Specifies whether playing a tone to the originating side is
mandatory. This applies only to an ingress IP trunk group.
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
—
EISUPPROFILE
SIPPROFILE
Valid values:
•
0—Playing a tone is optional.
•
1—Playing a tone is mandatory.
COMMONPROFILE
Default: 0
This property is added in software Release 9.8(1).
*.topologyHiding
Enabled
Indicates whether topology hiding is enabled.
—
SIPPROFILE
Valid values:
•
0 = Trust level configuration
•
1 = Disabled
•
2 = Enabled
Default value: 1
Dynamically reconfigurable: Yes
This property is added in software Release 9.8(1).
Set to 1 to enable overlap signaling for call termination to this DPNSS
traffic path. Values are: 0 or 1.
EISUP
Default: 0
ISDNPRI
*.TOverlap
DPNSS
EISUP
ISDNPRI (BRI)
SS7-ANSI
TRUNKGROUP
SS7-China
EISUPPROFILE
SS7-ITU
SIPPROFILE
SS7-Japan
COMMONPROFILE
SS7-UK
*.TransferAwait
Connect
ISDNPRI
Await connection flag, which is used to determine when a
QSIG PBX releases a call. This property is used for
communication with a VoIP gateway connected to a QSIG
PBX, when the implementation of MWI on the PBX deviates
from the ECMA standard. Valid values: 0—(false) QSIG PBX
releases original call after receiving ALERT, or 1—(true)
QSIG PBX releases original call after receiving CONNECT).
ISDNPRI (BRI)
Default: NULL
This property is added in software Release 9.5(2).
*.transReqInclude
Indicates whether or not to include the Transaction request
parameter in an IAM. Values: 0 (for no) or 1 (for yes).
Default: 0
SS7-ANSI
SS7-ANSI
TRUNKGROUP
COMMONPROFILE
GRPROFILE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-104
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
*.TrunkGroupTag
Label
This property identifies name of the trunk group from which a TRUNKGROUP
call comes.
TRUNKGROUP
EISUPPROFILE
Value: String from 1-63 characters
SIPPROFILE
Default: Null
COMMONPROFILE
Dynamically Reconfigurable: Yes
DOMAINPROFILE
This property does not support some special characters
like #, >, and white space. MML does not permit
provisioning these characters to the
TrunkGroupTagLabel.
Note
*.TrunkGrpTag
LabelTransEnable
Associated
Components for
Release 9.8
Indicates how the Cisco PGW 2200 Softswitch handles the
ingress trunk group tag label (if present) in the outgoing SIP
INVITE message. This property is dynamically
reconfigurable.
TRUNKGROUP
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Values:
•
0: The Cisco PGW 2200 Softswitch does not send the
ingress trunk group tag label
•
1: The Cisco PGW 2200 Softswitch sends the ingress
trunk group tag label in the x-route-tag parameter
•
2: The Cisco PGW 2200 Softswitch sends the ingress
trunk group tag label in the tsp parameter
Default: 0
Dynamically Reconfigurable: Yes
*.trustLevel
Indicates if the trunk group or domain is on a trusted or
non-trusted interface.
—
SIPPROFILE
DOMAINPROFILE
Valid values:
•
0 = trusted
•
1 = non-trusted
Default value: 1
Dynamically reconfigurable: Yes
This property is added in software Release 9.8(1).
*.unavailProc
Indicates the procedure to follow when there are no available SS7-ANSI
ISUP circuits. Values are: ALTRTE (alternate routing) or BLO TRUNKGROUP
(blocking).
Default: ALTRTE
SS7-ANSI
COMMONPROFILE
GRPROFILE
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-105
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
*.Unsolicited
NotifyMethod
Determines if the unsolicited Notify method for unsolicited
notification of SIP DTMF digits is enabled or disabled.
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
SIP
SIPPROFILE
TRUNKGROUP
COMMONPROFILE
Valid Values:
•
0 = Unsolicited Notify method disabled
•
1 = Unsolicited Notify method enabled
•
2 = Unsolicited Info method enabled
DOMAINPROFILE
Default: 0
*.useDomain
Profile
Indicate whether domain profiles are enabled for a SIP profile. —
SIPPROFILE
Valid values:
•
0 = Disabled
•
1 = Enabled
Default value: 0
Dynamically reconfigurable: Yes
This property is added in software Release 9.8(1).
UseGtdCalledParty Enables PGW to use embedded calledPartyNumber field of
TRUNKGROUP
Number
GTD in the invite message instead of url/number contained in
the request line. Valid values: 0—disable, 1—enable.
SIPPROFILE
*.variant
SS7-ANSI
SS7 protocol variants supported by local subsystem.
SS7-ANSI
Default: SS7-ANSI
Note
*.VideoAllowed
This property is used only if the profile type is
ISUPTMRPROFILE.
You use this property to specify whether the Cisco PGW 2200 —
Softswitch allows video calls on SIP or EISUP trunk groups.
Valid values: boolean (0 = video calls not allowed, 1 = video
calls allowed).
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Default value: 1.
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
*.VOIPPrefix
A numeric string.
DPNSS
DPNSS
Default: 0
ISDNPRI
ISDNPRI (BRI)
SS7-ANSI
SS7-ANSI
SS7-China
SS7-China
SS7-ITU
SS7-ITU
SS7-Japan
SS7-Japan
SS7-UK
SS7-UK
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-106
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
Property
Definition
*.WaitAnswer
Timer
TRUNKGROUP
Wait for Answer Timer. The timer is started when the
Cisco PGW 2200 Softswitch instructs the MGW to apply ring
back tone upon receiving Alerting. The timer is stopped when the
Cisco PGW 2200 Softswitch receives the Answer message.
Value range: 0 through 300 (in seconds).
TRUNKGROUP
Default: 65
DOMAINPROFILE
TRUNKGROUP
Wait for Originating SDP Timer. On H.323 originated calls,
the Cisco PGW 2200 Softswitch transits the answer message
and starts this timer when the originating SDP information has
not been received. Value range: 0 through 50 (in seconds).
TRUNKGROUP
Default: 10
COMMONPROFILE
*.WaitOrigSDP
Timer
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
EISUPPROFILE
SIPPROFILE
DOMAINPROFILE
*.WaitTermSDP
Timer
Wait for Terminating SDP Timer. On H.323 terminated calls, TRUNKGROUP
the Cisco PGW 2200 Softswitch transits the answer message
and starts this timer when the terminating SDP information
has not been received. Value range: 0 through 50 (in seconds).
TRUNKGROUP
Default: 10
COMMONPROFILE
EISUPPROFILE
SIPPROFILE
DOMAINPROFILE
*.XmitCalling
Name
Allows the Cisco PGW 2200 Softswitch to use the
displayname in the INVITE or INFO header for the calling
party name.
SIP
SIP
TRUNKGROUP
TRUNKGROUP
Valid values:
•
0 = The Cisco PGW 2200 Softswitch does not retrieve the
displayname.
•
1 = The Cisco PGW 2200 Softswitch retrieves the
displayname from the RemotePartyID Header.
Default: 0
*.ZoneID
Specifies the administrative zone that a trunk group belongs —
to. The wildcard, *, is supported as the zone ID. If the property
value is set to * for a trunk group, the zone ID of this trunk
group matches any zone ID set on other trunk groups. This
property can be provisioned in a SIP or EISUP profile, or a
domain profile.
EISUPPROFILE
SIPPROFILE
COMMONPROFILE
DOMAINPROFILE
Valid values: string (1 to 63 characters) or none.
Default value: none.
Dynamically reconfigurable: yes.
This property is added in software Release 9.8(1).
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-107
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
SS7-ANSI.cong
Proc
Indicates the procedure to follow when there is congestion on SS7-ANSI
ISUP circuits. This value is taken from the originating trunk
group and is used in call control when re-attempting occurs.
Values: ALTRTE (alternate routing) or BLK (blocking).
Associated
Components for
Release 9.8
SS7-ANSI
Default: BLK
SS7-ANSI.mtp3
ApcMtpRstrtT28
Overall restart timer for signaling point adjacent to one whose SS7-ANSI
MTP restarts. Value range: 3 to 35 seconds. (Values are in
tenths of a second.)
SS7-ANSI
Default: 30
SS7-ANSI.mtp3
DlnkConnAckT7
Waiting for signaling data link connection acknowledgment. SS7-ANSI
Value range: 1 to 5 seconds. (Values are in tenths of a second.)
Default: 10
SS7-ANSI
SS7-ANSI.mtp3
FrcUnhT13
Waiting for force uninhibited. Value range: 0.8 through 1.5
seconds. (Values are in tenths of a second.)
SS7-ANSI
SS7-ANSI
SS7-ANSI
SS7-ANSI
SS7-ANSI
SS7-ANSI
Maximum number of retries of signaling link test message. If SS7-ANSI
MTP3 does not receive a response after two signaling link test
messages, the system fails the link. Value range: 1 to 5.
SS7-ANSI
Default: 10
SS7-ANSI.mtp3
InhAckT14
Waiting for inhibit acknowledgment. Value range: 2 to 3
seconds (Values are in tenths of a second.)
Default: 20
SS7-ANSI.mtp3
LocInhTstT20
Waiting to repeat local inhibit test. Value range: 90 to 120
seconds (Values are in tenths of a second.)
Default: 900
SS7-ANSI.mtp3
MaxSltTries
Default: 2
SS7-ANSI.mtp3
MsgPriority
SS7-ANSI
SS7-ANSI
SS7-ANSI
SS7-ANSI
Maximum number of queued messages for MTP3. Value 1024. SS7-ANSI
SS7-ANSI
Message priority of management messages for congestion
periods. Value range: 0 to 3.
Priority 1 (default) indicates that there are no congestion
priorities. Priorities greater than 1 indicate multiple
congestion priorities. Priority 3 is the highest priority.
Default: 2
SS7-ANSI.mtp3
MtpRstrtT24
Overall MTP restart timer for local MTP restart. Value range
is network dependent. (Values are in tenths of a second.)
Values: 0 to 2147483647.
Default: 100
SS7-ANSI.mtp3
Queue
Default:1024
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-108
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
SS7-ANSI
SS7-ANSI
SS7-ANSI
SS7-ANSI
Timer started when traffic restart allowed is sent in response SS7-ANSI
to unexpected traffic restart allowed or traffic restart waiting.
Value range: 0 to 65 seconds. (Values are in tenths of a
second.)
SS7-ANSI
Property
Definition
SS7-ANSI.mtp3
RepeatRstrtT26
Traffic restart waiting message at local MTP restart. Value
range: 12 to 15 seconds. (Values are in tenths of a second.)
Default: 150
SS7-ANSI.mtp3
TfrUsed
Transfer restricted procedure is enabled (true) or disabled
(false). Set to true or false.
Default: true
SS7-ANSI.mtp3
TraSntT29
Default: 600
SS7-ANSI.mtp3
tstSltmT1
SS7-ANSI
SS7-ANSI
Interval for sending signaling link test message. Value range: SS7-ANSI
30 to 90 seconds. (Values are in tenths of a second.)
SS7-ANSI
Waiting for signaling link test acknowledgment message.
Value range: 4 to 12 seconds.
Default: 60
SS7-ANSI.mtp3
tstSltmT2
Default: 600
SS7-ANSI.mtp3
UnhAckT12
Waiting for uninhibited acknowledgment. Value range: 0.8
through 1.5 seconds. (Values are in tenths of a second.)
SS7-ANSI
SS7-ANSI
Default: 10
SS7-ANSI.referen
ce
Denotes version of protocol standard supported for MTP.
Values are ANSI88, ANSI92, ANSI96. Default: ANSI92.
SS7-ANSI
SS7-ANSI
SS7-ANSI.standar
d
Denotes version of protocol standard supported for SCCP and SS7-ANSI
TCAP.
SS7-ANSI
Default: ITU92
SS7-ANSI.unavail
Proc
Indicates the procedure to follow when no ISUP circuits are SS7-ANSI
available. This value is taken from the originating trunk group
and is used in call control when re-attempting occurs. Values:
ALTRTE (alternate routing) or BLK (blocking).
SS7-ANSI
Default: BLK
SS7-ANSI.variant
SS7 variant supported by local subsystem. Value range:
SS7-ANSI, SS7-China, SS7-ITU, SS7-Japan, or SS7-UK.
SS7-ANSI
SS7-ANSI
SS7-China
SS7-China
Default: SS7-ANSI
SS7-China.mtp3
ApcMtpRstrtT21
Overall MTP restart timer at an SP adjacent to an SP whose
MTP restarts. Value range: 0 to disable, or 63 to 65 seconds.
(Values are in tenths of a second.)
Default: 0
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-109
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
Property
Definition
SS7-China.mtp3
DlnkConnAckT7
Waiting for signaling data link connection acknowledgment. SS7-China
Value range: 1 to 5 seconds. (Values are in tenths of a second.)
Default: 10
SS7-China
SS7-China.mtp3
FrcUnhT13
Waiting for force uninhibited. Value range: 0.8 through 1.5
seconds. (Values are in tenths of a second.)
SS7-China
SS7-China
SS7-China
SS7-China
Waiting to repeat local inhibit test. Value range: 3 to 6 minutes. SS7-China
(Values are in tenths of a second.)
SS7-China
Default: 10
SS7-China.mtp3
InhAckT14
Waiting for inhibit acknowledgment. Value range: 2 to 3
seconds (Values are in tenths of a second.)
Default: 20
SS7-China.mtp3
LocInhTstT22
Default: 3000
SS7-China.mtp3
MaxSltTries
Maximum number of retries of signaling link test message. If SS7-China
MTP3 does not receive a response after two signaling link test
messages, the system fails the link. Value range: 1 to 5.
SS7-China
Default: 2
SS7-China.mtp3
MsgPriority
SS7-China
SS7-China
Overall MTP restart timer at the signaling point where MTP SS7-China
restarts. Value range: 0 to disable, or 50 to 61 seconds. (Values
are in tenths of a second.)
SS7-China
Message priority of management messages for congestion
periods. Value range: 0 to 3.
Priority 1 (default) indicates without congestion priorities.
Priorities greater than 1 indicate multiple congestion
priorities. Priority 3 is the highest priority.
Default: 2
SS7-China.mtp3
MtpRstrtT20
Default: 0
SS7-China.mtp3
TfrUsed
Transfer restricted procedure is enabled (true) or disabled
(false). Set to true or false.
SS7-China
SS7-China
SS7-China
SS7-China
Interval for sending signaling link test message. Value range: SS7-China
30 to 90 seconds. (Values are in tenths of a second.)
SS7-China
Default: false
SS7-China.mtp3
tstSltmT1
Waiting for signaling link test acknowledgment message.
Value range: 4 to 12 seconds.
Default: 50
SS7-China.mtp3
tstSltmT2
Default: 300
SS7-China.mtp3
UnhAckT12
Waiting for uninhibited acknowledgment. Value range: 0.8
through 1.5 seconds. (Values are in tenths of a second.)
SS7-China
SS7-China
Default: 10
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-110
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Property
Definition
SS7-China.referen
ce
Denotes version of protocol standard supported for MTP.
SS7-China
Values are ANSI88, ANSI92, and ANSI96. Default: ANSI92.
Associated
Components for
Release 9.8
SS7-China
SS7-ITU
SS7-ITU
Waiting for signaling data link connection acknowledgment. SS7-ITU
Value range: 1 to 5 seconds. (Values are in tenths of a second.)
SS7-ITU
SS7-ITU.mtp3Apc Overall MTP restart timer at an SP adjacent to an SP whose
MtpRstrtT21
MTP restarts. Value range: 0 to disable, or 63 to 65 seconds.
(Values are in tenths of a second.)
Default: 640
SS7-ITU.mtp3
DlnkConnAckT7
Default: 10
SS7-ITU.mtp3
FrcUnhT13
Waiting for force uninhibited. Value range: 0.8 through 1.5
seconds. (Values are in tenths of a second.)
SS7-ITU
SS7-ITU
SS7-ITU
SS7-ITU
Waiting to repeat local inhibit test. Value range: 3 to 6 minutes. SS7-ITU
(Values are in tenths of a second.)
SS7-ITU
Default: 10
SS7-ITU.mtp3
InhAckT14
Waiting for inhibit acknowledgment. Value range: 2 to 3
seconds (Values are in tenths of a second.)
Default: 20
SS7-ITU.mtp3
LocInhTstT22
Default: 3000
SS7-ITU.mtp3
MaxSltTries
Maximum number of retries of signaling link test message. If SS7-ITU
MTP3 does not receive a response after two signaling link test
messages, the system fails the link. Value range: 1 to 5.
SS7-ITU
Default: 2
SS7-ITU
SS7-ITU
SS7-ITU.mtp3Mtp Overall MTP restart timer at the signaling point where MTP SS7-ITU
RstrtT20
restarts. Value range: 0 to disable, or 50 to 61 seconds. (Values
are in tenths of a second.)
SS7-ITU
SS7-ITU.mtp3Msg Message priority of management messages for congestion
Priority
periods. Value range: 0 to 3.
Priority 1 (default) indicates without congestion priorities.
Priorities greater than 1 indicate multiple congestion
priorities. Priority 3 is the highest priority.
Default: 2
Default: 600
SS7-ITU.mtp3Tfr
Used
Transfer restricted procedure is enabled (true) or disabled
(false). Set to true or false.
SS7-ITU
SS7-ITU
SS7-ITU
SS7-ITU
Default: false
SS7-ITU.mtp3tstSl Waiting for signaling link test acknowledgment message.
tmT1
Value range: 4 to 12 seconds.
Default: 50
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-111
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Property
Definition
Associated
Components for
Release 9
through 9.7
SS7-ITU.mtp3tstSl Interval for sending signaling link test message. Value range: SS7-ITU
tmT2
30 to 90 seconds. (Values are in tenths of a second.)
Associated
Components for
Release 9.8
SS7-ITU
Default: 300
SS7-ITU.mtp3Unh Waiting for uninhibited acknowledgment. Value range: 0.8
AckT12
through 1.5 seconds. (Values are in tenths of a second.)
SS7-ITU
SS7-ITU
SS7-ITU
SS7-ITU
Denotes version of protocol standard supported for SCCP and SS7-ITU
TCAP.
SS7-ITU
Default: 10
SS7-ITU.reference Denotes version of protocol standard supported for MTP.
Values are ITU88, ITU92, and ITU96. Default: ITU92.
SS7-ITU.standard
Default: ITU92
SS7-Japan.mtp3
ApcMtpRstrtT21
SS7-Japan
SS7-Japan
SS7-Japan
SS7-Japan
Waiting for signaling data link connection acknowledgment. SS7-Japan
Value range: 1 to 5 seconds. (Values are in tenths of a second.)
SS7-Japan
Overall MTP restart timer at an SP adjacent to an SP whose
MTP restarts. Value range: 0 to disable, or 63 to 65 seconds.
(Values are in tenths of a second.)
Default: 0
SS7-Japan.mtp3
ClearTfc
Transfer controlled clear timer. Value range: 0 through
2147483647.
Default: 200
SS7-Japan.mtp3
DlnkConnAckT7
Default: 20
SS7-Japan.mtp3
FrcUnhT13
SS7-Japan
SS7-Japan
SS7-Japan
SS7-Japan
Waiting to repeat local inhibit test. Value range: 3 to 6 minutes. SS7-Japan
(Values are in tenths of a second.)
SS7-Japan
Waiting for force uninhibited. Value range: 0.8 through 1.5
seconds. (Values are in tenths of a second.)
Default: 0
SS7-Japan.mtp3
InhAckT14
Waiting for inhibit acknowledgment. Value range: 2 to 3
seconds (Values are in tenths of a second.)
Default: 0
SS7-Japan.mtp3
LocInhTstT22
Default: 0
SS7-Japan.mtp3
MaxSltTries
Maximum number of retries of signaling link test message. If SS7-Japan
MTP3 does not receive a response after two signaling link test
messages, the system fails the link. Value range: 1 to 5.
SS7-Japan
Default: 0
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-112
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
SS7-Japan
SS7-Japan
Overall MTP restart timer at the signaling point where MTP SS7-Japan
restarts. Value range: 0 to disable, or 50 to 61 seconds. (Values
are in tenths of a second.)
SS7-Japan
Property
Definition
SS7-Japan.mtp3
MsgPriority
Message priority of management messages for congestion
periods. Value range: 0 to 3.
Priority 1 (default) indicates without congestion priorities.
Priorities greater than 1 indicate multiple congestion
priorities. Priority 3 is the highest priority.
Default: 2
SS7-Japan.mtp3
MtpRstrtT20
Default: 0
SS7-Japan.mtp3
T12
SS7-Japan
SS7-Japan
SS7-Japan
SS7-Japan
SS7-Japan
SS7-Japan
Overall MTP restart timer at the signaling point whose MTP SS7-Japan
restarts. Value range: 50 to 61 seconds. (Values are in tenths of
a second.)
SS7-Japan
Waiting for signaling data link connection acknowledgment.
Value range: 500 through 1500 milliseconds. (Values are in
tenths of a second.)
Default: 0
SS7-Japan.mtp3
T13
Waiting for force uninhibited. Value range: 0.8 through 1.5
seconds. (Values are in tenths of a second.)
Default: 0
SS7-Japan.mtp3
T14
Waiting for inhibit acknowledgment. Value range: 2 to 3
seconds. (Values are in tenths of a second.)
Default: 0
SS7-Japan.mtp3
T20
Default: 0
SS7-Japan.mtp3
T21
SS7-Japan
SS7-Japan
Waiting to repeat local inhibit test. Value range: 3 to 6 minutes. SS7-Japan
(Values are in tenths of a second.)
SS7-Japan
Overall MTP restart timer at an SP adjacent to an SP whose
MTP restarts. Value range: 63 to 65 seconds. (Values are in
tenths of a second.)
Default: 0
SS7-Japan.mtp3
T22
Default: 0
SS7-Japan
SS7-Japan
SS7-Japan.mtp3Tc Transfer controlled status cancel timer. Value range: 0 through SS7-Japan
2147483647.
SS7-Japan
SS7-Japan.mtp3T7 Waiting for signaling data link connection acknowledgment.
Value range: 1 through 20 seconds. (Values are in tenths of a
second.)
Default: 20
Default: 200
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-113
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
SS7-Japan
SS7-Japan
MTP3 test signaling link test timer T1. Waiting for signaling SS7-Japan
link test acknowledgment message. Value range: 4 through 12
seconds.
SS7-Japan
Property
Definition
SS7-Japan.mtp3
TfrUsed
Transfer restricted procedure is enabled (true) or disabled
(false). Set to true or false.
Default: false
SS7-Japan.mtp3tst
SltmT1
Default: 0
SS7-Japan.mtp3tst
SltmT2
MTP3 test signaling link test timer T2. Interval for sending
signaling link test message. Value range: 0, 30 through 90
seconds. (Values are in tenths of a second.)
SS7-Japan
SS7-Japan
SS7-Japan
SS7-Japan
SS7-Japan
SS7-Japan
Default: 0
SS7-Japan.mtp3
UnhAckT12
Waiting for uninhibited acknowledgment. Value range:0, 0.8
through 1.5 seconds. (Values are in tenths of a second.)
Default: 0
SS7-Japan.mtp3
TstSrtaT10
Timer for waiting to repeat signaling route set test. Value
range: 0 through 2147483647.
Default: 50
SS7-Japan.
reference
Denotes version of protocol standard supported for MTP.
Values are NTT, NTT92, and TTC. Default: NTT.
SS7-Japan
SS7-Japan
SS7-Japan.sltmT1
Signaling link test timer T1. Waiting for signaling link test
acknowledgment message. Value range: 0 through
2147483647.
SS7-Japan
SS7-Japan
Signaling link test timer T2. Interval for sending signaling link SS7-Japan
test message. Value range: 0 through 2147483647. (Values are
in tenths of a second.)
SS7-Japan
Default: 0
SS7-Japan.sltmT2
Default: 0
SS7-UK
SS7-UK
SS7-UK.mtp3Dlnk Waiting for signaling data link connection acknowledgment. SS7-UK
ConnAckT7
Value range: 1 to 5 seconds. (Values are in tenths of a second.)
SS7-UK
SS7-UK.mtp3Apc
MtpRstrtT21
Overall MTP restart timer at an SP adjacent to an SP whose
MTP restarts. Value range: 0 to disable, or 20, 63 to 65
seconds. (Values are in tenths of a second.)
Default: 20
Default: 10
SS7-UK.mtp3Frc
UnhT13
Waiting for force uninhibited. Value range: 0.8 through 1.5
seconds. (Values are in tenths of a second.)
SS7-UK
SS7-UK
Default: 10
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-114
OL-1116-24
Chapter 1
Properties
Property List
Table 1-1
Property Definitions (continued)
Associated
Components for
Release 9
through 9.7
Associated
Components for
Release 9.8
SS7-UK
SS7-UK
Waiting to repeat local inhibit test. Value range: 3 to 6 minutes. SS7-UK
(Values are in tenths of a second.)
SS7-UK
Property
Definition
SS7-UK.mtp3Inh
AckT14
Waiting for inhibit acknowledgment. Value range: 2 to 3
seconds (Values are in tenths of a second.)
Default: 20
SS7-UK.mtp3Loc
InhTstT22
Default: 3000
SS7-UK.mtp3Max
SltTries
Maximum number of retries of signaling link test message. If SS7-UK
MTP3 does not receive a response after two signaling link test
messages, the system fails the link. Value range: 1 to 5.
SS7-UK
Default: 2
SS7-UK.mtp3Msg
Priority
SS7-UK
SS7-UK
SS7-UK
SS7-UK
SS7-UK
SS7-UK
SS7-UK
SS7-UK
Interval for sending signaling link test message. Value range: SS7-UK
30 to 90 seconds. (Values are in tenths of a second.)
SS7-UK
Message priority of management messages for congestion
periods. Value range: 0 to 3.
Priority 1 indicates without congestion priorities. Priorities
greater than 1 indicate multiple congestion priorities. Priority
3 is the highest priority.
Default: 2
SS7-UK.mtp3Mtp
RstrtT20
Overall MTP restart timer at the signaling point whose MTP
restarts. Value range: 0 to disable, 20, or 50 to 61 seconds.
(Values are in tenths of a second.)
Default: 20
SS7-UK.mtp3Tfr
Used
Transfer restricted procedure is enabled (true) or disabled
(false). Set to true or false.
Default: false
SS7-UK.mtp3tst
SltmT1
Waiting for signaling link test acknowledgment message.
Value range: 4 to 12 seconds.
Default: 50
SS7-UK.mtp3tst
SltmT2
Default: 300
SS7-UK.mtp3Unh
AckT12
Waiting for uninhibited acknowledgment. Value range: 0.8
through 1.5 seconds. (Values are in tenths of a second.)
SS7-UK
SS7-UK
SS7-UK
SS7-UK
Default: 10
SS7-UK.reference
Denotes version of protocol standard supported for MTP.
Values are UK and UK92. Default: UK.
1. NI = network identity
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-115
Chapter 1
Properties
ISUP Timers
ISUP Timers
The following list identifies the ISUP timers that can be provisioned for signaling service. Information
for each timer consists of:
•
Default—Indicates if it is assigned to a profile. Set to 0 for no profile.
•
Components—Identifies the protocol variants supported, the default value, and the range for each
protocol variant.
*.T1
Desc:
T1
Default:
0
Type:
Components:
SigPath Profile = Yes
SS7-ANSI
ANSISS7_STANDARD Default: 4000 Range=4000-15000
SS7-ITU
Q761_BASE Default: 15000 Range=15000-60000
Q767_BASE Default: 4000 Range=4000-15000
Q761_SINGAPORE Default: 15000 Range=15000-60000
Q761_ARGENTINA Default: 10000 Range=10000-60000
ISUPV2_FINNISH96 Default: 15000 Range=15000-60000
ISUPV2_FRENCH Default: 15000 Range=15000-60000
Q761_THAILAND Default: 15000 Range=15000-60000
Q761_PERU Default: 30000 Range=15000-60000
Q761_BELG_C2 Default: 15000 Range=15000-60000
SS7-Japan
ISUPV2_JAPAN Default: 15000 Range=10000-60000
*.T12
Desc:
T12
Default:
0
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
ANSISS7_STANDARD Default: 6000 Range=4000-15000
SS7-ITU
Q761_BASE Default: 15000 Range=15000-60000
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-116
OL-1116-24
Chapter 1
Properties
ISUP Timers
Q767_BASE Default: 15000 Range=4000-15000
Q761_SINGAPORE Default: 60000 Range=60000-60000
Q761_ARGENTINA Default: 10000 Range=10000-60000
ISUPV2_SPANISH Default: 30000 Range=10000-60000
ISUPV2_FINNISH96 Default: 15000 Range=15000-60000
ISUPV2_FRENCH Default: 15000 Range=15000-60000
Q761_THAILAND Default: 15000 Range=15000-60000
Q761_PERU Default: 30000 Range=15000-60000
Q761_BELG_C2 Default: 15000 Range=15000-60000
SS7-Japan
ISUPV2_JAPAN Default: 15000 Range=15000-60000
*.T13
Desc:
T13
Default:
0
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
ANSISS7_STANDARD Default: 60000 Range=60000-60000
SS7-ITU
Q761_BASE Default: 300000 Range=300000-900000
Q767_BASE Default: 60000 Range=60000-60000
Q761_SINGAPORE Default: 300000 Range=300000-900000
Q761_ARGENTINA Default: 60000 Range=60000-900000
ISUPV2_SPANISH Default: 600000 Range=60000-900000
ISUPV2_FINNISH96 Default: 300000 Range=300000-900000
ISUPV2_FRENCH Default: 300000 Range=300000-900000
Q761_THAILAND Default: 60000 Range=60000-900000
Q761_PERU Default: 600000 Range=300000-900000
Q761_BELG_C2 Default: 300000 Range=300000-900000
SS7-Japan
ISUPV2_JAPAN Default: 300000 Range=60000-900000
*.T14
Desc:
T14
Default:
0
Type:
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-117
Chapter 1
Properties
ISUP Timers
Components:
SigPath Profile=Yes
SS7-ANSI
ANSISS7_STANDARD Default: 6000 Range=4000-15000
SS7-ITU
Q761_BASE Default: 15000 Range=15000-60000
Q767_BASE Default: 15000 Range=4000-15000
Q761_SINGAPORE Default: 60000 Range=60000-60000
Q761_ARGENTINA Default: 10000 Range=10000-60000
ISUPV2_SPANISH Default: 30000 Range=10000-60000
ISUPV2_FINNISH96 Default: 15000 Range=15000-60000
ISUPV2_FRENCH Default: 15000 Range=15000-60000
Q761_THAILAND Default: 15000 Range=15000-60000
Q761_PERU Default: 30000 Range=15000-60000
Q761_BELG_C2 Default: 15000 Range=15000-60000
SS7-Japan
ISUPV2_JAPAN Default: 15000 Range=15000-60000
*.T15
Desc:
T15
Default:
0
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
ANSISS7_STANDARD Default: 60000 Range=60000-60000
SS7-ITU
Q761_BASE Default: 300000 Range=300000-900000
Q767_BASE Default: 60000 Range=60000-60000
Q761_SINGAPORE Default: 300000 Range=300000-900000
Q761_ARGENTINA Default: 6000 Range=60000-900000
ISUPV2_SPANISH Default: 600000 Range=60000-900000
ISUPV2_FINNISH96 Default: 300000 Range=300000-900000
ISUPV2_FRENCH Default: 300000 Range=300000-900000
Q761_THAILAND Default: 60000 Range=60000-900000
Q761_PERU Default: 600000 Range=300000-900000
Q761_BELG_C2 Default: 300000 Range=300000-900000
SS7-Japan
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-118
OL-1116-24
Chapter 1
Properties
ISUP Timers
ISUPV2_JAPAN Default: 300000 Range=300000-900000
*.T16
Desc:
T16
Default:
0
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
ANSISS7_STANDARD Default: 5000 Range=4000-15000
SS7-ITU
Q761_BASE Default: 15000 Range=15000-60000
Q767_BASE Default: 5000 Range=4000-15000
Q761_SINGAPORE Default: 60000 Range=60000-60000
Q761_ARGENTINA Default: 10000 Range=10000-60000
ISUPV2_SPANISH Default: 30000 Range=10000-60000
ISUPV2_FINNISH96 Default: 15000 Range=15000-60000
ISUPV2_FRENCH Default: 15000 Range=15000-60000
Q761_THAILAND Default: 15000 Range=15000-60000
Q761_PERU Default: 30000 Range=15000-60000
Q761_BELG_C2 Default: 15000 Range=15000-60000
SS7-Japan
ISUPV2_JAPAN Default: 15000 Range=10000-60000
*.T17
Desc:
T17
Default:
0
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
ANSISS7_STANDARD Default: 60000 Range=60000-60000
SS7-ITU
Q761_BASE Default: 300000 Range=300000-900000
Q767_BASE Default: 60000 Range=60000-60000
Q761_SINGAPORE Default: 300000 Range=300000-900000
Q761_ARGENTINA Default: 60000 Range=60000-900000
ISUPV2_SPANISH Default: 600000 Range=60000-900000
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-119
Chapter 1
Properties
ISUP Timers
ISUPV2_FINNISH96 Default: 300000 Range=300000-900000
ISUPV2_FRENCH Default: 300000 Range=300000-900000
Q761_THAILAND Default: 60000 Range=60000-900000
Q761_PERU Default: 600000 Range=300000-900000
Q761_BELG_C2 Default: 300000 Range=300000-900000
SS7-Japan
ISUPV2_JAPAN Default: 60000 Range=60000-900000
*.T18
Desc:
T18
Default:
0
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
ANSISS7_STANDARD Default: 15000 Range=4000-15000
SS7-ITU
Q761_BASE Default: 15000 Range=15000-60000
Q767_BASE Default: 15000 Range=4000-15000
Q761_SINGAPORE Default: 60000 Range=60000-60000
Q761_ARGENTINA Default: 10000 Range=10000-60000
ISUPV2_SPANISH Default: 30000 Range=10000-60000
ISUPV2_FINNISH96 Default: 15000 Range=15000-60000
ISUPV2_FRENCH Default: 15000 Range=15000-60000
Q761_THAILAND Default: 15000 Range=15000-60000
Q761_PERU Default: 30000 Range=15000-60000
Q761_BELG_C2 Default: 15000 Range=15000-60000
SS7-Japan
ISUPV2_JAPAN Default: 15000 Range=15000-60000
*.T19
Desc:
T19
Default:
0
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
ANSISS7_STANDARD Default: 60000 Range=60000-60000
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-120
OL-1116-24
Chapter 1
Properties
ISUP Timers
SS7-ITU
Q761_BASE Default: 300000 Range=300000-900000
Q767_BASE Default: 60000 Range=60000-60000
Q761_SINGAPORE Default: 300000 Range=300000-900000
Q761_ARGENTINA Default: 60000 Range=60000-900000
ISUPV2_SPANISH Default: 600000 Range=60000-900000
ISUPV2_FINNISH96 Default: 300000 Range=300000-900000
ISUPV2_FRENCH Default: 300000 Range=300000-900000
Q761_THAILAND Default: 60000 Range=60000-900000
Q761_PERU Default: 600000 Range=300000-900000
Q761_BELG_C2 Default: 300000 Range=300000-900000
SS7-Japan
ISUPV2_JAPAN Default: 300000 Range=300000-900000
*.T2
Desc:
T2
Default:
0
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
ANSISS7_STANDARD Default: 180000 Range=180000-180000
SS7-ITU
Q761_BASE Default: 180000 Range=180000-180000
Q767_BASE Default: 180000 Range=180000-180000
Q761_SINGAPORE Default: 180000 Range=180000-180000
Q761_ARGENTINA Default: 180000 Range=180000-180000
ISUPV2_SPANISH Default: 180000 Range=180000-180000
ISUPV2_FINNISH96 Default: 180000 Range=180000-180000
ISUPV2_FRENCH Default: 180000 Range=180000-180000
Q761_THAILAND Default: 180000 Range=180000-180000
Q761_PERU Default: 180000 Range=180000-180000
Q761_BELG_C2 Default: 180000 Range=180000-180000
SS7-Japan
ISUPV2_JAPAN Default: 180000 Range=180000-180000
*.T20
Desc:
T20
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-121
Chapter 1
Properties
ISUP Timers
Default:
0
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
ANSISS7_STANDARD Default: 15000 Range=4000-15000
SS7-ITU
Q761_BASE Default: 15000 Range=15000-60000
Q767_BASE Default: 15000 Range=4000-15000
Q761_SINGAPORE Default: 60000 Range=60000-60000
Q761_ARGENTINA Default: 10000 Range=10000-60000
ISUPV2_SPANISH Default: 30000 Range=10000-60000
ISUPV2_FINNISH96 Default: 15000 Range=15000-60000
ISUPV2_FRENCH Default: 15000 Range=15000-60000
Q761_THAILAND Default: 15000 Range=15000-60000
Q761_PERU Default: 30000 Range=15000-60000
Q761_BELG_C2 Default: 15000 Range=15000-60000
SS7-Japan
ISUPV2_JAPAN Default: 15000 Range=15000-60000
*.T21
Desc:
T21
Default:
0
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
ANSISS7_STANDARD Default: 60000 Range=60000-60000
SS7-ITU
Q761_BASE Default: 300000 Range=300000-900000
Q767_BASE Default: 60000 Range=60000-60000
Q761_SINGAPORE Default: 300000 Range=300000-900000
Q761_ARGENTINA Default: 60000 Range=60000-900000
ISUPV2_SPANISH Default: 600000 Range=60000-900000
ISUPV2_FINNISH96 Default: 300000 Range=300000-900000
ISUPV2_FRENCH Default: 300000 Range=300000-900000
Q761_THAILAND Default: 60000 Range=60000-900000
Q761_PERU Default: 600000 Range=300000-900000
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-122
OL-1116-24
Chapter 1
Properties
ISUP Timers
Q761_BELG_C2 Default: 300000 Range=300000-900000
SS7-Japan
ISUPV2_JAPAN Default: 300000 Range=300000-900000
*.T22
Desc:
T22
Default:
0
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
ANSISS7_STANDARD Default: 15000 Range=4000-15000
SS7-ITU
Q761_BASE Default: 15000 Range=15000-60000
Q767_BASE Default: 15000 Range=4000-15000
Q761_SINGAPORE Default: 60000 Range=60000-60000
Q761_ARGENTINA Default: 10000 Range=10000-60000
ISUPV2_SPANISH Default: 30000 Range=10000-60000
ISUPV2_FINNISH96 Default: 15000 Range=15000-60000
ISUPV2_FRENCH Default: 15000 Range=15000-60000
Q761_THAILAND Default: 15000 Range=15000-60000
Q761_PERU Default: 30000 Range=15000-60000
Q761_BELG_C2 Default: 15000 Range=15000-60000
SS7-Japan
ISUPV2_JAPAN Default: 10000 Range=10000-60000
*.T23
Desc:
T23
Default:
0
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
ANSISS7_STANDARD Default: 60000 Range=60000-60000
SS7-ITU
Q761_BASE Default: 300000 Range=300000-900000
Q767_BASE Default: 60000 Range=60000-60000
Q761_SINGAPORE Default: 300000 Range=300000-900000
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-123
Chapter 1
Properties
ISUP Timers
Q761_ARGENTINA Default: 60000 Range=60000-900000
ISUPV2_SPANISH Default: 600000 Range=60000-900000
ISUPV2_FINNISH96 Default: 300000 Range=300000-900000
ISUPV2_FRENCH Default: 300000 Range=300000-900000
Q761_THAILAND Default: 60000 Range=60000-900000
Q761_PERU Default: 600000 Range=300000-900000
Q761_BELG_C2 Default: 300000 Range=300000-900000
SS7-Japan
ISUPV2_JAPAN Default: 60000 Range=60000-900000
*.T24
Desc:
T24
Default:
0
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
ANSISS7_STANDARD Default: 20000 Range=20000-20000
SS7-ITU
Q761_BASE Default: 2000 Range=0-2000
Q767_BASE Default: 2000 Range=0-2000
Q761_SINGAPORE Default: 2000 Range=2000-2000
Q761_ARGENTINA Default: 2000 Range=2000-2000
ISUPV2_SPANISH Default: 1500 Range=1500-2000
ISUPV2_FINNISH96 Default: 2000 Range=0-2000
ISUPV2_FRENCH Default: 2000 Range=0-2000
Q761_THAILAND Default: 2000 Range=0-2000
Q761_PERU Default: 15000 Range=0-2000
Q761_BELG_C2 Default: 2000 Range=0-2000
SS7-Japan
ISUPV2_JAPAN Default: 2000 Range=0-2000
*.T25
Desc:
T25
Default:
0
Type:
Components:
SigPath Profile=Yes
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-124
OL-1116-24
Chapter 1
Properties
ISUP Timers
SS7-ANSI
ANSISS7_STANDARD Default: 1000 Range=1000-10000
SS7-ITU
Q761_BASE Default: 2000 Range=1000-10000
Q767_BASE Default: 2000 Range=1000-10000
Q761_SINGAPORE Default: 10000 Range=1000-10000
Q761_ARGENTINA Default: 10000 Range=1000-10000
ISUPV2_SPANISH Default: 10000 Range=1000-10000
ISUPV2_FINNISH96 Default: 2000 Range=1000-10000
ISUPV2_FRENCH Default: 2000 Range=1000-10000
Q761_THAILAND Default: 2000 Range=1000-10000
Q761_PERU Default: 10000 Range=1000-10000
Q761_BELG_C2 Default: 2000 Range=1000-10000
SS7-Japan
ISUPV2_JAPAN Default: 2000 Range=1000-10000
*.T26
Desc:
T26
Default:
0
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
ANSISS7_STANDARD Default: 120000 Range=60000-180000
SS7-ITU
Q761_BASE Default: 180000 Range=60000-180000
Q767_BASE Default: 180000 Range=60000-180000
Q761_SINGAPORE Default: 180000 Range=60000-180000
Q761_ARGENTINA Default: 120000 Range=60000-180000
ISUPV2_SPANISH Default: 120000 Range=60000-180000
ISUPV2_FINNISH96 Default: 180000 Range=60000-180000
ISUPV2_FRENCH Default: 180000 Range=60000-180000
Q761_THAILAND Default: 180000 Range=60000-180000
Q761_PERU Default: 120000 Range=60000-180000
Q761_BELG_C2 Default: 180000 Range=60000-180000
SS7-Japan
ISUPV2_JAPAN Default: 180000 Range=60000-180000
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-125
Chapter 1
Properties
ISUP Timers
*.T27
Desc:
T27
Default:
0
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
ANSISS7_STANDARD Default: 240000 Range=180000-240000
SS7-ITU
Q761_BASE Default: 240000 Range=240000-240000
Q767_BASE Default: 240000 Range=240000-240000
Q761_SINGAPORE Default: 240000 Range=240000-240000
Q761_ARGENTINA Default: 240000 Range=240000-240000
ISUPV2_SPANISH Default: 240000 Range=240000-240000
ISUPV2_FINNISH96 Default: 240000 Range=240000-240000
ISUPV2_FRENCH Default: 240000 Range=240000-240000
Q761_THAILAND Default: 240000 Range=240000-240000
Q761_PERU Default: 240000 Range=240000-240000
Q761_BELG_C2 Default: 240000 Range=240000-240000
SS7-Japan
ISUPV2_JAPAN Default: 240000 Range=240000-240000
*.T28
Desc:
T28
Default:
0
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
ANSISS7_STANDARD Default: 10000 Range=10000-10000
SS7-ITU
Q761_BASE Default: 10000 Range=10000-10000
Q761_SINGAPORE Default: 10000 Range=10000-10000
Q761_ARGENTINA Default: 10000 Range=10000-10000
ISUPV2_SPANISH Default: 10000 Range=10000-10000
ISUPV2_FINNISH96 Default: 10000 Range=10000-10000
ISUPV2_FRENCH Default: 10000 Range=10000-10000
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-126
OL-1116-24
Chapter 1
Properties
ISUP Timers
Q761_THAILAND Default: 10000 Range=10000-10000
Q761_PERU Default: 10000 Range=10000-10000
Q761_BELG_C2 Default: 10000 Range=10000-10000
SS7-Japan
ISUPV2_JAPAN Default: 10000 Range=10000-10000
*.T33
Desc:
T33
Default:
0
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
ANSISS7_STANDARD Default: 120000 Range=120000-120000
SS7-ITU
Q761_BASE Default: 15000 Range=12000-15000
Q767_BASE Default: 120000 Range=120000-120000
Q761_SINGAPORE Default: 14000 Range=12000-15000
Q761_ARGENTINA Default: 15000 Range=12000-15000
ISUPV2_SPANISH Default: 15000 Range=12000-15000
ISUPV2_FINNISH96 Default: 15000 Range=12000-15000
ISUPV2_FRENCH Default: 15000 Range=12000-15000
Q761_THAILAND Default: 15000 Range=12000-15000
Q761_PERU Default: 15000 Range=12000-15000
Q761_BELG_C2 Default: 15000 Range=12000-15000
SS7-Japan
ISUPV2_JAPAN Default: 15000 Range=12000-15000
*.T34
Desc:
T34
Default:
0
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
ANSISS7_STANDARD Default: 10000 Range=10000-10000
SS7-ITU
Q761_BASE Default: 2000 Range=2000-4000
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-127
Chapter 1
Properties
ISUP Timers
Q761_SINGAPORE Default: 3800 Range=2000-4000
Q761_ARGENTINA Default: 15000 Range=2000-15000
ISUPV2_SPANISH Default: 2000 Range=2000-15000
ISUPV2_FINNISH96 Default: 2000 Range=2000-4000
ISUPV2_FRENCH Default: 4000 Range=2000-4000
Q761_THAILAND Default: 2000 Range=2000-4000
Q761_PERU Default: 2000 Range=2000-4000
Q761_BELG_C2 Default: 2000 Range=2000-4000
SS7-Japan
ISUPV2_JAPAN Default: 2000 Range=2000-4000
*.T35
Desc:
T35
Default:
0
Type:
Components:
SigPath Profile=Yes
SS7-ITU
Q761_BASE Default: 15000 Range=15000-20000
Q767_BASE Default: 15000 Range=15000-20000
Q761_SINGAPORE Default: 15000 Range=15000-20000
Q761_ARGENTINA Default: 15000 Range=15000-20000
ISUPV2_SPANISH Default: 15000 Range=15000-20000
ISUPV2_FINNISH96 Default: 15000 Range=15000-20000
ISUPV2_FRENCH Default: 15000 Range=15000-20000
Q761_THAILAND Default: 15000 Range=15000-20000
Q761_PERU Default: 15000 Range=15000-20000
Q761_BELG_C2 Default: 15000 Range=15000-20000
SS7-Japan
ISUPV2_JAPAN Default: 15000 Range=15000-20000
*.T36
Desc:
T36
Default:
0
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-128
OL-1116-24
Chapter 1
Properties
ISUP Timers
ANSISS7_STANDARD Default: 10000 Range=10000-10000
SS7-ITU
Q761_BASE Default: 10000 Range=10000-15000
Q767_BASE Default: 10000 Range=10000-15000
Q761_SINGAPORE Default: 10000 Range=1000-15000
Q761_ARGENTINA Default: 10000 Range=1000-15000
ISUPV2_SPANISH Default: 15000 Range=1000-15000
ISUPV2_FINNISH96 Default: 10000 Range=10000-15000
ISUPV2_FRENCH Default: 10000 Range=10000-15000
Q761_THAILAND Default: 10000 Range=10000-15000
Q761_PERU Default: 15000 Range=10000-15000
Q761_BELG_C2 Default: 10000 Range=10000-15000
SS7-Japan
ISUPV2_JAPAN Default: 10000 Range=10000-15000
*.T38
Desc:
T38
Default:
0
Type:
Components:
SigPath Profile=Yes
SS7-ITU
Q761_BASE Default: 125000 Range=125000-125000
Q761_SINGAPORE Default: 125000 Range=125000-125000
Q761_ARGENTINA Default: 125000 Range=125000-125000
ISUPV2_SPANISH Default: 125000 Range=125000-125000
ISUPV2_FINNISH96 Default: 125000 Range=125000-125000
ISUPV2_FRENCH Default: 125000 Range=125000-125000
Q761_THAILAND Default: 125000 Range=125000-125000
Q761_BELG_C2 Default: 125000 Range=125000-125000
SS7-Japan
ISUPV2_JAPAN Default: 125000 Range=125000-125000
*.T5
Desc:
T5
Default:
0
Type:
Components:
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-129
Chapter 1
Properties
ISUP Timers
SigPath Profile=Yes
SS7-ANSI
ANSISS7_STANDARD Default: 60000 Range=60000-60000
SS7-ITU
Q761_BASE Default: 300000 Range=300000-900000
Q767_BASE Default: 60000 Range=60000-60000
Q761_SINGAPORE Default: 300000 Range=300000-900000
Q761_ARGENTINA Default: 60000 Range=60000-900000
ISUPV2_SPANISH Default: 600000 Range=60000-900000
ISUPV2_FINNISH96 Default: 300000 Range=300000-900000
ISUPV2_FRENCH Default: 300000 Range=300000-900000
Q761_THAILAND Default: 60000 Range=60000-900000
Q761_PERU Default: 600000 Range=300000-900000
Q761_BELG_C2 Default: 300000 Range=300000-900000
SS7-Japan
ISUPV2_JAPAN Default: 60000 Range=60000-900000
*.T6
Desc:
T6
Default:
0
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
ANSISS7_STANDARD Default: 32000 Range=10000-32000
SS7-ITU
Q761_BASE Default: 120000 Range=60000-120000
Q767_BASE Default: 120000 Range=60000-120000
Q761_SINGAPORE Default: 20000 Range=20000-130000
Q761_ARGENTINA Default: 60000 Range=10000-60000
ISUPV2_SPANISH Default: 60000 Range=10000-60000
ISUPV2_FINNISH96 Default: 120000 Range=60000-120000
ISUPV2_FRENCH Default: 60000 Range=60000-120000
Q761_THAILAND Default: 90000 Range=60000-120000
Q761_PERU Default: 15000 Range=15000-120000
Q761_BELG_C2 Default: 120000 Range=60000-120000
SS7-Japan
ISUPV2_JAPAN Default: 3000 Range=2000-4000
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-130
OL-1116-24
Chapter 1
Properties
ISUP Timers
*.T7
Desc:
T7
Default:
0
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
ANSISS7_STANDARD Default: 30000 Range=20000-30000
SS7-ITU
Q761_BASE Default: 30000 Range=20000-30000
Q767_BASE Default: 30000 Range=20000-30000
Q761_SINGAPORE Default: 20000 Range=20000-30000
Q761_ARGENTINA Default: 20000 Range=20000-30000
ISUPV2_SPANISH Default: 20000 Range=20000-30000
ISUPV2_FINNISH96 Default: 30000 Range=20000-30000
ISUPV2_FRENCH Default: 30000 Range=20000-30000
Q761_THAILAND Default: 30000 Range=20000-30000
Q761_PERU Default: 20000 Range=20000-30000
Q761_BELG_C2 Default: 40000 Range=20000-50000
SS7-Japan
ISUPV2_JAPAN Default: 30000 Range=20000-30000
*.T8
Desc:
T8
Default:
0
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
ANSISS7_STANDARD Default: 10000 Range=10000-15000
SS7-ITU
Q761_BASE Default: 10000 Range=10000-15000
Q767_BASE Default: 10000 Range=10000-15000
Q761_SINGAPORE Default: 10000 Range=10000-15000
Q761_ARGENTINA Default: 15000 Range=10000-15000
ISUPV2_SPANISH Default: 15000 Range=10000-15000
ISUPV2_FINNISH96 Default: 10000 Range=10000-15000
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-131
Chapter 1
Properties
ISUP Timers
ISUPV2_FRENCH Default: 10000 Range=10000-15000
Q761_THAILAND Default: 10000 Range=10000-15000
Q761_PERU Default: 15000 Range=10000-15000
Q761_BELG_C2 Default: 10000 Range=10000-15000
SS7-Japan
ISUPV2_JAPAN Default: 10000 Range=10000-15000
*.T9
Desc:
T9
Default:
0
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
ANSISS7_STANDARD Default: 120000 Range=120000-240000
SS7-ITU
Q761_BASE Default: 120000 Range=60000-120000
Q767_BASE Default: 120000 Range=60000-120000
Q761_SINGAPORE Default: 90000 Range=60000-240000
Q761_ARGENTINA Default: 120000 Range=60000-240000
ISUPV2_SPANISH Default: 60000 Range=60000-240000
ISUPV2_FINNISH96 Default: 180000 Range=120000-240000
ISUPV2_FRENCH Default: 120000 Range=60000-120000
Q761_THAILAND Default: 120000 Range=60000-120000
Q761_PERU Default: 60000 Range=60000-120000
Q761_BELG_C2 Default: 120000 Range=60000-120000
SS7-Japan
ISUPV2_JAPAN Default: 120000 Range=60000-120000
T_CCR
Desc:
T_CCR
Default:
2000
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-132
OL-1116-24
Chapter 1
Properties
ISUP Timers
T_CCRR
Desc:
T_CCRR
Default:
20000
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
T_CGB
Desc:
T_CGB
Default:
5000
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
T_CGBA
Desc:
T_CGBA
Default:
5000
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
T_CRA
Desc:
T_CRA
Default: 20000
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
T_CVT
Desc:
T_CVT
Default:
10000
Type:
Components:
SigPath Profile=Yes
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
OL-1116-24
1-133
Chapter 1
Properties
Protocol Variants
SS7-ANSI
T_GRS
Desc:
T_GRS
Default:
5000
Type:
Components:
SigPath Profile=Yes
SS7-ANSI
Protocol Variants
For a list of supported protocol variants, see the Release Notes document for the software release you
are using. Alternatively, you can generate the list by entering the prov-rtrv:variant command.
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
1-134
OL-1116-24