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

Requirements

Scenarios

According to the network environment of Cisco IP phone and Yeastar PBX, you can auto provision IP phones using the PBX's built-in DHCP server or a third-party DHCP server, as the following table shows.

Auto provision a Cisco IP phone in the same subnet

Prerequisites

• Make sure that you have downloaded the template for the desired phone model (Path: Auto Provisioning > Resource Repository > Default Templates).
• Make sure that no DHCP server is active on the same subnet as the IP phone.
• RESET the IP phone if it is previously used.
• Gather information of IP phone, including Vendor, Model, and MAC address.

Procedure

• Step 1. Set the PBX as a DHCP server
• Step 2. Add the Cisco IP phone on PBX

Step 1. Set the PBX as a DHCP server

1. Log in to PBX web portal, go to System > Network, click DHCP Server tab.
2. Turn on the DHCP Server, and complete the following network configurations.
   

   • Gateway: Specify the IP address of the default gateway for the DHCP server.
   • Subnet Mask: Specify the subnet mask used to subdivide your IP address.
   • Preferred DNS Server: Specify a DNS server for the DHCP server.
   • Alternative DNS Server: Optional. Specify a secondary DNS server for the DHCP server.
   • DHCP Address Range: Specify the IP address range that will be allocated to DHCP clients.
   • NTP Server: Enter the IP address of an NTP server.
     Note: The default value is the IP address of the PBX, which can synchronize the network time of the client devices with the PBX.
3. Click Save.

   The Status field displays Running, indicating the DHCP server is running.

   

Step 2. Add the Cisco 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 Cisco.
   • Model: Select a phone model. In this example, select SPA502G.
   • 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 extension(s) to the phone, then specify which extension's phonebook and function keys you want to use on the phone.
   Tip: If your desired extension is not listed in the drop-down list of the Extension column, it indicates that the devices registered to the extension has reached the limit. You can use either of the following methods to proceed.

   • To release the extension from the associated IP phone or gateway, see Release an Extension from a Provisioned IP Phone/Gateway.
   • To raise the phone registration limit, you need to configure the concurrent registration setting for the extension, as the PBX only allows an extension to register with one SIP endpoint by default.
   • To assign a single extension to the phone, select a desired extension from the drop-down list beside SIP1.

     Both the Phonebook Line and Function Key Line fields are set to SIP1 by default, indicating that the phone will use the authorized phonebook(s) and function keys of the extension assigned to the SIP line 1.

     

   • To assign multiple extensions to the phone, complete the following settings.

     

     1. In the drop-down list beside SIP1, select a desired extension for SIP line 1.
     2. Click Add, then select a desired SIP line and an extension for the added entry.
        To assign more extensions to the phone, repeat this step.

        Note: The selected SIP lines must be supported by the phone, otherwise the configurations for unsupported SIP line will not be applied. You can check the phone's supported SIP lines via the phone webpage or on the device screen.
     3. In the Phonebook Line drop-down list, select a SIP line. The phone book of extension assigned to the SIP line will be applied to the phone.
        Note: After successful registration, contacts are available regardless of which SIP line is currently active on the phone.
     4. In the Function Key Line drop-down list, select a SIP line. The function keys of extension assigned to the SIP line will be applied to the phone.
        Note: After successful registration, the function keys take effect only when the selected SIP line is active on the phone.
6. 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.

• After the phone is rebooted, it gets an IP address from the PBX built-in DHCP server, download the configurations from the PBX and applies the settings automatically.
• The extension is successfully registered on the IP phone. You can check the extension registration status on Auto Provisioning > Phones on the PBX web portal.

  

  Note: If the status displays , this indicates that you assigned multiple extensions to the IP phone but only some of them are successfully registered on the phone. You can hover over to view the registration status of each extension.

  

• If multiple extensions are successfully registered on the phone, corresponding SIP lines are associated with different physical line keys on the device.

  You can press a line key to activate the target SIP line. The corresponding indicator LED illuminates, and all calls are processed over this SIP line.

Auto provision a Cisco IP phone in different subnets (within the same LAN) or different networks

Prerequisites

• Make sure that there is only one DHCP server running in the same subnet as the IP phone, or the IP phone would fail to obtain an IP address.
• RESET the IP phone if it is previously used.
• Gather information of IP phone, including Vendor, Model, and MAC 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 Cisco IP phone and Yeastar PBX.

  Network Environment		Setting
  IP Phone and PBX are in DIFFERENT subnets (within the same LAN)		Make sure that the two subnets can communicates with each other. Enable the Remote Registration feature for the extension (Path: Extension and Trunk > Extension > > Security > SIP Security > Allow Remote Registration).
  IP Phone and PBX are in DIFFERENT networks	Remotely provision an IP phone using Yeastar FQDN	Grant remote SIP access permission for the extension (Path: System > Network > Yeastar FQDN > Features > SIP Access).
  	Remotely provision an IP phone using public IP address / 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 Complete the following settings for the extension to be assigned to the IP phone: Enable NAT for the extension (Path: Extension and Trunk > Extension > > Advanced > VoIP Settings > NAT). Enable the Remote Registration feature for the extension (Path: Extension and Trunk > Extension > > Security > SIP Security > Allow Remote Registration).

Procedure

• Step 1. Add the Cisco IP phone on PBX
• Step 2. Configure DHCP option 66 on DHCP server

Step 1. 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. 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 Cisco.
   • Model: Select a phone model. In this example, select SPA502G.
   • 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 the provisioning method according to your needs.

     Provisioning Method	Description
     DHCP (In the Office)	Suitable for provisioning the IP phone that is located in different subnets within the same LAN.
     Provision Link (Remote)	Suitable for provisioning the IP phone located in a remote network, and the IP phone will access the PBX using public IP address / domain name to retrieve configuration files.
     Provision Link - FQDN (Remote)	Suitable for provisioning the IP phone located in a remote network, and the IP phone will access the PBX using Yeastar FQDN to retrieve configuration files.

     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.

     Note: Note down the provisioning link, as you will use it later.
5. In the Assign Extension section, assign extension(s) to the phone, then specify which extension's phonebook and function keys you want to use on the phone.
   Tip: If your desired extension is not listed in the drop-down list of the Extension column, it indicates that the devices registered to the extension has reached the limit. You can use either of the following methods to proceed.

   • To release the extension from the associated IP phone or gateway, see Release an Extension from a Provisioned IP Phone/Gateway.
   • To raise the phone registration limit, you need to configure the concurrent registration setting for the extension, as the PBX only allows an extension to register with one SIP endpoint by default.
   • To assign a single extension to the phone, select a desired extension from the drop-down list beside SIP1.

     Both the Phonebook Line and Function Key Line fields are set to SIP1 by default, indicating that the phone will use the authorized phonebook(s) and function keys of the extension assigned to the SIP line 1.

     

   • To assign multiple extensions to the phone, complete the following settings.

     

     1. In the drop-down list beside SIP1, select a desired extension for SIP line 1.
     2. Click Add, then select a desired SIP line and an extension for the added entry.
        To assign more extensions to the phone, repeat this step.

        Note: The selected SIP lines must be supported by the phone, otherwise the configurations for unsupported SIP line will not be applied. You can check the phone's supported SIP lines via the phone webpage or on the device screen.
     3. In the Phonebook Line drop-down list, select a SIP line. The phone book of extension assigned to the SIP line will be applied to the phone.
        Note: After successful registration, contacts are available regardless of which SIP line is currently active on the phone.
     4. In the Function Key Line drop-down list, select a SIP line. The function keys of extension assigned to the SIP line will be applied to the phone.
        Note: After successful registration, the function keys take effect only when the selected SIP line is active on the phone.
6. Click Save.

   The IP phone is added and displayed in the Auto Provisioning phone list.

Step 2. Configure DHCP option 66 on DHCP server

On the DHCP server in the same subnet as the IP phone, use the provisioning link obtained from Yeastar P-Series Software Edition to configure option 66 on the DHCP Server.

In this example, the configuration is shown below.

Results

• 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 extension registration status on Auto Provisioning > Phones on the PBX web portal.

  

  Note: If the status displays , this indicates that you assigned multiple extensions to the IP phone but only some of them are successfully registered on the phone. You can hover over to view the registration status of each extension.

  

• If multiple extensions are successfully registered on the phone, corresponding SIP lines are associated with different physical line keys on the device.

  You can press a line key to activate the target SIP line. The corresponding indicator LED illuminates, and all calls are processed over this SIP line.