Summary
This article describes how to specify a source for phone IP/DN mapping.
Background
To provide some of the Voice Office functionality, the Application Gateway must have the IP address and extension of the IP phones, referred to as an IP/DN map. The Application Gateway supports the following sources for creating an IP/DN map:
- For CallManager 3.3(x), 4.0 and 4.1, the Application Gateway can obtain phone IP addresses from the DeviceListX Report that resides on the CallManager Publisher server. For each of the IP addresses on the DeviceListX Report, the Application Gateway obtains directory number (DN) and other information from the phone’s DeviceListX file. The Application Gateway uses the intersection of those two information sources to create the IP/DN map.
- You can also specify a comma-separated value (CSV) file source with the CallManager source. This is useful if there are phones associated with CallManager that you do not want the Application Gateway to handle. You must specify a CSV file if your site is using an external phone number mask. The CSV file acts as a filter, indicating which of the phones associated with the CallManager should be made known to the Application Gateway. The CSV file must include, at a minimum, the IP phone device ID. For example, if the CSV file includes the device ID and DN, the Application Gateway queries the CallManager for IP address and model information.
- As an alternative to connecting to the CallManager Publisher Server, you can manually create a CSV file that contains the phone extensions and IP addresses required by the Application Gateway. You must ensure that the CSV file is updated and available to the Application Gateway for scheduled synchronizations.
When the Application Gateway detects that an IP phone has come online, the Application Gateway obtains the IP address from the IP phone its and uses that address to look up the phone’s extension in the IP/DN map. A phone cannot obtain a license unless the phone’s extension appears in the IP/DN map. Once a phone is licensed, it holds the license even when it is idle.
Note: A licensed phone occupies one session. Refer to the Application Gateway Release Notes for information on Application Gateway capacity.
When user traffic reaches the fixed license or session capacity, you can increase capacity by installing additional Application Gateways, all pointing to the same CallManager. You must configure groups of phones to use a particular Application Gateway by pointing their application server setting to the IP address of the Application Gateway. The following sections describe the one-time setup that applies to all Voice Office applications.
Procedure
Configuring a connection to CallManager 3.3, 4.0, or 4.1:
CallManager produces the “DeviceListX Report,” which contains real-time device status and IP address information. CallManager writes the report to the CallManager Publisher server in the following locations:
- For CallManager 3.3, 4.0:
http://CMgr_IP_or_hostname/CCMAdmin/reports/devicelistx.asp - For CallManager 4.1:
https://CMgr_IP_or_hostname/CCMAdmin/reports/devicelistx.asp
To configure a connection between the Application Gateway and the CallManager DeviceListX Report:
- Open the Administration Tool: From a Web browser, go to the following URL:
https://AG_ipAddress:AG_adminPort - Go to the Operation > Voice Office > IP Phone page.
- For Type, select CallManager 3.3(x)/4.x.
- Specify the path to the DeviceListX Report, including either “http:” (for CallManager 3.3 or 4.0) or “https” (for CallManager 4.1):
http(s)://<CMgr_IP_or_hostname>/CCMAdmin/reports/devicelistx.asp
Where <CMgr_IP_or_hostname> is the IP address or hostname of the CallManager Publisher server. - Specify the credentials for accessing the CallManager Publisher server.
- Choose a schedule for synchronizing the Application Gateway with the DeviceListX Report.
Note: If the CallManager Publisher server is unavailable during a scheduled update, the Application Gateway uses the last available mapping. The Application Gateway system log (Logging > System Log) contains status information. - Click Submit.
- To immediately synchronize the Application Gateway with the DeviceListX Report, click Synchronize Now.
Configuring a connection to a CSV file:
The Application Gateway can use a CSV-formatted file as a source for phone extensions and IP addresses. If you use a CSV file, you must ensure that an updated CSV file is available to the Application Gateway for scheduled synchronizations.
To configure a connection to a CSV file:
- Open the Administration Tool. To do this, enter the following URL in a Web browser:
https://AG_ipAddress:AG_adminPort - Go to the Operation > Voice Office > IP Phone page.
- For Type, select CSV File Only.
- Specify the URL of the Web server where the CSV file resides (http://<url>).
- Specify the credentials required to access the URL, if required (leave everything blank if anonymous).
- Choose a schedule for synchronizing the Application Gateway with the CSV file.
- Click Submit.
- To immediately synchronize the Application Gateway with the CSV file, click Synchronize Now.
Note: If a server is unavailable during a scheduled update, the Application Gateway uses the last available mapping. The Application Gateway system log (Logging > System Log) contains status information.
More Information
CSV file format specifications:
The CSV-formatted file that you upload to the Application Gateway for IP/DN mapping must meet these requirements:
- It is a comma-delimited text file with an extension of .CSV, hosted in a directory of a Web server.
- The field order must be extension,IP Address
For example: - 5017,10.0.10.160
- 5018,10.0.10.149
- 5019,10.0.16.160
- The file must not contain any spaces or blank lines.
- A record is one line. Records must be separated by a line feed (ASCII/LF=0x0A) or carriage return and line feed pair (ASCII/CRLF=0x0D 0x0A). Fields may contain embedded line breaks; therefore, a record can occupy more than one line. Embedded line breaks must be surrounded by double quotation marks.
