Yealink SIP-CP Series Auto Provisioning Manual Download Page 1

Page: 1 / 74

Table of Contents

iii

Summary of Contents for SIP-CP Series

Page 1: ...Table of Contents iii ...

Page 2: ......

Page 3: ... Provisioning Yealink IP Phones 5 Auto Provisioning Process 5 Major Tasks for Auto Provisioning 6 An Instance of Auto Provision Configuration 7 Managing Boot Files 11 Editing Common Boot File 11 Creating MAC Oriented Boot File 12 Managing Configuration Files 15 Editing Common CFG File 15 Editing MAC Oriented CFG File 17 Creating a New CFG File 18 Managing MAC local CFG File 18 Encrypting Configura...

Page 4: ...ixed 38 SIP NOTIFY Message 38 Auto Provisioning via Activation Code 39 Downloading and Verifying Configurations 43 Downloading Boot Files and Configuration Files 43 Resolving and Updating Configurations 43 Using MAC local CFG File 44 Verifying Configurations 44 Troubleshooting 47 Glossary 49 Appendix 51 Configuring an FTP Server 51 Preparing a Root Directory 51 Configuring an FTP Server 52 Configu...

Page 5: ...Table of Contents v Add the Option 43 via DHCP Turbo 64 ...

Page 6: ......

Page 7: ...ion 81 72 Documentations of the newly released CP960 IP phones have also been added Changes for Release 81 Guide Version 81 71 Documentations of the newly released CP860 SIP T54S T52S IP phones have also been added Changes for Release 81 Guide Version 81 70 Documentations of the newly released W56P W52P SIP T58V T58A T56A T40G IP phones have also been added ...

Page 8: ......

Page 9: ...SIP T54S Yealink SIP T52S Yealink SIP T48G S Yealink SIP T46G S Yealink SIP T42G S Yealink SIP T41P S Yealink SIP T40P G Yealink SIP T29G Yealink SIP T27P G Yealink SIP T23P G Yealink SIP T21 P E2 Yealink SIP T19 P E2 Yealink CP860 Yealink CP960 Yealink W52P W56P The auto provisioning process outlined in this guide applies to Yealink SIP T54S T52S 46G T46S T42G T42S T41P T41S T40P T40G T29G T27P T...

Page 10: ...Yealink IP Phones Auto Provisioning Guide 2 ...

Page 11: ...te boot file named as y000000000000 boot The IP phone tries to download the boot file first and then download the configuration files referenced in the boot file in sequence during auto provisioning Yealink supports the following two types of boot files MAC Oriented boot file e g 00156574b150 boot Common boot file y000000000000 boot You can ask the distributor or Yealink FAE for the template boot ...

Page 12: ...iles online http support yealink com documentFront forwardToDocumentFrontDisplayPage To download template configuration files 1 Go to Yealink Document Download page and select the desired phone model 2 Download and extract the combined configuration files to your local system For example the following illustration shows the template files available for SIP T23G IP phones running firmware version 8...

Page 13: ...amiliar with auto provisioning to understand this process more easily and quickly Auto Provisioning Process When IP phones are triggered to perform auto provisioning they will request to download the boot files and configuration files from the provisioning server During the auto provisioning process the IP phone will download and update configuration files to the phone flash The following figure s...

Page 14: ...naging Configuration Files on page 15 For more information on how to configure a provisioning server refer to Configuring a Provisioning Server on page 21 For more information on how to obtain the provisioning server address refer to Obtaining the Provisioning Server Address on page 25 For more information on how to perform the auto provisioning process refer to Triggering the IP Phone to Perform ...

Page 15: ...e 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 cfg you want the IP phone to download For more information on how to manage configuration files refer to Managing Configuration Files on page 15 3 Configure the TFTP server 1 Place boot files and conf...

Page 16: ...e 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 ...

Page 17: ...w 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 ...

Page 18: ...Yealink IP Phones Auto Provisioning Guide 10 ...

Page 19: ...rsion 1 0 0 1 is not a comment and must be placed in the first line It cannot be edited or deleted The file format must be boot Each include statement can reference a configuration file The referenced configuration file format must be cfg The include statement can be repeated as many times as needed It means one or more CFG files can be referenced in the boot file Each include statement must use t...

Page 20: ... commented out in the configuration files The factory default value 0 takes effect after auto provisioning So account 1 is disabled Note that if a boot file is used but the value of the parameter overwrite_mode is not configured the default value 1 will take effect If you want to disable the overwrite mode configure overwrite_mode 0 in the boot file Note Creating MAC Oriented Boot File The MAC Ori...

Page 21: ...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 You can also make a copy of the common boot file rename it and then edit it ...

Page 22: ...Yealink IP Phones Auto Provisioning Guide 14 ...

Page 23: ...CFG Files_V81 xlsx Yealink IP DECT Phones Description of Configuration Parameters in CFG Files xlsx or Yealink_SIP T5_Series_CP960_IP_Phones_Description of Configuration Parameters in CFG Files xlsx Editing Common CFG File The Common CFG file is effectual for all phones of the same model It uses a fixed name y0000000000XX cfg as the file name where XX equals to the first two digits of the hardware...

Page 24: ...ones with the same model such as language and volume The following figure shows a portion of the common CFG file When editing the common CFG file learn the following The line beginning with is considered to be a comment The file header version 1 0 0 1 is not a comment and must be placed in the first line It cannot be edited or deleted The file format must be cfg The filename complies with the requ...

Page 25: ...g The line beginning with is considered to be a comment The file header version 1 0 0 1 is not a comment and must be placed in the first line It cannot be edited or deleted The file format must be cfg The filename matches the MAC address of your phone Each line must use the following format and adhere to the following rules Configuration Parameter Valid Value Separate each configuration parameter ...

Page 26: ...ores non static settings modified via web user interface or phone user interface This file is stored locally on the IP phone but a copy can also be uploaded to the provisioning server or a specified URL configured by static auto_provision custom sync path This file enables the phone to keep user personalization settings even after auto provision As with the MAC Oriented CFG files MAC local CFG fil...

Page 27: ...tomizing Resource Files When configuring some particular features you may need to upload resource files to IP phones such as personalized ring tone file language package file and logo file Yealink supplies the following resource file templates Feature Template File Name DST AutoDST xml Language Packs For example 000 GUI English lang 1 English_note xml 1 English js Replace Rule dialplan xml Dial no...

Page 28: ...56P IP DECT phones None Firmware For SIP T54S T52S T48G T48S T46G T46S T42 T42S T41P T41S T40P T29G T27P T27G T23P T23G T21 P E2 T19 P E2 X 81 0 XX rom For example 44 81 0 15 rom For SIP T58V T58A T56A CP960 X 80 0 XX rom For example 58 80 0 10 rom Ask the distributor or Yealink FAE for resource file templates For more information on an explanation of the configuration parameters that relate to th...

Page 29: ...dows You can download 3CDaemon online http www oldversion com 3Com Daemon html and TFTPD32 online http tftpd32 jounin net For more information on how to configure FTP and HTTP servers refer to Configuring an FTP Server on page 51 and Configuring an HTTP Server on page 54 Preparing a Root Directory To prepare a root directory 1 Create a TFTP root directory on the local system e g D TFTP Directory 2...

Page 30: ... 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 A configuration page is shown as below ...

Page 31: ... 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 ...

Page 32: ...Yealink IP Phones Auto Provisioning Guide 24 ...

Page 33: ...Flash The following sections detail the process of each way take the SIP T23G IP phone as an example Zero Touch Zero Touch allows you to configure the network parameters and provisioning server address via phone user interface during startup This feature is helpful when there is a system failure on the IP phone To use Zero Touch make sure this feature is enabled This feature is not applicable to W...

Page 34: ...n the Auto Provision screen An example of screenshot is shown as below Press the OK soft key After the above configuration is completed the IP phone will connect to the configured provisioning server and perform the auto provisioning process during startup Plug and Play PnP Server Yealink IP phones support obtaining the provisioning server address from the PnP server The IP phone broadcasts the Pn...

Page 35: ... 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 DHCP Options Yealink IP phones support obtaining the provisioning server address by detecting DHCP options during startup ...

Page 36: ...ng a DHCP Server on page 58 To configure the DHCP option via web user interface 1 Click on Settings Auto Provision 2 Mark the On radio box in the DHCP Active field 3 Enter the desired value in the Custom Option 128 254 field 4 Click Confirm to accept the change During startup the phone will broadcast DHCP request with DHCP options for obtaining the provisioning server address The provisioning serv...

Page 37: ...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 To obtain the provisioning server address by reading the IP phone flash make sure the configuration is set properly To configure the IP phone flash via web...

Page 38: ...ories need to be configured for different phone models each with a unique directory name 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 corresponding boot files and configuration files are located MAC it is used to identify the MAC address of the IP phone The parameter stat...

Page 39: ...P T42G IP phones and T46G for the SIP T46G IP phones When performing auto provisioning the SIP T42G IP phones and the SIP T46G IP phones first request to download the MAC Oriented boot files and configuration files referenced in MAC Oriented boot files from the provisioning server address tftp 192 168 1 100 T42G and tftp 192 168 1 100 T46G respectively If no matched MAC Oriented boot files are fou...

Page 40: ...Yealink IP Phones Auto Provisioning Guide 32 ...

Page 41: ...OTIFY Message Auto Provisioning via Activation Code Power On The IP phone performs the auto provisioning process when the IP phone is powered on To activate the power on mode via a web user interface 1 Click on Settings Auto Provision When there is an active call on the IP phone during auto provisioning the auto provisioning process will detect the call status every 30 seconds If the call is relea...

Page 42: ... 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 1 Click on Settings Auto Provision 2 Mark the On radio box in the Repeatedly field ...

Page 43: ...he delay time to perform an auto provisioning process when the IP phone is inactive at regular week For example you can configure the IP phone to check and update new configuration only when the IP phone has been inactivated for 10 minutes between 2 to 3 o clock in the morning every Monday for a 4 week interval If you configure two or more days in a week the auto provisioning only occurs at a rand...

Page 44: ...rovisioning process For example you can configure the IP phone to check and update new configuration between 1 and 6 o clock in the morning for a 30 day interval The IP phone will perform an auto provisioning process at a random time e g 03 47 on a random day e g 18 based on the phone s MAC address Note that the update time will be recalculated if auto provisioning occurs e g Auto Provision Now du...

Page 45: ...ime 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 ...

Page 46: ...sage The IP phone will perform the auto provisioning process when receiving a SIP NOTIFY message which contains the header Event check sync Whether the IP phone reboots or not depends on the value of the parameter sip notify_reboot_enable If the value is set to 1 or the value is set to 0 and the header of the SIP NOTIFY message contains an additional string reboot true the IP phone will reboot imm...

Page 47: ...tivation Code In addition to the updating modes introduced above users can trigger IP phones to perform auto provisioning by dialing an activation code To use this method the activation code and the provisioning server URL need to be pre configured on the IP phones This method works only if there is no registered account on the IP phone It is normally used for IP phones distributed by retail sales...

Page 48: ...onfiguration file for IP phones static autoprovision 1 code 123 static autoprovision 1 url http 192 168 1 30 T23G_1 static autoprovision 2 code 456 static autoprovision 2 url http 192 168 1 30 T23G_2 5 Send the specified activation code associated user name and password to each end user 6 The user can set up the IP phone and then input the activation code e g 123 after the phone startup The LCD sc...

Page 49: ...he code name for triggering auto provisioning static autoprovision X name Configure the activation code static autoprovision X code Configure the URL of the provisioning server static autoprovision X url Configure the username and password for downloading boot files and configuration files If configured the LCD screen will not prompt for user name and password static autoprovision X user static au...

Page 50: ...Yealink IP Phones Auto Provisioning Guide 42 ...

Page 51: ... the auto provisioning process is completed For update of some specific configurations which require a reboot before taking effect for example network configurations the IP phone will reboot to make the configurations effective after the auto provisioning process is completed The IP phone calculates the MD5 values of the downloaded files before updating them If the MD5 values of the Common and MAC...

Page 52: ...nalized settings by setting the value of the parameter static auto_provision custom protect to 1 it will update configurations in the MAC local cfg file If the value of the parameter overwrite_mode is set to 1 in the boot file the value of the parameter static auto_provision custom protect will be forced to set to 1 The IP phone updates configuration files during auto provisioning in sequence CFG ...

Page 53: ...xample1 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 ...

Page 54: ...Yealink IP Phones Auto Provisioning Guide 46 ...

Page 55: ...thenticate the provisioning server during auto provisioning Ensure that the certificate for the provisioning server has been uploaded to the phone s trusted certificates list If not do one of the following Import the certificate for the provisioning server to the phone s trusted certificates list at phone s web path Security Trusted Certificates Import Trusted Certificates Disable the IP phone to ...

Page 56: ...correct Ensure that the network is available and the root directory is right for downloading Ensure that the ring tone file exists on the provisioning server Why doesn t the IP phone update configurations Ensure that the configuration files are different from the last ones Ensure that the IP phone has downloaded the configuration files Ensure that the parameters are correctly set in the configurat...

Page 57: ...c web hosting server HTTP The Hypertext Transfer Protocol HTTP is an application protocol for distributed collaborative hypermedia information systems HTTP is the foundation of data communication for the World Wide Web HTTPS Hypertext Transfer Protocol Secure HTTPS is a combination of Hypertext Transfer Protocol HTTP with SSL TLS protocol It provides encrypted communication and secure identificati...

Page 58: ...Yealink IP Phones Auto Provisioning Guide 50 ...

Page 59: ...Preparing a Root Directory To prepare a root directory 1 Create an FTP root directory on the local system e g D FTP Directory 2 Place the boot files and configuration files to this root directory 3 Set the security permissions for the FTP directory folder 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 c...

Page 60: ...he 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 Click Security Users rights ...

Page 61: ...ck 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 ...

Page 62: ...est1 123456 10 3 6 234 is where the IP phone downloads boot files and configuration files from Configuring an HTTP Server This section provides instructions on how to configure an HTTP server using HFS tool You can download the HFS software online http www snapfiles com get hfs html Preparing a Root Directory To prepare a root directory 1 Create an HTTP root directory on the local system e g D HTT...

Page 63: ...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 ...

Page 64: ...Yealink IP Phones Auto Provisioning Guide 56 The main configuration page is shown as below 2 Click Menu in the main page and select the IP address of the PC from IP address ...

Page 65: ...he 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 ...

Page 66: ...orresponding 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 For more information on installing and configuring an Apache HTTPS Server refer to the network resource Configuring a DHCP Server This section provides instructions on how...

Page 67: ...bled 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 ...

Page 68: ...s Auto Provisioning Guide 60 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 ...

Page 69: ...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 to save the change 8 Click Named Policies Global right click the blank area on the right of the main page and then select New Option ...

Page 70: ...e 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 ...

Page 71: ...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 ...

Page 72: ...h 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 Select the Standard Options from the pull down list of Filter ...

Page 73: ...Appendix 65 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 ...

Page 74: ...link IP Phones Auto Provisioning Guide 66 Customer Feedback We are striving to improve our documentation quality and we appreciate your feedback Email your opinions and comments to DocsFeedback yealink com ...

Search results

Summary of Contents for SIP-CP Series

Reviews:

Related manuals for SIP-CP Series

Brands by name

Popular brands

Yealink SIP-CP Series, Auto Provisioning Manual

Search results

Summary of Contents for SIP-CP Series

Reviews:

Related manuals for SIP-CP Series

Brands by name

Popular brands