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

Requirements

The firmwares of Htek IP Phone and Yeastar PBX meet the following requirements.

Scenarios

The provisioning methods and operations vary depending on the network environment of Htek IP Phone and Yeastar PBX, as the following table shows.

Auto provision an Htek IP phone in the same subnet (PnP)

In this example, the Htek IP phone (IP: 192.168.28.193) and the Yeastar PBX (IP: 192.168.28.39) are both deployed in subnet 28.

Auto provision an Htek IP phone in the different subnets (DHCP)

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

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).
• RESET the IP phone if it is previously used.
• Gather information of IP phone, including Vendor, Model, and MAC address.

Procedure

• Step 1. Enable Remote Registration feature for the extension on PBX
• Step 2. Add the Htek IP phone on PBX
• Step 3. Configure DHCP option 66 on DHCP server

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.

1. Log in to PBX web portal, go to Extension and Trunk > Extension, edit the desired extension.
2. Click Security tab, select the checkbox of Allow Remote Registration in the SIP Security section.

   

3. Click Save and Apply.

Step 2. Add the Htek IP phone on PBX

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 Htek.
   • Model: Select the phone model. In this example, select UC921G.
   • 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.

   • 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.
6. Click Save.

Step 3. Configure DHCP option 66 on DHCP server

In the subnet where the IP phone is deployed, use the generated provisioning link to configure option 66 on the DHCP Server.

1. On PBX web portal, copy the provisioning link from the phone's detail page.

   

2. On the DHCP server, set up option 66 with the provisioning link.

   In this example, the configuration on a router's DHCP server is shown below.

   

Result

Note: Some IP phones will reboot automatically. If not, you need to manually reboot the phone to make the configurations take effect.

• After the IP phone is rebooted, it gets an IP address from the DHCP server, downloads the configurations from the PBX via the provisioning link, 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 an Htek IP phone in remote network (RPS)

In this example, the Htek IP phone and the Yeastar PBX are deployed in different network.

Prerequisites

Yeastar P-Series Software Edition supports to auto provision an Htek phone remotely either using Yeastar FQDN or using Public IP address / External Host domain name. According to the provisioning method you intend to use, make sure that you have completed the corresponding setup shown below.

Method	Setting
Using Yeastar FQDN	Subscribe to Enterprise Plan or Ultimate Plan for the PBX. Grant remote access permission for extension to be registered and the remote IP phones: Grant remote SIP access permission for the extension, so that the extension can be registered remotely via FQDN (Path: System > Network > Yeastar FQDN > Features > SIP Access). If you have enabled IP restriction for Yeastar FQDN remote Web access, make sure that you have added the phone's IP address to the permitted IP list, so that the phone can obtain configuration files from the PBX (Path: System > Network > Yeastar FQDN > Features > Remote Access > Web Access). 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). RESET the IP phone if it is previously used. Gather information of IP phone, including Vendor, Model, and MAC address.
Using Public IP address / External Host domain name	Configure PBX network for remote access by a public IP address or by an external host domain name. Important: The following PBX ports MUST be forwarded for RPS provisioning. RTP ports SIP port Web Server port Set up the extension for remote registration. Enable NAT for the extension (Path: Extension and Trunk > Extension > > Advanced > VoIP Settings > NAT). Enable Remote Registration feature for the extension (Path: Extension and Trunk > Extension > > Security > SIP Security > Allow Remote Registration). 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). RESET the IP phone if it is previously used. Gather information of IP phone, including Vendor, Model, and MAC address.

Procedure

• Step 1. Add the Htek IP phone on PBX
• Step 2. Trigger the IP phone to complete provisioning

Step 1. Add the Htek IP phone on PBX

1. Log in to 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 Htek.
   • Model: Select the phone model. In this example, select UC921G.
   • 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 RPS FQDN (Remote) or RPS (Remote) according to your need.

     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.

   • Authentication for the First-time Auto Provisioning: If enabled, users are requested to fill in authentication information on the IP phones before triggering the first-time provisioning.
     Note: We recommend that you keep this option selected.
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.

   • 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.
6. Click Save.

   The PBX will send an event notification of RPS Request Success.

Step 2. Trigger the IP phone to complete provisioning

1. Reboot the IP phone.
2. If you have enabled Authentication for the First-time Auto Provisioning on the PBX, enter the authentication credential on the IP phone.

   

   • User Name: Enter the extension number that is assigned to the phone.
   • Password: Enter the extension's Voicemail Access PIN.
     Tip: You can check the Voicemail Access PIN in the Voicemail tab on the extension's configuration page.

     

Result

• The IP phone automatically downloads the configurations from the PBX and applies the settings.
• The extension is successfully registered on the IP phone. You can check the registration status on Auto Provisioning > Phone on the PBX web portal.