publication may be reproduced or transmitted in any form or by any means, electronic or mechanical,
photocopying, recording, or otherwise, for any purpose, without the express written permission of
Yealink (Xiamen) Network Technology CO., LTD. Under the law, reproducing includes translating into
another language or format.
When this publication is made available on media, Yealink (Xiamen) Network Technology CO., LTD. gives
its consent to downloading and printing copies of the content provided in this file only for private use
but not for redistribution. No parts of this publication may be subject to alteration, modification or
commercial use. Yealink (Xiamen) Network Technology CO., LTD. will not be liable for any damages
arising from use of an illegally modified or altered publication.
Trademarks
Yealink®, the logo and the name and marks is trademark of Yealink (Xiamen) Network Technology CO.,
LTD, which are registered legally in China, the United States, EU (European Union) and other countries.
All other trademarks belong to their respective owners. Without Yealink’s express written permission,
recipient shall not reproduce or transmit any portion hereof in any form or by any means, with any
purpose other than personal use.
Warranty
(1) Warranty
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS GUIDE ARE SUBJECT TO
CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS
GUIDE ARE BELIEVED TO BE ACCURATE AND PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF PRODUCTS.
(2) Disclaimer
YEALINK (XIAMEN) NETWORK TECHNOLOGY CO., LTD. MAKES NO WARRANTY OF ANY KIND WITH
REGARD TO THIS GUIDE, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. Yealink (Xiamen) Network Technology
CO., LTD. shall not be liable for errors contained herein nor for incidental or consequential damages in
connection with the furnishing, performance, or use of this guide.
(3) Limitation of Liability
Yealink and/or its respective suppliers are not responsible for the suitability of the information contained
in this document for any reason. The information is provided “as is”, and Yealink does not provide any
ii
Page 3
warranty and is subject to change without notice. All risks other than risks caused by use of the
information are borne by the recipient. In no event, even if Yealink has been suggested the occurrence of
damages that are direct, consequential, incidental, special, punitive or whatsoever (Including but not
limited to loss of business profit, business interruption or loss of business information), shall not be liable
for these damages.
End User License Agreement
This End User License Agreement ("EULA") is a legal agreement between you and Yealink. By installing,
copying or otherwise using the Products, you: (1) agree to be bounded by the terms of this EULA, (2) you
are the owner or an authorized user of the device, and (3) you represent and warrant that you have the
right, authority and capacity to enter into this agreement and to abide by all its terms and conditions, just
as if you had signed it. The EULA for this product is available on the Yealink Support page for the product.
Patent Information
China, the United States, EU (European Union) and other countries are protecting one or more patents of
accompanying products and/or patents being applied by Yealink.
Customer Feedback
We are striving to improve our documentation quality and we appreciate your feedback. Email your
opinions and comments to DocsFeedback@yealink.com.
Technical Support
Visit Yealink WIKI (http://support.yealink.com/) for the latest firmware, guides, FAQ, Product documents,
and more. For better service, we sincerely recommend you to use Yealink Ticketing system
(https://ticket.yealink.com) to submit all your technical issues.
iii
Page 4
GNU GPL INFORMATION
Yealink IP phone firmware contains third-party software under the GNU General Public License (GPL).
Yealink uses software under the specific terms of the GPL. Please refer to the GPL for the exact terms and
conditions of the license.
The original GPL license, source code of components licensed under GPL and used in Yealink products
can be downloaded from Yealink web site:http://www.yealink.com/onepage_83.html.
iv
Page 5
Introduction
Introduction
Yealink administrator guide provides general guidance on setting up phone network, provisioning and
managing phones.
This guide is not intended for end users, but for administrators with experience in networking who
understand the basic of open SIP networks and VoIP endpoint environments.
As an administrator, you can do the following with this guide:
Set up a VoIP network and provisioning server.
Provision the phone with features and settings.
Troubleshoot, update and maintain phones.
The information detailed in this guide is applicable to the following Yealink devices running firmware
version 83 or higher:
T5 series IP phones, including T54S and T52S.
T4 series IP phones, including T48S/G, T46S/G, T42S/G, T41S/P and T40P/G.
T2 series IP phones, including T29G, T27P/G, T23P/G, T21(P) E2 and T19(P) E2.
Expansion modules, including EXP20, EXP40 and EXP50.
Read the Yealink Products Regulatory Notices guide for all regulatory and safety guidance.
Related Documentations
The following related documents are available:
Quick Start Guides, describe how to assemble IP phones and configure the most basic features
available on IP phones.
User Guides, describe how to configure and use the basic and advanced features available on IP
phones via phone user interface or via web user interface.
Auto Provisioning Guide, describes how to provision IP phones using the boot file and configuration
files.
The
Auto Provisioning Guide
a provisioning server. If you are novice, this guide is helpful for you.
is to serve as a basic guidance for provisioning Yealink IP phones with
Using features integrated with Broadsoft UC-One, refer to the following two guides to have a better
knowledge of BroadSoft features.
IP Phones Deployment Guide for BroadSoft UC-One Environments, describes how to configure
BroadSoft features on the BroadWorks web portal and IP phones.
IP Phone Features Integrated with BroadSoft UC-One User Guide, describes how to configure and
i
Page 6
Administrator’s Guide for SIP-T2 Series/T4 Series/T5 Series IP Phones
Convention
Description
Bold
Highlight the web/phone user interface items such as menus, menu
selections, soft keys, or directory names when they are involved in a
procedure or user action (for example, click Settings->Upgrade.).
Also used to emphasize text (for example, Important!).
Italics
Used to emphasize text, to show the example values or inputs (format of
examples:
http(s)://[IPv6 address]
).
Blue Text
Used for cross references to other topics related to this topic (for example,
Ring Tones), for hyperlinks to external sites and documents, for example, RFC
3315 or Yealink_SIP_IP_Phones_Auto_Provisioning_Guide.
Convention
Description
<>
Indicate that you must enter information specific to phone or network. For
example, when you see <MAC>, enter your phone’s 12-digit MAC address. If
you see <phoneIPAddress>, enter your phone’s IP address.
use IP phone features integrated with BroadSoft UC-One on Yealink IP phones.
For support or service, please contact your Yealink reseller or go to Yealink Technical Support online:
http://support.yealink.com/.
Recommended References
For more information on configuring and administering other Yealink products not included in this guide,
refer to product support page at Yealink Technical Support.
To access the latest Release Notes or other guides for Yealink IP phones, refer to the Document
Downloadpage for your phone at Yealink Technical Support.
If you want to find Request for Comments (RFC) documents, type
(NNNN is the RFC number) into the location field of your browser.
For other references, look for the hyperlink or web info throughout this administrator guide.
http://www.ietf.org/rfc/rfcNNNN.txt
Typographic and Writing Conventions
Yealink documentations contain a few typographic conventions and writing conventions.
You need to know the following basic typographic conventions to distinguish types of in-text
information:
You also need to know the following writing conventions to distinguish conditional information:
ii
Page 7
Convention
Description
->
Indicate that you need to select an item from a menu. For example,
Settings->Basic Settings indicates that you need to select Basic Settings
from the Settings menu.
Introduction
iii
Page 8
Administrator’s Guide for SIP-T2 Series/T4 Series/T5 Series IP Phones
iv
Page 9
Table of Contents
Table of Contents
Introduction..................................................................................... i
Related Documentations ......................................................................................................................................................... i
Recommended References .................................................................................................................................................... ii
Typographic and Writing Conventions ............................................................................................................................. ii
Table of Contents ........................................................................... v
Getting Started ............................................................................... 1
Yealink IP Phones in a Network ........................................................................................................................................... 1
Initialization Process Overview ............................................................................................................................................. 2
Loading the ROM File ..................................................................................................................................................... 3
Configuring the VLAN .................................................................................................................................................... 3
Querying the DHCP (Dynamic Host Configuration Protocol) Server .......................................................... 3
Contacting the Provisioning Server .......................................................................................................................... 3
SIP Port and TLS Port Configuration...................................................................................................................... 39
Internet Port and PC Port .................................................................................................................................................... 40
Internet Port and PC Port Configuration ............................................................................................................. 40
VPN Related Files ........................................................................................................................................................... 42
Quality of Service (QoS) ....................................................................................................................................................... 43
Voice and SIP QoS Configuration ........................................................................................................................... 44
Files Download Process ............................................................................................................................................... 63
Central Provisioning ..................................................................................................................................................... 71
Setting Up a Provisioning Server ...................................................................................................................................... 80
Supported Provisioning Server Discovery Methods ....................................................................................... 82
Configuring a Provisioning Server .......................................................................................................................... 86
Keeping User’s Personalized Settings after Auto Provisioning ............................................................................ 87
Auto Provisioning Flowchart for Keep User’s Personalized Configuration Settings ......................... 88
vi
Page 11
Table of Contents
Example: Deploying Phones from the Provisioning Server ................................................................................... 89
Firmware for Each Phone Model ...................................................................................................................................... 91
Language .................................................................................................................................................................................... 94
Language Display Configuration ............................................................................................................................. 95
Language Customization ............................................................................................................................................ 96
Example: Setting a Custom Language for Phone Display .......................................................................... 101
Backlight Brightness and Time Configuration ................................................................................................. 114
Label Length for Line Key Display .................................................................................................................................. 116
Linekey Length in Short ...................................................................................................................................................... 118
Linekey Length in Short Configuration ............................................................................................................... 119
Administrator’s Guide for SIP-T2 Series/T4 Series/T5 Series IP Phones
Time and Date ........................................................................................................................................................................ 123
Time Zone ....................................................................................................................................................................... 124
Time and Date Manually Configuration ............................................................................................................. 134
Time and Date Format Configuration ................................................................................................................. 135
Date Customization Rule .......................................................................................................................................... 136
Logo Customization ............................................................................................................................................................. 137
Custom Logo Picture Limit ...................................................................................................................................... 138
Customizing a Logo Picture .................................................................................................................................... 138
Custom Logo Configuration.................................................................................................................................... 139
Example: Setting a Custom Logo Display .......................................................................................................... 140
Display Method on Dialing ............................................................................................................................................... 143
Display Method on Dialing Configuration ........................................................................................................ 143
Key As Send ............................................................................................................................................................................. 144
Key As Send Configuration ...................................................................................................................................... 144
Supported Call States and Soft Keys ................................................................................................................... 145
Power LED Indicator ............................................................................................................................................................. 159
Power LED Indicator Configuration ...................................................................................................................... 159
Bluetooth .................................................................................................................................................................................. 162
Bluetooth Configuration ........................................................................................................................................... 162
Line Keys .......................................................................................................................................................................... 167
EDK List Configuration ............................................................................................................................................... 189
Example: Configuring EDK List for a Line Key .................................................................................................. 197
Power Saving .......................................................................................................................................................................... 197
Power Saving Configuration ................................................................................................................................... 198
USB Port Lock ......................................................................................................................................................................... 201
USB Port Lock Configuration .................................................................................................................................. 201
Search Source List in Dialing ............................................................................................................................................ 201
Outbound Proxy in Dialog ................................................................................................................................................ 215
Outbound Proxy in Dialog Configuration ......................................................................................................... 215
Server Redundancy............................................................................................................................................................... 216
Behaviors When Working Server Connection Fails ....................................................................................... 217
Registration Method of the Failover/Fallback Mode .................................................................................... 218
Fallback Server Redundancy Configuration...................................................................................................... 218
Failover Server Redundancy Configuration ...................................................................................................... 220
SIP Server Name Resolution ............................................................................................................................................. 225
SIP Server Name Resolution Configuration ...................................................................................................... 225
Static DNS Cache................................................................................................................................................................... 226
Behave with a Configured DNS Server ............................................................................................................... 226
Static DNS Cache Configuration ........................................................................................................................... 227
Multiple Line Keys per Account ...................................................................................................................................... 233
Multiple Line Keys per Account Configuration ............................................................................................... 233
Auto Line Labels Rule Configuration ................................................................................................................... 235
Local Directory ....................................................................................................................................................................... 245
Contact Avatars and Icons Picture Limit ............................................................................................................ 245
Preparing the Tar Formatted File .......................................................................................................................... 246
Local Contact File Customization .......................................................................................................................... 247
Local Contact Files and Resource Upload ......................................................................................................... 249
Example: Adding Contacts Using a Contact File ............................................................................................. 252
Local Contacts Backup ........................................................................................................................................................ 252
Remote Phone Book ............................................................................................................................................................ 262
Remote Phone Book File Customization ........................................................................................................... 263
Remote Phone Book Configuration ..................................................................................................................... 265
Example: Configuring a Remote Phone Book.................................................................................................. 266
Directory List for Directory/Dir Soft Key ...................................................................................................................... 267
Directory List File Customization ........................................................................................................................... 267
Directory List Configuration .................................................................................................................................... 269
Example: Configuring a Directory List ................................................................................................................. 271
Call Features ............................................................................... 273
Dial Plan .................................................................................................................................................................................... 274
Dial Plan Defined by Four Patterns ...................................................................................................................... 274
Dial Plan Defined by Digit Map ............................................................................................................................. 283
Emergency Dialplan and Enhanced 911 ...................................................................................................................... 293
Emergency Dialplan and Enhanced 911 Configuration ............................................................................... 294
Off Hook Hot Line Dialing ................................................................................................................................................. 300
Off Hook Hot Line Dialing Configuration .......................................................................................................... 300
Live Dialpad ............................................................................................................................................................................. 301
Live Dialpad Configuration ...................................................................................................................................... 301
Auto Redial .............................................................................................................................................................................. 302
Auto Redial Configuration ....................................................................................................................................... 302
Call Number Filter ................................................................................................................................................................. 309
Call Number Filter Configuration .......................................................................................................................... 309
IP Address Call ........................................................................................................................................................................ 309
IP Address Call Configuration................................................................................................................................. 309
Off Hook Answering ............................................................................................................................................................ 311
Off Hook Answering Configuration ..................................................................................................................... 311
Auto Answer ............................................................................................................................................................................ 311
Auto Answer Configuration ..................................................................................................................................... 312
Do Not Disturb (DND) ......................................................................................................................................................... 318
Call Hold ................................................................................................................................................................................... 325
Call Hold Configuration ............................................................................................................................................ 326
Music on Hold (MoH) Configuration ................................................................................................................... 328
Call Forward Synchronization for Server-side Configuration .................................................................... 343
Call Transfer ............................................................................................................................................................................. 345
Call Transfer Configuration ...................................................................................................................................... 345
Transfer Mode for Dsskey Configuration .......................................................................................................... 347
Conference Type Configuration ............................................................................................................................ 347
Local Conference Configuration ............................................................................................................................ 348
xi
Page 16
Administrator’s Guide for SIP-T2 Series/T4 Series/T5 Series IP Phones
USB Recording ....................................................................................................................................................................... 350
USB Recording Configuration ................................................................................................................................ 350
Audio Features ........................................................................... 359
Alert Tone ................................................................................................................................................................................. 359
Alert Tone Configuration .......................................................................................................................................... 360
Ring Tones ............................................................................................................................................................................... 361
Distinctive Ring Tones ......................................................................................................................................................... 364
Supported Alert-Info Headers Format ................................................................................................................ 364
Distinctive Ring Tones Configuration .................................................................................................................. 368
Packetization Time (PTime) ............................................................................................................................................... 383
Supported PTime of Audio Codec ........................................................................................................................ 383
Early Media .............................................................................................................................................................................. 384
Early Media Configuration ....................................................................................................................................... 385
Automatic Gain Control (AGC) ............................................................................................................................... 388
Transfer via DTMF ........................................................................................................................................................ 396
Local DTMF Tone ......................................................................................................................................................... 397
Security Features ........................................................................ 407
User and Administrator Identification .......................................................................................................................... 407
User and Administrator Identification Configuration ................................................................................... 407
User Access Level Configuration ........................................................................................................................... 409
Auto Logout Time ................................................................................................................................................................. 409
Auto Logout Time Configuration .......................................................................................................................... 410
Group Call Pickup ........................................................................................................................................................ 437
Example: Using Call Completion ........................................................................................................................... 441
xiii
Page 18
Administrator’s Guide for SIP-T2 Series/T4 Series/T5 Series IP Phones
Call Park and Retrieve ......................................................................................................................................................... 441
Call Park and Retrieve Configuration .................................................................................................................. 442
Example: Setting Call Park and Retrieve in FAC Mode ................................................................................ 443
Example: Setting Call Park and Retrieve in Transfer Mode ........................................................................ 444
Automatic Call Distribution (ACD) ................................................................................................................................. 444
Busy Lamp Field ..................................................................................................................................................................... 447
BLF List Configuration ................................................................................................................................................ 448
State Indicator of Remote Line .............................................................................................................................. 451
BLF/BLF List Subscription.......................................................................................................................................... 451
Visual and Audio Alert for Monitor Lines .......................................................................................................... 454
LED Mode for BLF/BLF List Key .............................................................................................................................. 456
BLF/BLF List Key LED Status and Behavior Configuration ........................................................................... 459
BLF Key for Intercom Configuration .................................................................................................................... 468
Shared Line .............................................................................................................................................................................. 469
State Indicator of Shared Line ................................................................................................................................ 469
State Monitor for Intercom Contact .................................................................................................................... 474
CSTA Control ........................................................................................................................................................................... 478
CSTA Control Configuration .................................................................................................................................... 479
Pre-defined Events List .............................................................................................................................................. 479
Variable Values List ..................................................................................................................................................... 481
Action URI ................................................................................................................................................................................ 496
Supported HTTP/HTTPS GET Request ................................................................................................................ 497
Variable Values List ..................................................................................................................................................... 499
Action URI Configuration ......................................................................................................................................... 502
Example: Capturing the Current Screen of the Phone ................................................................................. 503
Example: Placing a Call via Web User Interface .............................................................................................. 504
Voice Mail ................................................................................................................................................................................. 505
MWI for Voice Mail Configuration ....................................................................................................................... 505
Short Message Service (SMS) .......................................................................................................................................... 507
XML Browser ........................................................................................................................................................................... 508
xiv
Page 19
Table of Contents
XML Browser Configuration .................................................................................................................................... 508
Hot Desking ............................................................................................................................................................................. 510
Hot Desking Key Configuration ............................................................................................................................. 511
Hot Desking Configuration ...................................................................................................................................... 511
General Features ........................................................................ 513
Line Identification Presentation ...................................................................................................................................... 513
CLIP and COLP Configuration................................................................................................................................. 514
Return Code for Refused Call........................................................................................................................................... 515
Return Code for Refused Call Configuration ................................................................................................... 515
Accept SIP Trust Server Only ............................................................................................................................................ 517
Accept SIP Trust Server Only Configuration ..................................................................................................... 517
Reboot in Talking .................................................................................................................................................................. 522
Reboot in Talking Configuration ........................................................................................................................... 522
Reserve # in User Name ..................................................................................................................................................... 522
Reserve # in User Name Configuration .............................................................................................................. 523
Busy Tone Delay .................................................................................................................................................................... 523
Busy Tone Delay Configuration ............................................................................................................................. 524
CFG File Version Information ........................................................................................................................................... 524
CFG File Version Information Configuration .................................................................................................... 524
Media Loopback .................................................................................................................................................................... 524
Media Loopback Configuration ............................................................................................................................. 525
Broadsoft Call Park ...................................................................................................................................................... 548
Watch Dog ...................................................................................................................................................................... 571
Exporting All the Diagnostic Files ......................................................................................................................... 574
Phone Status .................................................................................................................................................................. 575
IP Address Issues.......................................................................................................................................................... 577
Time and Date Issues ................................................................................................................................................. 578
Phone Book Issues ...................................................................................................................................................... 579
Wi-Fi and Bluetooth Issues ...................................................................................................................................... 580
Firmware and Upgrading Issues ............................................................................................................................ 581
System Log Issues ....................................................................................................................................................... 582
Logo Issues ..................................................................................................................................................................... 583
Power and Startup Issues ......................................................................................................................................... 583
Other Issues ................................................................................................................................................................... 584
RFC and Internet Draft Support ...................................................................................................................................... 586
Note: It works only if “static.network.ip_address_mode” is set to 0 (IPv4) or 2 (IPv4 &
IPv6), and "static.network.internet_port.type" is set to 2 (Static IP Address).
Permitted
Values
IPv4 Address
Default
Blank
Web UI
Network->Basic->IPv4 Config->Static IP Address->IP Address
[1]
If you change this parameter, the IP phone will reboot to make the change take effect.
[2]
X is the account ID. For T54S/T48S/T48G/T46S/T46G/T29G, X=1-16; for T52S/T42G/T42S, X=1-12; for
T41P/T41S/T27P/T27G, X=1-6; for T40P/T40G/T23P/T23G, X=1-3; for T21(P) E2, X=1-2; for T19(P) E2, X=1.
IPv4 Configuration
The following table lists the parameters you can use to configure IPv4.
7
Page 28
Administrator’s Guide for SIP-T2 Series/T4 Series/T5 Series IP Phones
Note: It works only if “static.network.ip_address_mode” is set to 1 (IPv6) or 2 ( IPv4 &
IPv6), and "static.network.ipv6_internet_port.type" is set to 1 (Static IP Address).
Permitted
Values
IPv6 Address
Default
Blank
Web UI
Network->Basic->IPv6 Config->Static IP Address->IP Address
Note: It works only if “static.network.ip_address_mode” is set to 1 (IPv6) or 2 (IPv4 &
IPv6), and "static.network.ipv6_internet_port.type" is set to 1 (Static IP Address).
Permitted
Values
Integer from 0 to 128
Default
64
Web UI
Network->Basic->IPv6 Config->Static IP Address->IPv6 Prefix(0~128)
It enables or disables the IP phone to obtain IPv6 network settings via SLAAC
(Stateless Address Autoconfiguration).
Note: It works only if “static.network.ipv6_internet_port.type” is set to 0 (DHCP). It is
only applicable to T54S/T52S/T48S/T48G/T46S/T46G/T29G IP phones. SLAAC is
enabled on T42G/T42S/T41P/T41S/T40P/T40G/T27P/T27G/T23P/T23G/T21(P)
E2/T19(P) E2 IP phones by default. You are not allowed to configure this parameter for
these IP phones.
Permitted
Values
0-Disabled
1-Enabled
Default
1
Web UI
Network->Advanced->ICMPv6 Status->Active
Note
For more information on DHCP options, refer to RFC 2131 or RFC 2132.
Parameters
DHCP Option
Description
Subnet Mask
1
Specify the client’s subnet mask.
[1]
If you change this parameter, the IP phone will reboot to make the change take effect.
DHCP Option for IPv4
The IP phone can obtain IPv4-related parameters in an IPv4 network via DHCP option.
Topics
Supported DHCP Option for IPv4
DHCP Option 66, Option 43 and Custom Option
DHCP Option 42, Option 2 and Option 100
DHCP Option 12
DHCP Option 120
DHCP Option 60
Supported DHCP Option for IPv4
The following table lists common DHCP options for IPv4 supported by Yealink IP phones.
14
Page 35
Phone Network
Parameters
DHCP Option
Description
Time Offset
2
Specify the offset of the client's subnet in seconds
from Coordinated Universal Time (UTC).
Router
3
Specify a list of IP addresses for routers on the
client’s subnet.
Time Server
4
Specify a list of time servers available to the client.
Domain Name
Server
6
Specify a list of domain name servers available to
the client.
Host Name
12
Specify the name of the client.
Domain Server
15
Specify the domain name that client should use
when resolving hostnames via DNS.
Network Time
Protocol Servers
42
Specify a list of NTP servers available to the client
by IP address.
Vendor-Specific
Information
43
Identify the vendor-specific information.
Vendor Class
Identifier
60
Identify the vendor type.
TFTP Server Name
66
Identify a TFTP server when the 'sname' field in
the DHCP header has been used for DHCP
options.
Timezone/DST
100
Specify a POSIX timezone string.
SIP
Server/outbound
proxy server
120
Convey a SIP server’s or outbound proxy server’s
location to the client.
Note
If you fail to configure the DHCP options for discovering the provisioning server on the DHCP server, an
alternate method of automatically discovering the provisioning server address is required. One possibility is
DHCP Option 66, Option 43 and Custom Option
During the startup, the phone will automatically detect the custom option, option 66, or option 43 for
obtaining the provisioning server address. The priority of obtaining the provisioning server address is as
follows: custom option>option 66 (identify the TFTP server)>option 43.
The IP phone can obtain the Auto Configuration Server (ACS) address by detecting option 43 during
startup.
To obtain the server address via DHCP option, make sure you have configured the DHCP option on the
phone. The option must be in accordance with the one defined in the DHCP server.
15
Page 36
Administrator’s Guide for SIP-T2 Series/T4 Series/T5 Series IP Phones
Note
that connecting to the secondary DHCP server that responds to DHCP INFORM queries with a requested
provisioning server address. For more information, refer to RFC 3925. If a single alternate DHCP server
responds, this is functionally equivalent to the scenario where the primary DHCP server responds with a
valid provisioning server address. If no DHCP server responds, the INFORM query process will retry and
eventually time out.
Parameter
static.network.dhcp_host_name
[1]
<y0000000000xx>.cfg
Description
It configures the DHCP Option 12 Hostname on the IP phone.
Permitted
Values
String within 99 characters
Default
For T54S IP phones: SIP-T54S.
Related Topic
DHCP Provision Configuration
DHCP Option 42, Option 2 and Option 100
Yealink IP phones support using the NTP server address offered by DHCP.
DHCP option 42 is used to specify a list of NTP servers available to the client by IP address. NTP servers
should be listed in order of preference.
DHCP option 2 is used to specify the offset of the client’s subnet in seconds from Coordinated Universal
Time (UTC).
DHCP option 100 is used to specify the timezone information (time zone and daylight-saving offset). The
priority is as follows: option 100>option 2.
Related Topic
NTP Settings
DHCP Option 12
You can specify a hostname for the phone when using DHCP. The DHCP client uses option 12 to send a
predefined hostname to the DHCP registration server. The name may or may not be qualified with the
local domain name (based on RFC 2132). See RFC 1035 for character restrictions.
Topic
DHCP Option 12 Hostname Configuration
DHCP Option 12 Hostname Configuration
The following table lists the parameter you can use to configure DHCP option 12 hostname.
16
Page 37
Phone Network
For T52S IP phones: SIP-T52S.
For T48G IP phones: SIP-T48G.
For T48S IP phones: SIP-T48S.
For T46G IP phones: SIP-T46G.
For T46S IP phones: SIP-T46S.
For T42G IP phones: SIP-T42G.
For T42S IP phones: SIP-T42S.
For T41P IP phones: SIP-T41P.
For T41S IP phones: SIP-T41S.
For T40P IP phones: SIP-T40P.
For T40G IP phones: SIP-T40G.
For T29G IP phones: SIP-T29G.
For T27P IP phones: SIP-T27P.
For T27G IP phones: SIP-T27G.
For T23P IP phones: SIP-T23P.
For T23G IP phones: SIP-T23G.
For T21(P) E2 IP phones: SIP-T21P_E2.
For T19(P) E2 IP phones: SIP-T19P_E2.
Web UI
Features->General Information->DHCP Hostname
Parameter
sip.dhcp.option120.mode
<y0000000000xx>.cfg
Description
It configures whether to use DHCP option 120 for obtaining the outbound proxy
server IP address.
Permitted
Values
0-Do not check with the DHCP server for the outbound proxy server IP address.
1-The value obtained from DHCP option 120 is used as outbound proxy server IP
address (can resolve up to two domain names or IPv4 addresses). If
[1]
If you change this parameter, the IP phone will reboot to make the change take effect.
DHCP Option 120
The DHCP option 120 is used by the SIP client to locate a local outbound proxy server.
Topic
DHCP Option 120 Configuration
DHCP Option 120 Configuration
The following table lists the parameter you can use to configure DHCP option 120.
17
Page 38
Administrator’s Guide for SIP-T2 Series/T4 Series/T5 Series IP Phones
“account.X.outbound_proxy_enable = 1”, and primary outbound proxy server is
configured, the address from DHCP option 120 is used as secondary one; if primary
outbound proxy server is not configured, the address from DHCP option 120 is used
as primary one.
2-The value obtained from DHCP option 120 is used as SIP server IP address (can
resolve up to only one IPv4 address). If primary SIP server is configured, the address
from DHCP option 120 is used as secondary one; if primary SIP server is not
configured, the address from DHCP option 120 is used as primary one.
Default
0
Note
The default vendor class ID is “yealink”.
Parameter
static.network.dhcp.option60type
<y0000000000xx>.cfg
Description
It configures the DHCP option 60 type.
Permitted
Values
0-ASCII
1-Binary (RFC 3925)
Default
0
Parameter
static.auto_provision.dhcp_option.option60_value
<y0000000000xx>.cfg
Description
It configures the value (vendor name of the device) of DHCP option 60.
Permitted
Values
String within 99 characters
Default
yealink
Web UI
Settings->Auto Provision->IPv4 DHCP Option Value
DHCP Option 60
DHCP option 60 is used to identify the vendor and functionality of a DHCP client. You can set the format
for option 60.
Topic
DHCP Option 60 Configuration
DHCP Option 60 Configuration
The following table lists the parameter you can use to configure DHCP option 60.
18
Page 39
DHCP Option for IPv6
Parameters
DHCP Option
Description
DNS Server
23
Specify a list of DNS servers available to the
client.
DNS Domain Search List
24
Specify a domain search list to a client.
SNTP Server
31
Specify a list of Simple Network Time
Protocol (SNTP) servers available to the
client.
Information Refresh Time
32
Specify an upper bound for how long a
client should wait before refreshing
information retrieved from DHCPv6.
Boot File URL
59
Specify a URL for the boot file to be
downloaded by the client.
The IP phone can obtain IPv6-related parameters in an IPv6 network via DHCP option.
Topics
Supported DHCP Option for IPv6
DHCP Option 59 and Custom Option
Supported DHCP Option for IPv6
The following table lists common DHCP options for IPv6 supported by Yealink IP phones.
Phone Network
DHCP Option 59 and Custom Option
During the startup, the phone will automatically detect the custom option or option 59 for obtaining the
provisioning server address. The priority of obtaining the provisioning server address is as follows:
custom option>option 59.
Related Topic
DHCP Provision Configuration
VLAN
The purpose of VLAN configurations on the IP phone is to insert tag with VLAN information to the
packets generated by the IP phone. When VLAN is properly configured for the ports (Internet port and PC
port) on the IP phone, the IP phone will tag all packets from these ports with the VLAN ID. The switch
19
Page 40
Administrator’s Guide for SIP-T2 Series/T4 Series/T5 Series IP Phones
Parameter
static.network.lldp.enable
[1]
<y0000000000xx>.cfg
Description
It enables or disables the LLDP (Linker Layer Discovery Protocol) feature on the IP
phone.
Permitted
Values
0-Disabled
1-Enabled, the IP phone will attempt to determine its VLAN ID through LLDP.
Default
1
Web UI
Network->Advanced->LLDP->Active
Phone UI
T54S/T52S/T48S/T48G/T46S/T46G/T29G:
receives and forwards the tagged packets to the corresponding VLAN according to the VLAN ID in the
tag as described in IEEE Std 802.3.
VLAN on IP phones allows simultaneous access to a regular PC. This feature allows a PC to be daisy
chained to an IP phone and the connection for both PC and IP phone to be trunked through the same
physical Ethernet cable.
In addition to manual configuration, the IP phone also supports automatic discovery of VLAN via LLDP,
CDP or DHCP. The assignment takes effect in this order: assignment via LLDP/CDP, manual configuration,
then assignment via DHCP.
For more information on VLAN, refer to VLAN Feature on Yealink IP Phones.
Topics
LLDP Configuration
CDP Configuration
Manual VLAN Configuration
DHCP VLAN
VLAN Setting Configuration
LLDP Configuration
LLDP (Linker Layer Discovery Protocol) is a vendor-neutral Link Layer protocol, which allows IP phones to
receive and/or transmit device-related information from/to directly connected devices on the network
that are also using the protocol, and store the information about other devices.
When LLDP feature is enabled on IP phones, the IP phones periodically advertise their own information to
the directly connected LLDP-enabled switch. The IP phones can also receive LLDP packets from the
connected switch. When the application type is “voice”, the IP phones decide whether to update the
VLAN configurations obtained from the LLDP packets. When the VLAN configurations on the IP phones
are different from the ones sent by the switch, the IP phones perform an update and reboot. This allows
the IP phones to plug into any switch, obtain their VLAN IDs, and then start communications with the call
control.
The following table lists the parameters you can use to configure LLDP.
20
Page 41
Phone Network
Menu->Advanced (default password: admin) ->Network->LLDP->LLDP Status
If you change this parameter, the IP phone will reboot to make the change take effect.
DHCP VLAN
Yealink IP phones support VLAN discovery via DHCP. When the VLAN discovery method is set to DHCP,
the IP phone will examine DHCP option for a valid VLAN ID. The predefined option 132 is used to supply
the VLAN ID by default. You can customize the DHCP option used to request the VLAN ID.
The following table lists the parameters you can use to configure DHCP VLAN discovery.
[1]
If you change this parameter, the IP phone will reboot to make the change take effect.
25
Page 46
Administrator’s Guide for SIP-T2 Series/T4 Series/T5 Series IP Phones
Parameter
static.network.vlan.vlan_change.enable
[1]
<y0000000000xx>.cfg
Description
It enables or disables the IP phone to obtain VLAN ID using lower preference of VLAN
assignment method or to close the VLAN feature when the IP phone cannot obtain
VLAN ID using the current VLAN assignment method.
The priority of each method is: LLDP/CDP>Manual>DHCP VLAN.
Permitted
Values
0-Disabled
1-Enabled, the IP phone will attempt to use the lower priority method when failing to
obtain the VLAN ID using higher priority method. If all the methods are attempted, the
phone will disable VLAN feature.
Default
0
Note
To use Wi-Fi feature, make sure the Wi-Fi USB dongle is properly connected to the USB port on the back of
the phone. The Wi-Fi USB dongle should be purchased separately.
Parameter
static.wifi.function.enable
[1]
<y0000000000xx>.cfg
VLAN Setting Configuration
The following table lists the parameter you can use to configure VLAN setting.
[1]
If you change this parameter, the IP phone will reboot to make the change take effect.
Wi-Fi
Wi-Fi feature enables you to connect the phones to the organization’s wireless network. The wireless
network is more convenient and cost-effective than wired network. Wi-Fi feature is only applicable to
T54S/T52S/T48S/T48G/T46S/T46G/T42S/T41S/T29G/T27G IP phones.
When the Wi-Fi feature is enabled, the IP phone will automatically scan the available wireless networks.
All the available wireless networks will display in scanning list on the LCD screen. You can store up to 5
frequently used wireless networks on your phone and specify the priority for them.
You can check the Wi-Fi dongle MAC address at the path: Menu->Status->Wi-Fi MAC (phone user
interface) or Status->Status->Network Common->Wi-Fi MAC (web user interface).
Topic
Wi-Fi Configuration
Wi-Fi Configuration
The following table lists the parameters you can use to configure Wi-Fi.
26
Page 47
Phone Network
Description
It enables or disables the Wi-Fi feature.
Note: It is only applicable to
T54S/T52S/T48S/T48G/T46S/T46G/T42S/T41S/T29G/T27G IP phones.
Permitted
Values
0-Disabled
1-Enabled
Default
1
Parameter
static.network.redundancy.mode
[1]
<y0000000000xx>.cfg
Description
It configures the network connection mode to be used preferentially.
Note: It is only applicable to
T54S/T52S/T48S/T48G/T46S/T46G/T42S/T41S/T29G/T27G IP phones.
Permitted
Values
0-If Wi-Fi mode is activated, the wired network is unavailable; Wi-Fi mode must be
deactivated if you want to use the wired network.
1-Use wireless network preferentially.
2-Use wired network preferentially.
Default
0
Parameter
static.network.redundancy.failback.timeout
[1]
<y0000000000xx>.cfg
Description
It configures the time to wait (minutes) for the IP phone to switch to the preferred
network (configured by “static.network.redundancy.mode”).
Note: It works only if “static.network.redundancy.mode” is set to 1 or 2. It is only
applicable to T54S/T52S/T48S/T48G/T46S/T46G/T42S/T41S/T29G/T27G IP phones.
Permitted
Values
Integer from 0 to 1440
0-The phone will not switch as long as the current network is available.
1 to 1440–The phone will keep using the current network for the specified time after
the preferentially used network becomes available. If the preferentially used network
is still available after the specified time, the phone performs a network switch while
the phone is not in use.
Default
55
Parameter
static.wifi.enable
<y0000000000xx>.cfg
Description
It activates or deactivates the Wi-Fi mode.
Note: It is only applicable to
T54S/T52S/T48S/T48G/T46S/T46G/T42S/T41S/T29G/T27G IP phones. It works only if
“static.wifi.function.enable” is set to 1 (Enabled).
Permitted
Values
0-Disabled
1-Enabled
Default
0
27
Page 48
Administrator’s Guide for SIP-T2 Series/T4 Series/T5 Series IP Phones
Web UI
Network->Wi-Fi->Wi-Fi Active
Phone UI
T54S/T52S/T48S/T48G/T46S/T46G/T29G:
Menu->Basic->Wi-Fi->Wi-Fi
T42S/T41S/T27G:
Menu->Settings->Basic Settings->Wi-Fi
Parameter
static.wifi.X.label
[2]
<y0000000000xx>.cfg
Description
It configures the profile name of the wireless network X for the IP phone.
Note: It works only if “static.wifi.enable” is set to 1 (Enabled). It is only applicable to
T54S/T52S/T48S/T48G/T46S/T46G/T42S/T41S/T29G/T27G IP phones.
Permitted
Values
String within 32 characters
Default
Blank
Web UI
Network->Wi-Fi->Profile Name
Phone UI
T54S/T52S/T48S/T48G/T46S/T46G/T29G:
Menu->Basic->Wi-Fi->Wi-Fi (On)->Known Network (press Add)->Profile Name
or
Menu->Basic->Wi-Fi->Wi-Fi (On)->Known Network->Option->Edit->Profile Name
It configures the encryption type of the wireless network X.
If “static.wifi.X.security_mode” is set to NONE, the permitted value of this parameter is
NONE.
If “static.wifi.X.security_mode” is set to WEP, the permitted value of this parameter is
WEP.
If “static.wifi.X.security_mode” is set to other values, the permitted values of this
parameter are TKIP, AES or TKIPAES.
Note: It works only if “static.wifi.enable” is set to 1 (Enabled).It is only applicable to
T54S/T52S/T48S/T48G/T46S/T46G/T42S/T41S/T29G/T27G IP phones.
Permitted
Values
NONE, WEP, TKIP, AES or TKIP AES
Default
NONE
Web UI
Network->Wi-Fi->Cipher Type
Phone UI
T54S/T52S/T48S/T48G/T46S/T46G/T29G:
Menu->Basic->Wi-Fi->Wi-Fi (On)->Known Network (press Add)->Cipher Type
or
Menu->Basic->Wi-Fi->Wi-Fi (On)->Known Network->Option->Edit->Cipher Type
The following table lists the parameters you can use to configure VPN.
Phone Network
[1]
If you change this parameter, the IP phone will reboot to make the change take effect.
Quality of Service (QoS)
VoIP is extremely bandwidth and delay-sensitive. QoS is a major issue in VoIP implementations,
regarding how to guarantee that packet traffic not be delayed or dropped due to interference from other
lower priority traffic. VoIP can guarantee high-quality QoS only if the voice and the SIP packets are given
priority over other kinds of network traffic. IP phones support the DiffServ model of QoS.
43
Page 64
Administrator’s Guide for SIP-T2 Series/T4 Series/T5 Series IP Phones
Note
For voice and SIP packets, the IP phone obtains DSCP info from the network policy if LLDP feature is
enabled, which takes precedence over manual settings. For more information on LLDP, refer toLLDP
Configuration.
Parameter
static.network.qos.audiotos
[1]
<y0000000000xx>.cfg
Description
It configures the DSCP (Differentiated Services Code Point) for voice packets.
The default DSCP value for RTP packets is 46 (Expedited Forwarding).
Permitted
Values
Integer from 0 to 63
Default
46
Web UI
Network->Advanced->Voice QoS->Voice QoS (0~63)
Parameter
static.network.qos.signaltos
[1]
<y0000000000xx>.cfg
Description
It configures the DSCP (Differentiated Services Code Point) for SIP packets.
The default DSCP value for SIP packets is 26 (Assured Forwarding).
Permitted
Values
Integer from 0 to 63
Default
26
Web UI
Network->Advanced->Voice QoS->SIP QoS (0~63)
Voice QoS
In order to make VoIP transmissions intelligible to receivers, voice packets should not be dropped,
excessively delayed, or made to suffer varying delay. DiffServ model can guarantee high-quality voice
transmission when the voice packets are configured to a higher DSCP value.
SIP QoS
SIP protocol is used for creating, modifying, and terminating two-party or multi-party sessions. To ensure
good voice quality, SIP packets emanated from IP phones should be configured with a high transmission
priority.
DSCPs for voice and SIP packets can be specified respectively.
Topic
Voice and SIP QoS Configuration
Voice and SIP QoS Configuration
The following table lists the parameters you can use to configure voice voice and SIP QoS.
[1]
If you change this parameter, the IP phone will reboot to make the change take effect.
44
Page 65
Phone Network
Parameter
static.network.802_1x.mode
[1]
<y0000000000xx>.cfg
Description
It configures the 802.1x authentication method.
Permitted
Values
0-EAP-None, 802.1x authentication is not required.
Yealink IP phones support boot files. The boot files maximize the flexibility to allow you to customize
features and settings for multiple phones.
With the boot file, you can specify which configuration files should be downloaded. It is effective for you
to provision the IP phones in different deployment scenarios:
For all phones
For a group of phones
For specific phone models
For a single phone
Yealink IP phones support two types of boot files: common boot file and MAC-Oriented boot file. You
53
Page 74
Administrator’s Guide for SIP-T2 Series/T4 Series/T5 Series IP Phones
Note
You can select whether to use the boot file or not according to your deployment scenario. If you do not
want to use the boot file, please go toConfiguration Files.
Tip
MAC address, a unique 12-digit serial number is assigned to each phone. You can obtain it from the bar
code on the back of the IP phone.
Attributes
Description
#!version:1.0.0.1
It must be placed in the first line. Do not edit and delete.
include:config <xxx.cfg>
include:config "xxx.cfg"
Each “include” statement can specify a location of a configuration file.
The configuration file format must be *.cfg.
The locations in the angle brackets or double quotation marks support
two forms:
Relative path (relative to the boot file):
For example, sip.cfg, HTTP Directory/sip.cfg
Absolute path (or URL):
can use the default boot template file “y000000000000.boot” to create MAC-Oriented boot file by
making a copy and renaming it.
Topics
Common Boot File
MAC-Oriented Boot File
Boot File Attributes
Customizing a Boot File
Common Boot File
Common boot file, named y000000000000.boot, is effective for all phones. You can use a common boot
file to apply common feature settings to all of the phones rather than a single phone.
MAC-Oriented Boot File
MAC-Oriented boot file, named <MAC>.boot. It will only be effective for a specific IP phone. In this way,
you have a high permission to control over each phone by making changes on a per-phone basis.
You can create a MAC-Oriented boot file for each phone by making a copy and renaming the boot
template file (y000000000000.boot). For example, if your phone MAC address is 00156574B150, rename
the template file as 00156574b150.boot (lowercase).
Boot File Attributes
The following table lists the attributes you need to know in the boot template file.
54
Page 75
Phone Provisioning
Attributes
Description
For example,
http://10.2.5.258/HTTP Directory/sip.cfg
The location must point to a specific CFG file.
[$MODEL]
The [$MODEL] can be added to specify settings for specific phone
models. $MODEL represents the phone model name.
The valid phone model names are: T54S, T52S, T48S, T48G, T46S, T46G,
. Multiple phone model names are separated by commas.
or
include:config “”
account.cfg
to the file. Each starts on a
only applies to T23G phones
in front of
overwrite_mode = 1
specific_model.excluded_mode = 1
6. Save the boot file and place it on the provisioning server.
Related Topic
Boot File Attributes
Configuration Files
Yealink supports two configuration template files: Common CFG file and MAC-Oriented CFG file.
These configuration files contain two kinds of parameters:
Static: The parameters start with a prefix “static.”, for example, static.auto_provision.custom.protect.
Non-static: The parameters do not start with a prefix “static.”, for example,
phone_setting.backgrounds.
56
Page 77
Phone Provisioning
Note
For protecting against unauthorized access, you can encrypt configuration files. For more information on
encrypting configuration files, refer to Encrypting and Decrypting Files.
Phone Model
Common CFG file
T54S
y000000000070.cfg
T52S
y000000000074.cfg
T48G
y000000000035.cfg
T48S
y000000000065.cfg
T46G
y000000000028.cfg
T46S
y000000000066.cfg
T42G
y000000000029.cfg
T42S
y000000000067.cfg
T41P
y000000000036.cfg
T41S
y000000000068.cfg
T40P
y000000000054.cfg
T40G
y000000000076.cfg
T29G
y000000000046.cfg
T27P
y000000000045.cfg
T27G
y000000000069.cfg
You can deploy and maintain a mass of Yealink IP phones automatically through configuration files
stored in a provisioning server.
Topics
Common CFG File
MAC CFG File
Configuration File Customization
Configuration File Attributes
Common CFG File
Common CFG file, named <y0000000000xx>.cfg, contains parameters that affect the basic operation of
the IP phone, such as language and volume. It will be effective for all IP phones in the same model. The
common CFG file has a fixed name for each phone model.
The following table lists the name of the common CFG file for each IP phone model:
57
Page 78
Administrator’s Guide for SIP-T2 Series/T4 Series/T5 Series IP Phones
Phone Model
Common CFG file
T23P/G
y000000000044.cfg
T21(P) E2
y000000000052.cfg
T19(P) E2
y000000000053.cfg
Tip
MAC address, a unique 12-digit serial number is assigned to each phone. You can obtain it from the bar
code on the back of the IP phone.
Note
The non-static changes that you made before enabling the provisioning priority mechanism are not saved in
the generated MAC-local file, but the previous settings still take effect on the phone. The static changes are
never be saved to the <MAC>-local.cfg file.
The provisioning priority mechanism is enabled by the parameter “static.auto_provision.custom.protect”.
MAC CFG File
Yealink supports two MAC CFG file: MAC-Oriented file and MAC-local CFG file, which are both named
after the MAC address of the IP phone. For example, if the MAC address of an IP phone is 00156574B150,
the name of MAC-Oriented CFG file is 00156574b150.cfg (lowercase), and the name of MAC-local CFG
file is 00156574b150-local.cfg (lowercase).
Topics
MAC-Oriented CFG File
MAC-local CFG File
MAC-Oriented CFG File
MAC-Oriented CFG file, named <MAC>.cfg, contains parameters unique to a particular phone, such as
account registration. It will only be effective for a MAC-specific IP phone.
MAC-local CFG File
MAC-local CFG file, named <MAC>-local.cfg, contains changes associated with non-static parameter that
you make via web user interface or phone user interface (for example, changes for time and date formats,
ring tones, and DSS keys).
This file generates only if you enable the provisioning priority mechanism. It is stored locally on the IP
phone and you can upload it to the provisioning server each time the file updates. This file enables the
users to keep their personalized configuration settings, even though the IP phone performs auto
provisioning.
58
Page 79
Phone Provisioning
Parameter
static.auto_provision.custom.protect
<y0000000000xx>.cfg
Description
It enables or disables the IP phone to keep user’s personalized settings after auto
provisioning.
Note: The provisioning priority mechanism (phone/web user interface >central
provisioning >factory defaults) takes effect only if the value of this parameter is set to
1 (Enabled). If “overwrite_mode” is set to 1 in the boot file, the value of this parameter
will be set to 1 (Enabled).
Permitted
Values
0-Disabled
1-Enabled, <MAC>-local.cfg file generates and personalized non-static settings
configured via web or phone user interface will be kept after auto provisioning.
Default
0
Parameter
static.auto_provision.custom.sync
<y0000000000xx>.cfg
Description
It enables or disables the IP phone to upload the <MAC>-local.cfg file to the server
each time the file updates, and to download the <MAC>-local.cfg file from the server
during auto provisioning.
Note: It works only if “static.auto_provision.custom.protect” is set to 1 (Enabled). The
upload/download path is configured by the parameter
“static.auto_provision.custom.sync.path”.
Permitted
Values
0-Disabled
1-Enabled
Default
0
Parameter
static.auto_provision.custom.sync.path
<y0000000000xx>.cfg
Description
It configures the URL for uploading/downloading the <MAC>-local.cfg file.
If it is left blank, the IP phone will try to upload/download the <MAC>-local.cfg file
to/from the provisioning server.
Note: It works only if “static.auto_provision.custom.sync" is set to 1 (Enabled).
Permitted
Values
URL
Topics
MAC-local CFG File Configuration
Clearing MAC-local CFG File
MAC-local CFG File Configuration
By default, the MAC-local.cfg file is stored on the IP phone. You can configure the phone to upload this
file to the provisioning server each time the file updates.
The following table lists the parameters you can use to generate and upload the MAC-local CFG file.
59
Page 80
Administrator’s Guide for SIP-T2 Series/T4 Series/T5 Series IP Phones
Default
Blank
Parameter
static.auto_provision.custom.upload_method
[1]
<y0000000000xx>.cfg
Description
It configures the way the IP phone uploads the <MAC>-local.cfg file,
<MAC>-calllog.xml file or <MAC>-contact.xml file to the provisioning server (for
HTTP/HTTPS server only).
Permitted
Values
0-PUT
1-POST
Default
0
Note
The Reset local settings option on the web/phone user interface appears only if you set
“static.auto_provision.custom.protect = 1”.
If you set “static.auto_provision.custom.sync = 1”, the MAC-local.cfg file on the provisioning server will be
cleared too. If not, the MAC-local.cfg file is kept on the provisioning server, and the IP phone could
download it and update the configurations to the phone after the next auto provisioning.
Clearing MAC-local CFG File
When the IP phone is given to a new user but many personalized configurations settings of the last user
are saved on the phone; or when the end user encounters some problems because of the wrong
configurations, you can clear user’s personalized configuration settings.
Via phone user interface at the path: Menu->Advanced (default password: admin) ->Reset
Config->Reset local settings.
Via web user interface at the path: Settings->Upgrade->Reset Local Settings.
Configuration File Customization
You can create some new CFG files by making a copy and renaming the configuration template file (for
example, sip.cfg, account.cfg). You can rearrange the parameters in the configuration template file and
create your own configuration files with parameters you want. This flexibility is especially useful when you
want to apply specific settings to a group of phones.
Topic
Customizing a Configuration File
Customizing a Configuration File
1. Copy and rename a configuration template file. For example,
2. Rearrange the parameters in the
sip.cfg
, and set the valid values for them.
For example:
phone_setting.contrast = 7
sip.cfg
.
60
Page 81
Phone Provisioning
Attributes
Description
#!version:1.0.0.1
It must be placed in the first line. Do not edit and delete.
Configuration
Parameter=Valid Value
(for example,
features.dnd_mode = 1)
Specify the parameters and values to apply specific settings to the
phones.
Separate each configuration parameter and value with an equal
sign
Set only one configuration parameter per line
Put the configuration parameter and value on the same line, and
do not break the line
[$MODEL]
The [$MODEL] can be added in front of configuration parameter to
specify the value for specific phone models. $MODEL represents the
phone model.
The valid phone model names are: T54S, T52S, T48S, T48G, T46S, T46G,
Multiple phone models are separated by commas. For example, [T46S,
T23G].
Note: The phone updates model-specific configurations and those
local_time.time_format = 1
account.1.dnd.enable = 1
account.2.dnd.enable = 1
features.dnd.enable = 0
3.To specify parameters for specific phone models, add specific phone models in the front of the
corresponding parameters. Multiple phone model names are separated by commas.
For example:
[T46S,T48S]voice_mail.number.1 = *5
[T27G]account.1.dnd.enable = 1
[T46S]account.2.dnd.enable = 1
[T48S]features.dnd.enable = 0
## These parameters only apply to their own specific phone models.
4. Save the configuration file and place it on the provisioning server.
Related Topic
Configuration File Attributes
Configuration File Attributes
The following table lists the attributes you need to know in the configuration template file.
61
Page 82
Administrator’s Guide for SIP-T2 Series/T4 Series/T5 Series IP Phones
Attributes
Description
model-unspecified configurations.
Tip
The line beginning with “#” is considered to be a comment.You can use “#” to make any comment in the
boot file.
Tip
If you want to specify the desired phone to use the resource file, the access URL of resource file should be
specified in the MAC-Oriented CFG file. During auto provisioning, the IP phones will request the resource
files in addition to the configuration files.
Template File
File Name
Description
Reference in Section
AutoDST Template
AutoDST.xml
Add or modify time
zone and DST settings.
DST Settings
Language Packs
For example,
000.GUI.English.lang
1.English_note.xml
1.English.js
Customize the
translation of the
existing language on
the phone/web user
interface.
Language
Customization
Keypad Input
Method File
ime.txt
Russian_ime.txt
Hebrew_ime.txt
Customize the existing
input method.
Input Method File
Customization
Replace Rule
Template
DialPlan.xml
Customize replace
rules for dial plan.
ReplaceRuleFile
Customization
Dial Now Template
DialNow.xml
Customize dial now
rules for dial plan.
DialNowFile
Customization
Resource Files
Resource files are optional, but if the particular feature is being employed, these files are required. You
need to place resource files on the provisioning server. The IP phones request the resource files in
addition to the configuration files during auto provisioning.
Topic
Supported Resource Files
Supported Resource Files
Yealink supplies some template of resource files for you, so you can directly edit the files as required.
The following table lists the resource files Yealink supplies:
62
Page 83
Phone Provisioning
Template File
File Name
Description
Reference in Section
Softkey Layout
Template
CallFailed.xml
CallIn.xml
Connecting.xml
Dialing.xml
RingBack.xml
Talking.xml
Customize soft key
layout for different call
states.
Softkey Layout File
Customization
Directory Template
favorite_setting.xml
Customize the
directory list.
Directory List File
Customization
Super Search
Template
super_search.xml
Customize the search
source list.
Search Source File
Customization
Local Contact File
contact.xml
Add or modify multiple
local contacts.
LocalContactFile
Customization
Remote Phone Book
Template
Department.xml
Menu.xml
Add or modify multiple
remote contacts.
Remote Phone Book
File Customization
Screen Saver
Template
CustomScreenSaver.xml
Customize the XML
items (for example,
notifications, company
logo) which will be
displayed on screen
saver.
Screensaver Display
Customization
Files Download Process
When you provision the IP phones, the phones will request to download the boot files, configuration files
and resource files from the provisioning server according to the following flowchart:
63
Page 84
Administrator’s Guide for SIP-T2 Series/T4 Series/T5 Series IP Phones
Note
For the phone running firmware version 82 or earlier, it downloads configuration files referenced in the boot
file in sequence.
For the phone running firmware version 83 or later, “specific_model.excluded_mode” determines which
configuration files referenced in the boot file to be downloaded.
The parameters in the new downloaded configuration files will override the same parameters in files
downloaded earlier.
Provisioning Methods
Yealink provides two ways to provision your phones:
Manual Provisioning: provisioning via the local phone user interface or web user interface.
Central Provisioning: provisioning through configuration files stored in a central provisioning server.
The method you use depends on how many phones need to be deployed and what features and settings
to be configured. Manual provisioning on web or phone user interface does not contain all of the phone
settings available with centralized method. You can use the web user interface method in conjunction
with central provisioning method and phone user interface method. We recommend using centralized
provisioning as your primary provisioning method when provisioning multiple phones.
Topics
Provisioning Methods Priority
64
Page 85
Phone Provisioning
Note
The provisioningpriority mechanism takes effect only if “static.auto_provision.custom.protect” is set to 1.
For more information on this parameter, refer to MAC-local CFG File Configuration.
Static parameters have no priority. They take effect no matter what method (web user interface or phone
user interface or configuration files) you are using for provisioning.
Static parameters are the parameters that start with a prefix“static.”, for example, the parameters associated
with auto provisioning/network/syslog, TR069 settings and internal settings (the temporary configurations
to be used for program running).
Note
When you manually configure a phone via web user interface or phone user interface, the changes
associated with non-static parameters you make will be stored in the MAC-local CFG file. For more
information on MAC-local CFG file, refer to MAC-local CFG File.
Manual Provisioning
Central Provisioning
Provisioning Methods Priority
There is a priority for configuration among the provisioning methods - settings you make using a higher
priority provisioning method override settings made using a lower priority provisioning method.
The precedence order for configuration parameter changes is as follows (highest to lowest):
Manual Provisioning
This method enables you to perform configuration changes on a per-phone basis.
Topics
Web User Interface
Phone User Interface
Web User Interface
You can configure IP phones via web user interface, a web-based interface that is especially useful for
remote configuration. You can either import a configuration file to the phone or export a configuration
65
Page 86
Administrator’s Guide for SIP-T2 Series/T4 Series/T5 Series IP Phones
file containing phone’s current settings to your computer to make changes.
Because features and configurations vary by phone models and firmware versions, options available on
each page of the web user interface can vary as well. Note that the features configured via web user
interface are limited. Therefore, you can use the web user interface in conjunction with central
provisioning method and phone user interface.
Topics
Web User Interface Access
Navigating the Web User Interface
Importing CFG Configuration Files to Phone
Exporting CFG Configuration Files from Phone
Web User Interface Access
When configuring IP phones via web user interface, you require a user name and password for access. For
a user, the default user name and password are “user” (case-sensitive). For an administrator, the default
user name and password are “admin” (case-sensitive).
Topics
Accessing the Web User Interface
QuickLoginConfiguration
Web Server Type Configuration
Accessing the Web User Interface
Procedure
1. Find the phone IP address. Press the OK key when the phone is idle or navigate to Menu->Status
on the phone.
2.Enter the IP address in the address bar of a web browser on your PC.
For example, for IPv4: http://192.168.0.10 or 192.168.0.10; for IPv6:
http://[2005:1:1:1:215:65ff:fe64:6e0a] or [2005:1:1:1:215:65ff:fe64:6e0a]
3. Enter the user name and password.
4. Click Login.
Related Topics
Web Server Type Configuration
User and Administrator Identification
66
Page 87
Phone Provisioning
Note
Accessing the web user interface by request URI may be restricted by the web explorer (e.g., Internet
Explorer).
For security purposes, we recommend you to use this feature in a secure network environment.
Parameter
wui.quick_login
<y0000000000xx>.cfg
Description
It enables or disables the quick login feature.
Note: It works only if “static.wui.https_enable” is set to 1 (Enabled).
Permitted
Values
0-Disabled
1-Enabled, you can quickly log into the web user interface using a request URI (for
example, https://admin:admin@192.168.0.10).
Default
0
Parameter
wui.secure_domain_list
<y0000000000xx>.cfg
Description
It configures the valid domain name to access the web user interface of the IP phone.
Multiple domain names are separated by semicolons.
Example:
wui.secure_domain_list = test.yealink.com
You are only allowed to use test.yealink.com or IP address to access the web user
interface of the IP phone.
Note: To use a domain name to access the web user interface of the IP phone, make
sure your DNS server can resolve the domain name to the IP address of the IP phone.
Permitted
Values
String
If it is left blank, you are only allowed to use IP address to access the web user
interface of the IP phone.
If it is set to “any”, you can use IP address or any domain name to access the web user
interface of the IP phone.
Default
any
Quick Login Configuration
You can access to web user interface quickly using the request URI
“https://username:password@phoneIPAddress” (for example, https://admin:admin@192.168.0.10). It will
locate you in the Status web page after accessing the web user interface. It is helpful to quickly log into
the web user interface without entering the username and password in the login page.
Yealink IP phones support domain name customization. You can use a custom domain name to access
the web user interface.
The following table lists the parameter you can use to configure quick login.
67
Page 88
Administrator’s Guide for SIP-T2 Series/T4 Series/T5 Series IP Phones
Parameter
static.wui.http_enable
[1]
<y0000000000xx>.cfg
Description
It enables or disables the user to access the web user interface of the IP phone using
the HTTP protocol.
Permitted
Values
0-Disabled
1-Enabled
Default
1
Web UI
Network->Advanced->Web Server->HTTP
Phone UI
T54S/T52S/T48S/T48G/T46S/T46G/T29G:
Menu->Advanced (default password: admin) ->Network->Web Server->HTTP Status