Table of Contents iii
Table of Contents Table of Contents Table of Contents .......................................................................... iii Summary of Changes ..................................................................... 1 Changes for Release 81, Guide Version 81.70 .............................................................................................. 1 Introduction.................................................................................... 1 Getting Started ..............................
Yealink IP Phones Auto Provisioning Guide Zero Touch............................................................................................................................................................... 25 Plug and Play (PnP) Server ................................................................................................................................ 26 DHCP Options ............................................................................................................................
Summary of Changes Summary of Changes This section describes the changes to this guide for each release and guide version. Changes for Release 81, Guide Version 81.70 Documentations of the newly released W56P/W52P/SIP-T58V/T58A/T56A/T40G IP phones have been added.
Yealink IP Phones Auto Provisioning Guide 2
Introduction Introduction Yealink IP phones are full-featured telephones that can be plugged directly into an IP network and can be used easily without manual configuration. This guide provides instructions on how to provision Yealink IP phones with the minimum settings required. Yealink IP phones support FTP, TFTP, HTTP, and HTTPS protocols for auto provisioning and are configured by default to use the TFTP protocol.
Yealink IP Phones Auto Provisioning Guide 2
Getting Started Getting Started This section provides instructions on how to get ready for auto provisioning. To begin the auto provisioning process, the following steps are required: Obtaining the Boot File Obtaining Configuration Files Obtaining Phone Information Obtaining the Boot File You can use a boot file to customize the download sequence of configuration files.
Yealink IP Phones Auto Provisioning Guide required. If boot file is not found on the provisioning server, IP phones download the common CFG file first, and then the MAC-Oriented CFG file during auto provisioning – i.e., the old mechanism for auto provisioning. You can select whether to use the boot file or not for auto provisioning according to your deployment scenario. IP phones also support local configuration files named as -local.cfg.
Provisioning Yealink IP Phones Provisioning Yealink IP Phones This section provides instructions on how IP phones interoperate with provisioning server for auto provisioning, and shows you four major tasks to provision the phones. It will help users who are not familiar with auto provisioning to understand this process more easily and quickly.
Yealink IP Phones Auto Provisioning Guide Major Tasks for Auto Provisioning You need to complete four major tasks to provision Yealink IP phones. The following figure shows an overview of four major provisioning tasks: For more information on how to manage boot files, refer to Managing Boot Files on page 11. For more information on how to manage configuration files, refer to Managing Configuration Files on page 15.
Provisioning Yealink IP Phones An Instance of Auto Provision Configuration This section shows an instance of auto provision configuration. 1. Manage boot files. Specify the desired download path (e.g., tftp://10.2.5.193/network.cfg) of the configuration files in the boot file (e.g., y000000000000.boot). For more information, refer to Managing Boot Files on page 11. 2. Manage configuration files. Add/Edit the desired configuration parameters in the CFG file (e.g., features.
Yealink IP Phones Auto Provisioning Guide 2) Start the TFTP sever. The IP address of the TFTP server is shown as below: 3) Select Configure TFTP Server. Click the button to locate the TFTP root directory from your local system. For more information on how to configure a provisioning server, refer to Configuring a Provisioning Server on page 21.
Provisioning Yealink IP Phones 4. Configure the provisioning server address on the IP phone. For more information on how to obtain the provisioning server address, refer to Obtaining the Provisioning Server Address on page 25. 5. Trigger the IP phone to perform the auto provisioning. For more information on how to trigger the phone to perform the auto provisioning, refer to Triggering the IP Phone to Perform the Auto Provisioning on page 33.
Yealink IP Phones Auto Provisioning Guide 10
Managing Boot Files Managing Boot Files Yealink IP phones support downloading CFG files referenced in the boot files in sequence. Before beginning provisioning, you may need to edit and customize your boot files. You can edit the template boot file directly or create a new boot file as required. Open each boot file with a text editor such as UltraEdit. Editing Common Boot File The common boot file is effectual for all phones. It uses a fixed name “y000000000000.boot” as the file name.
Yealink IP Phones Auto Provisioning Guide new downloaded configuration files will override the duplicate parameters in files downloaded earlier. “overwrite_mode = 1” means overwrite mode is enabled. The overwrite mode will be applied to the configuration files specified to download. This parameter can only be used in boot files.
Managing Boot Files To create a MAC-Oriented boot file: 1. Create a boot file for your phone. Ensure the file complies with the guidelines that are listed in Editing Common Boot File on page 11. 2. Copy the contents from the common boot file and specify the configuration files to be downloaded. One or more configuration files can be referenced in the boot file. The following takes two configuration files for example: 3. Save the changes and close the MAC-Oriented boot file.
Yealink IP Phones Auto Provisioning Guide 14
Managing Configuration Files Managing Configuration Files Auto provisioning enables Yealink IP phones to update themselves automatically via downloading Common CFG, MAC-Oriented CFG, custom CFG and MAC-local CFG files. Before beginning provisioning, you may need to edit and customize your configuration files. You can edit the template configuration files directly or create a new CFG file as required. Open each configuration file with a text editor such as UltraEdit.
Yealink IP Phones Auto Provisioning Guide Phone Model Common CFG File SIP-T27G y000000000069.cfg SIP-T23P/G y000000000044.cfg SIP-T21(P) E2 y000000000052.cfg SIP-T19(P) E2 y000000000053.cfg W52P/W56P y000000000025.cfg Common CFG file contains configuration parameters which apply to phones with the same model, such as language and volume.
Managing Configuration Files Editing MAC-Oriented CFG File The MAC-Oriented CFG file is only effectual for the specific phone. It use the 12-digit MAC address of the IP phone as the file name. For example, if the MAC address of the IP phone is 00156574B150, the MAC-Oriented CFG file has to be named as 00156574b150.cfg (case-sensitive) respectively. MAC-Oriented CFG file contains configuration parameters which are expected to be updated per phone, such as the registration information.
Yealink IP Phones Auto Provisioning Guide Creating a New CFG File If you want to create a new CFG file for your phone, follow these steps: To create a new CFG file: 1. Create a CFG file for your phone. Ensure the file complies with the guidelines that are listed in Editing Common CFG File on page 15 or Editing MAC-Oriented CFG File on page 17. 2. Copy configuration parameters from the template configuration files and set the valid values for them. 3. Save the changes and close the CFG file.
Managing Configuration Files For more information on how to keep user personalization settings, refer to Yealink_SIP-T2_Series_T19(P) E2_T4_Series_IP_Phones_Administrator_Guide_V81, Yealink IP DECT Phone Administrator Guide_V81 or Yealink_SIP-T5_Series_Smart_Media_Phones_Administrator_Guide. We recommend you do not edit the MAC-local CFG file. If you really want to edit MAC-local CFG file, you can export and then edit it.
Yealink IP Phones Auto Provisioning Guide Feature Template File Name Talking.xml Directory (not applicable to SIP-T58V/T58A/T56A favorite_setting.xml IP phones) Super Search in dialing super_search.xml Local Contact File contact.xml Remote XML Phone Department.xml Book Menu.
Configuring a Provisioning Server Configuring a Provisioning Server Yealink IP phones support using FTP, TFTP, HTTP and HTTPS protocols to download boot files and configuration files. You can use one of these protocols for provisioning. The TFTP protocol is used by default. The following section provides instructions on how to configure a TFTP server. We recommend that you use 3CDaemon or TFTPD32 as a TFTP server. 3CDaemo and TFTPD32 are free applications for Windows.
Yealink IP Phones Auto Provisioning Guide An example of configuration on the Windows platform is shown as below: Configuring a TFTP Server If you have a 3CDaemon application installed on your local system, use it directly. Otherwise, download and install it. To configure a TFTP server: 1. Double click 3CDaemon.exe to start the application.
Configuring a Provisioning Server 2. Select Configure TFTP Server. Click the button to locate the TFTP root directory from your local system: 3. Click the Confirm button to finish configuring the TFTP server. The server URL “tftp://IP/” (Here “IP” means the IP address of the provisioning server, for example, ”tftp://10.2.5.193/”) is where the IP phone downloads configuration files from.
Yealink IP Phones Auto Provisioning Guide 24
Obtaining the Provisioning Server Address Obtaining the Provisioning Server Address Yealink IP phones support obtaining the provisioning server address in the following ways: Zero Touch Plug and Play (PnP) Server DHCP Options Phone Flash Configuring Wildcard of the Provisioning Server URL The priority of obtaining the provisioning server address is as follows: Zero Touch-->PnP Server-->DHCP Options (Custom option-->option 66-->option 43) -->Phone Flash.
Yealink IP Phones Auto Provisioning Guide 4. Click Confirm to accept the change. When Zero Touch is enabled, there will be a configuration wizard during startup: Press the OK soft key. The network parameters are configurable via phone user interface: Press the Next soft key after finishing network settings. Configure the provisioning server address, authentication user name (optional) and password (optional) in the Auto Provision screen.
Obtaining the Provisioning Server Address 2. Mark the On radio box in the PNP Active field. 3. Click Confirm to accept the change. Any PnP server activated in the network responses with a SIP NOTIFY message, and an address of the provisioning server is contained in the message body. After the IP phone obtains the provisioning server address from the PNP server, it will connect to the provisioning server and perform the auto provisioning process during startup.
Yealink IP Phones Auto Provisioning Guide The phone will automatically detect the option 66 and option 43 for obtaining the provisioning server address. DHCP option 66 is used to identify the TFTP server. DHCP option 43 is a vendor-specific option, which is used to transfer the vendor-specific information. You can configure the phone to obtain the provisioning server address via a custom DHCP option.
Obtaining the Provisioning Server Address The following figure shows the example messages of obtaining the TFTP server address from a custom DHCP option: Right click the root node of the custom option (e.g., option 128) shown on the above figure, and select Copy->Bytes->Printable Text Only. Paste the copied text in your favorite text editor to check the address, for example, tftp://192.168.1.100/. Phone Flash Yealink IP phones support obtaining the provisioning server address from the IP phone flash.
Yealink IP Phones Auto Provisioning Guide 2. Enter the URL, user name and password of the provisioning server in the Server URL, User Name and Password field respectively (the user name and password are optional). 3. Click Confirm to accept the change.
Obtaining the Provisioning Server Address configuration files from the identified directory on the provisioning server. The value of the parameter “static.auto_provision.url_wildcard.pn” must be configured in accordance with the directory name of the provisioning server directory where the boot files and configuration files of the IP phones are located. The following example assists in explaining the wildcard feature: You want to deploy SIP-T42G and SIP-T46G IP phones simultaneously in your environment.
Yealink IP Phones Auto Provisioning Guide 32
Triggering the IP Phone to Perform the Auto Provisioning Triggering the IP Phone to Perform the Auto Provisioning This chapter introduces the following methods to trigger the IP phone to perform the auto provisioning process: Power On Repeatedly Weekly Flexible Auto Provision Auto Provision Now Multi-mode Mixed SIP NOTIFY Message Auto Provisioning via Activation Code When there is an active call on the IP phone during auto provisioning, the auto provisioning process will dete
Yealink IP Phones Auto Provisioning Guide 2. Mark the On radio box in the Power On field. 3. Click Confirm to accept the change. Repeatedly The IP phone performs the auto provisioning process at regular intervals. You can configure the interval for the repeatedly mode. The default interval is 1440 minutes. To activate the repeatedly mode via web user interface: 34 1. Click on Settings->Auto Provision. 2. Mark the On radio box in the Repeatedly field.
Triggering the IP Phone to Perform the Auto Provisioning 3. Enter the desired interval time (in minutes) in the Interval(Minutes) field. 4. Click Confirm to accept the change. Weekly The IP phone performs the auto provisioning process at a random time every week/month/quarter. You can configure what time of the day and which day of the week to trigger the IP phone to perform the auto provisioning process.
Yealink IP Phones Auto Provisioning Guide 6. Check one or more checkboxes in the Day of Week field. 7. Click Confirm to accept the change. Flexible Auto Provision The IP phone performs the auto provisioning process at a random time on a random day within a specific period of time. The random day is calculated on the basis of the phone's MAC address. You can specify an interval and configure what time of the day to trigger the IP phone to perform the auto provisioning process.
Triggering the IP Phone to Perform the Auto Provisioning 4. Enter the desired start time and end time in the Flexible Time field. 5. Click Confirm to accept the change. Auto Provision Now You can use auto provision now mode to manually trigger the IP phone to perform the auto provisioning process immediately. To use the auto provision now mode via web user interface: 1. Click on Settings->Auto Provision.
Yealink IP Phones Auto Provisioning Guide 2. Click Autoprovision Now. The IP phone will perform the auto provisioning process immediately. Multi-mode Mixed You can activate more than one method for auto provisioning. For example, you can activate the “Power On” and “Repeatedly” modes simultaneously. The IP phone will perform the auto provisioning process when it is powered on and at a specified interval.
Triggering the IP Phone to Perform the Auto Provisioning Description of Configuration Parameters in CFG Files.xlsx or Yealink_SIP-T5_Series_Smart_Media_Phones_Description of Configuration Parameters in CFG Files.xlsx. This method requires server support. The following figure shows the message flow: Auto Provisioning via Activation Code In addition to the updating modes introduced above, users can trigger IP phones to perform auto provisioning by dialing an activation code.
Yealink IP Phones Auto Provisioning Guide The following lists the processes for triggering auto provisioning via activation code: 1. Create multiple directories (e.g., T23G_1 and T23G_2) on the provisioning server. 2. Store boot files and configuration files to each directory on the provisioning server. 3. Configure a user name and password for each directory on the provisioning server.
Triggering the IP Phone to Perform the Auto Provisioning process. The IP phone downloads the specified configuration files in sequence in boot files from the provisioning server to complete phone configurations. For more information on boot files and configuration files, refer to Managing Boot Files on page 11 and Managing Configuration Files on page 15. The entered user name and password will be saved to the IP phone for next auto provisioning.
Yealink IP Phones Auto Provisioning Guide 42
Downloading and Verifying Configurations Downloading and Verifying Configurations Downloading Boot Files and Configuration Files After obtaining the provisioning server address in one of the ways introduced above, the phone will request to download the boot files and configuration files from the provisioning server when it is triggered to perform auto provisioning.
Yealink IP Phones Auto Provisioning Guide If configuration files have been AES encrypted, the IP phone will uses the Common AES key to decrypt the Common CFG file and the MAC-Oriented AES key to decrypt the .cfg file after downloading the configuration files. For more information on how the IP phone decrypts configuration files, refer to Yealink Configuration Encryption Tool User Guide. Using MAC-local CFG File Uploading and downloading the -local.
Downloading and Verifying Configurations messages by a WinPcap tool. The following shows some examples. Example1: Yealink SIP-T23G IP phone downloads the boot file and configuration files from the TFTP server. Example 2: Yealink SIP-T23G IP phone downloads the boot file and configuration files from the FTP server. Example 3: Yealink SIP-T23G IP phone downloads boot file and configuration files from the HTTP server.
Yealink IP Phones Auto Provisioning Guide 46
Troubleshooting Troubleshooting This chapter provides general troubleshooting information to help you solve problems you might encounter when deploying phones. If you require additional information or assistance with the deployment, contact your system administrator. Why does the IP phone fail to download configuration files? Ensure that auto provisioning feature is configured properly. Ensure that the provisioning server and network are reachable.
Yealink IP Phones Auto Provisioning Guide Why is the permission denied when uploading files to the root directory of the FTP server? Ensure that the complete path to the root directory of the FTP server is authorized. Check security permissions on the root directory of the FTP server, if necessary, change the permissions. Why doesn’t the IP phone obtain the IP address from the DHCP server? Ensure that settings are correct on the DHCP server.
Glossary Glossary MAC Address: A Media Access Control address (MAC address) is a unique identifier assigned to network interfaces for communications on the physical network segment. MD5: The MD5 Message-Digest Algorithm is a widely used cryptographic hash function that produces a 128-bit (16-byte) hash value. DHCP: Dynamic Host Configuration Protocol (DHCP) is a network configuration protocol for hosts on Internet Protocol (IP) networks.
Yealink IP Phones Auto Provisioning Guide 50
Appendix Appendix Configuring an FTP Server Wftpd and FileZilla are free FTP application software for Windows. This section mainly provides instructions on how to configure an FTP server using wftpd for Windows. You can download wftpd online: http://www.wftpd.com/products/products.html or FileZilla online: https://filezilla-project.org. We recommend that you use vsftpd as an FTP server for Linux platform if required. Preparing a Root Directory To prepare a root directory: 1.
Yealink IP Phones Auto Provisioning Guide Configuring an FTP Server To configure a wftpd server: 1. Download the compressed file of the wftpd application to your local directory and extract it. 2. Double click the Wftpd.exe. The dialogue box of how to register is shown as below: 3. Check the check box and click OK in the pop-up dialogue box. The log file of the wftpd application is shown as below: 4. 52 Click Security->Users/rights.
Appendix 5. Click New User. 6. Enter a user name (e.g., test1) in the User Name field and then click OK. 7. Enter the password of the user (e.g., test1) created above in the New Password and Verify Password field respectively, and then click OK. 8. Click Browse to locate the FTP root directory from your local system. 9. Click Rights>> and assign the desired permission for the user (e.g., test1) created above.
Yealink IP Phones Auto Provisioning Guide 10. Check the check boxes of Read, Create Files/Dirs, List Directories and Overwrite/Delete to make sure the FTP user has the read and write permission. 11. Click Done to save the settings and finish the configurations. The server URL “ftp://username:password@IP/” (Here “IP” means the IP address of the provisioning server, “username” and “password” are the authentication for FTP download. For example, “ftp://test1:123456@10.3.6.
Appendix You need to define a user or group name and set the permissions: read, write, and modify. Security permissions vary by organizations. An example of configuration on the Windows platform is shown as below: Configuring an HTTP Server HFS tool is an executable application, so you don’t need to install it. To configure an HTTP server: 1. Download the application file to your local directory, double click the hfs.exe.
Yealink IP Phones Auto Provisioning Guide The main configuration page is shown as below: 2. 56 Click Menu in the main page and select the IP address of the PC from IP address.
Appendix The default HTTP port is 8080. You can also reset the HTTP port (make sure there is no port conflict). 3. Right click the icon on the left of the main page, select Add folder from disk to add the HTTP Server root directory.
Yealink IP Phones Auto Provisioning Guide 4. Locate the root directory from your local system. 5. Check the server URL (e.g., http://10.2.11.101:8088/ProvisioningDir) by clicking “Open in browser”. 6. (Optional.) Right click the root directory name (e.g., ProvisioningDir), and then select Set user/pass…. 7. (Optional.) Enter the desired user name and password for the root directory in the corresponding fields and then click OK.
Appendix Configuring the DHCP Turbo Before configuring the DHCP Turbo, make sure: The firewall on the PC is disabled. There is no DHCP server in your local system. To configure the DHCP Turbo: 1. To start the DHCP Turbo application, double click localhost. 2. Click the Login button (the login password is blank) to log in. 3. Right click Scopes and select New Scope. 4. Configure the DHCP server name, the DHCP IP range and the subnet mask.
Yealink IP Phones Auto Provisioning Guide 5. Click OK to accept the change. 6. You can add a custom option via DHCP Turbo. Select Option Types, right click one of the options on the right of the main page, and then select New Option Type.
Appendix 7. Set the custom DHCP option (custom DHCP option tag number ranges from 128 to 254) and select the option type (Yealink supports string and ipaddress option types only). Click the OK button to finish setting the option properties. Click 8. to save the change. Click Named Policies-->Global, right click the blank area on the right of the main page and then select New Option.
Yealink IP Phones Auto Provisioning Guide 9. Scroll down and double click the custom option 128. 10. Fill the provisioning server address in the input field. 11. Click the OK button to finish setting a custom option. 12. Click to save the change. Add the Option 66 via DHCP Turbo You can add the option 66 via DHCP Turbo. The following shows the detailed processes.
Appendix 1. Click Named Policies-->Global, right click the blank area on the right of the main page and then select New Option. 2. Select TFTP Options from the pull-down list of Filter. 3. Scroll down and double click MS option 66.
Yealink IP Phones Auto Provisioning Guide 4. Fill the provisioning server IP address in the input field. 5. Click the OK button to finish setting a custom option. 6. Click to save the change. Add the Option 43 via DHCP Turbo You can also add the option 43. The following shows the detailed processes. 1. Click Named Policies-->Global, right click the blank area on the right of the main page and then select New Option. 2. 64 Select the Standard Options from the pull-down list of Filter.
Appendix 3. Scroll down and double click 43. 4. Fill the provisioning server address in the input field. 5. Click the OK button to finish setting a custom option. 6. Click to save the change.
Yealink IP Phones Auto Provisioning Guide Customer Feedback We are striving to improve our documentation quality and we appreciate your feedback. Email your opinions and comments to DocsFeedback@yealink.com.
