Alcatel-Lucent Enterprise 8AL91471ENAA ed01 SIP DeskPhones Configuration File Mass Generation Installation Guide

: September 7, 2024
: Alcatel-Lucent Enterprise

Table of Contents

Alcatel-Lucent Enterprise 8AL91471ENAA ed01 SIP DeskPhones Configuration
Product Information
Product Usage Instructions
Configuration file mass generation tool introduction
How to generate H2P configuration file in batches
How to create the configuration template
How to complete mass auto-provisioning
Technical Support
References
Read User Manual Online (PDF format)
Download This Manual (PDF format)

Alcatel-Lucent Enterprise 8AL91471ENAA ed01 SIP DeskPhones Configuration

File Mass Generation

Product Information

Specifications

Model: Alcatel-Lucent Enterprise SIP DeskPhones
Tool Version: ALE SIP Phone Config File Generation Tool_V1.1
Supported Desk Phones: H2X, H3X, H6X, MX series

Product Usage Instructions

Configuration File Mass Generation Tool Introduction
Unzip ALE SIP Phone Config File Generation Tool_V1.1 and locate the following:

config folder: Contains a config.json file for changing the configuration file format.
out folder: Stores the generated configuration files.
input.xlsx: Table for entering phone MAC addresses and variable parameters.
run.exe: Program for mass generation of configuration files.
template.xml: Phone configuration template used for generating content.

How to Generate H2P Configuration File in Batches

Edit config.json file
In the config folder, edit the config.json file to change the configuration file format to $$$mac$$$.xml for H2P phones.

Edit input.xlsx file
Open input.xlsx and fill in variable names and corresponding values for the phones:

First row must be MAC Address, followed by other customizable parameters like register name, username, password.
Variable names can be in English or other languages.
Values for MAC Address can have : symbol (e.g., aa:bb:cc:dd:ee:01) or without (e.g., aabbccddee01).

Frequently Asked Questions (FAQ)

Q: Can I use the tool for phones other than H2X, H3X, H6X, MX series?
A: The tool is specifically designed for the mentioned desk phone series. Using it for other models may not yield desired results.
Q: What should I do if the generated configuration files are not working?
A: Double-check the input.xlsx file for correct MAC addresses and parameter values. Ensure the template.xml is correctly configured for your phone model.

Alcatel-Lucent Enterprise
SIP DeskPhones Configuration File Mass Generation and Installation Guide

Reference Guide
8AL91471ENAA ed01

www.al-enterprise.com The Alcatel-Lucent name and logo are trademarks of Nokia used under license by ALE. To view other trademarks used by affiliated companies of ALE Holding,
visit: www.al-enterprise.com/en/legal/trademarks-copyright. All other trademarks are the property of their respective owners. The information presented is subject to change without notice. Neither ALE Holding nor any of its affiliates assumes any responsibility for inaccuracies contained herein. © Copyright 2024 ALE International, ALE USA Inc. All rights reserved in all countries.

Configuration file mass generation tool introduction

Unzip “ALE SIP Phone Config File Generation Tool_V1.1”, files as shown below:

config folder: There is a config.jaon file in this folder, it’s used for changing the format of configuration file.
out folder: The configuration files generated will be saved in this folder.
input.xlsx: This table is used to fill in the phone MAC addresses and their corresponding variable parameters information.
run.exe: Running program for mass generation of configuration files.
template.xml: The configuration template of the phone. The generated configuration file content is generated according to this template.
template-H2X.xml: The configuration template is for H2P. Please change the file name to template.xml when generating H2P configuration file.
template-H3XH6XMX.xml: The configuration template is for H3G/H6/M3/M5/M7/M8. Please change the file name to template.xml when you want to generate H3G/H6/M3/M5/M7/M8 configuration file.
No changes needed for the other folders.

How to generate H2P configuration file in batches

Edit config.json file
Enter the “config” folder, then edit the config.json file.

The format of configuration file is “config.$$$mac$$$.xml” by default.

This format is for H3G/H6/M3/M5/M7/M8. Please change it to “$$$mac$$$” for H2P, where the “$$$mac$$$” is the variable replacement character. The “$$$mac$$$” will be replaced by the real MAC which is written in the “input.xlsx” file during the configuration file generating. For example, if the format is “$$$mac$$$.xml”, then the configuration file generated will be “112233445566.xml”, where the “112233445566” is a real MAC of the phone.

Edit input.xlsx file
Open the “input.xlsx” file, then fill in the variable name and its corresponding value for the phones.

Please fill in the variable name in the first row, where the first row and first column must be “MAC Address”. Other parameters, such as: register name, username, password, can be customized and no ordering limitation. The variable name except “MAC Address” can be English or other languages, as shown below:
Fill in the corresponding values of the parameters from the second row. The value of MAC Address support two formats, one with “:” symbol, like “aa:bb:cc:dd:ee:01”, another one without “:” symbol, like “aabbccddee01”
If the value of a related parameter is empty in the table, then the value of the related parameter in the configuration file generated is also empty. The phone will use the default value of this parameter instead.

Edit template.xml file
Enter the folder unzipped and delete the “template.xml” file (The default template.xml file is for H3XH6XMX phones), then rename the “template-H2X.xml” to “template.xml”.
Open template.xml file, this template.xml file includes all of the parameters for H2X, user can directly fill in the value of parameter which is same for all phones, such as SIP Server, NTP Server etc. For the same parameter but with different values for different phones. we need to use the variable symbol to get the values of related parameters from the “input.xlsx” file, such as username, password etc., the configuration rules of variable symbol are shown below:
Open input.xlsx file, then copy the customized parameters to the value part of the related parameters in template.xml file, the format in template.xml is “$$$customized parameter$$$”, the “$$$customized parameter$$$” will be replaced by the real value from the input.xlsx file during the generation of configuration files, as the picture shown below:

The other parameters in the template.xml file of H2X are default parameters, there is no need to edit if not necessary.
Note: The parameter can be customized, but the parameter name in the template.xml and input.xlsx must be matched for each other

Run program to generate configuration files
Double click “run.exe” after completing the processes above. The configuration files were generated when the “Please click anything to close me” is displayed in the bottom line, just click any key to exit this program, as the picture shown below:

Review the configuration file generated
Enter the folder “out”, all of the configuration files generated are here. Open any one of the configuration files, then check the value of the parameters are the same as the one defined in the “input.xlsx” file, as the picture shown below:

How to generate H3XH6MX configuration file in batches

Edit config.json file
Enter the “config” folder, then edit the config.json file. The format of configuration file is “config.$$$mac$$$.xml” by default.

This format is for H3G/H6/M3/M5/M7/M8, where the “$$$mac$$$” is the variable replacement character. The “$$$mac$$$” will be replaced by the real MAC which is written in the “input.xlsx” file during the configuration file generating. For example, if the format is “$$$mac$$$.xml”, then the configuration file generated will be “112233445566.xml” where the “112233445566” is a real MAC of the phone.

Edit input.xlsx file
Open the “input.xlsx” file, then fill in the variable name and its corresponding value for the phones.

Please fill in the variable name in the first row, where the first row and first column must be “MAC Address”. Other parameters, such as: register name, username, password, can be customized and no ordering limitation. The variable name except “MAC Address” can be English or other language, as shown below:
Fill in the corresponding values of the parameters from the second row. The value of MAC Address supports two formats, one with “:” symbol, like “aa:bb:cc:dd:ee:01”, another one without “:” symbol, like “aabbccddee01”.
If the value of a related parameter is empty in the table, then the value of the related parameter in the configuration file generated is also empty. The phone will use the default value of this parameter instead.

Edit template.xml file
Enter the folder unzipped and delete the “template.xml” file (The default template.xml file is for H3XH6MX phones.), then rename the “template-H2X.xml” to “template.xml”.
Open template.xml file, this template.xml file includes all of the parameters for 3XH6MX, user can directly fill in the value of the parameter which is same for all phones, such as SIP Server, NTP Server etc. For the same parameter but with different values for different phones, we need to use the variable symbol to get the values of related parameters from the “input.xlsx” file, such as username, password etc., the configuration rules of variable symbol as shown below:
Open input.xlsx file, then copy the customized parameters to the value part of the related parameters in template.xml file, the format in template.xml is “$$$customized parameter$$$”, the “$$$customized parameter$$$” will be replaced by the real value from the input.xlsx file during the generation of configuration files, as the picture shown below:

The other parameters in the template.xml file of H3XH6MX are default parameters, there is no need to edit if not necessary.
Note: The parameter can be customized, but the parameter name in the template.xml and input.xlsx must be matched for each other.

Run program to generate configuration files
Double click “run.exe” after completing the process above. The configuration files were generated when the “Please click anything to close me” is displayed in the bottom line, just click any key to exit this program, as the picture shown below:

Review the configuration file generated
Enter the folder “out”, all of the configuration files generated are here. Open any one of the configuration files, then check the value of the parameters are the same as the one defined in the “input.xlsx” file, as the picture shown below:

How to create the configuration template

H2X Desk Phone

Access the phone’s WBM, set up all the configurations needed on the WBM directly, then enter “System – Configurations – Export Configurations”, right click the third file and save as “template.xml”, as the picture shown below:
Replace the original “template.xml” file with the downloaded “template.xml” file.
Open the “template.xml” file, find out the parameters that are not common to other phones and replace the original parameter values with $$$variable name $$$. (User can find this parameter by filtering the value of the parameter configured on the WBM.
The new configuration template is created successfully after editing and saving.

H3XH6MX Desk Phone

Access the phone’s WBM, set up all the configurations needed on the WBM directly, then enter “Maintenance – Config File”. If the firmware is 2.12.X or lower and below, please click “Export” to download the configuration file directly, then save as “template.xml”, as the picture shown below: If the firmware is 2.13.X or higher, please choose “All Settings”, then click “Export” to download the configuration file directly, then save as “template.xml”, as the picture shown below:
Replace the original “template.xml” file with the downloaded “template.xml” file.
Open the “template.xml” file, find out the parameters that are not common to all phones and replace the original parameter values with $$$variable name $$$. (User can find this parameter by filtering the value of the parameter configured on the WBM.)
The new configuration template is created successfully after editing and saving.

How to complete mass auto-provisioning

Note: ALE SIP phones support FTP/HTTP/HTTPS protocols to download configuration files, the HTTP method is used as example here.

Install HTTP Server
Download an HTTP Server from internet. HFS as an example, run HFS, then copy configuration files to the Virtual File System area, as the picture shown below:

Auto-provisioning

By EDS
Prerequisites: All the phones can access internet.

Log in EDS, enter Device Management and click “Add” and “Import” button to add phones. The import template can be found in import interface, as the picture shown below:
Enter Profile Management interface, click “Add” button to add profile, then fill in the Profile Name and URL, where the URL is the access URL of HFS, as the picture shown below： Note: Please add “$mac.xml” at the end of the URL if the profile is for H2X, as the picture shown below
Reboot phone, then the phone will connect to EDS automatically and then being redirected to the URL in the bound profile to download the configuration file from HFS automatically to complete deployment.

Note:

If the port of HFS is not 80, please add the port at the end of the URL, such as: http://192.168.3.100:8080.
If the phone has been provisioned before, please restore factory settings to complete deployment automatically.

By DHCP option66/67
Prerequisites: The DHCP Server Option66/67 is available for phone.

Set up the DHCP Option 66/67 value to the URL of HTTP Server installed above.
- The Option66/67 URL format for H2X
- The URL format without username and password: http://192.168.3.100/Smac.xml
- The URL format with username and password: http://user:password@192.168.3.100/$mac.xml
- The Option 66/67 format for H3XH6MX
- The format is “http://192.168.3.100”, the format with username and password is not supported.
  Note : The network model of phone must be dynamic when using DHCP Option 66/67.
Reboot phone, the phone will get a dynamic IP address from DHCP server and the URL from Option 66/67, then the phone will try to download the configuration file from HFS automatically to complete deployment.
Note : If the port of HFS is not 80, please add the port behind the URL, such as: http://192.168.3.100:8080