Using Polycom Phones with Microsoft Lync Server 2010

Transcription

1 Using Polycom Phones with Microsoft Lync Server 2010 Microsoft Lync Server 2010 is a unified communications solution that enables customers, colleagues, and business partners to communicate by voice, video, or messaging through a single interface, regardless of their location or network. Administrators can configure Microsoft Lync to work with their existing call servers to provide users with advanced productivity features and communication tools for locating and interacting with others in real time. Microsoft Lync is easy to deploy and manage as administrators can configure Lync directly into existing infrastructure, eliminating the need for additional gateways. The first section of this feature profile shows administrators how to set up the configuration files for interoperability with Microsoft Lync, and the second section provides a brief description of user features that behave differently when phones are registered with a Microsoft Lync Server Microsoft Lync Server 2010 works with Polycom SoundPoint IP desktop phones, SoundStation IP 5000 conference phones, SoundStation Duo conference phones, and VVX 500 and 1500 business media phones, and SpectraLink 8400 Series wireless handsets running Polycom UC Software or later. All phones are compatible with presence-based real-time voice communications, Microsoft Lync enables you to use instant messaging with the SpectraLink 8400 Series Wireless handsets. Table 1: Microsoft Lync 2010 Features and Interoperability at a Glance highlights which Polycom phones are supported, what software release is required, and any limitations that exist. Table 1: Microsoft Lync 2010 Features and Interoperability at a Glance Released: November 2011 Interoperability Issues: None Applies to models: SoundPoint IP 321, 331, 335, 450, 550, 560, 650, and 670 SoundStation IP 5000 SoundStation Duo VVX 500 and 1500 SpectraLink 8400 Series Available Support Documentation: Polycom UC Software Administrators Guide Provisioning Polycom Phones for Use with Microsoft Lync Server 2010 How to Provision a Polycom Phone Software version: UC Software or later Limitations: Instant messaging available only on the SpectraLink 8400 Series Wireless Handsets Main business size: Small to medium business Maintenance: One-time set up Primary users: Users and administrators Dependencies: None November Rev. A 1

2 Licenses Required: No licenses required Resources Required: None Supported server versions: Security: TLS Authentication When deploying Polycom phones for use with Microsoft Lync Server 2010, you must configure both the Microsoft Lync Server 2010 and the Polycom phones. For details on how to provision your Polycom phones with the latest UC Software, and on features related to those in Microsoft Lync Server 2010 including Group Paging and 802.1X Authentication, and how to provision your Polycom with the latest UC Software, see the latest Polycom UC Software Administrators Guide on the Polycom Support site. For more information, you can also read Provisioning Polycom Phones for Use with Microsoft Lync Server 2010 and How to Provision a Polycom Phone. For details on how to use your Polycom phones, including how to set up different ringtones for different callers, see the User Guide for your phone on the appropriate Polycom Support web site. Web Info: Integrating the Calendaring Feature on Polycom Phones If you want to use the Calendaring feature on SpectraLink 8400 Series handsets and VVX 500 and 1500 phones, read the Engineering Advisory 66940: Integrating the Calendaring and Instant Messaging/Presence Features on Polycom Phones available on the Polycom Support web site. Web Info: For Microsoft Environments For information on how to configure your Microsoft Lync Server 2010, see the Polycom Unified Communications Deployment Guide for Microsoft Environments on the Polycom Support site. Configuring Polycom Phones for the Microsoft Lync Server Environment Your Polycom phones must be running Polycom UC Software or later to be used with the Microsoft Lync Server. This section shows you how to configure the Polycom phones for use in a Microsoft Lync environment. 2

3 To configure Polycom phones in a Microsoft Lync environment: 1 Install a Microsoft CA certificate on the Polycom phones and configure the phones to use this certificate for authentication with Microsoft Lync Server See Setting Up Polycom Phones for Microsoft Lync Authentication. 2 Modify the configuration templates lyncperphoneexample.cfg, lyncperphonelcexample.cfg, and lyncsharedexample.cfg to register Polycom phones with Microsoft Lync Server, enable Polycom phones for Microsoft Presence, and enable Polycom phones for Microsoft Instant Messaging (only supported for SpectraLink 8400 Series Wireless Handsets at this time). These configuration templates are included in the Polycom UC Software software package. Change your master configuration file cfg or [MACAddress].cfg to use these configuration templates. Power Tip: When Editing a Configuration Template Polycom recommends that you use an XML editor such as XML Notepad to edit the lync*.cfg templates. In this way, all configuration files that you create will be valid XML files. Admin Tip: All Calls Established Though SRTP Polycom phones support calls established through Secure Real-Time Transport Protocol (SRTP). SRTP must be used for all lines registered to the Microsoft Lync Server Admin Tip: Connecting Polycom Phones to More Than One Call Server You can connect Polycom phones to other call servers at the same time as they are connected to Microsoft Lync. For more information on connecting to more than one call server at a time, see the latest Polycom UC Software Administrators Guide. Setting Up Polycom Phones for Microsoft Lync Authentication You must install a Microsoft CA certificate on each of your Polycom phones so they will register with the Microsoft Lync Server 2010, and then use this certificate for authentication. You can install the certificate through the phone s user interface or through the configuration files (shown in the next section). 3

4 To install a Microsoft CA certificate on your phone: 1 Press the Menu key, and select Settings > Advanced > Admin Settings > TLS Security > Custom CA Certificates. When prompted, enter the administrative password. The default password is Press the Install soft key. 3 Enter the URL of the certificate. 4 Press the Enter soft key. The MD5 fingerprint of the certificate displays on the screen. To use this certificate for authentication: 1 Press the Menu key, and select Settings > Advanced > Admin Settings > TLS Security > Configure TLS Profiles > TLS Platform Profile 1 > CA Certificates. When prompted, enter the administrative password. The default value is 456. Admin Tip: Which Profile to Use on SpectralInk 8400 Series Handsets If you want to provision SpectraLink 8400 Series handsets with Microsoft Lync and the SpectraLink 8400 Series handsets are configured to use TLS Platform Profile 1 for 802.1X Authentication, use TLS Platform Profile 2 for Microsoft Lync authentication. 2 Scroll to All Certificates and press the Select soft key. All certificates on the phone will be used for authentication, including the Microsoft CA Certificate installed above. Configure the Polycom Phones for Use with the Microsoft Lync Server 2010 The following examples show you the minimum configuration you need to set to integrate a phone that has a single registration with Microsoft Lync Server You can use the lync*.cfg templates to make the required configuration changes to put a single registered line on a Polycom Phone. These templates come with the UC Software package and can be found in the PartnerConfig\Microsoft\ folder. You can also use the configuration template files that come with the UC Software package (in the \Config folder). You will need features.cfg, sip-basic.cfg, sipinterop.cfg, reg-basic.cfg, reg-advanced.cfg, and site.cfg template files. For more information on the pre-packaged configuration templates, see the latest Polycom UC Software Administrators Guide. 4

5 You need to enable the presence and messaging features, as well as set a line/registration number on which roaming buddies support is enabled and set the office hours. You can force users to enter their login credentials or you can enter them into the template file. To save time, enter the Microsoft CA Certificate into the template file. The values and description of each parameter is listed in Table 2: Setting Up Microsoft Lync Server 2010 Configuration. To configure a single registration with Microsoft Lync Server 2010: 1 Open the configuration templates in an XML editor. 2 Enable the presence and messaging features as shown next. 3 Enable the roaming buddies feature as shown next. 4 Set for the office hours idle timeout period as shown next. 5 Ensure all consultation calls are logged as shown next. 5

6 6 In voipprot.sip.mtls.enable, disable Mutual TLS if the self-signed CA certificate is not accepted by the Microsoft Lync Server. 7 In voipprot.sip.im.autoanswerdelay, you can specify a time interval that determines how your instant messages are received. Enter a value of 40 seconds if you want the Microsoft Lync client on the computer to always answer first. Enter a value between 10 and 15 seconds if you want the SpectraLink 8400 Series handset to answer the instant messages first. The following example uses a value of 40 to show that the Microsoft Lync client on the computer will receive instant messages. 8 Specify the Microsoft Lync Server server name. In the example shown next, the server address is set to c1fe.vanocs.local. 6

7 9 Disable the transfer on proceeding as shown next. 10 Set msg.mwi.x.callbackmode to contact and set the callback location to the Microsoft Lync Server voic . In the example shown next, the callback location is set to 11 Set the Microsoft Lync Server 2010 user s address. Set the line key label, if desired. In the example shown next, Microsoft Lync Server 2010 user s address is set to tdavis@vanocs.local and the line label is set to Admin Tip: Security Issues With Entering the User s Login Name, Password, and Domain into the Configuration File You can enter a user s Microsoft Lync Server user ID, password, and domain into the configuration template file. However, this may conflict with your organization s security procedures. Asking a user to enter their user ID, password, and domain is considered more secure. See Changing your Login Credentials. 7

8 12 In reg.x.auth.uselogincredentials, determine whether or not to enable the use of login credentials. The following example shows reg.x.auth.uselogincredentials has been set to 1 indicating that login credential entry is required. 13 Configure the transport protocol for Microsoft Lync to use. For the transport protocol parameter (reg.x.server.y.transport), specify TLS. 8

9 14 For the server type parameter (reg.x.server.y.specialinterop), specify lync2010. You must assign this value for instant messaging to work. 15 You must enable SRTP when connected to the Microsoft Lync 2010 Server. You can do this for your entire site or on a per-phone basis. Enable the per-site SRTP parameters as shown next. Enable the per-registration SRTP parameters as shown next. 9

10 16 Finally, put the Microsoft CA certificate on the phone by setting up a custom CA certificate, if you did not enter this Certificate through the phone user interface (see Setting Up Polycom Phones for Microsoft Lync Authentication). You must enter the CA certificate into the template file in PEM format including the BEGIN and END markers. The following example shows the custom CA certificate parameter when selected. 17 Save your changes. Admin Tip: Workaround for Microsoft Lync Client - Polycom VVX 1500 Video Issue In some video calls between a Microsoft Lync client and a VVX 1500 phone, there is no video in client window. This happens because Microsoft Lync clients do not support standard fast update request signaling techniques. As a workaround, you will need to change video.iframe.delay to 2 seconds in video.cfg. This change has already been made in the lync*.cfg templates. Admin Tip: Workaround for Polycom Phones using G.722 and for Retrieving Microsoft Lync Voic If your Polycom phones are configured with G.722 and users find that they do not hear audio when retrieving voic from the Microsoft Lync Server, you will need to make the following changes to the site.cfg template file: Change voice.codecpref.g kbps from 0 to 5. Change voice.codecpref.g kbps from 5 to 0. Add voice.audioprofile.g kbps.payloadtype and set it to 112. These changes have already been made in the lync*.cfg templates. 10

11 Understanding Microsoft Lync Configuration Parameters If you are a system administrator, you can configure the Microsoft Lync feature using configuration files or the Web Configuration Utility. When using configuration files, see Table 2: Setting Up Microsoft Lync Server 2010 Configuration to help you understand the parameters values that configure this feature. You can locate all of the parameters used to configure the Microsoft Lync Server 2010 in the features.cfg, sip-basic.cfg, sip-interop.cfg, reg-basic.cfg, reg-advanced.cfg, and site.cfg configuration templates. For information on setting these parameters, see the Polycom UC Software Administrators Guide on the Polycom Support web site. Note that the value x in certain parameters shown next represents the registration and the value y in certain parameters shown next represents the server. Table 2: Setting Up Microsoft Lync Server 2010 Configuration Parameter Permitted Values Default calllists.logconsulationcalls 0 or 1 0 If 1, all consultation calls are logged. (Calls made to a third party while the original party is on hold when settings up a conference call are called consultation calls.) If 0, consultation calls are not logged. feature.messaging.enabled 1 0 or 1 0 If 0, the instant messaging feature is disabled. If 1, the feature is enabled. The instant messaging feature is supported on SpectraLink 8400 Series handsets only. feature.presence.enabled 1 0 or 1 1 If 0, the presence feature including buddy managements and user status is disabled. If 1, the presence feature is enabled with the buddy and status options. msg.mwi.x.callbackmode contact, registration, disabled registration The message retrieval mode and notification for registration x. contact a call is placed to the contact specified by msg.mwi.x.callback. registration the registration places a call to itself (the phone calls itself). disabled message retrieval and message notification are disabled. msg.mwi.x.callback ASCII encoded string containing digits (the user part of a SIP URL) or a string that constitutes a valid SIP URL (6416 or 6416@polycom.com) Null The contact to call when retrieving messages for this registration if msg.mwi.x.callbackmode is set to contact. 11

12 Parameter Permitted Values Default pres.idletimeout.officehours.enabled 0 or 1 1 If 0, the office hours idle timeout feature is disabled. If 1, the feature is enabled. pres.idletimeout.officehours.period 1 to 600, minutes 15 If the phone is idle for this time period, a presence status of Away displays on the phone and is sent to the Microsoft Lync Server. Once the user presses any key on the phone, the presence status returns to its previous value. pres.reg positive integer 1 The valid line/registration number that is used for presence. This registration sends a SUBSCIRBE for presence. If the value is not a valid registration, this parameter is ignored. reg.x.address string address Null The user part (for example, 1002) or the user and the host part (for example, 1002@polycom.com) of the registration SIP URI or the H.323 ID/extension. reg.x.auth.uselogincredentials 0 or 1 0 If 0, login credentials are not used for authentication to the server on registration x. If 1, login credentials are used for authentication to the server. Note: This must be set to 1 for instant messaging on the SpectraLink handsets. reg.x.auth.userid string Null User ID to be used for authentication challenges for this registration. If the password non-null, it will override the user parameter entered into the Authentication submenu on the Settings menu of the phone. reg.x.auth.password string Null The password to be used for authentication challenges for this registration. If the password is non-null, it will override the password entered into the Authentication submenu on the Settings menu of the phone. reg.x.auth.domain string Null The domain of the authorization server that is used to check the user names and passwords. reg.x.server.y.address dotted-decimal IP address or hostname Null The IP address or host name of a SIP server that accepts registrations. If not Null, all of the parameters in this table will override the parameters specified in voipprot.server. Note: If this parameter is set, it will take precedence even if the DHCP server is available. If this registration is used for Microsoft Lync Server 2010 on SpectraLink handsets, this parameter must be in the form OCShostname.OSCdomain_name. 12

13 Parameter Permitted Values Default reg.x.server.y.transport DNSnaptr, TCPpreferred, UDPOnly, TLS, TCPOny DNSnaptr The transport method the phone uses to communicate with the SIP server. Null or DNSnaptr if reg.x.server.y.address is a hostname and reg.x.server.y.port is 0 or Null, do NAPTR then SRV look-ups to try to discover the transport, ports and servers, as per RFC If reg.x.server.y.address is an IP address, or a port is given, then UDP is used. TCPpreferred TCP is the preferred transport; UDP is used if TCP fails. UDPOnly only UDP will be used. TLS if TLS fails, transport fails. Leave port field empty (will default to 5061) or set to TCPOnly only TCP will be used. reg.x.server.y.specialinterop standard, ocs2007r2, lcs2005, lync2010 standard Specify if this registration should support Microsoft Office Communications Server 2007 R2 (ocs2007r2), Microsoft Live Communications Server 2005 (lcs2005), or Microsoft Lync 2010 (lync2010). This parameter overrides voipprot.server.x.specialinterop. Note: To use instant messaging on SpectraLink handsets running UC Software 4.0.1, set this parameter to lync2010. reg.x.srtp.enable 1 0 or 1 0 If 0, the phone always declines SRTP offers. If 1, the phone accepts SRTP offers. This parameter overrides sec.srtp.enable. reg.x.srtp.offer 0 or 1 0 If 1, the phone includes a secure media stream description along with the usual non-secure media description in the SDP of a SIP INVITE. This parameters applies to the phone initiating (offering) a phone call. If 0, no secure media stream is included in SDP of a SIP invite. This parameter overrides sec.srtp.offer. reg.x.srtp.require 0 or 1 0 If 0, secure media streams are not required. If 1, the phone is only allowed to use secure media streams. Any offered SIP INVITEs must include a secure media description in the SDP or the call will be rejected. For outgoing calls, only a secure media stream description is included in the SDP of the SIP INVITE, meaning that the nonsecure media description is not included. If this parameter set to 1, reg.x.srtp.offer will also be set to 1, regardless of the value in the configuration file. This parameter overrides sec.srtp.require. reg.x.telephony 0 or 1 1 If 0, telephony calls are not enabled on this registration (use this value if the registration is used with Microsoft Office Communications Server 2007 R2 or Microsoft Lync If 1, telephony calls are enabled on this registration. roaming_buddies.reg positive integer Null The index of the registration which has roaming buddies support enabled. If Null, the roaming buddies feature is disabled. Warning: This parameter must be set if the call server is Microsoft Lync Server

14 Parameter Permitted Values Default sec.srtp.enable 1 0 or 1 0 If 0, the phone always declines SRTP offers. If 1, the phone accepts SRTP offers. Note: The defaults for SIP was 0 when Null or not defined. sec.srtp.offer 1 0 or 1 0 If 1, the phone includes a secure media stream description along with the usual non-secure media description in the SDP of a SIP INVITE. This parameters applies to the phone initiating (offering) a phone call. If 0, no secure media stream is included in SDP of a SIP invite. sec.srtp.require 1 0 or 1 0 If 0, secure media streams are not required. If 1, the phone is only allowed to use secure media streams. Any offered SIP INVITEs must include a secure media description in the SDP or the call will be rejected. For outgoing calls, only a secure media stream description is included in the SDP of the SIP INVITE, meaning that the nonsecure media description is not included. If this parameter set to 1, sec.srtp.offer will also be set to 1, regardless of the value in the configuration file. sec.strp.mki.enabled 1 0 or 1 0 The master key identifier (MKI) is an optional parameter for the cryptographic parameter in the SDP that uniquely identifies the SRTP stream within an SRTP session. MKI is expressed as a pair of decimal numbers in the form: mki:mki_length where mki is the MKI value and mki_length its length in bytes. If 1, a four-byte MKI parameter is sent within the SDP message of the SIP INVITE / 200 OK. If 0, the MKI parameter is not sent. sec.srtp.mki.length integer 4 The length of the mki in bytes. Note: To support Microsoft SRTP, set to 1. sec.srtp.holdwithnewkey 2 0 or 1 0 If 0, a new key is not provided when holding a call. If 1, a new key is provided when holding a call. sec.srtp.resumewithnewkey 2 0 or 1 0 If 0, a key is not provided when resuming a call. If 1, a key is provided when resuming a call. voipprot.sip.allowtransferonproceeding 0 to 1 1 If set to 1, a transfer can be completed during the proceeding state of a consultation call. If set to 0, a transfer is not allowed during the proceeding state of a consultation call. voipprot.sip.mtls.enable 0 or 1 0 If 0, Mutual TLS is disabled. If 1, Mutual TLS is enabled. Used in conjunction with Microsoft Lync Server voipprot.sip.use486forreject 0 or 1 0 If set to 1 and the phone is indicating a ringing inbound call appearance, the phone will transmit a 486 response to the received INVITE when the Reject soft key is pressed. If set to 0, no 486 response is transmitted. 14

15 Parameter Permitted Values Default voipprot.server.x.specialinterop standard, ocs2007r2, lcs2005, lync2010 standard Specify if this registration should support Microsoft Office Communications Server 2007 R2 (ocs2007r2), Microsoft Live Communications Server 2005 (lcs2005), or Microsoft Lync 2010 (lync2010). Note: To use instant messaging on SpectraLink handsets running UC Software 4.0.1, set this parameter to lync2010. voipprot.sip.im.autoanswerdelay 0 to 40, seconds 10 The time interval from receipt of the instant message invitation to automatically accepting the invitation. 1 Change causes phone to restart or reboot. 2 Applies to SpectraLink 8400 Series Wireless Handsets only. Using the Features on Polycom Phones Working With Microsoft Lync Server This section explains the features and options available on your Polycom phone once you have configured the phone to work with the Microsoft Lync Server. First, you must enter your login credentials into your Polycom phone. See Changing your Login Credentials. When your phone is configured to work with a Microsoft Lync Server, you will be able to: Place and answer calls Hold and resume multiple calls Transfer calls Set up conference calls Forward incoming calls to other users Access your contact directory Work with call lists Access voic Set your presence status Manage your Microsoft Lync contacts (called buddies) Send and receive instant messages (on SpectraLink 8400 Series wireless handsets only) 15

16 Note: User Features That Behave Differently When the Phones are Registered With Microsoft Lync Server 2010 Shared lines are not supported on lines registered to the Microsoft Lync Server Polycom phones running Polycom UC Software cannot initiate a Microsoft Lync-hosted conference call. Web Info: Reading Polycom Phone User Guides For details about how specific features work on particular Polycom phones, see the phone User Guide available on the Polycom Support site at Changing your Login Credentials Your system administrator will assign you login credentials a domain, user name, and password so you can call with your Lync contacts using your Polycom phone. To call your Lync contacts, you must enter these credentials into your phone. If your phone has incorrect Login Credentials or you need to enter them, you will see: The message Login Credentials have failed. Please update them if information is correct displays on the screen. or a similar icon displays in the status bar to warn you that your credentials have failed. The message Invalid login credentials scrolls under the time in the status bar. To re-submit or enter your login credentials: 1 Press the Menu key, and select Basic > Login Credentials. 2 Enter your domain, user name, and password. 3 Select Submit. Your credentials are submitted. Once your Polycom phone is ready to use, the home screen displays. 16

17 The following figure shows how the appearance of the Login Credentials screen varies across on several different Polycom phones. Figure 1: Entering Login Credentials SoundPoint IP 335 SoundPoint IP 670 SpectraLink 8400 Series VVX 500 Troubleshooting: My Login Credential Don t Work If you still don t have access to Lync contacts after entering your credentials, try entering your credentials again, and then press Submit. If you still don t have access to your contacts, or you lock your account, see your system administrator. Managing Your Microsoft Lync Contacts You can select the Microsoft Lync contacts called buddies or IM contacts on the phone s user interface that you want to monitor. The buddies that you monitor will form your buddy status list. 17

18 Updating Your Buddy List You can add contacts to your buddy status list from your contact directory. You can also dial contacts from the buddy list. To add a contact to your buddy list on the SpectraLink 8400 Series handset: 1 Select the Contacts/Call Lists icon on the home screen and press OK. 2 Select IM Contacts and press OK again. The IM Contacts screen displays as shown next. Figure 2: Viewing IM Contacts SpectraLink Press the Add soft key to add new IM contacts, and enter the contact s user ID name. To add a contact to your buddy list on SoundPoint IP and VVX phones: 1 Press the Menu key, and select Features > Presence > Buddy Status. a On the SoundPoint IP 335 phone, press the OK key when <new entry> displays. Enter the contact s user ID and press the OK key again. b On other SoundPoint IP phones and the VVX phones, press the Add soft key, and enter the contact s user ID. You may need to press a More soft key before the Add soft key displays. The following figure shows the Buddy Status list on several Polycom phones. 18

19 Figure 3: Viewing the Buddy List SoundPoint IP 335 SoundPoint IP 670 VVX 500 The following figure shows the Home screen of several Polycom phones that are displaying buddies. For example: On the SoundPoint IP 335 phone, Tom is a buddy. On the SoundPoint IP 670 phone, Betty, Michelle, and Tom are buddies. They are all away from their phones. On the VVX 500 phone, Michelle and Tom are buddies. They are both away from their phones. Figure 4: Viewing the Home Screen SoundPoint IP 335 SoundPoint IP

20 SpectraLink 8400 Series VVX

21 Trademarks 2011, Polycom, Inc. All rights reserved. POLYCOM, the Polycom "Triangles" logo and the names and marks associated with Polycom's products are trademarks and/or service marks of Polycom, Inc. and are registered and/or common law marks in the United States and various other countries. All other trademarks are property of their respective owners. No portion hereof may be reproduced or transmitted in any form or by any means, for any purpose other than the recipient's personal use, without the express written permission of Polycom. Disclaimer While Polycom uses reasonable efforts to include accurate and up-to-date information in this document, Polycom makes no warranties or representations as to its accuracy. Polycom assumes no liability or responsibility for any typographical or other errors or omissions in the content of this document. Limitation of Liability Polycom and/or its respective suppliers make no representations about the suitability of the information contained in this document for any purpose. Information is provided "as is" without warranty of any kind and is subject to change without notice. The entire risk arising out of its use remains with the recipient. In no event shall Polycom and/or its respective suppliers be liable for any direct, consequential, incidental, special, punitive or other damages whatsoever (including without limitation, damages for loss of business profits, business interruption, or loss of business information), even if Polycom has been advised of the possibility of such damages. Customer Feedback We are constantly working to improve the quality of our documentation, and we would appreciate your feedback. Please send to Visit support.polycom.com for software downloads, product document, product licenses, troubleshooting tips, service requests, and more. 21