Administration Guide for Cisco UC Integration for Microsoft Lync Release 9.2(1)
Planning
Downloads: This chapterpdf (PDF - 1.22MB) The complete bookPDF (PDF - 2.84MB) | The complete bookePub (ePub - 358.0KB) | Feedback

Planning

Planning

This section provides information on planning for a deployment.

Hardware Requirements

Installed RAM

  • 1.87 GB RAM on Microsoft Windows XP 32 bit with Service Pack 3
  • 2 GB RAM on Microsoft Windows 7

Free physical memory

  • 128 MB

Free disk space

  • 256 MB

CPU speed and type

  • Mobile AMD Sempron Processor 3600+ 2 GHz
  • Intel Core2 CPU T7400 @ 2. 16 GHz

GPU

  • Directx 9 on Microsoft Windows XP 32 bit with Service Pack 3
  • Directx 11 on Microsoft Windows 7

I/O ports

  • USB 2.0 for USB camera and audio devices.

Software Requirements

Supported Microsoft Lync versions

  • Microsoft Lync 2010
  • Microsoft Lync 2013 Microsoft Lync 2013 is supported with the following caveats at this time:
    • Drag and drop from the Microsoft Lync contact list is not supported.
    • Click to Call from Microsoft Office 2013 is not supported.
    • Escalation from a Microsoft Lync group chat session to a voice or video call is not supported.
    • Microsoft Lync 2013 update KB2760512 must be installed.

    Note


    Microsoft Lync 2013 64 bit is not supported.


Supported operating systems

  • Microsoft Windows 7 32 bit
  • Microsoft Windows 7 64 bit
  • Microsoft Windows XP 32 bit with Service Pack 3

Supported servers

  • Cisco Unified Communications Manager version 7.1(4) or later
  • Cisco Unity Connection version 8.5 or later

Supported directories

  • Microsoft Active Directory 2003
  • Microsoft Active Directory 2008
  • Cisco Unified Communications Manager User Data Service UDS is supported on Cisco Unified Communications Manager version 8.6.2 or later.
  • OpenLDAP
Restriction:

Directory integration with OpenLDAP requires you to define specific parameters in a Cisco UC Integration for Microsoft Lync configuration file. See LDAP Directory Servers for more information.

Microsoft Internet Explorer

Cisco UC Integration for Microsoft Lync requires Microsoft Internet Explorer 7.0, 8.0, or 9.0. The application uses the Microsoft Internet Explorer rendering engine to display HTML content.

Support for Microsoft Office (Click to Call)

  • Microsoft Office 2007 32 bit
  • Microsoft Office 2010 32 bit

Note


Microsoft Lync 2013 is installed with Microsoft Office 2013 but Click to Call is not supported.


Network Requirements

ICMP requests

Cisco UC Integration for Microsoft Lync sends Internet Control Message Protocol (ICMP) requests to the TFTP server. These requests enable the client to determine if it can connect to Cisco Unified Communications Manager. You must configure firewall settings to allow ICMP requests from the client. If your firewall does not allow ICMP requests, the application cannot establish a connection to Cisco Unified Communications Manager.

Ports and protocols

Cisco UC Integration for Microsoft Lync uses the ports and protocols listed in the following table. If you plan to deploy a firewall between the application and a server, configure the firewall to allow these ports and protocols.

Port Protocol Description
Inbound
16384 to 32766 UDP Receives Real-Time Transport Protocol (RTP) media streams for audio and video. You set these ports in Cisco Unified Communications Manager.
Outbound
69 UDP Trivial File Transfer Protocol (TFTP) service
6970 HTTP TFTP service to download client configuration
443 TCP

(HTTPS)

Cisco Unity Connection for voicemail

7080 TCP

(HTTPS)

Cisco Unity Connection for notifications of voice messages
389 UDP / TCP LDAP directory server
636 LDAPS LDAP directory server (secure)
3268 TCP Global Catalog server
3269 LDAPS Global Catalog server (secure)
2748 TCP CTI gateway
5060 UDP / TCP Session Initiation Protocol (SIP) call signaling
5061 TCP Secure SIP call signaling
8443 HTTPS Web access to Cisco Unified Communications Manager and includes connections for the following:
  • Cisco Unified Communications Manager IP Phone (CCMCIP) server for assigned devices.
  • User Data Service (UDS)
16384 to 32766 UDP RTP media streams for audio and video
53 UDP / TCP Domain Name System (DNS) traffic
3804 TCP Locally Significant Certificates (LSC) for IP phones

This is the listening port for Cisco Unified Communications Manager Certificate Authority Proxy Function (CAPF) enrollment.

Supported Codecs

Supported Audio Codecs

  • g.722.1
    • g.722.1 32k
    • g.722.1 24k

    Note


    g.722.1 is supported on Cisco Unified Communications Manager 8.6.1 or later.


  • g.711
    • g.711 A-law
    • g.711 u-law
  • g.729a

Supported Video Codecs

  • H.264/AVC

Phones, headsets, and cameras

CTI supported devices

Cisco UC Integration for Microsoft Lync supports the same CTI devices as Cisco Unified Communications Manager version 8.6(1). See the CTI supported device matrix table in the CTI Supported Devices topic at the following URL:

http:/​/​www.cisco.com/​en/​US/​docs/​voice_ip_comm/​cucm/​tapi_dev/​8_6_1/​supporteddevices.html

Headsets and speakers

Plantronics Blackwire C420 Plantronics Voyager Pro UC B230
Plantronics Blackwire C610 Plantronics Voyager Pro UC BT300
Plantronics Blackwire C620 Jabra BIZ 2400
Plantronics C220UC Jabra BIZ 620
Plantronics C420 Jabra Go 6470
Plantronics Calisto P420 Jabra PRO 930
Plantronics Calisto P800 series headset Jabra Speak 410
Plantronics DSP400 Jabra-8120
Plantronics W740 Jabra GN2000
Plantronics WO200/A Jabra PRO 9470
Plantronics WO300 Polycom CX100 Speakerphone
Plantronics Voyager Pro UC WG200/B -
Plantronics Blackwire C310 Plantronics Voyager 510SL
Plantronics Blackwire C320 Plantronics Voyager Pro UC B230
Plantronics Blackwire C420 Plantronics DSP 400
Plantronics Blackwire C435 Plantronics Savi 740
Plantronics Blackwire C610 Plantronics Savi 440
Plantronics Blackwire C620 Jabra GN2000 CIPC Mono
Plantronics Blackwire C710 Jabra GN2000 CIPC Duo
Plantronics Blackwire C720 Jabra Go 6470
Plantronics Calisto P240 series Jabra Pro 930
Plantronics Calisto P420 Jabra Speak 410
Plantronics Calisto P610 series Jabra BIZ 2400
Plantronics Calisto P800 series Polycom CX100 Speakerphone
Plantronics Voyager Pro UC WG200/B -

Cameras

Microsoft LifeCam 6000 Tandberg Precision HD devices
Logitech Pro 9000 Cisco VTIII, resolution up to VGA
Logitech C920 -

Cisco AnyConnect

Cisco AnyConnect refers to a server-client infrastructure that enables the application to connect securely to your corporate network from remote locations such as Wi-Fi or mobile data networks.

The Cisco AnyConnect environment includes the following components:
Cisco Adaptive Security Appliance (ASA)

Provides a service to secure remote access.

Cisco AnyConnect Secure Mobility Client

Establishes an secure connection to Cisco Adaptive Security Appliance from the user's computer.

Cisco UC Integration for Microsoft Lync supports secure remote access with the following:
  • Cisco AnyConnect Secure Mobility Client 2.5
  • Cisco AnyConnect Secure Mobility Client 3.1

See the Cisco AnyConnect documentation for information and procedures on the configuration of this infrastructure. It is located here: http:/​/​www.cisco.com/​en/​US/​products/​ps10884/​tsd_​products_​support_​series_​home.html.

Audio and Video Performance Reference

Attention:

The following data is based on testing in a lab environment. This data is intended to provide an idea of what you can expect in terms of bandwidth usage. The content in this topic is not intended to be exhaustive or to reflect all media scenarios that might affect bandwidth usage.

Bit Rates for Audio, Video, and Presentation Video

The following table describes bit rates for audio:
Codec RTP payload in kilobits (kbits) per second Actual bitrate (kbits per second) Notes
g.722.1 24/32 54/62 High quality compressed
g.711 64 80 Standard uncompressed
g.729a 8 38 Low quality compressed

Bit Rates for Video

The following table describes bit rates for video with g.711 audio:
Resolution Pixels Measured bit rate (kbits per second) with g.711 audio
w144p 256 x 144 156
w288p

This is the default size of the video rendering window.

512 x 288 320
w448p 768 x 448 570
w576p 1024 x 576 890
720p 1280 x 720 1300
Notes about the preceding table:
  • This table does not list all possible resolutions.
  • The measured bit rate is the actual bandwidth used (RTP payload + IP packet overhead).

Bit Rates for Presentation Video

The following table describes the bit rates for presentation video:
Pixels Estimated wire bit rate at 2 fps (kbits per second) Estimated wire bit rate at 8 fps (kbits per second)
720 x 480 41 164
704 x 576 47 188
1024 x 768 80 320
1280 x 720 91 364
1280 x 800 100 400
Notes about the preceding table:
  • The application captures at 8 fps and transmits at 2 to 8 fps.
  • The values in this table do not include audio.

Maximum Negotiated Bit Rate

You specify the maximum payload bit rate in Cisco Unified Communications Manager in the Region Configuration window. This maximum payload bit rate does not include packet overhead, so the actual bit rate used is higher than the maximum payload bit rate you specify.

The following table describes how the application allocates the maximum payload bit rate:
Desktop sharing session Audio Interactive video (Main video) Presentation video (Desktop sharing video)
No The application uses the maximum audio bit rate The application allocates the remaining bit rate as follows:

The maximum video call bit rate minus the audio bit rate.

-
Yes The application uses the maximum audio bit rate The application allocates half of the remaining bandwidth after subtracting the audio bit rate. The application allocates half of the remaining bandwidth after subtracting the audio bit rate.

Performance Expectations for Bandwidth

The application separates the bit rate for audio and then divides the remaining bandwidth equally between interactive video and presentation video. The following table provides information to help you understand what performance you should be able to achieve per bandwidth:
Upload speed Audio Audio + Interactive video (Main video) Audio + Presentation video (Desktop sharing video) Audio + Interactive video + Presentation video
125 kbps under VPN At bandwidth threshold for g.711. Sufficient bandwidth for g.729a and g.722.1. Insufficient bandwidth for video. Insufficient bandwidth for video. Insufficient bandwidth for video.
384 kbps under VPN Sufficient bandwidth for any audio codec. w288p (512 x 288) at 30 fps 1280 x 800 at 2+ fps w144p (256 x 144) at 30 fps + 1280 x 720 at 2+ fps
384 kbps in an enterprise network Sufficient bandwidth for any audio codec. w288p (512 x 288) at 30 fps 1280 x 800 at 2+ fps w144p (256 x 144) at 30 fps + 1280 x 800 at 2+ fps
1000 kbps Sufficient bandwidth for any audio codec. w576p (1024 x 576) at 30 fps 1280 x 800 at 8 fps w288p (512 x 288) at 30 fps + 1280 x 800 at 8 fps
2000 kbps Sufficient bandwidth for any audio codec. w720p30 (1280 x 720) at 30 fps 1280 x 800 at 8 fps w288p (1024 x 576) at 30 fps + 1280 x 800 at 8 fps

Note that VPN increases the size of the payload, which increases the bandwidth consumption.

Video Rate Adaptation

The application uses video rate adaptation to negotiate optimum video quality. Video rate adaptation dynamically increases or decreases video bit rate throughput to handle real-time variations on available IP path bandwidth.

Users should expect video calls to begin at lower resolution and scale upwards to higher resolution over a short period of time. The application saves history so that subsequent video calls should begin at the optimal resolution.

Cisco Options Package Files

Review the different Cisco Options Package (COP) files that you might require to deploy the application.

COP File Description Cisco Unified Communications Manager Versions
ciscocm.installcsfdevicetype.cop.sgn

Adds the CSF device type to Cisco Unified Communications Manager. For more information, see Software Requirements.

7.1.3
cmterm-bfcp-e.8-6-2.cop.sgn

Enables CSF devices to support BFCP video desktop sharing. For more information, see Apply COP File for BFCP Capabilities.

8.6.2 only
ciscocm.addcsfsupportfield.cop.sgn

Adds the CSF Support Field field for group configuration files. For more information, see Create Group Configurations.

8.6.x and lower
cmterm-cupc-dialrule-wizard-0.1.cop.sgn

Publishes application dial rules and directory lookup rules to Cisco UC Integration for Microsoft Lync. For more information, see Publish Dial Rules.

All supported versions

Directory Integration

Deployment of the application requires directory integration. Two types of directory integration are supported:
  • Enhanced Directory Integration (EDI)
  • Cisco Unified Communications Manager User Data Service (UDS)

EDI Directory Integration

Enhanced Directory Integration (EDI) uses native Microsoft Windows APIs to retrieve contact data from Microsoft Active Directory.

EDI Configuration

Cisco UC Integration for Microsoft Lync will automatically discover the directory service and connect to a Global Catalog if it has been installed on a workstation that is registered to an Active Directory domain. This connection can be customized in the configuration file as follows:

  • Attribute mappings See Attribute Mapping Parameters.
  • Connection settings See Directory Connection Parameters.
  • Query settings See Directory Query Parameters.
  • Contact photo resolution See Contact Photo Parameters.
  • Contact resolution See Contact Resolution.

Retrieving Attributes from the Directory

Cisco UC Integration for Microsoft Lync can connect to a Global Catalog or Domain Controller to retrieve Active Directory attributes. Use the following information when determining how the application will receive attributes in your network.

Global Catalog

Cisco UC Integration for Microsoft Lync connects to a Global Catalog server by default . If you use the default settings, you must ensure that all attributes reside on your Global Catalog server.

You can replicate attributes to a Global Catalog server using an appropriate tool such as the Microsoft Active Directory Schema snap-in.

Note


Replicating attributes to your Global Catalog server generates traffic between Active Directory servers in the domain.


See the appropriate Microsoft documentation for instructions on replicating attributes to a Global Catalog server with the Active Directory Schema snap-in.

Domain Controller
You can configure Cisco UC Integration for Microsoft Lync to connect to a Domain Controller if you:
  • Do not want to connect to a Global Catalog server.
  • Do not want to replicate attributes to a Global Catalog server.

Note


The application queries only a single domain if you configure it to connect to a Domain Controller.


Specify 1 as the value of the ConnectionType parameter to configure the application to connect to a Domain Controller. See Directory Connection Parameters for more information.

Indexing Attributes

Ensure you index any attributes you use for contact resolution on your directory.

If you use the default attribute mappings, ensure the following attributes are indexed:
  • sAMAccountName
  • telephoneNumber
    Additionally, ensure you index the following attributes for secondary number queries:
    • otherTelephone
    • mobile
    • homePhone

    Note


    By default secondary number queries are enabled in the application. You can disable secondary number queries with the DisableSecondaryNumberLookups parameter.


UDS Directory Integration

UDS is an interface on Cisco Unified Communications Manager that provides contact resolution. You synchronize contact data into Cisco Unified Communications Manager from Microsoft Active Directory or another LDAP directory source. Cisco UC Integration for Microsoft Lync automatically retrieves that contact data directly from Cisco Unified Communications Manager using the UDS interface.

Enable Integration with UDS

To enable integration with UDS, you perform the following steps:
  1. Create your directory source in Cisco Unified Communications Manager.
  2. Synchronize the contact data to Cisco Unified Communications Manager.
  3. Specify UDS as the value of the DirectoryServerType parameter in your Cisco UC Integration for Microsoft Lync configuration file.
Contact data resides in Cisco Unified Communications Manager after the synchronization occurs. The application automatically connects to UDS and performs all contact resolution. You do not need to perform any other server configuration tasks to use UDS.

Contact Photo Retrieval

You must configure the application to retrieve contact photos if you integrate with UDS. For more information, see Contact Photo Retrieval.

Contact Resolution with Multiple Clusters

For contact resolution with multiple Cisco Unified Communications Manager clusters, you should synchronize all users on the corporate directory to each Cisco Unified Communications Manager cluster. You should then provision a subset of those users on the appropriate Cisco Unified Communications Manager cluster.

For example, your organization has 40,000 users. 20,000 users reside in North America. 20,000 users reside in Europe. Your organization has the following Cisco Unified Communications Manager clusters for each location:
  • cucm-cluster-na for North America
  • cucm-cluster-eu for Europe
In this example, you should synchronize all 40,000 users to both clusters. You then provision the 20,000 users in North America on cucu-cluster-na and the 20,000 users in Europe on cucm-cluster-eu.

When users in Europe call users in North America, the application retrieves the contact details for the user in Europe from cucu-cluster-na.

When users in North America call users in Europe, the application retrieves the contact details for the user in North America from cucu-cluster-eu.

Supported LDAP Directory Services

Cisco UC Integration for Microsoft Lync supports the following directory services:

  • Microsoft Active Directory 2003
  • Microsoft Active Directory 2008
  • OpenLDAP
  • Active Directory Lightweight Directory Service (AD LDS) or Active Directory Application Mode (ADAM)
Cisco UC Integration for Microsoft Lync supports the following specific integration scenarios with OpenLDAP, AD LDS, and ADAM:
  • OpenLDAP integration using anonymous or authenticated bings.
  • AD LDS or ADAM integration using anonymous binds, authentication with the Microsoft Windows principal user, or authentication with the AD LDS principal user.

Evaluate your directory service to determine the characteristics of the schema before configuring Cisco UC Integration for Microsoft Lync.

Domain Name System Configuration

Cisco UC Integration for Microsoft Lync must connect to a directory service that can access information for all users in the organization. The application typically retrieves the domain name from the USERDNSDOMAIN environment variable on the user's workstation. This value allows Cisco UC Integration for Microsoft Lync to locate either the Global Catalog or LDAP service in the domain.

Note


The application automatically connects to the Global Catalog. The application must be configured to locate an LDAP service.


In some instances, the value of the USERDNSDOMAIN environment variable does not resolve to the DNS domain name that corresponds to the domain name of the entire forest. For example, an instance where this configuration occurs is when an organization uses a sub-domain or resource domain. In such a configuration, the USERDNSDOMAIN environment variable resolves to a child domain, not the parent domain. The result of this type of configuration is that the application cannot access information for all users in the organization.

If the USERDNSDOMAIN environment variable resolves to a child domain, you can use one of the following configuration options to connect to a service in the parent domain:

  • Configure the application to use the FQDN of the parent domain. To perform this configuration, you specify the FQDN of the parent domain as the value of the PrimaryServerName parameter.
  • Configure your DNS server to direct the application to a server that can access all users in the organization when it requests a Global Catalog or LDAP service.
  • Ensure that the Global Catalog or LDAP service has access to all users in the organization.
For more information about configuring your DNS server, see the following Microsoft documentation:
  • Configuring DNS for the Forest Root Domain
  • Assigning the Forest Root Domain Name
  • Deploying a GlobalNames Zone
  • Support for DNS Namespace planning in Microsoft server products

Quality of Service Configuration

You can configure group policies in Microsoft Windows so that clients automatically apply Differentiated Services Code Point (DSCP) values to media streams.

The policies you configure should match the application, the UDP protocol, and a source port range. In most cases, you should configure one policy to apply DSCP values to the audio call port range and another policy to apply DSCP values to the video call port range.

See the Policy-based Quality of Service (QoS) topic in the Microsoft Windows Server 2008 documentation for more information.

Cisco Media Services Interface

Cisco Media Services Interface provides a Microsoft Windows service that works with Cisco Prime Collaboration Manager and Cisco Medianet-enabled routers to ensure that the application can send audio-visual media on your network with minimum latency and packet loss. The application checks for this service before sending audio-visual media on the network. Flow information is provided to the Cisco Media Services Interface by the application if it is installed. The service then signals the network so that routers classify the flow and provide priority to the application traffic. Audio-visual media is sent normally across the network if this service is not installed.

You must install Cisco Media Services Interface separately and ensure your network is enabled for Cisco Medianet. You must also install Cisco Prime Collaboration Manager and routers enabled for Cisco Medianet.

Port Ranges on Cisco Unified Communications Manager

Cisco Unified Communications Manager lets you define one port range for Cisco UC Integration for Microsoft Lync . The application divides this port range equally and uses the lower half for audio calls and the upper half for video calls. For example, if you define a port range of 1000 to 3000, the application uses a port range of 1000 to 2000 for audio calls and a port range of 2000 to 3000 for video calls.

Part ranges are set on the SIP Profile Configuration window for the appropriate SIP profile on Cisco Unified Communications Manager.

To access the SIP Profile Configuration window, select Device > Device Settings > SIP Profile.

The Start Media Port field defines the lowest port available. The Stop Media Port field defines the highest port available. See the SIP Profile Configuration topic in the Cisco Unified Communications Manager documentation for more information.