ETSI TS 118 106 V2.0.1 (2016-09)

oneM2M; Management Enablement (BBF) (oneM2M TS-0006 version 2.0.1 Release 2)

RTS/oneM2M-000006v200

General Information

• Status: Published
• Publication Date: 08-Sep-2016
• Technical Committee: oneM2M - oneM2M
• Current Stage: 12 - Completion
• Due Date: 03-Oct-2016
• Completion Date: 09-Sep-2016

Standards Content (Sample)

ETSI TS 118 106 V2.0.1 (2016-09)






TECHNICAL SPECIFICATION
oneM2M;
Management Enablement (BBF)
(oneM2M TS-0006 version 2.0.1 Release 2)

�

---------------------- Page: 1 ----------------------
oneM2M TS-0006 version 2.0.1 Release 2 2 ETSI TS 118 106 V2.0.1 (2016-09)



Reference
RTS/oneM2M-000006v200
Keywords
IoT, M2M, management

ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE

Tel.: [phone]  Fax: [phone]

Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88

Important notice
The present document can be downloaded from:
http://www.etsi.org/standards-search
The present document may be made available in electronic versions and/or in print. The content of any electronic and/or
print versions of the present document shall not be modified without the prior written authorization of ETSI. In case of any
existing or perceived difference in contents between such versions and/or in print, the only prevailing document is the
print of the Portable Document Format (PDF) version kept on a specific network drive within ETSI Secretariat.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
https://portal.etsi.org/TB/ETSIDeliverableStatus.aspx
If you find errors in the present document, please send your comment to one of the following services:
https://portal.etsi.org/People/CommiteeSupportStaff.aspx
Copyright Notification
No part may be reproduced or utilized in any form or by any means, electronic or mechanical, including photocopying
and microfilm except as authorized by written permission of ETSI.
The content of the PDF version shall not be modified without the written authorization of ETSI.
The copyright and the foregoing restriction extend to reproduction in all media.

© European Telecommunications Standards Institute 2016.
All rights reserved.

TM TM TM
DECT , PLUGTESTS , UMTS and the ETSI logo are Trade Marks of ETSI registered for the benefit of its Members.
TM
3GPP and LTE™ are Trade Marks of ETSI registered for the benefit of its Members and
of the 3GPP Organizational Partners.
GSM® and the GSM logo are Trade Marks registered and owned by the GSM Association.
ETSI

---------------------- Page: 2 ----------------------
oneM2M TS-0006 version 2.0.1 Release 2 3 ETSI TS 118 106 V2.0.1 (2016-09)
Contents
Intellectual Property Rights . 5
Foreword . 5
1 Scope . 6
2 References . 6
2.1 Normative references . 6
2.2 Informative references . 6
3 Definitions, abbreviations and acronyms . 7
3.1 Definitions . 7
3.2 Abbreviations . 7
3.3 Acronyms . 7
4 Conventions . 7
5 Mapping of basic data types . 7
6 Mapping of identifiers . 8
6.0 Introduction . 8
6.1 Mapping of Device identifiers to the Node Resource . 8
6.2 Identifier of an object instance . 9
7 Mapping of resources . 9
7.0 Introduction . 9
7.1 General mapping assumptions . 9
7.1.0 Introduction. 9
7.1.1 Mapping of Device Identifiers . 9
7.1.2 Mapping of Embedded Devices . 9
7.2 Resource [deviceInfo] . 10
7.3 Resource [memory] . 10
7.4 Resource [battery] . 11
7.5 Resource [areaNwkInfo] . 11
7.6 Resource [areaNwkDeviceInfo] . 11
7.7 Resource [eventLog] . 12
7.8 Resource [deviceCapability] . 12
7.9 Resource [firmware] . 13
7.10 Resource [software] . 14
7.11 Resource [reboot] . 15
7.12 Resource [cmdhPolicy] . 15
7.12.0 Introduction. 15
7.12.1 Resource [activeCmdhPolicy] . 16
7.12.2 Resource [cmdhDefaults] . 16
7.12.3 Resource [cmdhDefEcValue] . 16
7.12.4 Resource [cmdhEcDefParamValues] . 17
7.12.5 Resource [cmdhLimits] . 17
7.12.6 Resource [cmdhNetworkAccessRules] . 18
7.12.7 Resource [cmdhNwAccessRule] . 18
7.12.8 Resource [cmdhBuffer] . 19
7.13 Resource Type . 19
7.14 Resource Type . 20
8 Mapping of procedures for management . 20
8.0 Introduction . 20
8.1 Resource Type primitive mappings . 20
8.1.0 Introduction. 20
8.1.1 Alias-Based Addressing Mechanism . 20
8.1.2 Create primitive mapping . 20
8.1.2.0 Introduction . 20
8.1.2.1 M2M Service Layer Resource Instance Identifier mapping . 20
ETSI

---------------------- Page: 3 ----------------------
oneM2M TS-0006 version 2.0.1 Release 2 4 ETSI TS 118 106 V2.0.1 (2016-09)
8.1.3 Delete primitive mapping . 21
8.1.3.1 Delete primitive mapping for deletion of Object Instances . 21
8.1.3.2 Delete primitive mapping for software un-install operation . 21
8.1.4 Update primitive mapping . 23
8.1.4.1 Update primitive mapping for Parameter modifications . 23
8.1.4.2 Update primitive mapping for upload file transfer operations . 23
8.1.4.3 Update primitive mapping for download file transfer operations . 24
8.1.4.4 Update primitive mapping for reboot operation . 26
8.1.4.5 Update primitive mapping for factory reset operation . 26
8.1.4.6 Update primitive mapping for software install operation . 26
8.1.5 Retrieve primitive mapping . 28
8.1.6 Notify primitive mapping . 28
8.1.6.0 Introduction . 28
8.1.6.1 Procedure for subscribed Resource attributes. . 28
8.1.6.2 Notification primitive mapping . 29
8.2 and resource primitive mappings . 29
8.2.1 Update (Execute) primitive for the resource . 29
8.2.1.0 Introduction . 29
8.2.1.1 Execute File Download . 30
8.2.1.2 Execute File Upload Operations . 30
8.2.1.3 Report Results using TransferComplete RPC . 31
8.2.1.4 Execute Software Operations with ChangeDUState RPC . 32
8.2.1.5 Report Results with ChangeDUStateComplete RPC . 33
8.2.1.6 Execute Reboot operation . 34
8.2.1.7 Execute Factory Reset operation . 34
8.2.2 Delete resource primitive mapping . 35
8.2.3 Update (Cancel) primitive mapping . 35
8.2.4 Delete primitive mapping . 36
9 Server Interactions . 36
9.0 Introduction . 36
9.1 Communication Session Establishment. 37
9.1.1 IN-CSE to ACS Communication Session Establishment . 37
9.1.2 ACS to IN-CSE Communication Session Establishment . 37
9.1.3 ACS and IN-CSE Communication Session Requirements . 37
9.2 Processing of Requests and Responses . 37
9.2.1 Request and Notification Formatting . 37
9.2.2 ACS Request Processing Requirements . 38
9.2.3 ACS Notification Processing Requirements . 38
9.3 Discovery and Synchronization of Resources . 38
9.4 Access Management . 38
9.4.0 Introduction. 38
9.4.1 Access Management Requirements . 38
10 New Management Technology Specific Resources . 39
History . 40


ETSI

---------------------- Page: 4 ----------------------
oneM2M TS-0006 version 2.0.1 Release 2 5 ETSI TS 118 106 V2.0.1 (2016-09)
Intellectual Property Rights
IPRs essential or potentially essential to the present document may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (https://ipr.etsi.org/).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Foreword
This Technical Specification (TS) has been produced by ETSI Partnership Project oneM2M (oneM2M).
ETSI

---------------------- Page: 5 ----------------------
oneM2M TS-0006 version 2.0.1 Release 2 6 ETSI TS 118 106 V2.0.1 (2016-09)
1 Scope
The present document describes the protocol mappings between the management Resources for oneM2M and the BBF
TR-181 Data Model [6].
2 References
2.1 Normative references
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the
referenced document (including any amendments) applies.
Referenced documents which are not found to be publicly available in the expected location might be found at
https://docbox.etsi.org/Reference/.
NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee
their long term validity.
The following referenced documents are necessary for the application of the present document.
[1] ETSI TS 118 101: "oneM2M; Functional Architecture (oneM2M TS-0001)".
[2] ETSI TS 118 104: "oneM2M; Service Layer Core Protocol Specification (oneM2M TS-0004)".
[3] ETSI TS 118 111: "oneM2M; Common Terminology (oneM2M TS-0011)".
[4] BBF: "TR-069 CPE WAN Management Protocol" Issue: 1 Amendment 5, November 2013.
[5] BBF: "TR-106 Data Model Template for TR-069-Enabled Devices", Issue 1, Amendment 7,
September 2013.
[6] BBF: "TR-181 Device Data Model for TR-069, Issue 2 Amendment 8", September 2014.
[7] BBF: "TR-131 ACS Northbound Interface Requirements, Issue:1", November 2009.
2.2 Informative references
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the
referenced document (including any amendments) applies.
NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee
their long term validity.
The following referenced documents are not necessary for the application of the present document but they assist the
user with regard to a particular subject area.
[i.1] oneM2M Drafting Rules.
NOTE: Available at http://www.onem2m.org/images/files/oneM2M-Drafting-Rules.pdf.
ETSI

---------------------- Page: 6 ----------------------
oneM2M TS-0006 version 2.0.1 Release 2 7 ETSI TS 118 106 V2.0.1 (2016-09)
3 Definitions, abbreviations and acronyms
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ETSI TS 118 111 [3] and the following
apply:
CPE Proxier: CPE that is capable of proxying the communication between an ACS and a Proxied Device as defined in
TR-069 [4]
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ETSI TS 118 111 [3] and the following apply:
ACS Auto-Configuration Server
ADN Application Dedicated Node
AE Application Entity
ASN Application Service Node
BBF BroadBand Forum
CMDH Communication Management and Delivery Handling
CPE Customer Premise Equipment
CSE Common Services Entity
CWMP CPE WAN Management Protocol
DM Device Management
DU Deployment Unit
IN-CSE CSE which resides in the Infrastructure Node
LAN Local Area Network
MN Middle Node
OUI Organizationally Unique Identifier
PC Product Class
RPC Remote Procedure Call
SN Serial Number
UPA Universal Powerline Association
URI Uniform Resource Identifier
URL Uniform Resource Locator
USB Universal Serial Bus
UUID Universal Unique Identifier
XML Extensible Markup Language
3.3 Acronyms
For the purposes of the present document, the acronyms given in ETSI TS 118 111 [3] apply.
4 Conventions
The key words "Shall", "Shall not", "May", "Need not", "Should", "Should not" in the present document are to be
interpreted as described in the oneM2M Drafting Rules [i.1].
5 Mapping of basic data types
TR-106 [5] specifies the object structure supported by TR-069 enabled devices and specifies the structural requirements
for the data hierarchy. This clause includes the mapping attribute data types to TR-181 [6] parameters which follows the
conventions of section 3 of TR-106 [5] and data types described in Table 4 of TR-106 [5].
ETSI

---------------------- Page: 7 ----------------------
oneM2M TS-0006 version 2.0.1 Release 2 8 ETSI TS 118 106 V2.0.1 (2016-09)
Table 5-1: Data Type Mapping
Mapping to data
oneM2M Data Types Conversion Notes
types in TR-106
xs:boolean boolean
xs:string string Mapping is constrained to the size of the string
xs:unsignedInt unsignedInt
xs:unsignedLong unsignedLong
xs:integer long Mapping is constrained to the size of the long data type.
Xs:positiveInteger unsignedLong Mapping is constrained to a lower limit of 1 and the size of the
unsignedLong data type.
Xs:nonNegativeInteger unsignedLong Mapping is constrained the size of the unsignedLong data type.
Comma separated Comma separated Data structure is represented by comma separated list as described in
Lists Lists section 3.2.3 of TR-106 [5].

In some instances the conversion of the contents between data types will cause an error to occur (e.g. xs:integer to
long). When an error occurs in the conversion of a data type, the STATUS_BAD_REQUEST response status code.
6 Mapping of identifiers
6.0 Introduction
The TR-069 [4] specification defines three (3) types of devices, known as CPEs, that are capable of being managed
from the perspective of the TR-069 agent:
• CPE that hosts the TR-069 agent: Section A.3.3.1 Inform of TR-069 [4] defines the required fields for a CPE
to be identified. These fields include the OUI and Serial Number of the CPE assigned by the CPE
manufacturer. Optionally the manufacturer may assign a Product Class to the CPE. The format of the identifier
is as follows: OUI-[PC-]SN.
• Virtual Device: This type of device is addressed as a CPE. The Virtual Device has its own OUI-[PC-]SN as
represented by the CPE Proxier. The CPE Proxier emulates a CWMP agent for each Virtual Device.
• Embedded Device: This type of device is addressed as one or more objects within the data model of the CPE
that hosts the TR-069 agent.
6.1 Mapping of Device identifiers to the Node Resource
Node Resources are identified for each instance of an ADN, ASN and MN node and are identified using the M2M Node
Identifier (M2M-Node-ID) defined in the oneM2M Functional [1].
CPE Device identifiers shall map to the nodeID attribute of the resource. The CPE Device identifiers are
obtained from the contents of the following attributes:
• Device.DeviceInfo.ManufacturerOUI
• Device.DeviceInfo.ProductClass
• Device.DeviceInfo.SerialNumber
Virtual Device identifiers shall map to the nodeID attribute of the resource. The Virtual Device identifiers are
obtained from the CPE Proxier using the contents of the attributes:
• Device.ManagementServer.VirtualDevice.{i}.ManufacturerOUI
• Device.ManagementServer.VirtualDevice.{i}.ProductClass
• Device.ManagementServer.VirtualDevice.{i}.SerialNumber
ETSI

---------------------- Page: 8 ----------------------
oneM2M TS-0006 version 2.0.1 Release 2 9 ETSI TS 118 106 V2.0.1 (2016-09)
Embedded Device identifiers shall map to the nodeID attribute of the resource. The Embedded Device
identifiers are obtained using the containing CPE Device or Virtual Device identifiers along with the contents of the
attributes of the:
• Device.ManagementServer.EmbeddedDevice.{i}.ControllerID
• Device.ManagementServer.EmbeddedDevice.{i}.ProxiedDeviceID
6.2 Identifier of an object instance
The TR-069 [4] specification permits objects to have multiple object instances where each object instance is contained
within the objectPath attribute of the Resource within the context of the Resource's objectId as defined in clause 7.1.
In order to allow the AE or CSE that originated the request that manipulates a Resource to easily align the M2M Service
Layer with the Resource's external technology identifier, the value of the object instance "{i}" should be a part of the
identifier of the Resource in the M2M Service Layer where possible. For example if the [areaNetwork] resource has an
object instance identifier of "Device.X_oneM2M_org_CSE.1.M2MareaNetworkDevice.[foo]" then the M2M Service
Layer Resource should be identified using the object instance of the underlying technology (e.g. "/foo" for the Resource
areaNetwork).
7 Mapping of resources
7.0 Introduction
This clause contains all information on how to map management resources from ETSI TS 118 104 [2] to managed
objects and parameters as defined in the TR-181 [6] data model or the Remote Procedure Calls (RPCs) in TR-069 [4].
7.1 General mapping assumptions
7.1.0 Introduction
TR-069 [4] specifies a protocol for communication between a CPE (Customer Premises Equipment) and an ACS
(Auto-Configuration Server). Any TR-069 enabled device has to follow the data model as described in the TR-106 [5]
and TR-181 [6] as well as RPCs described in TR-069 [4].
As TR-181 [6] is the model that the Resources are mapped, all Resources shall have the objects of the TR-181 [6]
namespace (e.g. "urn:broadband-forum-org:tr-181-2-7-0").
7.1.1 Mapping of Device Identifiers
The Device identifiers for CPEs are mapped to the Resource Types [deviceInfo].
For CPE and Virtual Devices map their Device Identifiers (OUI-[PC-]SN) to the manufacturer, deviceType and
deviceLabel attributes of the Resource [deviceInfo].
For Embedded Devices, the ControllerID and ProxiedDeviceID parameters of the
Device.ManagementServer.EmbeddedDevice.{i} object instance are mapped to the deviceLabel attribute of the
Resource [deviceInfo] as a comma separated list: "Device.ManagementServer.EmbeddedDevice.{i}.ControllerID,
Device.ManagementServer.EmbeddedDevice.{i}.ProxiedDeviceID".
7.1.2 Mapping of Embedded Devices
The TR-181 [6] specification does not provide a mechanism where Embedded Devices provide information related to
the Device.DeviceInfo objects and sub-objects. Instead the TR-181 [6] provides this information in a manner that is
reliant on the Embedded Device's underlying technology (e.g. ZigBee®, UpnP).
ETSI

---------------------- Page: 9 ----------------------
oneM2M TS-0006 version 2.0.1 Release 2 10 ETSI TS 118 106 V2.0.1 (2016-09)
As such the mapping of the [memory] and [battery] Resources are implementation specific for each underlying
technology and is outside the scope of the present document.
7.2 Resource [deviceInfo]
The Resource [deviceInfo] is a read-only Resource that shall map to the Device.DeviceInfo object of TR-181 [6] for
CPE and Virtual Devices.
The information shall be retrieved using the GetParameterValues RPC of TR-069 [4].
NOTE: The SerialNumber, ModelNumber, ProductClass attributes for a Virtual device are the same values as the
Device.ManagementServer.VirtualDevice.{i} object in the CPE Proxier.
Table 7.2-1: Resource [deviceInfo] for CPE and Virtual Devices
Attribute Name of
TR-181 Parameter
[deviceInfo]
deviceLabel Device.DeviceInfo.SerialNumber
manufacturer Device.DeviceInfo.Manufacturer
model Device.DeviceInfo.ModelNumber
deviceType Device.DeviceInfo.ProductClass
fwVersion Device.DeviceInfo.SoftwareVersion if the device support
...