Cisco PGW 2200 Softswitch Release 9 MML Command Reference
Chapter 2 - Session-Level Commands
Downloads: This chapterpdf (PDF - 235.0KB) The complete bookPDF (PDF - 8.56MB) | Feedback

Session-Level Commands

Table Of Contents

Session-Level Commands

H—Display History

HELP

PROV-CPY—Copy Provisioning Data

PROV-DPLY—Deploy Provisioning Data

PROV-EXP—Export Provisioning Data

PROV-LOCK—Disable Provisioning

PROV-RTRV—Retrieve Provisioning Information

PROV-STA—Start Provisioning Session

PROV-STP—Stop Provisioning Session

PROV-SYNC—Synchronize Provisioning Data

PROV-UNLOCK—Re-enable Provisioning

QUIT—End Session

R—Repeat Previously Entered Command


Session-Level Commands


Revised: Aug 30, 2011, OL-1116-24

This chapter describes the Man-Machine Language (MML) session-level commands for the Cisco PGW 2200 Softswitch Release 9.

H—Display History

Purpose:

Redisplays a command or a series of commands, depending on whether you enter a specified number or a range. If no number is specified, the last command is displayed.

Syntax:

h[::<number>[,<number>]]

Input Description:

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

 

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
                                   older than value of T in seconds
diaglog:<file name>:START|STOP    Starts/stops diagnostics log
h[::<number>[,<number>]]          Displays a history of commands for a
                                   specified backward number or range;
                                   the last command by default
help[:<command name>]             Displays the list of MML commands or
                                   the help information on a specified
                                   command
-call:<dest_pc>:cic=<cic>,confirm
                                 Forcefully releases a bearer channel 
                                 associated with a single call instance.
numan-add:<comp>:custgrpid=<cust group ID>,<param name>=<param value>,...
                                  Adds an element to a dial plan table
numan-dlt:<comp>:custgrpid=<cust group ID>
                                  Deletes an element from a dial plan
                                   table
numan-ed:<comp>:custgrpid=<cust group ID>,<param name>=<param value>,...
                                  Edits an element in a dial plan table
numan-rtrv:<comp>:custgrpid=<cust group ID>
                                  Retrieves an element from a dial plan
                                   table
numan-rtrv:<comp>:custgrpid=<cust group ID>,"all"
                                  Retrieves all elements from a dial plan
                                   table
prov-add:<comp>:name=<MML name>,<param name>=<param value>,...
                                  Adds the component
prov-add:sippath:name=<MML name>,<param name>=<param value>,...
                                  Adds SIP signal path
prov-add:siplnk:name=<MML name>,<param name>=<param value>,...
                                  Adds SIP signal chan
 
prov-add:siprttrnkgrp:name=<MML name>,<param name>=<param value>,...
                                  Adds SIP route trunk group
prov-add:lnksetprop:name="<protocol family>",<param name>=<param value>,...
                                Provisions linkset property parameters
prov-cpy                          Commits provisioning data
prov-dlt:<comp>:name=<MML name>   Deletes the component
prov-dply                         Deploys provisioning data
prov-ed:<comp>:name=<MML name>,<param name>=<param value>,...
                                  Modifies the component attributes
prov-exp:<tid>:dirname="<export directory name>"
                                  Exports provisioning data to the given
                                   export directory name
                                   tid can be one of the following:
                                    all
                                    config
                                    signal
                                    trkgrp
                                    trunk
                                    numan
                                    routing
                                   export directory name can be any
                                    directory name, in double quotes,
                                    which will be created under the
                                    cust_specific directory
prov-rtrv:<comp>:name=<MML name>  Retrieves the component attributes
prov-rtrv:all                     Retrieves all the components
prov-rtrv:siprttrnkgrp:"all"      Retrieves all SIP route trunk group
                                   information
prov-rtrv:session                 Retrieves provisioning session
                                   information if one exists
prov-rtrv:variants                Retrieves all variants
prov-rtrv:profiletypes            Retrieves all profile types
prov-sta::srcver=<version>,dstver=<version>,confirm
                                  Starts a provisioning session
prov-stp                          Stops the current provisioning
                                   session
prov-stp:<session name>:confirm   Stops the specified provisioning
                                   session
prov-sync                         Synchronizes provisioning data
prt-call:<sig path>|<trk grp>:[CIC=<number>|SPAN=<number>[BC=<number>]]
                              [,LOG=<logname>] [,EVT]
                                  Prints diagnostic information about an
                                  active call into the log file
query-cic:<sigpath>:CIC=<number>[,RNG=<slaves>][,RSLV]
                                  Performs a circuit query for a circuit
                                   or a circuit range with an optional
                                   RESOLVE parameter
quit                              Ends the session
r[::<number>]                     Repeats a previously entered command
                                   with a specified backward number;
                                   the last command by default
reset-cic:<sigpath>:CIC=<number>[,RNG=<slaves>]
                                  Resets a circuit or a circuit range
rtrv-admin-state:<target>:<param>
                                  Retrieves the administrative state
                                   of the target;
                                   target can be a MGC or gateway or
                                   trunk group or signal path;param can be 
                                   one of the following combinations:
                                    [span=number] or
                                    [span=number,]bc=number[,RNG=number]
                                    or
                                    cic=number[,RNG=number]
 
rtrv-alms                         Displays all active alarms
rtrv-alms::CONT                   Displays all active alarms and listens
                                   for alarm events until Ctrl-C
rtrv-aud-gw:<sig path MGCP>       Retrieves result of an auditing process
                                   of a gateway
rtrv-aud-gw:all                   Retrieves results of auditing processes
                                   of all gateways
rtrv-cfg:<cfg table>              Displays contents of a configuration
                                   table where table can be:
                                   alarmCategories | components |
                                   componentTypes | measCategories |
                                   services | tables
rtrv-cic:<sigpath>:CIC=<number>[,RNG=<slaves>]
                                  Retrieves bearer channels of a signal 
                                  path
rtrv-ctr:<comp>:"<meas cat>"      Retrieves a measurement of a component
rtrv-dest:<sigpath>              Retrieves state of a destination
                                   (signal path)
rtrv-dest:all                     Retrieves state of all destinations:
                                   point codes and signal paths
rtrv-dns-info:<sig path SIP>      Retrieves DNS cache info
rtrv-iplnk:<IP link>              Displays attributes of an IP link
rtrv-iplnk:all                    Displays attributes of all IP links
rtrv-lnk-ctr:<C7 link/set>        Retrieves all measurements of a link or
                                   link set
rtrv-lnk-ctr:all                  Retrieves all measurements of all links
rtrv-log:all                      Displays logging level of all processes
rtrv-log:<proc>                   Displays logging level of a process
rtrv-lset:<C7 link set>           Displays state of a link set
rtrv-lssn:all                     Displays state of local SSN
rtrv-mml                          Displays all active MML sessions
rtrv-ne                           Displays attributes of the Network
                                   Element
rtrv-ne-health                    Displays health of the Network Element
                                   (CPU/Memory utilization etc.)
rtrv-ovld                         Displays overload level and number of
                                   messages in a queue
rtrv-rssn:all                     Displays state of remote SSN
rtrv-rte:<dpc name>               Retrieves all SS7 routes for a point
                                   code
rtrv-rte:all                      Retrieves SS7 routes for all point
                                   codes
rtrv-dchan:<D channel | fas link> Displays attributes of a signal
                                   channel
rtrv-dchan:all                     Displays attributes of all D channels
rtrv-c7lnk:<C7 link set|C7 link>  Displays attributes of a link(set)
rtrv-c7lnk:all                    Displays attributes of all signal
                                   channels and link sets
rtrv-sc-trc                       Displays the names of all files
                                  currently open for the various traces
                                   in progress
rtrv-softw:<proc>                 Displays status of a process or
                                   process group
 
rtrv-softw:all                    Displays status of all known processes
 
        
rtrv-softw:<point code>           Retrieves all measurements of a point
                                   code
rtrv-sp-ctr:all                   Retrieves all measurements of all point
                                   codes
rtrv-spc:<point code>             Retrieves route set of a point code
rtrv-spc:all                      Retrieves route sets of all point codes
rtrv-ss7-slt:<C7 link>            Retrieves result of an MTP SLT test on
                                   a link (SS7 only)
rtrv-ss7-srt:<ss7path>:LSET="<C7 link/set>"
                                  Retrieves result of an MTP SRT test on
                                   a point code (Japanese SS7 only)
rtrv-tc:<sig path>&<sig path>...  Displays state of bearers per signal
                                   path(s)
rtrv-tc:all                       Displays state of all bearers
rtrv-tc-held:<sig path>&<sig path>...
                                  Displays state of bearers per signal
                                   path(s) held by gateway
rtrv-tc-held:all                  Displays state of all bearers, held by
                                   gateway
rtrv-tcap-trans                   Displays number of active TCAP
                                   transactions
rtrv-thres::"<Meas Cat>"        Displays the threshold settings for
                                   measurement category
set-admin-state:<target>:<param>,LOCK|UNLOCK|RESET
                                  Sets the administrative state of
                                   the target;
                                   target can be a MGC or gateway or
                                   trunk group or signal path;
                                   param can be one of the following
                                   combinations:
                                    [span=number] or
                                    [span=number,]bc=number[,RNG=number]
                                    or
                                    cic=number[,RNG=number]
set-dest-state:<sig path>:IS|OOS... replaced by set-dest
set-dest:<sig path>:IS|OOS|FOOS
                                  Changes service state of signal path
set-iplnk:<IP link>:IS:OOS:FOOS   Changes the services state of an IP link
                                   This command is disabled for NAS links
set-lnk-state:<C7 link/set>:IS|OOS|INH|UNH
                                  Changes service state of a link or a
                                   linkset
set-log:<proc>:<log level>        Sets logging level for process <proc>
set-log:<proc>:DEBUG,CONFIRM      Sets DEBUG logging level for <proc>
set-log:all:<log level>           Sets logging level for all processes.
                                   logLevel can be:
                                   DEBUG | TRACE | INFO | WARN | ERR |
                                   CRIT
set-lssn-state::<SSN>,IS|OOS
                                  Changes service state of a local SSN
set-c7lnk:<C7 IP or TDM SS7 link>:IS|OOS|FOOS|UNH|INH
                                  Changes service state of a SS7 link
set-dchan:<FAS link|d-channel>:IS|OOS
                                  Changes service state of FAS related link
set-spc:<point code>:IS|OOS...
                                  Changes service state of a point code
set-thres::cat="<meas cat>",interval=<seconds>,thres=<value>
                                  Changes the threshold value of
                                  measurement category <meas cat>
                                  for interval to the new value
 
sta-aud                           Starts auditing process
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 HELP command with no parameters on those systems.


  

PROV-CPY—Copy Provisioning Data

Purpose:

Copies configuration settings from the current provisioning session to the local host on which the commands are running in a simplex configuration to activate the configuration. This command, if successful, terminates the current provisioning session and fails if there is no active provisioning session.

The difference between the PROV-CPY command and the PROV-DPLY command is that the PROV-DPLY command applies the configuration changes to both hosts in continuous-service Cisco PGW 2200 Softswitch configurations, and the PROV-CPY command applies the configuration changes to only the local Cisco PGW 2200 Softswitch host.

Note When you provision and add new signaling links or new CICs using the PROV-CPY command, you must reboot the standby system to synchronize the new objects in the active system to those on the standby system. Not rebooting can cause loss of calls after a switchover.

Syntax:

prov-cpy

Example:

The MML command shown in the following example copies the configuration changes from the current session to the simplex Cisco PGW 2200 Softswitch you are configuring.

mml> PROV-CPY

Comments:

Performance Impact Category: B, C, D; impact depends on changes being committed.

See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for a description of using the PROV commands for provisioning and for information about components, parameter names, and parameter values used in provisioning.


PROV-DPLY—Deploy Provisioning Data

Purpose:

Copies configuration settings from the current provisioning session to both Cisco PGW 2200 Softswitchs in a continuous-service configuration, and this activates the configuration. If the command is successful, it terminates the current provisioning session. The command fails if there is no active provisioning session.

Note The difference between the PROV-CPY command and the PROV-DPLY command is that the PROV-DPLY command applies the configuration changes to continuous-service Cisco PGW 2200 Softswitch configurations, whereas the PROV-CPY command applies the configuration changes to the Cisco PGW 2200 Softswitch you are configuring.

Syntax:

PROV-DPLY

Example:

The MML command shown in the following example copies the configuration from the current session to both Cisco PGW 2200 Softswitchs:

mml> PROV-DPLY

Comments:

Perform the PROV-STA command before using this command.

Performance Impact Category: B, C, D. This command is necessary to deploy a new data configuration; impact depends on the changes being deployed.

Note Shutting down interfaces during a PROV-DPLY or PROV-SYNC can cause failover after bouncing. To correct this, shut down both the standby and active systems and restart them.

See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for a description of using the PROV commands for provisioning and for information about components, parameter names, and parameter values used in provisioning.


PROV-EXP—Export Provisioning Data

Purpose:

Exports the current configuration of the Cisco PGW 2200 Softswitch, in MML-command form, to a file or files. This allows for a system to be primed with a cloned configuration from an existing system or to be restored to a baseline configuration. The exported data can be imported by the use of MML's batch feature. See the Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for information about creating an MML batch file.

Syntax:

prov-exp:<tid>:dirname="<export directory name>"

Input Description:

tid—Types of data. These can be:

config—Core configuration data, including trunks and trunk group data.

routing—Routing only.

numan—Dial plan only.

trkgrp—Trunk group data only.

trunk—Trunk data only.

all—Entire configuration (all data).

export directory name—Name of the directory to which the data is exported. This directory, which must be typed within double quotes, is created as a subdirectory within the cust_specific directory established at installation.

Since software Release 9.4, the prov-exp command has been modified to extract global screening data (if any exists) from the TimesTen database after all dial plans are processed. Global screening data is stored in the following files within the cust_specific directory:

GLBL.awhite

GLBL.ablack

GLBL.bwhite

GLBL.bblack

Example:

The MML command shown in the following example exports the following files to the saved config directory:

config.mml

export_trunks.dat (optionally created if trunks are defined)

export_trkgrp.dat (optionally created if trunk groups are defined)

routing.mml

<custGrpID>.mml (any number of these depending on the number of dial plans defined)

GLBL.awhite (optionally created if global whitelist screening is defined)

GLBL.ablack (optionally created if global blacklist screening is defined)

GLBL.bwhite (optionally created if global whitelist screening is defined)

GLBL.bblack (optionally created if global blacklist screening is defined)

mml> PROV-EXP:ALL:DIRNAME="SAVED_CONFIG"
Media Gateway Controller  - MGC-01 2000-01-12 15:19:51
M COMPLD
 
        

To import all configuration data from the directory saved_config exported by this command, use the UNIX commands shown, in the following order, to execute MML in batch mode:

mml -b $BASEDIR/etc/cust_specific/saved_config/config.mml
mml -b $BASEDIR/etc/cust_specific/saved_config/routing.mml
mml -b $BASEDIR/etc/cust_specific/saved_config/<CustGrpID>.mml

Comments:

Performance Impact Category: B

This command was introduced in software Release 7.4.


PROV-LOCK—Disable Provisioning


Note This command is obsolete and is not supported on Releases 9.7(3) and 9.8(1).


Purpose:

Locks the system to disable any provisioning or deployment during an upgrade or downgrade.

Syntax:

prov-lock::confirm 

Input Description:

confirm—Verify that the system is locked and any new or modified provisioning is disabled.

Example:

The MML command shown in the following example locks the system disables provisioning additions, modifications, and deployment:

mml> prov-lock::confirm
 
        

Comments:

Performance Impact Category: B

This command disables the prov-add, prov-ed, prov-dlt, prov-sync, prov-cpy, and prov-dply commands.


PROV-RTRV—Retrieve Provisioning Information

Purpose:

Retrieves information about an existing provisioning session.

Syntax:

prov-rtrv:<comp>:name=<MML name>
prov-rtrv:all
prov-rtrv:<comp>:name="<componentname>"|"all"
prov-rtrv:siprttrnkgrp:"all"
prov-rtrv:session
prov-rtrv:profiletypes
prov-rtrv:variants
prov-rtrv:lnksetprop:name="<protocol family>"

Input Description:

all—Displays all components that have been provisioned. A provisioning session is not required.

session—Displays information about the provisioning session.

variants—Displays a list of the signaling protocols this configuration supports. A provisioning session is not required.

siprttrnkgrp—Retrieves all SIP route trunk group information.

lnksetprop—Displays properties for linksets associated with the specified protocol family.

profiletypes—Displays all profile types.

comp—Use this parameter when you want to display information about a single component. Enter the MML component type name for the type of component you are modifying. The entered parameter must match one of the component types listed in Cisco PGW 2200 Softswitch Release 9 Provisioning Guide. Use the PROV-RTRV:ALL command to view TID names that can be entered here.

name—MML component name for the component you want to display. Use the PROV-RTRV:ALL command to view MML component names that can be entered here.

Output Description:

The output of this command varies, depending on the format selected.

For PROV-RTRV:ALL, the output is the following:

SESSION—DSTVER if session exists; otherwise this is "ACTIVE"

NAME—MML name of component

COMPID—8-digit component ID

PARENT NAME—MML name of parent component

TID—Target identifier of component

DESCRIPTION—Description of the provisioning component

For PROV-RTRV:<comp>:NAME="<component name>", the output is the following:

SESSION—DSTVER if session exists; otherwise this is "ACTIVE"

NAME—MML name of component

DESC—Description of the component

A wide variety of additional output parameters can appear, depending on the component selected.

Output Description:

For PROV-RTRV:SESSION, the output is the following:

SRCVER—The specific configuration version, as entered in the PROV-STA command that created the session.

DSTVER—The specific output version, as entered in the PROV-STA command that created the session.

For PROV-RTRV:VARIANTS, the output is the following:

MDO FILE NAME—Filename of the message definition object file. The MDO is a file that identifies protocol variants.

PROTOCOL FAMILY—Name of the protocol family.

Example:

The MML command shown in the following example displays information about the point code "opc":

mml> PROV-RTRV:opc:NAME="opc"
MGC-01 - Media Gateway Controller 2000-08-25 16:28:56
M  RTRV
   ""session=active:ptcode"
   /* 
NAME = opc
DESC = Origination Point Code
NETADDR = 201.1.100
NETIND = 2
   */
   ;

Example:

The MML command shown in the following example displays information about variants:

 
        
mml> PROV-RTRV:VARIANTS
MGC-01 - Media Gateway Controller 2001-12-17 15:38:04.774 EST
M  RTRV
   "session=cleanversion:variants"
   /* 
MDO File name         Protcol Family        Switch Type
-------------         --------------        -----------
ANSISS7_CLEAR         SS7-ANSI              20
ANSISS7_MCI           SS7-ANSI              0
ANSISS7_SPRINT        SS7-ANSI              0
ANSISS7_STANDARD      SS7-ANSI              0
ATT_41459             ISDNPRI               17
ATT_41459_C2          ISDNPRI               17
BELL_1268             ISDNPRI               22
BELL_1268_C3          ISDNPRI               22
BTNUP_BTNR167         SS7-UK                5
BTNUP_IUP             SS7-UK                5
BTNUP_NRC             SS7-UK                5
DPNSS_BTNR188         DPNSS                 26
EISUP                 EISUP                 0
ETS_300_102           ISDNPRI               27
 
        
<Press 'SPACE' for next page, 'Enter' for next line or 'q' to quit this 
output>
ETS_300_102_C1        ISDNPRI               27
ETS_300_121           SS7-ITU               0
ETS_300_172           ISDNPRI               29
ETS_300_356           SS7-ITU               0
GR317                 SS7-ANSI              0
HKTA_2202             SS7-ITU               0
IETF_DCS              SIP                   0
IETF_SIP              SIP                   0
ISUPV1_POLI           SS7-ITU               0
ISUPV2_32DIG          SS7-ITU               0
ISUPV2_AUSTRIAN       SS7-ITU               0
ISUPV2_CZECH          SS7-ITU               0
ISUPV2_FINNISH96      SS7-ITU               0
ISUPV2_FRENCH         SS7-ITU               0
ISUPV2_GERMAN         SS7-ITU               0
ISUPV2_JAPAN          SS7-Japan             10
ISUPV2_KPNPB          SS7-ITU               0
ISUPV2_NORWEGIAN      SS7-ITU               0
 
        
 
ISUPV2_NTT            SS7-Japan             0
ISUPV2_SPANISH        SS7-ITU               0
 
        
<Press 'SPACE' for next page, 'Enter' for next line or 'q' to quit this 
output>
ISUPV2_SWISS          SS7-ITU               0
ISUPV2_SWISS_C2       SS7-ITU               0
ISUPV2_TELEFONICA     SS7-ITU               0
ISUPV2_VIETNAM        SS7-ITU               0
ISUPV3_UK             SS7-UK                0
MGCPCAS               CAS                   0
NORTEL_IBN7           SS7-ANSI              0
NTT_INS_1500          ISDNPRI               27
Q721_BASE             SS7-ITU               5
Q721_BRAZILIAN        SS7-ITU               5
Q721_CHINA            SS7-China             5
Q721_FRENCH           SS7-ITU               5
Q721_PHILLIPINE       SS7-ITU               5
Q761_ARGENTINA        SS7-ITU               0
Q761_ARGENTINA_C2     SS7-ITU               0
Q761_AUSTRL           SS7-ITU               0
Q761_AUSTRL_C2        SS7-ITU               0
Q761_BASE             SS7-ITU               0
Q761_BELG_BCOM        SS7-ITU               0
Q761_BELG_MOBI        SS7-ITU               0
<Press 'SPACE' for next page, 'Enter' for next line or 'q' to quit this 
output>
Q761_CHILE            SS7-ITU               0
Q761_CHINA            SS7-China             0
Q761_CHINA_MOB        SS7-China             0
Q761_DANISH           SS7-ITU               0
Q761_INDIA            SS7-ITU               0
Q761_KOREAN           SS7-ITU               0
Q761_NEWZEALAND       SS7-ITU               0
Q761_PERU             SS7-ITU               0
Q761_PORTUGAL         SS7-ITU               0
Q761_SIEMENS_MOBI     SS7-ITU               0
Q761_SINGAPORE        SS7-ITU               0
Q761_SINGAPORE_C2     SS7-ITU               0
Q761_TAIWAN           SS7-ITU               0
Q761_THAILAND         SS7-ITU               0
Q767_BASE             SS7-ITU               0
Q767_BRAZIL           SS7-ITU               0
Q767_COLOMBIA         SS7-ITU               0
Q767_GUATEMALA        SS7-ITU               0
Q767_INDONESIA        SS7-ITU               0
Q767_ITAL             SS7-ITU               0
 
        
 
<Press 'SPACE' for next page, 'Enter' for next line or 'q' to quit this 
output>
Q767_ITAL_INTERCONNECT  SS7-ITU               0
Q767_MEXICAN          SS7-ITU               0
Q767_RUSS             SS7-ITU               0
Q767_SPAN             SS7-ITU               0
Q767_SWED             SS7-ITU               0
Q767_TELSTRA          SS7-ITU               0
Q931                  ISDNPRI               27
Q931_AUSTRALIA        ISDNPRI               19
Q931_SINGAPORE        ISDNPRI               27
dummy                 AVM                   0
dummy                 MGCP                  0
dummy                 SGCP                  0
dummy                 TCAPOverIP            0
dummy                 VSI                   0
   */
   ;
 
        

Example:

The MML command shown in the following example displays information about linkset properties:

 
        
mml> prov-rtrv:LNKSETPROP:name="ss7-itu"
   MGC-01 - Media Gateway Controller 2002-04-19 16:12:54.469 EST
M  RTRV
   "session=Mist915-S10P15-22MAR02:LNKSETPROP"
   /* 
mtp2AermEmgThr = 1
mtp2AermNrmThr = 4
mtp2CongDiscard = false
mtp2LssuLen = 1
mtp2MaxAlignRetries = 5
mtp2MaxMsuFrmLen = 272
mtp2MaxOutsFrames = 127
mtp2ProvingEmgT4 = 6
mtp2ProvingNormalT4 = 23
mtp2SuermThr = 64
mtp2T1 = 450
mtp2T2 = 250
mtp2T3 = 20
mtp2T5 = 1
mtp2T6 = 60
mtp2T7 = 10
;
 
        

Note To determine the protocol family associated with a linkset, use the PROV-RTRV:LNKSET:"ALL" command.


Comments:

Performance Impact Category: B, C; impact depends on the size of the current configuration and what information is retrieved.

See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for a description of using the PROV commands for provisioning and for information about components, parameter names, and parameter values used in provisioning.

If the quotation marks are not used, the following error message is displayed:

/* Input, Invalid Data Parameter */

PROV-STA—Start Provisioning Session

Purpose:

Establishes a provisioning session. The data files are copied from the source version to the destination version. The data files are also locked to prevent other users from making changes.

If there is no active session, you can start a new session. If there is an active session, you can view the active configuration, but you are blocked from performing other actions.

Syntax:

prov-sta::srcver=<version>,dstver=<version>[,confirm]

Input Description:

srcver—Selects a specific configuration version as the source for configuration changes. The srcver variable represents a directory stored in $BASEDIR/etc/CONFIG_LIB. In place of the configuration version, you can also enter:

new—Specifies a new default session configuration; no existing source configuration is used.

active—Selects the active configuration as the source for configuration changes.

dstver—Specifies the output version number and directory for the configuration session results. The destVersionNumber variable represents a directory stored in $BASEDIR/etc/CONFIG_LIB.

confirm—Allows overwriting of existing provisioning directories. In other words, if the dstver directory exists and this option is not used, an error message results. If the dstver directory exists and this option is used, the directory is overwritten.

Note A version number is not required within the directory names listed above, but it does help you keep track of different configuration versions.

Example:

The MML command shown in the following example starts a provisioning session and creates a new configuration named ver1:

mml> PROV-STA::SRCVER="new", DSTVER="ver1":CONFIRM
Media Gateway Controller  - MGC-01 2000-01-12 15:19:51 
M  COMPLD
   "PROV-STA"
   ;

Example:

The MML command shown in the following example starts a provisioning session, opens the existing configuration named ver1, and overwrites that configuration:

mml> PROV-STA::SRCVER="ver1", DSTVER="ver1"

Example:

The MML command shown in the following example starts a provisioning session, opens the existing configuration named ver1, and saves the updated configuration as ver2:

mml> PROV-STA::SRCVER="ver1", DSTVER="ver2"

Comments:

Performance Impact Category: B

See Cisco PGW 2200 Softswitch Release 9 Provisioning Guide for a description of the PROV commands for provisioning and for information about components, parameter names, and parameter values.

If the source and destination filenames are the same, the new configuration overwrites the old configuration. It is a good practice to copy an existing configuration instead of overwriting it. This gives you an easy way to return to a known configuration if there are problems with the new configuration. The new configuration should never be the destination session.

If the source configuration specified is new, the software does not allow you to overwrite an existing configuration.


PROV-STP—Stop Provisioning Session

Purpose:

Terminates either a specified session or the current provisioning session, saves the configuration, and releases the lock on the configuration data files.

Note This command does not activate the new configuration. Use the PROV-CPY or PROV-DPLY command to activate the configuration.

Syntax:

prov-stp
prov-stp:<session name>:confirm

Input Description:

session nameUse the PROV-RTRV:SESSION command to display a provisioning session for this parameter.

confirm—If no confirm option is entered, the command is rejected, and you are notified of the potential performance impact of this command.

Note Do not use the confirm option unless you enter the MML session ID.

Example:

The MML command shown in the following example terminates the current provisioning session:

mml> PROV-STP
Media Gateway Controller  - MGC-01 2000-01-12 15:19:51 
M  COMPLD
   "PROV-STP"
   ;

Comments:

Performance Impact Category: B


PROV-SYNC—Synchronize Provisioning Data

Purpose:

Copies the active configuration from the active Cisco PGW 2200 Softswitch host to the standby Cisco PGW 2200 Softswitch host, ensuring that both Cisco PGW 2200 Softswitch hosts are using the same configuration.

Note When you provision and add new signaling links or new CICS using the PROV-CPY command, you must reboot the standby system to synchronize the new objects in the active system to the standby. Not rebooting can cause loss of calls after a switch over.

Syntax:

prov-sync

Example:

The MML command shown in the following example copies the configuration from the active Cisco PGW 2200 Softswitch to the standby Cisco PGW 2200 Softswitch:

mml> PROV-SYNC

Comments:

Performance Impact Category: C, D; impact depends on the size of the data being synchronized.

Note Shutting down interfaces during a PROV-DPLY or PROV-SYNC can cause failover after bouncing. To correct this, shut down both the standby and active systems and restart them.


PROV-UNLOCK—Re-enable Provisioning


Note This command is obsolete and is not supported on Releases 9.7(3) and 9.8(1).


Purpose:

Unlocks the system when provisioning has been disabled by the use of the prov-lock command, during a system upgrade or downgrade.

Syntax:

prov-unlock

Example:

The MML command shown in the following example unlocks the system after a system upgrade or downgrade is complete:

mml> prov-unlock

Comments:

Performance Impact Category: B

This command enables the prov-add, prov-ed, prov-dlt, prov-sync, prov-cpy, and prov-deply commands after they have been disabled by the prov-lock command.


QUIT—End Session

Purpose:

Ends the MML session.

Syntax:

quit

Example:

mml> QUIT

Comments:

Performance Impact Category: A


 

R—Repeat Previously Entered Command

Purpose:

Repeats a previously entered command.

Syntax:

r[::<number>]

Input Description:

number—The command to repeat. For example, a value of 3 repeats the command issued before the two preceding commands. The default value is 1, which repeats the previous command.

Example:

The MML command shown in the following example repeats the preceding command (this is the same as using the up arrow):

mml> R

Example:

The MML command shown in the following example repeats the third to the last command:

mml> R::3

Comments:

Performance Impact Category: A