
{"id":10220,"date":"2022-06-21T09:11:33","date_gmt":"2022-06-21T09:11:33","guid":{"rendered":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/diagnostics_subsystem\/tr69\/"},"modified":"2024-12-04T14:10:50","modified_gmt":"2024-12-04T14:10:50","slug":"tr69","status":"publish","type":"page","link":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/diagnostics_subsystem\/tr69\/","title":{"rendered":"TR69"},"content":{"rendered":"\n <h3 class=\"wp-sub-header\">Overview<\/h3><p>TR-069 is a technical specification that defines an application layer protocol for remote management of end-user devices.&nbsp;It was published by the Broadband Forum and was entitled CPE WAN&nbsp;Management Protocol (CWMP).&nbsp;It provides the communication between CPE and Auto&nbsp;Configuration Servers (ACS).&nbsp;An ACS can manage a device, trouble shoot, configure,&nbsp;upgrade etc.&nbsp;TR-69 uses common web protocols such as HTTP, TCP-IP,&nbsp;SOAP, XML-RPCs to exchange information.<\/p><p><strong><div class=\"wp-block-file\"><a href=\"\/wp-content\/uploads\/sites\/16\/2023\/09\/Dimark%20Client%20v.4.3%20Implementation%20Guide.pdf\">Dimark Client v.4.3 Implementation Guide.pdf<\/a><a href=\"\/wp-content\/uploads\/sites\/16\/2023\/09\/Dimark%20Client%20v.4.3%20Implementation%20Guide.pdf\" class=\"wp-block-file__button\">Download<\/a><\/div><\/strong><\/p><h3 class=\"wp-sub-header\">Feature Summary<\/h3><ul><li>Service Activation<\/li><li>Firmware upgrade management<\/li><li>Register device to Auto-Configuration Server (ACS) using Inform notification<\/li><li>Periodically send device information to ACS using Inform notification<\/li><li>Forced Inform for required parameters<\/li><li>Allow ACS to configure periodic Inform interval.<\/li><li>Allow ACS to reach devices that are connected behind NAT using STUN + UDP NAT traversal<\/li><li>(future)&nbsp;Allow ACS to reach devices that are connected behind NAT using XMPP<\/li><li>Retrieve device diagnostics\/parameters using GetParameterValues() method<\/li><li>Set device parameters using SetParameterValues() method<\/li><li>Factory reset using FactoryReset method<\/li><li>Device reboot using Reboot method<\/li><li>SSL\/TLS 1.2 (Transport Layer Security) per RFC5246 to encrypt communications with ACS&nbsp;<\/li><\/ul><h3 class=\"wp-sub-header\">&nbsp;<span>Device Applicability<\/span><\/h3><ul><li>IP<\/li><\/ul><h3 class=\"wp-sub-header\">Setup<\/h3><p>    \n\n<\/p><img decoding=\"async\" src=\"\/wp-content\/uploads\/sites\/16\/2023\/09\/TR-69.drawio.png\"><p>Since the Client is non-addressable from the public network, tr-069 and STUN creates and&nbsp;maintains a lightweight connection between&nbsp;the tr-069 server and agent to allow for tr-069-server initiated commands to be sent to&nbsp;the Client in real-time.<\/p><h3 class=\"wp-sub-header\">Sample message flow<\/h3><p>The CPE is responsible for establishing the&nbsp;session to the server. The CPE keeps sending HTTP POST requests during the session.&nbsp;The session is closed as soon as both CPE &amp; ACS&nbsp;&nbsp;have indicated that they have nothing more to send&nbsp;(response or new RPC)<\/p><p>    \n\n<\/p><img decoding=\"async\" src=\"\/wp-content\/uploads\/sites\/16\/2023\/09\/Message%20flow.drawio.png\"><h3 class=\"wp-sub-header\">Implementation Details<\/h3><p>The RDK tr69 client is developed by Dimark which has the following key&nbsp;features<\/p><ul><li>The Dimark TR-069 client is typically provided as ANSI C source code that runs on&nbsp;embedded Linux, with the API designed to ease the integration of the client into&nbsp;existing environments<\/li><li>The client incorporates an abstraction layer that will speed implementation as well as&nbsp;make the addition of many new features, upgrades and updates virtual drop-ins.<\/li><li>The client incorporates all updates that have resulted from more than eight years of&nbsp;field use, feature requests and customer deployments.<br><br><img decoding=\"async\" src=\"\/wp-content\/uploads\/sites\/16\/2023\/09\/Implementation%20Details.drawio.png\"><\/li><\/ul><h3 class=\"wp-sub-header\">Solution Details<\/h3><h3 id=\"TR69-DataModels\">Data Models<\/h3><p>Data Model (version 0.9) &#8211; requires TR-181-2-2-0 Device-2.3 + TR-135 STB Service + Custom settop data model<\/p><ul><li>TR-098: Internet Gateway Device Data Model for TR-069<\/li><li>TR-104: Provisioning Parameters for VoIP CPE<\/li><li>TR-135: Data Model for a TR-069 Enabled STB<\/li><li>TR-140: TR-069 Data Model for Storage Service Enabled Devices<\/li><li>TR-143: Enabling Network Throughput Performance Tests and Statistical Monitoring<\/li><li>TR-181: Device Data Model for TR-069<\/li><\/ul><h3 id=\"TR69-InformMessage\">Inform Message<\/h3><p>The Inform message contains:<\/p><ul><li>Device.Manufacturer<\/li><li>Device.ManufacturerOUI<\/li><li>Device.SerialNumber<\/li><li>Device.ProductClass<\/li><\/ul><p>The Inform message at boot contains:<\/p><ul><li>Event Code = BootStrap<\/li><li>Parameter List<br><ul><li>HardwareVersion<\/li><li>SoftwareVersion<\/li><li>ProvisioningCode<\/li><li>ParameterKey<\/li><\/ul><\/li><\/ul><h3 id=\"TR69-ForceInform\"><span><a href=\"http:\/\/www.broadband-forum.org\/cwmp\/tr-181-2-1-0.html#H.Forced%20Inform%20Parameters\" rel=\"nofollow\" class=\"external-link\"><span>Force Inform<\/span><\/a><\/span><\/h3><p>The following parameters must be supported for Forced Inform:<\/p><ul><li>Device.DeviceInfo.HardwareVersion<\/li><li>Device.DeviceInfo.SoftwareVersion<\/li><li>Device.DeviceInfo.ProvisioningCode<\/li><li>Device.ManagementServer.ParameterKey<\/li><li>Device.ManagementServer.ConnectionRequestURL<\/li><\/ul><h3 id=\"TR69-DownloadMessage\">Download Message<\/h3><p>The Download message contains:<\/p><ul><li><p>CommandKey<\/p><\/li><li><p>FileType<\/p><\/li><li><p>URL<\/p><\/li><li><p>Username<\/p><\/li><li><p>Password<\/p><\/li><li><p>FileSize<\/p><\/li><li><p>TargetFileName<\/p><\/li><li><p>DelaySeconds<\/p><\/li><li><p>SuccessURL<\/p><\/li><li><p>FailureURL<\/p><\/li><\/ul><p><br><\/p><p><br><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Overview TR-069 is a technical specification that defines an application layer protocol for remote management [&hellip;]<\/p>\n","protected":false},"author":28,"featured_media":0,"parent":10215,"menu_order":1,"comment_status":"open","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-10220","page","type-page","status-publish","hentry"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v24.9 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>TR69 - RDK Documentation Portal | Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/diagnostics_subsystem\/tr69\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"TR69 - RDK Documentation Portal | Documentation\" \/>\n<meta property=\"og:description\" content=\"Overview TR-069 is a technical specification that defines an application layer protocol for remote management [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/diagnostics_subsystem\/tr69\/\" \/>\n<meta property=\"og:site_name\" content=\"RDK Documentation Portal | Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2024-12-04T14:10:50+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/diagnostics_subsystem\/tr69\/\",\"url\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/diagnostics_subsystem\/tr69\/\",\"name\":\"TR69 - RDK Documentation Portal | Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/#website\"},\"datePublished\":\"2022-06-21T09:11:33+00:00\",\"dateModified\":\"2024-12-04T14:10:50+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/diagnostics_subsystem\/tr69\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/diagnostics_subsystem\/tr69\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/diagnostics_subsystem\/tr69\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Documentation\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"RDK Entertainment\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Sub-Systems\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/?page_id=10158\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"Diagnostics\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/diagnostics_subsystem\/\"},{\"@type\":\"ListItem\",\"position\":6,\"name\":\"TR69\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/#website\",\"url\":\"https:\/\/developer.rdkcentral.com\/documentation\/\",\"name\":\"RDK Documentation Portal | Documentation\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/developer.rdkcentral.com\/documentation\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"TR69 - RDK Documentation Portal | Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/diagnostics_subsystem\/tr69\/","og_locale":"en_US","og_type":"article","og_title":"TR69 - RDK Documentation Portal | Documentation","og_description":"Overview TR-069 is a technical specification that defines an application layer protocol for remote management [&hellip;]","og_url":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/diagnostics_subsystem\/tr69\/","og_site_name":"RDK Documentation Portal | Documentation","article_modified_time":"2024-12-04T14:10:50+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/diagnostics_subsystem\/tr69\/","url":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/diagnostics_subsystem\/tr69\/","name":"TR69 - RDK Documentation Portal | Documentation","isPartOf":{"@id":"https:\/\/developer.rdkcentral.com\/documentation\/#website"},"datePublished":"2022-06-21T09:11:33+00:00","dateModified":"2024-12-04T14:10:50+00:00","breadcrumb":{"@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/diagnostics_subsystem\/tr69\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/diagnostics_subsystem\/tr69\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/diagnostics_subsystem\/tr69\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/developer.rdkcentral.com\/documentation\/"},{"@type":"ListItem","position":2,"name":"Documentation","item":"https:\/\/developer.rdkcentral.com\/documentation\/"},{"@type":"ListItem","position":3,"name":"RDK Entertainment","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/"},{"@type":"ListItem","position":4,"name":"Sub-Systems","item":"https:\/\/developer.rdkcentral.com\/documentation\/?page_id=10158"},{"@type":"ListItem","position":5,"name":"Diagnostics","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/sub-systems\/diagnostics_subsystem\/"},{"@type":"ListItem","position":6,"name":"TR69"}]},{"@type":"WebSite","@id":"https:\/\/developer.rdkcentral.com\/documentation\/#website","url":"https:\/\/developer.rdkcentral.com\/documentation\/","name":"RDK Documentation Portal | Documentation","description":"","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/developer.rdkcentral.com\/documentation\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"}]}},"_links":{"self":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/10220","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/users\/28"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/comments?post=10220"}],"version-history":[{"count":2,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/10220\/revisions"}],"predecessor-version":[{"id":11847,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/10220\/revisions\/11847"}],"up":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/10215"}],"wp:attachment":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/media?parent=10220"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}