Plantronics + Polycom. Now together as Poly Logo

[FAQ] Where can I download configuration files from or create these myself?

Highlighted
Polycom Employee & Community Manager

[FAQ] Where can I download configuration files from or create these myself?

UC Software 4.0.0 or later:

 

Since UCS 4.0.0 the phone can import configuration files via the Web Interface. For more information please check => here <=

 

This is useful in order to add configuration changes to an individual phone with Parameters that are not available to change via the Web Interface or the Phone GUI.

 

The expected format would be an XML file with the .cfg as a file extension.

 

  • Utilities > Import & Export Configuration > Import Configuration

 

ImportConfig.PNG

 

Some community replies or the Admin Guide contain individual parameters.

 

Simply open a compatible editor like Notepadd++ and paste the parameter into it:

 

Notepad_plusPlus_Example.png

Any configuration file needs to start with a < chevron and end with a /> forward-slash chevron

 

Simply save this with any name ending with .cfg and import using the above menu

 

Older than UC Software 4.0.0 or Provisioning Server:

 

Each released version of SIP or UCS software contains the relevant supported configuration files that, depending on the software Version, are needed to provision the phone.

 

The compatible Software and prior versions can be downloaded from => here <= , need to be decompressed / unzipped and then to be placed on a provision server.

 

NOTE: Do not ever mix configuration files from previous versions with newer versions!

 

The SIP Software releases traditionally included the 000000000000.cfg, the sip.cfg and the phone1.cfg

 

Since the appearance of newer phone models, older phones have been classed as legacy phones, and the newer phones software now may contain a sip_(Version of Sip).cfg and a phone1_(Version of Sip).cfg

 

This allows a mix of phones and guarantees backwards capability.

 

NOTE: Please consult the SIP / UCS Admin Guide matching your software version!

 

Every Software Version prior to UCS 3.3.0 always needed the phone to be able to download its sip.cfg / phone1.cfg files.

 

UCS 3.3.0 removed the need for this and the phone does only need to download either the templates files listed in the \Config subdirectory or any self-created files that had been listed within the CONFIG_FILES=" " section of a 000000000000.cfg or manually created <mac>.cfg.

 

Example file's from within the \Config subdirectory within UCS 3.3.0:

 

applications.cfg
features.cfg
H323.cfg
polycomConfig.xsd
reg-advanced.cfg
reg-basic.cfg
region.cfg
sip-basic.cfg
sip-interop.cfg
site.cfg
text.txt
video-integration.cfg
video.cfg

 

The user must specify the files that should be loaded via the CONFIG_FILES="" section as these are not automatically loaded.

 

For more details please check => here <=

 

NOTE: The files within the \Config are only templates and individual parameters can be copied & pasted into a manually created file(s) instead! 

 

Example applications.cfg

applications,.cfgapplications,.cfg

In the above example the parameter

<apps.restapi apps.restapi.enabled="0">

is disabled aka ="0".

 

This matches the factory configuration so specifying the file within the config_files="" section would not actually make any changes unless this applications.cfg file would be modified.

 

Manually creating a configuration file:

 

NOTE: Please note that the configuration file must be XML conform or the phone will ignore it!

 

In order to change the standard value of a single parameter it is easier to create an individual file.

 

The example parameter used in below is se.rt.enabled="1"

 

If 0, the ringtone feature is not enabled on the phone. If 1 (default), the ringtone feature is enabled.

 

Using UCS 3.3.0 or newer (check the matching admin guide) the parameter is contained in the template file features.cfg.

 

Opening the file with an XML compatible editor like Notepadd++ shows all the template parameters. 

 

Configuration_File_01.PNG

 

Copying and pasting the relevant section into a new window will allow the user to simply change one individual setting and load this file via the 000000000000.cfg or manually created <mac>.cfg.

 

Configuration_File_02.PNG

 

Above shows an individual file stored as rt.cfg and the value changed from the factory default 1 into 0.

 

Configuration_File_03.PNG

 

Above shows the individually created <mac>.cfg file loading the rt.cfg via the  CONFIG_FILES="" section from the provisioning server root directory.

 

Only the individual Phone with this MAC address will load this parameter.

 

NOTE: Substitution placeholders can be used as shown => here <=

 

----------------
The title Polycom Employee & Community Manager is a community setting and does not reflect my role. I am just a simple volunteer in the community like everybody else. My official "day" Job is 3rd Level support at Poly but I am unable to provide official support via the community.

----------------

Notice: This community forum is not an official Poly support resource, thus responses from Poly employees, partners, and customers alike are best-effort in attempts to share learned knowledge. If you need immediate and/or official assistance please open a service ticket through your proper support channels.
Please also ensure you always check the VoIP , Video Endpoint , Skype for Business , PSTN or RPM FAQ's
Message 1 of 2
1 REPLY 1
Polycom Employee & Community Manager

Provisioning a large number of phones

When a user wants to provision and automate the configuration of a large number of phones they could utilize the attached excel spreadsheet to do so. 

 

For the steps below please familiarize yourself with the Poly Admin Guide for the phone model in question. Poly support suggest using an editor like Notepad++

 

  1. Download a supported software for the Phone in question from our support page >here<

  2. Unzip the software into a directory on the PC and open the 00000000000.cfg and amend the various config_file and other locations to match what you are trying to setup.

    An explanation of this can be found => here <=

    For example, the logs should go into a newly-created subdirectory called logs aka LOG_FILE_DIRECTORY="/logs/"

  3. Setup a DHCP Option for either a Skype for Business Sku 161, an openSIP Sku 160 or a general option 66 to cover both as shown >here<

  4. Setup Filezilla FTP as shown => here <= and set up a new user.

    The user could be called PlcmSpIp as this is the default user a Poly phone would use as user and password.

    Point to the directory where the downloaded firmware from step 2. was unzipped into.

  5. Unzip the attached Copy of GenerateMac.zip and open the Copy of GenerateMac.xlsm

    GenerateMAC_00.png

    Please enable the content so the macro's in the script work

    GenerateMAC_01.png
    Row 2 Field A represents the Mac address of the device. The rest of the fields B etc. can be any configuration parameter.

    In the example, we used the User, the address and the password required for a SIP registration. You can add more fields to create individually required configuration for phones.

    Clicking on "Generate Files" will start to create the individual files named <MAC>-individual.cfg in the directory the xlsm file was opened.
    GenerateMAC_02.png
    Now copy all these files to the location of the unzipped firmware in step 2. from above.

  6. Download the attached general.zip and unzip the file general.cfg and place it into the location of the unzipped firmware downloaded in step 2. above.

    Example file:
    GenerateMAC_03.png
    The above contains the general settings for every phone to register to a SIP server as shown >here< and changes the time to a 24h clock preferred in Europe as an example.

    The above can be edited to suit the local requirements.

    For example you could also include the below:
    		prov.polling.enabled="1"
    		prov.polling.mode="random"
    		prov.polling.period="86400"
    		prov.polling.time="03:00"
    		prov.polling.timeRandomEnd="05:00"

    Adding the above would cause the Poly phone every day to automatically connect to the provisioning server and check for any configuration changes. The approached polling period is during the night hours at the phones local time. This is staggered based on the phones Mac address so no all phones are doing this at the same time.

    The above could also be modified to include configuration for phone >logs<

  7. Edit the config_file section of the 000000000000.cfg again to include:
    CONFIG_FILES="general.cfg,[PHONE_MAC_ADDRESS]-individual.cfg"


    GenerateMAC_04.png

  8. Each phone will now boot out of the box from the DHCP Server and find it's DHCP Option and search first for its own Mac address.cfg file and then skip this step and download the 000000000000.cfg instead.
    Whilst parsing the 000000000000.cfg it will check the config_files section and load the general.cfg and then next automatically substitute the [PHONE_MAC_ADDRESS] part and replace this with its own Mac address-individual.cfg and load this.

 

NOTE: The above information is supplied to help users but Poly cannot be held responsible for any of the attached files. If you require support please work with your Poly reseller as outlined => here <=

----------------
The title Polycom Employee & Community Manager is a community setting and does not reflect my role. I am just a simple volunteer in the community like everybody else. My official "day" Job is 3rd Level support at Poly but I am unable to provide official support via the community.

----------------

Notice: This community forum is not an official Poly support resource, thus responses from Poly employees, partners, and customers alike are best-effort in attempts to share learned knowledge. If you need immediate and/or official assistance please open a service ticket through your proper support channels.
Please also ensure you always check the VoIP , Video Endpoint , Skype for Business , PSTN or RPM FAQ's