Yealink VP59 Auto Provisioning Manual
Hide thumbs Also See for VP59:
Table of Contents

Advertisement

Table of Contents
iii

Advertisement

Table of Contents
loading

Summary of Contents for Yealink VP59

  • Page 1 Table of Contents...
  • Page 3: Table Of Contents

    Configuration Files .............................. 3 Resource Files ................................ 4 Obtaining Template Files ..........................5 Obtaining Phone Information ..........................5 Provisioning Yealink IP Phones ............ 7 Interoperating with Provisioning Server ......................7 Auto Provisioning Process ............................ 8 Old Mechanism – Without Boot Files ......................8 New Mechanism –...
  • Page 4 Yealink IP Phones Auto Provisioning Guide Configuring a Provisioning Server ..........27 Preparing a Root Directory ..........................27 Configuring a TFTP Server ..........................28 Obtaining the Provisioning Server Address ......31 Zero Touch ................................31 Plug and Play (PnP) Server ..........................33 DHCP Options ................................
  • Page 5 Table of Contents Configuring an HTTP Server ......................... 61...
  • Page 6 Yealink IP Phones Auto Provisioning Guide...
  • Page 7: Introduction

    TFTP protocol. Supported Phones The purpose of this guide is to serve as a basic guidance for provisioning Yealink IP phones. The following table lists product names and available firmware versions for IP phones that use auto provisioning process outlined in this guide.
  • Page 8 Yealink IP Phones Auto Provisioning Guide Product Name Boot File Exclude Mode (Available Firmware (Available Firmware Version) Version) CP860 Yes (81 or later) CP960 Yes (80 or later) Yes (83 or later) CP920 Yes (81 or later) W60P Yes (81 or later)
  • Page 9: Getting Started

    The configuration files contain parameters that affect the features of the phone. You can use the configuration files to deploy and maintain a mass of Yealink IP phones automatically. You can create and name as many configuration files as you want (e.g., account.cfg, sip.cfg, features.cfg) by using the template configuration files.
  • Page 10: Resource Files

    When configuring some particular features, you may need to upload resource files to IP phones, such as personalized AutoDST file, language package file and local contact file. Resource files are optional, but if the particular feature is being employed, these files are required. Yealink supplies the following resource file templates: Feature Template File Name AutoDST.xml...
  • Page 11: Obtaining Template Files

    Getting Started Obtaining Template Files You can ask the distributor or Yealink FAE for template files. You can also obtain them online: http://support.yealink.com/documentFront/forwardToDocumentFrontDisplayPage. To download template boot, configuration and resource files: Go to Yealink Document Download page and select the desired phone model.
  • Page 12 Yealink IP Phones Auto Provisioning Guide...
  • Page 13: Provisioning Yealink Ip Phones

    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 the auto provisioning process and the 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.
  • Page 14: Auto Provisioning Process

    Yealink IP Phones Auto Provisioning Guide Auto Provisioning Process Old Mechanism – Without Boot Files The following flowchart shows how Yealink IP phones perform auto provisioning when using configuration files only:...
  • Page 15: New Mechanism - With Boot Files

    Provisioning Yealink IP Phones New Mechanism – With Boot Files The following figure shows auto provisioning flowcharts for Yealink IP phones when using boot files: Scenario A – Do Not Support Exclude Mode...
  • Page 16 Yealink IP Phones Auto Provisioning Guide Scenario B – Support Exclude Mode This scenario is only applicable to IP phones (except W52P/W56P IP phones) running firmware version 83 or later.
  • Page 17: Major Tasks For Auto Provisioning

    For more information on how to perform auto provisioning, refer to Triggering the IP Phone to Perform Auto Provisioning. If you are not familiar with auto provisioning on Yealink IP phones, you can refer to An Instance of Auto Provision Configuration.
  • Page 18: An Instance Of Auto Provision Configuration

    Yealink IP Phones Auto Provisioning Guide An Instance of Auto Provision Configuration This section shows an instance of auto provision configuration. Manage boot files. Specify the desired URL (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.
  • Page 19 Provisioning Yealink IP Phones Start the TFTP sever. The IP address of the TFTP server is shown as below: Select Configure TFTP Server. Click the button to locate the TFTP root directory in your local system. For more information on how to configure a provisioning server, refer to...
  • Page 20 Yealink IP Phones Auto Provisioning Guide 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. Trigger the IP phone to perform auto provisioning.
  • Page 21: Managing Boot Files

    Managing Boot Files Managing Boot Files Yealink IP phones can download CFG files referenced in the boot files. Before provisioning, you may need to edit and customize your boot files. Yealink supports the following two types of boot files: MAC-Oriented boot file (e.g., 00156574b150.boot) ...
  • Page 22 The [$MODEL] can be added to specify settings for specific phone models. $MODEL represents the phone model name. The valid phone model names are: VP59, T58, CP960, T54W, T54S, T53W, T53, T52S, T48S, T48G, T46S, T46G, T42S, T42G, T41P, T41S, T40P, T40G, T29G, T27G, T23P, T23G, T21P_E2, T19P_E2 and CP920.
  • Page 23: Creating Mac-Oriented Boot File

    Managing Boot Files Item Guidelines W53P/W60P/CP930W-Base) running firmware version 83 or later. Creating MAC-Oriented Boot File The MAC-Oriented boot file is only effective for the specific phone. It uses 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 boot file has to be named as 00156574b150.boot (case-sensitive) respectively.
  • Page 24 Yealink IP Phones Auto Provisioning Guide...
  • Page 25: Managing Configuration Files

    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 provisioning, you may need to edit and customize your configuration files.
  • Page 26 Yealink IP Phones Auto Provisioning Guide Product Name Common CFG File SIP-T40G y000000000076.cfg SIP-T29G y000000000046.cfg SIP-T27G y000000000069.cfg SIP-T23P/G y000000000044.cfg SIP-T21(P) E2 y000000000052.cfg SIP-T19(P) E2 y000000000053.cfg CP860 y000000000037.cfg CP920 y000000000078.cfg W53P/W60P/CP930W-Base y000000000077.cfg W52P/W56P y000000000025.cfg Common CFG file contains configuration parameters which apply to phones with the same model, such as language and volume.
  • Page 27: Editing Mac-Oriented Cfg File

    $MODEL represents the phone model. The valid phone models are: VP59, T58, CP960, T54W, T54S, T53W, T53, T52S, T48G, T48S, T46G, T46S, T42G, T42S, T41P, T41S, T40P, T40G, T29G, T27G, T23P, T23G, T21P_E2, T19P_E2 and CP920. Multiple phone models are separated by commas.
  • Page 28 $MODEL represents the phone model. The valid phone models are: VP59, T58, CP960, T54W, T54S, T53W, T53, T52S, T48G, T48S, T46G, T46S, T42G, T42S, T41P, T41S, T40P, T40G, T29G, T27G, T23P, T23G, T21P_E2, T19P_E2 and CP920. Multiple phone models are separated by commas.
  • Page 29: Creating A New Cfg File

    The phone model name T21P_E2 is applicable to T21P E2 and T21 E2 phones. VP59/SIP-T58A/T54W/T54S/T48G/T48S/T46G/T46S/T29G IP phones support 16 accounts, SIP-T53W/T53/T52S/T42G/T42S IP phones support 12 accounts, W53P/W60P DECT IP phones support 8 assigned accounts, CP930W-Base phones support only one assigned account.
  • Page 30: Encrypting Configuration Files

    Encrypting Configuration Files To protect against unauthorized access and tampering of sensitive information (e.g., login password, registration information), you can encrypt configuration files using Yealink Configuration Encryption Tool. AES keys must be 16 characters and the supported characters contain: 0 ~ 9, A ~ Z, a ~ z and the following special characters are also supported: # $ % * + , - . : Yealink = ? @ [ ] ^ _ { } ~.
  • Page 31: Managing Resource Files

    For more information on how to customize these template resource files and an explanation of the configuration parameters that related to these features, refer to the latest Administrator Guide for your phone on Yealink Technical Support.
  • Page 32 Yealink IP Phones Auto Provisioning Guide...
  • Page 33: Configuring A Provisioning Server

    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.
  • Page 34: Configuring A Tftp Server

    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.
  • Page 35 Configuring a Provisioning Server Select Configure TFTP Server. Click the button to locate the TFTP root directory from your local system: 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.
  • Page 36 Yealink IP Phones Auto Provisioning Guide...
  • Page 37: Obtaining The Provisioning Server Address

    Obtaining the Provisioning Server Address Obtaining the Provisioning Server Address Yealink IP phones can obtain 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 ...
  • Page 38 Yealink IP Phones Auto Provisioning Guide The default value is 5. 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.
  • Page 39: Plug And Play (Pnp) Server

    Plug and Play (PnP) Server Yealink IP phones support obtaining the provisioning server address from the PnP server. The IP phone broadcasts the PnP SUBSCRIBE message to obtain the provisioning server address during startup.
  • Page 40: Dhcp Options

    Yealink IP Phones Auto Provisioning Guide DHCP Options Yealink IP phones can obtain the provisioning server address by detecting DHCP options during startup. If you are using IPv4 network, the phone will automatically detect the option 66 and option 43 for obtaining the provisioning server address.
  • Page 41: Phone Flash

    Phone Flash Yealink IP phones can obtain the provisioning server address from the IP phone flash. To obtain the provisioning server address by reading the IP phone flash, make sure the configuration is set properly.
  • Page 42: Configuring Wildcard Of The Provisioning Server Url

    Yealink IP phones support the following wildcards in the provisioning server URL: $PN: it is used to identify the directory name of the provisioning server directory where the ...
  • Page 43 Obtaining the Provisioning Server Address When the IP phone obtains a provisioning server URL containing the wildcard $PN, it automatically replaces the character $PN with the value of the parameter “static.auto_provision.url_wildcard.pn” configured on the IP phone. When the IP phone is triggered to perform auto provisioning, it will request to download the boot files and configuration files from the identified directory on the provisioning server.
  • Page 44 Yealink IP Phones Auto Provisioning Guide...
  • Page 45: Triggering The Ip Phone To Perform Auto Provisioning

    Triggering the IP Phone to Perform Auto Provisioning Triggering the IP Phone to Perform Auto Provisioning This chapter introduces the following methods to trigger the IP phone to perform auto provisioning: Power On  Repeatedly  Weekly  Flexible Auto Provision ...
  • Page 46: Repeatedly

    Yealink IP Phones Auto Provisioning Guide Mark the On radio box in the Power On field. Click Confirm to accept the change. Repeatedly The IP phone performs the auto provisioning at regular intervals. You can configure the interval for the repeatedly mode. The default interval is 1440 minutes.
  • Page 47: Weekly

    Triggering the IP Phone to Perform Auto Provisioning Enter the desired interval time (in minutes) in the Interval(Minutes) field. Click Confirm to accept the change. Weekly The IP phone performs auto provisioning 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 auto provisioning.
  • Page 48: Flexible Auto Provision

    Yealink IP Phones Auto Provisioning Guide Check one or more checkboxes in the Day of Week field. Click Confirm to accept the change. Flexible Auto Provision The IP phone performs auto provisioning at a random time on a random day within a specific period of time.
  • Page 49: Auto Provision Now

    Triggering the IP Phone to Perform Auto Provisioning Enter the desired start time and end time in the Flexible Time field. Click Confirm to accept the change. Auto Provision Now You can use auto provision now mode to manually trigger the IP phone to perform auto provisioning immediately.
  • Page 50: Multi-Mode Mixed

    Yealink IP Phones Auto Provisioning Guide Click Auto Provision Now. The IP phone will perform auto provisioning 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 auto provisioning when it is powered on and at a specified interval.
  • Page 51: Auto Provisioning Via Activation Code

    Triggering the IP Phone to Perform Auto Provisioning in CFG Files or Administrator Guide for your phone on Yealink Technical Support. 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.
  • Page 52 Yealink IP Phones Auto Provisioning Guide The following lists the processes for triggering auto provisioning via activation code: Create multiple directories (e.g., T23G_1 and T23G_2) on the provisioning server. Store boot files and configuration files to each directory on the provisioning server.
  • Page 53 Triggering the IP Phone to Perform Auto Provisioning 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 Managing Configuration Files.
  • Page 54 Yealink IP Phones Auto Provisioning Guide...
  • Page 55: Downloading And Verifying Configurations

    “static.auto_provision.reboot_force.enable = 1” in the configuration file. For more information on the specific configurations which require a reboot during auto provisioning and the parameter “static.auto_provision.reboot_force.enable”, refer to the latest IP Phones Description of Configuration Parameters in CFG Files for your phone on Yealink Technical Support.
  • Page 56: Using Mac-Local Cfg File

    Yealink IP Phones Auto Provisioning Guide If configuration files have been AES encrypted, the IP phone will use the Common AES key to decrypt the Common CFG file and the MAC-Oriented AES key to decrypt the <MAC>.cfg file after downloading the configuration files. For more information on how the IP phone decrypts...
  • Page 57 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...
  • Page 58 Yealink IP Phones Auto Provisioning Guide...
  • Page 59: Troubleshooting

    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.
  • Page 60 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 ...
  • Page 61: Glossary

    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 as cryptographic hash function that produces a 128-bit (16-byte) hash value.
  • Page 62 Yealink IP Phones Auto Provisioning Guide...
  • Page 63: Appendix

    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.
  • Page 64: Configuring An Ftp Server

    Yealink IP Phones Auto Provisioning Guide Configuring an FTP Server To configure a wftpd server: Download the compressed file of the wftpd application to your local directory and extract Double click the Wftpd.exe. The dialogue box of how to register is shown as below: Check the check box and click OK in the pop-up box.
  • Page 65 Appendix Click New User. Enter a user name (e.g., test1) in the User Name field and then click OK. Enter the password of the user (e.g., test1) created above in the New Password and Verify Password field respectively, and then click OK. Click Browse to locate the FTP root directory in your local system.
  • Page 66: Configuring An Http Server

    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.
  • Page 67 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: Download the application file to your local directory, double click the hfs.exe.
  • Page 68 Yealink IP Phones Auto Provisioning Guide The main configuration page is shown as below: Click Menu in the main page and select the IP address of the PC from IP address.
  • Page 69 Appendix The default HTTP port is 8080. You can also reset the HTTP port (make sure there is no port conflict). Right click the icon on the left of the main page, select Add folder from disk to add the HTTP Server root directory.
  • Page 70 (Optional.) Enter the desired user name and password for the root directory in the corresponding fields and then click OK. Yealink IP phones also support the Hypertext Transfer Protocol with SSL/TLS (HTTPS) protocol for auto provisioning. HTTPS protocol provides the encrypted communication and secure identification.

Table of Contents