Cisco Unified Communications Manager Administration Guide, Release 9.0(1)
Intercluster directory URI
Downloads: This chapterpdf (PDF - 408.0KB) The complete bookPDF (PDF - 8.34MB) | Feedback

Intercluster directory URI

Intercluster directory URI

This chapter describes how to enable the ILS URI Replication feature in order to support intercluster dialing with directory URIs. When this feature is configured, Cisco Unified Communications Manager replicates the local directory URI catalog to remote clusters in the ILS network, thereby providing support for URI dialing across clusters.

Intercluster directory URI settings

In Cisco Unified CM Administration, use the Call Routing > Intercluster Directory URI > Intercluster Directory URI Configuration path to enable ILS support for URI dialing across clusters. After you configure URI dialing in the local cluster you can configure the settings on this page to expand URI dialing support across clusters.

Configuration Tips

Before you configure the settings on this page, you must do the following:
  • Set up URI dialing in the local cluster. See the URI dialing chapter of the Cisco Unified Communications Manager System Guide for more information.
  • Set up an ILS network. See the Intercluster Lookup Service chapter of the Cisco Unified Communications Manager Features and Services Guide for more information.
The following table describes the settings in the Intercluster Directory URI Configuration window.

Table 1 Intercluster Directory URI Configuration
Field Description
Exchange Directory URI Catalogs with Remote Clusters

Check this check box to enable the URI Replication feature with ILS. When this check box is checked, the local cluster sends its directory URIs and route strings to remote clusters in the ILS network and also receives directory URI catalogs and route strings from the remote clusters in the ILS network.

If this check box is checked for all clusters in the ILS network, each cluster in the network learns the directory URIs and route strings for all the other clusters in the network.

Note   

You must check this check box if you want to implement URI dialing across clusters.

Route String

Enter a route string for this cluster. Route strings can be up to 250 alphanumeric characters and can include dots and dashes. Route strings must have at least one dot.

If the Exchange Directory URI Catalogs with Remote Clusters check box is checked, the local cluster includes its route string when it exchanges directory URI catalogs with remote clusters in the ILS network.

When a remote cluster in the ILS network receives a call that is addressed to a directory URI in this cluster, the remote cluster pulls the route string for this cluster. If a route pattern is configured that matches the route string, the remote cluster sends the call to the outbound trunk that is specified by the route pattern.

Note   

In order for Cisco Unified Communications Manager to route calls to a route string, you must configure SIP route patterns that match the route string and point those SIP route patterns to an outbound trunk that routes to that cluster. See the Sip route pattern setup chapter of the Cisco Unified Communications Manager Administration Guide for more information on SIP route patterns.

Export Local Directory URIs

Click this button to export all directory URIs that were configured in the local cluster, including directory URIs that were imported from an LDAP directory, to a CSV export file. The export file can be imported into another call control system that is not running ILS such as a Cisco TelePresence Video Communication Server.

Note   

The export file does not contain directory URIs that were learned by ILS or directory URIs that were manually imported from another system.

Imported directory URI catalog settings

In Cisco Unified CM Administration, use the Call Routing > Intercluster Directory URI > Imported Directory URI Catalog path if you want to import directory URIs manually from a CSV file for a call control system that is not running ILS such as a Cisco TelePresence Video Communication Server or a third-party call control system.

Configure the settings on this page to create an empty directory URI catalog with a route string for the remote call control system. After you configure the settings on this page, you must use Bulk Administration to insert directory URIs from the CSV file into the newly created directory URI catalog. Follow the Import directory URIs from a non-ILS system procedure for detailed instructions on how to import a directory URI catalog from a third-party call control system.


Note


The local cluster must be a hub cluster in an existing ILS network. For more information on ILS networks, see the Intercluster Lookup Service chapter of the Cisco Unified Communications Manager Features and Services Guide.


The following table contains field descriptions for the Imported Directory URI Catalog window.

Field Description
Name Enter a unique name to identify the imported directory URI catalog that you want to import.
Description Enter a description for the directory URI catalog that you want to import.
Route String

Enter a route string for the remote call control system. Route strings can be up to 250 alphanumeric characters long and can include dots and dashes.

Unified CM uses route strings in conjunction with SIP route patterns to route calls to directory URIs that are configured in remote clusters. When a call from the local cluster is placed to a directory URI in this remote catalog, Unified CM matches the directory URI with the route string and then uses a SIP route pattern to match that route string to an outbound trunk that routes to that directory URI.

Note    After you create the route string, create a SIP route pattern that routes this route string to an outbound trunk. See the SIP route pattern setup chapter of the Cisco Unified Communications Manager Administration Guide for more information on SIP route patterns.
Related Information

Find imported directory URIs

Procedure
Select Call Routing > Intercluster Directory URI > Imported Directory URIs to display a list of imported directory URI catalogs, in Cisco Unified CM Administration.

The Find and List Imported Directory URIs window displays a complete list of directory URIs that were manually imported from another call control system, along with a corresponding directory URI catalog.


Note


The Find and List Imported Directory URIs window displays only those directory URIs and directory URI catalogs that were manually imported into the local Cisco Unified Communications Manager cluster from another call control system. This window does not display directory URIs that were configured locally in Cisco Unified CM Administration, directory URIs that were imported from a corporate LDAP directory, or directory URIs that were learned by the Intercluster Lookup Service.


Import Directory URIs from a non-ILS system

Follow this procedure if you are running the Intercluster Lookup Service (ILS) on your local cluster and you want to import directory URIs from a CSV file for a call control system that is not running ILS, such as a Cisco TelePresence Video Communication Server (VCS), or a third-party call control system.

To perform this procedure, the Cisco Bulk Provisioning Service must be running on the local cluster, which must be configured as a hub cluster in an ILS network. After you import the catalog into Cisco Unified Communications Manager, ILS replicates the imported catalog to the other clusters in the ILS network.


Note


Within Cisco Unified CM Administration, you can enter directory URIs with embedded double quotes or commas. However, when you use Bulk Administration to import a CSV file that contains directory URIs with embedded double quotes and commas, you must use enclose the entire directory URI in double quotes and escape the embedded double quotes with a double quote. For example, a directory URI of Jared,"Jerry",Smith@test.com must be input as "Jared,""Jerry"",Smith@test.com" in the CSV file.


Procedure
    Step 1   In Cisco Unified CM, choose Routing > Directory URIs > Imported Directory URI Catalogs.
    Step 2   In the Name field, enter a name for the directory URI catalog.
    Step 3   In the Description field, enter a description of the directory URI catalog.
    Step 4   In the Route String field, create a route string for the system from which you are importing the URI catalog.
    Step 5   Click Save.
    Step 6   In Cisco Unified CM Administration, chooseBulk Administration > Upload/Download Files.
    Step 7   Click Add New.
    Step 8   Click Browse and select the CSV file for the directory URI catalog that you want to import.
    Step 9   In the Select the Target drop-down list box, choose Imported Directory URIs.
    Step 10   In the Select TransactionType drop-down list box, choose Insert Imported Directory URIs.
    Step 11   Click Save.
    Step 12   In Cisco Unified CM Administration, choose Bulk Administration > Imported Directory URIs > Insert Imported Directory URIs.
    Step 13   In the File Name drop-down list box, choose the CSV file that contains the imported directory URI catalog.
    Step 14   In the Imported Directory URI Catalog drop-down list box, choose the directory URI catalog that you named in the Imported Directory URI Catalog window.
    Step 15   In the Job Description text box, enter a name for the job that you are about to run.
    Step 16   Select when you want to run the job.
    • If you want to run the job now, click the Run Immediately radio button, and click Submit.
    • If you want to schedule the job to run at a specified time, check the Run Later radio button and click Submit. If you choose this option, you must use the Bulk Administration Job Scheduler to schedule when the job runs.

    Directory URI format

    Directory URIs are alphanumeric strings consisting of a user and a host address separated by the @ symbol. Cisco Unified Communications Manager supports the following formats for directory URIs:

    • user@domain (for example, joe@cisco.com)
    • user@ip_address (for example, joe@10.10.10.1)

    Cisco Unified Communications Manager supports the following formats in the user portion of a directory URI (the portion before the @ symbol):

    • Accepted characters are a-z, A-Z, 0-9, !, $, %, &, *, _, +, ~, -, =, \, ?, \, ‘, ,, ., /.
    • The user portion has a maximum length of 47 characters.
    • The user portion accepts percent encoding from %2[0-9A-F] through %7[0-9A-F]. For some accepted characters, Unified CM automatically applies percent encoding. See below for more information on percent encoding.
    • The user portion is case sensitive.

    Cisco Unified Communications Manager supports the following formats in the host portion of a directory URI (the portion after the @ symbol):

    • Supports IPv4 addresses or fully qualified domain names.
    • Accepted characters are a-z, A-Z ,0-9, hyphens, and dots.
    • The host portion cannot start or end with a hyphen.
    • The host portion cannot have two dots in a row.
    • Minimum of two characters.
    • The host portion is not case sensitive.

    Due to database restrictions, the Directory URI field has a maximum length of 254 characters.


    Note


    You can also enter a directory number in the user portion of a directory URI. However, Cisco Unified Communications Manager may treat the directory URI as a directory number depending on which Dial String Interpretation option you choose for the SIP Profile.



    Note


    For compatibility with third-party call control systems, we recommend using lower case for directory URIs.


    Percent encoding of directory URIs

    In the user portion of a directory URI, Unified CM automatically applies percent encoding to the following characters when the directory URI is saved in the database:

    # % ^ ` { } | \ : ” < > [ ] \ ‘ and spaces

    When percent encoding is applied, the digit length of the directory URI increases. For example, if you input joe smith#@cisco.com (20 characters) as a directory URI, Cisco Unified Communications Manager stores the directory URI in the database as joe%20smith%23@cisco.com (24 characters). Due to database restrictions, Cisco Unified Communications Manager rejects any attempt to save a directory URI of greater than 254 characters.

    Directory URI format exception for Bulk Administration

    Within Cisco Unified CM Administration, you can enter directory URIs with embedded double quotes or commas. However, when you use Bulk Administration to import a CSV file that contains directory URIs with embedded double quotes and commas, you must use enclose the entire directory URI in double quotes and escape the embedded double quotes with a double quote. For example, the Jared, "Jerry",Smith@test.com directory URI must be input as "Jared,""Jerry"",Smith@test.com" in the CSV file.