Auto Provision Avaya IP Phone with Yeastar P-Series Software Edition
This topic takes Avaya J139 (firmware: 4.1.1.0.7) as an example to describe how to auto provision Avaya IP phone with Yeastar P-Series Software Edition in Local Area Network (LAN).
Requirements
The firmwares of Avaya IP phone and Yeastar PBX meet the following requirements.
Model | Phone Requirement | PBX Requirement | Supported Auto Provisioning Method |
---|---|---|---|
J129 | 4.1.1.0.7 or later |
83.12.0.23 or later |
|
J139 | 4.1.1.0.7 or later |
83.12.0.23 or later |
|
J159 | 4.1.1.0.7 or later |
83.12.0.23 or later |
|
J169 | 4.1.1.0.7 or later |
83.12.0.23 or later |
|
J179 | 4.1.1.0.7 or later |
83.12.0.23 or later |
|
J189 | 4.1.1.0.7 or later |
83.12.0.23 or later |
|
9608 | 7.1.15.2.1 or later |
83.14.0.26 or later |
|
Scenarios
Auto provision an Avaya IP phone in the same subnet
In this example, the Avaya IP phone, a DHCP server, and Yeastar PBX (IP:
192.168.28.39
) are deployed in subnet 28. Additionally, an HTTP
server is set up on a PC located in the same subnet, which is used to host the
phone's configuration files.
- Prerequisites
-
- Make sure that there is only one DHCP server running in the subnet, or the IP phone would fail to obtain an IP address.
- Make sure that you have downloaded the template for the desired phone model (Path: ).
- Gather information of IP phone, including Vendor, Model, and MAC address.
- Set the registration name to the same as the extension number for the extension that will be assigned to the IP phone (Path: ).
- Prepare an HTTP server on a PC that is located
in the same subnet as the Avaya IP phone.Note: In this example, an HFS (HTTP File Server) is used.
- Procedure
- Step 1. Add the Avaya IP phone on PBX
Add the IP phone on PBX. The PBX will generate a configuration file based on the phone's MAC address. You need to download the phone's configuration file from the PBX for later use.
- Add the Avaya IP phone.
- Log in to PBX web portal, go to .
- Click .
- In the IP Phone section, enter
the following phone information.
- Vendor: Select Avaya.
- Model: Select the phone model. In this example, select J139.
- MAC Address: Enter the MAC address of the IP phone.
- In the Options section, configure
the following settings.
- Template: Select a desired template
from the drop-down list.Note: You can select the default template corresponding to the phone model, or customize your own template. For more information, see Create a Custom Auto Provisioning Template.
- Provisioning Method: Select DHCP (In the Office).
- Template: Select a desired template
from the drop-down list.
- In the Assign Extension
section, assign an extension to the IP phone.Note: If your desired extension is not listed in the drop-down list, it indicates that the extension has been associated with an IP phone or gateway.
- To release the extension from the associated IP phone or gateway, see Release an Extension from a Provisioned IP Phone/Gateway.
- To assign the extension to the phone without releasing it from the previously associated device, you can configure the concurrent registration setting for the extension, as the PBX only allows an extension to register with one SIP endpoint by default.
- Click Save.
The IP phone is added and displayed in the Auto Provisioning phone list.
- Set
the phone language for the IP
phone.
- In the Auto Provisioning phone list, click beside the Avaya IP phone.
- In the phone configuration page, scroll down to the Preference section, and select the desired phone language based on the phone model.
- Click Save.
- Download the phone's configuration file onto
your PC.
- Click beside the Avaya IP phone.
- In the drop-down list, click Download to download the phone's configuration file.
- Add the Avaya IP phone.
- Step 2. Set up HTTP server on PC
- Yeastar has prepared a provisioning package to provision Avaya IP
phones. You need to download the package and mount the required files in an
HTTP server on your PC. In this example, an HFS is used as the HTTP server.
- Download the provisioning
package onto the PC, then extract the package.
The provisioning package contains all the files necessary to provision the Avaya IP phone, where you can mount the files of the corresponding phone model in the HTTP server.
- On the running HTTP server (HFS), mount the following files to
the root directory
/
.- The following files obtained from the provisioning
package.
- Setting file:
46xxsettings.txt
- Upgrade file:
J100Supgrade.txt
- Firmware file: Choose the firmware file
based on the phone model. In this example, choose
FW_S_J139_R4_1_1_0_7.bin
. - Language file: Choose the desired
language file based on the phone model. In this
example, choose
Mlf_J139_English.xml
.
- Setting file:
- The phone's configuration file {mac}.txt downloaded from PBX.
- The following files obtained from the provisioning
package.
- Download the provisioning
package onto the PC, then extract the package.
- Step 3. Configure DHCP option 242 on DHCP server
- Configure DHCP option 242 to point to the HTTP server. In this way,
the Avaya IP phone can automatically retrieve its configuration files from
the HTTP server. The following instructions take Tftpd64 DHCP server as an
example to show how to configure the option 242.
- On the running Tftpd64 software, go to .
- Add option 242 and define the location of the configuration
files.
- In the Additional Option field, enter 242.
- In the string value field, enter the HTTP server address
at the following
format:
HTTPSRVR=192.168.28.25,HTTPDIR=,HTTPPORT=80,SIG=2
- HTTPSRVR: The IP address of the PC where the HTTP server is running.
- HTTPDIR: The path of the mounted files in the HTTP server. In this example, leave it blank as the files are mounted in the root directory.
- HTTPPORT: The port of the HTTP server. In
this example, enter the default port is 80.Tip: You can check the port, or specify a port as needed in the HFS software.
- SIG: The software version of the Avaya IP phone. Set the value to 2.
- Step 4. Trigger the IP phone to complete provisioning
-
Reset the IP phone to complete provisioning.
- On the phone screen, access the Admin menu and reset the IP
phone to factory default.
- On the IP phone, go to .
- In the Access code field, enter
the
administrator
password, then press
Enter. In this
example, enter the default password
27238
. - In the Admin menu, select Reset to defaults, then select Reset when the phone prompts for confirmation.
- Select No to proceed.
The IP phone goes on searching for DHCP server for network configuration, which will take about 2-3 minutes.
- On the phone screen, access the Admin menu and reset the IP
phone to factory default.
- Result
-
- The IP phone automatically downloads configurations from the HTTP server, and applies the settings.
- The extension is successfully registered on the IP phone. You can check the registration status on on the PBX web portal.
Auto provision an Avaya IP phone in different subnets
In this example, the Avaya IP phone and DHCP server are deployed in subnet 28, while
the Yeastar PBX (IP: 192.168.20.58
) is deployed in subnet 20.
Additionally, an HTTP server is set up on a PC located in the same subnet as the IP
phone, which is used to host the phone's configuration files.
- Prerequisites
-
- Make sure that there is only one DHCP server running in the subnet where the IP phone is deployed, or the IP phone would fail to obtain an IP address.
- Make sure that you have downloaded the template for the desired phone model (Path: ).
- Gather information of IP phone, including Vendor, Model, and MAC address.
- Set the registration name to the same as the extension number for the extension that will be assigned to the IP phone (Path: ).
- Prepare an HTTP server on a PC that is located
in the same subnet as the Avaya IP phone.Note: In this example, an HFS (HTTP File Server) is used.
- Procedure
- Step 1. Enable Remote Registration feature for the extension on PBX
- Enable the Remote Registration feature for the extension to be assigned to the phone, so that the extension can be registered in a different subnet.
- Step 2. Add the Avaya IP phone on PBX
-
Add the IP phone on PBX. The PBX will generate a configuration file based on the phone's MAC address. You need to download the phone's configuration file from the PBX for later use.
- Step 3. Set up HTTP server on PC
- Yeastar has prepared a provisioning package to provision Avaya IP
phones. You need to download the package and mount the required files in an
HTTP server on your PC. In this example, an HFS is used as the HTTP server.
- Download the provisioning
package onto the PC, then extract the package.
The provisioning package contains all the files necessary to provision the Avaya IP phone, where you can mount the files of the corresponding phone model in the HTTP server.
- On the running HTTP server (HFS), mount the following files to
the root directory
/
.- The following files obtained from the provisioning
package.
- Setting file:
46xxsettings.txt
- Upgrade file:
J100Supgrade.txt
- Firmware file: Choose the firmware file
based on the phone model. In this example, choose
FW_S_J139_R4_1_1_0_7.bin
. - Language file: Choose the desired
language file based on the phone model. In this
example, choose
Mlf_J139_English.xml
.
- Setting file:
- The phone's configuration file {mac}.txt downloaded from PBX.
- The following files obtained from the provisioning
package.
- Download the provisioning
package onto the PC, then extract the package.
- Step 4. Configure DHCP option 242 on DHCP server
- Configure DHCP option 242 to point to the HTTP server. In this way,
the Avaya IP phone can automatically retrieve its configuration files from
the HTTP server. The following instructions take Tftpd64 DHCP server as an
example to show how to configure the option 242.
- On the running Tftpd64 software, go to .
- Add option 242 and define the location of the configuration
files.
- In the Additional Option field, enter 242.
- In the string value field, enter the HTTP server address
at the following
format:
HTTPSRVR=192.168.28.25,HTTPDIR=,HTTPPORT=80,SIG=2
- HTTPSRVR: The IP address of the PC where the HTTP server is running.
- HTTPDIR: The path of the mounted files in the HTTP server. In this example, leave it blank as the files are mounted in the root directory.
- HTTPPORT: The port of the HTTP server. In
this example, enter the default port is 80.Tip: You can check the port, or specify a port as needed in the HFS software.
- SIG: The software version of the Avaya IP phone. Set the value to 2.
- Step 5. Trigger the IP phone to complete provisioning
-
Reset the IP phone to complete provisioning.
- On the phone screen, access the Admin menu and reset the IP
phone to factory default.
- On the IP phone, go to .
- In the Access code field, enter
the
administrator
password, then press
Enter. In this
example, enter the default password
27238
. - In the Admin menu, select Reset to defaults, then select Reset when the phone prompts for confirmation.
- Select No to proceed.
The IP phone goes on searching for DHCP server for network configuration, which will take about 2-3 minutes.
- On the phone screen, access the Admin menu and reset the IP
phone to factory default.
- Result
-
- The IP phone automatically downloads configurations from the HTTP server, and applies the settings.
- The extension is successfully registered on the IP phone. You can check the registration status on on the PBX web portal.