Question: How can I setup my Phone / Provisioning / Download Software?
Polycom Phones may be connected to Platforms like Microsoft Lync and Skype for Business, Broadsoft or Digium Asterisk or other VoIP Interop Partners.
Question: What is a Provisioning Server?
Answer: A provisioning server is a term for a server like FTP, FTPs, HTTP, HTTPs or TFTP hosting the relevant files => here <= for a Polycom device to successfully be able to download configuration and provide software.
Polycom has separate Solutions in either on Premise Polycom ResourceManager RPRM or a Cloud Solution called PDMS-E and additional details can be found => here <=
Skype for Business
In order to utilize your Phone with Skype for Business the phone needs to have at least UC Software 5.4.0A (5.4.0.10182) => installed <=
Please follow Option 1 to upgrade your phone if => compatible <= and already on UC Software 4.0.0 or later or follow Option 2 using a Provisioning Server.
LYNC 2010 or LYNC 2013
Please follow Option 1 to upgrade your phone if => compatible <= and already on UC Software 4.0.0 or later or follow Option 2 using a Provisioning Server.
NOTE: You may have to enable the Web Interface as explained => here <=
Polycom Trio 8800 or 8500
The Polycom Trio in addition supports USB provision as shown => here <=
D60 Firmware Update:
Details on how to upgrade the D60 Handset can be found => here <=
General Provisioning
Some of the above Platforms provide the configuration files templates or Software in order to provision the phones and set the correct configuration values.
Detailed Information about Provisioning can be found in the Admin Guide matching your Phones SIP / UC Software Revision.
NOTE: UC Software 4.0.0 or later added the ability to import a configuration via the Web Interface. For more details check => here <=
OPTION 1
Using the Web Interface Phone Software Update
UC Software 4.0.0 or later introduced a new feature where a hosted server either by Polycom or => locally <= can be used to upgrade the phones software via the Web Interface.
NOTE: Phones delivered with this software version should be the VVX101, 150, 201, 250, 300, 310, 350, 400, 410, 450, 500, 501, 600, 601 and Polycom Trio 8500 and 8800
Browsing to the Phones => IP Adddress <= will bring up the Phones Web Interface and you can Login using the phones Admin => default Password <= of 456.
NOTE: UC Software 5.1.0 or will present changes to the HTTP/HTTPS availability of the Web Interface as explained => here <=
Via Utilities => Software Upgrade:
Pressing the "Check for Updates" Radio button will connect to the Polycom server and display the available software versions in a drop down menu
NOTE: The phone requires to be able to connect via Port 80 to the Internet if the Polycom hosted server is being used
May 11, 2018 Question: Why do I get a "Failed to fetch available software from the Polycom hosted server" error message or able to download list but unable to upgrade / downgrade?
Resolution: Please ensure your firewall allows outbound network traffic as shown => here <=
OPTION 2:
Using a Provisioning Server
UC Software 4.0.0 or later introduced a new Feature where the Provisioning Server can be added via the Web Interface of the phone.
NOTE: Prior to UCS 4.0.0 the Provisioning server was only available via the Phones GUI
OPTION 3:
Manually utilizing a provisioning server via the Phone GUI when the Phone is running
Press Menu => Settings => Advanced => Admin Settings => Network Configuration => Provisioning Server
OPTION 4:
Manually utilizing a provisioning server via the Phone GUI when the Phone is booting up
> UC Software 4.0.0 or later
> SIP Software 3.3.5 or older
Software Download Location:
The Provisioning Server (FTP is preferred => details below) needs to be setup to provision the desired SIP / UC Software Revision.
Usually this is archived via downloading a compatible SIP / UC Software Revision from => here <=
Oct 7, 2011 Question: What SIP or UC Software Version or BootROM/Updater Version is supported by my Phone?
Resolution: Please check => here <=
Additional considerations:
The downloaded Software usually comes in two different variants:
May 14, 2012 Question: Can I support a mix of legacy SIP and UCS Phones on the same Provisioning Server?
Resolution: Please check => here <=
Checking the current Software Version:
Oct 7, 2011 Question: How can I find out my SIP UC Software Version or the BootROM Version of my Phone?
Resolution: Please check => here <=
SOFTWARE UPGRADE PATH
Updating to SIP 3.1.x:
If the phone is running an older Version of Software you will need to download the compatible SIP Version and in addition the BootROM.
Note: The accompanying sip.cfg and phone1.cfg must be used
Oct 7, 2011 Question: What is the relevance of the sip.cfg and phone1.cfg files?
Resolution: Please check => here <=
Updating to SIP 3.2.x:
If the phone is running an older Version of Software you will need to download the compatible SIP Version and in addition the BootROM.
Note: The accompanying sip.cfg and phone1.cfg must be used
Oct 7, 2011 Question: What is the relevance of the sip.cfg and phone1.cfg files?
Resolution: Please check => here <=
Updating to UCS 3.3.x:
If the phone is running an older Version of Software you will need to download the compatible UCS Version and in addition the BootROM.
Note: Do not use any old sip.cfg or phone1.cfg and utilize the cfcUtility to convert your old configuration files instead
Oct 03, 2012 Question: What is the cfcUtility and where can I get it?
Resolution: Please check => here <=
Updating to UCS 4.x.x:
If the phone is running an older Version of Software you will need to download the compatible UCS Version and in addition the BootROM 4.4.0 B Upgrader.
As an example download software version UCS 4.0.14 (or later) and BootROM 4.4.0 B Upgrader and unzip the content of both of the downloads into one directory.
You will then have to point the relevant Server (HTTP(s), FTP(s) or TFTP to the directory where the Software has been unzipped.
Before you can successfully install UC Software 4.x.x onto phones running Polycom® UCS released prior to version 4.0.0, you must perform a required upgrade procedure using the Polycom® Upgrader 4.0.0 Utility.
Before you download and install Polycom® UC Software version 4.0.x or higher, Polycom strongly recommends that you review the changes to the upgrade procedures detailed in the Polycom® UC Software 4.0.0 Administrators’ Guide or newer and Engineering Advisory 64731 Polycom® UC Software 4.0.0: Upgrade and Downgrade Methods.
Note: A SoundStation IP 6000 and IP 7000 need the Updater upgraded as shown => here <=.
Downgrading from UCS 4.x.x:
If the phone is running the new version of UC Software you will need to download the compatible Downgrader (Example Polycom UC Downgrader 4.5.0B Utility)
This will downgrade the compatible phones to UCS 3.3.2 and you then can update to any other UCS 3.3.x Version or Downgrade to SIP 3.2.x
Please check the Polycom UC Software 4.0.x Upgrade and Downgrade Methods (Engineering Advisory 64731).
SoundStation IP6000 and SoundStation IP7000 Examples:
Basically the process is the same as described in this FAQ but you need to ensure you also have the relevant compatible Updater:
First download:
Unzip all of the above into one directory and then point the phone to the Server
Automation
Local provisioning automated DHCP Server Options:
Poly Phones delivered from the Factory are preconfigured to be using DHCP Custom Option 160 or 161 (If ordered as Skype for Business SKU) and then Option 66 to inform themselves about the location of a potential Provisioning Server.
Adding a Custom 160 / 161:
And then select the actual new Option 160 or 161
Option 66:
Above Example uses the Standard Provisioning Factory Default Username of PlcmSpIp and the Password PlcmSpIp and would utilize these using FTP as the protocol and 10.252.149.100 as the Server IP or Hostname.
This is submitted via a DHCP String and could be in one of the following formats:
HTTP(S), FTP(S) or TFTP.
Example DHCP string:
ftp://Username:Password@IP_Address or URL
A Username & Password could also be:
http://domain\username:password@IP_Address_or_URL
NOTE: If the password as an example contains an @ please replace this with %40 instead.
Example:
ftp://Username:%40123$@IP_Address or URL
The above would use @123$ as the password or the phone would interpret the @Symbol as the separator between the password and the IP Address or URL.
If a Poly Phone is used in a non-supported Environment the End Customer is responsible for setting up a local Provisioning Server.
Poly Logs:
013527.204|dhcpc|3|00|dhcListener: Read succeeds: eth0 option: o-161 ftp://t590d:1@10.252.149.100
Setting the DHCP logging level as Settings > Logging > Module Log Level Limits > DHCP Client > Event 3 will show the received Option in the logs
Pointing a Phone to an Provisioning Server manually:
NOTE: Please remember that you may need to require to add a local Firewall Rule or Disable the Firewall completely !
To manually point the Phone to a Provisioning Server please do the following Steps:
Reboot the Phone (unplug Ethernet cable and plug back in)
Server Type: | FTP(s), TFTP or HTTP(S) |
Server Address: | IP Address or Hostname of your Server |
Server User: | Username of your server (if needed) |
Server Password: | Password of your server (if needed) |
In a normal setup we recommend using an FTP Server in order to provision the Phone and in addition to allow the Phone to upload its own <mac>-app.log and <mac>-boot.log files.
The Server directory should contain the unzipped Version of either UCS or SIP Software (depending on the compatible version)
NOTE: check => here <= if legacy phones are used
The FTP Server needs to allow append and write for this functionality.
Above is vital for Polycom Support in order to troubleshoot cases.
The Customer needs to create their own individual Configuration Files and can use separate files for a Phones registration (per Phone Mac Address) and Global Settings like SIP Server, NTP and Language etc.
When is a Provisioning Server needed:
Example FTP Server:
Note: Below example utilizes the Freeware FTP Server Filezilla. Please ensure to setup the correct Firewall settings and liaise directly with Filezilla for any issues encountered with their Software. The example provided is utilizing UCS 4.1.0 Rev B as the Polycom Phone Software
NOTE: Above UC Software 4.1.0 is just an example and is for LYNC deployments only. For SIP please check the Support page for the compatible software !
Pre-requisite:
Setting up the server
Setting up Microsoft IIS for HTTP Provisioning
NOTE: Please be aware that Polycom does not provide any support on the below and any changes or permissions are at your own risk !!
A "normal" IIS server is unable to append using HTTP or HTTPS. Utilising HTTPd, Apache or any other flavor of HTTP/HTTPS servers should work.
The LOG_FILE_DIRECTORY="" can be used to define a FTP server instead. Example:
Below information is based on a Microsoft Windows Server 2008 R2 and assumes that you install the below on a separate server that is part of an existing domain.
Option 1 Basic Authentication:
Once IIS is installed please download and unzip the Software you wish to provision into the C:\inetpub\wwwroot Directory
Example:
NOTE: As a standard Windows will not allow basic passwords so the following is at your own risk!
In order to enable a basic Password like the Polycom factory default of PlcmSpIp you will need to change the Password Policy
NOTE: The above is only an example to create a User that can utilize the Standard Polycom Password PlcmSpIp and may violate local policies !
NOTE: IIS or the Server hosting IIS may need to be restarted after a successful installation !
The Option 160 or 66 DHCP Server string explained => here <= would now be as follows:
http://PlcmSpIp : PlcmSpIp @ 10.252.122.133/UCS_5.2.0.8330_rts55rel
Setting up Microsoft IIS for HTTPS Provisioning
NOTE: Please be aware that Polycom does not provide any support on the below and any changes or permissions are at your own risk !!
Below information is based on a Microsoft Windows Server 2012 and assumes that you install the below on a separate server that is part of an existing domain.
This Guide also assumes that you have setup a AD User called ftpuser with a password of T3ch!ab and the C:\inetpub\wwwroot Directory in the sbaierhome.lab domain.
The above HTTP Instructions already document how to add IIS as a role and the relevant addition of Basic Authentication, Mime Types and WebDav
The C:\inetpub\wwwroot Directory directory is being used for HTTP so we create a new Directory called C:\inetpub\wwwhttps
Once all of the above has been set you should be able to browse to the URL of the Provisioning Server and receive a challenge for a Username and Password.
Copy the ExportedRootCertificateForPhoneProvisioning.cer to your main PC so you can create the certificate for the Polycom phone to use.
In order for the Phone to be able to either import this via the Web Interface or load it from a Provisioning server the file needs to be correctly formatted.
device.set="1" device.sec.TLS.customCaCert1.set="1" device.sec.TLS.customCaCert1=" place certificate here "
The Certificate can then be seen:
Setting the Provisioning Server Details on the phone:
The Phone connects via HTTPS:
0517184023|copy |3|00|'https://sbaierhome%5Cftpuser:****@iistestserver.sbaierhome.lab/000000000000.cfg' from 'iistestserver.sbaierhome.lab(10.252.149.123)' 0517184023|copy |3|00|cfgProvSrvTypeGet()[0] 0517184023|copy |1|00|performCurl : ipAddress = 10.252.149.123, connTimeout = 16, respCode =0, numAddress = 1 0517184023|curl |3|00|timeout on name lookup is not supported 0517184023|curl |3|00|About to connect() to iistestserver.sbaierhome.lab port 443 (#0) 0517184023|curl |3|00| Trying 10.252.149.123... 0517184023|curl |3|00|the local port callback returned 0 0517184023|curl |3|00|Local port: 57091 0517184023|curl |3|00|Connected to iistestserver.sbaierhome.lab (10.252.149.123) port 443 (#0) 0517184023|curl |3|00|successfully set certificate verify locations: 0517184023|curl |3|00| CAfile: /ffs0/ca1.crt CApath: none 0517184023|curl |3|00|SSLv3, TLS handshake, Client hello (1): 0517184023|curl |0|00|SSL DATA_OUT: Data of len 105 not displayed 0517184023|curl |3|00|SSLv3, TLS handshake, Server hello (2): 0517184023|curl |0|00|SSL DATA_IN: Data of len 81 not displayed 0517184023|curl |3|00|SSLv3, TLS handshake, CERT (11): 0517184023|curl |0|00|SSL DATA_IN: Data of len 1428 not displayed 0517184023|curl |3|00|SSLv3, TLS handshake, Server finished (14): 0517184023|curl |0|00|SSL DATA_IN: Data of len 4 not displayed 0517184023|curl |3|00|SSLv3, TLS handshake, Client key exchange (16): 0517184023|curl |0|00|SSL DATA_OUT: Data of len 134 not displayed 0517184023|curl |3|00|SSLv3, TLS change cipher, Client hello (1): 0517184023|curl |0|00|SSL DATA_OUT: Data of len 1 not displayed 0517184023|curl |3|00|SSLv3, TLS handshake, Finished (20): 0517184023|curl |0|00|SSL DATA_OUT: Data of len 16 not displayed 0517184023|curl |3|00|SSLv3, TLS change cipher, Client hello (1): 0517184023|curl |0|00|SSL DATA_IN: Data of len 1 not displayed 0517184023|curl |3|00|SSLv3, TLS handshake, Finished (20): 0517184023|curl |0|00|SSL DATA_IN: Data of len 16 not displayed 0517184023|curl |3|00|SSL connection using AES256-SHA 0517184023|curl |3|00|Server certificate: 0517184023|curl |3|00| subject: C=GB, ST=Berkshire, L=Slough, O=Polycom, OU=Tier3, CN=iistestserver.sbaierhome.lab 0517184023|curl |3|00| start date: 2016-05-17 11:09:25 GMT 0517184023|curl |3|00| expire date: 2018-05-17 11:09:25 GMT 0517184023|curl |3|00| common name: iistestserver.sbaierhome.lab (matched) 0517184023|curl |3|00| issuer: DC=lab, DC=sbaierhome, CN=sbaierhome-LYNCLAB1DC-CA 0517184023|curl |3|00| SSL certificate verify ok. 0517184023|curl |3|00|Server auth using Basic with user 'sbaierhome\ftpuser' ...7184023|curl |1|00|HEADER_OUT: GET /000000000000.cfg HTTP/1.1 0517184023|curl |1|00|HEADER_IN : HTTP/1.1 200 OK 0517184023|curl |1|00|HEADER_IN : Content-Type: text/plain 0517184023|curl |1|00|HEADER_IN : Last-Modified: Wed, 08 Apr 2015 14:54:52 GMT 0517184023|curl |1|00|HEADER_IN : Accept-Ranges: bytes 0517184023|curl |1|00|HEADER_IN : ETag: "046b8f7b72d01:0" 0517184023|curl |1|00|HEADER_IN : Server: Microsoft-IIS/8.5 0517184023|curl |1|00|HEADER_IN : Date: Tue, 17 May 2016 17:40:24 GMT 0517184023|curl |1|00|HEADER_IN : Content-Length: 1961 0517184023|curl |1|00|HEADER_IN : 0517184023|curl |0|00|DATA_IN : Data of len 1961 not displayed