Cisco PGW 2200 Softswitch Release 9 MML Command Reference
Chapter 5 - NUMAN: Commands for Provisioning Dial Plan Components
Downloads: This chapterpdf (PDF - 326.0KB) The complete bookPDF (PDF - 8.56MB) | Feedback

NUMAN: Commands for Provisioning Dial Plan Components

Table Of Contents

NUMAN: Commands for Provisioning Dial Plan Components

NUMAN-ADD—Add Dial Plan Element

ABLACK—A-digit Tree Black List

ACHGORIGIN—A-number Charge Origin

ADIGTREE—A-digit Tree

ANNOUNCEMENT—Tone and Announcement Table

ANOA—A Nature of Address

ANPI—A Number Plan Indicator

ANUMDPSEL—A-number Dial Plan Selection

AWHITE—A-digit Tree White List

BBLACK—B-digit Tree Black List

BC—Bearer Capability

BDIGTREE—B-digit Tree

BNOA—B Nature of Address

BNPI—B Number Plan Indicator

BWHITE—B-digit Tree White List

CAUSE—Cause Table (Release 9.7(3))

CLIIPADDRESS—Calling Line Identity IP Address

CLIPREFIX—Calling Line Identity Prefix

CPC—Calling Party Category

CRPTMESG—Call Reporting Message (Release 9.7(3))

CUSTOMERVPNID—Customer VPN ID

DEFRESULTSET—Default Result Set

DESTTRANS—Destination Translation Table (Release 9.8(1))

DIALPLAN—Customer-created Dial Plan

DIGMODSTRING—Digit Modification String

DMNMODSTRING—Domain String Table (Release 9.8(1))

DRPTABLE—Domain Routing Policy Table (Release 9.8(1))

DPSEL—Dial Plan Selection

FULLNUMBERTRANS—Full Number Translation (Release 9.7(3))

H323IDDIVFROM—H323 ID, Division Header, or From Field

HLC—High Layer Compatibility

LOCATION—Location

PORTTBL—Ported Numbers Table

PREFIXCONVERT—Prefix Convert (Release 9.8(1))

RESULTSET—Result Set

RESULTTABLE—Result Table

ROUTESEL— Route Selection Table (Release 9.8(1))

RTEHOLIDAY—Route Holiday Table

SCRIPT—Script Table

SERVICE—Service

SOURCEBLACK—Source Domain Blacklist Table (Release 9.8(1))

TAG—Tag (Release 9.8(1))

TAGLIST—Tag List (Release 9.8(1))

TERMTBL—Number Termination Table

TMR—Transmission Medium Requirements

TNS—Transit Network Selection


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, 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:

mml> numan-add:digmodstring:custgrpid="T001",name="digmod1",digstring="703484"

Comments:

Performance Impact Category: B, C. Impact depends on the size of the dial plan.


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:

custgrpid—Customer group ID. ID of an existing dial plan.

cli—Calling line identifier.

Example:

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:

custgrpid—Customer group ID. ID of an existing dial plan.

cli—Calling line identifier.

corigin—Call origin. Integer range 1 to 9999.

Example:

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"

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 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.

Example:

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"

Input Description:

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.

Example:

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:

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.

Example:

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"

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:

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.

Example:

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:

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.

Example:

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"

Input Description:

custgrpid—Customer group ID. ID of an existing dial plan.

cli—Calling line identifier.

Example:

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:

custgrpid—Customer group ID. ID of an existing dial plan.

cli—Calling line identifier.

svcname—MML name of the previously defined service.

Example:

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:

custgrpid—Customer group ID. ID of an existing dial plan.

name—Bearer capability name.

ocval—Octet coding value.

Example:

The MML command shown in the following example adds the BC table entry:

mml> numan-add:BC:cusgrpid="dpl1",name="bc-04",ocval="9090A3"

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.

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.


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:

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.

Example:

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:

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.

Example:

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"

Input Description:

custgrpid—Customer group ID. ID of an existing dial plan.

cli—Calling line identifier.

svcname—MML name of the previously defined service.

Example:

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:

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"

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 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


CLIIPADDRESS—Calling Line Identity IP Address

Purpose:

Add, delete, or edit a Calling Line Identity (CLI) IP address entry.

Note Provision CLIPREFIX before CLIIPADDRESS and H323IDDIVFROM. See the "CLIPREFIX—Calling Line Identity Prefix" section.

Syntax:

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"

Input Description:

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.

Example:

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 Provision CLIPREFIX before CLIIPADDRESS and H323IDDIVFROM.

Syntax:

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"

Input Description:

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.

Example:

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"

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:

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"

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.

Example:

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

Input Description:

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":

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:

custgrpid—Customer group ID. ID of an existing dial plan.

name—Customer VPN ID (8-digit alphanumeric character string).

Example:

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.

Syntax:

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"

Input Description:

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 (user@example.com) 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.

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:

mml> numan-add:desttrans: custgrpid="dp11", destdmnstring="bob@cisco.com",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  bob@cisco.com  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:

Input Description:

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.

Examples:

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:

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.

Examples:

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"

Input Description:

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.

Output Description:

COMPLD—Provision succeeds

DENY—Provision fails

Examples:

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:

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

Output Description:

COMPLD—Provision succeeds

DENY—Provision fails

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:

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.

Examples:

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"

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 The numtype value of 5 is added in the Cisco PGW 2200 Softswitch Release 9.8(1) S7P7.

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:

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 Provision CLIPREFIX before CLIIPADDRESS and H323IDDIVFROM. See the "CLIPREFIX—Calling Line Identity Prefix" section.

Syntax:

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"

Input Description:

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.

Example:

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"

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"

Input Description:

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.

Example:

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 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.

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.

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.


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 If cdpnprefix, cgpnprefix, or acgpnprefix are not specified, they will be assigned with DEFAULT values.

Example:

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.


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:

custgrpid—The customer group ID, which is a previously defined 4-digit alphanumeric string.

name—The result set name.

Example:

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:

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"

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.

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.

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.


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:

custgrpid—Customer group ID. A 4-digit alphanumeric string (enclosed in straight quotes) to identify the dial plan.

destdmnstring—Destination username (bob@domain.com) or domain name (domain.com).

srcdmnstring—Source username (bob@example.com) 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.

Output Description:

COMPLD—Provision succeeds

DENY—Provision fails

Examples:

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       fred@example.com rtlist60
   */
   ;

Comments:

Performance impact category: A


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:

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"

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

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.


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

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.

Example:

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
   ;

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:

custgrpid—Customer group ID. A 4-digit alphanumeric string (enclosed in straight quotes) to identify the dial plan.

name—Service name.

Example:

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:

custgrpid—Customer group ID. A 4-digit alphanumeric string (enclosed in straight quotes) to identify the dial plan.

srcdmnstring—The source username (bob@example.com) or domain name (example.com).

svcname—The MML name of a service.

all—All entries in the SOURCEBLACK table.

Output Description:

COMPLD—Provision succeeds

DENY—Provision fails

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:

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"

Input Description:

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.

Output Description:

COMPLD—Provision succeeds

DENY—Provision fails

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.


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:

digitstring—The called number.

rtlistname—The route list name.

Examples:

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:

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"

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.

Example:

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"

TNS—Transit Network Selection

Purpose:

Add—Provisions transit network selection (TNS).

Delete—Deletes elements in the TNS.

Edit—Edits elements in the TNS.

Syntax:

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"

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.

Example:

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"