Cisco Intercompany Media Engine Installation and Configuration Guide, Release 8.5(1)
Cisco IME Configuration in Cisco Unified Communications Manager Administration
Downloads: This chapterpdf (PDF - 674.0KB) The complete bookPDF (PDF - 2.1MB) | Feedback

Cisco IME Configuration in Cisco Unified Communications Manager Administration

Table Of Contents

Cisco IME Configuration in Cisco Unified Communications Manager Administration

Cisco Unified Communications Manager Administration Basics

Using the Cisco Unified Communications Manager Administration Graphical User Interface

Using Cisco Unified Communications Manager Administration Help

Finding and Deleting Records

Adding and Copying Records

Cisco IME Configuration Checklist

Configuring Cisco IME Server Connections

Setting Up TLS Connections Between the Cisco Unified Communications Manager and Cisco Intercompany Media Engine Servers

Generating and Uploading a Self-Signed Certificate on the Cisco Intercompany Media Engine Server

Generating and Uploading Third Party Certificates for Cisco Intercompany Media Engine

Configuring a Cisco IME Enrolled Group

Configuring a Cisco IME Enrolled Pattern

Configuring a Cisco IME Exclusion Group

Configuring a Cisco IME Exclusion Number

Configuring a Cisco IME Trust Group

Configuring a Cisco IME Trust Element

Configuring a Cisco IME Service

Configuring External IP Address and Port Information

Configuring Transformation Patterns for Cisco IME

Configuring a Cisco IME Transformation Profile

Configuring Cisco IME E.164 Transformations

Configuring PSTN Access Trunks

Configuring a Cisco IME Feature Configuration

Verifying Connectivity

Registration Status

Vservice Publication

DID Publication

Configuring a Fallback Profile

Configuring Fallback Feature Parameters

Configuring Intercompany Media Services Firewall Information

Cisco Intercompany Media Engine Learned Routes

Related Topics


Cisco IME Configuration in Cisco Unified Communications Manager Administration


Cisco Intercompany Media Engine (Cisco IME) allows customer to establish direct IP connectivity between enterprises. After you install the software on the Cisco IME server and perform the post-installation tasks, you must configure the Cisco Unified Communications Manager server to enable the Cisco Intercompany Media Engine feature.

This chapter contains information on using the Cisco Unified Communications Manager Administration user interface and provides detailed steps on configuring the Cisco Unified Communications Manager server for the Cisco Intercompany Media Engine feature. The chapter covers the following topics:

Cisco Unified Communications Manager Administration Basics

Cisco IME Configuration Checklist

Configuring Cisco IME Server Connections

Setting Up TLS Connections Between the Cisco Unified Communications Manager and Cisco Intercompany Media Engine Servers

Configuring a Cisco IME Enrolled Group

Configuring a Cisco IME Enrolled Pattern

Configuring a Cisco IME Exclusion Group

Configuring a Cisco IME Exclusion Number

Configuring a Cisco IME Trust Group

Configuring a Cisco IME Trust Element

Configuring a Cisco IME Service

Configuring External IP Address and Port Information

Configuring Transformation Patterns for Cisco IME

Configuring a Cisco IME Transformation Profile

Configuring Cisco IME E.164 Transformations

Configuring PSTN Access Trunks

Configuring a Cisco IME Feature Configuration

Verifying Connectivity

Configuring a Fallback Profile

Configuring Fallback Feature Parameters

Configuring Intercompany Media Services Firewall Information

Cisco Intercompany Media Engine Learned Routes

Related Topics

Cisco Unified Communications Manager Administration Basics

You use Cisco Unified Communications Manager Administration, a web-based application, to perform configuration tasks for Cisco Unified Communications Manager servers. This section describes basic elements of the graphical user interface, including the navigation menus and the documentation search feature that allows you to search Cisco Unified Communications Manager documentation on Cisco.com.

For more information, see the following topics:

Using the Cisco Unified Communications Manager Administration Graphical User Interface

Using Cisco Unified Communications Manager Administration Help

Finding and Deleting Records

Adding and Copying Records

Using the Cisco Unified Communications Manager Administration Graphical User Interface

The Cisco Unified Communications Manager Administration interface contains the following options.


Note For information on logging into Cisco Unified Communications Manager Administration, refer to the Cisco Unified Communications Manager Administration Guide.


Navigation—After you log on, the main Cisco Unified Communications Manager Administration window redisplays. The window includes the drop-down list box in the upper, right corner called Navigation. To access the applications in the drop-down list box, choose the program that you want and click Go. The choices in the drop-down list box include the following Cisco Unified Communications Manager applications:

Cisco Unified Communications Manager Administration—Shows as default when you access Cisco Unified Communications Manager. Use Cisco Unified Communications Manager Administration to configure system parameters, route plans, devices, and much more.

Cisco Unified Serviceability—Takes you to the main Cisco Unified Serviceability window. Use Cisco Unified Serviceability to configure trace files and alarms and to activate and deactivate services.

Cisco Unified OS Administration—Takes you to the main Cisco Unified Operating System Administration window, so you can configure and administer the Cisco Unified Communications Manager platform. You must log off from any other application before you can log in to this application.

Disaster Recovery System—Takes you to the Cisco Disaster Recovery System, a program that provides full data backup and restore capabilities for all servers in a Cisco Unified Communications Manager cluster. You must log off from any other application before you can log in to this application.

Search Documentation—Click this link to search Cisco Unified Communications Manager documentation on Cisco.com for the current release. The Cisco Unified CM Documentation Search window displays. Type the word or words for which you want to search and click the Search button. The search results display. You can narrow the search results by choosing a documentation type modifier button that displays above your search result; for example, Unified CM Install/Upgrade or Unified CM Business Edition Release Notes.

About—Displays the Cisco Unified Communications Manager Administration main window and allows you to view the system software version.

Logout—Allows you to log out of Cisco Unified Communications Manager Administration application. The window redisplays with the login fields.

Menu Bar—The horizontal bar located across the top of the interface contains the names of the menus. Click the menu options to display the Cisco Unified Communications Manager Administration windows. Menu items in this document appear in boldface font. A > (greater than) symbol separates menu item selections. In the browser, this indicates a menu item selection; for example: Choose Advanced Features > Intercompany Media Services > Service.

Additional Information

Cisco Unified Communications Manager Administration Basics

Using Cisco Unified Communications Manager Administration Help

To access Help, click the Help menu in the Cisco Unified Communications Manager Administration navigation bar, and choose one of the following options:

Contents—Opens a new browser window and displays the home page for the Cisco Unified Communications Manager Administration Help system. The links in the left pane of the Help window allow you to access all topics in the Help system.

This Page—Opens a new browser window for the Cisco Unified Communications Manager Administration Help system. The right pane of the window contains definitions for each field in the current window in Cisco Unified Communications Manager Administration. In most cases, cross-references point to additional topics that relate to the current window.

About—Displays the Cisco Unified Communications Manager Administration main window and allows you to view the system software version.

The left pane of the Help system provides a table of contents for all of the product guides that the Help system includes. The table of contents expands to show the location within the hierarchy of the Help topic that displays on the right.

To learn more about the Cisco Unified Communications Manager Administration system, including instructions on how to search Help, click the Using Help link at the top of any Help window.

Additional Information

Cisco Unified Communications Manager Administration Basics

Finding and Deleting Records

You can search Cisco Unified Communications Manager for any records that you have added to the database through the Cisco Unified Communications Manager Administration windows or for records that exist as default entries. To find records, you navigate to the Find and List window for the record that you want to locate, such as Find and List Phones (Device > Phone). You can search for all records or enter search criteria to narrow your search. The search parameters vary, depending on the records for which you are searching. For example, when searching for a phone, you can search for phones with certain digits in the directory number or certain characters in the device name. When searching for an end user, you can search for first or last names that contain certain letters.

Once you have found records, you can delete them from the Find and List window that contains your records. You can delete individual records or delete all records that display in the window.

Use the following procedure to find and delete records from Cisco Unified Communications Manager Administration.

Procedure


Step 1 Navigate to the Find and List window in Cisco Unified Communications Manager Administration for the component that you want to find. For example, if you want to find a phone, choose Device > Phone to display the Find and List Phones window.

Step 2 To find all records in the database, ensure the dialog box is empty; go to Step 3.

Step 3 To filter or search records

From the first drop-down list box, select a search parameter. The search parameter represents the field on which you want to search. The search parameters vary, depending on the records type.

From the second drop-down list box, select a search pattern. The search pattern defines how the system searches the records. For example, you might want to search for records (or search parameters) that contain a certain value that you specify in the search text field.

Specify the appropriate search text, if applicable. The search text allows you to specify values for which you want to search. Use this field with the search parameter and search pattern fields. For example, if you choose "Directory Number" from the search parameter drop-down list box, choose "contains" from the search pattern drop-down list box, and enter 5551212 as the search text, the system searches for a directory number that contains the digits 5551212.


Note To add additional search criteria, click the + button. When you add criteria, the system searches for a record that matches all criteria that you specify. To remove criteria, click the - button to remove the last added criterion or click the Clear Filter button to remove all added search criteria.


Step 4 Click Find.

All matching records display.

You can change the number of items that display on each page by choosing a different value from the Rows per Page drop-down list box.

You can reverse the sort order, by clicking the up or down arrow, if available, in the list header.


Note You can delete multiple records from the database by checking the check boxes next to the appropriate record(s) and clicking Delete Selected. You can delete all configurable records for this selection by clicking the check box at the top of the column of check boxes and then clicking Delete Selected.


Step 5 From the list of records that display, click the link for the record that you want to view.

The window displays the item that you choose.


Additional Information

Cisco Unified Communications Manager Administration Basics

Adding and Copying Records

You can add items to the Cisco Unified Communications Manager by creating new records in Cisco Unified Communications Manager Administration and sometimes by copying existing records. Use the following procedure to add or copy records to the database.

Procedure


Step 1 Navigate to the Find and List window in Cisco Unified Communications Manager Administration for the component that you want to add (or copy). For example, if you want to add a trust element, choose Advanced Services > Intercompany Media Services > Trust Element to display the Find and List Trust Elements window.

Step 2 To add a new record, click the Add New button.

The window refreshes with a new record. Make the necessary changes, and click Save.

Step 3 To copy an existing record, do one of the following:

In the Find and List window, click the Copy button, if available.

Locate the record that you want to copy, as described in "Finding and Deleting Records" section. Choose the record, and click the Copy button in the configuration window. For example, find the trust element record that you want to copy, and click the Copy button in the Trust Element Configuration window.

The window refreshes with a new record. Make the necessary changes, and click Save.

Step 4 To copy an existing record and populate a new record with all of the associated information from the existing record:

In the Find and List window, click the Super Copy button, if available.

Locate the record that you want to copy, as described in "Finding and Deleting Records" section. Choose the record, and click the Super Copy button in the configuration window. For example, find the phone record that you want to copy, and click the Super Copy button in the Phone Configuration window.

The window refreshes with a new Device Name field. Make the necessary changes, and click Save.


Additional Information

Cisco Unified Communications Manager Administration Basics

Cisco IME Configuration Checklist

Table 3-1 provides an overview of the steps for configuring the Cisco Intercompany Media Engine (Cisco IME) feature in Cisco Unified Communications Manager Administration.


Note Before you begin, make sure that you have installed the Cisco Intercompany Media Engine software on the server and performed the post-installation tasks, including uploading the license file and enrolling the certificates. See the "Installation and Cisco IME Server Configuration" section on page 2-1.


Table 3-1 Cisco IME Configuration Checklist 

Configuration Steps
Related Procedures and Topics

Step 1 

Make sure that you have the appropriate adaptive security appliance (ASA) license.

For information, refer to the Cisco Unified Communications Manager Software Compatibility Matrix at http://www.cisco.com/en/US/docs/voice_ip_comm/cucm/compat/ccmcompmatr.html.

Step 2 

To allow calls to get rerouted to the ingress gateway device immediately if the Cisco IME trunks fail for any reason, set the Retry Count for SIP Invite service parameter to a small value. Reasons include TCP connection timeouts occur or the off-path ASA goes offline.

Cisco Systems recommends setting the parameter to a value of 2.

Tip To determine if you have UDP trunks, check the transport type of the SIP security profile ( System > Security > SIP Trunk Security Profile.)

If you keep the default value of 6 and an ASA outage occurs, Cisco Unified Communications Manager takes up to a minute to revert a Cisco IME call to the PSTN.

Note The Retry Count for SIP Invite service parameter applies to all SIP trunks that you configure on the Cisco Unified Communications Manager server.

1. Choose System > Service Parameters.

2. Choose the appropriate server from the Server drop-down list box.

3. Choose the Cisco CallManager service from the Service drop-down list box.

4. Set the value of the Retry Count for SIP Invite service parameter to the appropriate value.

5. Click Save.

Step 3 

Create an application user in Cisco Unified Communications Manager Administration.

Cisco Unified Communications Manager uses the application user name and password configuration when you activate the Cisco IME service on the Cisco Unified Communications Manager.

Cisco Unified Communications Manager obtains the IP address and port of the Cisco IME server and checks the application user name and password configuration for that server. Cisco Unified Communications Manager also checks the security setting and the application user information for the Cisco IME service.

Cisco Unified Communications Manager initiates a connection to the Cisco IME server over TCP. If the security mode specifies encrypted, a TLS connection gets established. That TLS connection uses the self-signed certificate that is created for Cisco Unified Communications Manager upon installation.

The certificate for the Cisco IME server must exist in the trust store on the Cisco Unified Communications Manager server.

The Cisco Unified Communications Manager node accepts any certificate from the Cisco IME server that exists in the trust store. Once the connection gets established, Cisco Unified Communications Manager sends a Register message that contains the user ID and password that associate with the application user for the Cisco IME service. The Cisco IME server checks the credentials against its configured username and password.

From Cisco Unified Communications Manager Administration, choose User Management > Application User and click Add New. In the User ID and Password fields in the Application User Configuration window, enter the VAP username and password that you configured on the Cisco IME server by using the add vapusercredentials CLI command, as described in Step 9 of Table 2-6.

Leave the other fields in the Application User Configuration window set to the default values.

If the username and password values that you enter in the Application User window do not match those of the VAP username and password on the Cisco IME server, the Cisco Unified Communications Manager server cannot register with the Cisco IME server.

Note You associate the application user to the server in the Intercompany Media Engine Server Connection Configuration window, as described subsequently in this checklist.

Step 4 

Ensure that the SIP security profile specifies the correct SIP listening port and the security mode to connect to the Cisco Intercompany Media Engine-enabled ASA. Check the Accept Out-of-Dialog REFER check box.

Note You must check the Accept Out-of-Dialog REFER check box to allow mid-call fallback to the PSTN.

1. Choose System > Security > SIP Trunk Security Profile.

2. Ensure that the value that is selected from Device Security Mode drop-down list box enables you to connect to the ASA. The value must match what you have configured on the ASA.

3. Ensure that the Incoming Port field contains the correct value of the port that Cisco Unified Communications Manager uses to communicate with the ASA. By default, Cisco Unified Communications Manager uses port 5060. If you are using a non-default port, you need to enter that port here.

4. Check the Accept Out-of-Dialog REFER check box.

5. To allow the Cisco IME trunk to accept unsolicited notification, replaces header, presence subscription, and to transmit security status, choose the corresponding check boxes in the SIP Trunk Security Profile Configuration window.

Step 5 

Configure a SIP trunk to use with Cisco Intercompany Media Engine.

The IME SIP trunk does not have a fixed destination IP address and port. Instead, the trunk obtains the remote IP address and port from the routing information that Cisco Unified Communications Manager learns through the Cisco IME network.

IME SIP trunks do not support IPv6, so ensure that the IME trunk specifies IPv4 only. If you do not have IPv6 enabled on your system, this issue does not apply.

Note You associate this trunk with an IME service later in this checklist.

1. Choose Device > Trunk and click Add New.

2. From the Trunk Type drop down list box, choose SIP Trunk.

3. From the Trunk Service Type drop-down list box, choose Cisco Intercompany Media Engine.

4. Click the Next button.

5. Configure the trunk by following these considerations:

For Cisco IME calls, the incoming calling and called numbers always specify an +E.164 number format; that is, globalized numbers preceded by "+". Based on the Cisco Unified Communications Manager dial plan and the routing architecture, you may also need to define calling and called party number transformations or translation patterns to allow the called number to route within Cisco Unified Communications Manager. Otherwise, incoming Cisco IME calls will fail with a digit analysis error.

For example, you may need to remove a leading "+" from the calling party number at the gateway level to allow the call to get routed in Cisco Unified Communications Manager.

To configure the necessary transformations, configure the fields in the Inbound Calls group box.

6. Restart the trunk.

For more information on configuring trunks, refer to the Cisco Unified Communications Manager Administration Guide.

Step 6 

To enable music on hold for Cisco IME calls, you must set the Cisco CallManager service parameter Duplex Streaming Enabled to true. This parameter determines whether music on hold and Annunciator use duplex streaming.

1. Choose System > Service Parameters.

2. From the Server drop-down list box, choose a server.

3. From the Service drop-down list box, choose the Cisco CallManager service.

4. Set the Duplex Streaming Enabled parameter to True.

Step 7 

Specify information about the Cisco IME server to which Cisco Unified Communications Manager connects, including the IP address and the port that VAP communications use.

Configuring Cisco IME Server Connections.

Step 8 

If you choose the Encrypted and Authenticated security mode for the Cisco IME server in Step 7, you must set up the TLS connection between the Cisco Intercompany Media Engine server and the into the Cisco IME server using third-party certificates or self-signed certificates.

Setting Up TLS Connections Between the Cisco Unified Communications Manager and Cisco Intercompany Media Engine Servers

Step 9 

Create the enrolled groups to which you can assign enrolled patterns. The enrolled patterns specify which numbers can participate in Cisco IME calls. The enrolled groups specify a collection of enrolled patterns.

After you create the enrolled group, create the enrolled patterns and assign the patterns to a group, as described in Step 10.

Tip For information on configuring enrolled groups in bulk, refer to the refer to the Cisco Unified Communications Manager Bulk Administration Guide.

Configuring a Cisco IME Enrolled Group

Step 10 

Specify the set of +E.164 numbers that you will allow to make and receive Cisco IME calls by creating enrolled patterns.

Configuring a Cisco IME Enrolled Pattern

Step 11 

Create an exclusion group to associate to numbers that you will prevent from using Cisco IME. (Optional)

Tip For information on configuring exclusion groups in bulk, refer to the refer to the Cisco Unified Communications Manager Bulk Administration Guide.

Configuring a Cisco IME Exclusion Group

Step 12 

Specify numbers that you will prevent from using Cisco IME, including numbers of analog devices and fax machines. Associate the exclusion numbers with an exclusion group that you created in Step 11.

Configuring a Cisco IME Exclusion Number

Step 13 

Create trust groups to which you can assign domains and prefixes, or trust elements, that the Cisco IME trusts (or does not trust). (Optional)

Note If you do not configure trust groups, Cisco IME trusts all prefixes and domains.

Tip For information on configuring trust groups in bulk, refer to the refer to the Cisco Unified Communications Manager Bulk Administration Guide.

Configuring a Cisco IME Trust Group

Step 14 

Specify the prefixes or domains that you want to trust or not trust and associate these trust elements with a trust group. You can only make Cisco IME calls to trusted elements.

Tip For information on configuring trust elements in bulk, refer to the refer to the Cisco Unified Communications Manager Bulk Administration Guide.

Configuring a Cisco IME Trust Element

Step 15 

Configure the Cisco IME service. This service defines the elements that you want this instance of Cisco IME to use, such as SIP trunk, trust group, exclusion group, and enrolled groups.

Configuring a Cisco IME Service

Step 16 

Define external IP addresses and ports for each Cisco Unified Communications Manager in the cluster, and associate the addresses with the Cisco IME service.

Configuring External IP Address and Port Information

Step 17 

Configure calling party and called party transformation patterns.

Note Make sure to apply transformations and reset your trunks during a maintenance window.

Configuring Transformation Patterns for Cisco IME

Step 18 

Configure two transformation profiles: one for incoming calling party numbers and one for incoming called party numbers.

Transformation profiles allow the system to convert the calling and called party numbers for incoming calls to a fully qualified +E.164 number format.

You associate the profiles with the Cisco IME transformations that are described in Step 19.

The system includes the transformed numbers in the voice call records (VCRs) that Cisco IME uses to validate PSTN calls.

Configuring a Cisco IME Transformation Profile

Step 19 

Configure Cisco IME +E.164 transformations. The transformations convert calling and called numbers on both the originating and terminating (incoming and outgoing) sides to +E.164 format after a PSTN call terminates.

You associate this transformation with all of the PSTN access trunks in your system in Step 20.

Configuring Cisco IME E.164 Transformations

Step 20 

Configure trunks to enable them to send VCRs to the Cisco IME server. You must configure any trunk that handles calls that might reach the PSTN.

Configuring PSTN Access Trunks

Step 21 

Review the feature parameters that apply to Cisco IME and make the appropriate changes. For instance, you may want to change the default value of the Enable Intradomain IME feature parameter. The default values of other feature parameters work for most configurations.

Configuring a Cisco IME Feature Configuration

Step 22 

(Optional) If you want to prevent certain devices or trunks from making Cisco IME calls, set up a common device configuration with Cisco IME turned off for outgoing calls, then associate that common device configuration with a device.

Note You can also disable Cisco Intercompany Media Engine from the Intercompany Media Services Feature Configuration window (Advanced Features > Intercompany Media Services > Feature Configuration) and create a common device configuration to enable Cisco IME for associated devices.

1. Choose Device > Device Settings > Common Device Configuration.

2. Create a common device configuration. To disable Cisco IME for devices that associate with this common device configuration, choose Off from the Use Intercompany Media (IME) for Outbound Calls drop-down list box. To enable Cisco IME, choose On from the drop-down list box.

The default value equals the value that you set for the Use IME for Outbound Calls field in the Intercompany Media Services Feature Configuration window (Advanced Features > Intercompany Media Services > Feature Configuration).

3. Associate the appropriate devices with this common device configuration. For more information on associating devices with a common device configuration, refer to the Cisco Unified Communications Manager Administration Guide

Step 23 

Verify the VAP connectivity between the Cisco IME server and the Cisco Unified Communications Manager server.

Verifying Connectivity

Configuring Fallback Information (Optional)

If you configure mid-call fallback information, the system detects voice quality issues based on the threshold that you set and switches only the audio path to a different bearer channel, most likely the PSTN. You must configure fallback on both the originating and terminating sides of the call in order for fallback to work.

Step 24 

Ensure that you checked the Accept Out-of-Dialog REFER check box in the SIP Trunk Security Profile window to allow mid-call fallback to the PSTN, as described in Step 4.

 

Step 25 

To prevent timeouts during PSTN fallback, Cisco recommends that you increase the Media Exchange Stop Streaming Timer to 12 seconds.

This parameter specifies the maximum seconds that the Cisco Unified Communications Manager waits to receive a response to a StopStreaming request. If the Cisco Unified Communications Manager does not receive a within the specified time, the Cisco Unified Communications Manager terminates the call.

1. Choose System > Service Parameters.

2. From the Server drop-down list box, choose a server.

3. From the Service drop-down list box, choose the Cisco CallManager service.

4. Set the Media Exchange Stop Streaming Timer parameter to 12 seconds.

Step 26 

Configure a fallback profile that defines several values that the Cisco Unified Communications Manager uses to fallback Cisco IME calls to the PSTN. (Optional)

Tip During the fallback configuration, a device associates with a device pool. The device pool can associate with an enrolled group, and the enrolled group can specify a fallback profile that contains the necessary information to allow the fallback to be set up.

Configuring a Fallback Profile

Step 27 

Associate the fallback profile with an enrolled group.

1. Choose Advanced Features > Intercompany Media Services > IME Enrolled Group. Find the enrolled group to associate with the fallback profile that you created.

2. From the Fallback Profile drop-down list box, choose the profile to associate with the selected enrolled group.

3. Click Save.

Step 28 

Associate the enrolled group that you associated with a fallback profile to a device pool.

Tip Devices associated with this device pool use caller ID for PSTN fallback using the patterns from the enrolled group in the device pool.

1. Choose System > Device Pool.

2. Find the device pool to which you want to associate the fallback profile that you configured in Step 27.

3. From the Intercompany Media Services Enrolled Group drop-down list box, choose the enrolled group.

4. Click Save.

Step 29 

Review the fallback feature parameters that Cisco Unified Communications Manager uses for mid-call fallback of Cisco IME calls to the PSTN. The default settings apply to most configurations.

Configuring Fallback Feature Parameters

Configuring Off-path Settings (Optional)

If you establish an off-path deployment in which inbound and outbound Cisco IME calls pass through an adaptive security appliance (ASA) that is enabled with the Cisco Intercompany Media Engine proxy but normal Internet-facing traffic does not flow through this ASA, you must configure the ASA that is enabled with the Cisco Intercompany Media Engine proxy as described in this section.

Step 30 

Configure the IP address and port of the ASA mapping service.

Configuring Intercompany Media Services Firewall Information

Step 31 

Configure the following feature parameters that apply to the firewall settings:

Firewall Connection Request Timer for IME Calls

Firewall Mapping Response Timer for IME Calls

Firewall Mapping Connection Idle Timer for IME calls

Configuring a Cisco IME Feature Configuration

General Information

Step 32 

You can view the routes that the Cisco Intercompany Media Engine learned as well as enable and disable learned routes.

Cisco Intercompany Media Engine Learned Routes

Configuring Cisco IME Server Connections

Use the Intercompany Media Engine Server Connection Configuration window to specify information about the Cisco Intercompany Media Engine (Cisco IME) server to which Cisco Unified Communications Manager connects. The information that you provide enables Cisco Unified Communications Manager to connect to the Cisco IME server to initiate VAP messaging. The interface between servers allows Cisco Unified Communications Manager to publish its configured direct inward dialing (DID) patterns and to learn new routes.

After Cisco Unified Communications Manager establishes a connection, Cisco Unified Communications Manager sends a VAP Register message to the Cisco IME server. This message contains the username that associates with the application user that the Application User field specifies. The Cisco IME server checks the credentials against the configured VAP username and password that you configured in Step 9 of the "Post-Installation Tasks" section on page 2-17. If the values do not match, validation does not occur and the Cisco IME server cannot communicate with the Cisco Unified Communications Manager server.


Note Cisco recommends that you install the Cisco IME server and ensure that the server is functional before configuring the Cisco IME server in Cisco Unified Communications Manager Administration.

If you configure the Cisco IME server in Cisco Unified Communications Manager Administration, make sure to deactivate the Cisco Intercompany Media Engine service in the Intercompany Media Service Configuration window (Advanced Features > Intercompany Media Services > Service) until the Cisco Intercompany Media Engine servers become available.

If the Cisco IME servers are not available when you configure Cisco Unified Communications Manager Administration, Cisco Unified Communications Manager continues to attempt to connect to the Cisco Intercompany Media Engine server based on the reconnect interval that you configure for the Cisco Intercompany Media Engine service.


To access the Intercompany Media Engine Server Connection Configuration window, choose Advanced Features > Intercompany Media Services > Server Connections.

Using the GUI

For instructions on how to use the Cisco Unified Communications Manager Administration Graphical User Interface (GUI) to find, delete, configure, or copy records, see the "Cisco Unified Communications Manager Administration Basics" section and its subsections, which explain how to use the GUI and detail the functions of the buttons and icons.

Configuration Settings Table

Table 3-2 describes the Cisco IME server configuration settings.

For related procedures, see the "Cisco IME Configuration Checklist" section.

Table 3-2 Cisco IME Server Configuration Settings 

Field
Description

Server Information

Name

Name of the Cisco IME server, up to 50 characters. Specify a name that is unique in the cluster.

Valid values include alphanumeric (a-z, A-Z, 0-9), period (.), dash (-), underscore (_), space ( ).

Description

Enter a descriptive name of the Cisco IME server. The description can comprise up to 128 characters. (Optional)

IP Address

Enter the IP address of the Cisco IME server to which Cisco Unified Communications Manager connects. You must enter an IPv4 address.

Port

Specify the port that the Cisco Unified Communications Manager server uses for Validation Access Protocol (VAP) communications to the Cisco IME server. The default specifies 5620. Valid values range from 0 to 65535.

The port number that you enter must match the port number that you configured on the Cisco IME server, as described in Step 6 of Table 2-6.

Authentication Information

Application User

Choose the application user that you configured in Step 3 of Table 3-1. The application user ID must match the vapusername that you configured in Step 6 of Table 2-6.

Server Security Mode

Choose the appropriate security mode for communications between the Cisco Unified Communications Manager server and the Cisco IME server, either Authenticated or Encrypted and Authenticated. The security mode that you choose must match the security mode that you configured on the Cisco Intercompany Media Engine server, as described in Step 6 of Table 2-6.

The Authenticated mode uses a digest-based authentication between the servers but does not encrypt the data. The Encrypted and Authenticated mode uses digest authentication that must run over a TLS connection between the Cisco Unified Communications Manager server and the Cisco IME server. If you choose Encrypted and Authenticated, you must upload the Cisco Intercompany Media Engine certificate into the Cisco Unified Communications Manager trust store by using the Cisco Unified Communications Operating System (Security > Certificate Management.). The default specifies Authenticated.

Cisco strongly recommends that you choose the Encrypted and Authenticated mode.

Note If you change the server security mode, the Cisco Unified Communications Manager closes the connections to the Cisco IME server.

Server Reconnect/VAP Retry Interval

Indicate the frequency (in seconds) with which you want the Cisco Unified Communications Manager server to try to connect to the Cisco IME server after losing connectivity. The Cisco Unified Communications Manager server tries to connect to the Cisco IME server indefinitely at this interval.

Valid values include 60 through 600 seconds. The default specifies 120 seconds.


Additional Information

Cisco IME Configuration Checklist

Setting Up TLS Connections Between the Cisco Unified Communications Manager and Cisco Intercompany Media Engine Servers

You can set up TLS connections between the Cisco Unified Communications Manager and Cisco Intercompany Media Engine (Cisco IME) servers using self-signed certificates or third-party certificates. See the following procedures:

Generating and Uploading a Self-Signed Certificate on the Cisco Intercompany Media Engine Server

Generating and Uploading Third Party Certificates for Cisco Intercompany Media Engine

Generating and Uploading a Self-Signed Certificate on the Cisco Intercompany Media Engine Server

If you want to set up a TLS connection between the Cisco Unified Communications Manager and Cisco Intercompany Media Engine (Cisco IME) servers using self-signed certificates, you must generate the self-signed certificate and upload the certificate to the appropriate trust store.

Use this procedure to use self-signed certificates.

Procedure


Step 1 On the Cisco IME server, log into the Cisco IME command line interface (CLI) and enter the show cert own IME command.

The Cisco IME certificate displays.

Step 2 Copy the contents of the certificate from "-----BEGIN CERTIFICATE-----" to "-----END CERTIFICATE-----", and paste it to a file named IME_Cert.pem that you store on your PC.

Step 3 On the Cisco Unified Communications Manager server that is going to connect to the Cisco IME server, login to Cisco Unified Communications Operating System, and choose Security > Certificate Management.

Step 4 Click Upload Certificate.

The Upload Certificate dialog box opens.

Step 5 Choose CallManager-trust from the Certificate Name drop down list.

Step 6 Choose the file to upload by doing one of the following steps:

In the Upload File text box, enter the path to the file.

Click the Browse button and navigate to the file; then, click Open.

Step 7 To upload the file to the Cisco Unified Communications Manager server, click the Upload File button.

Uploading the Cisco Unified Communications Manager Signed Certificate to the Cisco IME Server

Step 8 On the Cisco Unified Communications Manager server, display the certificates. To do this, choose Security >Certificate Management from the in the Cisco Unified Communications Operating Systemand click Find.

Step 9 Choose the CallManager.pem certificate. The description of this certificate indicates that it is a self-signed certificate generated by the system.

Step 10 Save the file to you PC by choosing the Download button.

Step 11 Open the file on your PC using a text editor, and copy the contents of the file from "-----BEGIN CERTIFICATE-----" to "-----END CERTIFICATE-----".

Step 12 Log into the Cisco IME CLI and enter the set cert import trust IME command.

Step 13 Paste the previously copied certificate.

Step 14 Make sure that the authentication mode on the Cisco IME specifies "encrypted" by entering the CLI command show ime vapserver vapservername, where vapservername is the name of the VAP server instance that you created on the Cisco IME server.

Step 15 On the Cisco Unified Communications Manager server, make sure that you set the authentication mode to Encrypted and Authenticated. To do this, log into Cisco Unified Communications Manager Administration, and display the Intercompany Media Engine Server Connection Configuration window (Advanced Features > Intercompany Media Services > Server Connections). Verify that the Server Security Mode for the corresponding Cisco IME Server equals Encrypted and Authenticated.

Verifying the Cisco Unified Communications Manager Signed Certificate Uploaded to the Cisco IME Server

Step 16 On the Cisco Unified Communications Manager server, display the CallManager.pem self-signed certificate by logging into the Cisco Unified Communications Operating System and choosing Security > Certificate Management. Click the Find button, and choose the CallManager.pem self-signed certificate from the list of certificates. The contents of the certificate displays.

Step 17 On the Cisco IME server, log into the Cisco IME CLI, locate the Cisco IME trust name by entering the show cert list trust command, and then enter the show cert trust trust name command.

Step 18 Compare the certificate content from the Cisco Unified Communications Manager server and the Cisco IME server and make sure that they match.


Note You must repeat this procedure for each Cisco Unified Communications Manager server that connects to the Cisco IME server.



Additional Information

Cisco IME Configuration Checklist

Generating and Uploading Third Party Certificates for Cisco Intercompany Media Engine

If you want to set up a TLS connection between the Cisco Unified Communications Manager and Cisco IME servers using third-party certificates, you must generate a Certificate Signing Request (CSR) and upload the certificates to the Cisco IME server. Then, generate the CSR and upload the third party certificate to the Cisco Unified Communications Manager server.

Use this procedure to generate the Certificate Signing Requests (CSRs) for the third party certificates and upload the certificates to the Cisco Unified Communications Manager and Cisco IME servers.

Procedure


Step 1 Generate the CSR for Cisco IME by logging into the Cisco IME command line interface (CLI) and entering the set csr gen IME command and then the show csr own IME command.

Step 2 Copy the CSR to the third party certificate agent (CA).

Step 3 Obtain and download the signed application certificate for Cisco IME and the root certificate from the CA.

Step 4 Import the root certificate to the Cisco IME server, by logging into the Cisco IME CLI and entering the set cert import trust IME command. Make note of the newly generated Cisco IME trust.

Step 5 Import the signed application certificate to the Cisco IME server by entering the set cert import own IME IME CA Cert command.

Step 6 Make sure that the authentication mode on the Cisco IME specifies encrypted by entering the show ime vapserver vapservername command, where vapservername is the name of the VAP server instance that you created on the Cisco IME server.

If you need to change the authentication mode, enter the set ime vapserver authenticationmode vapservername encrypted command.

Generating and Uploading a Third Party Certificate on the Cisco Unified Communications Manager Server

Step 7 Log into the Cisco Unified Communications Operating System, and choose Security > Certificate Management.

Step 8 Generate and download a CallManager CSR, as described in the Cisco Unified Communications Operating System Administration Guide. Make sure to choose CallManager from the Certificate Name drop-down list box.

Step 9 Obtain and download the third party signed application certificate and the root certificate from the certificate agent (CA) using the generated CSR.

Step 10 From the Cisco Unified Communications Operating System (Security > Certificate Management), upload the CallManager-Trust root certificate and CallManager signed certificate.

Step 11 Make sure that you set the authentication mode on the Intercompany Media Engine Server Connection Configuration window in Cisco Unified Communications Manager Administration (Advanced Features > Intercompany Media Services > Server Connections) to Encrypted and Authenticated.

Verify the certificate between Cisco IME and Cisco Unified Communications Manager

Step 12 In the Cisco Unified Communications Operating System, choose Security > Certificate Management.

Step 13 Find and display the CallManager root certificate that you uploaded in Step 10.

Step 14 Log into the Cisco IME server CLI, and use the show cert trust list command to obtain the name of the root certificate.

Step 15 Enter the show cert trust filename command, where filename equals the name of the certificate that you obtained in Step 14.

Step 16 Make sure that the root certificates on the Cisco Unified Communications Manager server and Cisco IME server match.


Note You must repeat Step 7 and Step 16 of this procedure for each Cisco Unified Communications Manager server that connects to the Cisco IME server.



Additional Information

Cisco IME Configuration Checklist

Configuring a Cisco IME Enrolled Group

You specify the numbers that you want to participate in Cisco Intercompany Media Engine (Cisco IME) by creating enrolled groups and patterns. Enrolled groups are a collection of enrolled patterns. These patterns define the set of +E.164 numbers that make and receive Cisco IME calls. Cisco IME publishes these numbers to the IME distributed cache. By doing so, Cisco IME makes these numbers available for other enterprises to learn through Cisco IME. Numbers within your enterprise must also match a pattern in an enrolled group in order to make Cisco IME calls. You can create an enrolled group for each of your campuses or sites to facilitate incremental deployment of Cisco IME, starting with certain sites or campuses and extending the deployment as usage grows.

After you create the enrolled group, you create the enrolled patterns, assign the patterns to a group, and associate the group with a Cisco IME service. If you want to disable Cisco IME for certain phones in the enterprise, you can unassign the enrolled group for those phones from the Cisco IME service.

To access the IME Enrolled Group Configuration window, choose Advanced Features > Intercompany Media Services > IME Enrolled Group.

Using the GUI

For instructions on how to use the Cisco Unified Communications Manager Administration Graphical User Interface (GUI) to find, delete, configure, or copy records, see the "Cisco Unified Communications Manager Administration Basics" section and its subsections, which explain how to use the GUI and detail the functions of the buttons and icons.

Configuration Settings Table

Table 3-3 describes the Cisco IME enrolled group configuration settings.

For related procedures, see the "Cisco IME Configuration Checklist" section.

Table 3-3 Cisco Intercompany Media Engine Enrolled Group Configuration Settings 

Field
Description

Group Name

Enter a unique name for the enrolled group. The name must be at least one character and can include up to 32 characters.

Description

Enter a description for the enrolled group. The description can include up to 128 characters. (Optional)

Fallback Profile

Choose the fallback profile that you want to associate to this enrolled group.

The fallback profile defines how Cisco Unified Communications Manager handles fallback to the PSTN for numbers that are associated with this enrolled group.

If you choose None, calls to direct inward dialing numbers (DIDs) in this pattern group do not fallback to the PSTN.

Configure fallback profiles in the Fallback Profile Configuration window. For more information, see the "Configuring a Fallback Profile" section.

Note If you are setting up Cisco IME for the first time, Cisco Systems recommends that you complete the rest of the Cisco Unified Communications Manager Administration configuration before you choose a fallback profile from this field.

All Patterns in Group Are Aliases

Check this check box if all of the patterns within the group need to be aliases to each other. For example, check this check box if you have 18xx numbers for which you enrolled the +E.164 numbers, but the service provider performs mapping from the 18xx number and provides the DID as the called party number for the 18xx instead.

Check this check box only if the patterns specify exact aliases to other patterns in the same group. Only exact patterns can be aliases; no wild cards are allowed.


Additional Information

Cisco IME Configuration Checklist

Configuring a Cisco IME Enrolled Pattern

Cisco Intercompany Media Engine (Cisco IME) enrolled patterns define the set of +E.164 numbers that make and receive Cisco IME calls. Cisco IME publishes these numbers to the IME distributed cache. By doing so, Cisco IME makes these numbers available for other enterprises to learn through Cisco IME. The patterns must specify valid direct inward dialing numbers (DIDs) that the enterprise owns. Numbers within your enterprise must match a pattern that is found in an enrolled group in order to make Cisco IME calls.

To eliminate the need for day-to-day provisioning of specific numbers as individual phones are added to and removed from the system, you can add a pattern that represents a large group of numbers for a given site. The enrolled pattern can include numbers that you have not assigned to a phone. Numbers that are not associated to a phone cannot be validated.

After you create enrolled patterns, you associate them to an enrolled group and assign the enrolled group to a Cisco Intercompany Media Engine service. You can disable or enable Cisco IME from calling certain phones in the enterprise by disassociating or associating the enrolled group to the Cisco IME service.


Note You can exclude specific numbers that fall within the range of an enrolled pattern from participating in Cisco IME by configuring exclusion groups and exclusion numbers. For more information, see the "Configuring a Cisco IME Exclusion Group" section and "Configuring a Cisco IME Exclusion Number" section.


To access the IME Enrolled Pattern Server Configuration window, choose Advanced Features > Intercompany Media Services > Enrolled Pattern.

Using the GUI

For instructions on how to use the Cisco Unified Communications Manager Administration Graphical User Interface (GUI) to find, delete, configure, or copy records, see the "Cisco Unified Communications Manager Administration Basics" section and its subsections, which explain how to use the GUI and detail the functions of the buttons and icons.

Configuration Settings Table

Table 3-4 describes the Cisco IME enrolled pattern configuration settings.

For related procedures, see the "Cisco IME Configuration Checklist" section.

Table 3-4 Cisco Intercompany Media Engine Enrolled Pattern
Configuration Settings 

Field
Description

Pattern

Create a unique pattern that contains the following characteristics:

Begins with a plus sign (+).

Contains up to 15 digits, including numbers between 0 and 9 and up to 3 wildcard (X) characters at the end of the pattern.

Wildcard characters represent numbers between 0 and 9.

The following patterns represent valid enrolled patterns:

+14089021xxx

+191937611xx

+14089523513

Description

Enter a descriptive name for the enrolled pattern. The description can contain up to 128 characters. (Optional)

Enrolled Group

Choose the Cisco IME enrolled group to associate with this enrolled pattern.

Note To configure more enrolled groups, see the "Configuring a Cisco IME Enrolled Group" section


Additional Information

Cisco IME Configuration Checklist

Configuring a Cisco IME Exclusion Group

Exclusion groups contain a list of numbers that you want to prevent from using Cisco Intercompany Media Engine (Cisco IME), including numbers of analog devices and fax machines. You create the exclusion group first and then you create exclusion numbers that you associate with a particular exclusion group. Then, you associate the exclusion group to the Cisco IME service.

This section describes how to create an exclusion group.

To access the Intercompany Media Services Exclusion Group Configuration window, choose Advanced Features > Intercompany Media Services > Exclusion Group.

Using the GUI

For instructions on how to use the Cisco Unified Communications Manager Administration Graphical User Interface (GUI) to find, delete, configure, or copy records, see the "Cisco Unified Communications Manager Administration Basics" section and its subsections, which explain how to use the GUI and detail the functions of the buttons and icons.

Configuration Settings Table

Table 3-5 describes the Cisco IME exclusion group configuration settings.

For related procedures, see the "Cisco IME Configuration Checklist" section.

Table 3-5 Cisco Intercompany Media Engine Exclusion Group Configuration Settings 

Field
Description

Name

Enter a unique name for the exclusion group. The name can comprise up to 32 characters in length.

Description

Enter a descriptive name of the exclusion group. The description can comprise up to 128 characters. (Optional)


Additional Information

Cisco IME Configuration Checklist

Configuring a Cisco IME Exclusion Number

Use the Intercompany Media Services Exclusion Number Configuration window to define numbers, sets of numbers, prefixes, or set of prefixes that you do not want to use Cisco Intercompany Media Engine (Cisco IME), even if these numbers occur within a list of numbers that is included in the Cisco IME enrolled pattern.

To access the Intercompany Media Services Exclusion Number Configuration window, choose Advanced Features > Intercompany Media Services > Exclusion Number.

Using the GUI

For instructions on how to use the Cisco Unified Communications Manager Administration Graphical User Interface (GUI) to find, delete, configure, or copy records, see the "Cisco Unified Communications Manager Administration Basics" section and its subsections, which explain how to use the GUI and detail the functions of the buttons and icons.

Configuration Settings Table

Table 3-6 describes the Cisco IME exclusion number settings.

For related procedures, see the "Cisco IME Configuration Checklist" section.

Table 3-6 Cisco Intercompany Media Engine Exclusion Number Configuration Settings 

Field
Description

Pattern

Specify the +E.164 number that you want to exclude from Cisco IME. You must precede the number by a plus sign (+). The number may contain up to 15 digits.

You must enter the exact +E.164 number with no wildcards.

Description

Enter a descriptive name of the exclusion number. The description can comprise up to 128 characters. (Optional)

Exclusion Group

From the drop-down list box, choose the Cisco IME group to associate with this exclusion number.

To configure additional exclusion groups, see the "Configuring a Cisco IME Exclusion Group" section.


Additional Information

Cisco IME Configuration Checklist

Configuring a Cisco IME Trust Group

Cisco Intercompany Media Engine (Cisco IME) trust groups contain a list of domains and prefixes that are trusted (or not trusted) by the Cisco IME service that associates with the trust group. Cisco Unified Communications Manager can only place Cisco IME calls to domains or prefixes that are trusted.

Configuration of trust groups is optional. If you do not create trust groups, Cisco IME trusts all calls by default.

This section describes how to configure a trust group. For information on creating domains and prefixes to include in the trust group, see the "Configuring a Cisco IME Trust Element" section.

To access the Intercompany Media Services Trusted Group Configuration window, choose Advanced Features > Intercompany Media Services > Trust Group.

Using the GUI

For instructions on how to use the Cisco Unified Communications Manager Administration Graphical User Interface (GUI) to find, delete, configure, or copy records, see the "Cisco Unified Communications Manager Administration Basics" section and its subsections, which explain how to use the GUI and detail the functions of the buttons and icons.

Configuration Settings Table

Table 3-7 describes the intercompany media services trust group configuration settings.

For related procedures, see the "Cisco IME Configuration Checklist" section.

Table 3-7 Intercompany Media Services Trust Group Configuration Settings 

Field
Description

Name

Enter a unique name for the trust group. The name can comprise up to 32 characters in length.

Description

Enter a descriptive name of the trust group. The description can comprise up to 128 characters. (Optional)

Trusted

Choose a trust value from the drop-down list box, either Yes (trusted) or No (untrusted).

You cannot change this value if any trust elements use this trust group. This limitation prevents you from accidentally changing an untrusted group (or blacklist) to a trusted group (or whitelist) by changing one value.

No default value exists. You must select a value.


Additional Information

Cisco IME Configuration Checklist

Configuring a Cisco IME Trust Element

Cisco Intercompany Media Engine (Cisco IME) trust elements specify prefixes or domain that you want to trust or not trust. You include the trust elements in a trust group. Cisco Unified Communications Manager can only place Cisco IME calls to domains or prefixes that are trusted. You cannot receive Cisco IME calls from a number whose prefix or domain is specified in an untrusted element.

This section describes how to create trust elements and how to associate the trust elements with a trust group. After you create the trust elements, you associate trust groups with an Cisco IME service to trust or not trust the prefixes or domains that the trust group specifies.

To access the Intercompany Media Services Trust Element Configuration window, choose Advanced Features > Intercompany Media Services > Trust Element.

Using the GUI

For instructions on how to use the Cisco Unified Communications Manager Administration Graphical User Interface (GUI) to find, delete, configure, or copy records, see the "Cisco Unified Communications Manager Administration Basics" section and its subsections, which explain how to use the GUI and detail the functions of the buttons and icons.

Configuration Settings Table

Table 3-8 describes the intercompany media services trust element configuration settings.

For related procedures, see the "Cisco IME Configuration Checklist" section.

Table 3-8 Intercompany Media Services Trust Element Configuration Settings 

Field
Description

Name

Enter a domain name or a prefix.

Domain names can contain up to 128 characters. You must specify a valid domain name.

Prefixes must begin with a "+" sign followed by up to 15 characters or up to 14 characters and a wildcard "!".

Description

Enter a descriptive name for the engine trust element. The description can comprise up to 128 characters. (Optional)

Element Type

Choose the appropriate element type, either "Domain" or "Prefix."

Trust Group

Choose the appropriate trust group. To include this element in a whitelist (trusted group), choose a trusted group from the drop-down list box. To include this element in a blacklist (untrusted group), choose an untrusted group from the drop-down list box.

For information on configuring trust groups, see the "Configuring a Cisco IME Trust Group" section


Additional Information

Cisco IME Configuration Checklist

Configuring a Cisco IME Service

Use the Intercompany Media Service Configuration window to configure and activate the Cisco Intercompany Media Engine (Cisco IME) service. To configure the Cisco IME service in Cisco Unified Communications Manager Administration, you associate various components that you have already configured, including trusted groups, enrolled groups, and exclusion groups. You indicate the Cisco IME server with which you want Cisco Unified Communications Manager to communicate. Communications between the Cisco Unified Communications Manager and the Cisco IME servers begin after you configure and activate the Cisco IME service.

To begin load balancing so that the system work spreads across multiple Cisco Intercompany Media Engine servers, create more than one Cisco Intercompany Media Engine service with different Cisco Intercompany Media Engine servers and move some of the enrolled groups from the old Cisco Intercompany Media Engine service to the new service.

To access the Intercompany Media Service Configuration window, choose Advanced Features > Intercompany Media Services > Service.

For information about the CUCM External Address List pop-up window, see the "Configuring External IP Address and Port Information" section.

Using the GUI

For instructions on how to use the Cisco Unified Communications Manager Administration Graphical User Interface (GUI) to find, delete, configure, or copy records, see the "Cisco Unified Communications Manager Administration Basics" section and its subsections, which explain how to use the GUI and detail the functions of the buttons and icons.

Configuration Settings Table

Table 3-9 describes the intercompany media service configuration settings.

For related procedures, see the "Cisco IME Configuration Checklist" section.

Table 3-9 Intercompany Media Service Configuration Settings 

Field
Description

Intercompany Media Service Information

Name

Enter a unique name for the Cisco IME service. The name can comprise up to 50 characters in length.

Description

Enter a descriptive name for the Cisco IME service. The description can comprise up to 128 characters in length. (Optional)

Domain

Enter the domain name to use with Cisco IME. Typically, you specify the domain name of your enterprise, such as cisco.com.

The domain name must match the domain name that is contained in the SSL certificate from GoDaddy.com for the ASA.

SIP Trunk

Choose the SIP trunk that you want to use with this service.

The drop-down list box populates with trunks that specify the Cisco Intercompany Media Engine trunk service type.

The trunk that you select runs on a specific set of nodes in the cluster, as defined by the Cisco Unified Communications Manager group that associates with the trunk. The Cisco IME service also runs on that same set of nodes.

Tip You configured Cisco Intercompany Media Engine trunks in Step 5 of the "Cisco IME Configuration Checklist" section.

Trust Group

If desired, choose a trust group. Trust groups contain a list of domains and prefixes that are trusted (or untrusted) by the Cisco IME service with which the group associates. Cisco Unified Communications Manager can only place Cisco IME calls to domains or prefixes that are trusted.

The drop-down list box populates with servers that you configured in the Intercompany Media Services Trust Group Configuration window (Advanced Features > Intercompany Media Services > IME Trusted Group).

If you do not choose a trust group, Cisco IME trusts all prefixes and domains.

Exclusion Group

If desired, choose an exclusion group. Exclusion groups contain numbers that you want to prevent from using Cisco Intercompany Media Engine.

The drop-down list box populates with servers that you configured in the Intercompany Media Services Exclusion Group Configuration window (Advanced Features > Intercompany Media Services > IME Exclusion Group).

Firewall

If you are using an off-path ASA deployment model, choose the firewall to associate with this service.

Available Enrolled Groups

This list box displays the enrolled groups that are available for association with this Cisco IME service. Enrolled groups specify the set of +E.164 numbers that make and receive Cisco IME calls.

To associate an enrolled group with this Cisco IME service, select the enrolled group and click the Down arrow below this list box.

Selected Enrolled Groups

This list box displays the enrolled groups that associate with this Cisco IME service. To remove an enrolled group, select the enrolled group name and click the Up arrow above this list box. To add an enrolled group, select an enrolled group in the Available Enrolled Groups list box and click the Down arrow between the list group boxes. You can reorder the enrolled groups by clicking the Up and Down arrows to the right of the list box.

Activated

Check the Activated check box to activate the Cisco IME service. If you do not activate the service, you cannot make and receive Cisco IME calls.

Server Information

Primary IME Server

Choose a primary Cisco IME server.

The drop-down list box populates with servers that you configure in the Intercompany Media Server Connection Configuration window (Advanced Features > Intercompany Media Services > Server Connections).

You can use the selected server in more than one service.

If you define multiple Cisco IME services but you have only one Cisco IME server, you can associated multiple Cisco IME services with a single server.

Secondary IME Server

(Optional) Choose a secondary Cisco IME server.

The drop-down list box populates with servers that you configure in the Intercompany Media Server Connection Configuration window (Advanced Features > Intercompany Media Services > Server Connections).

You must choose different servers for the primary and secondary Cisco IME servers.

You can use the selected server in more than one service.


Additional Information

Cisco IME Configuration Checklist

Configuring External IP Address and Port Information

Use the CUCM External Address List pop-up window to define an external IP address and port for each Cisco Unified Communications Manager in the cluster. The IP address and port represent the global (or real) address that the Cisco Unified Communications Manager advertises to the Cisco Intercompany Media Engine (Cisco IME) service. Other enterprises learn this address and use it to route Cisco IME calls. Ensure that all enterprises that use Cisco IME can resolve the IP address or hostname that you provide.

For inbound calls, the Cisco Intercompany Media Engine-enabled ASA utilizes network address translation (NAT). A specific IP/port on one of the ASA interfaces has a static mapping to each Cisco Unified Communications Manager node on the inside. Cisco Unified Communications Manager, through its existing configuration, advertises the IP/port on the ASA instead. As a result, inbound calls arrive at the Cisco Intercompany Media Engine-enabled ASA.

You need to provide external IP addresses or hostnames if your Cisco Unified Communications Manager servers reside behind a firewall or NAT.

To access the CUCM External Address List pop-up window, find the Cisco IME service to which you want to associate the IP Address and port by choosing Advanced Features > Intercompany Media Services > Service. From the Related Links drop-down list box in the Intercompany Media Service Configuration window, choose the Add/Update CUCM External Address List option and click Go.

Table 3-10 describes the address list configuration settings.

For related procedures, see the "Cisco IME Configuration Checklist" section.

Table 3-10 CUCM External Address List Configuration Settings 

Field
Description
CUCM External Address List

Cisco Unified CM

Displays the Cisco Unified Communications Manager servers in your system.

IP Address/Host

Enter the IP address or hostname that you want other enterprises to use to route calls to your enterprise. You must provide an IP address or hostname that all enterprises that use Cisco IME can resolve.

Port

Enter the port to use for external Cisco IME traffic.


Additional Information

Cisco IME Configuration Checklist

Configuring Transformation Patterns for Cisco IME

Configure transformation patterns of called and calling party numbers so that the transformations provide +E.164 numbers. You may need to add or remove digits as well as prefix digits including the "+" sign to get the numbers in +E.164 format.

To access the Calling Party Transformation Pattern Configuration window, choose Call Routing > Transformation > Transformation Pattern > Calling Party Transformation Pattern.

To access the Called Party Transformation Pattern Configuration window, choose Call Routing > Transformation > Transformation Pattern > Called Party Transformation Pattern.

For calling and called party transformation pattern configuration settings, refer to the Cisco Unified Communications Manager Administration Guide or choose Help > This Page in the respective window in Cisco Unified Communications Manager Administration.

For related procedures, see the "Cisco IME Configuration Checklist" section.

Additional Information

Cisco IME Configuration Checklist

Configuring a Cisco IME Transformation Profile

Transformation profiles allow the system to convert the calling and called party numbers for outgoing calls to a fully qualified +E.164 number format. The system includes the transformed numbers in the voice call records (VCRs) that Cisco Intercompany Media Engine (Cisco IME) uses to validate PSTN calls. The number transformation takes place after normal call routing processing. Cisco Unified Communications Manager does not use transformation profiles for call routing.

You must create one profile for the incoming called number and one for the incoming calling number. You associate the transformation profiles with the Cisco IME transformation as described in "Configuring Cisco IME E.164 Transformations" section.


Note Cisco IME does not upload VCRs that do not contain numbers in +E.164 format.


To access the Transformation Profile Configuration window, choose Call Routing > Transformation > Transformation Profile.

Using the GUI

For instructions on how to use the Cisco Unified Communications Manager Administration Graphical User Interface (GUI) to find, delete, configure, or copy records, see the "Cisco Unified Communications Manager Administration Basics" section and its subsections, which explain how to use the GUI and detail the functions of the buttons and icons.

Configuration Settings Table

Table 3-11 describes the transformation profile configuration settings.

For related procedures, see the "Cisco IME Configuration Checklist" section.

Table 3-11 Cisco Intercompany Media Engine Transformation Profile Configuration Settings 

Field
Description

Transformation Profile Information

Name

Enter a unique name for the transformation profile. The name can comprise up to 50 characters in length.

Description

Enter a descriptive name for the transformation profile. The description can comprise up to 128 characters in length. (Optional)

Incoming Party Setting

Clear Prefix Settings

To delete prefixes for all calling party number types, click the Clear Prefix Settings button.

Default Prefix Settings

To reset prefixes for all calling party number types to the default values, click the Default Prefix Settings button.

National Number

Configure the following settings to globalize calling party numbers that use National for the Number Type. The National number type gets used for calls within your country.

Prefix—Cisco Unified Communications Manager applies the prefix that you enter in this field to calling party numbers that use National for the Calling Party Number Type. You can enter up to eight characters, which include digits, the international escape character (+), asterisk (*), or the octothorpe (#). You can enter the word, Default, instead of entering a prefix.

Tip If the word, Default, displays in the Prefix field in the Gateway Configuration or Trunk Configuration window, you cannot configure the Strip Digits field in the Gateway Configuration or Trunk Configuration window. In this case, Cisco Unified Communications Manager takes the configuration for the Prefix and Strip Digits fields from the device pool that applies to the device. If the word, Default, displays in the Prefix field in the Device Pool Configuration window, Cisco Unified Communications Manager applies the service parameter configuration for the incoming calling party prefix, which supports both the prefix and strip-digit functionalities.
Tip To configure the Strip Digits field in the Device Pool Configuration, Gateway Configuration, or Trunk Configuration window, you must leave the Prefix field blank or enter a valid configuration in the Prefix field. To configure the Strip Digits fields in these windows, do not enter the word, Default, in the Prefix field.

Strip Digits—Enter the number of digits that you want Cisco Unified Communications Manager to strip from the calling party number of National number type before Cisco Unified Communications Manager applies the prefixes.

Calling Search Space—This setting allows you to globalize the calling party number of National calling party number type on the device. Make sure that the calling search space that you choose contains the calling party transformation pattern that you want to assign to this device.

International Number

Configure the following settings to globalize calling party numbers that use International for the Number Type. The International number type gets used for calls outside the dialing plan for your country.

Prefix—Cisco Unified Communications Manager applies the prefix that you enter in this field to calling party numbers that use International for the Calling Party Numbering Type. You can enter up to eight characters, which include digits, the international escape character (+), asterisk (*), or the octothorpe (#). You can enter the word, Default, instead of entering a prefix.

Tip If the word, Default, displays in the Prefix field in the Gateway Configuration or Trunk Configuration window, you cannot configure the Strip Digits field in the Gateway Configuration or Trunk Configuration window. In this case, Cisco Unified Communications Manager takes the configuration for the Prefix and Strip Digits fields from the device pool that applies to the device. If the word, Default, displays in the Prefix field in the Device Pool Configuration window, Cisco Unified Communications Manager applies the service parameter configuration for the incoming calling party prefix, which supports both the prefix and strip-digit functionalities.
Tip To configure the Strip Digits field in the Device Pool Configuration, Gateway Configuration, or Trunk Configuration window, you must leave the Prefix field blank or enter a valid configuration in the Prefix field. To configure the Strip Digits fields in these windows, do not enter the word, Default, in the Prefix field.

Strip Digits—Enter the number of digits that you want Cisco Unified Communications Manager to strip from the calling party number of International type before Cisco Unified Communications Manager applies the prefixes.

Calling Search Space—This setting allows you to globalize the calling party number of International calling party number type on the device. Make sure that the calling party transformation CSS that you choose contains the calling party transformation pattern that you want to assign to this device.

Tip Before the call occurs, the device must apply the transformation by using digit analysis. If you configure the CSS as None, the transformation does not match and does not get applied. Ensure that you configure the calling party transformation pattern in a non-null partition that is not used for routing.

Unknown Number

Configure the following settings to globalize calling party numbers that use Unknown for the Number Type. The Unknown number type gets used when the dialing plan is unknown.

Prefix—Cisco Unified Communications Manager applies the prefix that you enter in this field to calling party numbers that use Unknown for the Calling Party Numbering Type. You can enter up to eight characters, which include digits, the international escape character (+), asterisk (*), or the octothorpe (#). You can enter the word, Default, instead of entering a prefix.

Tip If the word, Default, displays in the Prefix field in the Gateway Configuration or Trunk Configuration window, you cannot configure the Strip Digits field in the Gateway Configuration or Trunk Configuration window. In this case, Cisco Unified Communications Manager takes the configuration for the Prefix and Strip Digits fields from the device pool that applies to the device. If the word, Default, displays in the Prefix field in the Device Pool Configuration window, Cisco Unified Communications Manager applies the service parameter configuration for the incoming calling party prefix, which supports both the prefix and strip-digit functionalities.
Tip To configure the Strip Digits field in the Device Pool Configuration, Gateway Configuration, or Trunk Configuration window, you must leave the Prefix field blank or enter a valid configuration in the Prefix field. To configure the Strip Digits fields in these windows, do not enter the word, Default, in the Prefix field.

Strip Digits—Enter the number of digits that you want Cisco Unified Communications Manager to strip from the calling party number of Unknown type before Cisco Unified Communications Manager applies the prefixes.

Calling Search Space—This setting allows you to globalize the calling party number of Unknown calling party number type on the device. Make sure that the calling party transformation CSS that you choose contains the calling party transformation pattern that you want to assign to this device.

Tip Before the call occurs, the device must apply the transformation by using digit analysis. If you configure the CSS as None, the transformation does not match and does not get applied. Ensure that you configure the calling party transformation pattern in a non-null partition that is not used for routing.

Subscriber Number

Configure the following settings to globalize calling party numbers that use Subscriber for the Number Type. The Subscriber number type gets used when you are dialing a subscriber by using a shortened subscriber number.

Prefix—Cisco Unified Communications Manager applies the prefix that you enter in this field to calling party numbers that use Subscriber for the Calling Party Numbering Type. You can enter up to eight characters, which include digits, the international escape character (+), asterisk (*), or the octothorpe (#). You can enter the word, Default, instead of entering a prefix.

Tip If the word, Default, displays in the Prefix field in the Gateway Configuration or Trunk Configuration window, you cannot configure the Strip Digits field in the Gateway Configuration or Trunk Configuration window. In this case, Cisco Unified Communications Manager takes the configuration for the Prefix and Strip Digits fields from the device pool that applies to the device. If the word, Default, displays in the Prefix field in the Device Pool Configuration window, Cisco Unified Communications Manager applies the service parameter configuration for the incoming calling party prefix, which supports both the prefix and strip-digit functionalities.
Tip To configure the Strip Digits field in the Device Pool Configuration, Gateway Configuration, or Trunk Configuration window, you must leave the Prefix field blank or enter a valid configuration in the Prefix field. To configure the Strip Digits fields in these windows, do not enter the word, Default, in the Prefix field.

Strip Digits—Enter the number of digits that you want Cisco Unified Communications Manager to strip from the calling party number of Subscriber type before Cisco Unified Communications Manager applies the prefixes.

Calling Search Space—This setting allows you to globalize the calling party number of Subscriber calling party number type on the device. Make sure that the CSS that you choose contains the calling party transformation pattern that you want to assign to this device.

Tip Before the call occurs, the device must apply the transformation by using digit analysis. If you configure the CSS as None, the transformation does not match and does not get applied. Ensure that you configure the calling party transformation pattern in a non-null partition that is not used for routing.

Additional Information

Cisco IME Configuration Checklist

Configuring Cisco IME E.164 Transformations

Cisco Intercompany Media Engine (Cisco IME) E.164 transformations convert calling numbers and called numbers on both the originating and terminating (incoming and outgoing) sides to +E.164 format after a PSTN call terminates. Cisco IME E.164 transformations do not impact call routing or digit analysis in Cisco Unified Communications Manager. The transformations allow the following actions to occur:

Send UploadVCRs to the Cisco Intercompany Media Engine server for unlearned direct inward dialing numbers (DIDs).

Reroute calls to the Cisco IME trunk if the DID exists in the learned table.

You associate Cisco IME E.164 transformations with a PSTN access trunk. If the transformation does not yield valid calling and called numbers on the incoming and outgoing sides of the call, no VCR upload takes place, and Cisco IME processing stops for that call.

To access the Intercompany Media Services E.164 Transformation Configuration window, choose Advanced Features > Intercompany Media Services > E.164 Transformation.

Using the GUI

For instructions on how to use the Cisco Unified Communications Manager Administration Graphical User Interface (GUI) to find, delete, configure, or copy records, see the "Cisco Unified Communications Manager Administration Basics" section and its subsections, which explain how to use the GUI and detail the functions of the buttons and icons.

Configuration Settings Table

Table 3-12 describes the transformation configuration settings.

For related procedures, see the "Cisco IME Configuration Checklist" section.

Table 3-12 Cisco Intercompany Media Engine E.164 Transformation
Configuration Settings 

Field
Description
E.164 Transformation

Name

Enter a unique name for the transformation profile. This name can comprise up to 50 characters in length.

Description

Enter a descriptive name for the transformation profile. The description can comprise up to 128 characters in length. (Optional)

Outgoing Calling Party Settings

Outgoing Party E.164 Transformation CSS

From the drop-down list box, choose the appropriate calling search space for the calling party on outgoing calls.

Choose a calling search space that contains the partitions used by the calling party transformation pattern that you configured on the Calling Party Transformation window (Call Routing > Transformation > Transformation Pattern > Calling Party Transformation Pattern).

Apply On

Choose whether you want to apply the calling search space to the original number or to the routing transformed number.

Outgoing Called Party Settings

Outgoing Party E.164 Transformation CSS

From the drop-down list box, choose the appropriate calling search space for the called party on outgoing calls.

Choose a calling search space that contains the partitions used by the called party transformation pattern that you configured on the Called Party Transformation window (Call Routing > Transformation > Transformation Pattern > Called Party Transformation Pattern).

Apply On

Choose whether you want to apply the calling search space to the original number or to the routing transformed number.

Incoming Transformation Profile Settings

Incoming Calling Party Transformation Profile

Choose the appropriate incoming calling party transformation profile that you configured in the Transformation Profile Configuration window (Call Routing > Transformation > Transformation Profile), as described in the "Configuring a Cisco IME Transformation Profile" section.

Incoming Called Party Transformation Profile

Choose the appropriate incoming called party transformation profile that you configured in the Transformation Profile Configuration window (Call Routing > Transformation > Transformation Profile), as described in the "Configuring a Cisco IME Transformation Profile" section.


Additional Information

Cisco IME Configuration Checklist

Configuring PSTN Access Trunks

Configure any SIP, MGCP, or H.323 trunk that handles calls that might reach the PSTN as a PSTN trunk. PSTN access trunks enable the system to send voice call records (VCRs) to the Cisco Intercompany Media Engine (Cisco IME) server. To configure PSTN access trunks, check the PSTN Access check box in the Trunk Configuration window and choose the appropriate E.164 transformation. If you do not configure a PSTN access trunk, Cisco Unified Communications Manager does not upload VCRs after calls terminate.

If a SIP trunk in your network connects to a SIP gateway that connects to the PSTN, you can configure this SIP trunk as a PSTN access trunk. If another SIP trunk that is an intercluster trunk connects to another cluster in your network, you do not have to configure this SIP trunk as a PSTN access trunk, because calls from this trunk will never go to the PSTN.

Procedure


Step 1 Choose Device > Trunk, and find a trunk that you want to configure as a PSTN access trunk.

Step 2 Check the PSTN Access check box.

Step 3 From the E.164 Transformation Profile drop-down list box, choose the appropriate E.164 transformation profile that you configured in the E.164 Transformation Configuration window (Advanced Features > Intercompany Media Services > E.164 Transformation). The profile transforms the called party and calling party numbers to +E.164 format. Numbers must use +E.164 format for call validation.

If you do not choose a profile from this drop-down list box, Cisco Unified Communications Manager does not upload VCRs to the Cisco Intercompany Media Engine server.


Additional Information

Cisco IME Configuration Checklist

Configuring a Cisco IME Feature Configuration

Use the Intercompany Media Services Feature Configuration window to configure feature parameters that apply to Cisco Intercompany Media Engine (Cisco IME).

To access the Intercompany Media Services Feature Configuration window, choose Advanced Features > Intercompany Media Services > Feature Configuration.

Configuration Settings Table

Table 3-13 describes the Intercompany Media Services feature configuration settings.

For related procedures, see the "Cisco IME Configuration Checklist" section.

Table 3-13 Intercompany Media Services Feature Configuration Settings 

Field
Description
Intercompany Media Services Parameters

Allow IME Calls through MGCP FXS/FXOs

Indicate whether Cisco IME allows MGCP FXS/FXO analog gateway devices, such as those used to connect to fax machines, to make Cisco IME calls. Choose True to allow MGCP FXO/FXS gateways to make Cisco IME calls. Choose False to prevent MGCP FXO/FXS gateways from making Cisco IME calls.

The default value specifies False.

Enable Intradomain IME

Indicate whether you want to enable Cisco IME for calls to another cluster within your enterprise. Generally, intercluster trunks manage calls between clusters; however, if you are using the PSTN between clusters within the same domain, you can use Cisco IME to learn the patterns between those clusters by enabling this field.

Choose True to enable Cisco IME between clusters in the same enterprise domain. Choose False to disable Cisco IME between clusters in the same enterprise domain

The default value specifies False.

Allow MWI via IME Learned Routes

Indicate whether Cisco Unified Communications Manager can use Cisco IME learned routes for message waiting indicator (MWI) notifications. Choose True to allow Cisco Unified Communications Manager to use Cisco IME learned routes for MWI messages. Choose False to prevent Cisco Unified Communications Manager from using Cisco IME learned routes for MWI messages.

The default value specifies True.

SIP Trunk IME Connection Timer for Destination Enterprise

Specify the amount of time in seconds that a Cisco IME SIP trunk attempts to establish a connection to a SIP uniform resource identifier (URI) that exists for a learned route to a destination enterprise. When this timer expires, the SIP trunk attempts to establish a connection to the next URI, if available, for that learned route to the destination enterprise.

The default value specifies 2 seconds. Valid values range from 1 to 5.

Firewall Connection Request Timer for IME Calls

Specify the amount of time, in seconds, that the Cisco Unified Communications Manager waits to establish a TCP connection with the Cisco IME firewall. If the firewall does not send a connection response to the Cisco Unified Communications Manager connection request before the timer expires, Cisco Unified Communications Manager continues the call without going through the Cisco IME firewall. In other words, Cisco Unified Communications Manager makes a PSTN call.

The default value specifies 2 seconds. Valid values range from 1 to 5.

Firewall Mapping Response Timer for IME Calls

Specify the amount of time, in seconds, that the Cisco Unified Communications Manager waits to complete a mapping transaction (request and response) with the Cisco IME firewall. If the firewall does not send a mapped address response to the Cisco Unified Communications Manager mapped address request before the timer expires, Cisco Unified Communications Manager continues the call without going through the Cisco IME firewall. In other words, Cisco Unified Communications Manager makes a PSTN call.

The default value specifies 2 seconds. Valid values range from 1 to 5.

Firewall Mapping Connection Idle Timer for IME calls

Specify the amount of time, in minutes, that the connection between the Cisco Unified Communications Manager and the Cisco IME firewall can remain idle before Cisco IME firewall tears down the connection with the Cisco Unified Communications Manager.

This timer begins when Cisco Unified Communications Manager stops sending new call requests to the Cisco IME firewall.

You can choose a higher value in this field to decrease delay in establishing new calls through the Cisco IME firewall, or you can choose a lower value to close the connection sooner. A lower value enhances security but may cause a minor delay in establishment of new calls.

The default value specifies 10. Valid values range from 5 to 60.

ICM Failed Call Attempt Threshold

Specify the percentage of failed Cisco IME call attempts to exceed before Cisco Unified Communications Manager generates the IMEQualityAlertEntry alarm.

When the percentage of failed Cisco IME call setup attempts falls below the threshold defined in this field and the system does not exceed the fallback threshold that the IME Call Fallback Attempt Threshold field specifies, Cisco Unified Communications Manager triggers the IMEQualityAlertExit alarm, which clears the IMEQualityAlertEntry alarm.

Entering a higher threshold value makes the system more tolerant of failed Cisco IME call attempts, so that more calls fail before Cisco Unified Communications Manager triggers an alarm. A higher value may be useful during minor network outages.

Entering a lower threshold value makes the system less tolerant of Cisco IME call setup failures, so fewer calls fail before Cisco Unified Communications Manager triggers an IMEQualityAlertEntry alarm.

The default value specifies 50 percent. Valid values range from 10 to 100.

ICM Call Fallback Attempt Threshold

Specify the percentage of active Cisco IME calls that fallback to the PSTN to exceed before Cisco Unified Communications Manager generates the IMEQualityAlertEntry alarm.

When the percentage of Cisco IME calls that experience mid-call fallback to the PSTN falls below the threshold defined in this field and the percentage of failed Cisco IME call setup attempts falls below the value specified in the IME Failed Call Attempt Threshold field, Cisco Unified Communications Manager generates the IMEQualityAlertExit alarm, which clears the IMEQualityAlertEntry alarm.

Entering a higher threshold value makes the system more tolerant of Cisco IME calls that experience mid-call fallback to the PSTN, so that more calls fallback to the PSTN before Cisco Unified Communications Manager triggers an alarm. A higher value may be useful during minor network outages.

Entering a lower threshold value makes the system less tolerant of Cisco IME calls that experience mid-call fallback to the PSTN, so fewer calls fallback before Cisco Unified Communications Manager triggers an IMEQualityAlertEntry alarm.

The default value specifies 50. Valid values range from 10 to 100.

ICM Quality Alert Evaluation Interval

Specify the time interval in seconds that Cisco Unified Communications Manager uses to check the status of the ICM Failed Call Attempt Threshold and ICM Call Fallback Attempt Threshold parameters to determine whether to continue generating the IMEQualityAlertEntry alarm.

The default value specifies 120. Valid values range from 30 to 1800.

Use IME for Outbound Calls

Specify whether to allow devices to make calls using the Cisco Intercompany Media Engine feature. Choose True to allow devices to make Cisco IME calls. Choose False to prevent devices from making Cisco IME calls.

The default value specifies True.


Additional Information

Cisco IME Configuration Checklist

Verifying Connectivity

The Cisco Unified Communications Manager server and the Cisco Intercompany Media Engine (Cisco IME) server communicate using the Validation Access Protocol (VAP). Without the communication between the servers, Cisco Unified Communications Manager cannot learn Cisco IME routes, and users cannot make Cisco IME calls. To determine if the VAP connection exists, you must verify that the Cisco Unified Communications Manager server registers with the Cisco IME server and that the Cisco Unified Communications Manager server has published Vservices with the Cisco IME server.

See the following sections:

Registration Status

Vservice Publication

DID Publication

Additional Information

Cisco IME Configuration Checklist

Registration Status

You can monitor the status of the connection between the Cisco Unified Communications Manager server and the Cisco Intercompany Media Engine (Cisco IME) server using one of the following methods.


Note After you verify the registration status, you can continue to verify connectivity between the Cisco Unified Communications Manager server and the Cisco IME server by verifying that the Cisco Unified Communications Manager server has published the Cisco IME service (or Vservice) to the Cisco IME server. as described in the "Vservice Publication" section.


From the CLI

From the Cisco Intercompany Media Engine CLI, enter the following command:

show ime vapstatus summary

This command displays the registration status for the client specified by port number. Make sure that the Registration Status equals Registered, and the Client IP ADDR equals the IP address of the Cisco Unified Communications Manager server.

The following example shows the output of the show ime vapstatus summary command in which the Cisco Unified Communications Manager registered with the Cisco IME server:

admin:show ime vapstatus summary
VAP Client Connection Details
Registration Status ...... Registered
Client IP ADDR............ 10.94.150.96
Client Handle ............ 1
Packets Sent ............. 106
Packets Rcvd ............. 106
VAPServer Name ........... vapuser
Missed Keep Alive Count .. 0
Connection Up Time ....... 3 hours 7 min 0 sec

From RTMT

Access the Cisco Unified Communications Manager server using RTMT, and choose the following menu and counter:

System > Performance > Open Performance Monitoring > IME Client Instance > VAPStatus

If a connection between the Cisco IME server and Cisco Unified Communications Manager server exists, the counter should equal 1 (healthy). The valid values equal: 0=unknown; 1=healthy; 2=unhealthy.


Note This counter monitors connections to primary and secondary Cisco IME servers.


Additional Information

Cisco IME Configuration Checklist

Vservice Publication

Once you have verified the registration status of the Cisco Unified Communications Manager server to the Cisco Intercompany Media Engine (Cisco IME) server, you can continue to verify the connectivity between servers by verifying that the Cisco Unified Communications Manager server has published the Cisco IME service (or Vservice) to the Cisco IME server.

Cisco Unified Communications Manager publishes the Vservice after you check the Activated checkbox on the Intercompany Media Service Configuration window (Advanced Features > Intercompany Media Services > Service.)

Published Vservices indicate that an active service exists on the Cisco Unified Communications Manager and that it has connectivity into the Cisco IME server.

To verify Vservice publication, enter the show ime vservice details command on the Cisco IME command line.

The following example shows the output of the command in which Cisco Unified Communications Manager has published a Vservice. The VServiceProfiles field matches the Cisco IME service name that you entered on the Intercompany Media Service Configuration window.

admin: show ime vservice details
VServiceProfiles: Vservice12-ccm18
VServiceId = 3834353762636435
overlay = intercompanymedianetwork
domain  = cisco.com
DiDCount (max) = 100
SIPURI =     
sip:d954c46b-51b4-ea2d-cda4-8a20134279f6@cisco.com:5082;maddr=10.94.150.96;transport=t
cp


Note After you verify the Vservice publication, you can continue to verify connectivity between the Cisco Unified Communications Manager server and the Cisco IME server by verifying that the Cisco Unified Communications Manager server has published DIDs to the IME distributed cache as described in the "DID Publication" section.


Additional Information

Cisco IME Configuration Checklist

DID Publication

After you confirm connectivity between the Cisco Unified Communications Manager and the Cisco Intercompany Media Engine (Cisco IME) servers, you can verify that the Cisco IME server has published the enrolled patterns (DIDs) to the IME distributed cache. Use the following methods to verify DID publication:

From the CLI

From the Cisco Intercompany Media Engine CLI, enter the following command:

utils ime fetch did E.164 number

The command output shows whether the Cisco IME server published DIDs to the IME distributed cache and which node owns the number.

Cisco IME RTMT

Access the Cisco Unified Communications Manager server using RTMT, and choose the following menu and counter:

System > Performance > Open Performance Monitoring > IME Client Instance > PublishedRoutes

This counter indicates the total number of DIDs published successfully into the IME distributed cache across all Cisco IME client instances.

Configuring a Fallback Profile

The fallback profile defines several values that the Cisco Unified Communications Manager uses to fallback Cisco Intercompany Media Engine (Cisco IME) calls to the PSTN. The fallback profile defines the quality of service level at which Cisco Unified Communications Manager attempts a mid-call fallback as well as the fallback number that the Cisco Unified Communications Manager uses to invoke the PSTN call.

When a user makes a call to a number that is linked to a fallback profile, the Cisco Unified Communications Manager of the calling party receives a fallback directory number that is configured on the Cisco Unified Communications Manager of the called party. The Cisco Unified Communications Manager uses the fallback number for the PSTN call when the ASA triggers a fallback to the PSTN.

After you configure the fallback profile and set the fallback feature parameters, you associate the fallback profile with an IME enrolled group (Advanced Features > Intercompany Media Services > Enrolled Group).


Note If you want calls to fallback to the PSTN, make sure that you Enable Fallback for IME Calls parameter in the Fallback Feature Configuration window (Advanced Features > Fallback > Fallback Feature Configuration.)


To access the Fallback Profile Configuration window, choose Advanced Features > Fallback > Fallback Profile.

Using the GUI

For instructions on how to use the Cisco Unified Communications Manager Administration Graphical User Interface (GUI) to find, delete, configure, or copy records, see the "Cisco Unified Communications Manager Administration Basics" section and its subsections, which explain how to use the GUI and detail the functions of the buttons and icons.

Configuration Settings Table

Table 3-14 describes the fallback profile configuration settings.

For related procedures, see the "Cisco IME Configuration Checklist" section.

Table 3-14 Fallback Profile Configuration Settings 

Field
Description

Fallback Profile Information

Name

Enter a unique name for the fallback profile. This name can comprise up to 32 characters in length.

Description

Enter a descriptive name for the fallback profile. The description can comprise up to 128 characters in length. (Optional)

Call Setup Fallback Settings

Advertised Fallback Directory E.164 Number

Specify the +E.164 DID number that Cisco Unified Communications Manager uses to fallback Cisco IME calls to the PSTN. The number that you enter must begin with a + and may contain up to 15 digits.

The Cisco Unified Communications Manager from the terminating side of the call passes this number to the Cisco Unified Communications Manager on the originating side of the call so that the originating Cisco Unified Communications Manager can initiate fallback to the PSTN when the quality of service falls below the level that this fallback profile specifies.

For example, if the originating enterprise receives +14089023232 as a fallback DID, the originating enterprise must have a route pattern or translation pattern that routes that number over the PSTN to the terminating enterprise that sent that fallback DID. You must provide a dedicated +E.164 number that has not been allocated to any device.

Call Fallback Trigger Settings

Fallback QOS Sensitivity Level

Indicate the RTP audio stream sensitivity level that you want the IME-enabled ASA to use to determine when to fallback a call to the PSTN. The Cisco Unified Communications Manager sends this value to the ASA firewall. Choose one of the following options:

Disable Fallback—This option disables the mid-call fallback feature. When you choose this option, no PSTN fallback of Cisco IME VoIP calls occurs.

Utility—This option maintains the lowest quality Cisco IME calls. This option does not provide consistent quality VoIP, but it does allow the greatest number of calls to be maintained on the VoIP network rather than being rerouted over the more costly PSTN. Cisco Systems does not recommend using this option for extended-duration calls. Cisco Systems recommends this option if you want to maintain as many calls as possible via the IP network, regardless of call quality.

Accommodative—Choose this option to accept a basic or low-level quality of audio on Cisco IME VoIP calls. With this level, the IME-enabled ASA attempts to retain calls over the IP network rather than falling back to the PSTN, even if the calls have less than desirable audio quality.

Nominal—Choose this option to maintain Cisco IME VoIP calls that have good or better quality than PSTN calls. Most enterprise deployments qualify based on reasonably high quality and high-speed Internet connectivity. (Default)

Moderate—This option maintains only Cisco IME VoIP calls that have very good QoS. Calls with lesser QoS statistics fallback to the PSTN. For this option, the enterprises at both ends of the call must have Tier 1 or Tier 2 networks. If both enterprises do not meet the network requirement, the system routes the calls over the PSTN.

Aggressive—This option maintains only Cisco IME VoIP calls that have superior QoS quality; that is, calls that are virtually identical to QoS-provisioned VoIP. All calls that do not meet the QoS statistics for calls at this level fallback to the PSTN. For this option, the enterprises at both ends of the call must have Tier 1 or Tier 2 networks. If both enterprises do not meet the network requirement, the system routes the calls over the PSTN.

The default specifies the value of the Fallback QOS Sensitivity Level parameter in the Fallback Feature Configuration window (Advanced Features > Fallback > Fallback Feature Configuration).

Fallback Call Settings

Fallback Call CSS

Choose which calling search space to use to route a fallback call to the PSTN on the originating Cisco Unified Communications Manager cluster. The default specifies Calling device AAR Calling Search Space.

If you have not defined an AAR calling search space, the re-route CSS can be used, depending on your system configuration.

Fallback Call Answer Timer

Do not change this value unless a Cisco TAC engineer instructs you to do so.

This field indicates the amount of time in seconds (from 1 to 10) that the originating Cisco Unified Communications Manager waits for a mid-call fallback PSTN call to be answered.

The default value equals the value of the Fallback Call Answer Timer in the Fallback Feature Configuration window (Advanced Features > Fallback > Fallback Feature Configuration).

Note If the value of the Fallback Call Answer Time field on the Fallback Feature Configuration window is greater than the value that you configure here, the fallback call uses the value from the Fallback Feature Configuration window when a mid-call fallback takes place.

Fallback Call Handling Settings

Fallback Directory Number Partition

Choose the partition that Cisco Unified Communications Manager uses in routing fallback calls.

This partition should be included in the calling search space used by the gateway devices that receive calls for the fallback number.

The default specifies the default partition.

For more information on configuring partitions and calling search spaces, refer to the Cisco Unified Communications Manager Administration Guide.

Fallback Directory Number

(Optional) Use this field to specify a non-E.164 version of the fallback directory number.

For example, if the advertised +E.164 fallback number specifies +14089023092 and you normalize incoming numbers to seven digits before routing, the fallback directory number should specify 9023092.

If you do not specify a value in this field, the +E.164 number gets injected into digit analysis.

Tip If you are using a dial plan that supports an +E.164 backplane, you can leave this field blank.

Number of Digits for Caller ID Partial Match

This field specifies the minimum number of digits that must match in an incoming fallback call and a particular Cisco IME call in order to be considered a match.

When receiving fallback calls, Cisco Unified Communications Manager uses the caller ID of the incoming call as a key to match the incoming call to a particular Cisco IME call that is falling back. Because caller identification numbers can be transformed in the PSTN, Cisco Unified Communications Manager uses a partial-matching algorithm that allows a caller ID to be considered a match if a subset of the digits matches.

The default specifies five digits.


Additional Information

Cisco IME Configuration Checklist

Configuring Fallback Feature Parameters

Use the Fallback Feature Configuration window to configure feature parameters that apply to mid-call fallback of Cisco Intercompany Media Engine (Cisco IME) calls to the PSTN.

To access the Fallback Profile Configuration window, choose Advanced Features > Fallback > Fallback Feature Configuration.

Configuration Settings Table

Table 3-2 describes the fallback configuration settings.

For related procedures, see the "Cisco IME Configuration Checklist" section.

Table 3-15 Fallback Feature Configuration Settings 

Field
Description

Enable Fallback for IME Calls

Specify whether Cisco Unified Communications Manager uses PSTN fallback. This value overrides any other setting for fallback.

This parameter must be enabled on the originating and terminating side of a call in order for PSTN fallback to occur.

The default specifies True.

Fallback QOS Sensitivity Level

Specify the sensitivity level for the ASA firewall to use to determine when to fallback a call to the PSTN. The Cisco Unified Communications Manager sends this value to the ASA firewall.

This parameter populates the default value of the Fallback QOS Sensitivity Level in the Fallback Profile Configuration window (Advanced Features > Fallback > Fallback Profile) as well as provides a default sensitivity level if you do not define a fallback profile.

This parameter applies to the terminating side during PSTN fallback.

The default value specifies Nominal sensitivity.

Fallback Number of DTMF Correlation Digits

Specify the number of DTMF digits that the Cisco Unified Communications Manager uses for a mid-call fallback PSTN call.

This parameter applies to the terminating side during PSTN fallback.

The default value specifies 4. Valid values range from 4 to 20.

Fallback DTMF Collection Timer

Specify the amount of time (in seconds) that Cisco Unified Communications Manager waits for DTMF digits collection during a mid-call fallback PSTN call.

This parameter applies to the terminating side during PSTN fallback.

The default value specifies 3. Valid values range from 1 to 10.

Fallback Call Answer Timer

Specify the amount of time (in seconds) that Cisco Unified Communications Manager waits, after receiving alerting indication, for a mid-call fallback PSTN call to be answered before giving up.

This parameter applies to the originating side during PSTN fallback.

This parameter populates the default values in the fallback profile, as well as provides the default value if a profile is not defined.

The default value specifies 3. Valid values range from 1 to 10.

Note If the value that you enter in the Fallback Call Answer Timer field on this window is greater than the value that you configure in the Fallback Call Answer Timer field on the Fallback Profile Configuration window (Advanced Features Fallback Fallback Profile), the fallback call uses the value from the Fallback Feature Configuration window when a mid-call fallback takes place.

Fallback Call CSS

Specify the calling search space to use to route the fallback calls.

This parameter applies to the originating side during PSTN fallback.

The default value specifies AAR CSS.


Additional Information

Cisco IME Configuration Checklist

Configuring Intercompany Media Services Firewall Information

Use the Intercompany Media Services Firewall Configuration window to configure the IP address and port of the ASA mapping service. You need to configure this information if you have implemented an off-path deployment model in which normal Internet-facing traffic does not flow through the same adaptive security appliance (ASA) as the Cisco Intercompany Media Engine (Cisco IME) traffic.

During an outbound call attempt, the SIP invite message must be routed to the offpath Cisco IME enabled ASA. Cisco Unified Communications Manager sends a request to the ASA for a mapping of the global IP/port of the remote enterprise (found in the Cisco IME learned route) to an internal IP/port on the Cisco IME enabled ASA. Cisco Unified Communications Manager then initiates a SIP Invite that routes to this internal IP/port. The Cisco IME enabled ASA performs NAT, mapping to the global IP/port of the remote enterprise from the IME learned route. The offpath Cisco IME enabled ASA proxies this signaling session and initiates a TLS session to this global IP/port (the Cisco IME enabled ASA of the remote enterprise).

To access the Intercompany Media Services Firewall Configuration window, choose Advanced Features > Intercompany Media Services > Firewall.

Using the GUI

For instructions on how to use the Cisco Unified Communications Manager Administration Graphical User Interface (GUI) to find, delete, configure, or copy records, see the "Cisco Unified Communications Manager Administration Basics" section and its subsections, which explain how to use the GUI and detail the functions of the buttons and icons.

Configuration Settings Table

Table 3-16 describes the Intercompany Media Services firewall configuration settings.

For related procedures, see the "Cisco IME Configuration Checklist" section.

Table 3-16 Intercompany Media Services Firewall Configuration Settings 

Field
Description

Name

Specify a unique name for the ASA mapping service.

Description

Specify a description for the ASA mapping service. (Optional)

IP Address

Enter the IP address of the ASA mapping service.

Port

Enter the port of the ASA mapping service.


Cisco Intercompany Media Engine Learned Routes

Learned routes specify lists of all +E.164 numbers that the system has learned through Cisco Intercompany Media Engine (Cisco IME). You can enable or disable a particular route. You can disable if you are having problems with a particular route and you need to disable to troubleshoot.

To access the IME Learned Routes window, choose Advanced Features > Intercompany Media Services > Learned Route.

Using the GUI

For instructions on how to use the Cisco Unified Communications Manager Administration Graphical User Interface (GUI) to find, delete, configure, or copy records, see the "Cisco Unified Communications Manager Administration Basics" section and its subsections, which explain how to use the GUI and detail the functions of the buttons and icons.

Configuration Settings Table

Table 3-17 describes the Intercompany Media Services learned route configuration settings.

For related procedures, see the "Cisco IME Configuration Checklist" section.

Table 3-17 Cisco Intercompany Media Engine Learned Route Configuration Settings 

Field
Description

E.164

The field specifies +E.164 number that the Cisco Unified Communications Manager has learned.

Domain

This field specifies the domain for the +E.164 number.

Signaling

This field specifies the destination remote IP address and port of the dynamic SIP trunk that the system uses to reach the destination DID.

Learned-On

This field specifies the date that Cisco Unified Communications Manager learned this route.

Expires-On

This field specifies the date that this route expires. Routes expire a year after the learned-on date.

Admin Enabled

This field indicates whether a learned route is in use. To disable a route without deleting it from the database, uncheck the Admin Enabled check box. To enable a route so that Cisco Intercompany Media Engine can use the route, check this check box.


Additional Information

Cisco IME Configuration Checklist

Related Topics

Cisco Unified Communications Manager Administration Basics

Cisco IME Configuration Checklist

Configuring Cisco IME Server Connections

Setting Up TLS Connections Between the Cisco Unified Communications Manager and Cisco Intercompany Media Engine Servers

Configuring a Cisco IME Enrolled Group

Configuring a Cisco IME Enrolled Pattern

Configuring a Cisco IME Exclusion Group

Configuring a Cisco IME Exclusion Number

Configuring a Cisco IME Trust Group

Configuring a Cisco IME Trust Element

Configuring a Cisco IME Service

Configuring External IP Address and Port Information

Configuring Transformation Patterns for Cisco IME

Configuring a Cisco IME Transformation Profile

Configuring Cisco IME E.164 Transformations

Configuring PSTN Access Trunks

Configuring a Cisco IME Feature Configuration

Verifying Connectivity

Configuring a Fallback Profile

Configuring Fallback Feature Parameters

Configuring Intercompany Media Services Firewall Information

Cisco Intercompany Media Engine Learned Routes