Guest

Cisco Unified Application Environment

Installation Guide for Cisco Unified Communications Manager 6.0 SDK for Use with the Cisco Unified Application Environment (2.4)

  • Viewing Options

  • PDF (142.5 KB)
  • Feedback
Installation Guide for Cisco Unified Communications Manager 6.0 SDK, for Use with the Cisco Unified Application Environment, Release 2.4

Table Of Contents

Installation Guide for Cisco Unified Communications Manager 6.0 SDK,
for Use with the Cisco Unified Application Environment, Release 2.4

Conventions

Related Documentation

Installing the VMware Player and Configuring Network Connections

Downloading the VMware Player

Configuring the Windows PC Network Connections

Installing the Cisco Unified Communications Manager 6.0 SDK

Configuring Cisco Unified Communications Manager

Configuring Cisco Unified Application Environment

Sample Application

Changing the Cisco Unified Communications Manager IP Address

Reconfiguring the VMware Image

Reconfiguring the Web Interface Access to Cisco Unified Communications Manager

Reconfiguring the Cisco Unified Application Environment

Obtaining Documentation, Obtaining Support, and Security Guideline


Installation Guide for Cisco Unified Communications Manager 6.0 SDK,
for Use with the Cisco Unified Application Environment, Release 2.4


Use this document to install Cisco Unified Communications Manager 6.0 SDK, for use with the Cisco Unified Application Environment, Release 2.4. This guide includes the following topics:

Conventions

Related Documentation

Installing the VMware Player and Configuring Network Connections

Installing the Cisco Unified Communications Manager 6.0 SDK

Configuring Cisco Unified Communications Manager

Configuring Cisco Unified Application Environment

Sample Application

Changing the Cisco Unified Communications Manager IP Address

Obtaining Documentation, Obtaining Support, and Security Guideline

Conventions

This document uses the following conventions.

Convention
Description

boldface font

Commands and keywords are in boldface.

italic font

Arguments for which you supply values are in italics.

[   ]

Elements in square brackets are optional.

{ x | y | z }

Alternative keywords are grouped in braces and separated by vertical bars.

[ x | y | z ]

Optional alternative keywords are grouped in brackets and separated by vertical bars.

string

A nonquoted set of characters. Do not use quotation marks around the string or the string will include the quotation marks.

screen font

Terminal sessions and information the system displays are in screen font.

boldface screen font

Information you must enter is in boldface screen font.

italic screen font

Arguments for which you supply values are in italic screen font.

^

The symbol ^ represents the key labeled Control—for example, the key combination ^D in a screen display means hold down the Control key while you press the D key.

<   >

Nonprinting characters, such as passwords, are in angle brackets.


Related Documentation

Table 1 lists URLs for related documentation.

Table 1 Quick Reference for URLs 

Related Information
URL

Administration Guide for the Cisco Unified Application Environment, Release 2.4

http://www.cisco.com/en/US/products/ps7058/products_administration_guide_book09186a00807dcce7.html

Cisco Unified Communications Manager Administration Guide, Release 6.0

http://www.cisco.com/en/US/docs/voice_ip_comm/cucm/admin/6_0_1/ccmcfg/bccm.pdf


Installing the VMware Player and Configuring Network Connections

This section includes these topics:

Downloading the VMware Player

Configuring the Windows PC Network Connections

Before You Begin

Make sure you have:

An available IP Address and subnet mask for the virtual Cisco Unified Communications Manager, and the related gateway IP address. If you need to change the IP address at a later time, refer to Changing the Cisco Unified Communications Manager IP Address for the procedure.

A Microsoft Windows PC, with a minimum of 2GB of RAM and a 400MHz or faster processor.

Downloading the VMware Player

To download the VMware player, follow these steps:

Procedure


Step 1 Download VMware Player 2.0 or above from the following URL: http://www.vmware.com/products/player/

Step 2 Read and accept the usage guidelines on the Download VMware Player page.

Step 3 Accept all the defaults during installation.


Configuring the Windows PC Network Connections


Note Perform this procedure only if you have two network adapters on your PC. Otherwise, go to Installing the Cisco Unified Communications Manager 6.0 SDK.


To designate one of the network connections as not used.

Procedure


Step 1 Choose Start > Control Panel > Network Connections > Local Area Connection. The Local Area Connection window displays.

Step 2 Select, then right-click the connection that is not the primary LAN connection.

Step 3 Click Properties. The Local Area Connection Properties window displays.

Step 4 From the General tab, write down the local area device used to make the connection shown in the Connect using: list box:

Step 5 Click Cancel to return to the Local Area Connection window; then click Close.

Step 6 From the VMware Player installation directory, run this executable file: vmnetcfg.exe. The Virtual Network Editor window displays.

Step 7 Select the Automatic Bridging tab.

Step 8 Select the device you noted in the Connect using: list box: under the General tab of the Local Area Connection Properties window, then click Add to add it to the Excluded Adapter list.

Step 9 Click Apply, then click OK.


Installing the Cisco Unified Communications Manager 6.0 SDK

To install the Cisco Unified Communications Manager SDK, follow these steps.


Note While performing these steps, use the following key combinations to interact with the VMware Player:

CTRL-G—Shifts the focus inside the VMware Player window.

CTRL-ALT—Shifts the focus outside the VMware Player window.

Procedure


Step 1 Insert the Cisco Unified Communications Manager SDK DVD into the drive.

Windows Explorer displays the contents of the DVD.

Step 2 Locate this executable file and run the self-extracting installer: CUCM_VirtualAppliance.exe.

Step 3 Start the VMware Player using your desktop icon or by choosing Start > Programs > VMware.

Step 4 Navigate to the location where you extracted the files, locate the file with the extension .vmx, and open it.

As the VMware Player loads the virtual image file, status messages display for which you do not need to take any action. If you see a [FAILED] status, ignore it.

When the virtual image has completed loading, a login prompt displays.

Step 5 Enter the username Administrator and the password metreos1.

The admin: prompt displays.

Step 6 At the admin: prompt, configure your available IP address and corresponding gateway IP address for the virtual Cisco Unified Communications Manager as follows:

a. Enter set network ip eth0 <communications manager IP> <mask>

b. When prompted, enter yes to continue and restart.

c. Enter set network gateway <gateway ip address>

d. When prompted, enter yes to continue and restart.

After a few minutes the system reboots and, a login prompt displays.

Step 7 Enter the username Administrator and the password metreos1. The admin: prompt displays.

Step 8 To verify the IP address are configured correctly, do the following:

a. At the admin: prompt, enter show network eth0.

The IP address and the gateway address display with the values you entered.

b. To exit the console, at the admin: prompt enter quit.

This command exits you from the console, but does not stop the virtual Cisco Unified Communications Manager from running.

Step 9 Open the virtual Cisco Unified Communications Manager web interface URL by entering: http://<communicationsmanageripaddress>/ccmadmin.

Step 10 List an available Cisco Unified Communications Manager by choosing Systems > Server, then click Find. A single entry displays.

Step 11 Click the entry, then change the IP address shown to your available IP address.

Step 12 Click Save, then log out.


Configuring Cisco Unified Communications Manager

To configure Cisco Communications Manager, follow these steps.


Note During this procedure:

Click Reset whenever you are prompted to do so after a configuration change.

Click Restart, then Close when prompted to do so when a pop-up window displays.

Accept the defaults unless explicit instructions are given.

Procedure


Step 1 Open the virtual Cisco Unified Communications Manager web interface URL by entering: http://<communicationsmanageripaddress>/ccmadmin.

Step 2 Enter the username Administrator and the password metreos1. The virtual Cisco Unified Communications Manager window displays.

Step 3 Configure a partition as follows:

a. Choose Call Routing > Class of Control > Partition.

b. Click Add New

c. For the partition name, enter Unrestricted.

d. Click Save.

Step 4 Configure a calling search space (CSS) as follows:

a. Choose Call Routing > Class of Control > Calling Search Space.

b. For the CSS name, enter Unrestricted.

c. Choose the Unrestricted partition in the Available Partitions list box and add it to the Selected Partitions list box.

d. Click Save.

Step 5 Configure the device pool as follows:

a. Choose System > Device Pool.

b. For the device pool name, enter Default.

c. Choose the Cisco Unified Communications Manager group to assign to the devices in this device pool.

d. Click Save.

Step 6 Configure a Cisco Unified Communications Manager Group as follows:

a. Choose System > Server.

b. Click Find.

c. From the list of records that display, click the link for the Cisco Unified Communications Manager.

d. Enter the Cisco Unified Communications Manager IP address in Host name/IP Address list box.

e. Choose System > Cisco Unified CM.

f. Click Find.

g. From the list of records that display, click the link for the Cisco Unified Communications Manager.

h. Enter 1000 for the Starting Directory Number, and 2000 for the Ending Directory Number.

i. From the Partition drop-down list box, select Unrestricted.

j. Uncheck the Auto-registration Cisco Unified Communications Managers Group.

k. Click Save.

Step 7 Update the Enterprise Parameters as follows:

a. Choose System > Enterprise Parameters.

b. Change all hostname references (ccm-sdk) to the Cisco Unified Communications Manager IP address.

Step 8 Configure a SIP trunk as follows:

a. Choose Device > Trunk.

b. Click Add New.

c. From the Trunk Type list box, select SIP Trunk.

d. From the Device Protocol list box, select SIP.

e. Click Next.

f. In the Device Information section, select Default from the Device Pool list box.

g. In the SIP Information section, enter the Cisco Unified Application Environment IP address in the Destination Address field.

h. Click Save.

Step 9 Register the Cisco Unified IP phone(s) you will use with the Cisco Unified Communications Manager as follows:

a. Press the Settings button to access the Settings menu.

b. Select Network Configurations.

c. Select TFTP Server 1.

d. Enter **# to enable Edit menu option.

e. Select Edit.

f. Enter the Cisco Unified Communications Manager IP address.

g. Select Validate.

h. Select Save.

Step 10 Configure the Cisco Unified IP phone(s) as follows:

a. Choose Device > Phone.

b. Click Find to list the phones that are auto-registered.

c. For each phone listed, click the link listed in the Device Name column, then from the Device Information section, select Unrestricted from the Calling Search Space drop-down list box.

d. Click Save.

e. Click the Line [1] link under the Association Information.

The directory number is the number your application needs to dial to ring this particular phone.

f. Under the Directory Number Information section, select Unrestricted from the Route Partition drop-down list box.

g. Click Save.

Step 11 Activate service as follows:

a. From the Navigation drop-down list box, select Cisco Unified Serviceability, then click Go. The Cisco Unified Serviceability window displays.

b. Choose Tools > Service Activation.

c. Scroll to the bottom of the page, then click Set to Default.

d. Check the Cisco Extension Mobility and Cisco AXL Web Service checkboxes.

e. Click Save.


Configuring Cisco Unified Application Environment

To configure Cisco Unified Application Environment, follow these steps.


Note During this procedure, accept the defaults unless explicit instructions are given.


Procedure


Step 1 Open the Cisco Unified Application Environment management console entering: http://<serverIPaddress>/mceadmin, and enter the username and password.

Step 2 Choose Main Control Panel > Telephony Servers.

Step 3 From the Add a Telephony Server list box, select Unified Communications Manager, then click Add Server.

a. In the Name field, enter the Cisco Unified Communications Manager IP address.

b. In the Version field, enter the Cisco Unified Communications Manager version number.

c. In the Publisher Address field, enter the IP address of the publisher.

d. In the SNMP Community field, enter public.

e. Click Create Unified Communications Manager.

Step 4 Click Add CTI Manager.

a. In the Name field, enter the Cisco Unified Communications Manager IP address.

b. In the Address field, enter the Cisco Unified Communications Manager IP address.

c. Click Add CTI Manager.

Step 5 Click Create CTI Device Pool.

a. In the Name field, enter the Cisco Unified Communications Manager IP address.

b. In the Primary CTI Manager field, enter the Cisco Unified Communications Manager IP address

c. Click Create CTI Device Pool.

Step 6 Choose Main Control Panel > Telephony Servers.

a. From the Add a Telephony Server list box, select Cisco SIP Domain.

a. In the Domain Name field, enter the Cisco Unified Communications Manager IP address.

a. In the Primary Registrar field, enter the Cisco Unified Communications Manager IP address.

b. Click Create SIP Domain.

Step 7 Choose Main Control Panel > Media Engines.

a. Click Add a Media Engine.

b. In the Name field, enter 127.0.0.1

c. In the Address field, enter 127.0.0.1

d. Click Add.


Sample Application

To upload a sample application file and configure a sample application, follow these steps.

Before You Begin

Download the MakeCall.mca sample file from the following URL: http://cuaesdk.svn.sourceforge.net/viewvc/cuaesdk/trunk/examples/

Procedure


Step 1 Open the Cisco Unified Application Environment management console and enter: http://<serverIPaddress>/mceadmin, and enter the username and password.

Step 2 From the Main Control Panel, click Applications.

Step 3 Click Browse... and highlight the MakeCall.mca application file.

Step 4 Click Open to make the file available for uploading.

Step 5 Click Upload File.

The file is uploaded and added to the list on the Applications page.

Step 6 Click the MakeCall link on the Applications page. The MakeCall Application window displays.

Step 7 Under Scripts, click Edit Trigger Parameters.

a. In the To field, enter a directory number (line number showing on your Cisco Unified IP phone) from one of your registered test phones.

b. Click Done.

Step 8 Under Partitions, click Edit.

a. From the Call Route Group list box, select Default SIP.

The To field should display the number entered in the previous step.

b. Click Apply Configuration.

Step 9 Under Scripts, click Edit Trigger Parameters.

a. In the URL field, enter /MakeCall.

b. Click Apply Parameter Values, then click Done.

Step 10 In your Browser window, enter http://CUAE-IP:8000/MakeCall.

The phone with the specified number rings, and you hear three goodbye messages. However, if you do not have a valid Text-to-Speech license installed, you will hear a license expiration message instead.


Changing the Cisco Unified Communications Manager IP Address

If you change the IP address for the Cisco Unified Communications Manager, you must follow these procedures:

Reconfiguring the VMware Image

Reconfiguring the Web Interface Access to Cisco Unified Communications Manager

Reconfiguring the Cisco Unified Application Environment

Reconfiguring the VMware Image

To reconfigure the VMware Image, follow these steps:

Procedure


Step 1 Access the VMware Player console, then enter the username Administrator and the password metreos1. The admin prompt displays.

Step 2 At the admin prompt, configure your new IP address for the virtual Cisco Unified Communications Manager and corresponding gateway as follows:

a. Enter set network ip eth0 <communications manager IP> <mask>

b. When prompted, enter yes to continue and restart.

c. Enter set network gateway <gateway ip address>

d. When prompted, enter yes to continue and restart.

After a few minutes the system reboots and, a login prompt displays.

Step 3 Enter the username Administrator and the password metreos1. The admin: prompt displays.

Step 4 Verify the IP address is configured correctly:

a. At the admin: prompt, enter show network eth0.

The IP address and the gateway address display with the values you entered.

b. Enter quit to exit the console at the admin prompt.


Reconfiguring the Web Interface Access to Cisco Unified Communications Manager

To reconfigure the web interface access to Cisco Unified Communications Manager, follow these steps.

Procedure


Step 1 Open the virtual Cisco Unified Communications Manager web interface URL by entering: http://<New IP Address>/ccmadmin.

Step 2 Enter the username Administrator and the password metreos1. The virtual Cisco Unified Communications Manager window displays.

Step 3 Choose Systems > Server.

Step 4 Click Find to list the Cisco Unified Communications Manager.

Step 5 Click the link, then change the IP Address field to the new IP a address.

Step 6 Click Save.


Reconfiguring the Cisco Unified Application Environment

To reconfigure the Cisco Unified Application Environment, follow the procedure in Configuring Cisco Unified Application Environment, substituting the old Cisco Unified Communications Manager IP address with the new IP address.

Obtaining Documentation, Obtaining Support, and Security Guideline

For information on obtaining documentation, obtaining support, providing documentation feedback, security guidelines, and also recommended aliases and general Cisco documents, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:

http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html