Auto Provision Cisco IP Phone with Yeastar P-Series Software Edition

This topic describes how to auto provision Cisco IP phone with Yeastar P-Series Software Edition in Local Area Network (LAN), so as to associate the Cisco IP phone with a Yeastar PBX extension.

Requirements

The firmwares of Cisco IP phone and Yeastar PBX meet the following requirements.

Note: Currently, the programmable line key configuration on Cisco 8811 via auto provisioning is NOT supported.
Model Phone Requirement PBX Requirement Supported Auto Provisioning Method
3905 9.4(1)SR3 or later

83.12.0.23 or later
  • DHCP
7821 14.2(1)SR1 or later

83.12.0.23 or later
  • DHCP
7861 SIP78xx.14-2-1-0201-40 or later

83.13.0.29 or later
  • DHCP
7942 SIP42.9-4-2SR3-1S or later

83.12.0.23 or later
  • DHCP
8811 SIP88xx.12-1-1SR1-4 or later

83.13.0.29 or later
  • DHCP
8845 14.2(1)SR1 or later

83.12.0.23 or later
  • DHCP

Scenarios

Yeastar P-Series Software Edition supports to auto provision Cisco IP phone via DHCP method in local network. The provisioning operations vary depending on the network environment of Cisco IP phone and Yeastar PBX.

Auto provision a Cisco IP phone in the same subnet

In this example, the Cisco IP phone, a DHCP server, and the Yeastar PBX (IP: 192.168.28.41) are deployed in subnet 28.

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: Auto Provisioning > Resource Repository > Default Templates).
  • Gather information of IP phone, including Vendor, Model, and MAC address.
  • (Optional) Download your desired language files from Cisco website and upload the language files to the folder tftpboot in the PBX via FTP.
    Note: By default, Cisco IP phone displays in English. If you want it to display in another language after auto provisioning, you can manually upload your language files to PBX.

  • If you want to provision Cisco 7942, in addition to the above prerequisites, you will also need to complete the followings:
    • Download and extract the Cisco 7942 provisioning package, and put the extracted files into the folder tftpboot of the PBX.

    • Disable NAT for the extension on PBX web portal (Path: Extension and Trunk > Extension > > Advanced > VoIP Settings).

Procedure
Step 1. Enable the TFTP feature on PBX
When provisioning a Cisco IP phone, the PBX works as a TFTP server to host the phone's configuration file. You need to enable the TFTP feature on PBX, so that the IP phone can download configurations from the PBX via TFTP.
  1. Log in to PBX web portal, go to System > Storage > File Sharing.
  2. Scroll down to the bottom, turn on the switch of TFTP, then click OK in the pop-up window.
  3. Click Save.
Step 2. Add the Cisco IP phone on PBX

Add the IP phone on PBX. The PBX will generate a configuration file based on the phone's MAC address.

  1. On PBX web portal, go to Auto Provisioning > Phones.
  2. Click Add > Add.
  3. In the IP Phone section, enter the following phone information.

    • Vendor: Select Cisco.
    • Model: Select the phone model.
    • MAC Address: Enter the MAC address of the IP phone.
  4. 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).

      A provisioning link is automatically generated and displayed in the Provisioning Link field. This provisioning link points to the location where the phone's configuration file is stored.

  5. 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.
  6. Click Save.
Step 3. Configure DHCP option 66 on DHCP server
Configure the DHCP option 66 on the DHCP server to deliver the PBX's IP address.

The configuration examples are shown below:

Figure 1. Configure option 66 on the Tftpd64's DHCP server
Figure 2. Configure option 66 on a router's DHCP server
Step 4. (Optional) Reset the Cisco IP phone
If the IP phone is to be deployed for a new user, you need to reset the phone to its default settings to ensure that the configurations from the previous user are removed from the phone.
  1. On the IP phone, press the button.
  2. On the IP phone screen, go to Admin settings > Reset settings > All settings.
  3. Select Reset when the phone prompts for confirmation.
Result
  • After boot-up, the IP phone gets an IP address from the DHCP server, downloads configurations from the PBX via TFTP protocol, and applies the settings automatically.
  • The extension is successfully registered on the IP phone. You can check the registration status on Auto Provisioning > Phone on the PBX web portal.

Auto provision a Cisco IP phone in different subnets

In this example, the Cisco IP phone and DHCP server are deployed in subnet 20, while the Yeastar PBX (IP address: 192.168.28.41) is deployed in subnet 28.

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 the IP phone and PBX can communicate with each other over the subnets.
  • Make sure that you have downloaded the template for the desired phone model (Path: Auto Provisioning > Resource Repository > Default Templates).
  • Gather information of IP phone, including Vendor, Model, and MAC address.
  • (Optional) Download your desired language files from Cisco website and upload the language files to the folder tftpboot in the PBX via FTP.
    Note: By default, Cisco IP phone displays in English. If you want it to display in another language after auto provisioning, you can manually upload your language files to PBX.

  • If you want to provision Cisco 7942, you will also need to download and extract the Cisco7942 provisioning package, and put the extracted files into the folder tftpboot of the PBX.

Procedure
Step 1. Enable the TFTP feature on PBX
When provisioning a Cisco IP phone, the PBX works as a TFTP server to host the phone's configuration file. You need to enable the TFTP feature on PBX, so that the IP phone can download configurations from the PBX via TFTP.
  1. Log in to PBX web portal, go to System > Storage > File Sharing.
  2. Scroll down to the bottom, turn on the switch of TFTP, then click OK in the pop-up window.
  3. Click Save.
Step 2. Enable the 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.
  1. Log in to PBX web portal, go to Extension and Trunk > Extension, edit the desired extension.
  2. If you want to provision Cisco 7942, click the Advanced tab, then unselect the checkbox of NAT in the VoIP Settings section.

  3. Click the Security tab, select the checkbox of Allow Remote Registration in the SIP Security section.

  4. Click Save and Apply.
Step 3. Add the Cisco IP phone on PBX

Add the IP phone on PBX. The PBX will generate a configuration file based on the phone's MAC address.

  1. On PBX web portal, go to Auto Provisioning > Phones.
  2. Click Add > Add.
  3. In the IP Phone section, enter the following phone information.

    • Vendor: Select Cisco.
    • Model: Select the phone model.
    • MAC Address: Enter the MAC address of the IP phone.
  4. 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).

      A provisioning link is automatically generated and displayed in the Provisioning Link field. This provisioning link points to the location where the phone's configuration file is stored.

  5. 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.
  6. Click Save.
Step 4. Configure DHCP option 66 on DHCP server
Configure the DHCP option 66 on the DHCP server to deliver the PBX's IP address.

The configuration examples are shown below:

Figure 3. Configure option 66 on the Tftpd64's DHCP server
Figure 4. Configure option 66 on a Router's DHCP server
Step 5. (Optional) Reset the Cisco IP phone
If the IP phone is to be deployed for a new user, you need to reset the phone to its default settings to ensure that the configurations from the previous user are removed from the phone.
  1. On the IP phone, press the button.
  2. On the IP phone screen, go to Admin settings > Reset settings > All settings.
  3. Select Reset when the phone prompts for confirmation.
Result
  • After boot-up, the IP phone gets an IP address from the DHCP server, downloads configurations from the PBX via TFTP protocol, and applies the settings automatically.
  • The extension is successfully registered on the IP phone. You can check the registration status on Auto Provisioning > Phone on the PBX web portal.