Table Of Contents
Voice Services Provisioning Tool Overview
Provisioning Introduction
VSPT Introduction
Installing the VSPT
Prerequisites
Preplanning
Upgrading VSPT Software
Saving Configuration Files
Uninstalling the VSPT Software
Installing the VSPT Software
VSPT Basics
VSPT Field Definitions
VSPT Data Entry Requirements
Starting the VSPT
Using the VSPT
Menu Bar
Buttons
Defining Users and Permissions
Exiting the VSPT
Voice Services Provisioning Tool Overview
Cisco Open Packet Telephony (OPT) provides the framework for delivering voice services over packet-based data, voice, and video networks. OPT encompasses a broad range of hardware platforms and Cisco software, delivering a continuum of voice solutions from core infrastructure to enhanced services over circuit and packet networks. The Cisco Media Gateway Controller (MGC) is at the center of Cisco OPT solutions.
Provisioning a Cisco MGC is the process of preparing it to communicate with an SS7 network, with Cisco media gateways, and with the other components of an OPT solution. The Cisco Voice Services Provisioning Tool (VSPT) provides an easy-to-use graphical tool to provision Cisco MGCs.
Individual releases of the VSPT are designed to be used with specific releases of the Cisco MGC software. VSPT Version 2.3(2) is designed to be used with Cisco MGC Version 9.3(2). If you are using a different release of the Cisco MGC software, see Table 1-1to identify the release of VSPT that you need.
This chapter introduces the VSPT and provides directions for obtaining, installing, and using the software.
This chapter contains the following sections:
•
Provisioning Introduction
•
VSPT Introduction
•
Installing the VSPT
•
VSPT Basics
•
Starting the VSPT
•
Using the VSPT
•
Defining Users and Permissions
•
Exiting the VSPT
Provisioning Introduction
All solutions involving the Cisco MGC are configured through the use of one or more Cisco MGC hosts, one or more Signaling System 7 (SS7) network signaling options, and one or more media gateways that control bearer-traffic routing.
Note
In this document, a solution is a logical combination of Cisco hardware and software configured to perform a specific network task.
Prior to starting any provisioning session, you should have a clear understanding of the network topology for your solution. Create a network drawing, and refer to it while configuring your network.
In addition, you should perform the following tasks before starting a provisioning session:
•
Thoroughly plan your network configuration. Refer to the documentation for your solution for detailed network configuration information.
•
Set up your system hardware, and install all required software. For more information, refer to Prerequisites, and the Cisco Media Gateway Controller Software Version 9 Installation and Configuration Guide at
http://www.cisco.com/univercd/cc/td/doc/product/access/sc/rel9/swinstl/index.htm
VSPT Introduction
The VSPT allows you to import an existing configuration, modify the configuration, and export it to the same or different devices. Wizards guide you through high-level configuration steps to create the initial network provisioning information for a newly installed node, creating iterative entries from a single operation. The VSPT can also facilitate provisioning of individual call parameters, simplifying the provisioning of a large live network.
Using the VSPT helps avoid common errors that might arise if devices are provisioned independently, eliminates the need to enter duplicate data, and enables importing and exporting configurations to and from the Cisco PGW 2200. The VSPT generates configuration files necessary to provision the PGW 2200, including the following provisioning information:
•
Signaling
•
Trunk groups
•
Trunks
•
Routes
•
Dial plans
The VSPT also allows provisioning Cisco Media Gateways (MGX), specifically the Cisco MGX 8850 with the Voice Interworking Service Module (VISM) Version 2.1, 2.2, 3.0, and 3.1. With the VSPT, you can carry out Cisco MGX 8850 chassis provisioning tasks and VISM provisioning tasks.
During a provisioning session, the VSPT automatically generates the Man Machine Language (MML) or command line interface (CLI) scripts used to configure network elements, assembles these commands into a batch file, and deploys the file to the appropriate network device.
The VSPT allows scheduled backups and restores of configurations on the following devices:
•
The Cisco MGC host (active configuration)
•
BAMS Phase2 (active configuration)
•
BAMS Phase3 (active configuration of the system, plus eight nodes)
•
The Cisco SLT 2600 (running configuration and image on flash)
•
The Cisco Catalyst 5500 (configuration and image on flash)
•
The Cisco Catalyst 2900XL (running configuration and image on flash)
The VSPT can be deployed as an integrated component of the Cisco MGC Node Manager or as a standalone application. If it is installed on the Cisco MGC, call throughput might be impacted when the VSPT is active. It typically runs on a standalone UNIX server that is also running the Cisco MGC Node Manager (Cisco MNM) and supports multiple users and provisioning sessions. You can launch the VSPT from the managed object icon in the CMNM map viewer. For information about Cisco MNM, refer to the Cisco MNM User's Guide Version 2.3(2) at
http://www.cisco.com/univercd/cc/td/doc/product/access/sc/rel9/cmnm232/index.htm
This document is designed to help you get started using the VSPT, and does not include complete provisioning instructions, which are found in the Cisco Media Gateway Controller Software Version 9 Provisioning Guide at
http://www.cisco.com/univercd/cc/td/doc/product/access/sc/rel9/prvgde/index.htm, in particular Chapter 3, Provisioning with the Voice Services Provisioning Tool at
http://www.cisco.com/univercd/cc/td/doc/product/access/sc/rel9/prvgde/r9gui.htm
Detailed instructions for provisioning dial plans are covered in the Cisco Media Gateway Controller Software Version 9 Dial Plan Guide at
http://www.cisco.com/univercd/cc/td/doc/product/access/sc/rel9/dplan/index.htm, in particular Chapter 3, "Provisioning Dial Plans with the VSPT", at
http://www.cisco.com/univercd/cc/td/doc/product/access/sc/rel9/dplan/dp_vspt.htm
Installing the VSPT
If you are a registered Cisco.com user, you can download the VSPT software from the Cisco web site. You must install the VSPT release that is compatible with your Cisco MGC software. This document describes the installation and use of VSPT Version 2.3(2). Refer to Table 1-1 for a guide to Cisco MGC and VSPT software release compatibility.
Table 1-1 VSPT & Cisco MGC Software Version Compatibility
VSPT Software Version
|
Cisco MGC Software Version
|
BAMS Software Version
|
New Features Added
|
VSPT 2.3(2)
|
Cisco MGC Version 9.3(2)
|
BAMs Phase 2, BAMS Phase 3 (3.10)
|
Support for provisioning features new in Cisco MGC Version 9.3(2) including:
• Calling party category (CPC), transmission medium requirements (TMR), transit network selection (TNS), codec call type, and percentage-based routing (PBR)
• Enhanced H.323 services
• Dual CLI interworking with Voice over IP network, both signaling path and call control
• Configurable ISUP timers
• Polish ISUP Version 2
• Improved SIP failover support
• Range checking of properties
• Support for BAMS NICS output
• Support for BAMS 1110 output
• Support for VISM VoATM operating mode
|
VSPT 2.3(1)
|
Cisco MGC Version 9.3(1)
|
BAMs Phase 2, BAMS Phase 3 (3.10)
|
• Backup and restore of the HSI adjunct
• VISM 2.2 and 3.0 Support
• Backup and restore of the Catalyst 6509 when used as the PGW node's LAN switch
• Support new result types
• New, internally generated cause codes exported in the PGW 2200 dial plan
• New Screening Editor is used for updating screening data.
|
VSPT 2.2(2)
|
Cisco MGC Version 9.2(1.5-2)
|
BAMS Phase 2, BAMS Phase 3
|
|
VSPT 2.2(2A)
|
Cisco MGC Version 9.2(1.5)
|
BAMs Phase 2, BAMS Phase 3
|
• Removal of support for TDM cards, (ITK, V.35) cards·
• Support for BAMS Phase 3
|
VSPT 2.2(1C)
|
Cisco MGC Version 9.2(0-1)T
|
BAMs Phase 2, BAMS Phase 3
|
• Backup and restore MGC system files·
• Netscape browser·
• Screening editor to create and modify screening files.
• Multiple provisioning sessions.
• Online help
|
VSPT 2.1(4)
|
Cisco MGC Version 9.1(5)
|
BAMs Phase 2, BAMS Phase 3 (3.08)
|
• Support for multiple dial plans·
• Provisioning Advice of Charge
|
VSPT 2.1(2.A)XA
|
Cisco MGC Version 9.1(3.4)XA
|
BAMs Phase 2, BAMS Phase 3 (3.08)
|
|
VSPT 2.1(2.B)
|
Cisco MGC Version 9.1(3.0-9)T
|
BAMs Phase 2, BAMS Phase 3 (3.08)
|
|
VSPT 2.0
|
|
|
• State Operations Utility
• CAS signaling paths provisioning
• Define trunk group profiles
• Automatic Congestion Control provisioning
• Define SIP signaling paths, SIP IP Links, and SIP trunk groups, and support for SIP routes
• Support for multiple OPCs
|
Before installing the VSPT, you must verify the following:
•
You have the appropriate release of the VSPT software. Visit the following Cisco web site to check the VSPT release number (a valid login to the VSPT Cisco web site is required):
http://www.cisco.com > Software Center > Voice Software > Cisco Voice Services Provisioning Tool
•
You have met the workstation hardware and software requirements. Refer to the Release Notes for your release of the Cisco MGC Version 9.3(2) and VSPT Version 2.3(2) software for a complete list of hardware requirements.
•
You have established network connectivity between your workstation and the network elements.
•
The network elements have the correct release of software installed.
Note
Make sure you have root access on your Sun workstation.
Before you begin provisioning, you should have a list of components you want to provision, including the component names, IP addresses, properties, and other parameters. To create this list, use the instructions provided in the Cisco Media Gateway Controller Software Version 9 Provisioning Guide at http://www.cisco.com/univercd/cc/td/doc/product/access/sc/rel9/prvgde/index.htm.
Tip
. In addition, descriptions of the properties and values contained in the VSPT are included in Appendix A of the Cisco Media Gateway Controller Software Version 9 Provisioning Guide and in the following chapters. Review this information before you begin provisioning, and keep it available for reference during provisioning.
Prerequisites
To install the VSPT software, you must have at least the following:
•
Sun Ultra 5 workstation (440MHz or faster) running the following software:
–
Sun Solaris 8 (April 2001 release recommended, latest Solaris 8 recommended patch set)
–
OpenWindows with the Common Desktop Environment (CDE)
•
8-bit video graphics card
•
RAM: 128 MB
•
Disk space:
–
128 MB of free disk space in the installation directory
–
Approximately 4 MB of disk space in the /var partition is needed for each configuration session
•
Swap space:
–
128 MB of free swap space
•
Cisco Media Gateway Controller Software Version 9.3(2)
•
Swap space:
–
Minimum: 128 MB
–
Recommended: 256 MB or greater
Note
The VSPT may also be installed on the same server as the Cisco MGC Node Manager client. It adds no additional hardware requirements in this configuration.
Preplanning
VSPT supports multiple solutions and offers the option to provision components for these solutions. Some components might not apply to your solution. Make sure you understand your solution component requirements. For information, refer to the provisioning guide for your solution.
Upgrading VSPT Software
If you have a previous release of the VSPT installed (such as VSPT Version 2.3(1) and you are performing a minor upgrade to VSPT Version 2.3(2)), the existing VSPT network configuration data is automatically moved to the new release. However, if a major earlier release is detected during the upgrade, (such as VSPT Version 1.6) and you are upgrading to VSPT Version 2, the existing VSPT network configuration data is not formatted for use with VSPT Version 2 and is not moved.
Two versions of the VSPT (such as VSPT 1.6 and 2) can exist on the same system; when you are upgrading, the older version is not automatically removed and must be manually uninstalled if you want to remove it. See the "Uninstalling the VSPT Software" section for information.
Note
Since the uninstall directory and files are removed during uninstall, do not change to the /opt/CSCO2X directory to run the uninstall script.
Saving Configuration Files
Before uninstalling the VSPT software, you can save current configuration data and administrative information so users and logins do not need to be recreated after the upgrade. Use the following procedure to save data and user information:
Step 1
Log in to the server as root.
Step 2
Create a temporary directory to hold the pertinent files.
Step 3
Use the following command to copy the password file, /var/opt/CSCOvspXX/etc/dartpwd.txt, to the temporary directory:
# cp -p /var/opt/CSCOvspXX/etc/dartpwd.txt /<temporary directory>/dartpwd.txt
Step 4
Change to the /var/opt/CSCOvspXX/data directory.
Step 5
Use the tar commend to archive all files in the directory.
Note
The tar command preserves file permissions.
Step 6
Copy the archive file to the temporary directory.
After you upgrade the VSPT software, replace the /var/opt/CSCOvsp<New>/etc/dartpwd.txt file and the /var/opt/CSCOvsp<New>/data directory with the archive files you saved in the temporary directory.
Uninstalling the VSPT Software
The uninstallation process removes the /var/opt/<CSCOvspt2x> directory created by the installation process. If a directory contains a file that was not created during the installation process, it is not removed and is logged in the uninstall.log file. This might occur in the data and logs directories, and all application data stored in the /var/opt/<CSCOvsp2x> directory will not be deleted.
Use the following procedure to uninstall the software:
Step 1
Enter the following commands:
>su -root
>cd /
>/opt/CSCO2x/uninstall/uninstall
Step 2
Proceed with the VSPT software installation (see "Installing the VSPT Software" section).
Installing the VSPT Software
To install the software from the Cisco web site, follow this procedure:
Step 1
Verify that the requirements listed in the "Prerequisites" section have been met.
Step 2
Become the root user by entering the following command:
Step 3
Create the temporary directory /var/tmp/CSCOvsp23-install by entering the following command:
#mkdir -p /var/tmp/CSCOvsp23-install
Step 4
Open a web browser and browse to the following site:
http://www.cisco.com> Software Center > Network Management> Cisco Voice Services Provisioning Tool
Step 5
Select the desired release number.
Step 6
Download the software to the temporary directory /var/tmp/CSCOvsp23-install.
Step 7
Extract the software image using the following tar command:
Step 8
Run the setup program by entering the following command:
Note
As an alternative to Step 8, you can avoid the GUI and install the VSPT in TTY mode by entering the command ./setup -nodisplay and following the onscreen prompts. An X server must be running, and the DISPLAY environment variable must be properly configured. Use one of the following commands to set the X display variable. Your choice of a command depends on which shell you are using.
In "csh" or "tcsh": setenv DISPLAY <hostname>:0
In "sh" or "ksh": DISPLAY=<hostname>:0;export $DISPLAY
Step 9
Follow the onscreen prompts.
Note
If a previous version of the Cisco VSPT is installed on the workstation, you may be asked if you want to uninstall it, depending on the version to which you are upgrading. If you answer no, the installation is aborted.
Step 10
Remove the /var/tmp/CSCOvsp23-install directory when the installation is complete by entering the following command:
#rm -rf /var/tmp/CSCOvsp23-install
Step 11
Change to the installation directory, /opt/CSCOvsp23, by entering the following command:
Step 12
Enter the following command to start the VSPT:
Installation of the VSPT software is now complete. Table 1-2 defines the default VSPT directories and files. If you have questions or need assistance, see the Obtaining Technical Assistance section.
.
Table 1-2 VSPT Installation Directories and Files
/opt/CSCOvsp23
|
vspt
|
VSPT application script
|
classes/
|
Class and property files
|
/docs
|
|
/help
|
|
images/
|
|
jre/
|
Java Runtime Environment
|
/netscape
|
Netscape web browser files
|
uninstall/
|
Uninstall script directory
|
/utils
|
|
version
|
VSPT version
|
| |
|
/var/opt/CSCOvsp23 (home directory)
|
data/
|
Configuration files
|
logs/
|
Log files
|
/etc
|
|
Note
The directories and files listed in Table 1-2 are for the most recent version of VSPT. Your directory structure may be different if you are using an older version or VSPT.
VSPT Basics
This section describes the requirements for entering provisioning data using the VSPT.
VSPT Field Definitions
Table 1-3 lists VSPT field names, which correspond to system components in the Cisco MGC, and their definitions. For more information about system components, refer to the Cisco Media Gateway Controller Software Version 9 Provisioning Guide.
.
Table 1-3 Field Name Definitions
Field Name
|
Definition
|
MGC Host
|
An origination point code (OPC) is the address of the Cisco MGC you are provisioning.
|
Interfaces (Cards)
|
Ethernet hardware cards and virtual interfaces (connections) for the Ethernet cards in the Cisco MGC host.
|
Adjacent Point Code
|
An adjacent point code (APC) is the address of an STP1 that sends and receives signaling messages to and from the Cisco MGC.
|
LinkSet
|
A LinkSet is a set of links from the MGC to an endpoint, such as an adjacent STP.
|
C7 IP Link
|
A link to the SS7 network (for example, an SSP2 or STP) from the Cisco MGC through a Cisco SLT.
|
Mated Pair (SS7 Subsystem)
|
A logical connection between a pair of mated STPs that allows the Cisco MGC to route through either STP to an endpoint.
|
Point Code
|
A destination point codes (DPC) is the address of an endpoint, such as a PSTN3 switch that carries the bearer traffic.
|
SS7 Path (SS7 Signaling Service)
|
An SS7 path is a connection between the Cisco MGC and a specified point code.
|
SS7 Route
|
An SS7 route is a route for each signaling path from the Cisco MGC to the PSTN switch through the linksets you have created to the STPs.
|
External Node
|
An external node is any object in the network that is connected to the Cisco MGC, for example, media gateways (Cisco MGWs) and associated BSCs4 .
|
MGCP5 Signaling Service
|
An MGCP signaling service is a signaling service between the Cisco MGC and a media gateway.
|
IPFAS Signaling Service
|
An IPFAS signaling service is a signaling service (over IP) between the Cisco MGC and a media gateway.
|
IP Link for MGCP and IPFAS
|
An IP Link for MGCP and IPFAS is a link for the MGCP and IPFAS signaling services.
|
|
5 Figure 1-1 shows the relationship of VSPT field names and the corresponding system components.
|
Figure 1-1 Component Relationships
VSPT Data Entry Requirements
When you are entering data into the VSPT windows, follow standard MML conventions for names and descriptions. Each MML name must have the following characteristics:
•
A maximum of 20 alphanumeric characters, including dashes
•
No space, underscore, or special characters
•
Must start with an alphabetic character
For example: name="dpc1"
MML descriptions can be as many as 128 characters and can include spaces and symbols. You should use a description that helps to identify the component or link that you are provisioning. For example, for an SS7 route, which indicates the signaling path from the Cisco MGC to a switch through a linkset, you could create a description "SS7 Route to PSTN Switch A through Linkset 1." For more information about MML, refer to the Cisco Media Gateway Controller Software Version 9 MML Command Reference Guide.
The VSPT GUI enables you to step through the provisioning process in a logical sequence. The sequence of steps is described in the Cisco Media Gateway Controller Software Version 9 Provisioning Guide.
Starting the VSPT
Note
See the Cisco Media Gateway Controller Software Version 9 Installation and Configuration Guide for information on setting up user privileges and access rights.
Perform the following steps to start the VSPT:
Step 1
Log in to the VSPT server or access it from a machine with X window capability.
Step 2
In a terminal window, change to the default directory:
>cd /opt/CSCOvsp23
Navigate to the appropriate directory if you installed the VSPT in a different location.
Step 3
Enter the following command to start the VSPT:
>./vspt
The system opens X windows, and the login screen shown in Figure 1-2 appears.
Figure 1-2 Login Screen
Step 4
Enter your user name and password, and click OK.
The default user uame is admin, and the password is also admin. The Welcome screen is displayed briefly during the login process, and the main window appears (see Figure 1-3).
Figure 1-3 Main VSPT Window
Using the VSPT
This section describes the VSPT menus and buttons and provides directions for using the tool functions.
Menu Bar
The VSPT provides a menu bar that contains the following selections:
•
File
•
View
•
Tools
•
Help
Table 1-4 lists the File menu choices.
Table 1-4 File Menu Command Choices
Command
|
Description
|
New
|
Begin a new configuration session
|
Open
|
Open an existing configuration
|
Import
|
Import an existing configuration from an MGC, or import trunk group, trunk, routing, or dial plan files into the VSPT
|
Export
|
Export configuration files from the VSPT to a specified directory
|
Save
|
Save the current configuration:
• As Working: Use to save a new configuration, either a configuration imported from the Cisco PGW or a configuration created in VSPT and to save modifications to an existing configuration, overwriting the last version. The configuration is saved in the /var/opt/CSCOvsp23/data/mgc/mistral directory.
• As Snapshot: Use to save modifications to an existing configuration under a new name in the ARCHIVE directory. The snapshot configuration is saved in /var/opt/CSCOvsp23/data/mgc/mistral/<configname>/ARCHIVE
• As New Config: Use to save a modified configuration under a new name, leaving the original intact.
|
Exit
|
Stop any open provisioning sessions and close the VSPT
|
Table 1-5 lists the View menu command choices.
Table 1-5 View Menu Command Choices
Command
|
Description
|
MML
|
Show generated MML for the current configuration
|
MGW Commands
|
Show generated Cisco MGX 8850 commands for the current configuration
|
Trunk Group File
|
Show generated trunk group file for the current configuration
|
Trunk File
|
Show generated trunk file for the current configuration
|
Table 1-6 lists the Tools menu command choices.
Table 1-6 Tools Menu Command Choices
Command
|
Description
|
Integrity Check
|
Check your configuration for inconsistencies and missing information
|
Deploy
|
Move the configuration to one or more target hosts and Cisco media gateways (MGWs)
|
Telnet
|
Open a telnet session
|
MGC Viewer
|
View, activate, remove, and synchronize configurations on the MGC.
|
MGX 8850 Wizard
|
View and configure MGX 8850 hosts. Refer to the Version for information about the MGX 8850 Wizard.
|
BAMS Config
|
View and configure a Billing and Measurements Server (BAMS). Refer to the Billing and Measurements Server User's Guide for your release of BAMS for information about BAMS configuration.
|
State Operation
|
View and configure the state of MGC components.
|
Screening Editor
|
View and configure screening number provisioning. Refer to the Cisco MGC Software Version 9 Dial Plan Guide for information about using the VSPT Screening Editor.
|
Audit
|
Audit bearer trunk information between the Cisco MGC and the BAMS.
|
Backup and Restore
|
Create, modify, or delete scheduled backups or restores on the MGC Host, CAT2900XL, CAT5500, CAT6509, SLT2600, BAMS P2, BAMS P3, and HSI adjunct server components.
|
Make a Seed File
|
Use an existing configuration to create a text file that can be used by the Cisco MGC Node Manager (CMNM) to deploy or discover devices in the network.
|
Table 1-7 lists the Help menu command choices.
Table 1-7 Help Menu Command Choices
Command
|
Description
|
About VSPT
|
View information about the current version of VSPT, including the software release number
|
VSPT User's Menu
|
View online help information
|
Buttons
The VSPT provides buttons and explorer trees that you can use to move through the system. Click these buttons to add or change network components. The VSPT contains the following buttons:
•
MGC Config—Add components and provision component properties
•
Traffic—Create customer-specific files, including trunk groups, trunks, and routing
•
Number Analysis—Provision dial plans
The left pane of the main VSPT screen displays selectable components. The right pane of the screen displays data entry fields. Click a component to select it. To see all of the subcomponents for the component you select, click the icon next to the component name to expand the component list.
Note
For instructions for using the VSPT to provision components, component properties, trunk groups, trunks, and routing, refer to the Cisco Media Gateway Controller Software Version 9 Provisioning Guide. For instructions for using the VSPT to provision a dial plan, refer to the Cisco Media Gateway Controller Software Version 9 Dial Plan Guide.
The Help menu selections display an html version of this guide and information about the current software release number.
Defining Users and Permissions
After you install the VSPT, you define users and their respective permissions using the following procedure:
Step 1
Log in to the server as root and start VSPT 2.
Step 2
Click Tools > User Admin on the menu bar.
The screen in Figure 1-4 appears.
Figure 1-4 VSPT User Administration
Step 3
Add, modify, or delete user definitions as follows:
•
To add a user, enter a user name and password, click Permission, select the permission level, and click Add.
•
To modify a user, select the user name, change the password or permission level, and click Modify.
•
To delete a user, select the user name, and click Delete.
Exiting the VSPT
You can exit the VSPT at any time by performing one of these actions:
•
Click File > Exit. Click OK at the resulting prompt.
•
Click the close box in the upper right of the VSPT screen. Click OK at the prompt.