Mitel 6863i User manual

Mitel 6800i Series SIP Phones
41-001562-00 REV01
RELEASE 4.0.0 SP1 TR-069 CONFIGURATION GUIDE

NOTICE
The information contained in this document is believed to be accurate in all respects but is not warranted
by Mitel Networks™ Corporation (MITEL®). The information is subject to change without notice and should
not be construed in any way as a commitment by Mitel or any of its affiliates or subsidiaries. Mitel and its
affiliates and subsidiaries assume no responsibility for any errors or omissions in this document. Revisions
of this document or new editions of it may be issued to incorporate such changes.
No part of this document can be reproduced or transmitted in any form or by any means - electronic or
mechanical - for any purpose without written permission from Mitel Networks Corporation.
Trademarks
Mitel is a trademark of Mitel Networks Corporation.
Other product names mentioned in this document may be trademarks of their respective companies and
are hereby acknowledged.
Mitel 6800i Series SIP Phones Release 4.0.0 SP1 TR-069 Configuration Guide
41-001562-00 REV01 - December 2014
®,™ Trademark of Mitel Networks Corporation
© Copyright 2014, Mitel Networks Corporation
All rights reserved

Table of Contents
iii
Welcome. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
TR-069 Protocol Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Pre-Staging SIP Phones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
TR-069 Functionality Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2
Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2
Behaviors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3
TR-069 Parameter Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3
Support for Getting Capabilities, General Profiles, and Other Static Parameters . . . . . . . . . . . .6
Voice Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6
Handling Dynamic Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6
TR-111 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Periodic Inform Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Configuring Periodic Inform Using the Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Inform Upon Receipt of SIP NOTIFY Check-Sync Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8
Configuring the Inform Upon Receipt of SIP NOTIFY Check-Sync Feature
Using the Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
Configuration Backup and Restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
Log File Download from CPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
Firmware Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
Passive and Active Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
Secured Connection Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12
privateKey.pem Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13
Factory Reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
Device Data Model Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
OUI and Product Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
Appendix A - Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Appendix B - XML Data Model Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Appendix C - Standard Supported TR-069 Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Mitel 6800i Series SIP Phones Release 4.0.0 SP1 TR-069 Configuration Guide
1
WELCOME
This document provides information about Technical Report (TR)-069 protocol support for the
6800i Series (6863i, 6865i, 6867i, and 6869i) SIP IP Phones.
TR-069 PROTOCOL SUPPORT
The IP Phones support the TR-069 protocol. This protocol is a bi-directional HTTP-based
protocol that provides a means of communication between Customer-Premises Equipment
(CPE) (e.g. IP phones) and Auto Configuration Servers (ACSs) over DSL/broadband
connections.Itincludesbothsafeautoconfiguration andthecontrolofotherCPEmanagement
functions within an integrated framework.
Service providers can, through TR-069, use one common platform to manage (through the
internet) all of their customer premise devices, regardless of the device or manufacturer. If
TR-069 is enabled on the phones, when the remote ACS boots the phones, they contact the
ACS and establish the configuration automatically.
In addition to configuring the phone with TR-069, you can also do the following:
• Reboot the phone
• Reset to factory defaults
• Update the firmware of the device
• Backup/restore configuration
• Upload the log file
An Administrator can configure the TR-069 parameters using the configuration files only. For
more information about the TR-069 parameters, see “TR-069 Parameter Descriptions” on
page 3.
PRE-STAGING SIP PHONES
There are two options available to enable TR-069 support for the phones:
a. An Administrator can provide a configuration file (that can be taken from theTFTP site
or during RCS provisioning) with parameters that are specified in “TR-069 Parameter
Descriptions” on page 3.
b. The phones can be branded and the branded default configuration file can contain all
the necessary parameters.
After phones (with correct firmware) receive this configuration file, they will start a bootstrap
procedure and connect to the ACS server.
Note: Implementation of the TR-069 protocol follows TR-104 and TR-106 standards to
the extent of data sets applicable to SIP IP phones.

TR-069 Protocol Support
2
TR-069 FUNCTIONALITY SUPPORT
XML-RemoteProcedureCall(RPC)isaprotocolwhichusesXML toencodeitscallsandHTTP
as a transport mechanism to make requests to Internet-based servers. The following table
identifies the XML-RPC methods supported for the TR-069 functionality on the phones in
Release 4.0.0 SP1.
LIMITATIONS
The following is a list of limitations with TR-069:
• TR-111 Part 1 is not supported (only Part 2 - STUN)
• The current release does not have support for the following RPC function calls:
•AddObject
• DeleteObject
• GetQueuedTransfers
• GetAllQueuedTransfers
• ScheduleInform
XML-RPC METHOD CPE
REQUIREMENT SUPPORTED IN THIS RELEASE 4.0.0 SP1
GetRPCMethods Required Yes
SetParameterValues Required Limited to parameters specified in “TR-069
Parameter Descriptions” on page 3.
Note: Users are limited to parameters that are
specified by Mitel. Please contact Mitel for a list of
these parameters.
GetParameterValues Required Limited to parameters specified in “TR-069
Parameter Descriptions” on page 3.
GetParameterNames Required Yes
SetParameterAttributes Required Yes
GetParameterAttributes Required Yes
AddObject Required No
DeleteObject Required No
Reboot Required Yes
Download Required Yes
Upload Optional Yes
FactoryReset Optional Yes
GetQueuedTransfers Optional No
GetAllQueuedTransfers Optional No
ScheduleInform Optional No
SetVouchers Optional No
GetOptions Optional No

Mitel 6800i Series SIP Phones Release 4.0.0 SP1 TR-069 Configuration Guide
3
• SetVouchers
• GetOptions
• Inform Retry Policy with increasing intervals is not supported (only constant intervals are
supported)
• Active Notification is supported only for limited list of parameters
• A subset of Mitel configuration parameters are supported through TR-069
• Only a TR-069 active session is supported (single IP address)
• CPE Identification is made based on OUI + Product Class + MAC (not serial number)
• Each Voice Profile has only 1 line
• VoiceService.X_Aastra_GlobalVoiceProfile corresponds to Mitel Sip Global Settings and
has only 1 line object
• VoiceService.1.VoiceProfile.{1} corresponds to Mitel SIP settings per line i and has only 1
line object
• Constant number of lines mapped to the number of Voice Profile (profile remove is not
supported)
BEHAVIORS
The following is a list of behaviors with TR-069:
• WebandphoneUIarestillavailableforconfigurationandcanoverride whatwasconfigured
through TR-069
• The phones will notify ACS though the Active notification process for a limited subset of
parameters (as defined)
• Loading of new configuration through TR-069 will require a CPE reboot
TR-069 PARAMETER DESCRIPTIONS
An Administrator can enable/disable and configure the TR-069 protocol using the following
parameters in the configuration files:
•tr69
• tr69 server
• tr69 server port
• tr69 server path
• tr69 username
•tr69password
• tr69 connection request path
• tr69 connection request port

TR-069 Protocol Support
4
Each of these parameters are described as follows:
PARAMETER –
tr69 CONFIGURATION FILES startup.cfg, mac.cfg
DESCRIPTION Enables/disables TR-069 communciation.
FORMAT Boolean
DEFAULT VALUE 0
RANGE 0-1
0 (disabled)
1 (enabled)
EXAMPLE tr69: 1
PARAMETER –
tr69 server CONFIGURATION FILES startup.cfg, mac.cfg
DESCRIPTION Specifies the IP or domain name of the TR-069
Auto-Configuration Server (ACS). This is the server to
which the phone sends TR-069 messages.
Contact your System Administrator for the applicable
server to specify for this parameter.
FORMAT String
DEFAULT VALUE Empty
RANGE Not Applicable
EXAMPLE tr69 server: http://10.30.105.127
PARAMETER –
tr69 server port CONFIGURATION FILES startup.cfg, mac.cfg
DESCRIPTION Specifies the server port of the TR-069 Auto-Configuration
Server (ACS). This is the server to which the phone sends
TR-069 messages.
Contact your System Administrator for the applicable port
to specify for this parameter.
FORMAT String
DEFAULT VALUE Empty
RANGE Not Applicable
EXAMPLE tr69 server port:10301

Mitel 6800i Series SIP Phones Release 4.0.0 SP1 TR-069 Configuration Guide
5
PARAMETER –
tr69 server path CONFIGURATION FILES startup.cfg, mac.cfg
DESCRIPTION Specifies the server path of the TR-069 Auto-Configuration
Server (ACS). This is the path to which the phone sends
TR-069 messages.
Contact your System Administrator for the applicable path
to specify for this parameter.
FORMAT String
DEFAULT VALUE Empty
RANGE Not Applicable
EXAMPLE tr69 server path: acs/
PARAMETER –
tr69 username CONFIGURATION FILES startup.cfg, mac.cfg
DESCRIPTION Username for HTTP authentication against the ACS
FORMAT String
DEFAULT VALUE Empty
RANGE Not Applicable
EXAMPLE tr69 username: Joe
PARAMETER –
tr69 password CONFIGURATION FILES startup.cfg, mac.cfg
DESCRIPTION Password for HTTP authentication against the ACS
FORMAT String
DEFAULT VALUE Empty
RANGE Not Applicable
EXAMPLE tr69 password: 12345
PARAMETER –
tr69 connection request
path
CONFIGURATION FILES
startup.cfg, mac.cfg
DESCRIPTION Path for tr69 connection url
FORMAT String
DEFAULT VALUE tr69
RANGE Not Applicable
EXAMPLE tr69 connection request path: mitel

TR-069 Protocol Support
6
Thefollowingsubsectionsprovideadditionalinformationandparametersthatarerequirements
for the TR-069.
SUPPORTFORGETTINGCAPABILITIES,GENERALPROFILES, AND
OTHER STATIC PARAMETERS
When the phone boots up for the first time, it will send an Inform message with the event code
BOOTSRAP to the ACS server. The ACS server will ask for the supporting parameters on the
phone. After this initial contact, the ACS server can read or write parameters on the phone.
VOICE PROFILE
There is one global Voice Profile called X_Aastra_GlobalVoiceProfile that corresponds to the
global line on the phone. For example:
Device.VoiceService.X_Aastra_GlobalVoiceProfilecorrespondstoGlobalontheMitelWeb
UI
Depending on the phone model, there are also up to 9 other Voice Profiles that correspond to
a specific line on the phone. They are always located on the VoiceService SubTree, and on
each line a SIP account can be configured. For example:
Device.VoiceService.VoiceProfile.1 corresponds to Line 1 on the Mitel Web UI.
Once a SIP account is fully configured, the line will be registered. Administrators also have the
option to delete the Voice Profile. When a Voice Profile is deleted, the corresponding line is
restored to the default.
HANDLING DYNAMIC PARAMETERS
If the ACS modifies a parameter, the SIP line is automatically configured and will register to the
server.
PARAMETER –
tr69 connection request
port
CONFIGURATION FILES
sstartup.cfg, mac.cfg
DESCRIPTION Port for tr69 connection url
FORMAT Integer
DEFAULT VALUE 7547
RANGE Not Applicable
EXAMPLE tr69 connection request port:12345

Mitel 6800i Series SIP Phones Release 4.0.0 SP1 TR-069 Configuration Guide
7
TR-111
The phones support the TR-111 protocol as a requirement for TR-069. TR-111 applies the
TR-069 to remote manage home networking devices (i.e. it can access a phone that is inside
a private network from a server outside). The TR-111 standard defines two ways of managing
CPE located behind Network Address Translation (NAT) routers. The parameters are
automatically configured for the Administrator.
PERIODIC INFORM SUPPORT
The TR069 stack provides a function that sets up periodic inform support. On the phone, the
periodic inform is done so that the phone can periodically send an inform message to the ACS
server. For example, for passive notification, the phone will inform the ACS server that one or
more parameters is/are modified and will send the new value in the inform message.
CONFIGURING PERIODIC INFORM USING THE CONFIGURATION FILES
PARAMETER –
tr69 periodic inform enable CONFIGURATION FILES startup.cfg, mac.cfg
DESCRIPTION Enable or disable the periodic inform functionality.
FORMAT Boolean
DEFAULT VALUE Empty
RANGE 0 - 1
0 (Disable)
1 (Enable)
EXAMPLE tr69 periodic inform enable: true
PARAMETER –
tr69 periodic inform
interval
CONFIGURATION FILES
startup.cfg, mac.cfg
DESCRIPTION The duration in seconds of the interval for which the CPE
must attempt to connect with the ACS and call the inform
method.
FORMAT Integer
DEFAULT VALUE Empty
RANGE Not Applicable
EXAMPLE tr69 periodic inform interval: 600