TR-069 Amendment 3 - Broadband Forum

197 Pages·2010·2.12 MB·English

by  John Blackford

TECHNICAL REPORT

TR-069 Amendment 3
CPE WAN Management Protocol

Issue: 1
Issue Date: November 2010
Protocol Version: 1.2

© The Broadband Forum. All rights reserved.
CPE WAN Management Protocol TR-069 Amendment 3
Notice

The Broadband Forum is a non-profit corporation organized to create guidelines for broadband
network system development and deployment. This Broadband Forum Technical Report has been
approved by members of the Forum. This Broadband Forum Technical Report is not binding on
the Broadband Forum, any of its members, or any developer or service provider. This Broadband
Forum Technical Report is subject to change, but only with approval of members of the Forum.
This Technical Report is copyrighted by the Broadband Forum, and all rights are reserved.
Portions of this Technical Report may be copyrighted by Broadband Forum members.

This Broadband Forum Technical Report is provided AS IS, WITH ALL FAULTS. ANY
PERSON HOLDING A COPYRIGHT IN THIS BROADBAND FORUM TECHNICAL
REPORT, OR ANY PORTION THEREOF, DISCLAIMS TO THE FULLEST EXTENT
PERMITTED BY LAW ANY REPRESENTATION OR WARRANTY, EXPRESS OR
IMPLIED, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY:

(A) OF ACCURACY, COMPLETENESS, MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE, NON-INFRINGEMENT, OR TITLE;
(B) THAT THE CONTENTS OF THIS BROADBAND FORUM TECHNICAL REPORT
ARE SUITABLE FOR ANY PURPOSE, EVEN IF THAT PURPOSE IS KNOWN TO
THE COPYRIGHT HOLDER;
(C) THAT THE IMPLEMENTATION OF THE CONTENTS OF THE TECHNICAL
REPORT WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS,
TRADEMARKS OR OTHER RIGHTS.

By using this Broadband Forum Technical Report, users acknowledge that implementation may
require licenses to patents. The Broadband Forum encourages but does not require its members
to identify such patents. For a list of declarations made by Broadband Forum member companies,
please see http://www.broadband-forum.org. No assurance is given that licenses to patents
necessary to implement this Technical Report will be available for license at all or on reasonable
and non-discriminatory terms.

ANY PERSON HOLDING A COPYRIGHT IN THIS BROADBAND FORUM TECHNICAL
REPORT, OR ANY PORTION THEREOF, DISCLAIMS TO THE FULLEST EXTENT
PERMITTED BY LAW (A) ANY LIABILITY (INCLUDING DIRECT, INDIRECT, SPECIAL,
OR CONSEQUENTIAL DAMAGES UNDER ANY LEGAL THEORY) ARISING FROM OR
RELATED TO THE USE OF OR RELIANCE UPON THIS TECHNICAL REPORT; AND (B)
ANY OBLIGATION TO UPDATE OR CORRECT THIS TECHNICAL REPORT.

Broadband Forum Technical Reports may be copied, downloaded, stored on a server or otherwise
re-distributed in their entirety only, and may not be modified without the advance written
permission of the Broadband Forum.

The text of this notice must be included in all copies of this Broadband Forum Technical Report.
November 2010 Page 2 of 197
© The Broadband Forum. All rights reserved.
CPE WAN Management Protocol TR-069 Amendment 3

TR Issue History

Issue Number Issue Date Issue Editor Changes
Issue 1 May 2004 Jeff Bernstein, 2Wire Issue 1
Tim Spets, Westell
Issue 1 November 2006 Jeff Bernstein, 2Wire Clarification of original document
Amendment 1 John Blackford, 2Wire
Mike Digdon, SupportSoft
Heather Kirksey, Motive
William Lupton, 2Wire
Anton Okmianski, Cisco
Issue 1 November 2007 William Lupton, 2Wire CWMP v1.1: Multicast Download
Amendment 2 Davide Moreo, Telecom Italia support, 10 AUTONOMOUS
TRANSFER COMPLETE event,
AutonomousTransferComplete
method, additional Download fault
codes, interoperability clarifications,
minor editorial changes.
Issue 1 November 2010 John Blackford, Pace CWMP v1.2: Small updates for IPv6
Amendment 3 Heather Kirksey, Alcatel-Lucent related to DHCP, Additions for
Software Module Management support
William Lupton, Pace
(including new RPCs, Inform Event
Codes, fault codes, and an Annex on
UUIDs), ScheduleDownload RPC, and
CancelTransfer RPC.

Comments or questions about this Broadband Forum Technical Report should be directed
to [email protected].

Editors John Blackford Pace [email protected]
Heather Kirksey Alcatel-Lucent [email protected]
William Lupton Pace [email protected]

BroadbandHome™ Greg Bathrick PMC-Sierra
Working Group Chairs Heather Kirksey Alcatel-Lucent

Vice Chair Jason Walls UNH

November 2010 Page 3 of 197
© The Broadband Forum. All rights reserved.
CPE WAN Management Protocol TR-069 Amendment 3
Table of Contents
1 Introduction ................................................................................................................. 13
1.1 Functional Components ..................................................................................... 13
1.1.1 Auto-Configuration and Dynamic Service Provisioning ....................... 13
1.1.2 Software/Firmware Image Management ............................................... 14
1.1.3 Software Module Management .............................................................. 14
1.1.4 Status and Performance Monitoring ...................................................... 14
1.1.5 Diagnostics ............................................................................................. 14
1.2 Positioning in the End-to-End Architecture ....................................................... 14
1.3 Security Goals .................................................................................................... 15
1.4 Architectural Goals ............................................................................................ 15
1.5 Assumptions ....................................................................................................... 16
1.6 Terminology ....................................................................................................... 17
1.7 Abbreviations ..................................................................................................... 18
1.8 Document Conventions ...................................................................................... 20
2 Architecture ................................................................................................................. 20
2.1 Protocol Components ......................................................................................... 20
2.2 Security Mechanisms ......................................................................................... 21
2.3 Architectural Components ................................................................................. 21
2.3.1 Parameters .............................................................................................. 21
2.3.2 File Transfers ......................................................................................... 22
2.3.3 CPE Initiated Sessions ........................................................................... 23
2.3.4 Asynchronous ACS Initiated Sessions .................................................. 23
3 Procedures and Requirements ..................................................................................... 23
3.1 ACS Discovery .................................................................................................. 24
3.2 Connection Establishment .................................................................................. 27
3.2.1 CPE Connection Initiation ..................................................................... 27
3.2.2 ACS Connection Initiation ..................................................................... 29
3.3 Use of TLS and TCP .......................................................................................... 31
3.4 Use of HTTP ...................................................................................................... 33
3.4.1 Encoding SOAP over HTTP .................................................................. 33
3.4.2 Transaction Sessions .............................................................................. 34
3.4.3 File Transfers ......................................................................................... 36
3.4.4 Authentication ........................................................................................ 36
3.4.5 Digest Authentication ............................................................................ 37
3.4.6 Additional HTTP Requirements ............................................................ 38
3.5 Use of SOAP ...................................................................................................... 38
3.6 RPC Support Requirements ............................................................................... 44
3.7 Transaction Session Procedures ......................................................................... 45
3.7.1 CPE Operation ....................................................................................... 45
3.7.2 ACS Operation ....................................................................................... 55
3.7.3 Transaction Examples ............................................................................ 58
Normative References ....................................................................................................... 60
November 2010 Page 4 of 197
© The Broadband Forum. All rights reserved.
CPE WAN Management Protocol TR-069 Amendment 3
Annex A. RPC Methods ................................................................................................ 63
A.1 Introduction ................................................................................................................ 63
A.2 RPC Method Usage .................................................................................................... 63
A.2.1 Data Types ........................................................................................................ 63
A.2.2 Other Requirements .......................................................................................... 64
A.3 Baseline RPC Messages ............................................................................................. 64
A.3.1 Generic Methods .............................................................................................. 64
A.3.1.1 GetRPCMethods ................................................................................... 64
A.3.2 CPE Methods .................................................................................................... 66
A.3.2.1 SetParameterValues .............................................................................. 66
A.3.2.2 GetParameterValues ............................................................................. 68
A.3.2.3 GetParameterNames ............................................................................. 69
A.3.2.4 SetParameterAttributes ......................................................................... 71
A.3.2.5 GetParameterAttributes ........................................................................ 75
A.3.2.6 AddObject ............................................................................................. 76
A.3.2.7 DeleteObject ......................................................................................... 79
A.3.2.8 Download ............................................................................................. 80
A.3.2.9 Reboot ................................................................................................... 85
A.3.3 ACS Methods ................................................................................................... 86
A.3.3.1 Inform ................................................................................................... 86
A.3.3.2 TransferComplete ................................................................................. 88
A.3.3.3 AutonomousTransferComplete ............................................................ 90
A.4 Optional RPC Messages ............................................................................................. 91
A.4.1 CPE Methods .................................................................................................... 91
A.4.1.1 GetQueuedTransfers ............................................................................. 91
A.4.1.2 ScheduleInform .................................................................................... 92
A.4.1.3 SetVouchers .......................................................................................... 92
A.4.1.4 GetOptions ............................................................................................ 93
A.4.1.5 Upload .................................................................................................. 94
A.4.1.6 FactoryReset ......................................................................................... 96
A.4.1.7 GetAllQueuedTransfers ........................................................................ 96
A.4.1.8 ScheduleDownload ............................................................................... 98
A.4.1.9 CancelTransfer ................................................................................... 102
A.4.1.10 ChangeDUState ............................................................................... 102
A.4.2 ACS Methods ................................................................................................. 106
A.4.2.1 Kicked ................................................................................................. 106
A.4.2.2 RequestDownload ............................................................................... 106
A.4.2.3 DUStateChangeComplete ................................................................... 107
A.4.2.4 AutonomousDUStateChangeComplete .............................................. 110
A.5 Fault Handling .......................................................................................................... 113
A.5.1 CPE Fault Codes ............................................................................................. 113
A.5.2 ACS Fault Codes ............................................................................................ 115
A.6 RPC Method XML Schema ..................................................................................... 115
November 2010 Page 5 of 197
© The Broadband Forum. All rights reserved.
CPE WAN Management Protocol TR-069 Amendment 3
Annex B. Removed ....................................................................................................... 150
Annex C. Signed Vouchers .......................................................................................... 151
C.1 Overview .................................................................................................................. 151
C.2 Control of Options Using Vouchers ......................................................................... 151
C.3 Voucher Definition ................................................................................................... 152
Annex D. Web Identity Management ......................................................................... 156
D.1 Overview .................................................................................................................. 156
D.2 Use of the Kicked RPC Method ............................................................................... 156
D.3 Web Identity Management Procedures .................................................................... 157
D.4 LAN Side Interface .................................................................................................. 158
Annex E. Signed Package Format .............................................................................. 160
E.1 Introduction .............................................................................................................. 160
E.2 Signed Package Format Structure ............................................................................ 160
E.2.1 Encoding Conventions .................................................................................... 161
E.3 Header Format .......................................................................................................... 161
E.4 Command List Format ............................................................................................. 161
E.4.1 Command Types ............................................................................................. 162
E.4.2 End Command ................................................................................................ 163
E.4.3 Extract and Add Commands ........................................................................... 163
E.4.4 Remove Commands ........................................................................................ 164
E.4.5 Move Commands ............................................................................................ 164
E.4.6 Version and Description Commands .............................................................. 165
E.4.7 Timeout Commands ....................................................................................... 166
E.4.8 Reboot Command ........................................................................................... 168
E.4.9 Format File System ......................................................................................... 168
E.4.10 Minimum and Maximum Version Commands ............................................ 168
E.4.11 Role Command ............................................................................................ 169
E.4.12 Minimum Storage Commands ..................................................................... 170
E.4.13 Required Attributes Command .................................................................... 170
E.5 Signatures ................................................................................................................. 171
Annex F. Device-Gateway Association ...................................................................... 173
F.1 Introduction .............................................................................................................. 173
F.1.1 Terminology ................................................................................................... 173
F.2 Procedures ................................................................................................................ 174
F.2.1 Gateway Requirements ................................................................................... 174
F.2.2 Device Requirements ...................................................................................... 175
F.2.3 ACS Requirements ......................................................................................... 176
F.2.4 Device-Gateway Association Flows ............................................................... 177
F.2.5 DHCP Vendor Options ................................................................................... 178
F.3 Security Considerations ............................................................................................ 179
November 2010 Page 6 of 197
© The Broadband Forum. All rights reserved.
CPE WAN Management Protocol TR-069 Amendment 3
Annex G. Connection Request via NAT Gateway ..................................................... 181
G.1 Introduction .............................................................................................................. 181
G.2 Procedures ................................................................................................................ 181
G.2.1 CPE Requirements .......................................................................................... 182
G.2.1.1 Binding Discovery .............................................................................. 183
G.2.1.2 Maintaining the Binding ..................................................................... 184
G.2.1.3 Communication of the Binding Information to the ACS ................... 185
G.2.1.4 UDP Connection Requests ................................................................. 187
G.2.2 ACS Requirements ......................................................................................... 188
G.2.2.1 STUN Server Requirements ............................................................... 188
G.2.2.2 Determination of the Binding Information ......................................... 189
G.2.2.3 UDP Connection Requests ................................................................. 190
G.2.3 Message Flows ............................................................................................... 192
G.3 Security Considerations ............................................................................................ 195
Annex H. Software Module Management UUID Usage ........................................... 196
H.1 Overview .................................................................................................................. 196
H.2 UUID Generation Requirements .............................................................................. 197
H.3 CPE Requirements ................................................................................................... 197

November 2010 Page 7 of 197
© The Broadband Forum. All rights reserved.
CPE WAN Management Protocol TR-069 Amendment 3
List of Tables
Table 1 – Protocol layer summary .................................................................................... 21

Table 2 – Encapsulated Vendor Specific Options ............................................................ 25

Table 3 – Session Retry Wait Intervals ............................................................................. 29

Table 4 – SOAP Header Elements .................................................................................... 43

Table 5 – RPC message requirements .............................................................................. 44

Table 6 – CPE Message Transmission Constraints .......................................................... 47

Table 7 – Event Types ...................................................................................................... 49

Table 8 – ACS Message Transmission Constraints .......................................................... 56

Table 9 – Data types ......................................................................................................... 63

Table 10 – GetRPCMethods arguments ........................................................................... 65

Table 11 – GetRPCMethodsResponse arguments ............................................................ 65

Table 12 – SetParameterValues arguments ...................................................................... 66

Table 13 – SetParameterValuesResponse arguments ....................................................... 66

Table 14 – ParameterValueStruct definition ..................................................................... 67

Table 15 – GetParameterValues arguments ...................................................................... 68

Table 16 – GetParameterValuesResponse arguments ...................................................... 68

Table 17 – GetParameterNames arguments ...................................................................... 69

Table 18 – GetParameterNamesResponse arguments ...................................................... 70

Table 19 – ParameterInfoStruct definition ....................................................................... 70

Table 20 – SetParameterAttributes arguments ................................................................. 71

Table 21 – SetParameterAttributesResponse arguments .................................................. 71

Table 22 – SetParameterAttributesStruct definition ......................................................... 72

Table 23 – GetParameterAttributes arguments ................................................................. 75

Table 24 – GetParameterAttributesResponse arguments ................................................. 75

Table 25 – ParameterAttributeStruct definition ................................................................ 75

Table 26 – AddObject arguments ..................................................................................... 78

Table 27 – AddObjectResponse arguments ...................................................................... 78

Table 28 – DeleteObject arguments .................................................................................. 80

Table 29 – DeleteObjectResponse arguments .................................................................. 80

Table 30 – Download arguments ...................................................................................... 82

Table 31 – DownloadResponse arguments ....................................................................... 85

Table 32 – Reboot arguments ........................................................................................... 86

Table 33 – RebootResponse arguments ............................................................................ 86

Table 34 – Inform arguments ............................................................................................ 86

Table 35 – InformResponse arguments ............................................................................ 87

Table 36 – DeviceIdStruct definition ................................................................................ 87

Table 37 – EventStruct definition ..................................................................................... 88

Table 38 – TransferComplete arguments .......................................................................... 89

Table 39 – TransferCompleteResponse arguments .......................................................... 89

Table 40 – FaultStruct definition ...................................................................................... 89

Table 41 – AutonomousTransferComplete arguments ..................................................... 90

Table 42 – AutonomousTransferCompleteResponse arguments ...................................... 91

Table 43 – GetQueuedTransfers arguments ..................................................................... 91

Table 44 – GetQueuedTransfersResponse arguments ...................................................... 91

Table 45 – QueuedTransferStruct definition .................................................................... 91

November 2010 Page 8 of 197
© The Broadband Forum. All rights reserved.
CPE WAN Management Protocol TR-069 Amendment 3
Table 46 – ScheduleInform arguments ............................................................................. 92

Table 47 – ScheduleInformResponse arguments .............................................................. 92

Table 48 – SetVouchers arguments .................................................................................. 92

Table 49 – SetVouchersResponse arguments ................................................................... 93

Table 50 – GetOptions arguments .................................................................................... 93

Table 51 – GetOptionsResponse arguments ..................................................................... 93

Table 52 – OptionStruct definition ................................................................................... 93

Table 53 – Upload arguments ........................................................................................... 94

Table 54 – UploadResponse arguments ............................................................................ 96

Table 55 – FactoryReset arguments .................................................................................. 96

Table 56 – FactoryResetResponse arguments .................................................................. 96

Table 57 – GetAllQueuedTransfers arguments ................................................................ 97

Table 58 – GetAllQueuedTransfersResponse arguments ................................................. 97

Table 59 – AllQueuedTransferStruct definition ............................................................... 97

Table 60 – ScheduleDownload arguments ....................................................................... 99

Table 61 – ScheduleDownloadResponse arguments ...................................................... 100

Table 62 – TimeWindowStruct definition ...................................................................... 100

Table 63 – CancelTransfer arguments ............................................................................ 102

Table 64 – CancelTransferResponse arguments ............................................................. 102

Table 65 – ChangeDUState Arguments .......................................................................... 103

Table 66 – ChangeDUStateResponse Arguments .......................................................... 104

Table 67 – OperationStruct Types .................................................................................. 104

Table 68 – InstallOpStruct Definition ............................................................................. 104

Table 69 – UpdateOpStruct Definition ........................................................................... 104

Table 70 – UninstallOpStruct Definition ........................................................................ 105

Table 71 – Kicked arguments ......................................................................................... 106

Table 72 – KickedResponse arguments .......................................................................... 106

Table 73 – RequestDownload arguments ....................................................................... 106

Table 74 – RequestDownloadResponse arguments ........................................................ 107

Table 75 – ArgStruct definition ...................................................................................... 107

Table 76 – DUStateChangeComplete Arguments .......................................................... 108

Table 77 – OpResultStruct Definition ............................................................................ 108

Table 78 – FaultStruct Definition ................................................................................... 109

Table 79 – DUStateChangeCompleteResponse Arguments ........................................... 110

Table 80 – AutonomousDUStateChangeComplete Arguments ..................................... 111

Table 81 – AutonOpResultStruct Definition .................................................................. 111

Table 82 – FaultStruct Definition ................................................................................... 112

Table 83 – AutonomousDUStateChangeCompleteResponse Arguments ...................... 113

Table 84 – Fault codes .................................................................................................... 113

Table 85 – Fault codes .................................................................................................... 115

Table 86 – Option specification definition ..................................................................... 152

Table 87 – DeviceIdStruct definition .............................................................................. 153

Table 88 – Recommended CGI Arguments for the kick URL ....................................... 158

Table 89 – Signed package component summary ........................................................... 160

Table 90 – Signed package header format ...................................................................... 161

Table 91 – Command format .......................................................................................... 161

November 2010 Page 9 of 197
© The Broadband Forum. All rights reserved.
CPE WAN Management Protocol TR-069 Amendment 3
Table 92 – Command Type summary ............................................................................. 162

Table 93 – Value format for the extract and add commands .......................................... 163

Table 94 – Value format for the remove commands ...................................................... 164

Table 95 – Value format for the move commands ......................................................... 165

Table 96 – Value format for the timeout commands ...................................................... 166

Table 97 – Timeout command definitions ...................................................................... 167

Table 98 – Value format for the minimum and maximum version commands .............. 168

Table 99 – Value format for the role command .............................................................. 170

Table 100 – Value format for the minimum storage commands .................................... 170

Table 101 – Value format for the required attributes command ..................................... 171

Table 102 – Encapsulated Vendor-Specific Option-Data fields ..................................... 179

Table 103 – Optional STUN attributes used in Binding Request messages ................... 185

November 2010 Page 10 of 197
© The Broadband Forum. All rights reserved.