ErisTerminal® SIP Deskset
ET685
Administrator and Provisioning Manual
Rev. 1 06/18
ET685 Administrator and Provisioning Manual
C
ONTENTS
Preface ...................................................................................................... 6
Text Conventions ................................................................................................................ 7
Audience............................................................................................................................. 7
Related Documents ............................................................................................................7
Introducing the ET685.............................................................................. 8
About the ET685 Deskset................................................................................................... 9
Quick Reference............................................................................................................... 11
Programmable Keys .........................................................................................................12
Configuration Methods ..................................................................................................... 13
Provisioning............................................................................................ 14
Auto Provisioning..............................................................................................................15
Requirements ...................................................................................................... 15
Saving Configuration Files...................................................................................15
Scenarios............................................................................................................. 16
DHCP Option 66/67 ...................................................................................... 16
DHCP Options...............................................................................................17
Plug & Play....................................................................................................19
Automatic Redirection Service ......................................................................20
TR-069 Provisioning......................................................................................21
Bootup Process ...................................................................................................23
Configuration File Types......................................................................................24
ASCII Format ....................................................................................................... 26
Structure........................................................................................................ 26
Hints ..............................................................................................................26
Flags ............................................................................................................. 26
General Setting File ......................................................................................26
Specific Setting File.......................................................................................27
Firmware Setting File ....................................................................................28
XML Format ......................................................................................................... 29
Structure........................................................................................................ 29
Setting Files Container <setting-files>........................................................... 30
Settings Container <settings> ....................................................................... 30
2
ET685 Administrator and Provisioning Manual
Supported Container Tags and Sub Tags...................................................... 31
XML Syntax...................................................................................................51
Manual Software Update ..................................................................................................52
Phone Menu Reference.......................................................................... 53
Viewing the Phone Menu.................................................................................................. 54
Alphanumeric keypad ..........................................................................................54
Input modes and navigation .......................................................................... 54
Entering numerals, letters, special characters, and symbols ........................ 55
Using the Identity menu.................................................................................................... 57
Select Outgoing Identity menu............................................................................. 57
Reregister Identity menu...................................................................................... 57
Edit Identity menu ................................................................................................ 58
Edit Identity (Hotdesking) .............................................................................. 58
Edit Identity ................................................................................................... 59
Logging off identity............................................................................................... 63
Using the Network menu .................................................................................................. 64
IP Settings menu .................................................................................................64
IPv4 settings.................................................................................................. 64
IPv6 Settings .................................................................................................66
Webserver menu .................................................................................................67
VLAN menu .........................................................................................................69
WLAN menu ........................................................................................................70
Advanced menu................................................................................................... 72
802.1X menu................................................................................................. 72
Hardware menu.............................................................................................74
NTP menu ..................................................................................................... 76
DNS menu.....................................................................................................77
Using the Maintenance menu...........................................................................................79
Security menu...................................................................................................... 79
Putting your phone in User Mode.................................................................. 79
Putting your phone in Administrator Mode .................................................... 79
Changing the Keyboard Lock PIN.................................................................80
Reboot ................................................................................................................. 82
Reset Values........................................................................................................ 82
Using the Information Menu ............................................................................................. 84
Status Info............................................................................................................ 84
System Info.......................................................................................................... 85
Help ..................................................................................................................... 85
Web User Interface (WebUI) Reference................................................ 87
Using the Web User Interface (WebUI) ............................................................................ 88
Accessing the WebUI .......................................................................................... 88
Changing settings in the WebUI .......................................................................... 89
Operation pages ...............................................................................................................91
Home page .......................................................................................................... 91
Directory page .....................................................................................................93
Setup pages...................................................................................................................... 97
3
ET685 Administrator and Provisioning Manual
Preferences page ................................................................................................ 97
Speed Dial page ................................................................................................ 103
Function Keys page ...........................................................................................105
Type ............................................................................................................ 106
Key Events .................................................................................................. 111
Identity n page ................................................................................................... 113
Login tab ..................................................................................................... 113
Features tab ................................................................................................ 117
SIP tab ........................................................................................................ 123
NAT tab ....................................................................................................... 130
RTP tab .......................................................................................................132
Action URL Settings page.................................................................................. 134
Advanced pages................................................................................................137
Network tab ................................................................................................. 137
Behavior tab ................................................................................................ 145
Audio tab ..................................................................................................... 151
SIP/RTP tab ................................................................................................ 154
QoS/Security tab ......................................................................................... 162
Update tab...................................................................................................166
Certificates page................................................................................................ 170
Unknown Certificates tab ............................................................................ 170
Custom Certificates..................................................................................... 171
802.1X Certificates...................................................................................... 171
Preinstalled Certificates...............................................................................172
Software Update................................................................................................172
Status pages...................................................................................................................175
System Information page................................................................................... 175
Log page............................................................................................................ 175
SIP Trace page.................................................................................................. 176
DNS Cache........................................................................................................ 177
Subscriptions .....................................................................................................177
PCAP Trace page.............................................................................................. 178
Memory page..................................................................................................... 179
Settings page..................................................................................................... 179
Configuration File Parameter Guide................................................... 181
Configuration File Parameters ........................................................................................182
Troubleshooting................................................................................... 421
Common Troubleshooting Procedures........................................................................... 421
Appendixes........................................................................................... 423
Appendix A: Maintenance............................................................................................... 423
4
ET685 Administrator and Provisioning Manual
5
P
REFACE
Congratulations on your purchase of this VTech product. Please thoroughly read this
manual for all the feature operations and troubleshooting information necessary to install
and operate your new VTech product. You can also visit our website at
businessphones.vtech.com or call 1 (888) 370-2006.
ET685 Administrator and Provisioning Manual
This administrator and provisioning manual contains detailed instructions for installing and
configuring your ET685 SIP Deskset with software version 8.10.1.x. See “System Info” on
page 85 for instructions on checking the software version on the ET685. Please read this
manual before installing the product.
Please print this page and record the following information regarding your product:
Model number: ET685
Type: Small to medium business SIP-endpoint deskset
Serial number: _______________________________
Purchase date: _______________________________
Place of purchase: ____________________________
Both the model and serial numbers of your VTech product can be found on the bottom of
the console.
Save your sales receipt and original packaging in case it is necessary to return your
telephone for warranty service.
Preface 6 Back to Contents
ET685 Administrator and Provisioning Manual
CallFwd
Notes provide important information
about a feature or procedure.
A caution means that loss of data or
unintended circumstances may result.
Text Conventions
Table 1 lists text formats and describes how they are used in this guide.
Table 1. Description of Text Conventions
Text Format Description
Screen Identifies text that appears on a device screen or a
WebUI page in a title, menu, or prompt.
HARD KEY or DIAL-PAD KEY Identifies a hard key, including the dial-pad keys.
Identifies a soft key.
Example of a Note.
Example of a Caution.
Audience
This guide is written for installers and system administrators. It assumes that you are
familiar with networks and VoIP, both in theory and in practice. This guide also assumes
that you have ordered your IP PBX equipment or service and selected which PBX features
you want to implement. This guide references specific IP PBX equipment or services only
for features or settings that have been designed for a specific service. Please consult your
equipment supplier or service provider for recommended switches, routers, and firewall
and NAT traversal settings, and so on.
As the ET685 SIP Deskset becomes certified for IP PBX equipment or services, VTech may
publish interop guides for those specific services. The interop guides will recommend
second-party devices and settings, along with ET685-specific configurations for optimal
performance with those services. For the latest updates, visit our website at
businessphones.vtech.com.
Related Documents
The ET685 Quick Start Guide contains a quick reference guide to the ET685 external
features and brief instructions on connecting the ET685 to a working IP PBX system.
The ET685 User Guide contains a quick reference guide, full installation instructions,
instructions for making and receiving calls, and a guide to all user-configurable settings.
The documents are available from our website at businessphones.vtech.com.
Preface 7 Back to Contents
I
NTRODUCING
THE
ET685 Administrator and Provisioning Manual
C HAPTER 1
ET685
This administrator and provisioning guide contains detailed instructions for configuring the
ET685 SIP Deskset. Please read this guide before attempting to configure the ET685.
This chapter covers:
“About the ET685 Deskset” on page 9.
“Quick Reference” on page 11.
“Programmable Keys” on page 12.
“Configuration Methods” on page 13.
Introducing the ET685 8 Back to Contents
About the ET685 Deskset
The VTech ET685 SIP Deskset is a business phone designed to work with popular SIP
telephone (IP PBX) equipment and services. Once you have ordered and configured your
SIP equipment or service, the ET685 enables you to make and receive calls as you would
with any other business phone.
The ET685 Deskset features include:
Support for 12 SIP lines/accounts
Dual Ethernet ports, GigE
USB port
Power over Ethernet (PoE) support (AC adapter optional)
4.3-inch 480 x 272 pixels (w x h) color LCD display, providing 10 clear lines of
information
4 configurable soft keys
ET685 Administrator and Provisioning Manual
6 programmable feature keys with multi-color LEDs
4-way navigational pad
Zero touch provisioning
RJ9 headset port
RJ12 EHS port
Sensor hook switch
HD Voice for receiver and speakerphone
Full-duplex base speakerphone
Message waiting LED indicator
Local phonebook up to 1,000 entries
Call history up to 100 entries
There are two network ports, known as the Ethernet port and PC port, at the back of the
ET685. The Ethernet port allows the ET685 Deskset to connect to the IP PBX. The PC port
is for another device such as a personal computer to connect to the Ethernet network
through the ET685.
You can configure the ET685 using the menus on the phone, a browser-based interface
called the WebUI, or an automatic provisioning process (see “Auto Provisioning” on
page 15). The WebUI enables you to configure the ET685 using a computer that is
connected to the same Local Area Network. The WebUI resides on the ET685, and may
get updated with firmware updates.
Introducing the ET685 9 Back to Contents
ET685 Administrator and Provisioning Manual
The ET685 SIP Deskset supports intercom and call transfers between system extensions
and can connect you and two other parties on the same conference call. The ET685 has
four programmable soft keys and 6 programmable feature keys. You can program these
keys for quick dial, busy lamp field, line access or any of the functions described in
“Function Keys page” on page 105.
Introducing the ET685 10 Back to Contents
Quick Reference
The following diagram shows the ET685 external features and controls.
ET685 Administrator and Provisioning Manual
Introducing the ET685 11 Back to Contents
Programmable Keys
You can use the WebUI to change the function of the four soft keys below the display,
navigation keys, customizable function keys, and programmable LED function keys.
For more information, see “Function Keys page” on page 105.
ET685 Administrator and Provisioning Manual
Introducing the ET685 12 Back to Contents
Configuration Methods
You can use any of the following methods to configure your ET685 SIP Deskset:
Provisioning – see “Provisioning” on page 14.
Phone User Interface – see “Phone Menu Reference” on page 53.
Web User Interface (WebUI) – see “Web User Interface (WebUI) Reference” on
page 87.
ET685 Administrator and Provisioning Manual
Introducing the ET685 13 Back to Contents
P
ROVISIONING
ET685 Administrator and Provisioning Manual
C HAPTER 2
Provisioning refers to the process of acquiring and applying new settings for the ET685
using configuration files retrieved from a remote computer. After a ET685 is deployed,
subsequent provisioning can update the ET685 with new settings; for example, if your
service provider releases new features.
With automatic provisioning, you enable the ET685 to get its settings automatically—the
process occurs in the background as part of routine system operation. Automatic
provisioning can apply to multiple devices simultaneously.
With Manual Software Update on the WebUI, you update the ET685 settings (configuration
and/or firmware) yourself via Setup > Software Update.
This chapter covers
“Auto Provisioning” on page 15
“Manual Software Update” on page 52
Provisioning 14 Back to Contents
Auto Provisioning
Auto Provisioning (Mass deployment) enables remote administration (configuration and
maintenance) of the ET685 deskset.
Auto Provisioning is particularly useful for out-of-the-box scenarios in larger phone
installations.
Auto Provisioning can be used to provide general and specific configuration parameters
(Settings) to the phones and to manage firmware actualization.
Requirements
Auto Provisioning requires a central setting (or provisioning) server.The Auto Provisioning
Server stores the Auto Provisioning Configuration Files and provides them on request to
the phones. Firmware images may also be stored here.
The following setting server types/protocols can be used for provisioning of configuration
parameters and firmware images: TFTP Server, HTTP Server, and HTTPS Server.
Selected Configuration parameters can be stored in configuration files (phone type/MAC
address based) or can be created on request by means of script files (MAC address
based). See “Configuration File Types” on page 24. The location of these files is defined in
the parameter setting_server.
ET685 Administrator and Provisioning Manual
Please check the Bootup Process in order to select the appropriate auto provisioning
method. See “Bootup Process” on page 23.
Saving Configuration Files
You can save a sample configuration file from your phone using the WebUI interface.
1. Open the ET685 WebUI interface, and open the Settings page.
2. To save the settings, click the link for the file format you want.
The first link will save the settings in ASCII format.
Provisioning 15 Back to Contents
ET685 Administrator and Provisioning Manual
NOTE: VTech recommends that you only work with XML format when saving
configuration files.
You can now make copies of the settings file, and edit them as required for auto
provisioning.
Scenarios
Depending on the installation environment, the following scenarios can be applied to
provide the setting (provisioning) URL to the phones:
1. DHCP Option 66/67 - see page 16.
The DHCP Server in the LAN may send the provisioning URL via Option 66/67.
2. Plug & Play - see page 19.
Any SIP Server in the LAN may send the provisioning URL by replying to SIP SUBSCRIBE Broadcast messages.
3. Automatic Redirection Service - see page page 20.
VTech’s public provisioning server will be contacted automatically and may redirect
MAC address based provisioning requests to any other server.
4. TR-069 Provisioning - see page page 21.
Either scenario 1/2/3 can be used to enable the phone for TR-69 Provisioning.
DHCP Option 66/67
This configuration method requires the following components:
DHCP Server
ONE DHCP Server per LAN supporting DHCP Option(s) 66 or/and 67.
See “DHCP Options” on page 17.
Auto Provisioning Server
Configuration files
See “Configuration File Types” on page 24.
VTech VOIP Phone Configuration
The DHCP Server must be configured with additional DHCP Options containing the URL of
the Auto Provisioning Server to the VTech VoIP phones on boot-up. The phones will then
request their configuration parameters from the Auto Provisioning Server which will result
in a ready-to-use phone setup without manual configuration.
Provisioning 16 Back to Contents
DHCP Options
Option 66 (TFTP server name)
ET685 Administrator and Provisioning Manual
This option is used to identify a TFTP server when the 'sname' field in the DHCP header
has been used for DHCP options. The code for this option is 66, and its minimum length is
1.
VALIDVALUE
<protocol> : // <IP address> or <domain> e.g. http://10.0.0.2,
https://provisioning.company.com
<IP address> or <domain> e.g. 10.0.0.2, provisioning.company.com
where <protocol> = server type/protocol
where <IP address> = server IP address
where <domain> = server domain name
NOTE: Without specifying the <protocol> the firmware will attempt all supported server
protocol types consecutively:
1. tftp://...
2. http://...
3. https://...
Configuration Parameter: update_server
Option 67 (Bootfile name)
This option is used to identify a bootfile when the 'file' field in the DHCP header has been
used for DHCP options. The code for this option is 67, and its minimum length is 1.
Provisioning 17 Back to Contents
ET685 Administrator and Provisioning Manual
VALIDVALUE
<path> e.g. settingfiles/vtech/VTechET685.cfg, settingfiles/vtech/ VTechET685.htm,
settingfiles/vtech/VTechET685.xml
<empty> or <not used>
where <path> = path to the location of the setting file/script file
NOTE: If this option is empty or not specified at all the firmware automatically requests the
following setting files, except the whole URL is encoded in option 66:
all ET685 phones request --> http://<domain>/VTechET685.htm
Configuration Parameter: update_filename
Option 43 (vendor-encapsulated-options)
Encapsulated Option 66, Option 67, Option 132, and Option 133 are supported.
Encapsulated DHCP options, for encoding see RFC 2132 Section 2. DHCP Option Field
Format; One can tunnel vendor specific DHCP options depending on the vendor-id (option
60) send before from the phone to the DHCP server. Vendor specific DHCP options may
be provided encapsulated in option 43, see RFC 2132 Section 8.4. Vendor Specific
Information. Values of options like 66/67/132/133, which are tunneled via option 43, take
precedence over direct options 66/67/132/133.
VALIDVALUE (Examples)
linux dhcpd3 syntax:
option vendor-encapsulated-options
42:0c:68:74:74:70:3a:2f:2f:74:65:73:74:00:43:12:73:6e:6f:6d:2f:73:65:74:74:6
9:6e:67:73:2e:70:68:70:00;
Which means tunnel opt 66 http://test and opt 67 vtech/settings.php via opt 43.
option vendor-encapsulated-options
84:02:33:00;
Which means tunnel opt 132 value 3 via opt 43.
option vendor-encapsulated-options
84:04:31:31:34:00:85:02:35:00;
Which means tunnel opt 132 value 114 and opt 133 value 5 via opt 43.
Option 60 (Vendor class identifier)
This option is used by DHCP clients to optionally identify the vendor type and configuration
of a DHCP client. The information is a string of n octets, interpreted by servers. Vendors
may choose to define specific vendor class identifiers to convey particular configuration or
other identification information about a client. For example, the identifier may encode the
client's hardware configuration. Servers not equipped to interpret the class-specific
Provisioning 18 Back to Contents
ET685 Administrator and Provisioning Manual
information sent by a client MUST ignore it (although it may be reported). Servers that
respond SHOULD only use option 43 to return the vendor-specific information to the client.
The code for this option is 60, and its minimum length is 1.
The phone sends its type (i.e. VTechET685) via this option to the DHCP server.
NOTE: Vendor class identifier for VTech ET685: VTechET685
Plug & Play
Plug & Play (PnP) provides a proprietory method to enable Auto Provisioning on all VTech
VoIP phones. By default (Parameter pnp config = on) the phones send SIP SUBSCRIBES
messages to a multicast address. Any SIP server understanding that message may reply
with a SIP NOTIFY message containing the Auto Provisioning Server URL where the
phones can request their configuration from.
SIP Flow
ET685 phones send on boot-up a SIP SUBSCRIBE message to a multicast address:
Sent to udp:224.0.1.75:5060 at 24/12/2001 00:00:19:248 (448 bytes):
SUBSCRIBE sip:MAC%3a00135E874B49@intern.vtech.ca SIP/2.0
Via: SIP/2.0/UDP 192.168.10.67:5060;rport
From: <sip:MAC%3a00135E874B49@intern.vtech.ca>;tag=658512961
To: <sip:MAC%3a00135E874B49@intern.vtech.ca>
Call-ID: 1930770594@192.168.10.67
CSeq: 1 SUBSCRIBE
Event: ua-profile;profile-type=device;vendor=OEM;model=OEM;version=7.1.19
Expires: 0
Accept: application/url
Contact: <sip:192.168.10.67:5060>
Content-Length: 0
If any SIP application within one hop range understands this message a confirmation is
sent:
Received from udp:192.168.100.10:5060 at 24/12/2001 00:00:19:287 (480 bytes):
SIP/2.0 200 OK
Via: SIP/2.0/UDP 192.168.10.67:5060;rport=5060
Record-Route: <sip:127.0.0.1;lr;transport=tcp;route-id=fb4fb92b7775c2a7>
Record-Route:
<sip:192.168.100.10;lr;transport=UDP;route-id=fb4fb92b7775c2a7>
Contact: <sip:192.168.100.10;transport=TCP;handler=dum>
To: <sip:MAC%3a00135E874B49@intern.vtech.ca>;tag=91955270
From: <sip:MAC%3a00135E874B49@intern.vtech.ca>;tag=658512961
Call-ID: 1930770594@192.168.10.67
CSeq: 1 SUBSCRIBE
Expires: 0
Content-Length: 0
followed by a SIP NOTIFY message containing the Auto Provisioning URL
Provisioning 19 Back to Contents
ET685 Administrator and Provisioning Manual
http://192.168.100.10/sipphone/sipphoneconfig.xml?mac={mac}:
Received from udp:192.168.100.10:5060 at 24/12/2001 00:00:19:293 (868 bytes):
NOTIFY sip:192.168.10.67:5060 SIP/2.0
Via: SIP/2.0/UDP
192.168.100.10:5060;branch=z9hG4bK-d8754z-c3ea5f0e74462613-1---d8754z-;rport
Via: SIP/2.0/TCP
127.0.0.1:5060;branch=z9hG4bK-d8754z-7ca96c30144f3e04-1---d8754z-;rport=4091
6
Max-Forwards: 20
Record-Route: <sip:192.168.100.10;lr;route-id=e3470eb400e9c0a4>
Record-Route: <sip:127.0.0.1;lr;transport=TCP;route-id=e3470eb400e9c0a4>
Contact: <sip:192.168.100.10;transport=TCP;handler=dum>
To: <sip:MAC%3a00135E874B49@intern.vtech.ca>;tag=658512961
From: <sip:MAC%3a00135E874B49@intern.vtech.ca>;tag=91955270
Call-ID: 1930770594@192.168.10.67
CSeq: 3 NOTIFY
Content-Type: application/url
Subscription-State: terminated;reason=timeout
Event: ua-profile;profile-type=device;vendor=OEM;model=OEM;version=7.1.19
Content-Length: 59
http://192.168.100.10/sipphone/sipphoneconfig.xml?mac={mac}
The phone accepts this message and confirms:
Sent to udp:192.168.100.10:5060 at 24/12/2001 00:00:19:315 (542 bytes):
SIP/2.0 200 Ok
Via: SIP/2.0/UDP
192.168.100.10:5060;branch=z9hG4bK-d8754z-c3ea5f0e74462613-1---d8754z-;rport
=5060
Via: SIP/2.0/TCP
127.0.0.1:5060;branch=z9hG4bK-d8754z-7ca96c30144f3e04-1---d8754z-;rport=4091
6
Record-Route: <sip:192.168.100.10;lr;route-id=e3470eb400e9c0a4>
Record-Route: <sip:127.0.0.1;lr;transport=TCP;route-id=e3470eb400e9c0a4>
From: <sip:MAC%3a00135E874B49@intern.vtech.ca>;tag=91955270
To: <sip:MAC%3a00135E874B49@intern.vtech.ca>;tag=658512961
Call-ID: 1930770594@192.168.10.67
CSeq: 3 NOTIFY
Content-Length: 0
Automatic Redirection Service
This redirection service enables customers to register/list/unregister the MAC addresses of
their VTech VoIP phones on VTech’s Redirect Server and assign a redirection URL pointing
to their own Auto Provisioning Server. Any ET685 updated to the latest firmware release
will have the Redirection Server URL available as the default Provisioning Server URL
Provisioning 20 Back to Contents
ET685 Administrator and Provisioning Manual
NOTE: Using the Redirection Service requires contacting the VTech support team for an
account.
TR-069 Provisioning
TR-069 is a standard for remote management of CPE (Customer Premises Equipment)
defined by the DSL Broadband Forum. TR-069 uses common transport mechanisms
(HTTP and HTTPS) for communication with CPE. The HTTP(S) messages contain
XML-RPC methods defined in the standard for configuration and management of the
device.
Typically, one router on customer premises provides Internet connectivity to many phones
as indicated in the above diagram. The ACS can now manage the router and all phones
located behind it remotely.
What does remote management mean?
Where provisioning was used to provide configuration information to many phones at once,
remote management takes this one step further. Of course, it is still possible to configure
the phone remotely when it boots up, but with TR-069 the phone can actually be managed
remotely.
In addition to the configuration you can also, for example:
Reboot the phone
Customize the phone look and feel
Push XML-Minibrowser pages to the phone
Update the firmware of the device
Provisioning 21 Back to Contents
ET685 Administrator and Provisioning Manual
Another difference is the way the actions are triggered. Unlike provisioning, where the
phone triggers the provisioning process according to a fixed schedule, TR-069 allows the
administrator to initiate provisioning via ACS at anytime. Another major difference is that in
case of TR-069 the server can be notified whenever a user changes a setting. This enables
the administrator to correct possible mistakes right away.
TR-069 specific phone settings
ACS settings are the settings specific to the ACS connection and need to be adjusted to
the specific environment. The following table describes the ACS settings with their data
types and default values.
Setting name Valid Values Default Description
tr69_acs_url URLs (STRING) empty URL of the TR-069 ACS. This is
the URL the phone will send
TR-069 messages to. Please
contact your ACS vendor to find
out about this URL.
tr69_acs_url URLs (STRING) empty URL of the TR-069 ACS. This is
the URL the phone will send
TR-069 messages to. Please
contact your ACS vendor to find
out about this URL.
tr69_acs_user STRING empty Username for HTTP
authentication against the ACS
tr69_acs_passwd STRING empty Password for HTTP
authentication against the ACS
tr69_use_acs BOOLEAN
(off, 0, on, 1)
tr69_bootstrap BOOLEAN
(off, 0, on, 1)
tr69_cnr_user STRING empt Username to authenticate
Internal settings (tr69_events, tr69_params, download_status) are used internally to
control the TR-069 stack and should not be modified manually.
off Turn TR-069 management on
and off.
on Send BOOTSTRAP event in
the Inform Message. Needs to
be set to on when a new ACS is
contacted.
incoming connection requests.
WARNING: modifying the internal settings manually may result in unexpected phone
behavior.
Provisioning 22 Back to Contents
ET685 Administrator and Provisioning Manual
Bootup Process
1. The firmware loads the configuration parameters (Settings) stored on the phone's flash
memory (either factory defaults or previously changed).
2. The firmware performs a check if the Provisioning URL (parameter setting_server) has
been changed manually.
YES: The given Provisioning URL (parameter setting_server) will be requested.
NO: see next step.
3. If the DHCP parameter is enabled the firmware performs a check whether the
supported DHCP options have been received in the DHCP offer:
YES:
The value found in Option 66 will be stored in parameter update_server,
e.g. http://server
The value found in Option 67 will be stored in parameter update_filename,
e.g. vtech/vtech.xml
Initially the Provisioning URL will be composed using update_server and
update_filename and will be requested,
e.g. http://server/vtech/vtech.xml. If Option 67 is absent, the Provisioning
URL is composed using update_server and {phoneType}.htm, e.g.
http://server/VTechET685.htm
In a second attempt the MAC address, i.e.-{mac}, will be concatenated and
the resulting Provisioning URL will be requested,
e.g. http://server/vtech/vtech-0011A0YXXXX.xml or
http://server/VTechET685-0011A0YXXXX.htm respectively.
NO: see next step.
4. Since the pnp_config parameter is enabled by default, the phone will send a SIP
SUBSCRIBE message to the multicast address 224.0.1.75:5060. The firmware waits
for a limited time whether a SIP NOTIFY reply is received with the Provisioning URL in
the body, e.g. http://server/vtech/vtech.xml
YES:
Initially the Provisioning URL found in the body will be requested,
e.g. http://server/vtech/vtech.xml
In a second attempt the MAC address, i.e.-{mac}, will be concatenated and the
resulting Provisioning URL will be requested,
e.g. http://server/vtech/vtech-0011A0YXXXX.xml
NO: see next step.
5. If none of the above steps could be applied the firmware requests the factory default
Provisioning URL: http://provisioning.vtech.com/vtechXXX/vtechXXX.php?mac={mac}
Provisioning 23 Back to Contents
ET685 Administrator and Provisioning Manual
6. IMPORTANT NOTE: If the parameter tr69_use_acs is enabled and will be delivered
back by any of the provisioning methods, the URL of the TR-069 ACS will be requested
immediately.
Configuration File Types
Setting files are container for a subset of configuration parameters needed to customize
and maintain the ET685 phone remotely.
Depending on the firmware version currently installed on the ET685 phone, two formats can
be distinguished:
ASCII text format (restrictions apply)
XML format
Provisioning 24 Back to Contents
ET685 Administrator and Provisioning Manual
The following hints apply to both ASCII Text Format and XML Format.
Hints ASCII Text Format AND XML Format
Start 1. Start with a factory reset phone
Apply the desired modifications in your working (live)
phone environment first.
Observe the stability and performance of the applied
changes.
2. Do NOT use the complete parameter list as starting point,
instead:
Delete or uncomment unused configuration
parameters from the complete parameter list.
Specify only those parameters you really want to
change --> Check the meaning of each parameter
before usage.
Finally your setting file may contain only a few
parameters.
Flags 1. Do NOT use read-only flags at the beginning. They can be
added at the end in order to protect certain parameters to
be notified by the user!
2. Inside firmware setting files do NOT use any flags at all.
Network/System
1. Do NOT provide network settings when using DHCP.
Settings
2. Do NOT specify setting_server unless a redirection to a
different setting server is desired.
Remember the phone has already obtained the setting
file correctly - repeated usage of the same setting
server can have unpredictable side effects and is
NOT recommended.
Firmware Setting
Files
1. Do NOT specify neither bootloader nor firmware inside
setting files:
In order to perform automated firmware updates
specify a firmware setting file URL inside firmware
status which points to the firmware setting file
containing the firmware image URL.
2. Inside firmware setting files use ONLY the configuration
parameters bootloader or firmware.
Provisioning 25 Back to Contents
ET685 Administrator and Provisioning Manual
ASCII Format
ASCII format provides limited provisioning support:
NO multiple language support. Only english phone user/web user interface
languages are pre-installed.
NO script dialplan
NO support of formerly used internal directory entries
[ Name (tn), Number (tu), Contact Type (tc), Outgoing Identity (to) ]
Structure
1. One general setting file per phone type, i.e. ET685, containing general configuration
parameters
2. One specific setting file per phone, i.e. (MAC address based), containing phone
specific configuration parameters.
3. One firmware setting file per phone type OR phone containing firmware related
configuration parameters in order to perform automated firmware updates.
Hints
Lines may end with newline or carriage return/newline pairs
Comments start with # or <
The < and > characters allow easy integration of HTML tags
Names may consist of the characters a-z, A-Z, 0-9 and _.
Flags
Parameter names can be followed by one specific character called flag:
A parameter followed by ! can be changed by the user. However the parameter
value will only be stored if that parameter has not been configured yet. Only
parameters followed by $ can be overwritten, DO NOT use ! in that case.
A parameter followed by &
(or no flag) becomes write-protected (read only)
A parameter followed by $ can be changed but will be overwritten on reboot.
$ will appear on the Settings page as !
General Setting File
General (phone type specific) setting files are requested from the setting server at first
example naming scheme: http://provisioning.mycompany.com/VTechET685.htm
in this case the general setting file was placed in the HTTP server root and will be requested
automatically by any ET685 --> necessary in mixed phone type environments
<html>
<pre>
Provisioning 26 Back to Contents
ET685 Administrator and Provisioning Manual
# example VTech general setting file
# After each setting (before the colon) you can set a flag
# General language and time configuration parameter
language$: English
web_language$: English
timezone$: USA-5
date_us_format&: on
time_24_format&: off
</pre>
</html>
Specific Setting File
The Phone specific setting file is requested from the setting server right after the general
setting file by appending
"-MAC address" (dash+phone's MAC address)
to the general setting filename:
http://provisioning.mycompany.com/VTechET685.htm) -->
http://provisioning.mycompany.com/VTechnABLE 2.8.1 User
Guide/VTechET685-000413241111.htm
<html>
<pre>
# example VTech specific setting file
# After each setting (before the colon) you can set a flag
user_pname1$: AUTHUSER1
user_pass1$: AUTHPASSWORD1
user_name1$: LINEPORT1
user_realname1$: User1
user_host1$: proxy.net
user_srtp1$: off
user_dp_str1$: !([^#]%2b)#!sip:\1@\d!d
user_pname2$: AUTHUSER2
user_pass2$: AUTHPASSWORD2
user_name2$: LINEPORT2
user_realname2$: User2
user_host2$: proxy.net
user_srtp2$: off
user_dp_str2$: !([^#]%2b)#!sip:\1@\d!d
# You may add up to 12 ET685 accounts
Provisioning 27 Back to Contents
ET685 Administrator and Provisioning Manual
# set 1st account to active outgoing identity
active_line$: 1
# the following parameters are only required to provide automated firmware
updates
# IMPORTANT: define the URL of the --> firmware setting file
firmware_status: http://provisioning.mycompany.com/VTechET685/firmware.htm
# additionally the --> update policy may be defined
update_policy: auto_update
# additionally the --> firmware update interval may be defined
firmware_interval: 2880
</pre>
</html>
Firmware Setting File
The firmware setting file is requested if the firmware_status URL has been defined either
in the general or --> specific setting file
example name: http://provisioning.mycompany.com/VTechET685/firmware.htm
<html>
<pre>
# example VTech firmware setting file
# Firmware setting specifies the URL of the firmware/root fs/linux image file
firmware:
http://provisioning.mycompany.com/firmware/VTechET685/VTechET685-X.X.bin
# Bootloader setting MUST NOT be used from Version 5.0 onwards
# bootloader:
</pre>
</html>
The firmware compares the URL (string) obtained from the firmware parameter with the last
firmware image URL successfully loaded by the phone --> if both strings are different the
provided firmware image URL is requested from the setting server otherwise no firmware
will be loaded.
Provisioning 28 Back to Contents
ET685 Administrator and Provisioning Manual
XML Format
XML Format provides Full provisioning support
Default phone configuration support
Automatic firmware update support
Multiple language support
Extended dial plan support
Directory provisioning support
Structure
1. One general setting file container <setting-files> per phone type, i.e. ET685, etc.,
providing a list of setting file URLs linked to:
One settings container
(<settings>) per phone type
containing general configuration parameters grouped in XML tags
(<phone-settings>, <functionKeys>, <tbook>, <dialplan>) OR/AND individual XML
Settings Files per phone type
containing general configuration parameters:(Phone settings
setting file, Function key setting file, Directory setting file, Dial plan setting file).
One Phone user interface
language file container per phone type with a list of phone user
interface language file URLs.
One Web user interface language file container per phone type with a list of
web user user interface language file URLs.
2. One specific setting file container <setting-files> per phone, i.e. MAC address
based, providing a list of setting file URLs linked to:
One settings container (<settings>) per phone containing phone specific
configuration parameters grouped in XML tags (<phone-settings>,
<functionKeys>, <tbook>, <dialplan>) AND/OR individual XML Settings Files
one per phone containing phone specific configuration parameters:(Phone
settings setting file, Function key setting file, Directory setting file, Dial plan setting
file).
3. Firmware setting files containing a subset of firmware related configuration parameters
allowing automated firmware updates.
Containers are XML structures allowing to specify a list of setting file URLs/tags which will
be consecutively requested by the phone. There are currently two container types
supported:
Setting Files Container
Setting Container
Provisioning 29 Back to Contents
ET685 Administrator and Provisioning Manual
Setting Files Container <setting-files>
Setting files container are XML files using the <setting-files> tag
They should be the first XML file provisioned.
They allow to specify a list of setting file URLs:
1. XML phone settings files
2. XML function key setting files
3. XML directory setting files
4. XML dial plan setting files
5. XML uploads setting files
6. XML certificate setting files
7. XML Language setting files
phone user interface language
web user interface language
The URLs are requested in the defined order.
tree:openlevels=3|root=Setting Files Container <setting-files>
Element:
Attributes:
File
url
Atribute values:
XML <phone-settings> file
XML <functionKeys> file
XML <ReplacementPlan> file
XML <tbook> file
XML <dialplan> file
XML <uploads> file
XML <certificates> file
XML <gui-languages> file
XML <web-languages> file
Settings Container <settings>
Setting container are XML files using the <settings> tag.
They allow to specify the following setting file tags in one file, e.g:
<phone-settings> tag
Provisioning 30 Back to Contents
Loading...