i
PROVISIONING GUIDE
Deploying Polycom®
UC Software
for use with Microsoft® Lync
™ Server 2010
Polycom UC Software | 2013 | 1725-49078-002 Rev A
ii
Deploying Polycom® UC Software for use with Microsoft™ Lync® Server 2010
Copyright ©2013, Polycom, Inc. All rights reserved.
6001 America Center Drive San Jose, CA 95002 USA
No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Polycom, Inc. Under the law, reproducing includes translating into another language or format.
As between the parties, Polycom, Inc., retains title to and ownership of all proprietary rights with respect to the software contained within its products. The software is protected by United States copyright laws and international treaty provision. Therefore, you must treat the software like any other copyrighted material (e.g., a book or sound recording).
Every effort has been made to ensure that the information in this manual is accurate. Polycom, Inc., is not responsible for printing or clerical errors. Information in this document is subject to change without notice.
Trademarks
POLYCOM®, the Polycom logo and the names and marks associated with Polycom 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 striving to improve our documentation quality and we appreciate your feedback. Email your opinions and comments to [email protected].
Visit the Polycom Voice Support Center for software downloads, product documents, product licenses, troubleshooting tips, service requests, and more.
iii
Contents
About This Guide .......................................................................................................... v
Who Should Read this Guide? ............................................................................................ v
Conventions Used in this Guide .......................................................................................... v
Information Elements ........................................................................................................... v
Typographic Conventions ................................................................................................... vi
What’s in This Guide? .........................................................................................................vii
Getting Started .............................................................................................................. 1
Before You Begin ................................................................................................................. 2
Frequently Asked Questions ............................................................................................... 2
What’s New? ......................................................................................................................... 3
Required Solution Software ................................................................................................. 6
UC Software | Hardware Dependencies .............................................................................. 6
Known Issues ....................................................................................................................... 6
Getting Help and Support Resources ................................................................................. 7
Deploying Polycom® Devices with Microsoft® Lync™ Server 2010 .......................... 9
Task 1: Setting Up the Network ..........................................................................................12
Task 2: Downloading Polycom UC Software .....................................................................14
Task 3: Provisioning the Phones .......................................................................................17
Ensuring Security ...............................................................................................................17
Provisioning Phones Manually ...........................................................................................21
Centralized Provisioning Methods ......................................................................................27
Sign In or Out of Lync ................................................................................................. 41
Enabling the Exchange Calendar............................................................................... 43
References ................................................................................................................... 45
Updating Polycom UC Software .........................................................................................45
Resetting the Phone to Factory Default Settings ..............................................................46
Understanding Provisioning Methods ...............................................................................48
Manual Provisioning...........................................................................................................48
Web Configuration Utility ...................................................................................................48
Centralized Provisioning ....................................................................................................48
Manually Installing a Certificate .........................................................................................50
Understanding Lync Configuration Files ...........................................................................53
Understanding In-Band Provisioning .................................................................................65
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
iv
Getting Help ................................................................................................................. 71
Polycom and Partner Resources ........................................................................................71
The Polycom Community ....................................................................................................71
Troubleshooting .......................................................................................................... 73
v
About This Guide
This provisioning guide uses a number of conventions that help you to understand information
and perform tasks.
Who Should Read this Guide?
This provisioning guide is intended for administrators deploying one or more Polycom devices
with Microsoft® Lync® Server 2010. Administrators having no or little familiarity with Polycom
devices and provisioning methods will find this provisioning guide as useful as experienced
Polycom administrators.
Conventions Used in this Guide
This user guide contains terms, graphical elements, and a few typographic conventions.
Familiarizing yourself with these terms, elements, and conventions will help you perform phone
tasks.
Information Elements
The following icons are used to alert you to types of important information in this guide:
Icons Used in this Guide
Name Icon Description
Note
The Note icon highlights information of interest or important information
needed to be successful in accomplishing a procedure or to understand
a concept.
Administrator Tip
The Administrator Tip icon highlights techniques, shortcuts, or
productivity related tips.
Caution
The Caution icon highlights information you need to know to avoid a
hazard that could potentially impact device performance, application
functionality, or successful feature configuration.
Warning
The Warning icon highlights an action you must perform (or avoid) to
prevent issues that may cause you to lose information or your
configuration setup, and/or affect phone or network performance.
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
vi
Name Icon Description
Web Info
The Web Info icon highlights supplementary information available
online such as documents or downloads on support.polycom.com or
other locations.
Timesaver
The Timesaver icon highlights a faster or alternative method for
accomplishing a method or operation.
Power Tip
The Power Tip icon highlights faster, alternative procedures for
advanced administrators already familiar with the techniques being
discussed.
Troubleshooting
The Troubleshooting icon highlights information that may help you
solve a problem or to refer you to other relevant troubleshooting
resources.
Settings
The Settings icon highlights settings you may need to choose for a
specific behavior, to enable a specific feature, or to access
customization options.
Typographic Conventions
A few typographic conventions, listed next, are used in this guide to distinguish types of in-text
information.
Typographic Conventions
Convention Description
Bold Highlights interface items such as menus, soft keys, file names, and
directories. Also used to represent menu selections and text entry to the
phone.
Italics Used to emphasize text, to show example values or inputs, and to show
titles of reference documents available from the Polycom Support Web
site and other reference sites.
Blue Used for cross-references to other sections, chapters, or parts in this
document.
Underlined Blue Used for URL links to external Web pages or documents. If you click on
text in this style, you will be linked to an external document or Web page.
Blue Text Used for cross references to other sections within this document. If you
click on text in this style, you will be taken to another part of this
document.
About This Guide
vii
Convention Description
Fixed-width-font Used for code fragments and parameter names.
What’s in This Guide?
This provisioning guide is organized into six chapters.
Getting Started This chapter contains information you require before you begin provisioning
and registering your Polycom devices with Microsoft Lync Server2010. Polycom strongly
recommends that you read this section before proceeding.
Deploying Polycom® Devices with Microsoft® Lync™ Server 2010 This chapter takes you
through the steps required to configure your Polycom phone for Lync Server 2010. Note that
you will need to make several choices about your provisioning environment and will need to
read this chapter carefully.
Sign In or Out of Lync This brief chapter shows you how to sign in and out of Lync from the
phone user interface.
Enabling the Exchange Calendar Use this chapter to enable the Microsoft Exchange
Calendar feature.
References Use this section as a reference for further information you may need to register
your Polycom devices with Microsoft Lync Server 2010 and to make decisions about
provisioning methods. You can find further information on the following items:
Updating Polycom UC Software
Resetting the Phone to Factory Default Settings
Understanding Provisioning Methods
Manually Installing a Certificate
Understanding Lync Configuration Files
Understanding In-Band Provisioning
Getting Help Go to this chapter to get more information on Polycom and Microsoft products
and support. In particular, you’ll find links to the Polycom Community, which offers a number of
discussion forums you can use to share ideas and solve problems with your colleagues.
Troubleshooting This chapter lists several common troubleshooting tips. Many of these
troubleshooting tips are placed in context throughout this guide.
1
Getting Started
This provisioning guide shows you how to provision your Lync-qualified Polycom phones for use
with Microsoft Lync Server 2010. You require Lync-enabled Polycom UC software if you want to
deploy Polycom products in a Microsoft environment using features available with Microsoft
Lync Server 2010. If you are using Polycom US software for the first time, this provisioning
guide shows you how to get UC software and how to configure your phones. If you are updating
your existing Polycom devices to Polycom UC software, see Updating Polycom UC Software.
The following table lists Polycom phones qualified for use with Microsoft Lync Server 2010 and
current qualification status for Microsoft Lync Server 2013.
Table 1: Polycom Lync-qualified Phones
Polycom Phone Lync 2010 Qualification Lync 2013 Qualification
SoundPoint IP 321 In progress
SoundPoint IP 331 In progress
SoundPoint IP 335 In progress
SoundPoint IP 450 In progress
SoundPoint IP 550 In progress
SoundPoint IP 560 In progress
SoundPoint IP 650 In progress
SoundStation IP Duo In progress
SoundStation IP 5000 In progress
VVX 300 Business Media Phone In progress
VVX 310 Business Media Phone In progress
VVX 400 Business Media Phone In progress
VVX 410 Business Media Phone In progress
VVX 500 Business Media Phone
VVX 600 Business Media Phone
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
2
Before You Begin
Read the following points carefully before you begin registering Polycom devices with
Microsoft Lync Server 2010:
Polycom strongly recommends that you make yourself familiar with the centralized
provisioning method. Centralized provisioning requires you to set up a provisioning server,
or boot server, and use Polycom template configuration files in XML format. For
information on using Polycom configuration files, see:
○ Centralized Provisioning
○ Understanding Provisioning Methods
If you require additional information, see Chapter 4: Setting Up the Provisioning Server in
the Polycom UC Software 4.1.0 Administrators' Guide.
You must purchase a Lync Feature License from a Polycom reseller or Polycom sales
representative to use Polycom SoundPoint IP, SoundStation IP, and VVX products in a
Microsoft Lync environment. Login to Licensing & Product Registration for more
information. You can use Polycom phones in a Lync environment for trial purposes,
without purchasing a license, to a maximum of 30 days.
Frequently Asked Questions
Refer to the frequently asked questions (FAQs) to help answer questions you may have about
the solution before you begin.
Q: What is the Base Profile?
A: This document refers to the Base Profile. The Base Profile is an option available on Lync-
enabled Polycom devices running Lync-enabled Polycom UC software releases. Base
Profile is meant to simplify the process of provisioning and registering your devices with
Lync Server 2010. While Base Profile simplifies registration of your devices, you cannot
modify or customize the Base Profile or the settings Base Profile applies to your devices.
For these reasons, Polycom recommends using Base Profile as a provisioning method
for deployments under twenty devices requiring only default Lync Settings. Base profile
displays as an option in the device’s menu system and has two options: Generic and
Lync. By default, the Base Profile is set to Generic.
Q: What is the best way to provision my Polycom device with Lync Server 2010?
A: Polycom strongly recommends using the centralized provisioning method. Centralized
provisioning requires that you set up a provisioning server, uses Polycom template
configuration files, and enables you to automatically apply and modify settings to all of
your devices.
Getting Started
3
What’s New?
The following table lists Lync features available for Polycom UC software releases.
For more information on Polycom devices compatible with each UC software release, see the
Polycom UC Software/SIP Software Release Matrix.
Table 2: Available Lync Features
Feature UCS
4.0.1
UCS
4.1.0
UCS
4.1.2
UCS
4.1.3
UCS
4.1.4 Function
Support for
VVX 300, 310, 400, 410
To support
VVX 300, 310, 400, 410
Auto root certificate
fetch
Available only through
DHCP Option 43.
H.323 Video
Narrowband Audio G.711
Call Transfer, Hold,
Mute
Basic calling user actions
Full Duplex Echo
Cancellation
Wideband Audio G.722-1
Media Encryption SRTP, SSRTP
Direct Lync Registration Microsoft SIP, TLS for SIP
Signaling, SRTP, SSRTP
Peer-to-Peer Audio
Calling
Initiate and receive two-party
calls from any supported Lync
endpoint
Enterprise Voice
Message Waiting
Indicator (MWI)
Illumination of physical MWI lamp
on equipped devices
Voice Mail Retrieval One-touch call to voice mail
attendant
Presence Publication Busy, In a call, Away
Presence State Control Menu of selectable presence
states.
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
4
Feature UCS
4.0.1
UCS
4.1.0
UCS
4.1.2
UCS
4.1.3
UCS
4.1.4 Function
Calls Logs
Local call history for missed,
received, and outgoing calls.
Non-volatile for all platforms
except VXworks phones.
Log Access Local access to device diagnostic
logging
Device Updates Centralized device update from
out-of-band server
VLAN Assignment LLDP-MED VLAN assignment
Device Sign In
Out-of-the-box device user sign
in and sign out with cached
credentials
Remote Worker
Scenarios Edge Server Registration
Firewall Traversal A/V Edge Server support
(ICE/STUN/TURN)
Federation
Provisioning Support of in-band provisioning
from Lync Server
Monitoring Device Inventory Reports
Reporting
Call Admission Control In-band bandwidth policy support
Media Bypass
Supports by-passing the Lync
mediation server to send media
directly to PSTN Gateway
Dial Plans
Support Lync Server Regex
normalization patterns passed
via in-band provisioning to the
endpoint. Limited to regular
expression support. Option to do
server side normalization.
Call Forwarding to
Contacts
Getting Started
5
Feature UCS
4.0.1
UCS
4.1.0
UCS
4.1.2
UCS
4.1.3
UCS
4.1.4 Function
Call Forwarding to
Voicemail
Response Groups
Team-Call
Delegates
Private Lines Alternate call-forwarding identity
for a Lync user's secondary DID
Branch Office
Survivability
Maintain SBA/SBS registration
during WAN outage, automatic
recovery
E911 Supports in-band provisioning
information for Emergency 911
Location Services LLDP-MED location based
information support
Contacts List Display Lync contacts and their
current presence status
Contact Groups Display and expand groups in the
Lync user's contact list
Web Ticket
Authentication NTLMv2 Authentication
Client Certificate
Provisioning
TLS-DSK Client Certificate
Authentication
TCP Media
RTP Media and ICE negotiation
supported over TCP when UDP
is unavailable
PIN Authentication
Support for Lync authentication
using the user telephone number
and PIN
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
6
Required Solution Software
You must be using Polycom UC software 4.1.0B or later to register phones with Lync Server
2010. Any version of Polycom Unified Communications (UC) software 4.1.x is for use only with
Microsoft Lync Server 2010.
UC Software | Hardware Dependencies
Use the following table to determine which Polycom UC software you need for your Polycom
devices. All UC software versions listed are Lync-enabled.
Web Info: Getting Polycom UC Software
All UC software versions are available directly from the Polycom Voice Support web site.
For the latest UC software versions, see Latest Polycom UC Software Release.
For all UC software versions, see Polycom UC Software Support Center.
The following table lists the Polycom UC software versions you can use with your Polycom
devices.
Table 3: UC Software – Hardware Dependencies
Polycom UC Software Version Polycom Devices
UC software 4.1.4 VVX 410 | 400 | 310 | 300
UC software 4.1.2 VVX 500 | 600 business media phones
BootROM 4.0
UC software 4.1.0B
SoundPoint IP 321/331 | 335 | 450 | 550 | 560 | 650
SoundStation IP 5000 | Duo
VVX 500 Business Media Phone
Known Issues
Before you begin, take note of the following known issues and limitations with Polycom Lync-
Enabled UC software:
Polycom phones deployed with Microsoft Lync Server 2010 support one registered line.
The exchange calendar does not support TLS-DSK. If you have the calendar feature
enabled and your user credentials expire, authentication with the Microsoft Exchange
server fails and your device will deregister from the Lync server.
Getting Started
7
Microsoft Office Communicator Server 2007 does not support remote worker and
federation deployments.
Getting Help and Support Resources
This partner solution guide includes a Getting Help section you can use to find links to Polycom
product and support sites and partner sites. You can also find information about The Polycom
Community, which provides access to discussion forums you can use to discuss hardware,
software, and partner solution topics. The Polycom Community includes access to Polycom
support personnel, as well as user-generated hardware, software, and partner solutions topics.
To register with the Polycom Community, you will need to create a Polycom online account. You
can view top blog posts and participate in threads on any number of recent topics.
9
Deploying Polycom® Devices with
Microsoft® Lync™ Server 2010
This provisioning guide shows you how to register your Polycom phones with Lync Server 2010
and shows you several ways to provision the phones. Regardless of the provisioning method
you choose, you will need to complete two major tasks to correctly register your Polycom
devices with Lync Server. This provisioning guide details each of these major tasks.
Although there are several ways to provision your Polycom phones to register with Lync Server,
Polycom recommends that you set up a centralized provisioning server, especially if you are
registering multiple Polycom devices with Lync. The following figure provides an overview of
how your Polycom devices interoperate with the provisioning server and Lync server in an
optimal deployment scenario.
Figure 1: How the Phone Interoperates with Provisioning and Lync Server
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
10
This optimal deployment scenario requires you to complete 3 major tasks. The following figure
illustrates the 3 major tasks of the deployment process. You must complete the three tasks in
sequence.
Figure 2: Overview of the Major Deployment Tasks
Deploying Polycom® Devices with Microsoft® Lync™ Server 2010
11
Once you have successfully completed the deployment tasks, the phones perform a bootup
sequence, as shown in the following figure.
Figure 3: Phone Boot Up Sequence
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
12
Task 1: Setting Up the Network
This section shows you how to set up a network that connects your Polycom devices to Lync
Server. The following figure illustrates the four steps required to set up your network.
Figure 4: Setting Up your Network
To set up your network:
1 Setup or verify domain name system (DNS) service (SRV) records to allow the devices to
automatically discover Lync Server. For information on creating and verifying DNS SRV
records, see Required DNS Records for Automatic Client Sign-In.
2 Obtain a security certificate. Choose from the following two ways to obtain a security
certificate.
○ When provisioning phones from within an enterprise, you can use Dynamic Host
Configuration Protocol (DHCP) Option 43 to download a private CA root security
certificate used by Lync Server. The security certificate is required to support secure
HTTPS and TLS. In conjunction with DHCP Option 43, you need to ensure that your
devices can access Lync Server Certificate Provisioning web service over HTTP (TCP
80) and HTTPS (TCP 443).
For information on configuring DHCP Option 43, see Microsoft Setting Up DHCP for
Devices.
Deploying Polycom® Devices with Microsoft® Lync™ Server 2010
13
For quick background information on how Option 43 works with Lync Server, see
Understanding DHCP Option 43.
○ If you need to manually install a security certificate on your Microsoft Edge Server, the
signing certificate authority (CA) that issued this certificate must be listed on the
Polycom Trusted Certificate Authority List in Chapter 12 of the Polycom UC Software
4.1.0 Administrators’ Guide. You must use Base64 format. For instructions on manually
installing a certificate, see Manually Installing a Certificate in the reference section of
this provisioning guide.
3 (Optional) If you are using centralized provisioning requiring a provisioning or boot server,
configure DHCP Option 66 or, if unavailable, Option 160 with the address (URL or IP
address) of the provisioning server. You can set the provisioning server address or URL
through the device menu or using the Setting the Base Profile Using the Web
Configuration Utility.
4 Ensure that you set up each user with a Lync account and credentials that can be used to
sign in on the phone. Also set up PIN Authentication if you are using the following phones
in your deployment: VVX 300, 310, 400, 410, 500, 600.
Once you have successfully set up your network, download Polycom UC software.
Web Info: Setting Up the Network
If you need more detailed information on setting up a network for Polycom devices, see Chapter 3: Setting Up Your Device Network in the Polycom UC Software 4.1.0 Administrators’ Guide.
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
14
Task 2: Downloading Polycom UC Software
The second major task in deploying your Polycom devices for use with Lync Server is to
download Polycom UC software.
Figure 5: Downloading Polycom UC Software
Use the following table to determine which Polycom UC software you need for your Polycom
devices. All UC software versions listed are Lync-enabled.
Web Info: Getting Polycom UC Software
All UC software versions are available directly from the Polycom Voice Support web site.
For the latest UC software versions, see Latest Polycom UC Software Release.
For all UC software versions, see Polycom UC Software Support Center.
Table 4: Polycom UC Software – Hardware Dependencies
Polycom UC Software Version Polycom Devices
UC software 4.1.4 VVX 300 | 310 | 400 | 410
UC software 4.1.2 VVX 500 | 600 business media phones
BootROM 4.0
UC software 4.1.0B
SoundPoint IP 321/331 | 335 | 450 | 550 | 560 | 650
SoundStation IP 5000 | Duo
VVX 500 Business Media Phone
Deploying Polycom® Devices with Microsoft® Lync™ Server 2010
15
To download UC software:
1 Create a root directory on your PC. You will use this root directory to hold all of the
required UC software, configuration files, and sub-directories you create. Give the
directory a name that easily identifies it as containing the Polycom UC software release
you are using.
2 Download and save your UC software release to the root directory you created. You can
obtain the UC software from the Polycom UC Software Support Center. Polycom UC
software is distributed in .ZIP file format.
You can download the combined version or the split file version. The split files are
available for specific phone models, have a smaller size, faster update time, and reduce
internal network traffic during reboots and updates. The combined files are a larger size
and contain software files for all Polycom phone models. All configuration files are saved
in compressed ZIP file format and you will need to uncompressed the files before use.
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
16
3 Extract the .ZIP file in your root directory.
The UC software directory is extracted and displays in your root directory, shown next.
You have successfully completed Task 2, downloading the Polycom UC software.
Deploying Polycom® Devices with Microsoft® Lync™ Server 2010
17
Task 3: Provisioning the Phones
The third major task of the deployment process is to provision your Polycom phones. Polycom
provides five manual per-phone provisioning methods and two centralized provisioning
methods. The method labeled device.set is an advanced method for users familiar with Polycom
configuration files and uses centralized provisioning to set the Base Profile for multiple phones.
Ensuring Security
Polycom phones are computing devices and you need to configure them for security as you do
other computing devices. Polycom strongly recommends that you change the default user name
and password on each Polycom device on first deployment. To maximize security, do not leave
user name and password fields blank, create user names and passwords of a reasonably long
length, and change user names and passwords periodically.
Polycom provides three ways you can change the administrative password of a device:
Configuration file
Web Configuration Utility
Device user interface
Configuration File
Polycom provides configuration files in XML format that you can use to change user names and
passwords. You can modify the attached sample configuration file and add it to your file
directory, or you can add the parameters and values directly to your existing configuration files.
However you use the files or parameters, ensure that you add them to your boot server
directory. Once you have updated you configuration files, you need to update your device
configuration from the device user interface by going to Menu > Settings > Basic > Update
Configuration.
Settings: Use a Secure Protocol
Use a secure provisioning protocol such as FTPS or HTTPS to maximize security of user names and passwords.
Web Configuration Utility
The Web Configuration Utility is a web tool you can use to configure settings and features on a
per-phone basis. To access the Web Configuration, enter the IP address of the device to the
address bar of your browser. Log in as Admin and enter the default password 456.
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
18
Settings: Use HTTPS
Polycom recommends using the Web Configuration Utility with HTTPS to maximize security.
In the Web Utility, go to Settings > Change Password to access settings that change the user
name and password, as shown next.
Phone User Interface
On your phone, go to Menu > Settings > Advanced > Enter the default password 456 and press Enter >
Administration Settings > Change Admin Password.
Deploying Polycom® Devices with Microsoft® Lync™ Server 2010
19
Understanding Manual Provisioning Methods
As shown in Figure 6, Polycom provides five per-phone manual methods you can use to register
Polycom devices with Lync Server. This is a per-phone method enabling you to configure one
phone at a time. You must be running a Lync-enabled Polycom software release to register
phones to Lync server – see Table 2: Hardware and Software Dependencies.
All manual provisioning methods set the Base Profile of a phone to Lync. The Base Profile is a
feature on each Polycom phone that, when set to Lync, automatically provisions the phone with
the minimum parameters required to register with Lync Server. For details on all of the Lync
parameters and values, see Table 7: Default Lync Base Profile Parameter Values.
You can set the Base Profile directly from the phone and you can choose to set it during phone
bootup or after phone bootup. You can also use the Polycom Web Configuration Utility to set
the Base Profile to Lync on a per-phone basis using a web interface application that is
particularly helpful when you are working remotely.
Understanding Centralized Provisioning Methods
As shown in Figure 6, Polycom provides two centralized provisioning methods that will register
your phones with Lync Server. Centralized provisioning requires you to set up a provisioning, or
boot server supporting one of the FTP, TFTP, HTTP, or HTTPS protocols, FTP being the most
common. Note that this method requires you to use the XML configuration files attached to this
provisioning guide. Polycom strongly recommends using this method when provisioning multiple
phones to enable you to:
Configure multiple devices automatically
Facilitate automated software updates
Receive automatic log files
Add, remove, or manage features and settings to multiple phones simultaneously
Create phone groups and modify features and settings for each phone group
You must be running a Lync-enabled Polycom software release to register phones to Lync
server – see Table 2: Hardware and Software Dependencies.
For more information on setting up a provisioning server for Polycom products, see Chapter 4:
Setting Up the Provisioning Server in the Polycom UC Software 4.1.0 Administrators’ Guide.
If you need more information comparing manual and centralized provisioning methods, see the
reference section Understanding Provisioning Methods in this provisioning guide.
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
20
Power Tip: Using device.set
Polycom does provide a third provisioning method that uses centralized provisioning to set the Base Profile of multiple phones. Polycom recommends this method only for administrators familiar with Polycom provisioning and configuration files. Go directly to Setting the Base Profile with <device.set> Parameters.
Settings: Do Not Use An Existing Lync Deployment
Do not use any existing Lync servers to deploy your provisioning server. Doing so may affect performance of your Lync deployment. Misconfiguration or non-standard deployment of the Microsoft Internet Information Services (IIS) web server may affect your ability to obtain accurate Microsoft support.
The following figure illustrates the five manual provisioning methods, the two centralized
provisioning methods, and device.set. Click on a provisioning method in Figure 6 to go to the
provisioning procedure.
Figure 6: Provisioning Methods for use with Lync Server 2010
The following summarizes the provisioning choices shown in Figure 6:
Manual Provisioning
MKC during bootup Set the Base Profile to Lync using a multi-key combo during phone
bootup. This is the fastest manual provisioning method.
Boot Setup Menu Set the Base Profile to Lync during bootup using the phone boot
setup menu.
Boot Setup
Menu MKC during
bootup
Idle Screen
MKC
Phone
Menu
Config File
Credentials
Web Cfg
Utility
device.set
Phone
Credentials
Deploying Polycom® Devices with Microsoft® Lync™ Server 2010
21
Idle Screen MKC Set the Base Profile to Lync from the phone idle screen using a multi-
key combo.
Phone Menu Set the Base Profile to Lync from the idle screen using the phone’s menu
system.
Web Configuration Utility Use the Polycom Web Configuration Utility to set the Base
Profile from a web browser.
Centralized Provisioning
Phone Credentials Configure multiple phones so that each user enters sign-in
credentials to log in and out of their phone. This is the most secure centralized
provisioning method.
Config File Credentials Configure multiple phones with the user sign-in credentials in
the configuration files to automatically log in the user.
Device.set Use a provisioning server and configuration files to set the Base Profile of
multiple phones to Lync. This is a power provisioning method for administrators familiar
with Polycom centralized provisioning and configuration files.
Provisioning Phones Manually
This section shows you five ways to set the Base Profile of a phone to Lync.
Setting the Base Profile During Bootup
This section shows you two ways to set the Base Profile of a phone to Lync during the phone
bootup cycle: using a multi-key combo (MKC) during bootup or from the phone boot Setup
menu. Note that MKC during bootup is the fastest manual provisioning method.
If your phones are not out-of-box from the manufacturer, ensure that you ensure that you reset
the phone to factory default settings, as shown in Resetting the Phone to Factory Default
Settings.
To set the Base Profile to Lync using MKC during bootup:
1 Boot up the phone or reboot after you have reset the phone to factory default settings.
2 A few seconds into the device bootup cycle, the phone displays the message Starting
Application, press Cancel to interrupt and a Cancel soft key. Press the Cancel soft key.
3 When the phone displays three soft keys - Start, Setup, About - enter the multi-key combo
for the phone model now.
SoundPoint IP 550, 560, and 650 5, 7, 8, *
VVX 300, 310, 400, 410, 500, 600 1, 4, 9
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
22
Pressing and holding the MKC keys causes the Base Profile Password menu to display.
4 Enter the password (default 456) to change the Base Profile and press Ok.
The Base Profile menu displays.
5 Press the Edit soft key, use the keypad keys to set the Base Profile to Lync, and press
Ok > Exit.
6 Highlight Save & Reboot and press the Select soft key.
The phone reboots and displays the Lync Server Sign In screen.
You can now Sign in or Out of Lync.
To set the Base Profile to Lync from the phone boot Setup menu:
1 Boot up the phone or reboot after you have reset the phone to factory default settings.
2 A few seconds into the device bootup cycle, the phone displays the message Starting
Application, press Cancel to interrupt and a Cancel soft key. Press the Cancel soft key.
3 When the phone displays three soft keys - Start, Setup, About - press the Setup soft key,
enter the password (default 456), and select Ok.
The phone displays a diagram of keypad keys you can use to navigate the Setup menu.
You will need to use these keys in the next few steps.
4 Press the Setup soft key and the Setup menu displays.
5 Using the keypad keys, scroll down, highlight Base Profile, and select the Edit soft key.
6 Using the keypad keys, set the Base Profile to Lync, and press Ok > Exit.
7 Highlight Save & Reboot and press the Select soft key.
The phone reboots and displays the Lync Server Sign In screen. You can now Sign In or
Out of Lync.
SoundPoint IP 321, 331, 335, 450
SoundStation 5000, SoundStation Duo conference phones 1, 2, 4, 5
Deploying Polycom® Devices with Microsoft® Lync™ Server 2010
23
Setting the Base Profile from the Idle Screen
This section shows you two ways to set the Base Profile to Lync using the phone menu system
when the phone is in idle screen mode, and how to sign in and register a line with Lync Server.
To set the Base Profile to Lync using the multi-key combo shortcut:
1 Press the phone’s Home/Menu key.
2 From the idle screen, press and hold the following key combination on the phone keypad
for about 3 seconds. These multi-key combo (MKC) keys vary by phone.
Pressing and holding the MKC keys causes the Base Profile Password menu to display.
3 In the Base Profile Password screen, enter the password (default 456) and press Enter.
4 In the Base Profile menu, select Lync.
The phone automatically reboots and displays the Lync Server Sign In screen.
If your phone supports PIN authentication, you will be prompted for authentication. Otherwise,
you will be prompted for Lync sign-in credentials. You can display the Lync login screen by
going to Menu > Features > Microsoft Lync > Login Credentials.
Troubleshooting: Phone Does Not Reboot
If the phone does not reboot, you can restart the phone by going to Settings > Basic > Restart, or you can power off/on the phone.
SoundPoint IP 550, 560, and 650 5, 7, 8, *
VVX 300, 310, 400, 410, 500, 600 1, 4, 9
SoundPoint IP 321, 331, 335, 450
SoundStation 5000, SoundStation Duo conference phones 1, 2, 4, 5
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
24
To set the Base Profile to Lync using the phone menu system:
1 Press the Home/Menu key.
2 From the idle screen, select Settings > Advanced > Administration Settings > Network
Configuration, and set Base Profile to Lync. Select Back > Save Configuration. The
phone automatically restarts and displays the Lync Server Sign In screen.
You can now Sign In or Out of Lync.
Setting the Base Profile Using the Web Configuration Utility
You can use the Web Configuration Utility to manually set the Base Profile of a phone. Note that
you can use the Web Configuration Utility to provision one phone at a time. You will need to
obtain the IP address of each phone.
To set the Base Profile to Lync using the Web Configuration Utility:
1 Obtain the IP address of each phone in your deployment by pressing the Menu/Home key
and going to Settings > Status > Platform > Phone. The IP address displays in the field
labeled IP:.
2 Enter the phone’s IP address in the address bar of a web browser and press Enter on
your PC keyboard.
Deploying Polycom® Devices with Microsoft® Lync™ Server 2010
25
The Web Configuration Utility login screen displays, shown next.
3 Choose Administrator, enter the password (default 456), and click Submit.
The Home page displays.
4 From the Home page, navigate to the Simple Setup menu, shown next.
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
26
5 From the Base Profile drop-down, choose Lync, and click on Save at the bottom of the
page. In the confirmation dialog, choose Yes.
The phone automatically reboots.
You can now Sign In or Out of Lync.
Troubleshooting: Rebooting the Phone
If the phone does not reboot, you can manually restart by powering off/on the phone. You can also manually reboot the phone: Press the Menu/Home key > Settings > Advanced, enter the password (default 456), press Enter, and choose Reboot Phone. When the phone completes the reboot cycle, the Lync Server Sign In screen displays.
Deploying Polycom® Devices with Microsoft® Lync™ Server 2010
27
Centralized Provisioning Methods
This section shows you how to provision your phones with Polycom UC software using
centralized provisioning. If you are deploying more than 20 phones, Polycom recommends that
you use centralized provisioning, which requires you to set up a provisioning server and use
configuration files to provision the phones. For details on centralized provisioning, see
Centralized Provisioning. Note also that Polycom phones have a number of built-in phone
features that remain active when your phones are registered with Lync Server. Centralized
provisioning will not only speed the deployment of multiple phones with Lync Server, it provides
greater control over parameters when you want to customize these built-in phone features.
Polycom provides template configuration files you can use to provision your Polycom phones for
use with Lync Server – you do not need any other files. The template configuration files are
attached to this provisioning guide. To view the template configuration files attached to this
provisioning guide, click the Attachments icon at the top left of the PDF viewing pane, as shown
in Figure 7. Once you have opened the Attachments pane, you can drag and drop the files to a
location in your root directory.
Figure 7: Locating Attached Configuration Files
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
28
All of the template files you need are attached to this provisioning guide. The Polycom template
configuration files are flexible and you can use them in several ways. You can keep the
parameters in the template configuration files separate from your other files, combine them as a
single configuration file, or you can copy and paste the parameters to any other configuration
file you are currently using to provision your phone.
Polycom makes available two centralized provisioning methods.
Provisioning for sign-in credentials on the phone Use this method if you have no
prior experience with Polycom configuration files or when you want to provision multiple
phones quickly with default Lync settings and modify settings at a later time. This method
is the most secure and enables users to sign in with their credentials from the phone’s
interface.
Provisioning for sign-in credentials in the configuration file Using this method, you
enter each user’s sign in credentials to a configuration file so that users are automatically
signed in when you power up and boot the phone. This method is not secure as user
credentials are easily located in the configuration files of your provisioning server.
Provisioning for Sign-In Credentials on the Phone
The following procedure shows you how to provision the phones for sign in on the phone. Note
that this method is recommended by Polycom as the most secure.
To provision for sign-in credentials on the phone:
1 Locate the following two Lync configuration files attached to this provisioning guide, as
shown next.
○ lyncSharedExample.cfg This file contains all of the parameters for settings that are
shared by all the phones in your deployment.
Deploying Polycom® Devices with Microsoft® Lync™ Server 2010
29
○ lyncSharedLCExample.cfg This is a per-phone file. Use this file to display the Sign
In screen and enable users to enter sign in credentials on the phone. Because users
enter their credentials on the device, this is a secure way to provision with Lync Server.
2 Place these two configuration files in your root provisioning directory, create a copy of
each file, and rename them keeping the suffix .cfg. Using edited copies of the template
files ensures that you have unedited template files containing the default values. The
following example renames the template as follows:
○ lyncSharedExample.cfg > lyncCommon.cfg
○ lyncSharedLCExample.cfg > lyncSignIn.cfg
If you are manually installing a root CA security certificate, go to step 3. If not, go to step 4.
3 Open your renamed lyncSharedExample.cfg. If you are manually configuring a root CA
certificate, configure the following two parameters:
○ Enter the root CA certificate, in Base64 format, in sec.TLS.customCaCert.1.
○ Set the application profile in sec.TLS.profileSelection.SIP.
For more details on manually installing a certificate or to troubleshoot failed server
certificates, see Importing Certificates on Polycom SIP Phones.
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
30
4 Open the master configuration file 000000000000.cfg. In the CONFIG_FILES field, enter
the name(s) of your two Lync configuration files and save.
Note that configuration files you enter in the CONFIG_FILES field are read left to right. If
you have configured the same setting in two configuration files, the setting listed first (left)
is applied. Ensure that you do not have the same parameter in more than one
configuration file.
The following example shows lyncCommon.cfg and lyncSignIn.cfg. The names of
every file you want to apply to your devices must be listed in the CONFIG_FILES field of
the master configuration file, and separated by a comma, as shown next.
Settings: Configuring Files in Different Directories
You can store your two Lync configuration files and the master configuration file in different directories; however, you must specify the file location path of the two Lync files in the CONFIG_FILES field of the master configuration file, for example:
directory/lyncCommon.cfg
directory/lyncSigIn.cfg
Deploying Polycom® Devices with Microsoft® Lync™ Server 2010
31
5 Boot up your phones.
Your phones display the Lync Sign In screen, as shown next on the VVX 500, and users can
Sign In or Out of Lync from the phone.
Provisioning for Sign-In Credentials in the Configuration File
The provisioning method shown in this section is an alternative to mass provisioning for sign in
on the phone. Using this method, you enter each user’s sign in credentials to a unique per-
phone configuration file that you create from the lyncPerPhoneExample.cfg template file.
Using this method, devices automatically register with Lync and users are not required to sign in
on the phone. Entering sign in credentials to the configuration file is not secure as user
credentials are easily located in the configuration file. Polycom recommends using this set only
for test purposes from within your organization.
To provision sign in credentials in the configuration file:
1 Make a list of the MAC addresses of all devices you want to provision. The MAC address,
the equivalent of a serial number, is a 12-digit hexadecimal number you can find on a
sticker on the back of the phone. You will need these MAC addresses later in this
procedure.
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
32
2 Locate the following two Lync configuration files attached to this provisioning guide, as
shown next.
○ lyncSharedExample.cfg This file contains all of the parameters for settings that are
shared by all the phones in your deployment.
○ lyncPerPhoneExample.cfg Use this per-phone file if you want to enter user sign in
credentials to the configuration file for automatic sign in. This file is a template you use
to create unique per-phone configuration files containing each user’s Lync sign in
credentials. Entering sign in credentials to the configuration file is not secure and
Polycom recommends using this only for test purposes from within your organization.
3 Place these two configuration files in your root provisioning directory, create a copy of
each file, and rename them keeping the suffix .cfg. Using edited copies of the template
files ensures that you have unedited template files containing the default values. The
following example renames the two template files as follows:
○ lyncSharedExample.cfg > lyncCommon.cfg
○ lyncPerPhoneExample.cfg > [macaddress]-phone.cfg
If you are manually installing a root CA security certificate, go to step 4. If not, go to step 5.
4 Open your renamed lyncSharedExample.cfg. If you are manually configuring a root CA
certificate, configure the following two parameters:
○ Enter the root CA certificate, in Base64 format, in sec.TLS.customCaCert.1.
○ Set the application profile in sec.TLS.profileSelection.SIP.
Deploying Polycom® Devices with Microsoft® Lync™ Server 2010
33
For more details on manually installing a certificate or to troubleshoot failed server
certificates, see Importing Certificates on Polycom SIP Phones.
5 In your root directory, create a sub-directory and give it a name that identifies it as
containing per-phone user files, for example, usercfg. The purpose of this sub-directory is
to organize and maintain your per-phone user files.
6 Place your renamed lyncPerPhoneExample.cfg in your new sub-directory. This is the file
you use as a template to create unique per-phone configuration files that contain each
user’s Lync sign in credentials. In this example, place lyncPerPhone.cfg in the folder
named usercfg.
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
34
7 In the usercfg folder, create one copy of the lyncPerPhone.cfg file for each user,
renaming each file to include the phone’s MAC address. You can use any name for the
per-phone files but you must use the same naming scheme for each file and you must
include the phone’s MAC address in each file name. The following example illustrates a
per-phone naming scheme for three users.
Deploying Polycom® Devices with Microsoft® Lync™ Server 2010
35
8 Once you have created and named a per-phone file for each user’s device, open each
user file and enter each user’s Lync sign in credentials in the following four parameters:
○ reg.1.address = <[email protected]>
○ reg.1.auth.domain = <example.com>
○ reg.1.auth.password = <password>
○ reg.1.auth.userId = <user name>
Save the configuration file with the new values.
9 Open the master configuration file 000000000000.cfg. In the CONFIG_FILES field, enter
the following values:
a Enter the name you gave to the copy of lyncSharedExample.cfg, in this example,
lyncCommon.cfg.
b Enter the naming scheme you gave to the per-phone files in step 7 using the following
two steps:
» Prefix the file with the name of the directory containing the per-phone files followed
by a forward slash. This is the directory you created in step 5 usercfg. In this
example, the full prefix is usercfg/.
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
36
» Substitute the MAC address of each phone with [MACADDRESS], including the square
brackets. In this example, the naming scheme for the per-phone files is
[MACADDRESS]-user.cfg, as shown next.
In this illustration,
» usercfg identifies the directory containing the per-phone files.
» [MACADDRESS] is a variable. When the phone reads the
[MACADDRESS]-lync.cfg file, the phone replaces the [MACADDRESS] variable with
its own MAC address and uses the values defined in its per-phone file you created in
the usercfg folder step 7. For more detailed information on using variables, see
Polycom best practices on Provisioning with the Master Configuration File.
When applying settings or features to your phones, you must list the name of every file
you want to apply to your devices in the CONFIG_FILES field of the master
configuration file. All parameters and values in the configuration files you enter to the
CONFIG_FILES field of the master configuration file are applied to each device. Note
that configuration files you enter in the CONFIG_FILES field are read left to right. If you
have configured the same setting in two configuration files, the setting listed first (left) is
applied. Ensure that you do not have the same parameter in more than one
configuration file.
10 Boot up the phones.
Deploying Polycom® Devices with Microsoft® Lync™ Server 2010
37
The phones display a line registered with Lync Server and you can begin using Lync
features directly from the phone. The following illustration shows a line 1, extension 2334
on the VVX 500 successfully registered to Lync Server.
Note: Use Configuration Files or Set the Base Profile to Lync - Not Both
Note that when you use configuration files to provision the phones with Lync Server 2010, the phone Base Profile stays set to Generic. You do not need to set the Base Profile feature on the phones to Lync when provisioning with configuration files.
Settings: How Line Key Labels Are Applied
Lync Server assigns the line label to the line key on your phone in the following order: 1 Extension 2 Full TelURI 3 User part of the SIP URI
Settings: Disabling Autodiscover
If you do not want to use the Microsoft Autodiscover service, use the following parameters to disable the feature and manually set the Lync server address and SIP signaling port.
Disable autodiscover: reg.1.serverAutoDiscovery=0
Server: reg.1.server.1.address=<server_address>
Port: reg.1.server.1.port=<port_number>
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
38
Setting the Base Profile with <device.set> Parameters
This section shows you how to provision devices for use with Lync Server using device.set
parameters located in the lync_device.cfg template configuration file attached to this
provisioning guide. Polycom recommends using this method only if you are familiar with
centralized provisioning and Polycom configuration files.
To set the Base Profile using device.set parameters:
1 Locate the lync_device.cfg template configuration file attached to this provisioning
guide.
2 Place the lync_device.cfg file on your provisioning server.
3 Locate and change the values of the following three parameters to the values shown in the
following illustration:
4 Rename and save the file.
5 Boot up the phones.
6 Once boot up is complete, remove device.set from the template configuration file and
save the file without device.set.
Deploying Polycom® Devices with Microsoft® Lync™ Server 2010
39
7 Verify that the device Base Profile is set to Lync. Press Home/Menu and go to Settings >
Advanced > enter the password (default 456) and press Enter > Administration
Settings > Network Configuration, and scroll to Base Profile. The Base Profile field
reads Lync, shown next on the VVX 500.
You can now Sign In or Out of Lync.
41
Sign In or Out of Lync
Once you have set the phone Base Profile to Lync, you can sign in or out of the phone.
To sign in/out of Lync Server from the phone:
1 Enter your sign in credentials in the following formats:
○ Sign In Address This is your Lync SIP URI address, not the user name for the Active
Directory account. For example, [email protected].
○ Domain By default, use the NetBIOS domain name.
○ User user name
○ Password password
2 Select Sign In.
The phone registers with Lync Server and you can begin using Lync features directly from
the phone. The following illustration shows a line 1, extension 2334 on the VVX 500
successfully registered to Lync Server.
3 Once you have a line registered with Lync Server, you can sign in or out of Lync from the
following location on the phone:
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
42
○ Press Home/Menu and go to Settings > Features > Microsoft Lync > Sign In/Sign
Out.
Settings: How Lync Server Sets the Line Label
Lync Server assigns the line label to the line key on your phone in the following order: 1 Extension 2 Full TelURI 3 User part of the SIP URI
43
Enabling the Exchange Calendar
This section explains two ways you can enable the exchange calendar. If you are using
centralized provisioning, you can include parameters to your configuration files. The parameters
are attached to this provisioning guide in the file exchange.cfg. Or, you can enable the
exchange calendar on a per-phone basis using the Web Configuration Utility.
Settings: Accessing Exchange Integration
Note that if you are entering your sign in credentials to the configuration file for your Lync registration and you want Exchange integration to work, phone users also need to enter credentials to the phone Sign In screen.
To enable the exchange calendar on a per-phone basis:
1 Enter the IP address of your phone to the address bar of a web browser. You can find the
phone’s IP address by going to Menu/Home > Settings > Basic > Platform > Phone.
The IP address displays in the field labeled IP:.
The Web Configuration Utility login screen displays, shown next.
2 Choose Administrator, enter the password (default 456), and click Submit.
3 The Home page displays.
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
44
4 Navigate to Settings > Applications > Exchange Applications, and expand Exchange
Applications, shown next.
5 Enable the exchange calendar.
6 Enter the exchange web services URL. For example,
https://<exchange.domain.com>/EWS/Exchange.asmx.
7 At the bottom of the browser page, click Save.
8 When the confirmation dialog displays, choose Yes.
Your exchange calendar is successfully configured and the Calendar icon displays on your
phone screen, as shown next on the VVX 500.
45
References
Use this section as a reference for information on registering your Polycom® devices with
Microsoft® Lync® Server 2010. This section provides information on the following items:
Updating Polycom UC Software
Resetting the Phone to Factory Default Settings
Understanding Provisioning Methods
Manually Installing a Certificate
Understanding Lync Configuration Files
Understanding In-Band Provisioning
Updating Polycom UC Software
This section shows you how to update the phones to Polycom UC Software. Before you update
to UC software, you need to Resetting the Phone to Factory Default Settings.
Use the following table to determine which Polycom UC software you need for your Polycom
devices. All UC software versions listed are Lync-enabled.
Web Info: Getting Polycom UC Software
All UC software versions are available directly from the Polycom Voice Support web site.
For the latest UC software versions, see Latest Polycom UC Software Release.
For all UC software versions, see Polycom UC Software Support Center.
Table 5: Polycom UC Software – Hardware Dependencies
Polycom UC Software Version Polycom Devices
UC software 4.1.4 VVX 300 | 310 | 400 | 410
UC software 4.1.3 VVX 500 | 600 | VVX camera
UC software 4.1.2 VVX 500 | 600 business media phones
BootROM 4.0
UC software 4.1.0B
SoundPoint IP 321/331 | 335 | 450 | 550 | 560 | 650
SoundStation IP 5000 | Duo
VVX 500 Business Media Phone
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
46
To update the phone to UC Software:
1 Download and unzip UC software to a directory on your provisioning server.
2 On the phone, go to Home > Settings> Advanced, enter the password (default 456),
Network Configuration > Provisioning Server > DHCP Menu > Boot Server. In the
Boot Server menu, you can choose Static if you are testing or provisioning a few phones,
or Option 66 if you are provisioning in a large environment and want phones to use a boot
server defined in DHCP. If you choose Option 66, skip step 3 and go to step 4.
3 Go back to Provisioning Server and do the following:
○ Choose a server type in the Server Type field.
○ Enter the Server Address, for example <http://server.domain.com/41X> or
<ftp://ftp.domain.com/41X>.
○ Enter your server user name and server password, if required.
4 Press Back until you are prompted to save your settings. Choose Save cfg to save your
settings and the phone reboots.
5 Confirm that the phone is running a Lync-enabled Polycom UC software version.
○ On the VVX 1500 Business Media phone, choose Home > Status > Platform >
Application > Main. The UC Software version displays beside Version.
○ On the VVX 500 Business Media phone, choose Menu > Settings > Status > Platform
> Application > Main. The UC Software version displays beside Version.
Note: Updating Your Phone Software
You can use the Web Configuration Utility to update your Polycom UC Software. For details on how to update the phone software using the Web Configuration Utility, see Using the Software Upgrade Option in the Web Configuration Utility.
Resetting the Phone to Factory Default Settings
If the device has already been in use, reset your devices to factory default settings. Before
resetting your devices, verify that there are no parameters such as a provisioning server
address or credentials that you need to keep.
Polycom devices store settings in up to three locations that correspond to three ways you can
apply setting to Polycom devices:
In configuration files stored on the provisioning server
References
47
In a per-device file uploaded to the provisioning server when settings are made using the
Web Configuration Utility
Locally on the phone’s memory system
Settings: Restore Settings All Three Sources
Ensure that you restore default settings from all three configuration sources. Settings that you do not reset to factory defaults may override any new settings you apply.
Restore default settings from each source, as shown next. You can conveniently perform all
three resets directly from the phone.
Reset local phone settings. On your phone to Settings > Advanced, enter the password
(default 456), and go to Administration Settings > Reset to Defaults > Reset Local
Configuration. At the prompt Are you sure?, tap Yes.
Reset Web settings. On your phone to Settings > Advanced, enter the password (default
456), and go to Administration Settings > Reset to Defaults > Reset Web
Configuration. At the prompt Are you sure?, tap Yes.
Note that the phone may reboot depending on the parameters you have set using the Web
Configuration Utility.
Reset the phone to factory default settings. On your phone, go to Settings > Advanced,
and enter the password (default 456), press Enter, and go to Administration Settings >
Reset to Defaults, and select Reset to Factory. At the prompt Are you sure?, tap Yes.
The phone reboots to factory default settings.
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
48
Understanding Provisioning Methods
Once your Polycom phones are provisioned with a Lync-enabled release of Polycom UC
Software and you have reset the phones to factory default settings, you can manually set the
Base Profile to Lync directly from the phone in one of five ways. Or, you can use centralized
provisioning, which requires you to set up a provisioning or boot server and use Polycom
configuration files in XML format. All of the configuration files you need are attached to this
provisioning guide.
Manual Provisioning
If you do not wish to use a provisioning server, you can quickly register your phone by setting
the phone’s Base Profile to Lync during the phone’s initial boot cycle or from the phone’s menu
system after the boot cycle is complete. Note that this method enables you to provision one
phone at a time. In addition, you will not be able to enable extensive diagnostic logging that the
phone writes to the provisioning server, contact directory files, or phone user interface language
files, all of which are available only with centralized provisioning. Note that there are four ways
you can provision the phone with Lync Server 2010 from the phone user interface.
Web Configuration Utility
You can use the Web Configuration Utility to register a phone with Lync Server by setting the
phone’s Base Profile to Lync in the Simple Setup > Base Profile menu. This method does not
require a provisioning server and registers a single phone at a time. The Web Configuration
Utility stores a limited number of log files in the Diagnostics menu that can be useful for
troubleshooting.
Centralized Provisioning
You can register Polycom phones to the Lync Server using a provisioning server supporting the
FTP, TFTP, HTTP, or HTTPS protocols. Polycom recommends using a provisioning server
when deploying multiple phones. Use of a provisioning server enables you to store configuration
files in a single location on a server, which simplifies maintenance of feature settings and
updates for multiple phones. In addition, use of a provisioning server enables you to choose one
of several languages on the phone interface, and allows the phone to send diagnostic and other
information to files stored on the server, including log files, a contact directory, and individual
call lists. Note that you must use a provisioning server to update your Polycom UC Software.
Deploying phones with a provisioning server requires use of Polycom configuration template
files in XML format.
References
49
Using Lync Configuration Files
Once you have set up a provisioning server, you can use Polycom template configuration files
to quickly provide default settings to all your devices. Polycom has created several Lync-specific
template configuration files, which are attached to this provisioning guide. If you require further
instruction on using Polycom configuration files effectively, see the section on centralized
provisioning in Chapter 5: Configuration Methods of the Polycom UC Software 4.1.0
Administrators’ Guide.
Setting the Base Profile with <device.set> Parameters
Polycom provides a template configuration file containing three <device.set> parameters you
can use to automatically set the Base Profile of multiple Polycom devices to Lync. Polycom
recommends using this method only if you are an experienced administrator and are familiar
with Polycom UC Software centralized provisioning method and configuration files. The
lync_device.cfg template configuration file attached to this provisioning guide contains the
three device.set parameters and their default values. To begin provisioning using this method,
go to Setting the Base Profile with <device.set> Parameters. The following table describes the
device.set parameters, and indicates the default values and required values you need to set.
Table 6: Lync <device.set> Parameters
Parameter=Default Value Parameter-Required Value
device.set1=0 device.set=1
A global parameter that you enable to make changes to <device> parameters. Use this parameter only to change <device> parameter values. Once you have made your changes, remove this parameter from the configuration file.
device.set.baseProfile.set1=0 device.set.baseProfile.set=1
This parameter enables you to make changes to the Base Profile of your devices. Set this parameter to 1 to enable changes to the Base Profile.
device.set.baseProfile1=Null device.set.baseProfile=Lync
This parameter sets the value for the device Base Profile. Set this parameter to Lync.
1 Change causes phone to restart or reboot.
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
50
Manually Installing a Certificate
If you need to set up a remote worker, you can manually enter a certificate to the phone. You
can add the certificate using the following two parameters included in the certificate.cfg file
attached to this provisioning guide, or you create your own XML configuration file and upload it
to a phone using the Web Configuration Utility. You can only install certificates manually on a
per-phone basis. You must use Base64 format.
Install a certificate using the Web configuration Utility:
1 Locate the certificate.cfg configuration file attached to this provisioning guide.
2 Drag and drop the certificate.cfg file to a location in your Lync directory.
3 Enter the certificate and application profile to the following two parameters:
sec.TLS.customCaCert.1=<enter the certificate>
sec.TLS.profileSelection.SIP=<ApplicationProfile1>
You can:
References
51
○ Add the two parameters in an XML file you create with an XML editor
○ Add the two parameters to an existing configuration file you are using
○ Use the certificate.cfg file attached to this provisioning guide
4 Enter the root CA certificate, in Base64 format, in sec.TLS.customCaCert.1 and set the
application profile in sec.TLS.profileSelection.SIP.
You have successfully installed a security certificate.
For more details on manually installing a certificate or to troubleshoot failed server
certificates, see Importing Certificates on Polycom SIP Phones.
You can also use the Web Configuration Utility to manually install a certificate.
To install a certificate using the Web Configuration Utility:
1 Enter the IP address of your phone to the address bar of a web browser. You can find the
phone’s IP address by going to Menu > Settings > Basic > Platform > Phone > IP.
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
52
The Web Configuration Utility login screen displays, shown next:
2 Choose Administrator, enter the password (default 456), and click Submit.
The Home page displays.
3 Navigate to Utilities > Import & Export Configuration, shown next.
4 In Import Configuration, click Choose File.
A dialog selection box opens.
5 Choose the XML configuration file you created and click Import.
The XML configuration file is successfully loaded to the phone. To verify that the file is
loaded, go to Menu > Settings > Status > Platform > Configuration.
References
53
Understanding Lync Configuration Files
The following tables detail the configuration files, parameters, and values you can use to
provision your Polycom phones with Lync Server 2010. Polycom provides the following four
template configuration files:
Table 7: Default Lync Base Profile Parameter Values
Table 8: lyncSharedLCExample.cfg
Table 9: lyncSharedExample.cfg
Table 10: lyncPerPhoneExample.cfg
The following table describes the parameters and values in the Lync Base Profile feature.
Table 7: Default Lync Base Profile Parameter Values
Parameter Permitted Values
Default
call.enableOnNotRegistered 0 or 1 0
If 1, users can make calls when the phone is not registered. If 0, calls are not permitted without registration. Note: Setting this parameter to 1 enables you to use VVX 1500 phones to make calls using the H.323 protocol even though an H.323 gatekeeper is not configured.
callLists.logConsultationCalls 0 or 1 1
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.
dialplan.applyToDirectoryDial 0 or 1 1
If 0, the dial plan is not applied to numbers dialed from the directory or speed dial list. If 1, the dial plan is applied to numbers dialed from the directory or speed dial, including auto-call contact numbers.
dialplan.1.applyToForward 0 or 1 1
If 0, the dial plan does not apply to forwarded calls. If 1, the dial plan applies to forwarded calls.
feature.messaging.enabled 0 or 1 1
Enable instant messaging on the SpectraLink 8400 Series wireless handsets. When used with Lync, this parameter will be ignored by other phones.
feature.presence.enabled 0 or 1 1
Enable the presence feature to manage your buddy list and display the status of your contacts.
reg.1.applyServerDigitMapLocally 0 or 1 1
When set to 1, dialplan normalization rules are downloaded from the Lync Server and processed on the phone. If 0, dialplan rules are processed by Lync Server.
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
54
Parameter Permitted Values
Default
reg.1.auth.useLoginCredentials 0 or 1 1
Enables the Sign In screen on the phone.
reg.1.auth.usePinCredentials 1
reg.1.serverFeatureControl.signalingMethod string serviceMsForwardContact
Controls the method used to perform call forwarding requests to the server.
reg.1.server.1.registerRetry.baseTimeOut 10 to 120 10
The base time period to wait before a registration retry. Used in conjunction with
reg.x.server.y.registerRetry.maxTimeOut to determine how long to wait. The algorithm is
defined in RFC 5626.
reg.1.server.1.registerRetry.maxTimeout 60 to 1800 180 seconds
Sets the maximum period of time in seconds that the phone tries to register.
reg.1.server.1.specialInterop lync2010
Identifies the SIP signaling as Microsoft Lync Server 2010 and enables Lync Server features.
reg.1.server.1.transport TLS TLS
The transport method the phone uses to communicate with the SIP server.
roaming_buddies.reg 0 or 1 1
Set the line index number for the registered line you want to enable Presence and Instant Messaging.
sec.srtp.holdWithNewKey 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.key.lifetime 0, positive integer minimum 1024 or power of 2 notation
2^31
The lifetime of the master key used for the cryptographic parameter in SDP. The value specified is the number of SRTP packets. If 0, the master key lifetime is not set. If set to a valid value (at least 1024, or a power such as 2^10), the master key lifetime is set. When the lifetime is set, a re-invite with a new key will be sent when the number or SRTP packets sent for an outgoing call exceeds half the value of the master key lifetime. Note: Setting this parameter to a non-zero value may affect the performance of the phone.
References
55
Parameter Permitted Values
Default
sec.srtp.mki.enabled 0 or 1 1
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 1 to 4 1
The length of the master key identifier (MKI), in bytes. Microsoft Lync offers 1-byte MKIs.
sec.srtp.mki.startSessionAtOne 0 or 1 1
If set to 1, use an MKI value of 1 at the start of an SDP session. If set to 0, the MKI value will increment for each new crypto key.
sec.srtp.resumeWithNewKey 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.
sec.TLS.profileSelection.SIP ApplicationProfile1
Set the TLS application profile used to store the CA certificate.
softkey.feature.simplifiedSignIn 1
tcpIpApp.ice.mode MSOCS
Specifies that ICE and TURN work with Microsoft Lync Server.
tcpIpApp.keepalive.tcp.sip.tls.enable 1
Set to 1 to enable keepalive packets and keep the TLS profile from timing out.
video.iFrame.delay 2
When non-zero, an extra I-frame is transmitted after video starts. The amount of delay from the start of video until the I-frame is sent is configurable up to 10 seconds. Use a value of 2 seconds if you are using this parameter in a Microsoft Lync environment.
video.iFrame.onPacketLoss 0 to 10, seconds
1
If 1, an I-frame is transmitted to the far end when a received RTCP report indicates that video RTP packet loss has occurred.
voice.audioProfile.G7221.24kbps.payloadType 112
The payload type for the G.722.1 24kbps codec.
voice.codecPref.G7221.24kbps 0 to 27 5
The priority of the G.722.1 24kbps codec. If 0 or Null, the codec is disabled. A value of 1 is the highest priority.
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
56
Parameter Permitted Values
Default
voice.codecPref.G7221.32kbps 0 to 27 0
The priority of the G.722.1 32kbps codec. If 0 or Null, the codec is disabled. A value of 1 is the highest priority.
voIpProt.SIP.IM.autoAnswerDelay 0 to 40 40
The time interval from receipt of the instant message invitation to automatically accepting the invitation.
voIpProt.SIP.allowTransferOnProceeding 0 to 2 seconds 0
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.serverFeatureControl.cf 0 or 1 1
If set to 1, server-based call forwarding is enabled. The call server has control of call forwarding.
If set to 0, server-based call forwarding is not enabled.
voIpProt.SIP.serverFeatureControl.dnd 0 or 1 1
If set to 1, server-based DND is enabled. The call server has control of DND.
If set to 0, server-based DND is not enabled.
voIpProt.SIP.serverFeatureControl.localProcessing.cf
0 or 1 0
If set to 0 and voIpProt.SIP.serverFeatureControl.cf is set to 1, the phone will not perform local
Call Forward behavior.
If set to 1, the phone will perform local Call Forward behavior on all calls received.
voIpProt.SIP.serverFeatureControl.localProcessing.dnd
0 or 1 0
If set to 0 and voIpProt.SIP.serverFeatureControl.dnd is set to 1, the phone will not perform local
DND call behavior.
If set to 1, the phone will perform local DND call behavior on all calls received.
voIpProt.SIP.serverFeatureControl.signalingMethod
serviceMsForwardContact
voIpProt.SIP.server.1.transport TLS
voIpProt.SIP.header.diversion.enable 0 or 1 1
If set to 1, the diversion header is displayed if received. If set to 0, the diversion header is not displayed.
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 2010.
References
57
The following table describes parameters and values in the lyncSharedLCExample.cfg
template.
Table 8: lyncSharedLCExample.cfg
Parameter Permitted Values
Default
call.enableOnNotRegistered 0 or 1 0
If 1, users can make calls when the phone is not registered. If 0, calls are not permitted without registration. Note: Setting this parameter to 1 enables you to use VVX 1500 phones to make calls using the H.323 protocol even though an H.323 gatekeeper is not configured.
callLists.logConsultationCalls 0 or 1 1
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 0 or 1 1
Enable instant messaging on the SpectraLink 8400 Series wireless handsets. When used with Lync, this parameter will be ignored by other phones.
feature.presence.enabled 0 or 1 1
Enable the presence feature to manage your buddy list and display the status of your contacts.
reg.1.applyServerDigitMapLocally 0 or 1 1
When set to 1, dialplan normalization rules are downloaded from the Lync Server and processed on the phone. If 0, dialplan rules are processed by Lync Server.
reg.1.auth.useLoginCredentials 0 or 1 1
Enables the Sign In screen on the phone.
reg.1.auth.usePinCredentials 1
reg.1.serverFeatureControl.cf 0 or 1 1
If ‘0’, server-based call forwarding is not enabled for this line. If ‘1’, server based call forwarding is enabled for this line.
reg.1.serverFeatureControl.localProcessing.cf 0 or 1 0
If set to ‘0’ and reg.1.serverFeatureControl.cf is set to 1, the phone will not perform local Call
Forward behavior. If set to 1, the phone will perform local Call Forward behavior on all calls received.
reg.1.serverFeatureControl.dnd 1
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
58
Parameter Permitted Values
Default
reg.1.serverFeatureControl.localProcessing.dnd 0
reg.1.serverFeatureControl.signalingMethod serviceMsForwardContact
reg.1.server.1.registerRetry.baseTimeOut 10 to 120 10
The base time period to wait before a registration retry. Used in conjunction with
reg.x.server.y.registerRetry.maxTimeOut to determine how long to wait. The algorithm is
defined in RFC 5626.
reg.1.server.1.registerRetry.maxTimeout 60 to 1800 180 seconds
Sets the maximum period of time in seconds that the phone tries to register.
reg.1.server.1.specialInterop lync2010
Identifies the SIP signaling as Microsoft Lync Server 2010 and enables Lync Server features.
reg.1.server.1.transport TLS TLS
The transport method the phone uses to communicate with the SIP server.
roaming_buddies.reg 0 or 1 1
Set the line index number for the registered line you want to enable Presence and Instant Messaging.
sec.srtp.holdWithNewKey 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.key.lifetime 0, positive integer minimum 1024 or power of 2 notation
2^31
The lifetime of the master key used for the cryptographic parameter in SDP. The value specified is the number of SRTP packets. If 0, the master key lifetime is not set. If set to a valid value (at least 1024, or a power such as 2^10), the master key lifetime is set. When the lifetime is set, a re-invite with a new key will be sent when the number or SRTP packets sent for an outgoing call exceeds half the value of the master key lifetime. Note: Setting this parameter to a non-zero value may affect the performance of the phone.
sec.srtp.mki.enabled 0 or 1 1
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.
References
59
Parameter Permitted Values
Default
sec.srtp.mki.length 1 to 4 1
The length of the master key identifier (MKI), in bytes. Microsoft Lync offers 1-byte MKIs.
sec.srtp.mki.startSessionAtOne 0 or 1 1
If set to 1, use an MKI value of 1 at the start of an SDP session. If set to 0, the MKI value will increment for each new crypto key.
sec.srtp.resumeWithNewKey 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.
sec.TLS.profileSelection.SIP ApplicationProfile1
sec.TLS.customCaCert.1
softkey.feature.simplifiedSignIn 1
tcpIpApp.ice.mode MSOCS
Specifies that ICE and TURN work with Microsoft Lync Server.
tcpIpApp.keepalive.tcp.sip.tls.enable 1
Set to 1 to enable keepalive packets and keep the TLS profile from timing out.
video.iFrame.delay 2
When non-zero, an extra I-frame is transmitted after video starts. The amount of delay from the start of video until the I-frame is sent is configurable up to 10 seconds. Use a value of 2 seconds if you are using this parameter in a Microsoft Lync environment.
video.iFrame.onPacketLoss 0 to 10, seconds
1
If 1, an I-frame is transmitted to the far end when a received RTCP report indicates that video RTP packet loss has occurred.
voice.audioProfile.G7221.24kbps.payloadType 112
The payload type for the G.722.1 24kbps codec.
voice.codecPref.G7221.24kbps 0 to 27 5
The priority of the G.722.1 24kbps codec. If 0 or Null, the codec is disabled. A value of 1 is the highest priority.
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
60
Parameter Permitted Values
Default
voice.codecPref.G7221.32kbps 0 to 27 0
The priority of the G.722.1 32kbps codec. If 0 or Null, the codec is disabled. A value of 1 is the highest priority.
voIpProt.SIP.IM.autoAnswerDelay 0 to 40 40
The time interval from receipt of the instant message invitation to automatically accepting the invitation.
voIpProt.SIP.allowTransferOnProceeding 0 to 2 seconds 0
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.header.diversion.enable 0 or 1 1
If set to 1, the diversion header is displayed if received. If set to 0, the diversion header is not displayed.
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 2010.
The following table describes parameters and values in the lyncSharedExample.cfg template.
Table 9: lyncSharedExample.cfg
Parameter Permitted Values
Default
call.enableOnNotRegistered 0 or 1 0
If 1, users can make calls when the phone is not registered. If 0, calls are not permitted without registration. Note: Setting this parameter to 1 enables you to use VVX 1500 phones to make calls using the H.323 protocol even though an H.323 gatekeeper is not configured.
callLists.logConsultationCalls 0 or 1 1
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 0 or 1 1
Enable instant messaging on the SpectraLink 8400 Series wireless handsets. When used with Lync, this parameter will be ignored by other phones.
feature.presence.enabled 0 or 1 1
Enable the presence feature to manage your buddy list and display the status of your contacts.
References
61
Parameter Permitted Values
Default
sec.srtp.holdWithNewKey 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.key.lifetime 0, positive integer minimum 1024 or power of 2 notation
2^31
The lifetime of the master key used for the cryptographic parameter in SDP. The value specified is the number of SRTP packets. If 0, the master key lifetime is not set. If set to a valid value (at least 1024, or a power such as 2^10), the master key lifetime is set. When the lifetime is set, a re-invite with a new key will be sent when the number or SRTP packets sent for an outgoing call exceeds half the value of the master key lifetime. Note: Setting this parameter to a non-zero value may affect the performance of the phone.
sec.srtp.mki.enabled 0 or 1 1
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 1 to 4 1
The length of the master key identifier (MKI), in bytes. Microsoft Lync offers 1-byte MKIs.
sec.srtp.mki.startSessionAtOne 0 or 1 1
If set to 1, use an MKI value of 1 at the start of an SDP session. If set to 0, the MKI value will increment for each new crypto key.
sec.srtp.resumeWithNewKey 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.
sec.TLS.customCaCert.1
Enter
sec.TLS.profileSelection.SIP ApplicationProfile1
Set the TLS application profile used to store the CA certificate.
tcpIpApp.ice.mode MSOCS
Specifies that ICE and TURN work with Microsoft Lync Server.
tcpIpApp.keepalive.tcp.sip.tls.enable 1
Set to 1 to enable keepalive packets and keep the TLS profile from timing out.
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
62
Parameter Permitted Values
Default
video.iFrame.delay 2
When non-zero, an extra I-frame is transmitted after video starts. The amount of delay from the start of video until the I-frame is sent is configurable up to 10 seconds. Use a value of 2 seconds if you are using this parameter in a Microsoft Lync environment.
video.iFrame.onPacketLoss 0 to 10, seconds
1
If 1, an I-frame is transmitted to the far end when a received RTCP report indicates that video RTP packet loss has occurred.
voice.audioProfile.G7221.24kbps.payloadType 112
The payload type for the G.722.1 24kbps codec.
voice.codecPref.G7221.24kbps 0 to 27 5
The priority of the G.722.1 24kbps codec. If 0 or Null, the codec is disabled. A value of 1 is the highest priority.
voice.codecPref.G7221.32kbps 0 to 27 0
The priority of the G.722.1 32kbps codec. If 0 or Null, the codec is disabled. A value of 1 is the highest priority.
voIpProt.SIP.IM.autoAnswerDelay 0 to 40 40
The time interval from receipt of the instant message invitation to automatically accepting the invitation.
voIpProt.SIP.allowTransferOnProceeding 0 to 2 seconds 0
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.header.diversion.enable 0 or 1 1
If set to 1, the diversion header is displayed if received. If set to 0, the diversion header is not displayed.
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 2010.
References
63
The following table describes parameters and values in the lyncPerPhoneExample.cfg
template.
Table 10: lyncPerPhoneExample.cfg
Parameter Permitted Values
Default
dialplan.1.applyToForward 0 or 1 1
If 0, the dial plan does not apply to forwarded calls. If 1, the dial plan applies to forwarded calls.
reg.1.address <[email protected]>
reg.1.auth.domain <example.com>
reg.1.auth.password <password>
reg.1.auth.userId <user1>
reg.1.auth.loginCredentialType <usernameAndPassword>
Enter the type of login credential you are using.
When the Base Profile is set to Generic, the default is 1.
When you set the Base Profile to Lync, the default is 2.
Allowable values are:
1 or loginCredentialNone
2 or usernameAndPassword
3 or extensionAndPIN
reg.1.applyServerDigitMapLocally 0 or 1 1
When set to 1, dialplan normalization rules are downloaded from the Lync Server and processed on the phone. If 0, dialplan rules are processed by Lync Server.
reg.1.auth.usePinCredentials 0
reg.1.serverFeatureControl.cf 0 or 1 1
If ‘0’, server-based call forwarding is not enabled for this line. If ‘1’, server based call forwarding is enabled for this line.
reg.1.serverFeatureControl.localProcessing.cf 0
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
64
Parameter Permitted Values
Default
reg.1.serverFeatureControl.dnd 1
reg.1.serverFeatureControl.localProcessing.dnd 0 or 1 0
If set to ‘0’ and reg.1.serverFeatureControl.cf is set to 1, the phone will not perform local Call
Forward behavior. If set to 1, the phone will perform local Call Forward behavior on all calls received.
reg.1.serverFeatureControl.signalingMethod string serviceMsForwardContact
Controls the method used to perform call forwarding requests to the server.
reg.1.server.1.registerRetry.baseTimeOut 10 to 120 10
The base time period to wait before a registration retry. Used in conjunction with
reg.x.server.y.registerRetry.maxTimeOut to determine how long to wait. The algorithm is
defined in RFC 5626.
reg.1.server.1.registerRetry.maxTimeout 60 to 1800 180 seconds
Sets the maximum period of time in seconds that the phone tries to register.
reg.1.server.1.specialInterop lync2010
Identifies the SIP signaling as Microsoft Lync Server 2010 and enables Lync Server features.
reg.1.server.1.transport TLS TLS
The transport method the phone uses to communicate with the SIP server.
roaming_buddies.reg 0 or 1 1
Set the line index number for the registered line you want to enable Presence and Instant Messaging.
softkey.feature.simplifiedSignIn 1
References
65
Understanding In-Band Provisioning
This section shows you how to view in-band provisioning parameters and provides a description
of the parameters. When you are signed in to Lync on your phone, the Lync Server
automatically retrieves provisioning parameters you need to operate Lync features. For details
of the in-band provisioning parameters, go to Table 11: In-Band Provisioning Parameters. You
can view the in-band provisioning parameters from your phone or using the Web Configuration
Utility.
To view in-band provisioning parameters:
1 On your phone, go to Menu > Settings > Advanced, enter the password (default 456),
and press Enter.
2 Go to Administration Settings > Upload Configuration.
3 Scroll down and select SIP.
4 Press the Upload soft key.
The phone uploads MAC-upload-CallServer.cfg to your boot server. Open this file to
view the in-band provisioning parameters.
You can also use the Polycom Web Configuration Utility to view in-band provisioning
parameters.
To view in-band provisioning parameters using the Web Configuration Utility:
1 Obtain the IP address of the phone by pressing the Menu/Home key and going to
Settings > Status > Platform > Phone. The IP address displays in the field labeled IP:.
2 Enter the phone’s IP address in the address bar of a web browser and press Enter on
your keyboard.
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
66
The Web Configuration Utility login screen displays, shown next.
3 Choose Administrator, enter the password (default 456), and click Submit.
The Home page displays.
4 From the Home page, navigate to Utilities > Import & Export Configuration, shown
next.
References
67
5 Open the Export Configuration. Click on the Export Configuration File drop down menu
and choose SIP, shown next.
6 Save the XML file to your computer.
Table 11: In-Band Provisioning Parameters
Parameter Permitted Values
Default
dialplan.1.e911dialmask 112;100
dialplan.1.e911dialstring 911
dialplan.1.originaldigitmap This value depends on how the Lync Server is configured.
dialplan.routing.emergency.1.value 911
msg.mwi.1.callBack This value depends on how the Lync Server is configured.
The contact to call when retrieving messages for this registration if msg.mwi.x.callBackMode is set to
contact.
msg.mwi.1.callBackMode contact contact
The message retrieval mode and notification for registration ‘x’. The value ‘contact’ indicates that a call is placed to the contact specified by msg.mwi.x.callback.
Deploying Polycom® UC Software for use with Microsoft
® Lync™ Server 2010
68
Parameter Permitted Values
Default
reg.1.ice.turn.callAdmissionControl.enabled
1
reg.1.lisdisclaimer This value depends on how the Lync Server is configured.
reg.x.srtp.enable 1
When set to ‘1’, SRTP for incoming SIP calls is enabled for a given line ‘x’. When set to ‘0’, SRTP offered SIP calls are declined.
reg.1.srtp.offer 1
If 1, the registration includes a secure media stream description along with the usual non-secure media description in the SDP of a SIP INVITE. This parameter applies to the registration initiating (offering) a phone call. If 0, no secure media stream is included in SDP of a SIP invite.
reg.1.srtp.require 0 or 1 1
If ‘0’, secure media streams are not required. If ‘1’, the registration 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 non-secure 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.
tcpIpApp.ice.turn.callAdmissionControl.enabled
1
tcpIpApp.ice.username This value depends on how the Lync Server is configured. This unique value is created for each registration and changes every eight minutes.
tcpIpApp.ice.password This value depends on how the Lync Server is configured.
tcpIpApp.ice.turn.server This value depends on how the Lync Server is configured.
tcpIpApp.ice.turn.tcpPort 443
References
69
Parameter Permitted Values
Default
tcpIpApp.ice.turn.udpPort 3478
71
Getting Help
This section provides a list of Polycom documents referred to in this guide as well as partner
resources you can use.
Polycom and Partner Resources
For a full account of Polycom UC software, see the Polycom UC Software 4.1.0 Administrators’
Guide.
For more information about installing, configuring, and administering Polycom products, refer to
the Polycom Voice Support web site.
For more information on Polycom-Microsoft solutions, see Polycom Solutions - Microsoft.
The Polycom Community
The Polycom Community gives you access to the latest developer and support information.
Participate in discussion forums to share ideas and solve problems with your colleagues. To
register with the Polycom Community, simply create a Polycom online account. When logged in,
you can access Polycom support personnel and participate in developer and support forums to
find the latest information on hardware, software, and partner solutions topics.
73
Troubleshooting
Use the following list as a guide to resolving issues, problems, or common difficulties you may
encounter while using Lync-enabled Polycom UC software with Microsoft Lync Server 2010.
The phone fails to register.
The most common issue with a failure to register is basic connectivity to the phone. There
are a number of ways you can check basic connectivity:
○ Obtain the Host IP by looking at the phone registration status, configuration file, DNS
and Lync PC Client Configuration Information Screen.
○ Make sure the phone can communicate with the server by performing a diagnostic ping.
○ From a computer connected on the same network as the phone, perform a telnet to the
lync server sip TCP port 5061 or 443
○ Check for a DNS issue.
○ Lync Services may be down, or there may be a firewall or routing problem with the
network.
Check that the phone is reading the configuration files. On the phone, go to Status >
Platform > Configuration. The phone displays the current configuration and files. If the
phone is not reading the correct configuration files, redo the provisioning procedures. If
the phone is reading the configuration files, go to the next troubleshooting tip.
If the phone still cannot register, check autodiscover:
○ Ensure the SRV Record exist and points to a valid A Record
○ Ensure that the A record points to a valid host IP, see Required DNS Records for
Automatic Client Sign-In.
○ Use the shell command dnsCacheShow to display a cached DNS entry. If an entry has a
negative cache, the phone is trying to perform a lookup and is failing to resolve.
If you get a TLS error, you may have an untrusted, corrupted, or expired certificate. Check
first if a root CA is installed on the phone by going to Settings > Advanced >
Administration Settings > TLS Security > Custom CA Certificate. If you need to
troubleshoot TLS log.level.change.tls=0 and log.level.change.sip=0 to log for
TLS problems.
Check for invalid user credentials. Use log.level.change.tls=0,
log.level.change.sip=0, and log.level.change.dns=0 to troubleshoot
authentication failures.
Log into a PC Lync client with a user’s credentials and ensure that user account logs in.
Use a simple password for testing purposes.