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

This topic takes Avaya J139 (firmware: 4.1.5.0.6) as an example to describe how to auto provision Avaya IP phone with Yeastar P-Series Software Edition.

Requirements

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

Model Phone Requirement PBX Requirement Supported Auto Provisioning Method
J129 4.1.1.0.7 or later

83.12.0.23 or later
  • DHCP
  • Provision Link
J139 4.1.1.0.7 or later

83.12.0.23 or later
  • DHCP
  • Provision Link
J159 4.1.1.0.7 or later

83.12.0.23 or later
  • DHCP
  • Provision Link
J169 4.1.1.0.7 or later

83.12.0.23 or later
  • DHCP
  • Provision Link
J179 4.1.1.0.7 or later

83.12.0.23 or later
  • DHCP
  • Provision Link
J189 4.1.1.0.7 or later

83.12.0.23 or later
  • DHCP
  • Provision Link
9608 7.1.15.2.1 or later

83.14.0.26 or later
  • DHCP
  • Provision Link
9611G 7.1.15.2.1 or later

83.14.0.26 or later
  • DHCP
  • Provision Link
9641G 7.1.15.2.1 or later

83.14.0.26 or later
  • DHCP
  • Provision Link

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.
  • 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 Avaya IP phone and Yeastar PBX.
    Network Environment Setting
    Local Network Provision an IP phone in the same subnet Set the registration name to the same as the extension number for the extension that will be assigned to the IP phone (Path: Extension and Trunk > Extension > > User > Extension Information).
    Important: Due to the IP phone's limitation, the extension's Registration Name must be the same as the Extension Number; otherwise, the registration will FAIL.
    Provision an IP phone in different subnets
    • Make sure that the two subnets can communicates with each other.
    • Complete the following settings for the extension to be assigned to the IP phone:
      • Set the registration name to the same as the extension number for the extension (Path: Extension and Trunk > Extension > > User > Extension Information).
        Important: Due to the IP phone's limitation, the extension's Registration Name must be the same as the Extension Number; otherwise, the registration will FAIL.

      • Enable the Remote Registration feature for the extension (Path: Extension and Trunk > Extension > > Security > SIP Security > Allow Remote Registration).
    Remote Network Remotely provision an IP phone using Yeastar FQDN
    • Complete the following settings for the extension to be assigned to the IP phone:
      • Set the registration name to the same as the extension number for the extension (Path: Extension and Trunk > Extension > > User > Extension Information).
        Important: Due to the IP phone's limitation, the extension's Registration Name must be the same as the Extension Number; otherwise, the registration will FAIL.

      • 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:
      • Set the registration name to the same as the extension number for the extension (Path: Extension and Trunk > Extension > > User > Extension Information).
        Important: Due to the IP phone's limitation, the extension's Registration Name must be the same as the Extension Number; otherwise, the registration will FAIL.

      • 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 Avaya 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 Avaya.
    • Model: Select the phone model. In this example, select J139.
    • 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 the local network, either in the same subnet or in different subnets.
      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 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.

  7. Set the phone language for the IP phone.
    1. In the Auto Provisioning phone list, click beside the Avaya IP phone.

    2. In the phone configuration page, scroll down to the Preference section, and select the desired phone language based on the phone model.

    3. Click Save.

Step 2. Configure DHCP option 242 on DHCP server

Configure DHCP option 242 to point to the PBX. This allows the Avaya IP phone to automatically retrieve its configuration files from the PBX.

The following instructions take Tftpd64 DHCP server as an example to show how to configure the option 242.

  1. On the running Tftpd64 software, go to Settings > DHCP > DHCP Options.
  2. Add option 242 and define the location of the configuration files.

    1. In the Additional Option field, enter 242.
    2. In the string value field, enter the provisioning link obtained from the PBX according to the selected provisioning method.
      Provisioning Method Instruction
      DHCP Enter the link in the following format:
      HTTPSRVR=192.168.28.39,HTTPDIR=api/autoprovision/lgjnRL8CkoYFXWJd,HTTPPORT=7778,SIG=2
      • HTTPSRVR: The IP address of the PBX.
      • HTTPDIR: The file path on the PBX (e.g. api/autoprovision/lgjnRL8CkoYFXWJd).
      • HTTPPORT: The server port of the PBX.
      • SIG: The software version of the Avaya IP phone. Set the value to 2.
      Provision Link Enter the link in the following format:
      TLSSRVR=yeastardocs.ras.yeastar.com,TLSDIR=api/autoprovision/lgjnRL8CkoYFXWJd,TLSPORT=443,SIG=2
      • TLSSRVR: The public IP address / domain name of the PBX.
      • TLSDIR: The file path on the PBX (e.g. api/autoprovision/lgjnRL8CkoYFXWJd).
      • TLSPORT: The server port of the PBX.
      • SIG: The software version of the Avaya IP phone. Set the value to 2.
  3. Click OK to save the settings.

Results

  • After rebooting the IP phone, 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.

    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.