Plantronics + Polycom. Now together as Poly Logo

[FAQ] What is the relevance of the 000000000000.cfg or <mac>.cfg

Highlighted
Polycom Employee & Community Manager

[FAQ] What is the relevance of the 000000000000.cfg or <mac>.cfg

Downloading the compatible SIP / UC Software from the Polycom Support Page => here <= always contains a 000000000000.cfg.

 

This File is protected and set as read only and is thought to be a template for Phone Provisioning.

 

The Phone, on booting from the Provisioning Server, will always look for its own <mac>.cfg file and load this if it can be found.

 

NOTE: The <mac>.cfg file reference represents the Phones own MAC address in this instruction!

 

If this is not available it will then try and load the 000000000000.cfg .

 

It will not load both files.

 

A <mac>.cfg can be created by opening the original 000000000000.cfg and storing it with the MAC Address of a Phone.

 

The properties of this file can be changed via right-clicking on the file and then selecting the properties and un-ticking the read-only attribute.

 

000_readOnly.png

 

The file or a local copy renamed into the MAC address <mac>.cfg of a phone is utilized to actually load individual configuration files via the config_files="" section.

 

Mar 08, 2013 QuestionWhat files does my phone download or upload and why?

Resolution: Please check => here <=

 

You do not add any kind of actual phone configuration parameter to this file!

 

Example: config_files="up.screenCapture.enabled="1" as this will not work.

 

Using a configuration parameter always needs to be in XML format and loaded via the above section.

 

Example:

<test up.screenCapture.enabled="1" />

store the above as capture.cfg and load via the config_files="capture.cfg"

 

NOTE: The names of configuration files can be anything as long as they are not <mac>-phone.cfg and/or <mac>-web.cfg 

 

Structure:

 

000000000000.PNG

 

The individual sections can be used to define separate directories in order to keep a root directory "clean".

 

The way a Sub Directory would need to be specified would be LOG_FILE_DIRECTORY="/logs/" to use the logs subdirectory.

 

NOTE: Please bear in mind using Linux as a server will use case sensitive so logs is logs and not Logs or LOGS

 

Above example was taken from a UCS 4.0.3 Software

 

NOTE: Using SIP 3.2.x or older the Phones always need to ensure to load the sip.cfg / phone1.cfg!

 

APP_FILE_PATH="sip.ld"

 

The APP_FILE_PATH="sip.ld" determines the name and location of the SIP / UCS application

 

DECT_FILE_PATH=""

 

The DECT_FILE_PATH="3111-17823-001.dect.ld"  determines the name and location of the Dect D60 application (UC Software 5.4.3 or later)

 

CONFIG_FILES=""

 

The CONFIG_FILES="" section is used to load additional files that are separated via a "," (comma).

 

The order of the files (left to right) determines how the parameters are set.

 

Having the same parameter in multiple different files will set the value found in the first file and ignore any other values for the same subsequent parameter.

 

NOTE: The 000000000000.cfg or <mac>.cfg is not being used to set configuration parameters! 

 

The CONFIG_FILES="" section in the <mac>.cfg or 000000000000.cfg is used to load Phone specific configuration files affecting the single phone only via substitution and general site-related configurations.

 

These could be individual SIP Authentication Username and Password or site-specific configuration files like the IP Address / Hostname of the SIP Server or other Site-Specific settings.

 

An example could be:

 

CONFIG_FILES="[PHONE_MAC_ADDRESS]-extension.cfg,site.cfg"

 

The [PHONE_MAC_ADDRESS]-extension.cfg would use the substitution and individual files with the MAC Address Part of the Phone in Question with similar content like => here <= would need to be manually created.

 

NOTE: A sample script that utilizes Perl can be found => here <=

 

The site.cfg would contain site-specific settings like NTP Server, SIP server IP address, default language and for example local ringtones.

 

Utilizing this example in a 000000000000.cfg would cause all phones to load their individual single files [PHONE_MAC_ADDRESS]-extension.cfg and then load the sites.cfg.

 

For more details on creating configuration files or using existing configuration files please check => here <=

 

NOTE: Legacy phones will in addition always need their sip.cfg / phone1.cfg as explained => here <=

 

The CONFIG_FILES="" and all other section can load files in several different formats. One could simply be site.cfg or even http://xxx.xxx.xxx.xxx/site.cfg and can combine local and/or remote files.

 

MISC_FILES=""

 

The MISC_FILES="" section enables to load ringtones wav files, pictures and to allow fonts, icons, animated backgrounds. See => here <= and => here <= for more details.

 

LOG_FILE_DIRECTORY=""

 

The LOG_FILE_DIRECTORY="" can be used to store logs in a different directory. If nothing is specified the files are stored in the root directory. See => here <= for more details.

 

OVERRIDES_DIRECTORY=""

 

The OVERRIDES_DIRECTORY="" can be used for the <mac>-phone.cfg and/or <mac>-web.cfg. If nothing is specified the files are stored / loaded in/from the root directory.

 

The overrides are "created" by the phone when you are making changes via the GUI (<mac>-phone.cfg and/or via the Web Interface (<mac>-web.cfg) and are stored on the provisioning server by the phone and loaded when rebooting.

 

NOTE: You must never create them manually and utilizing these files to provision a phone is a bad practice.

 

CONTACTS_DIRECTORY=""

 

The CONTACTS_DIRECTORY="" can be used for the <mac>-phone.cfg and/or <mac>-web.cfg. If nothing is specified the files are stored / loaded in/from the root directory. See => here <= for more details.

 

LICENSE_DIRECTORY=""

 

The LICENSE_DIRECTORY="" can be used for the <mac>-license.cfg . If nothing is specified the files are loaded from the root directory. See => here <= for more details.

 

USER_PROFILES_DIRECTORY=""

 

The USER_PROFILES_DIRECTORY="" can be used for the individual user cfg files. If nothing is specified the files are loaded from the root directory. See => here <= for more details.

 

CALL_LISTS_DIRECTORY=""

 

The CALL_LISTS_DIRECTORY="" can be used to store/load the <mac>-calls.xml or <username>-calls.xml files. If nothing is specified the files are stored/loaded in/from the root directory.

 

Note:The call lists (or call log) is supported on VVX Business Media and Trio phones!

 

COREFILE_DIRECTORY=""

 

The COREFILE_DIRECTORY="" is being used by the phone in case the software encounters an issue and is used by Support to determine the root cause.

SERVICE_FILES=""

 

The Service_Files="" is being used by ALY / Alcatel Lucent implementations. This was added in 5.4.0

 

Details on how to combine new SIP / UC Software when using legacy Phones can be found => here <=.

 

VVX UC Software 5.6.3 added the following feature:

 

CERTIFICATE_DIRECTORY=""

 

This directory is used to upload the certificate file with extensions such as .csr and .pem (private key), for example, <mac>.csr and <mac>-privatekey.pem that is generated by the VVX business media phone by using CSR generation process. This directory is also used to download the certificate file with extensions such as .crt, .key, and .pac from a user specified location.

 

FLK_DIRECTORY=""

 

This directory is used to upload or download the CSV file, for example,
<MAC>-<sign-in address>.csv to the user specified location in Skype for Business Flexible Line Key assignment.

 

NOTE: This will be added to VVX UC Software 5.7.3 and/or 5.8.1. For Trio please check the Release notes

 

 

Trio UC Software 5.7.1 added the following feature:

 

CAMERA_PRESETS_DIRECTORY=""

 

You can store the camera preset thumbnail images to a sub-directory on the provisioning server. When you set the attribute CAMERA_PRESETS_DIRECTORY="presets", the images are stored to an existing sub-directory called Presets.

 

General Usage:

 

The below section is used to load on every phone:

 

AllPhones.PNG

 

IF there is no individual section defined below.

 

If you specify an individual phone model it would use for all other VVX, Trio and CX5500 models the 1st line and the _VVX300 would use the 2nd line starting with <APPLICATION_VVX300

 

IndividualModel.PNG

 

A 3rd approach could be to specify the firmware only for a certain phone model in a subdirectory ( /testfirmware/ ) within the generic section:

 

Provisioning_per_Phone.png

 

You can also mix these so in this example only a VVX410 would download its configuration from the application Sub Directory:

<APPLICATION APP_FILE_PATH="sip.ld" DECT_FILE_PATH="3111-17823-001.dect.ld" CONFIG_FILES="" 
SERVICE_FILES="" MISC_FILES="/misc/" LOG_FILE_DIRECTORY="/logs/" OVERRIDES_DIRECTORY="/overrides/"
CONTACTS_DIRECTORY="/contacts/" LICENSE_DIRECTORY="" USER_PROFILES_DIRECTORY=""
CALL_LISTS_DIRECTORY="/calls/" COREFILE_DIRECTORY="/core/" CERTIFICATE_DIRECTORY=""
FLK_DIRECTORY=""> <APPLICATION_VVX410 APP_FILE_PATH_VVX410="/application/sip.ld" CONFIG_FILES_VVX410="" />



<======== Signature / Disclaimer ========>
Please be aware:For questions about the type of support to expect please check here

Please also ensure you always check the VoIP , Video Endpoint , Skype for Business , PSTN or RPM FAQ's

Please remember, if you see a post that helped you , and it answers your question, please mark it as an "Accept as Solution".

The title Polycom Employee & Community Manager is an automatic setting within the community and any forum reply or post is based upon my personal experience and does not reflect the opinion or view of my employer.
Poly employee participation within this community is not mandatory and any post or FAQ article provided by myself is done either during my working hours or outside working hours, in my private time, and maybe answered on weekends, bank holidays or personal holidays.