This chapter describes the Cisco PGW 2200 Softswitch Release 9 Machine-Man Language (MML) commands, presenting each of them in alphabetical order.
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 the Cisco PGW 2200 SoftswitchRelease 9 Provisioning Guide.See the "RTRV-CTR—Retrieve Measurement Counter" sectionto 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.
Note The terms for alarm category and severity are case sensitive, and they must be in quotation marks.
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:
•sig path—MML component name of a signal path created with the prov-add:sigpath command.
•range—A number such that number + range is a valid CIC. All circuits between number and number + range are blocked.
Example:
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).
•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 - MGC-01 2000-01-12 15:19:51
M COMPLD
;
Comments:
Performance Impact Category: A
Components are described in the Cisco PGW 2200 Softswitch Release 9 Provisioning Guide. For a description of measurement categories, see the 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 want to 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"
;
DIAGLOG—Diagnostics Log
Purpose:
Starts and stops event logging into a diagnostics log.
Syntax:
diaglog:<file name>:START | STOP
Input Description:
•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.
Example:
The MML command shown in the following example starts logging into the diagnostics log named test:
mml> DIAGLOG:test:start
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M COMPLD
;
Comments:
See the Cisco PGW 2200 Softswitch Release 9 Messages Reference Guide for more information about log files.
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:
•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.
Example:
The MML command shown in the following example displays the last successful command entered:
mml> H
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M RTRV
"RTRV-TC:ALL"
/* command 1 */
;
Example:
The MML command shown in the following example displays the third previous successful command entered:
mml> H::3
Media Gateway Controller - MGC-01 2000-01-12 15:19:51
M RTRV
"RTRV-TC:ALL"
/* command 3 */
;
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 - MGC-01 2000-01-12 15:19:51
M RTRV
"RTRV-IPLNK:ALL"
/* command 5 */
"RTRV-SOFTW:ALL"
/* command 4 */
"RTRV-TC:ALL"
/* command 3 */
"STP-AUD"
/* command 2 */
;
Comments:
Performance Impact Category: A
HELP—Open
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>]
Input Description:
•command name—Name of the particular command for which you would like to display a description.
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.
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
sta-aud-gw:<sig path MGCP> Starts auditing process of a gateway
sta-aud-gw:all 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
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 HELPcommand, with no parameters, on those systems.
Kill Call—Forcefully Release a Hung CIC
Purpose:
Resolves a stuck or hung CIC 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 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).
•dest_mgw—MML name of the media gateway destination associated with the stuck span and bearer channel.
•cic—Number of the affected CIC.
•span—Number of the affected span.
•bc—Number of the affected bearer channel.
•sigpath_name—Name of the affected signaling path.
•confirm—Verify execution of the command.
See the Cisco PGW 2200 Softswitch Release 9 Operations, Maintenance, and Troubleshooting Guide for a description how this command is used to release a hung or stuck CIC.
Example:
The MML command shown in the following example releases a stuck CIC on sigpath1:
mml> kill-call:sigpath1:cic=215,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 the Cisco PGW 2200 SoftswitchRelease 9 Operations, Maintenance, and Troubleshooting Guide for information about resolving a stuck or hung CIC.
KILL-CALL—Terminate a Call (Release 9.3(2))
Purpose:
Resolves a stuck or hung CIC associated with a single call instance or a range of calls.
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 the 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:
Performance Impact Category: B, C; impact depends on the size of the dial plan.
NUMAN-ADD:bdigtree—Provision the BdigTree
See the "Provisioning the BdigTree" section in the Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide for more details.
NUMAN-ADD:Cause—Provision Cause Table (Release 9.7(3))
Purpose:
Adds one entry to the cause table.
Syntax:
numan-add:cause:custgrpid="customer group ID",causevalue="x",
locationblock=x
numan-add:cause:custgrpid="customer group ID",causevalue="x",
setname="ResultSet Name"
Input Description:
•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 0 value 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.
NUMAN-ADD:cpc—Provision Calling Party Category (Release 9.3(2)
Purpose:
Provisions the calling party category (CPC).
Syntax:
numan-add:cpc:custgrpid="customer group id",cpcvalue=number,setname="result
set name"
Input Description:
•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.
See the 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 provisions the CPC:
•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.
Example:
The following sample MML command adds the customized message, "Emergency Call":
Adds an entry to the destination username/domain translation table. For more information about the destination username/domain translation table, see the Domain-Based Routing Feature Module, Destination Username/Domain Translation (DESTTRANS) Table.
•custgrpid—Customer group ID. A 4-digit alphanumeric string (enclosed in straight quotes) to identify the dial plan.
•destdmnstring—The destination username (bob@cisco.com) or domain name (cisco.com).
•svcname—The MML name of a service.
•displayname—The display name for the user, such as BobOffice.
Note RFC 3261 provides for 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 "TerryOffice" (including quotation marks) is "%22TerryOffice%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.
Output Description:
•COMPLD—Provision succeeds
•DENY—Provision fails
Examples:
The MML command shown in the following example retrieves one entry in the destination username/domain translation table:
MGC-01 - Media Gateway Controller 2008-08-01 16:40:09.168 EDT
M COMPLD
"Desttrans"
;
Comments:
Performance impact category: A
NUMAN-ADD:DMNMODSTRING (Release 9.8(1))
Purpose:
Adds an entry to the domain strings table. For more information about the DRP, see Domain-Based Routing Feature Module, Domain Strings (DMNMODSTRING) Table.
MGC-01 - Media Gateway Controller 2008-08-04 10:22:29.141 EDT
M COMPLD
"dmnmodstring"
;
Comments:
Performance impact category: A
NUMAN-ADD:DRPTABLE (Release 9.8(1))
Purpose:
Adds an entry to the domain routing policy (DRP) table. For more information about the DRP, see Domain-Based Routing Feature Module, Domain Routing Policy (DRPTABLE) Table.
•svcname—A unique service name string for full number translation entries. Maximum length of string: 10 characters.
•numtype—Identifier for the number type (1-4), 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
Maximum length of integers: 1 digit
•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 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.
Example:
The MML command shown in the following example enables full number translation for result types:
Adds an entry to the PORTTBL list of your dial plan.
Syntax:
mml> numan-add:porttbl:digitstring="<digitstring>",routenum="<route num
ber>",minlength=<minimum length>,maxlength=<maximum length>
Input Description:
•digitstring—Called number.
•routenum—Routing number.
•minlength—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—Specifies the maximum length for call origination from this traffic path. Value range is 0-20. Default is 0.
Example:
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.
•The digitstring is the B-Number digits (can be post normalization or modification).
•The routenum (optional) is the Routing number prefix for ported numbers.
•The minlength and maxlength values (optional) being 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 the 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.
NUMAN-ADD:resulttable—Adding a Gateway Pool Result Type Entry (Release 9.8(1))
Purpose:
Adds a new result, (Gateway Pool) to the result table in the dial plan to override the IP-IP gateway on A number or B number analysis.
Syntax:
numan-add:resulttable:custgrpid="customer group ID",name="result name",
resulttype="GATEWAYPOOL",dw1="value",dw2="value", dw3="value",
dw4="value", setname="ResultSet Name"
Input Description:
•custgrpid—The customer group ID, which is a previously defined 4-digit alphanumeric string.
•name—The result table index name.
•resulttype—The result type, which is GATEWAYPOOL in A Number Analysis or in B Number Analysis for Media Anchor Bypass.
•dw1—dw1 and dw2 decide if the IP-IP gateway is on the incoming and dw3 and dw4 decide if the IP-IP gateway is on the outgoing.
•setname—The result set name.
Examples:
The example MML commands below show the provisioning used to add the Gateway Pool in A Number Analysis.
NUMAN-ADD:resulttable—Adding an A_NUM_DP_TABLE or DB_XLATED Result Type Entry (Release 9.7(3))
Purpose:
Adds a new result, (A_NUM_DP_TABLE or DB_XLATED) to the result table in the dial plan
Syntax:
numan-add:resulttable:custgrpid="customer group ID",name="result name",
resulttype="FACILITY type",dw1="value",setname="ResultSet Name"
Input Description:
•custgrpid—The customer group ID, which is a previously defined 4-digit alphanumeric string.
•name—The result table index name.
•resulttype—The result type, which is A_NUM_DP_TABLE or DB_XLATED for the Enhanced Local Number Portability and Dial Plan Selection feature.
•dw1—The value indicating how far to search back in the number when longest matching. Integer. The value 0 for dw1 for A_NUM_DP_TABLE result table means that you want to keep the existing functionality with exact matching, while the value 0 for dw1 for DB_XLATED is not allowed.
•setname—The result set name.
Examples:
The example MML command below shows the provisioning used to add the A_NUM_DP_TABLE result in to the dial plan result table.
•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 example MML command below shows the provisioning used to add the new DB_XLATED result to the result table in the dial plan.
•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).
Comments:
Performance Impact Category: A
NUMAN-ADD:resulttable—Adding a Cause Result Type Entry (Release 9.7(3))
Purpose:
Provisions the CAUSE result type to map the received cause and location value into the user's preferred cause and location value.
Syntax:
numan-add:resulttable:custgrpid="customer group ID",name="result name",
Resulttype=CAUSE,dw1="Cause value",dw2="Location value",
setname="ResultSet Name"
Input Description:
custgrpid—The customer group ID, which is a previously defined 4-digit alphanumeric string.
name—The result table index name.
resulttype—The result type, which is CAUSE for this feature module.
dw1—The cause value. Integers 1-173.
dw2—The location value. Integers 1-15. Default is 0.
–0—When no location is entered, the default value is used. The default value is different for the SS7 protocol variants. For example, for SS7-ANSI, the default value is LOCATION_TRANSIT, and for Q.761, the default value is LOCATION_INTERWORKING.
–1-15—This value overrides the received location value.
•custgrpId—Indicates the customer group ID. This is a 4-digit alphanumeric string.
•resulttype—Indicates the result type being provisioned. This is a string.
•dw1 (dataword1)—Provides an index into the Script table in the Cisco PGW 2200 Softswitch database, where the details of the Script table, such as gateway type, language, location, and so on are stored. This is an integer.
Note When adding an index in the Script table, be sure the value you enter is a valid value in the Script table.
•dw2 (dataword2)—Indicates the CallType associated with this result type. A value of 1 hands over call control to the gateway, with script invocation. Currently, only this call type is supported. This is an integer.
•dw3 (dataword3)—Indicates if an optional Address Complete Message (ACM) is to be sent when the confirmation of script invocation is received (for dw2, CallType = 1) from the gateway. This is an integer.
•dw4 (dataword4) is not used.
•setname—Indicates the MML result set name for this SCRIPT result type. The set name is user configured and can be as many as 20 alphanumeric characters.
Media Gateway Controller - MGC-01 2003-01-12 15:19:51
M COMPLD
;
NUMAN-ADD:resulttable (Release 9.3(2))
Purpose:
Provisions Polish ISUP version 2.
Syntax:
numan-add:resulttable:custgrpid="customer group ID",name="result
name",resulttype="CHARGE"[,dw1="charge unit"][,dw2="charge
unit"],dw3="charge unit=4"[,dw4="charge unit"],setname="result set name"
Input Description:
•custgrpid—The customer identifier (customer group ID) which is a four-character alphanumeric field.
•name—Result index table name.
•resulttype—CHARGE.
•dw1—Charge unit number; an integer in the range 0 through 255.
•dw2—Charge unit number; an integer in the range 0 through 255.
•dw3—4, indicating charge data discriminator Charge Unit.
•dw4—Charge unit number; an integer in the range 0 through 255.
•setname—Result set name.
See the Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide for a description of how to use the NUMAN-ADD command for dial plan provisioning and for information about components, parameter names, parameter descriptions, and parameter values.
Example:
The MML command shown in the following example provisions Polish ISUP version 2:
The existing AOCEnabled property must be set to 1.
NUMAN-ADD:resulttable—Provision Result Table (Release 9.2(1))
Purpose:
Provisions the IN_trigger to support INAP prepaid services on the Cisco PGW 2200 Softswitch.
Syntax:
numan-add:resulttable:custgrpid="Customer group ID",name="result
name",resulttype="result type",dw1="service type",dw2="
Index",setname="Result set name"
Input Description:
•Custgrpid—The customer identifier (customer group ID). It is a four-character alphanumeric field and is not validated by MML.
•Name—Result index table name.
•Resulttype—Result type.
–IN_TRIGGER
–RETRY_ACTION
–MGCPDIALPKG
•DW1—Service type. The value for the new IN trigger is 18.
–Reattempt—Select circuit again on the current trunk group.
–TGAdvance—Advance to the next available trunk group and attempt circuit selection there.
–Redirect—Request a new number analysis using the new B number returned from analysis.
–Digital—B number analysis indicates that the call type is digital.
–Analog—B number analysis indicates that the call type is analog.
–Dynamic—NAS is advised that the call is analog unless analysis indicates 64k unrestricted data service for the call.
•DW2— Specifies whether or not need ACM.
0—No need ACM
1—need ACM
•Setname—Result set name.
See the Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide for a description of how to use the NUMAN-ADD command for dial plan provisioning and for information about components, parameter names, parameter descriptions, and parameter values.
Example:
The MML command shown in the following example provisions the INAP prepaid services IN_Trigger:
Adds an entry to the route selection table. For more information about the route selection table, see Domain-Based Routing Feature Module, Route Selection (ROUTESEL) Table.
Adds a conditional route to the route holiday table.
Syntax:
numan-add:rteholiday:custgrpid="Customer group
ID",date="yyyy.mm.dd",hday="holiday string"
Input Description:
•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
See the Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide for a description of how to use the NUMAN-ADD command for dial plan provisioning and for information about components, parameter names, parameter descriptions, and parameter values.
Example:
The MML command shown in the following example is used to add a holiday entry:
•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:
•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.
Media Gateway Controller - MGC-01 2003-01-12 15:19:51
M COMPLD
;
NUMAN-ADD:SOURCEBLACK (Release 9.8(1))
Purpose:
Adds an entry to the source domain blacklist table. For more information about the source blacklist table, see Domain-Based Routing Feature Module, Source Blacklist Screening (SOURCEBLACK) Table.
•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''
;
Comments:
Performance impact category: A
NUMAN-ADD:tmr—Provision Transmission Medium Requirements (Release 9.3(2))
Purpose:
Provisions transmission medium requirements (TMR):
Syntax:
numan-add:tmr:tmrvalue=TMR value,custgrpid="customer group id",
setname="result set name"
Input Description:
•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.
See the Cisco PGW 2200 SoftswitchDial Plan Guide for a description of how to use the NUMAN-ADD command for dial plan provisioning and for information about components, parameter names, parameter descriptions, and parameter values.
Example:
The MML command shown in the following example provisions the TMR table:
numan-add:tns:tnsvalue="TNS value",custgrpid="customer group id",
setname="result set name"
Input Description:
•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.
See the Cisco PGW 2200 SoftswitchRelease 9 Dial Plan Guide for a description of how to use the NUMAN-ADD command for dial plan provisioning and for information about components, parameter names, parameter descriptions, and parameter values.
Example:
The MML command shown in the following example provisions the TNS table:
•<comp>—The component being added to the dial plan.
•custgrpid—Customer Group ID.
See the Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for information about components, parameter names, parameter descriptions, and parameter values.
Example:
The MML command shown in the following example deletes an element from a dial plan table:
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 0 value 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
Example:
numan-dlt:cause:custgrpid="Natl",causevalue=0
numan-dlt:cause:custgrpid="Natl",causevalue=3
Comments:
Performance Impact Category: A
NUMAN-DLT:cliipaddress—Delete Calling Line Identity IP Address (Release 9.4(1))
Purpose:
Deletes a Calling Line Identity (CLI) IP address entry.
NUMAN-DLT:cpc—Delete Calling Party Category (Release 9.3(2))
Purpose:
Deletes elements in the calling party category (CPC).
Syntax:
numan-dlt:cpc:custgrpid="customer group id",cpcvalue="number"
Input Description:
•custgrpid—The previously defined customer identifier (customer group ID). It is a four-character alphanumeric field and is not validated by MML.
•cpcvalue—Enter a previously defined value in the range 0 to 255. There is no default value.
See theCisco PGW 2200 Softswitch Release 9 Dial Plan Guide for a description of how to use the NUMAN-DLT command for dial plan provisioning and for information about components, parameter names, parameter descriptions, and parameter values.
Example:
The MML command shown in the following example deletes the CPC value for customer group T001:
mml> NUMAN-DLT:cpc:custgrpid="T001",cpcvalue="3"
NUMAN-DLT:CRPTMESG—Deletes a Call Reporting Message (Release 9.7(3))
Purpose:
Enables you to delete a call reporting message.
Syntax:
numan-dlt:crptmesg:index=1,msgstr="Fire Alarm"
Input Description:
•CRPTMESG—The call reporting message represented as a character string.
Example:
The following sample MML command deletes a customized message:
numan-dlt:rteholiday:custgrpid="<cust group ID>"date="yyyy.mm.dd"
Input Description:
•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.
.See the Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for information about components, parameter names, parameter descriptions, and parameter values.
Example:
The MML command shown in the following example deletes an entry from the route holiday table:
•tmrvalue—Enter a previously defined number in the range 0 to 255. There is no default for this entry.
•custgrpid—The previously defined customer identifier (customer group ID). It is a four-character alphanumeric field and is not validated by MML.
See the Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide for a description of how to use the NUMAN-DLT command for dial plan provisioning and for information about components, parameter names, parameter descriptions, and parameter values.
Example:
The MML command shown in the following example deletes the customer group ID:
mml> NUMAN-DLT:tmr:tmrvalue=2,custgrpid="T002"
NUMAN-DLT:tns—Deletes Transit Network Selection Elements (Release 9.3(2))
Purpose:
Deletes elements in the transit network selection (TNS).
•tnsvalue—Enter a previously defined number in the range 000 to FFFFFFFF. There is no default for this entry.
•custgrpid—The previously defined customer identifier (customer group ID). It is a four-character alphanumeric field and is not validated by MML.
See the Cisco PGW 2200 Softswitche Release 9 Dial Plan Guide for a description of how to use the NUMAN-DLT command for dial plan provisioning and for information about components, parameter names, parameter descriptions, and parameter values.
Example:
The MML command shown in the following example deletes the customer group ID:
mml> NUMAN-DLT:tns:tnsvalue="7",custgrpid="T002"
NUMAN-ED—Edit Dial Plan Element
Purpose:
Edits an element in a dial plan table.
Syntax:
numan-ed:<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 the Cisco PGW 2200 SoftswitchSoftware Release 9 Dial Plan Guide for a description of using the NUMAN commands for dial plan provisioning as well as for information about components, parameter names, parameter descriptions, and parameter values.
Example:
The MML command shown in the following example edits a dial modification table:
•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 0 value is added to enable using a wildcard for the cause value. A cause value of 0 is the default cause value.
NUMAN-ED:cpc—Edit Calling Party Category (Release 9.3(2))
Purpose:
Edits elements in the calling party category (CPC).
Syntax:
numan-ed:cpc:custgrpid="customer group id",cpcvalue=number,
setname="result set name"
Input Description:
•custgrpid—The customer identifier (customer group ID). It is a four-character alphanumeric field and is not validated by MML.
•cpcvalue—Enter a previously defined value in the range 0 to 255. There is no default value.
•setname—Name of the result set which was previously defined.
See the Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide for a description of how to use the NUMAN-ED command for dial plan provisioning and for information about components, parameter names, parameter descriptions, and parameter values.
Example:
The MML command shown in the following example edits the CPC value:
numan-ed:rteholiday:custgrpid="<cust group
ID>",date="yyyy.mm.dd",hday="holN"
Input Description:
•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
See the Cisco PGW 2200 SoftswitchRelease 9 Dial Plan Guide for a description of using the NUMAN commands for dial plan provisioning as well as for information about components, parameter names, parameter descriptions, and parameter values.
Example:
The MML command shown in the following example edits an entry in the route holiday table:
NUMAN-ED:tmr—Edit Transmission Medium Requirements (Release 9.3(2))
Purpose:
Edits elements in the transmission medium requirements (TMR).
Syntax:
numan-ed:tmr:tmrvalue="TMR value",custgrpid="customer group id",
setname="result set name"
Input Description:
•tmrvalue—Enter a previously defined number in the range 0 to 255. There is no default for this entry.
•custgrpid—The previously defined customer identifier (customer group ID). It is a four-character alphanumeric field and is not validated by MML.
•setname—Name of the previously defined result set.
See the Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide for a description of how to use the NUMAN-ED command for dial plan provisioning and for information about components, parameter names, parameter descriptions, and parameter values.
Example:
The MML command shown in the following example edits the TMR value:
Edits elements in the transit network selection (TNS).
Syntax:
numan-ed:tns:tnsvalue="TNS value",custgrpid="customer group id",
setname="result set name"
Input Description:
•tnsvalue—Enter a previously defined number in the range 000 to FFFFFFFF. There is no default for this entry.
•custgrpid—The previously defined customer identifier (customer group ID). It is a four-character alphanumeric field and is not validated by MML.
•setname—Name of the previously defined result set.
See the Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide for a description of how to use the NUMAN-ED command for dial plan provisioning and for information about components, parameter names, parameter descriptions, and parameter values.
Example:
The MML command shown in the following example edits the TNS value:
Retrieves an element or all elements from a dial plan table.
Syntax:
numan-rtrv:dialplan:"all"
numan-rtrv:<comp>:custgrpid="<cust group ID>"
numan-rtrv:<comp>:custgrpid="<cust group ID>","all"
Input Description:
•<comp>—The component being added to the dial plan.
•custgrpid—Customer group ID.
See the Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide for information about components, parameter names, parameter descriptions, and parameter values.
Output Description:
•DIALPLANcustgrpid—Customer group IDs for the dial plan
•ADIGTREE digitString—Digit string being displayed
•ADIGTREE callSide—Call side: originating or terminating
•ADIGTREE PointInDigitString—A portion of the digit string that has a result set
•ADIGTREE ResultSetName—Result set name
•ADIGTREE ResultName—Result name in the set
•ADIGTREE ResultType—Result type for the result name
•ADIGTREE dw(n)—Data word (one through four) for the result
•ADIGTREE nextResult—Next result name in the result set
•RESULTTABLE setName—Result set name
•RESULTTABLE resultName—Result name in the set
•RESULTTABLE resultType—Result type for the result name
•RESULTTABLE dw(n)—Data word (one through four) for the result
•RESULTTABLE nextResult—Next result name in the result set
•DIGMODSTRING digName—Name of the digit modification string
•DIGMODSTRING digString—String of digits to modify
•NOA Index—Nature of address indicator
•NOA NPIBlock—Value of a configurable numbering plan indicator
•NOAresultName—MML name of the result set
•NPI Index—Index for the numbering plan index
•NPI blockVal—NPI Block value
•NPI resultName—NPI result set name
•CAUSE Index—Cause value
•CAUSE locationBlock—Location block value
•CAUSE resultName—MML name of the result set
•LOCATION Index—Location block value
•LOCATION blockVal—Block value
•LOCATION resultName—MML name of the result set
•SERVICE serviceName—MML name of the service
•RESULTSET setName—MML name of the result set
•RESULTSET resultName—Result name
•A (or B)WHITE—Calling line identity and whether it exists
•A (or B)BLACK—Calling line identity and whether it exists
•PORTTBL digitString—Called number
•PORTTBL routingNumber—Routing number
•TERMTBL digitString—Called number
•TERMTBL routeListName—Route list name
•DEFRESULTSET—MML name of the default result set
Example:
The MML command shown in the following example retrieves the customer group ID:
mml> numan-rtrv:dialplan:"all"
Media Gateway Controller - MGC-01 2000-02-01 13:23:36
M RTRV
"session=active:dialplan"
/*
CustGrpId
---------
V123
*/
;
Comments:
Performance Impact Category: B
NUMAN-RTRV:CRPTMESG—Retrieve a Call Reporting Message (Release 9.7(3))
Purpose:
Retrieves a call reporting messages.
Syntax:
numan-rtrv:crptmesg:"all"
numan-rtrv:crptmesg:index=1
Input Description:
•CRPTMESG—The call reporting message represented as a character string.
Example:
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
NUMAN-RTRV:DESTTRANS (Release 9.8(1))
Purpose:
Retrieves entries in the destination username/domain translation table. For more information about the destination username/domain translation table, see the Domain-Based Routing Feature Module, Destination Username/Domain Translation (DESTTRANS) Table.
Retrieves an entry to the domain strings table. For more information about the domain strings table, see the Domain-Based Routing Feature Module, Domain Strings (DMNMODSTRING) Table.
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
NUMAN-RTRV:DRPTABLE (Release 9.8(1))
Purpose:
Retrieves entries in the route selection table. For more information about the route selection table, see the Domain-Based Routing Feature Module, Route Selection (ROUTESEL) Table.
Retrieves entries in the route selection table. For more information about the route selection table, see the Domain-Based Routing Feature Module, Route Selection (ROUTESEL) Table.
Retrieves an entry or all entries in the route holiday table.
Syntax:
numan-rtrv:rteholiday:custgrpid="<cust group ID>",date="yyyy.mm.dd"
numan-rtrv:rteholiday:custgrpid="<cust group ID>","all"
Input Description:
•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.
See the Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide for a information about components, parameter names, parameter descriptions, and parameter values.
Example:
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
NUMAN-RTRV:SOURCEBLACK (Release 9.8(1))
Purpose:
Retrieves entries in the source domain blacklist table. For more information about the source blacklist table, see the Domain-Based Routing Feature Module, Source Blacklist Screening (SOURCEBLACK) Table.
•lnksetprop—MML NE component consisting of parameters for which you can tune linkset communications. See Appendix A of the Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for a list of linkset property parameters.
•comp—MML component name for the type of configuration you are creating. The component type must match one of the component types listed in the 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).
•protocol family—Name of the protocol family for which you are provisioning linkset properties. Use PROV-RTRV:VARIANTS for a list of protocol families configured for your system.
•param name—The name of a valid configuration parameter for the specified component type. Parameter names are listed in the 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.
Example:
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"
;
Example:
The MML command shown in the following example adds an external node to the Cisco PGW 2200 Softswitch configuration:
Media Gateway Controller - MGC-02 2000-05-08 18:05:55
M COMPLD
"extnode"
;
Comments:
Performance Impact Category: B
See the 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.
PROV-ADD:apc—Provision Adjacent Point Code (Release 9.4(1))
•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 to128 alphanumeric characters in length.
•netaddr—Enter the network address in dot notation.
•netind—Enter the network indicator number. The default value is 0.
See theCisco PGW 2200 SoftswitchRelease 9 Provisioning Guide for information on using the PROV commands for provisioning and for information about components, parameter names, parameter descriptions, and parameter values.
Example:
To add an APC named apc1, enter the following command:
•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
•SGP—MML name of a previously configured Signaling Gateway Process.
•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—Lowest priority destination address, expressed in dot notation. This parameter is optional. 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—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
This is an optional parameter.
•Peerport—Destination (peer) SCTP port:
–Enter a number in the range 1025 to 65535.
–The default is 9900 for IUA.
–The default is 2905 for M3UA.
–The default is 14001 for SUA.
This is an optional parameter.
•Extnode—MML name of a previously configured external node.
•Iproute1—MML name of a previously configured IP route. This is an optional parameter.
•Iproute2—MML name of a previously configured IP route. This is an optional parameter.
•Rcvwin—Number of bytes to advertise for the local receive window.
–Enter a number in the range 1500 to 65535.
–The default is 18000.
This is an optional parameter.
•Maxinitretrans—Maximum number of times to retransmit SCTP INIT message.
•Maxretrans—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.
This is an optional parameter.
•Cumsackto—Maximum time after a datagram is received before a SCPT SACK is sent.
–Enter a number in the range 100 to 500 milliseconds.
–The default is 300 milliseconds.
This is an optional parameter.
•Bundleto—Maximum time SCTP waits for other outgoing datagrams for bundling.
–Enter a number in the range 100 to 600 milliseconds.
–The default is 100 milliseconds.
This is an optional parameter.
•Minrto—Minimum value for the retransmission timer.
–Enter a number in the range 300 to 3000 milliseconds.
–The default is 300 milliseconds.
This is an optional parameter.
•Maxrto—Maximum value for the retransmission timer.
–Enter a number in the range 1000 to 10,000 milliseconds.
–The default is 3000 milliseconds.
This is an optional parameter.
•Hbto—Time between heartbeats. The heartbeat is this value plus the current retransmission timeout value.
–Enter a number in the range 300 to 10,000 milliseconds.
–Enter 0 to disable this parameter.
–The default is 2000 milliseconds.
This is an optional parameter.
•Ipprecedence—Internet Protocol Precedence. Enter one of the following:
–ROUTINE (default)
–PRIORITY
–IMMEDIATE
–FLASH
–FLASH-OVERRIDE
–CRITICAL
–INTERNET
–NETWORK
•DSCP—Time between heartbeats (optional). The heartbeat is this value plus the current retransmission timeout value. Valid values are in the range from 300 to 10000 ms, or 0. A value of 0 means that the heartbeat is disabled. The default value is 2000 ms.
–EF 101110—Expedited Forwarding
–AF11 001010—Assured Forwarding Class 1 Low Drop Precedence
–AF12 001100—Assured Forwarding Class 1 Medium Drop Precedence
–AF13 001110—Assured Forwarding Class 1 High Drop Precedence
–AF21 010010—Assured Forwarding Class 2 Low Drop Precedence
–AF22 010100—Assured Forwarding Class 2 Medium Drop Precedence
–AF23 010110—Assured Forwarding Class 2 High Drop Precedence
–AF31 011010—Assured Forwarding Class 3 Low Drop Precedence
–AF32 011100—Assured Forwarding Class 3 Medium Drop Precedence
–AF33 011110—Assured Forwarding Class 3 High Drop Precedence
–AF41 100010—Assured Forwarding Class 4 Low Drop Precedence
–AF42 100100—Assured Forwarding Class 4 Medium Drop Precedence
–AF43 100110—Assured Forwarding Class 4 High Drop Precedence
–N/A (default)
•Maxretransdest—Maxretransdest—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. This parameter is optional.
Example:
The MML command shown in the following example creates an association between an Cisco PGW 2200 Softswitch and a NAS:
•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.
Example:
The MML command shown in the following example adds the atmprofile atmprof1 to ITU1.
•name—Bearer capability name. Up to 20 alphanumeric characters.
•bearercap—Series of transmission medium requirements (TMR) values separated by semicolons.
See the Cisco PGW 2200 SoftswitchRelease 9 Provisioning Guide for information on using the PROV commands for provisioning and for information about components, parameter names, and parameter values used in provisioning.
Example:
The MML commands shown in the following example provision bearer capability attributes:
prov-add:codecstring:name="name of codec",codecstring="codec string"
Input Description:
•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.
See the Cisco PGW 2200 SoftswitchRelease 9 Provisioning Guide for information on using the PROV commands for provisioning and for information about components, parameter names, and parameter values used in provisioning.
Example:
The MML commands shown in the following example provisions the codec result type:
A conditional route description name must be configured before any conditional route can be connected to it.
See the Cisco PGW 2200 SoftswitchRelease 9 Provisioning Guide for information on using the PROV commands for provisioning and for information about components, parameter names, and parameter values used in provisioning.
Adds a component to the conditional routing table.
Syntax:
prov-add:condrte:name="condName", dow="day of week string",
rtedesc="conditional routing descriptor"
Input Description:
•condrte—Add an entry to the conditional routing table and create the table if it does not already exist.
•name—Conditional routing name; up to 20 alphanumeric characters.
•dow—Day of week. A valid value can be any one of the following:
–Default
–Monday
–Tuesday
–Wednesday
–Thursday
–Friday
–Saturday
–Sunday
–Hol1
–Hol2
–Hol3
•rtedesc—Conditional routing descriptor, consisting of up to 124 alphanumeric characters, that provides time ordered options to use a particular result set from the dial plan result table. Valid format is: setName1setTime1 ... SetName_nSetTimeChange_n
Example:
The MML command shown in the following example adds an entry to the conditional routing table and creates the table, if it does not already exist:
mml> PROV-ADD:CONDRTE:NAME="CONDNAME1", DOW="DEFAULT", RTEDESC="set21 0800
set22 1830 set 24", CONDRTEDESC="descone";
Comments:
Performance Impact Category: B
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.
See the Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide for a description of how to use the PROV-ADD command for dial plan provisioning and for information about components, parameter names, and parameter values used in provisioning.
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.
See the Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for information on using the PROV commands for provisioning and for information about components, parameter names, and parameter values used in provisioning.
PROV-ADD:ctimgr (Release 9.6(1))
Purpose:
Sets the CTI manager on the PGW to IS/OS.
Note A CTI path cannot have more than two CTI managers.
•name—The 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.
•sessionset—MML name of a previously provisioned session set (used for PRI connections only).
•tcplink—MML name of a previously provisioned backhaul TCP link (used for BRI connections only).
•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.
•sigport—Physical port of the associated slot on the Cisco MGW. 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. Default value is 0.
Provisioning Rules:
The following rules apply when you are creating or editing D-channels:
•Backup D-channels for QSIG/Q.931 Over BRI Backhaul signaling services are not supported.
•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.
Example:
The MML command shown in the following example provisions an IP link:
•name—The 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.
•sessionset—MML name of a previously provisioned session set (used for PRI connections only).
•tcplink—MML name of a previously provisioned backhaul TCP link (used for BRI connections only).
•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.
•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.
•subunit—Physical subunit on the Cisco MGW. Valid values are 0 through 3, and 99. The value 99 is only for onboard 2-tuple T1/E1 controller on NM-HDV2-1T1/E1, NM-HDV2-2T1/E1, and etc. Default value is 0.
Provisioning Rules:
The following rules apply when you are creating or editing D-channels:
•Backup D-channels for QSIG/Q.931 Over BRI Backhaul signaling services are not supported.
•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.
Example:
The MML command shown in the following example provisions an IP link:
•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 to128 alphanumeric characters in length.
•netaddr—Enter the network address in dot notation.
•netind—Enter the network indicator number. The default value is 0.
See the Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for information on using the PROV commands for provisioning and for information about components, parameter names, and parameter values used in provisioning.
Example:
To add a DPC named dpc1, enter the following command:
•name—The 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—An assigned name. 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 media gateway. Valid values are 0 and 1. Default value is 0.
Provisioning Rules:
The following attributes cannot be modified:
•NAME
•EXTNODE
The following rules apply when you are creating or editing DPNSS signaling paths:
•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 define 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.
•name—The 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—An assigned name. 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.
•origlabel—Origination location label. Name of an existing location label.
•termlabel—Termination location label. Name of an existing location label.
•subunit—Physical subunit on the Cisco media gateway. Valid values are 0 through 3, and 99. The value 99 is only for onboard 2-tuple T1/E1 controller on NM-HDV2-1T1/E1, NM-HDV2-2T1/E1, and etc. Default value is 0.
Provisioning Rules:
The following attributes cannot be modified:
•NAME
•EXTNODE
The following rules apply when you are creating or editing DPNSS signaling paths:
•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 define 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.
•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—Enter a long name up to128 alphanumeric characters in length.
•EXTNODE—External node name assigned to the media gateway you are configuring.
•MDO—A 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.
See the Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for information on using the PROV commands for provisioning and for information about components, parameter names, and parameter values used in provisioning.
Example:
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
PROV-ADD:extnode—Provision an External Node (Release 9.4(1))
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
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—External node type. Valid values are:
–AS5200
–AS5300
–AS5350
–AS5400
–AS5800
–AS5850
–AS7200
–ASR1000
–C12000
–C1751
–C1760
–C2600
–C2610XM
–C2611XM
–C2620XM
–C2621XM
–C2650XM
–C2651XM
–C2691
–C2801
–C2811
–C2821
–C2851
–C3600
–C3640
–C3640A
–C3660
–C3725
–C3745
–C3825
– C3845
–CAT8510
–CAT8540
Input Description: (continued)
–CCMCLUSTER
–H323
–ITP
–LIMD
–LS1010
–MC3810MGC
–MGX8260
–MGX8850
–RACLUSTER
–SCP
–SLT
–TALISS7
–UNKNOWN
–VISM
–VXSM
•Isdnsigtype—ISDN signaling type. Enter one of the following:
–IUA
–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.
–
Example:
The MML command shown in the following example provisions an AS5300 NAS, va-5300-37, as an external node:
1. Gateway pool ID 1 identifies the global default VXSM gateway pool.
2. 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 of the gateways in this gateway pool. Also, you can use the command prov-ed to change the gateway pool description.
3. prov-dlt:GWPOOL. The associated board gateways are disassociated with this gateway pool first.
PROV-ADD:H248PATH:NAME—Provision H.248 Signaling Protocol Service (Release 9.7(3))
Purpose:
Provisions the H.248 signaling protocol service. The parameters are stored in sigPath.dat, which contains the EXTNODE compID.
comp—The component that is generating the alarm. Components are described in the Cisco PGW 2200 Softswitch Release 9 Provisioning Guide. See the "RTRV-CTR—Retrieve Measurement Counter" section 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.
