Auto Provision Flat-phone with Yeastar P-Series PBX System

This topic takes Flat-phone B10 (firmware: 15.66.7.12.234) as an example to describe how to auto provision Flat-phone with Yeastar P-Series PBX System.

Requirements

The firmwares of Flat-phone and Yeastar PBX meet the following requirements.

Model Phone Requirement PBX Requirement Supported Auto Provisioning Method
B6 15.63.11.12.234 or later 37.19.0.110 or later
  • PnP
  • DHCP
  • Provision Link
B10 15.66.7.12.234 or later 37.19.0.110 or later
  • PnP
  • DHCP
  • Provision Link
C10 15.60.11.12.234 or later 37.19.0.110 or later
  • PnP
  • DHCP
  • Provision Link

Scenarios

The provisioning methods and operations vary depending on the network environment of Flat-phone and Yeastar PBX, as the following table shows.

Scenario Description
IP Phone and PBX are in the SAME subnet In this scenario, you can provision the Flat-phone with the PBX via PnP method.

For more information, see Auto provision a Flat-phone in the same subnet (PnP).

IP Phone and PBX are in DIFFERENT subnets In this scenario, you can provision the Flat-phone with the PBX via DHCP method.

For more information, see Auto provision a Flat-phone in different subnets (DHCP).

IP Phone and PBX are in DIFFERENT networks In this scenario, you can provision the Flat-phone with Yeastar PBX via Provision Link method.

For more information, see Provision a Flat-phone in different networks (Provision Link).

Auto provision a Flat-phone in the same subnet (PnP)

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

Prerequisites
  • Make sure that you have downloaded the template for the desired phone model (Path: Auto Provisioning > Resource Repository > Default Templates).
  • If the IP phone is previously used, you need to RESET the IP phone, then re-configure the network settings for the phone.
Procedure
  1. Log in to PBX web portal, go to Auto Provisioning > Phones.

    The IP phones detected by the PBX via PnP are displayed in the phone list.

  2. Click beside the Flat-phone.

  3. Optional: In the Options section, select a desired template from the Template 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.
  4. 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.
  5. Click Save.
Result
Note: Some IP phones will reboot automatically. If not, you need to manually reboot the phone to make the configurations take effect.
  • 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 in PBX web portal.

Auto provision a Flat-phone in different subnets (DHCP)

In this example, the Flat-phone and DHCP server are deployed in subnet 20, while the Yeastar PBX (IP: 192.168.28.110) 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).
  • 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
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 Flat-phone on the 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, configure phone information as follows:
    • Vendor: Select Flat-Phone.
    • Model: Select a phone model. In this example, select B10.
    • 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

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 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.

Provision a Flat-phone in different networks (Provision Link)

In this example, the Flat-phone and the Yeastar PBX are deployed in different networks. A DHCP server is set up in the IP phone’s network to deliver the provisioning link (obtained from the PBX) to the phone.
Note: This method is suitable for bulk provisioning. For a single device, you can manually enter the provision link in the phone's web interface.
Prerequisites
  • Set up a DHCP server in the same subnet as the IP phone to assign it an IP address.
    Note: 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).
  • Make sure that you have completed the corresponding settings shown below according to the network environment of Flat-phone and Yeastar PBX.
    Method Setting
    Using Yeastar FQDN
    • Subscribe to Enterprise Plan or Ultimate Plan for the PBX and ensure the FQDN is available.

    • Grant remote access permission for extension to be registered and the remote IP phones:
    • 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 / Yeastar domain name
    • Configure PBX network for remote access by a public IP address, by an external host domain name, or by a Yeastar 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 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 Flat-phone on PBX

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

  1. Log in to PBX web portal, go to Auto Provisioning > Phones.
  2. Click Add > Add.
  3. In the IP Phone section, configure phone information as follows:
    • Vendor: Select Flat-Phone.
    • Model: Select a phone model. In this example, select B10.
    • 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 Provision Link - FQDN (Remote) or Provision Link (Remote).
      The Provisioning Link field displays a provisioning link, which points to the location where the phone's configuration file is stored.
      Note: Note down the provisioning link, as you will need to use it later when configuring the DHCP server.
  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 2. 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 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.