Configuring with MML

For more information on MML, including online help, operating tips, command syntax, and status message definitions, refer to Cisco Media Gateway Controller Software Release 7 Reference Guide.

Before starting an actual configuration, refer to "Provisioning Overview," for instructions and worksheets for configuring your system.

MML interfaces with the Provisioning Object Manager (POM). POM requires an active provisioning session to make provisioning changes. During an active session, POM locks all the data files to prevent other users from making changes.

Tips Keep these tips in mind when working with MML:

In general, MML commands are not case sensitive. However, file names are case sensitive when used as arguments in MML commands (for example, TKGFile, BCFFile, RoutingFile).
Keywords do not need to be enclosed in (" ").
Use only one MML command on each line.
After starting a provisioning session, MML displays COMPLD, indicating success. (This is true for all commands; for all failed commands, MML displays DENY.)
A provisioning session inactive for 30 minutes results in a warning. If the session continues without activity for five more minutes, the session terminates.
As many as 12 MML sessions may exist at any given time; however, only one provisioning session is allowed.
You can create an ASCII text file for batch processing of provisioning commands.
You can create batch files for individual segments of provisioned data.
During batch file execution, each MML command response echoes to the terminal. You can log command responses for later review so that the file can run unattended.
Place quotes around all value strings in your commands. For example, card="Interface1". The keyword card does not have to be enclosed in quotes. The value Interface1 is being assigned to keyword card and must be enclosed in quotes.
Online help is available in an MML session by typing help at the command prompt. For more information, refer to Cisco Media Gateway Controller Software Release 7 Reference Guide.

TimeSaver To repeat the last MML command you entered, press the Up Arrow key. To scroll through all the previous MML commands, continue to press the up arrow after pressing the Shift Starting an MML Session

You must start an MML session before you can start a provisioning session. To start an MML session:

Caution Do not log in as root when starting MML. If you log in as root, then attempt to start an MML session, it will cause an MML core dump and MML will not start.

Tips If another session is running, you receive a message similar to the following:

mml1: Already in use
Failure to run MML, reason=Entry was already present

To see other MML sessions that are running, enter:

     ps -ef |grep mml

If another provisioning session is running, you will be unable to start a provisioning session. To see if another provisioning session is running, use the PROV-RTRV command (refer to Retrieving Provisioning Session Information).

Saving the Session for Review

To save the provisioning session for review purposes, perform the following procedure.

Procedure

Step
Command
Purpose

1

mml>diaglog:pom-log-session-cie3:start
Creates a log file of the provisioning session, cie3, for later review.

For information about where the log is saved, refer to the Cisco Media Gateway Controller Software Release 7 Reference Guide.

2

mml>prov-sta::srcver="new",dstver="cie3-prov"
Creates a new configuration, cie3-prov.

Step	Command	Purpose
1	mml>diaglog:pom-log-session-cie3:start	Creates a log file of the provisioning session, cie3, for later review. For information about where the log is saved, refer to the Cisco Media Gateway Controller Software Release 7 Reference Guide.
2	mml>prov-sta::srcver="new",dstver="cie3-prov"	Creates a new configuration, cie3-prov.

Verify

View the log file.

Tips You can place the dialog commands to start and stop at the start and end of an MML batch file.

All MML commands are automatically logged to the mml.log file located in the /opt/TransPath/var/log directory (or /opt/CiscoMGC/var/log directory (for Release 7.4)).

Killing an Orphan Session

To kill a nonfunctioning configuration session, perform the following procedure.

Procedure

Command
Purpose

mml>prov-stp Virtual Switch Controller 1999-09-30 11:19:17 M COMPLD "PROV-STP" ;
Terminates the provisioning session, saves the configuration, and releases the lock on the configuration data files.

For information about where the log is saved, refer to the Cisco Media Gateway Controller Software Release 7 Reference Guide.

Command	Purpose
mml>prov-stp Virtual Switch Controller 1999-09-30 11:19:17 M COMPLD "PROV-STP" ;	Terminates the provisioning session, saves the configuration, and releases the lock on the configuration data files. For information about where the log is saved, refer to the Cisco Media Gateway Controller Software Release 7 Reference Guide.

Verify

View the log file.

Tips This command does not activate the new configuration.

Stopping a Session

To stop a configuration session, perform the following procedure.

Procedure

Command
Purpose

va-cerulean mml> quit va-cerulean%
Terminates the provisioning session.

For information about where the log is saved, refer to the Cisco Media Gateway Controller Software Release 7 Reference Guide.

Command	Purpose
va-cerulean mml> quit va-cerulean%	Terminates the provisioning session. For information about where the log is saved, refer to the Cisco Media Gateway Controller Software Release 7 Reference Guide.

Verify

View the log file.

Getting Help

To get help for a specific MML command, enter help: followed by the command you want help for, as shown in the following procedure.

Procedure

Command
Purpose

mml> help:prov-sync Virtual Switch Controller - VSC-01 2000-01-13 11:28:51 M RTRV PROV-SYNC - SYNCHRONIZE PROVISIONING DATA Purpose: This command copies the active configuration from the active telephony controller to the standby telephony controller, ensuring that both telephony controllers are using the same configuration. Format: PROV-SYNC Example: This command copies the configuration from the active to standby telephony controller:mml> PROV-SYNC
Obtains help for the MML command prov-sync.

For information on MML help, refer to the Cisco Media Gateway Controller Software Release 7 Reference Guide.

Command	Purpose
mml> help:prov-sync Virtual Switch Controller - VSC-01 2000-01-13 11:28:51 M RTRV PROV-SYNC - SYNCHRONIZE PROVISIONING DATA Purpose: This command copies the active configuration from the active telephony controller to the standby telephony controller, ensuring that both telephony controllers are using the same configuration. Format: PROV-SYNC Example: This command copies the configuration from the active to standby telephony controller:mml> PROV-SYNC	Obtains help for the MML command prov-sync. For information on MML help, refer to the Cisco Media Gateway Controller Software Release 7 Reference Guide.

MML Configuration Commands

There are two types of MML configuration commands:

Session commands—Use session commands to work with entire provisioning data filesets. See Table 5-1.
Component/Parameter commands—Use provisioning commands to perform actions on components or parameters affecting a specific data file. See Table 5-2.

Table 5-1: MML Configuration Session Commands

Command—Heading Description

PROV-STA —Start Provisioning Session

Starts a provisioning session to create a new configuration or to modify an existing configuration. The POM locks the data files to prevent other users from making changes.

PROV-CPY —Copy Provisioning Session

Copies configuration settings from the current provisioning session to the active MGC in a single MGC configuration, activates the configuration, and then terminates the current provisioning session. Requires an open provisioning session.

Note   You can use PROV-CPY on dual systems to change the configuration of one machine (for example, during upgrading). Use the PROV-SYNC command to resynchronize both machines.

Note   The PROV-CPY command terminates the current provisioning session only if it is successfully executed.

PROV-DPLY —Deploy Provisioning Session

Copies configuration settings from the current provisioning session to both MGCs in a dual MGC configuration, activates the configuration, and then terminates the current provisioning session. Requires an open provisioning session.

Note   The PROV-DPLY command terminates the current provisioning session only if it is successfully executed.

PROV-SYNC —Synchronize Provisioning Data

Copies the active configuration from the active MGC to the standby MGC in a dual MGC configuration to ensure that both MGCs are using the same configuration.

Note   You cannot perform a PROV-SYNC command in an open provisioning session. You must stop the provisioning session before using the PROV-SYNC command.

PROV-STP —Stop Provisioning Session

Stops the provisioning session and saves the configuration. It releases the lock on the configuration data files, but does not activate the new configuration.

PROV-EXP—Export Configuration Data.

Exports current configuration data routing plans, dial plans, configuration, or all three in MML-command form to the directory /opt/CiscoMGC/etc/cust_specific/directory name where the files names are:

config.mml

export_trunks.dat (if trunks are defined)

export_trkgrp.dat (if trunk groups are defined)

routing.mml

custGrpID.mml (for dial plans)

Table 5-2: MML Configuration Component/Parameter Commands

Command Description

PROV-ADD

Adds a component to the MGC configuration.

PROV-DLT

Deletes a provisioned component.

Note You cannot delete a component that is a parent of another component. For example, you cannot delete a linkset that contains links. You receive an error message when you try to delete a parent component.

PROV-ED

Edits a provisioned component.

PROV-RTRV

Retrieves the information about an existing provisioning session.

NUMAN-ADD

Adds an element to a dial plan table.

NUMAN-DLT

Deletes an element from a dial plan table.

NUMAN-ED

Edits an element in a dial plan table.

NUMAN-RTRV

Retrieves the information in a dial plan table.

Note For more information on these commands, refer to the Cisco Media Gateway Controller Software Release 7 Reference Guide.

Working with Session Commands

Use session commands to work with the entire set of provisioning data files.

Starting a Provisioning Session

Use the PROV-STA command to start a provisioning session when you want to:

Create a new configuration.
Modify an existing configuration.
Modify an existing configuration and save it as another version.
To copy a provisioning session, to deploy a provisioning session, or to synchronize a provision session.

Tips Although you can save to either the same version or a new version, saving to a new version instead of overwriting the old one gives you an easy way to return to a known configuration if there are problems with the new configuration.

Caution Do not name the destination directory "active" or "new." The name "active" and "new" have a special meaning in the Cisco MGC software.

Creating a New Configuration

To create a new configuration, use the PROV-STA command as follows:

Procedure

Command
Purpose

mml>prov-sta::srcver="new",dstver="ver1" Virtual Switch Controller 1999-07-13 17:35:42 M COMPLD "PROV-STA"
Starts a new provisioning session ("new"), names it CFG_ver1, and saves the configuration files at /opt/TransPath/etc/CONFIG_LIB/CFG_ver1
or /opt/CiscoMGC/etc/CONFIG_LIB/CFG_ver1 (for Release 7.4).

Command	Purpose
`mml>`prov-sta::srcver="new",dstver="ver1" `Virtual Switch Controller 1999-07-13 17:35:42` `M COMPLD` `"PROV-STA"`	Starts a new provisioning session ("new"), names it CFG_ver1, and saves the configuration files at /opt/TransPath/etc/CONFIG_LIB/CFG_ver1 or /opt/CiscoMGC/etc/CONFIG_LIB/CFG_ver1 (for Release 7.4).

Verify

Use the PROV-RTRV command to verify that your new configuration has been saved.

Tips The Cisco MGC Software Release 7 appends CFG_ in front of any user-supplied destination version name. For example, ver1 becomes CFG_ver1.

Modifying an Existing Inactive Configuration

To modify an existing inactive configuration, use the PROV-STA command as follows:

Procedure

Command
Purpose

mml>prov-sta::srcver="ver1",dstver="ver1" Virtual Switch Controller 1999-07-16 10:04:02 M COMPLD "PROV-STA"
Starts a provisioning session, opens the existing configuration named ver1, and overwrites that configuration.

Command	Purpose
mml>prov-sta::srcver="ver1",dstver="ver1" Virtual Switch Controller 1999-07-16 10:04:02 M COMPLD "PROV-STA"	Starts a provisioning session, opens the existing configuration named ver1, and overwrites that configuration.

Verify

Use the PROV-RTRV command to verify that the modified configuration has been saved.

Tips To modify an existing configuration directory, the srcver and dstver must be the same. Then the original configuration is overwritten by the new 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.

Caution If the source configuration specified is new, the software does not allow you to overwrite an existing configuration. For example, if a provisioning directory "CFG_ver1" exists, the following command fails:

mml>prov-sta:srcver"new", dstver="ver1"

Note In Release 7.3, an existing non-active configuration cannot be overwritten; however, in Release 7.4, an existing non-active configuration can be overwritten.

Modifying an Active Configuration

To modify an existing configuration and save it as another version, use the PROV-STA command as follows:

Procedure

Command	Purpose
mml>prov-sta::srcver="active",dstver="ne_ac tive" Virtual Switch Controller 1999-07-16 10:08:48 M COMPLD "PROV-STA"	Starts a provisioning session, selects the active configuration as the source for configuration change, and saves the configuration as new_active.

Command

Purpose

mml>prov-sta::srcver="active",dstver="ne_ac
tive" Virtual Switch Controller 1999-07-16 
10:08:48
M  COMPLD
   "PROV-STA"

Starts a provisioning session, selects the active configuration as the source for configuration change, and saves the configuration as new_active.

Verify

Use the PROV-RTRV command to verify that the existing configuration has been saved as another version.

Tips dstver cannot be the same as the existing directory name; otherwise, you override the existing configuration.

A provisioning session inactive for 30 minutes results in a warning. If the session continues without activity for five more minutes, it terminates.

Modifying an Existing Configuration and Saving It as Another Version

To modify an existing configuration and save it as another version, use the PROV-STA command as follows:

Procedure

Command	Purpose
mml>prov-sta::srcver="ver1",dstver="ver2"Vi rtual Switch Controller 1999-07-16 10:08:48 M COMPLD "PROV-STA"	Starts a provisioning session, opens the existing configuration named ver1, and saves the configuration as ver2.

Command

Purpose

mml>prov-sta::srcver="ver1",dstver="ver2"Vi
rtual Switch Controller 1999-07-16 10:08:48
M  COMPLD
   "PROV-STA"

Starts a provisioning session, opens the existing configuration named ver1, and saves the configuration as ver2.

Verify

Use the PROV-RTRV command to verify that the existing configuration has been saved as another version.

Tips A provisioning session inactive for 30 minutes results in a warning. If the session continues without activity for five more minutes, it terminates.

Committing a Provisioning Session to a Single MGC

To direct the POM to make the data files that belong to the current provisioning session operational on a single MGC and then terminate the POM session, use the PROV-CPY command as follows:

Procedure

Command
Purpose

mml> PROV-CPY
Copies configuration settings from the current provisioning session to the active MGC in a single MGC configuration, and then activates the configuration.

Command	Purpose
mml> PROV-CPY	Copies configuration settings from the current provisioning session to the active MGC in a single MGC configuration, and then activates the configuration.

Tips The difference between the PROV-CPY command and the PROV-DPLY command is that the PROV-DPLY command applies the configuration changes to dual MGC configurations, while the PROV-CPY command applies the configuration changes to single MGC configurations only.

To avoid errors before a complete configuration change, execute the following MML commands before executing prov-cpy:

mml>stp-softw:eng-01:kill
mml>stp-softw:iosg-01:kill

Due to the dependency of other processes, execute the following MML command to determine the processes status:

mml>rtrv-softw:all

Virtual Switch Controller - VSC-01 2000-01-13 11:42:51
M  RTRV
"CFM-01:RUNNING"
"ALM-01:RUNNING"
"MM-01:RUNNING"
"AMDMPR-01:RUNNING"
"CDRDMPR-01:RUNNING"
"MMDB-01:RUNNING"
"POM-01:RUNNING"
"MEASAGT-01:RUNNING"
"OPERSAGT-01:RUNNING"
"PROVSAGT-01"RUNNING"
"PRIIP-1:STOPPED"
"Replic-01:RUNNING"
"ENG-01:STOPPED"
"IOCM-01:STOPPED"
"TCAP-01:STOPPED"
"IOCC-ASP:STOPPED"
"FOD-01:RUNNING"
"PRIIP-2:STOPPED"
"SS7-A-1:STOPPED"

After successfully completing the prov-cpy, you need to restart the processes by using the following MML commands:

mml>sta-softw:iosg-01:01
mml>stp-softw:eng-01:01

Verify

Use the PROV-RTRV-softw:all command to processes are all running.

Use the PROV-RTRV:session command to verify your configuration.

Deploying a Provisioning Session to Dual MGCs

To direct the POM to make the data files that belong to the current POM session operational, to copy the data files to the standby MGC, and then to terminate the POM session, use the PROV-DPLY command as follows:

Procedure

Command
Purpose

mml> PROV-DPLY
Copy configuration settings from the current provisioning session to both MGCs in a dual MGC configuration, and then activate the configuration.

Command	Purpose
mml> PROV-DPLY	Copy configuration settings from the current provisioning session to both MGCs in a dual MGC configuration, and then activate the configuration.

Verify

Use the PROV-RTRV:session command to verify your configuration.

Tips A provisioning session inactive for 30 minutes results in a warning. If the session continues without activity for five more minutes, it terminates.

The difference between the PROV-CPY command and the PROV-DPLY command is that the PROV-DPLY command applies the configuration changes to dual MGC configurations and the PROV-CPY command applies the configuration changes to a single MGC configuration.

Synchronizing Configuration Data

To synchronize the configuration data between two MGCs, use the PROV-SYNC command as follows:

Procedure

Command
Purpose

mml> PROV-SYNC
Copies the configuration data from the active MGC to the standby MGC to ensure that both MGCs are using the same configuration.

Command	Purpose
mml> PROV-SYNC	Copies the configuration data from the active MGC to the standby MGC to ensure that both MGCs are using the same configuration.

Verify

Use the PROV-RTRV:session command to verify your configuration.

Tips The configuration data always goes from the active MGC to the standby MGC.

You cannot perform the PROV-SYNC command with an open provisioning session.

Stopping a Configuration Session

To save all changes made during the configuration session and terminate the session with the POM, use the PROV-STP command as follows:

Procedure

Command
Purpose

mml> PROV-STP Virtual Switch Controller 1999-06-16 11:19:17 M COMPLD
Stop the provisioning session and save your configuration changes to the destination version specified when the session was started.

mml> PROV-STP:<session name>:confirm
Stop a provisioning session started from another MML or CMM session.

Verify

On successful completion of this command, the POM releases the lock on the configuration data files.

Tips This command saves the new configuration but does not activate it. You must use the PROV-CPY or PROV-DPLY commands to activate the configuration.

Caution Quitting an MML session does not stop the session. While inactive sessions terminate, the only commands that can stop a session are PROV-STP, PROV-CPY, or PROV-DPLY.

Performing a Manual Switchover (Release 7.4)

To enable a switchover from an active to a standby system, use the SW-OVR command as follows:

Procedure

Command
Purpose

mml>sw-ovr::CONFIRM Virtual Switch Controller 1999-04-02 17:06:23 M COMPLD
Performs a manual switchover.

Verify

Use the RTRV-NE command to verify. For information on this command, refer to the Cisco Media Gateway Controller Software Release 7 Reference Guide.

The standby system becomes active in less than two seconds after the switchover.

Exporting Configuration Data (Release 7.4)

To export core configuration data (signaling paths, SS7 nodes, trunks, trunk groups), routing plans, dial plans, use the PROV-EXP command.

The following are key points to understand when exporting routing and dial plan information:

If a provisioning session exists, the PROV-EXP command uses the provisioning link as the source of the data to be exported. If no provisioning session exists, this command uses the active link as the source of the data to be exported.
If the directory indicated with DIR_NAME already exists, the PROV-EXP command fails. This ensures that current files generated by previous PROV-EXP commands are not overwritten by a subsequent PROV-EXP command.

Procedure

Command
Purpose

mml> prov-exp:config:dirname="saved_config" Virtual Switch Controller 1999-06-16 11:19:17 M COMPLD
Exports configuration data in MML format to the file: /opt/TransPath/etc/cust_specific/saved_config
or
/opt/CiscoMGC/etc/cust_specific/saved_config
(for Release 7.4).

The file contains the MML commands for all of the configuration data..

mml> prov-exp:routing:dirname="saved_config" Virtual Switch Controller 1999-06-16 11:19:17 M COMPLD
Exports routing data in MML format to the file:

/opt/TransPath/etc/cust_specific/saved_config
or
/opt/CiscoMGC/etc/cust_specific/saved_config
(for Release 7.4).

The file contains the MML add/edit commands for all of the data in the route analysis file.

mml> prov-exp:numan:dirname="saved_config" Virtual Switch Controller 1999-06-16 11:19:17 M COMPLD
Exports dial plan data in MML format to the file: /opt/TransPath/etc/cust_specific/saved_config
or
/opt/CiscoMGC/etc/cust_specific/saved_config
(for Release 7.4).

The file contains MML commands for all of the data in the dial plan. The first line of the created file will contain an MML command to create the dial plan.

mml> prov-exp:all:dirname="saved_config" Virtual Switch Controller 1999-06-16 11:19:17 M COMPLD
Exports configuration, routing, and dial plan data in MML format to the file: /opt/TransPath/etc/cust_specific/saved_config
or
/opt/CiscoMGC/etc/cust_specific/saved_config
(for Release 7.4).

The file contains the MML commands for all of the data in the configuration, route analysis, and dial plan files.

Verify

Examine the exported data to verify.

If trunks and trunk groups are defined, a file for the trunks and a file for the trunk groups will also be generated as part of the command to export configuration data. The files export_trunks.dat and export_trkgrp.dat are placed in the same directory created by the initial PROV-EXP command. An MML command to import the generated files is appended to the end of the config.mml file to import the trunk and trunk group files. These commands look like this:

prov-add:files:name="TKGFile", file="<dir_name>/export_trkgrp.dat", action="import" 
prov-add:files:name="BCFile", file="<dir_name>/export_trunks.dat", action="import"

Importing Saved MML Configuration Data (Release 7.4)

To import previously exported configuration data, batch MML can be used as follows:

From a UNIX prompt, enter the following command to import previously exported configuration data:

mml -b /opt/CiscoMGC/etc/cust_specific/dumpdir/config.mml

To import all the configuration data:

Command
Purpose

mml> prov-exp:all:dirname=saved_config Virtual Switch Controller 1999-06-16 11:19:17 M COMPLD
Saves the following files in the /opt/CiscoMGC/etc/cust_specific/saved_config file:

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 number of dial plans defined)

To import all configuration data from the directory "saved_config" in the previous procedure, use the following UNIX commands, which execute MML in batch mode, in the following order:

mml -b /opt/CiscoMGC/etc/cust_specific/saved_config/config.mml 

mml -b /opt/CiscoMGC/etc/cust_specific/saved_config/routing.mml 

mml -b /opt/CiscoMGC/etc/cust_specific/saved_config/<CustGrpID>.mml

To export the MML trunk group file, use the following MML commands:

prov-add:files:name="TKGFile",file="trunkGroupCust.dat",action="export" 
prov-ed:files:name="TKGFile",file="trunkGroupCust.dat",action="export"

Working with Provisioning Commands

Use provisioning commands to work with components, parameters, and properties.

Components—Describe physical and logical entities such as external switches, signaling links, and signaling services.
Parameters—Are defined when you create or modify a component. For example, when you add a signaling service, the options that you specify when you create the service are called parameters.

Note Although parameters are often called options or properties, properties have a specific meaning in this section.

Properties—Are options that are applied to a linkset or signaling service or trunk groups when you create the linkset or service. A default set of properties is assigned to each linkset and signaling service. The default property settings should work for most installations. You can override them to customize your installation.

Use the MML provisioning commands for:

Adding a Component

To add a component to the MGC configuration, use the PROV-ADD command as follows:

Procedure

Command
Purpose

mml> prov-add:ptcode:name="opc", desc="Point code of CP1", netaddr="0.0.1", netind=2 Virtual Switch Controller 1999-06-16 11:28:17 M COMPLD "ptcode"
Add a point code with the MML name of opc, a component description of point code for CP1, a netaddr parameter of 0.0.1, and a netind of 2.

Verify

To verify the new component, use the PROV-RTRV command.

Tips After you add a system component, you can change the value of most parameters at any time. However, you cannot change the component type or name, because these attributes uniquely identify the component you are modifying. To change the type or name of a component, you must delete the component and create a new component with a new type and name.

If you want to use a component's default values, you do not have to specify any parameters. For information on component default parameters, refer to "Planning for Provisioning."

Modifying a Component

To modify a provisioning object within the data files, use the PROV-ED command as follows:

Procedure

Command
Purpose

mml> prov-ed:ptcode:name="opc", desc="Point code for this SSP" Virtual Switch Controller 1999-06-16 11:32:09 M COMPLD "ptcode"

Changes the description of a provisioned point code named opc.

Verify

After you enter the command to modify a component, the component is changed. To verify the change, use the PROV-RTRV command.

Tips Enter only those parameters that you want to modify.

Deleting a Component

To remove a component from the MGC configuration, use the PROV-DLT command as follows:

Procedure

Command
Purpose

mml> prov-dlt:ptcode:name="opc" Virtual Switch Controller 1999-06-16 11:42:45 M COMPLD "ptcode"
Deletes the point code component named opc.

Verify

To verify that the component is removed, use the PROV-RTRV:ALL command.

Tips Component types are in the Cisco Media Gateway Controller Software Release 7 Reference Guide. If you cannot remember the name of a component, use the PROV-RTRV:ALL command to display all components.

You cannot delete a component that is a parent of another component. For example, you cannot delete a linkset that contains links. You receive an error message when you try to delete a parent component.

Overriding Component Properties

To override component properties for an existing provisioning component, use the PROV-ADD command as follows:

Procedure

Command
Purpose

mml>prov-add:propertyType:name="name",propert y=value mml>prov-add:sigserv:name="ss7srv1", alarmcarrier="1"
Each command adds a property to a different signaling service.

The property override value is added to the configuration the current session is modifying.

Verify

To view the component configuration, use the PROV-RTRV command as described in the "Retrieving Provisioning Session Information" section.

Tips Working with properties is similar to working with components, but there are differences. For example, when you create a component, you have to define values for all the component parameters. However, you never have to create a component property, because a set of default properties is automatically created when you create a component. If you want to change a default property value, you must override that value.

For information on components, parameters, and properties, refer to "Planning for Provisioning."

After overriding a property value with the PROV-ADD command, an override statement is added to the configuration file for a specific linkset or signaling service property. Do not use additional PROV-ADD commands to change the overridden property value. Use the PROV-ED command to modify overridden property values, as explained in the "Changing Overridden Properties" section.

Changing Overridden Properties

To modify a provisioning object within the data files, use the PROV-ED command as follows:

Procedure

Command
Purpose

mml> prov-ed:alarmcarrier:NAME="ss7srv1", alarmcarrier="2" Virtual Switch Controller 1999-09-30 11:32:09 M COMPLD "alarmcarrier"
Change the SS7 signaling service (ss7srv1) overridden property (alarm carrier) value to 2 for a different alarm carrier (hardware carrier).

Verify

After you enter the PROV-ED command, the property value is changed. To view the component configuration, use the PROV-RTRV command.

Tips There are two property types: lnksetprop and sigsvcprop. The lnksetprop property type changes properties for a linkset, and the sigsvcprop property type changes properties for a signaling service. The name parameter in the command above specifies a specific linkset or signaling service that you have already defined. Replace the property parameter with the property name. For more information on these property types, refer to the "Planning for Provisioning."

Note For software release 7.4(x), there is a property type: TRNKGRPPROP. The TRNKGRPPROP property type supports trunk group provisioning. For more information, refer to "Overriding the Trunk Group Property (Release 7.4)" section.

Retrieving All Components

To retrieve all configured components, use the PROV-RTRV command as follows:

Procedure

Command Purpose

mml> prov-rtrv:all /* Name Parent Name TID Description ---- ----------- --- ----------- "TKGFile" "LPC-01" TRNKGRP "" "BCFile" "LPC-01" BEARCHAN "" "TrkRtFile" "LPC-01" TRNKROUTE "" "Ether1" "LPC-01" CARD "Motherboard 1" "Ether2" "LPC-01" CARD "Motherboard 2" "en1" "Ether1" ENETIF "Ethernet IF 1" "en2" "Ether2" ENETIF "Ethernet IF 2" "ls1" "stp1" LNKSET "Link Set 1" "route1" "LPC-01" SS7ROUTE "route to dpc1 via ls1" "opc" "LPC-01" PTCODE "Own Pointcode" "dpc1" "LPC-01" PTCODE "Dest Point Code 1" "dpc2" "LPC-01" PTCODE "Dest Point Code 2" "ss7svc1" "dpc1" SS7PATH "SS7 Service to DPC1" "ss7svc2" "dpc2" SS7PATH "SS7 Service to DPC2" "ls1link1" "ls1" C7IPLNK "SS7 link 1 to SP1" "stp1" "LPC-01" APC "STP 1 Point Code" "stp2" "LPC-01" APC "STP 2 Point Code" "mate1" "LPC-01" SS7SUBSYS "mate stp1 to stp2" */
Displays all configured components. A provisioning session is not required.

Tips Component types and component parameters are listed in the Cisco Media Gateway Software Release 7 Reference Guide. If you cannot remember the name of a component, use the PROV-RTRV:ALL command to display all components.

Retrieving All Components of a Specific Type

In software release 7.4(x), to retrieve all the components of a specific type, use the PROV-RTRV command as follows:

Procedure

Command
Purpose

mml> prov-rtrv:card:"ALL" Virtual Switch Controller 1999-11-10 15:17:55 M RTRV "session=tmp:CARD" /* NAME TYPE SLOT card1 EN 0 card2 EN 1
Retrieves all the components associated with the component named "card".

Verify

To verify the retrieve, use the PROV-RTRV command. (VALID ONLY for Release 7.4)

Retrieving an Individual Component

To display an individual component that is configured on the MGC, use the PROV-RTRV command as follows:

Procedure

Command
Purpose

mml> prov-rtrv:enetif:name="en2" Virtual Switch Controller 1999-07-20 20:39:14 M RTRV "enetif" /* NAME = en2 DESC = Ethernet IF 2 CARD = Ether2 */
Retrieves the attributes associated with the Ethernet interface component named "en2".

Tips If you cannot remember the name of a component, use the PROV-RTRV:ALL command to display all components.

Retrieving Protocol Variants

To retrieve the signaling protocol variants available on the MGC, use the PROV-RTRV:VARIANTS command as follows:

Procedure

Command
Purpose

mml>prov-rtrv:variants /* MDO File name Protocol Family ------------- -------------- DPNSS_BTNR188 DPNSS ETSI_300_102 ISDNPRI ETSI_300_102_C1 ISDNPRI ATT_41459 ISDNPRI ATT_41459_C2 ISDNPRI BELL_1268 ISDNPRI ETSI_300_172 ISDNPRI BELL_1268_C3 ISDNPRI NTT_INS_1500 ISDNPRI T113_BELL SS7-ANSI NORTEL_IBN7 SS7-ANSI ANSISS7_SPRINT SS7-ANSI ANSISS7_STANDARD SS7-ANSI Q721_CHINA SS7-China Q721_BASE SS7-China Q767_BASE SS7-ITU ETSI_300_356 SS7-ITU BTNUP_BTNR167 SS7-ITU BTNUP_NRC SS7-ITU Q767_SPAN SS7-ITU Q761_BASE SS7-ITU HKTA_2202 SS7-ITU ISUPV2_FRENCH SS7-ITU ETS_300_121 ISDNPRI ISUPV2_SWISS SS7-ITU ISUPV2_GERMAN SS7-ITU FINLAND_5779 SS7-ITU Q761_AUSTRL SS7-ITU ISUPV1_POLI SS7-ITU ISUPV2_KPNPB SS7-ITU ISUPV2_JAPAN SS7-NTT ISUPV3_UK SS7-UK Q761_BELG_MOBI SS7-ITU Q767_ITAL SS7-ITU Q767_RUSS SS7-ITU EISUP EISUP */
To display the signaling protocol variants on the MGC.

Tips A provisioning session is not required.

Retrieving Provisioning Session Information

To obtain information about the provisioning session, for example, if there is an active session, use the PROV-RTRV command as follows:

Procedure

Command
Purpose

mml> prov-rtrv:session Virtual Switch Controller 1999-07-16 10:32:01 M RTRV "session" /* Session ID = mml1 SRCVER = ver1 DSTVER = ver1 */
To display information about the provisioning session.

Adding an Element to a Dial Plan Table

To add an element to a dial plan table, use the NUMAN-ADD command as follows:

Procedure

Command
Purpose

mml>numan-add:resulttable:custgrpid="t666",in dex="1", resulttype="route" Virtual Switch Controller 1999-09-30 11:54:46 M COMPLD
Adds a route element to the dial plan result table.

Verify

To verify the change, use the NUMAN-RTRV command.

Deleting an Element from a Dial Plan Table

To delete an element from a dial plan table, use the NUMAN-DLT command as follows:

Procedure

Command
Purpose

mml>numan-dlt:resultset:custgrpid="t666",name="ra 4" Virtual Switch Controller 1999-09-30 11:54:46 M COMPLD
Removes a resultset component from the dial plan.

Verify

To verify the change, use the NUMAN-RTRV command.

Editing an Element in a Dial Plan Table

To edit an element in a dial plan table, use the NUMAN-ED command as follows:

Procedure

Command
Purpose

mml>numan-ed:npi:custgrpid="t666",npiblock=1, setname="ra2" Virtual Switch Controller 1999-09-30 11:54:46 M COMPLD
Changes the npi table in the dial plan.

Verify

To verify the change, use the NUMAN-RTRV command.

Updating a Change in a Dial Plan Table

After editing an element in a dial plan table, use the CHG-DPL command as follows:

Procedure

Command
Purpose

mml> mml> chg-dpl::custgrpid="t666" Virtual Switch Controller 1999-09-30 11:54:46 M COMPLD
Updates the dial plan for customer group t666.

Verify

To verify the change, use the NUMAN-RTRV command. (VALID ONLY for Release 7.4)

Retrieving an Element in a Dial Plan Table

To retrieve an element in a dial plan table, use the NUMAN-RTRV command as follows:

Procedure

Command
Purpose

mml>numan-rtrv:bdigtree:custgrpid="t666",index=39 Virtual Switch Controller 1999-09-30 11:54:46 M COMPLD
Retrieves an element from the bdigtree table in the dial plan.

Creating a Batch File

You can create a file of MML provisioning commands for use as a batch file. All commands go into a single ASCII text file that, when read by MML, are executed sequentially.

Note It is important that the MML provisioning commands are in the correct provisioning sequence based on component dependencies. For example, a line interface cannot be provisioned before the card.

Some advantages to using an MML provision batch file are that you can cut and paste commands and the batch files can be used repeatedly to "re-provision" the MGC or to quickly provision multiple MGCs.

You can create an MML batch file by using any ASCII text editor. Simply enter each MML provisioning command on a single line, ending with a carriage return. You can use any name for the file (use the UNIX file naming convention) and you can copy and paste components.

To create a batch file, use an ASCII text editor program to create a new file with one MML command on each line. You can use any name for the file and you can store it in any location; however, the file must be accessible on the machine where you run MML sessions.

Example 5-1: Sample MML Provisioning Batch File

prov-sta::srcver="new",dstver="oldyella"
prov-add:ptcode:name="opc",netaddr="111.111.666",netind=1,desc="originating Pointcode"
prov-add:ptcode:name="dpc1",netaddr="444.777.444",netind=2,desc="TDM Switch dpc1 
Pointcode"
prov-add:ptcode:name="dpc2",netaddr="555.333.555",netind=3,desc="Host Node dpc2 
Pointcode"
prov-add:apc:name="apc1",netaddr="666.222.222",desc="STP 1 APC pointcode",netind=1
prov-add:apc:name="apc2",netaddr="777.333.333",desc="STP 2 APC pointcode",netind=2
prov-add:apc:name="apc3",netaddr="888.777.777",desc="STP 3 APC pointcode",netind=3
prov-cpy

Notice that the first command starts a provisioning session and the last command terminates and commits the provisioning session. If you are not ready to commit a session then use the prov-stp command to save and stop the provisioning session.

The prov-cpy or prov-dply commands make the provisioning session active and then automatically stop the provisioning session.

Also notice that the commands in the file do not configure a complete system. You can create batch files to define complete systems or modify parts of an existing system.

Note If you want to test the batch file before you use it, use the prov-stp command.

If you plan to run the batch file multiple times on the same host, plan the source and destination directories carefully.

Note The example shown above would fail if run twice, because the destination directory already exists.

In this example, you could edit the batch file after the first execution and replace the source version name with the destination version name. Future executions of the batch file would then replace the previous configuration. For more information on the source and destination directories, refer to the "Starting a Provisioning Session" section.

Note If any of the provisioning commands fail in the batch mode, the changes do not become active. The PROV-CPY and PROV-DPLY commands fail, indicating that some of the provisioning commands in the batch file have failed.

Starting a Batch File

To start executing the batch file, use the following UNIX command:

Procedure

Command
Purpose

mml -b path/filename.ext
To execute the MML commands in the batch file.

Replace the path parameter with the absolute path to the file, and replace the filename.ext parameter with the filename of the batch file containing the provisioning commands.

Verify

After you enter the command, MML displays the result of each command as it is executed. When the batch file is done, the MML session is closed.

Tips MML provides a log function that records the MML commands and responses for you in a log file. If you start this function before you start the provisioning session and stop it after you stop the provisioning session, you can let the batch file run unattended and then check the log file later for any error messages. The log command is called diaglog. For more information on using this command, refer to the Cisco Media Gateway Software Release 7 Reference Guide.

The dialog commands to start and stop can be placed at the beginning and end, respectively, of an MML batch file.

All MML commands are automatically logged to the mml.log file located in the /opt/TransPath/var/log directory (or /opt/CiscoMGC/var/log directory (for Release 7.4)). A sample log file is shown below:

va-cerulean% more mml.log.4
Sat Jan  8 04:10:01:694 2000 | mml11 (PID 24954) <Info>
MML_INFO_COMMAND: MML Command
Sat Jan  8 04:10:06:218 2000 | mml11 (PID 24954) <Info>
MML_INFO_COMMAND: MML Command
mml> sta-aud
   Virtual Switch Controller - VSC-01 2000-01-08 04:10:06
M  RTRV
   SABT
   /* Status, Command Aborted - Command has timed out
     without successful completion of operation
     Some operations may have completed successfully */
va-cerulean%

Command	Purpose
mml> prov-exp:config:dirname="saved_config" Virtual Switch Controller 1999-06-16 11:19:17 M COMPLD	Exports configuration data in MML format to the file: /opt/TransPath/etc/cust_specific/saved_config or /opt/CiscoMGC/etc/cust_specific/saved_config (for Release 7.4). The file contains the MML commands for all of the configuration data..
mml> prov-exp:routing:dirname="saved_config" Virtual Switch Controller 1999-06-16 11:19:17 M COMPLD	Exports routing data in MML format to the file: /opt/TransPath/etc/cust_specific/saved_config or /opt/CiscoMGC/etc/cust_specific/saved_config (for Release 7.4). The file contains the MML add/edit commands for all of the data in the route analysis file.
mml> prov-exp:numan:dirname="saved_config" Virtual Switch Controller 1999-06-16 11:19:17 M COMPLD	Exports dial plan data in MML format to the file: /opt/TransPath/etc/cust_specific/saved_config or /opt/CiscoMGC/etc/cust_specific/saved_config (for Release 7.4). The file contains MML commands for all of the data in the dial plan. The first line of the created file will contain an MML command to create the dial plan.
mml> prov-exp:all:dirname="saved_config" Virtual Switch Controller 1999-06-16 11:19:17 M COMPLD	Exports configuration, routing, and dial plan data in MML format to the file: /opt/TransPath/etc/cust_specific/saved_config or /opt/CiscoMGC/etc/cust_specific/saved_config (for Release 7.4). The file contains the MML commands for all of the data in the configuration, route analysis, and dial plan files.

Table of Contents

Configuring with MML