TR-098 Amendment 1 - Broadband Forum

1 TECHNICAL REPORT The Broadband Forum . All rights reserved. TR-98 Internet Gateway Device Data Model for TR-069 Issue: Issue Date: November 2006 The Broadband Forum . All rights reserved. Internet Gateway Device Data Model for TR-069 TR-098 Amendment 1 Notice The Broadband Forum is a non-profit corporation organized to create guidelines for Broadband network system development and deployment. This Technical Report has been approved by members of the Forum . This document is not binding on the Broadband Forum , any of its members, or any developer or service provider. This document is subject to change, but only with approval of members of the Forum . This document is provided "as is," with all faults. Any person holding a copyright in this document, or any portion thereof, disclaims to the fullest extent permitted by law any representation or warranty, express or implied, including, but not limited to, (a) any warranty of merchantability, fitness for a particular purpose, non-infringement, or title; (b) any warranty that the contents of the document are suitable for any purpose, even if that purpose is known to the copyright holder; (c) any warranty that the implementation of the contents of the documentation will not infringe any third party patents, copyrights, trademarks or other rights.

2 This publication may incorporate intellectual property. The Broadband Forum encourages but does not require declaration of such intellectual property. For a list of declarations made by Broadband Forum member companies, please see Version History Version Number Version Date Version Editor Changes Issue 1 September 2005 Jeff Bernstein, 2 Wire Barbara Stark, BellSouth Issue 1 Issue 1 Amendment 1 November 2006 Jeff Bernstein, 2 Wire John Blackford, 2 Wire Mike Digdon, SupportSoft Heather Kirksey, Motive William Lupton, 2 Wire Anton Okmianski, Cisco Clarification of original document Technical comments or questions about this document should be directed to: Editor: Jeff Bernstein 2 Wire Barbara Stark BellSouth John Blackford 2 Wire Mike Digdon SupportSoft Heather Kirksey

3 Motive William Lupton 2 Wire Anton Okmianski Cisco WG Chairs Greg Bathrick PMC Sierra Heather Kirksey Motive Abstract: Defines the Internet Gateway Device data model for the CPE WAN Management Protocol (TR-069).

4 The Broadband Forum . All rights reserved. Internet Gateway Device Data Model for TR-069 TR-098 Amendment 1 Contents 1 Introduction .. 5 Terminology .. 5 Document Conventions .. 6 2 Data Model Definition .. 6 General Notation .. 6 Data Types .. 6 Vendor-Specific Parameters .. 8 InternetGatewayDevice Data Model .. 9 Inform and Notification Requirements .. 85 Version Data Model 90 3 Profile Definitions .. 92 Notation .. 92 Baseline Profile .. 92 EthernetLAN Profile .. 96 USBLAN Profile .. 96 WiFiLAN Profile .. 97 ADSLWAN Profile .. 98 EthernetWAN Profile .. 100 POTSWAN Profile .. 100 QoS Profile.

5 100 QoSDynamicFlow Profile .. 103 Bridging Profile .. 103 Time Profile .. 104 IPPing Profile .. 105 ATML oopback Profile .. 105 DSLD iagnostics Profile .. 106 DeviceAssociation Profile .. 106 UDPConnReq Profile .. 106 Normative References .. 108 Annex A. Queuing and 109 Queuing and Bridging 109 Packet 109 Classification Order .. 110 . Dynamic Application Specific Classification .. 111 . Classification 111 Policing .. 112 Queuing and Scheduling .. 112 Bridging .. 113 Filtering .. 113 . Exclusivity Order .. 113 Egress from a Bridge .. 114 Default Layer 2/3 QoS Mapping .. 115 URN Definitions for App and Flow 116 Protocol Identifier .. 116 FlowType .. 116 117 Example Queuing Architecture for RG (from TR-059).

6 117 Layer2 Bridging Use Case: Interface Based Bridging .. 119 Annex B. LinkType and ConnectionType Interdependencies .. 120 The Broadband Forum . All rights reserved. Internet Gateway Device Data Model for TR-069 TR-098 Amendment 1 1 Introduction This document describes the Internet Gateway Device data model for the CPE WAN Management Protocol (TR-069). TR-069 defines the generic requirements of the management protocol methods which can be applied to any TR-069 CPE. It is intended to support a variety of different functionalities to manage a collection of CPE, including the following primary capabilities: Auto-configuration and dynamic service provisioning Software/firmware image management Status and performance monitoring Diagnostics If TR-069 defines the generic methods for any device, other documents (such as this one) specify the managed objects, or data models, on which the generic methods act to configure, diagnose, and monitor the state of specific devices and services.

7 The following figure places TR-069 and this document in the end-to-end management architecture: The ACS is a server that resides in the network and manages devices in the subscriber premises. It uses the methods, or RPCs, defined to TR-069 to get and set the state of the device, initiate diagnostic tests, download and upload files, and manage events. This document defines those objects applicable to management of an Internet Gateway Device delivering Broadband service. The Internet Gateway Device data model follows the conventions defined in [3] for versioning of data models and the use of profiles. Terminology The following terminology is used throughout the series of documents defining the CPE WAN Management Protocol. ACS Auto-Configuration Server. This is a component in the Broadband network responsible for auto-configuration of the CPE for advanced services.

8 B-NT Broadband -Network Termination. A specific type of Broadband CPE used in DSL networks. CPE Customer Premises Equipment; refers to any TR-069-compliant device and therefore covers both Internet Gateway Devices and LAN-side end devices. CWMP CPE WAN Management Protocol. Defined in [2], CWMP is a communication protocol between an ACS and CPE that defines a mechanism for secure auto-configuration of a CPE and other CPe management functions in a common framework. Data Model A hierarchical set of Parameters that define the managed objects accessible via TR-069 Figure 1 Positioning in the End-to-End ArchitectureOSS/BSS Scope of CPE WAN ManagementProtocol (CWMP): ACS Southbound InterfaceManaged Internet Gateway DeviceTR:098 Internet GatewayDevice Data ModelACS Northbound Interface Managed LAN Device Managed LAND eviceManaged LAN Device Policy Call Center Auto-ConfigurationServer (ACS) The Broadband Forum .

9 All rights reserved. Internet Gateway Device Data Model for TR-069 TR-098 Amendment 1 for a particular device or service. Device Used interchangeably with CPE. Event An indication that something of interest has happened that requires the CPE to notify the ACS. Internet A CPE device, typically a Broadband router, that acts as a gateway between the WAN Gateway and the LAN. Device Parameter A name-value pair representing a manageable CPE parameter made accessible to an ACS for reading and/or writing. RPC Remote Procedure Call. Document Conventions The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [1]. The key words DEPRECATED and OBSOLETED in this document are to be interpreted as defined in [3].

10 2 Data Model Definition General Notation Parameter names use a hierarchical form similar to a directory tree. The name of a particular Parameter is represented by the concatenation of each successive node in the hierarchy separated with a . (dot), starting at the trunk of the hierarchy and leading to the leaves. When specifying a partial path, indicating an intermediate node in the hierarchy, the trailing . (dot) is always used as the last character. Parameter names MUST be treated as case sensitive. In some cases, where multiple instances of an object can occur, the placeholder node name {i} is shown. In actual use, this placeholder is to be replaced by an instance number, which MUST be a positive integer ( 1). Because in some cases object instances can be deleted, instance numbers will in general not be contiguous.