Page is loading ...
ErisTerminal
®
SIP Deskset
ET685
Administrator and Provisioning Manual
Rev. 1 06/18
2
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
3
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
4
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
5
ET685 Administrator and Provisioning Manual
Preface 6 Back to Contents
ET685 Administrator and Provisioning Manual
PREFACE
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.
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 7 Back to Contents
ET685 Administrator and Provisioning Manual
Text Conventions
Table 1 lists text formats and describes how they are used in this guide.
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.
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.
CallFwd
Notes provide important information
about a feature or procedure.
A caution means that loss of data or
unintended circumstances may result.
Introducing the ET685 8 Back to Contents
ET685 Administrator and Provisioning Manual
C HAPTER 1
INTRODUCING THE 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 9 Back to Contents
ET685 Administrator and Provisioning Manual
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
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 10 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 12 Back to Contents
ET685 Administrator and Provisioning Manual
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.
Introducing the ET685 13 Back to Contents
ET685 Administrator and Provisioning Manual
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.
Provisioning 14 Back to Contents
ET685 Administrator and Provisioning Manual
C HAPTER 2
PROVISIONING
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 15 Back to Contents
ET685 Administrator and Provisioning Manual
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.
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 16 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 SUB-
SCRIBE 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 17 Back to Contents
ET685 Administrator and Provisioning Manual
DHCP Options
Option 66 (TFTP server name)
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 18 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 19 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%3a00135E874B[email protected]ch.ca>
Call-ID: 19307[email protected]68.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%3a00135E874B[email protected]ch.ca>;tag=91955270
From: <sip:MAC%3a00135E874B49@intern.vtech.ca>;tag=658512961
Call-ID: 19307[email protected]68.10.67
CSeq: 1 SUBSCRIBE
Expires: 0
Content-Length: 0
followed by a SIP NOTIFY message containing the Auto Provisioning URL
Provisioning 20 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%3a00135E874B[email protected]ch.ca>;tag=658512961
From: <sip:MAC%3a00135E874B49@intern.vtech.ca>;tag=91955270
Call-ID: 19307[email protected]68.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%3a00135E874B[email protected]ch.ca>;tag=658512961
Call-ID: 19307[email protected]68.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
/