Auto Provision Snom IP Phone with Yeastar P-Series PBX System

This topic takes Snom D865 (firmware: 10.1.137.15) as an example to introduce how to provision a Snom IP phone with Yeastar P-Series PBX System.

Requirements

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


Model	Phone Requirement	PBX Requirement	Supported Auto Provisioning Method
D120	10.1.54.13 or later	37.4.0.17 or later	PnP DHCP RPS
D140	10.1.148.1 or later	37.12.0.33 or later	PnP DHCP RPS
D150	10.1.148.1 or later	37.12.0.33 or later	PnP DHCP RPS
D315	10.1.73.16 or later	37.4.0.17 or later	PnP DHCP RPS
D335	10.1.73.16 or later	37.4.0.17 or later	PnP DHCP RPS
D385	10.1.73.16 or later	37.4.0.17 or later	PnP DHCP RPS
D713	10.1.73.16 or later	37.6.0.46 or later	PnP DHCP RPS
D717	10.1.73.16 or later	37.4.0.17 or later	PnP DHCP RPS
D735	10.1.73.16 or later	37.4.0.17 or later	PnP DHCP RPS
D785	10.1.73.16 or later	37.4.0.17 or later	PnP DHCP RPS
D862	10.1.137.15 or later	37.9.0.22 or later	PnP DHCP RPS
D865	10.1.137.15 or later	37.9.0.22 or later	PnP DHCP RPS
M100 KLE	1.0.5.7 or later	37.14.0.24 or later	PnP DHCP RPS
M500	1.12.2 or later	37.14.0.24 or later	PnP DHCP RPS
M300	BSV530B2 or later	37.8.0.25 or later	PnP DHCP RPS
M400	BSV610B5 or later	37.8.0.25 or later	PnP DHCP RPS
M900	BSV530B7 or later	37.8.0.25 or later	PnP DHCP RPS

Scenarios

The provisioning process can be different depending on the network environment of Snom IP phone and Yeastar PBX, as the following table shows:


Scenario	Description
IP phone and PBX are in the SAME subnet (LAN)	In this scenario, you can directly provision the Snom IP phone via PnP method. For more information, see Auto provision a Snom IP phone in the same subnet (PnP).
IP phone and PBX are in DIFFERENT subnets (LAN)	In this scenario, you can provision the Snom IP phone using a third-party DHCP server via DHCP method. For more information, see Auto provision a Snom IP phone in different subnets (DHCP).
IP phone and PBX are in DIFFERENT network	In this scenario, you can provision the Snom IP phone remotely via RPS method. For more information, see Auto provision a Snom IP phone in remote network (RPS).

Auto provision a Snom IP phone in the same subnet (PnP)

In this example, the Snom IP 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

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.
Click beside the Snom IP phone.
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.
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.

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.

Auto provision a Snom IP phone in different subnets (DHCP)

In this example, the Snom 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 Snom 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.

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

Step 2. Add the Snom IP phone on PBX

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

On PBX web portal, go to Auto Provisioning > Phones.
Click Add > Add.
In the IP Phone section, enter the following phone information.
- Vendor: Select Snom.
- Model: Select the phone model. In this example, select snomD865.
- 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).
  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.
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.

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.

On PBX web portal, copy the provisioning link from the phone's detail page.
On the DHCP server, set up option 66 by entering the provisioning link followed by the configuration file name of the phone (mac.xml), as the following example shows:
```
http://192.168.20.58:7778/api/autoprovision/KZVJ3gwHjecazEQB/00abxxxxxxc2.xml
```
Note:
- The letters in the MAC address must be in lowercase.
- If you need to provision multiple Snom IP phones, you can directly use a placeholder {mac} in the configuration file name. For example:
```
http://192.168.20.58:7778/api/autoprovision/KZVJ3gwHjecazEQB/{mac}.xml
```
In this example, the configuration on a router's DHCP server for provisioning a single Snom IP phone 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 a Snom IP phone in remote network (RPS)

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

Prerequisites

Yeastar P-Series PBX System supports to auto provision a Snom 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 Snom IP phone on PBX
Step 2. Trigger the IP phone to complete provisioning

Step 1. Add the Snom IP phone on PBX

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

Log in to PBX web portal, go to Auto Provisioning > Phones.
Click Add > Add.
In the IP Phone section, enter the following phone information.
- Vendor: Select Snom.
- Model: Select the phone model. In this example, select snomD865.
- MAC Address: Enter the MAC address of the IP phone.
In the Option section, configure the following settings.

Figure 1. RPS using Yeastar FQDN

Figure 2. RPS using Public IP Address / External Host domain name
- 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.
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 PBX will send an event notification of RPS Request Success.

Step 2. Trigger the IP phone to complete provisioning

Reboot the IP phone.
If you have enabled Authentication for the First-time Auto Provisioning on the PBX, enter the authentication credential on the IP phone.
- Login ID: 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.