hash
stringlengths
32
32
doc_id
stringlengths
7
13
section
stringlengths
3
121
content
stringlengths
0
2.2M
b59ff5f2c3ee9c7d158588bafab8a1bc
118 105
6.6.1.5 CmdhEcDefParamValues Object
The CmdhEcDefParamValues Object represents a specific set of default values for the CMDH related parameters Request Expiration Timestamp, Result Expiration Timestamp, Operational Execution Time, Result Persistence and Delivery Aggregation that are applicable for a given Event Category if these parameters are not specified in the message. Table 6.6.1.5-1: Object definition Name Object ID Instances Mandatory Object URN CmdhEcParamValues 2052 Multiple Optional urn:oma:lwm2m:ext:2052 Table 6.6.1.5-2: Resource definitions ID Name Operations Instances Mandatory Type Range or Enumeration Units Description 0 ApplicableEventCategory RW Multiple Mandatory Integer Contains list of Event Category values 1 DefaultRequestExpTime RW Single Mandatory Integer ms Contains the default value for the Request Expiration Timestamp parameter when such a parameter is not set in the request 2 DefaultResultExpTime RW Single Mandatory Integer ms Contains the default value of the Result Expiration Timestamp parameter when such a parameter is not set in the request 3 DefaultOpExecTime RW Single Mandatory Integer ms Contains the default value of the Operation Execution Time parameter when such a parameter is not set in the request ETSI ETSI TS 118 105 V4.0.1 (2025-09) 72 oneM2M TS-0005 version 4.0.1 Release 4 ID Name Operations Instances Mandatory Type Range or Enumeration Units Description 4 DefaultRespPersistence RW Single Mandatory Integer ms Contains the default value of the Result Persistence parameter when such a parameter is not set in the request 5 DefaultDelAggregation RW Single Mandatory Integer ms Contains the default value of the Delivery Aggregation parameter when such a parameter is not set in the request
b59ff5f2c3ee9c7d158588bafab8a1bc
118 105
6.6.1.6 CmdhLimits Object
The CmdhLimits Object represents limits for CMDH related parameter values. Table 6.6.1.6-1: Object definition Name Object ID Instances Mandatory Object URN CmdhLimits 2053 Multiple Optional urn:oma:lwm2m:ext:2053 Table 6.6.1.6-2: Resource definitions ID Name Operations Instances Mandatory Type Range or Enumeration Units Description 0 Order RW Single Mandatory Integer Contains index indicating in which order the concerned CmdhLimits Object Instance will be treated by the CSE to determine a value for the limit parameters 1 RequestOrigin RW Multiple Mandatory String List of zero or more Local AE- IDs, App-IDs, or the strings "localAE" or "thisCSE" 2 RequestContext RW Single Optional String Represents the Dynamic Context condition under which CMDH parameter limits defined inside the concerned CmdhLimits Object Instance is applicable 3 RequestContextNotification RW Single Optional Boolean Contains true/false flag indicating whether or not notification procedures apply ETSI ETSI TS 118 105 V4.0.1 (2025-09) 73 oneM2M TS-0005 version 4.0.1 Release 4 ID Name Operations Instances Mandatory Type Range or Enumeration Units Description 4 RequestCharacteristics RW Single Optional String Represents conditions pertaining to the request itself, (e.g. the requested Response Type) than needs to be matched 5 LimitsEventCategory RW Multiple Mandatory Integer Allowed values for the Event Category parameter in a request of any of the Originators indicated in the requestOrigin attribute 6 LimitsRequestExpTime RW Multiple Mandatory Integer 2 Instances ms Defines a range of values for the Request Expiration Time parameter for a request of any Originator indicated in the requestOrigin Resource Inst 0: minTime Inst 1: maxTime 7 LimitsResultExpTime RW Multiple Mandatory Integer 2 Instances ms Defines a range of values for the Result Expiration Time parameter for a request of any Originator indicated in the requestOrigin Resource Inst 0: minTime Inst 1: maxTime 8 LimitsOptExpTime RW Multiple Mandatory Integer 2 Instances ms Defines a range of values for the Operation Expiration Time parameter for a request of any Originator indicated in the requestOrigin Resource Inst 0: minTime Inst 1: maxTime 9 LimitsRespPersistence RW Multiple Mandatory Integer 2 Instances ms Defines a range of values for the Result Persistence parameter for a request of any Originator indicated in the requestOrigin Resource Inst 0: minTime Inst 1: maxTime ETSI ETSI TS 118 105 V4.0.1 (2025-09) 74 oneM2M TS-0005 version 4.0.1 Release 4 ID Name Operations Instances Mandatory Type Range or Enumeration Units Description 10 LimitsDelAggregation RW Multiple Mandatory String Contains the permitted settings of the DeliveryAggregati on parameter of request primitives. '0' means 'False' '1' means 'True' '0 1' means 'False' or 'True'
b59ff5f2c3ee9c7d158588bafab8a1bc
118 105
6.6.1.7 CmdhNetworkAccessRules Object
The CmdhNetworkAccessRules Object defines the usage of underlying networks for forwarding information to other CSEs during processing of CMDH-related requests in a CSE. Table 6.6.1.7-1: Object definition Name Object ID Instances Mandatory Object URN CmdhNetworkAccessRules 2054 Multiple Optional urn:oma:lwm2m:ext:2054 Table 6.6.1.7-2: Resource definitions ID Name Operations Instances Mandatory Type Range or Enumeration Units Description 0 ApplicableEventCategories RW Multiple Mandatory Integer Contains a list of Event Category values 1 NetworkAccessRule RW Multiple Optional Objlink Contains 0 or more references to CmdhNwAccessRule Object Instances
b59ff5f2c3ee9c7d158588bafab8a1bc
118 105
6.6.1.8 CmdhNwAccessRule Object
The CmdhNwAccessRule Object defines limits in usage of specific underlying networks for forwarding information to other CSEs during processing of CMDH-related requests in a CSE. Table 6.6.1.8-1: Object definition Name Object ID Instances Mandatory Object URN CmdhNwAccessRule 2055 Multiple Optional urn:oma:lwm2m:ext:2055 Table 6.6.1.8-2: Resource definitions ID Name Operations Instances Mandatory Type Range or Enumeration Units Description 0 TargetNetwork RW Multiple Mandatory String Contains identifiers of Underlying networks ETSI ETSI TS 118 105 V4.0.1 (2025-09) 75 oneM2M TS-0005 version 4.0.1 Release 4 ID Name Operations Instances Mandatory Type Range or Enumeration Units Description 1 MinReqVolume RW Single Mandatory Integer Byte Minimum amount of data that needs to be aggregated before any of the Underlying Networks matching with the targetNetwork Resource of the current Instance of the CmdhNwAccessRule Object can be used for forwarding information to other CSEs 2 SpreadingWaitTime RW Single Mandatory Integer ms Contains a value in ms such that before accessing the underlying network (typically to forward an incoming request), the CSE will wait for an additional amount of time randomly chosen between 0 and this value 3 BackOffParameters RW Single Mandatory objlnk Reference to an Instance of of BackOffParameterSet Object defining parameters that define how usage of any of the Underlying Networks matching with the targetNetwork Resource of that Object Instance, shall be handled when attempts to use such networks have failed 4 OtherConditions RW Single Mandatory String List of additional conditions that need to be fulfilled before any of the Underlying Networks matching with the TargetNetwork Resource of this CmdhNwAccessRule Object Instance can be used for forwarding information to other CSEs 5 AllowedSchedule RW Multiple Mandatory String Contains time schedules in form of extended crontab syntax defined in ETSI TS 118 104 [2]
b59ff5f2c3ee9c7d158588bafab8a1bc
118 105
6.6.1.9 CmdhBuffer Object
The CmdhBuffer Object defines limits in usage of buffers for temporarily storing information that needs to be forwarded to other CSEs during processing of CMDH-related requests in a CSE. Table 6.6.1.9-1: Object definition Name Object ID Instances Mandatory Object URN CmdhBuffer 2056 Multiple Optional urn:oma:lwm2m:ext:2056 ETSI ETSI TS 118 105 V4.0.1 (2025-09) 76 oneM2M TS-0005 version 4.0.1 Release 4 Table 6.6.1.9-2: Resource definitions ID Name Operations Instances Mandatory Type Range or Enumeration Units Description 0 ApplicableEventCategory RW Multiple Mandatory Integer Contains a list of event category values 1 MaxBufferSize RW Single Mandatory Integer Byte Contains the max Buffer size of the CmdhBuffer Object Instance 2 StoragePriority RW Single Mandatory Integer 1..10 Storage priority for the buffered data associated to that CmdhBuffer Object Instance. Buffered requests associated with a lower storage priority shall be purged before buffered requests with a higher storage priority.
b59ff5f2c3ee9c7d158588bafab8a1bc
118 105
6.6.1.10 CmdhBackOffParametersSet Object
The CmdhBackOffParametersSet Object defines set of parameters which can be referenced by a specific Instance of the CmdhNwAccessRule Object (ID: 2055). Table 6.6.1.10-1: Object definition Name Object ID Instances Mandatory Object URN CmdhBackOffParamet ersSet 2057 Multiple Optional urn:oma:lwm2m:ext:2057 Table 6.6.1.10-2: Resource definitions ID Name Operations Instances Mandatory Type Range or Enumeration Units Description 0 NetworkAction RW Single Optional Integer 1..5 Contains specific action actually attempted on the network (e.g. cellular-registration) 1 InitialBackoffTime RW Single Mandatory Integer ms Regarding the BackOffParameters of a certain CmdhNwAccessRule Object Instance, this Resource contains the value for the Initial wait time 2 AdditionalBackoffTime RW Single Mandatory Integer ms Regarding the BackOffParameters of a certain CmdhNwAccessRule Object Instance, this Resource contains the value for an additional wait time ETSI ETSI TS 118 105 V4.0.1 (2025-09) 77 oneM2M TS-0005 version 4.0.1 Release 4 ID Name Operations Instances Mandatory Type Range or Enumeration Units Description 3 MaximumBackoffTime RW Single Mandatory Integer ms Regarding the BackOffParameters of a certain CmdhNwAccessRule Object Instance, this Resource contains the value for the maximum wait time 4 OptionalRandomBackoff Time RW Multiple Optional Integer ms Regarding the BackOffParameters of a certain CmdhNwAccessRule Object Instance, this Resource contains the value for an optional random wait time 6.7 Generic Guidelines for Mapping LwM2M Objects to oneM2M <mgmtObj> Resources Since there are several LwM2M defined objects and vendor defined LwM2M Objects that currently do not have a corresponding <mgmtObj> specialization defined in the present document, the following guidelines have been defined. These guidelines provide interoperability and extensibility between the two standards and ensure seamless interworking of LwM2M clients and servers with oneM2M CSEs and AEs. Below are the guidelines for generically mapping LwM2M Objects to oneM2M <mgmtObj> resources. 1) For a given LwM2M object that is to be mapped to oneM2M, there shall exist a definition file where information about the LwM2M object is defined. An example of such a definition file is shown in annex A for convenience. Using a template oneM2M schema file as shown in annex B, a corresponding oneM2M <mgmtObj> XSD file shall be created that is compliant with existing oneM2M XSD conventions as defined in ETSI TS 118 104 [2]. 2) The new XSD shall have a base of "m2m:mgmtResource" and inherit all oneM2M defined <mgmtObj> common attributes. In addition, the new mgmtObj resource shall include the oneM2M common types and subscription schema files. The name of both the resource and the schema file shall be the concatenation of the LwM2M Object name. For example, the LwM2M Cellular connectivity object (object ID 10) shall be given the name cellularConnectivity in oneM2M. 3) For each LwM2M resource supported by the LwM2M object to be mapped, the XSD shall support a corresponding oneM2M [objectAttribute] element. The name of the LwM2M resource shall be used for the name of the oneM2M [objectAttribute] but the convention of the name shall follow oneM2M naming conventions, e.g. LwM2M resource name "SMSC address" shall be "smscAddress". 4) The order of the [objectAttribute] attributes shall match the order of the LwM2M resources as specified by the LwM2M object's resource definition file. This order matching is important as it provides an ordered mapping between LwM2M resources and oneM2M attributes. This allows for easier translation of oneM2M [objectAttribute] attributes to the corresponding LwM2M resources whenever a request is made to manage a LwM2M device. The ordering will also help ensure that <mgmtObj> XSD files generated by different developers and for the same LwM2M object are the same. 5) For each [objectAttribute] attribute, the following guidelines shall be followed. a) The type definition shall be based on the mapping of basic data types defined in clause 6.1. ETSI ETSI TS 118 105 V4.0.1 (2025-09) 78 oneM2M TS-0005 version 4.0.1 Release 4 b) The minOccurs and maxOccurs settings shall be based on the multiplicity (i.e. Single vs. Multiple) and the optionality (i.e. Mandatory vs. Optional) of the corresponding LwM2M resource. A mandatory attribute shall have a minOccurs=1, while an optional attribute shall have a minOccurs=0. An attribute with single multiplicity shall have a maxOccurs=1, while an attribute with multiplicity greater than one shall have a maxOccurs set to the specified limit or to unbounded if no limit is specified. 6) An example of a oneM2M schema file that is mapped from a LwM2M resource definition file is shown in annex C. Note the order of the oneM2M resource specific attributes match that of the LwM2M definition file, e.g. activatedProfileNames is mapped to Activated Profile Names even though the LwM2M resource ID is not sequential. As long as the order of the oneM2M attributes match the order of the LwM2M resources, a mapping can be performed provided that both the oneM2M schema file and the LwM2M resource definition are available. This applies to cases where the LwM2M resource ID are out of sequence or even if there is a gap in the sequence of the resource IDs. 7) When creating the <mgmtObj> associated with a LwM2M Object defined by these guidelines, the following rules shall be followed as shown in table 6.7-1. a) mgmtDefinitions shall be set to the value "Unspecified". b) mgmtSchema shall be set to the URI of where the XSD file created in Step 1 is located. c) objectIDs shall be set to the URN of the corresponding LwM2M Object. d) objectPaths may be included and configured with the prefix of the local path where the LwM2M Object resides on the LwM2M device. e) mgmtLink may be included if the <mgmtObj> resource links to another <mgmtObj> resource to form a hierarchy of <mgmtObj> resources. f) The inclusion of at least one [objectAttribute]. Note the order of the [objectAttribute] shall follow the same order as specified by the LwM2M Object's resource definition file. g) The description attribute may be included to provide more specific information about the functionality of the <mgmtObj>. An example is the string "LwM2M:<object_ID>" to identify the <mgmtObj> is associated with LwM2M and to what Object ID. Table 6.7-1: <mgmtObj> Resource Specific Attributes <mgmtObj> Attributes Create M/O Description of Value During <mgmtObj> Create mgmtDefinitions M Contains the value corresponding to "Unspecified" mgmtSchema O URI of an XSD file that provides the resource definitions for this <mgmtObj> resource objectIDs M URN of the corresponding LwM2M object objectPaths O Contains the prefix of the local path the LwM2M Object resides at on the LwM2M device. The path will include the LwM2M object instance associated with this <mgmtObj> resource, e.g. /9/2 - this <mgmtObj> maps to software object instance 2 mgmtLink O Contains a link to other <mgmtObj> resources to support a hierarchy of <mgmtObj> resources [objectAttribute] M List of LwM2M resources mapped to oneM2M attributes one for one and in the order specified by the LwM2M Object's resource definitions file Description O A text description that contains information about the LwM2M Object These generic guidelines allow for the specification of a new <mgmtObj> schema definitions that may be referenced by the mgmtSchema attribute. The new schema definition (e.g. XSD) of the <mgmtObj> specialization shall correspond to a LwM2M Object definition. The mgmtSchema shall be configured during the creation of the specialized <mgmtObj> resource. The option to specify a URI in the mgmtSchema attribute allows the CSE to support interworking with new LwM2M Objects (e.g. those that were not available at the time of initial deployment of the CSE). This is especially true in the case of vendor specific LwM2M Objects. The URI will point to a location where the schema definition of the new <mgmtObj> specialization can be found and retrieved by the CSE to use. ETSI ETSI TS 118 105 V4.0.1 (2025-09) 79 oneM2M TS-0005 version 4.0.1 Release 4 Annex A (informative): Example definition file for OMA LwM2M object The following text shows an example for the information an OMA LwM2M object definition file contains. "<?xml version="1.0" encoding="utf-8"?> <!-- FILE INFORMATION OMA Permanent Document File: OMA-SUP-XML_LWM2M_Cellular_connectivity-V1_0-20170301-D Type: xml Public Reachable Information Path: http://www.openmobilealliance.org/tech/profiles Name: LWM2M_Cellular_connectivity-v1_0.xml NORMATIVE INFORMATION Information about this file can be found in the latest revision of OMA-TS-LWM2M_ConnMgmt-V1_0 This is available at http://www.openmobilealliance.org/ Send comments to technical-comments@mail.openmobilealliance.org CHANGE HISTORY 01032017 File created LEGAL DISCLAIMER Copyright 2017 Open Mobile Alliance All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. The above license is used as a license under copyright only. Please reference the OMA IPR Policy for patent licensing terms: http://www.openmobilealliance.org/ipr.html --> <LWM2M xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://openmobilealliance.org/tech/profiles/LWM2M.xsd"> <Object ObjectType="MODefinition"> <Name>Cellular connectivity</Name> <Description1><![CDATA[This object specifies resources to enable a device to connect to a 3GPP or 3GPP2 bearer, including GPRS/EDGE, UMTS, LTE, NB-IoT, SMS. For cellular connectivity, this object focuses on Packet Switched (PS) connectivity and doesn’t aim to provide comprehensive Circuit Switched (CS) connectivity management. ETSI ETSI TS 118 105 V4.0.1 (2025-09) 80 oneM2M TS-0005 version 4.0.1 Release 4 ]]></Description1> <ObjectID>10</ObjectID> <ObjectURN>urn:oma:lwm2m:oma:10</ObjectURN> <MultipleInstances>Single</MultipleInstances> <Mandatory>Optional</Mandatory> <Resources> <Item ID="11"><Name>Activated Profile Names</Name> <Operations>R</Operations> <MultipleInstances>Multiple</MultipleInstances> <Mandatory>Mandatory</Mandatory> <Type>String</Type> <RangeEnumeration></RangeEnumeration> <Units></Units> <Description><![CDATA[Links to instances of the "APN connection profile" object representing every APN connection profile that has an activated connection to a PDN.]]></Description> </Item> <Item ID="0"><Name>SMSC address</Name> <Operations>RW</Operations> <MultipleInstances>Single</MultipleInstances> <Mandatory>Optional</Mandatory> <Type>String</Type> <RangeEnumeration></RangeEnumeration> <Units></Units> <Description><![CDATA[E.164 address of SMSC. Applicable for 3GPP2 networks where SMSC is not available from a smart card, or for 3GPP/3GPP2 networks to provide the application with a customer specific SMSC. The application decides how to use this parameter, e.g. precedence over UICC based SMSC address.]]></Description> </Item> <Item ID="1"><Name>Disable radio period</Name> <Operations>RW</Operations> <MultipleInstances>Single</MultipleInstances> <Mandatory>Optional</Mandatory> <Type>Integer</Type> <RangeEnumeration>0-65535</RangeEnumeration> <Units>minutes</Units> <Description><![CDATA[Time period for which the device shall disconnect from cellular radio (PS detach, CS detach if applicable). Can be used to handle network overload situations. The value is a positive integer (0 to 65535), duration can be from 1 minute to 65535 minutes (approximately 45 days). As soon the server writes a value which is >0 the device SHALL disconnect. When the period has elapsed the device MAY reconnect.]]></Description> </Item> <Item ID="2"><Name>Module activation code</Name> <Operations>RW</Operations> <MultipleInstances>Single</MultipleInstances> <Mandatory>Optional</Mandatory> <Type>String</Type> <RangeEnumeration></RangeEnumeration> <Units></Units> <Description><![CDATA[Configurable in case the application needs to issue a code (e.g. via AT command) to activate the module. e.g. "*98".]]></Description> </Item> <Item ID="3"><Name>Vendor specific extensions</Name> <Operations>R</Operations> <MultipleInstances>Single</MultipleInstances> <Mandatory>Optional</Mandatory> <Type>Objlnk</Type> <RangeEnumeration></RangeEnumeration> <Units></Units> <Description><![CDATA[Links to a vendor specific object.]]></Description> </Item> <Item ID="4"><Name>PSM Timer (1)</Name> <Operations>RW</Operations> <MultipleInstances>Single</MultipleInstances> <Mandatory>Optional</Mandatory> <Type>Integer</Type> <RangeEnumeration>10min-992 days</RangeEnumeration> <Units>s</Units> <Description><![CDATA[Power saving mode (PSM) timer as defined in [3GPP-TS_23.682]. PSM Timer = Extended T3412. Max interval between periodic TAU if there is no other transmission from the device. During most of this time the device is considered as unreachable and can therefore go into a deep sleep mode while keeping the PDN connection(s) active.]]></Description> </Item> <Item ID="5"><Name>Active Timer (1)</Name> <Operations>RW</Operations> <MultipleInstances>Single</MultipleInstances> <Mandatory>Optional</Mandatory> <Type>Integer</Type> ETSI ETSI TS 118 105 V4.0.1 (2025-09) 81 oneM2M TS-0005 version 4.0.1 Release 4 <RangeEnumeration>2sec-31 min</RangeEnumeration> <Units>s</Units> <Description><![CDATA[Active timer = T3324 as defined in [3GPP-TS_24.008]. The time the UE has to remain reachable after transitioning to idle state in case there is pending data from the NW to send out. At the end of T3324 UE can go into a deep sleep mode while keeping the PDN connection(s) active.]]></Description> </Item> <Item ID="6"><Name>Serving PLMN Rate control</Name> <Operations>R</Operations> <MultipleInstances>Single</MultipleInstances> <Mandatory>Optional</Mandatory> <Type>Integer</Type> <RangeEnumeration></RangeEnumeration> <Units></Units> <Description><![CDATA[Only for when using Signalling Radio Bearers (c.f. Data over NAS), it indicates the maximum the number of allowed uplink PDU transmissions per 6 minute interval aggregated across all PDN connections. See [3GPP-TS_23.401], octet 3 to 4 of the Serving PLMN rate control IE.]]></Description> </Item> <Item ID="7"><Name>eDRX parameters for Iu mode (1)</Name> <Operations>RW</Operations> <MultipleInstances>Single</MultipleInstances> <Mandatory>Optional</Mandatory> <Type>Opaque</Type> <RangeEnumeration>8 bits</RangeEnumeration> <Units></Units> <Description><![CDATA[Extended DRX parameters (Paging Time Window and eDRX value) for Iu mode which the UE can request from the network. This resource is encoded as octet 3 in [3GPP- TS_24.008, clause 10.5.5.32].]]></Description> </Item> <Item ID="8"><Name>eDRX parameters for WB-S1 mode (1)</Name> <Operations>RW</Operations> <MultipleInstances>Single</MultipleInstances> <Mandatory>Optional</Mandatory> <Type>Opaque</Type> <RangeEnumeration>8 bits</RangeEnumeration> <Units></Units> <Description><![CDATA[Extended DRX parameters (Paging Time Window and eDRX value) for WB-S1 mode which the UE can request from the network. This resource is encoded as octet 3 in [3GPP-TS_24.008, clause 10.5.5.32].]]></Description> </Item> <Item ID="9"><Name>eDRX parameters for NB-S1 mode (1)</Name> <Operations>RW</Operations> <MultipleInstances>Single</MultipleInstances> <Mandatory>Optional</Mandatory> <Type>Opaque</Type> <RangeEnumeration>8 bits</RangeEnumeration> <Units></Units> <Description><![CDATA[Extended DRX parameters (Paging Time Window and eDRX value) for NB-S1 mode which the UE can request from the network. This resource is encoded as octet 3 in [3GPP-TS_24.008, clause 10.5.5.32].]]></Description> </Item> <Item ID="10"><Name>eDRX parameters for A/Gb mode (1)</Name> <Operations>RW</Operations> <MultipleInstances>Single</MultipleInstances> <Mandatory>Optional</Mandatory> <Type>Opaque</Type> <RangeEnumeration>8 bits</RangeEnumeration> <Units></Units> <Description><![CDATA[Extended DRX parameters (Paging Time Window and eDRX value) for A/Gb mode which the UE can request from the network. This resource is encoded as octet 3 in [3GPP-TS_24.008, clause 10.5.5.32].]]></Description> </Item></Resources> <Description2><![CDATA[Notes: (1) This parameter is controlled by the 3GPP network. A LWM2M server may write a suggested value to this resource. As soon a LWM2M server changes the current value the device then suggests the new value to the network upon the next practical opportunity e.g. by inclusion of the requested value in an Attach or TAU request. In case the network confirms the suggested value then the device shall apply that value. In case the network provides a different value then the value provided by the network shall be applied by the device and the resource value shall be set to that value. The LWM2M server may use the observe function to be notified upon any changes of PSM or Active timer. By using the observe function the LWM2M server will get notified in case the value suggested by the LWM2M server is not accepted by the network, or, if the value is changed by the network for any reason (e.g. if the device moves into new tracking areas there is no guarantee that the above values remain the same and are not altered by the network). ]]></Description2> </Object> </LWM2M>". ETSI ETSI TS 118 105 V4.0.1 (2025-09) 82 oneM2M TS-0005 version 4.0.1 Release 4 Annex B (normative): Mapping LwM2M object definition files to oneM2M schema files The following text is a oneM2M template schema file for use when mapping LwM2M object definition files to oneM2M schema files. This template contains the oneM2M copyright notice, the schema namespace information, and the schema include sections that are common for all oneM2M resource schemas. Two XML element sections are reserved for resource specific mappings to interwork LwM2M object definition files to oneM2M mgmtObj resource schemas. These sections represent the oneM2M resource specific attributes and the corresponding announced resources, respectively. This template contains placeholder oneM2M schema version (i.e. vX_Y_Z) and date information (i.e. © 20XX). Based on the targeted version of oneM2M schemas for a given deployment, this placeholder version and date shall be updated to reflect the version of published oneM2M schemas that a schema file is compatible with. The template also contains a placeholder for the XML schema targetNamespace that may be configured with a customized namespace to avoid namespace conflicts if/when needed for a given deployment. "<?xml version="1.0" encoding="UTF-8"?> <!-- Copyright Notification The oneM2M Partners authorize you to copy this document, provided that you retain all copyright and other proprietary notices contained in the original materials on any copies of the materials and that you comply strictly with these terms. This copyright permission does not constitute an endorsement of the products or services, nor does it encompass the granting of any patent rights. The oneM2M Partners assume no responsibility for errors or omissions in this document. © 20XX, oneM2M Partners Type 1 (ARIB, ATIS, CCSA, ETSI, TIA, TSDSI, TTA, TTC). All rights reserved. Notice of Disclaimer & Limitation of Liability The information provided in this document is directed solely to professionals who have the appropriate degree of experience to understand and interpret its contents in accordance with generally accepted engineering or other professional standards and applicable regulations. No recommendation as to products or vendors is made or should be implied. NO REPRESENTATION OR WARRANTY IS MADE THAT THE INFORMATION IS TECHNICALLY ACCURATE OR SUFFICIENT OR CONFORMS TO ANY STATUTE, GOVERNMENTAL RULE OR REGULATION, AND FURTHER, NO REPRESENTATION OR WARRANTY IS MADE OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR AGAINST INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS. NO oneM2M PARTNER TYPE 1 SHALL BE LIABLE, BEYOND THE AMOUNT OF ANY SUM RECEIVED IN PAYMENT BY THAT PARTNER FOR THIS DOCUMENT, WITH RESPECT TO ANY CLAIM, AND IN NO EVENT SHALL oneM2M BE LIABLE FOR LOST PROFITS OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES. oneM2M EXPRESSLY ADVISES ANY AND ALL USE OF OR RELIANCE UPON THIS INFORMATION PROVIDED IN THIS DOCUMENT IS AT THE RISK OF THE USER. --> <xs:schema xmlns="http://www.w3.org/2001/XMLSchema-instance" targetNamespace=" <target_name_space>" xmlns:m2m="http://www.onem2m.org/xml/protocols" elementFormDefault="unqualified" attributeFormDefault="unqualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:include schemaLocation="CDT-commonTypes-vX_Y_Z.xsd" /> <xs:include schemaLocation="CDT-subscription-vX_Y_Z.xsd" /> <xs:element name="<LWM2M_Object_Name>" substitutionGroup="m2m:sg_mgmtResource"> </xs:element> <xs:element name="<LWM2M_Object_Name>Annc" substitutionGroup="m2m:sg_announcedMgmtResource"> </xs:element> </xs:schema>". ETSI ETSI TS 118 105 V4.0.1 (2025-09) 83 oneM2M TS-0005 version 4.0.1 Release 4 Annex C (informative): Example schema file for LwM2M Cellular Connectivity object The following text shows an example schema file for the LwM2M Cellular Connectivity object: "<?xml version="1.0" encoding="UTF-8"?> <!-- Copyright Notification The oneM2M Partners authorize you to copy this document, provided that you retain all copyright and other proprietary notices contained in the original materials on any copies of the materials and that you comply strictly with these terms. This copyright permission does not constitute an endorsement of the products or services, nor does it encompass the granting of any patent rights. The oneM2M Partners assume no responsibility for errors or omissions in this document. © 2017, oneM2M Partners Type 1 (ARIB, ATIS, CCSA, ETSI, TIA, TSDSI, TTA, TTC). All rights reserved. Notice of Disclaimer & Limitation of Liability The information provided in this document is directed solely to professionals who have the appropriate degree of experience to understand and interpret its contents in accordance with generally accepted engineering or other professional standards and applicable regulations. No recommendation as to products or vendors is made or should be implied. NO REPRESENTATION OR WARRANTY IS MADE THAT THE INFORMATION IS TECHNICALLY ACCURATE OR SUFFICIENT OR CONFORMS TO ANY STATUTE, GOVERNMENTAL RULE OR REGULATION, AND FURTHER, NO REPRESENTATION OR WARRANTY IS MADE OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR AGAINST INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS. NO oneM2M PARTNER TYPE 1 SHALL BE LIABLE, BEYOND THE AMOUNT OF ANY SUM RECEIVED IN PAYMENT BY THAT PARTNER FOR THIS DOCUMENT, WITH RESPECT TO ANY CLAIM, AND IN NO EVENT SHALL oneM2M BE LIABLE FOR LOST PROFITS OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES. oneM2M EXPRESSLY ADVISES ANY AND ALL USE OF OR RELIANCE UPON THIS INFORMATION PROVIDED IN THIS DOCUMENT IS AT THE RISK OF THE USER. --> <xs:schema xmlns="http://www.w3.org/2001/XMLSchema-instance" targetNamespace="http://www.onem2m.org/xml/protocols" xmlns:m2m="http://www.onem2m.org/xml/protocols" elementFormDefault="unqualified" attributeFormDefault="unqualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:include schemaLocation="CDT-commonTypes-v2_8_0.xsd" /> <xs:include schemaLocation="CDT-subscription-v2_8_0.xsd" /> <xs:element name="cellularConnectivity" substitutionGroup="m2m:sg_mgmtResource"> <xs:complexType> <xs:complexContent> <!-- Inherit common attributes from mgmtResource --> <xs:extension base="m2m:mgmtResource"> <xs:sequence> <!-- Resource Specific Attributes --> <xs:element name="activatedProfileNames" type="xs:string" minOccurs="1" maxOccurs="unbounded" /> <xs:element name="smscAddress" type="xs:string" minOccurs="0" maxOccurs="1" /> <xs:element name="disableRadioPeriod" type="xs:integer" minOccurs="0" maxOccurs="1" /> <xs:element name="moduleActivationCode" type="xs:string" minOccurs="0" maxOccurs="1" /> <xs:element name="vendorSpecificExtensions" type="xs:string" minOccurs="0" maxOccurs="1" /> <xs:element name="psmTimer" type="xs:integer" minOccurs="0" maxOccurs="1" /> <xs:element name="activeTimer" type="xs:integer" minOccurs="0" maxOccurs="1" /> <xs:element name="servingPLMNRateControl" type="xs:integer" minOccurs="0" maxOccurs="1" /> <xs:element name="eDRXParametersForIuMode" type="xs:base64Binary" minOccurs="0" maxOccurs="1" /> <xs:element name="eDRXParametersForWB-S1Mode" type="xs:base64Binary" minOccurs="0" maxOccurs="1" /> <xs:element name="eDRXParametersForNB-S1Mode" type="xs:base64Binary" minOccurs="0" maxOccurs="1" /> <xs:element name="eDRXParametersForA/GbMode" type="xs:base64Binary" minOccurs="0" maxOccurs="1" /> ETSI ETSI TS 118 105 V4.0.1 (2025-09) 84 oneM2M TS-0005 version 4.0.1 Release 4 <!-- Child Resources --> <xs:choice minOccurs="0" maxOccurs="1"> <xs:element name="childResource" type="m2m:childResourceRef" maxOccurs="unbounded" /> <xs:element ref="m2m:subscription" maxOccurs="unbounded" /> </xs:choice> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> </xs:element> <xs:element name="cellularConnectivityAnnc" substitutionGroup="m2m:sg_announcedMgmtResource"> <xs:complexType> <xs:complexContent> <!-- Inherit common attributes from announcedMgmtResource --> <xs:extension base="m2m:announcedMgmtResource"> <xs:sequence> <!-- Resource Specific Attributes --> <xs:element name="activatedProfileNames" type="xs:string" minOccurs="1" maxOccurs="unbounded" /> <xs:element name="smscAddress" type="xs:string" minOccurs="0" maxOccurs="1" /> <xs:element name="disableRadioPeriod" type="xs:integer" minOccurs="0" maxOccurs="1" /> <xs:element name="moduleActivationCode" type="xs:string" minOccurs="0" maxOccurs="1" /> <xs:element name="vendorSpecificExtensions" type="xs:string" minOccurs="0" maxOccurs="1" /> <xs:element name="psmTimer" type="xs:integer" minOccurs="0" maxOccurs="1" /> <xs:element name="activeTimer" type="xs:integer" minOccurs="0" maxOccurs="1" /> <xs:element name="servingPLMNRateControl" type="xs:integer" minOccurs="0" maxOccurs="1" /> <xs:element name="eDRXParametersForIuMode" type="xs:base64Binary" minOccurs="0" maxOccurs="1" /> <xs:element name="eDRXParametersForWB-S1Mode" type="xs:base64Binary" minOccurs="0" maxOccurs="1" /> <xs:element name="eDRXParametersForNB-S1Mode" type="xs:base64Binary" minOccurs="0" maxOccurs="1" /> <xs:element name="eDRXParametersForA/GbMode" type="xs:base64Binary" minOccurs="0" maxOccurs="1" /> <!-- Child Resources --> <xs:choice minOccurs="0" maxOccurs="1"> <xs:element name="childResource" type="m2m:childResourceRef" maxOccurs="unbounded" /> <xs:element ref="m2m:subscription" maxOccurs="unbounded" /> </xs:choice> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> </xs:element> </xs:schema>". ETSI ETSI TS 118 105 V4.0.1 (2025-09) 85 oneM2M TS-0005 version 4.0.1 Release 4 History Version Date Status V4.0.1 September 2025 Publication
d87eb3f66919df49f65eccf89c57cbd3
118 102
1 Scope
The present document contains an informative functional role model and normative technical requirements for oneM2M.
d87eb3f66919df49f65eccf89c57cbd3
118 102
2 References
d87eb3f66919df49f65eccf89c57cbd3
118 102
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 122 368: "Digital cellular telecommunications system (Phase 2+) (GSM); Universal Mobile Telecommunications System (UMTS); LTE; Service requirements for Machine-Type Communications (MTC); Stage 1 (3GPP TS 22.368)".
d87eb3f66919df49f65eccf89c57cbd3
118 102
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. [i.2] ETSI TS 118 111: "oneM2M; Common Terminology (oneM2M TS-0011)". [i.3] ETSI TR 118 508: "Analysis of Security Solutions for the oneM2M System". [i.4] BBF TR-069: "CPE WAN Management Protocol" Issue: 1 Amendment 5, November 2013.
d87eb3f66919df49f65eccf89c57cbd3
118 102
3 Definition of terms, symbols and abbreviations
d87eb3f66919df49f65eccf89c57cbd3
118 102
3.1 Terms
For the purposes of the present document, the terms given in ETSI TS 118 111 [i.2] apply. ETSI ETSI TS 118 102 V3.1.2 (2021-01) 6 oneM2M TS-0002 version 3.1.2 Release 3
d87eb3f66919df49f65eccf89c57cbd3
118 102
3.2 Symbols
Void.
d87eb3f66919df49f65eccf89c57cbd3
118 102
3.3 Abbreviations
For the purposes of the present document, the following abbreviations apply: AE Application Entity API Application Program Interface BBF BroadBand Forum CHA Continua Health Alliance CMDH Communication Management and Delivery Handling CPU Central Processing Unit CSE Common Services Entity DM Device Management GBA Generic Bootstrapping Architecture GSMA Global System for Mobile Communications Association GW GateWay HGI Home Gateway Initiative HSM Hardware Security Module IP Internet Protocol MTC Machine Type Communications OEM Original Equiment Manufacturer OMA Open Mobile Alliance OSR Overall System Requirements OWL Web Ontology Language QoS Quality of Service RDF Resource Description Framework SIM Subscriber Identity Module SMS Short Message Service TPM Trusted Platform Module UICC Universal Integrated Circuit Card USIM UMTS Subscriber Identity Module USSD Unstructured Supplementary Service Data WAN Wide Area Network WLAN Wireless Local Area Network
d87eb3f66919df49f65eccf89c57cbd3
118 102
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]. ETSI ETSI TS 118 102 V3.1.2 (2021-01) 7 oneM2M TS-0002 version 3.1.2 Release 3
d87eb3f66919df49f65eccf89c57cbd3
118 102
5 Introduction to the M2M ecosystem
d87eb3f66919df49f65eccf89c57cbd3
118 102
5.1 Functional roles description
M2M Application M2M Common Service M2M Appl. M2M CS Underlying Network M2M Service Providers Network Operators operates operates operates an M2M Solution …. … … (end) user Connectivity Services Underlying Network M2M Common Services M2M Applications Application Service Providers Figure 1: Functional Roles in the M2M Ecosystem 1) The User (individual or company - aka: end-user) fulfils all of the following criteria: - Uses an M2M solution. 2) The Application Service Provider fulfils all of the following criteria: - Provides an M2M Application Service. - Operates M2M Applications. 3) The M2M Service Provider fulfils all of the following criteria: - Provides M2M Services to Application Service Providers. - Operates M2M Common Services. 4) The Network Operator fulfils all of the following criteria: - Provides Connectivity and related services for M2M Service Providers. - Operates an Underlying Network. Such an Underlying Network could e.g. be a telecom network. Any of the above functional roles may coincide with any of the other roles. These functional roles do not imply business roles or architectural assumptions. ETSI ETSI TS 118 102 V3.1.2 (2021-01) 8 oneM2M TS-0002 version 3.1.2 Release 3
d87eb3f66919df49f65eccf89c57cbd3
118 102
6 Functional Requirements
d87eb3f66919df49f65eccf89c57cbd3
118 102
6.1 Overall System Requirements
Table 1: Overall System Requirements Requirement ID Description Release OSR-001 The oneM2M System shall allow communication between M2M Applications by using multiple communication means based on IP access. Implemented in Rel-1 OSR-002a The oneM2M System shall support communication means that can accommodate devices with constrained computing (e.g. small CPU, memory, battery) or communication capabilities (e.g. 2G wireless modem, certain WLAN node). Implemented in Rel-1 OSR-002b The oneM2M System shall support communication means that can accommodate devices with rich computing capabilities (e.g. large CPU, memory) or communication (e.g. 3/4G wireless modem, wireline). Implemented in Rel-1 OSR-003 See REQ-2015- 0626R01 The oneM2M System shall support the ability to maintain application-to- application communication in coordination with an application session for those M2M Applications that require it. Not implemented OSR-004 The oneM2M System shall support session-less application communications for those M2M Applications that require it. Implemented in Rel-1 OSR-005 The oneM2M System shall be able to expose the services offered by telecommunications networks to M2M Applications (e.g. SMS, USSD, localization, subscription configuration, authentication (e.g. Generic Bootstrapping Architecture), etc.), subject to restriction based on Network Operator's policy. Partially implemented (see note 9) OSR-006 The oneM2M System shall be able to reuse the services offered by Underlying Networks to M2M Applications and/or M2M Services by means of open access models (e.g. OMA, GSMA OneAPI framework). Examples of available services are: • IP Multimedia communications. • Messaging. • Location. • Charging and billing services. • Device information and profiles. • Configuration and management of devices. • Triggering, monitoring of devices. • Small data transmission. • Group management. (see note 1). Partially implemented (see note 10) OSR-007 The oneM2M System shall provide a mechanism for M2M Applications to interact with the Applications and data/information managed by a different M2M Service Provider, subject to permissions as appropriate. Implemented in Rel-1 OSR-008 The oneM2M System shall provide the capability for M2M Applications to communicate with an M2M Device (i.e. application in the device) without the need for the M2M Applications to be aware of the network technology and the specific communication protocol of the M2M Device. Implemented in Rel-1 (see note 11) OSR-009 The oneM2M System shall support the ability for single or multiple M2M Applications to interact with a single or multiple M2M Devices/Gateways (application in the device/gateway) (see note 2). Implemented in Rel-1 OSR-010 The oneM2M System shall support mechanisms for confirmed delivery of a message to its addressee to those M2M Applications requesting reliable delivery to detect failure of message within a given time interval. Implemented in Rel-1 OSR-011a The oneM2M System shall be able to request different communication paths, from the Underlying Network based on Underlying Network Operator and/or M2M Service Provider policies, routing mechanisms for transmission failures. Implemented in Rel-1 (see note 12) OSR-011b The oneM2M System shall be able to request different communication paths from the Underlying Network based on request from M2M Applications. Not implemented OSR-012 The oneM2M System shall support communications between M2M Applications and M2M Devices supporting M2M Services by means of continuous or non-continuous connectivity. Implemented in Rel-1 OSR-013 The oneM2M System shall be aware of the delay tolerance acceptable by the M2M Application and shall schedule the communication accordingly or request the Underlying Network to do it, based on policies criteria. Implemented in Rel-1 ETSI ETSI TS 118 102 V3.1.2 (2021-01) 9 oneM2M TS-0002 version 3.1.2 Release 3 Requirement ID Description Release OSR-014 The oneM2M System shall be able to communicate with M2M Devices, behind an M2M Gateway that supports heterogeneous M2M Area Networks. Implemented in Rel-1 OSR-015 The oneM2M System shall be able to assist Underlying Networks that support different communication patterns including infrequent communications, small data transfer, transfer of large file and streamed communication. Partially implemented (see note 13) OSR-016 The oneM2M System shall provide the capability to notify M2M Applications of the availability of, and changes to, available M2M Application/management information on the M2M Device/Gateway, including changes to the M2M Area Network. Implemented in Rel-1 OSR-017 The oneM2M System shall be able to offer access to different sets of M2M Services to M2M Application Providers. The minimum set of services are: • Connectivity management. • Device management (service level management). • Application Data management. In order to enable different deployment scenarios, these services shall be made available by the oneM2M System, individually, as a subset or as a complete set of services. Implemented in Rel-1 OSR-018 The oneM2M System shall be able to offer M2M Services to M2M Devices roaming across cellular Underlying Networks, subject to restriction based on Network Operator's policy (see note 3). Implemented with some limitations (see note 14) OSR-019 The oneM2M System shall support the capabilities for data repository (i.e. to collect/store) and for data transfer from one or more M2M Devices or M2M Gateways, for delivery to one or more M2M Gateways, M2M Services Infrastructure, or M2M Application Infrastructure, in ways requested by the M2M Application Infrastructure as listed below: • action initiated either by an M2M Device, M2M Gateway, M2M Services Infrastructure, or M2M Application Infrastructure; • when triggered by schedule or event; • for specified data. Implemented in Rel-1 OSR-020 The oneM2M System shall be able to support policies and their management regarding the aspects of storage and retrieval of data/information. Implemented in Rel-1 OSR-021 The oneM2M System shall be able to provide mechanisms to enable sharing of data among multiple M2M Applications. Implemented in Rel-1 OSR-022 When some of the components of a M2M Solution are not available (e.g. WAN connection lost), the oneM2M System shall be able to support the normal operation of components of the M2M Solution that are available. Implemented in Rel-1 OSR-023 The oneM2M System shall be able to identify the M2M Services to be used by M2M Service Subscriptions (see note 4). Implemented in Rel-1 OSR-024 The oneM2M System shall be able to identify the M2M Devices used by M2M Service Subscriptions. Implemented in Rel-1 OSR-025 The oneM2M System shall be able to identify the M2M Applications used by M2M Service Subscriptions. Implemented in Rel-1 OSR-026 If provided by the Underlying Network, the oneM2M System shall be able to associate the M2M Device used by M2M Service Subscriptions with the device identifiers offered by the Underlying Network and the device. Implemented in Rel-1 OSR-027 The oneM2M System shall provide a generic mechanism to support transparent exchange of information between the M2M Application and the Underlying Network, subject to restriction based on M2M Service Provider's policy and/or Network Operator's policy (see note 5). Not implemented OSR-028 The oneM2M System shall enable an M2M Application to define trigger conditions in the oneM2M System such that the oneM2M System autonomously sends a series of commands to actuators on behalf of the M2M Application when these conditions are met. Not implemented OSR-029 The oneM2M System shall be able to support sending common command(s) to each actuator or sensor via a group. Implemented in Rel-1 OSR-030 The oneM2M System shall be able to support the management (i.e. addition, removal, retrieval and update) of the membership of a group. Implemented in Rel-1 OSR-031 The oneM2M System shall be able to support a group as a member of another group. Implemented in Rel-1 OSR-032 The oneM2M System shall be able to support Event Categories (e.g. normal, urgency) associated with data for M2M Applications when collecting, storing and reporting that data (see note 6). Implemented in Rel-1 ETSI ETSI TS 118 102 V3.1.2 (2021-01) 10 oneM2M TS-0002 version 3.1.2 Release 3 Requirement ID Description Release OSR-033 Based on the Dynamic Device/Gateway Context of the M2M Gateway and/or Device and the defined Event Categories, the oneM2M System shall provide the capability to dynamically adjust the scheduling of reporting and notification of the M2M Device/Gateway (see note 17). Partially implemented (see note 15) OSR-034 The oneM2M System shall support seamless replacement of M2M Devices as well as M2M Gateways (e.g. redirecting traffic, connection, recovery, etc.). Not implemented OSR-035 The oneM2M System shall support the exchange of non-M2M Application related relevant information (e.g. Device/Gateway classes) between M2M Device/Gateway and M2M Service Infrastructure for the purpose of efficient communication facilitation. This includes the capability for an M2M Device to report its device class to M2M Service Infrastructure and for the M2M Service Infrastructure to inform M2M Device of the M2M Service Infrastructure capabilities. Not implemented OSR-036 The oneM2M System should provide mechanisms to accept requests from M2M Application Service Providers for compute/analytics services. Not implemented OSR-037 The oneM2M System shall enable an M2M Application to request to send data, in a manner independent of the Underlying Network, to the M2M Applications of a group of M2M Devices and M2M Gateways in geographic areas that are specified by the M2M Application. Not implemented OSR-038 The oneM2M System shall support the inclusion of M2M Application's QoS preference in service requests to Underlying Networks. Not implemented OSR-039 The oneM2M System shall be able to authorize service requests with QoS preference at service level, but shall pass M2M Application's QoS preference in service requests to Underlying Network for authorization and granting or negotiation of the service QoS requests. Not implemented OSR-040 The oneM2M System shall be able to leverage multiple communication mechanisms (such as USSD or SMS) when available in the Underlying Networks. Not implemented (see note 16) OSR-041 The oneM2M System shall provide a mechanism, which supports the addition of new M2M Services to the oneM2M System as independent portable modules by means of the oneM2M interfaces. Partially implemented (see note 21) OSR-042 The oneM2M System shall be able to support different QoS-levels specifying parameters, such as guaranteed bitrate, delay, delay variation, loss ratio and error rate, etc. Not implemented OSR-043 The oneM2M System shall be able to verify that members of a group support a common set of functions. Implemented in Rel-1 OSR-044 The oneM2M System shall support communication with M2M Devices which are reachable based on defined time schedules (e.g. periodic) as well as M2M Devices which are reachable in an unpredictable and spontaneous manner. Implemented in Rel-1 OSR-045a The oneM2M System shall be able to receive and utilize information provided by the Underlying Network about when an M2M Device can be reached. Not implemented OSR-045b The oneM2M System shall be able to utilize reachability schedules generated by either the M2M Device or the Infrastructure Domain. Partially implemented (see note 18) OSR-046 The oneM2M System shall be able to support a capability for the M2M Application to request/disallow acknowledgement for its communication. Not implemented OSR-047 The oneM2M System shall be able to support mechanism for the M2M Devices and/or Gateways to report their geographical location information to M2M Applications (see note 7). Implemented in Rel-1 OSR-048 The oneM2M System shall provide an M2M Service that allows M2M Devices and/or Gateways to share their own or other M2M Devices' geographical location information (see note 7). Implemented in Rel-1 OSR-049 The oneM2M System shall be able to provide the capability for an M2M Application to selectively share data (e.g. access control) among applications. Implemented in Rel-1 OSR-050 If communication over one communication channel provided by the Underlying Network can only be triggered by one side (Infrastructure Domain or Field Domain), and alternative channel(s) is (are) available in the other direction, the oneM2M System shall be able to use the alternative channel(s) to trigger bidirectional communication on the first channel. Implemented in Rel-1 OSR-051 Depending on availability of suitable interfaces provided by the Underlying Network the oneM2M System shall be able to request the Underlying Network to broadcast/multicast data to a group of M2M Devices in a specified area. Implemented in Rel-1 OSR-052 The oneM2M System shall be able to select an appropriate Underlying Network to broadcast or multicast data depending on the network's broadcast/multicast support and the connectivity supported by the targeted group of M2M Devices/Gateways. Not implemented ETSI ETSI TS 118 102 V3.1.2 (2021-01) 11 oneM2M TS-0002 version 3.1.2 Release 3 Requirement ID Description Release OSR-053 The oneM2M System shall provide a means that enables backward compatibility of interfaces among different releases (see note 8). Not implemented OSR-054 The oneM2M System shall be able to support an M2M Application, M2M Device, or M2M Gateway to obtain access to resources of another M2M Application, M2M Device, or M2M Gateway. Implemented in Rel-1 OSR-055 The oneM2M System shall be able to provide the capability of M2M Applications to exchange data with one or more authorized M2M Applications which are not known in advance. Implemented in Rel-1 (see note 20) OSR-056 The oneM2M System shall enable discovery of usable M2M Applications on an M2M Gateway or at an M2M Device. Implemented in Rel-1 OSR-057 The oneM2M System shall enable discovery of M2M Gateways and M2M Devices available to an M2M Application for data exchange. Implemented in Rel-1 OSR-058 The oneM2M System shall be able to provide time stamps as needed by Common Service Functions. Implemented in Rel-1 OSR-059 The oneM2M System shall be able to support Role-Based Access Control based on M2M Service Subscriptions. Implemented in Rel-1 OSR-060 The oneM2M System should support time synchronization with an external clock source. Not implemented OSR-061 M2M Devices and M2M Gateways may support time synchronization within the oneM2M System. Not implemented OSR-062 The oneM2M System shall enable means of testing the connectivity towards a set of M2M Applications. Not implemented OSR-063 The oneM2M System shall be able to manage the scheduling of M2M Service Layer connectivity and messaging between the Infrastructure Domain and M2M Devices/Gateways. Implemented in Rel-1 OSR-064 The oneM2M System shall be able to aggregate messages depending on message delay tolerance and/or category. Implemented in Rel-1 OSR-065 The oneM2M System shall provide mechanisms that enable a M2M Service Provider to distribute processing functions to his M2M Devices/Gateways in the Field Domain. Not implemented OSR-066 The oneM2M System shall be able to support the placement and operation of M2M Applications in selected M2M Nodes per criteria requested by M2M Application Service Providers, subject to access rights. Implemented in Rel-1 OSR-067 The oneM2M System shall be able to take operational and management action as requested by M2M Applications. Implemented in Rel-1 OSR-068 When available from an Underlying Network, the oneM2M System shall be able to provide the capability to retrieve and report the information regarding whether an M2M Device is authorized to access Underlying Network services. Not implemented OSR-069 When available from the Underlying Network, the oneM2M System shall be able to maintain the M2M Service Operational Status of a M2M Device and update it when the Underlying Network connectivity service status changes. Not implemented OSR-070 The oneM2M System shall be able to provide the capability to notify an authorized M2M Application when the M2M Service Administrative State or M2M Service Operational Status of an M2M Device changes, if that M2M Application has subscribed for such notifications. Partially implemented (see note 19) OSR-071 The oneM2M System shall be able to enable an authorized M2M Application to set the M2M Service Administrative State of a M2M Device. Implemented in Rel-1 OSR-072 The oneM2M System shall be able to initiate a set of actions defined by a M2M Application (e.g. trigger upon a threshold, compare a value) that impacts another Application. Not implemented OSR-073 See REQ-2015- 0529R03 The oneM2M System shall support distributed transactions to multiple devices or applications where the transaction includes the characteristics of atomicity, consistency, isolation and durability. Not implemented OSR-074 See REQ-2015- 0529R03 The oneM2M System shall support the completion of distributed transactions to multiple devices or applications while maintaining the order of the operations and performing the transaction within a given time frame. Not implemented OSR-75 See REQ-2015- 0546R01 The oneM2M System shall be able to collect, store Time Series Data. Implemented in Rel-2 OSR-76 See REQ-2015- 0546R01 The oneM2M System shall be able to detect and report the missing data in time series. Implemented in Rel-2 OSR-077 See REQ-2015- 0558R01 The oneM2M System shall be capable of collecting asynchronous responses pertaining to the broadcasted messages. Not implemented ETSI ETSI TS 118 102 V3.1.2 (2021-01) 12 oneM2M TS-0002 version 3.1.2 Release 3 Requirement ID Description Release OSR-078 See REQ-2015- 573R01 The oneM2M System shall support gateway-based capabilities for Event management, e.g. capability for arbitration of the resulting processing. Not implemented OSR-079 See REQ-2015- 574R01 The oneM2M System shall provide the capability to notify a device hosting a group of applications when alternative registration points for that group of applications are available (e.g. via different underlying networks) based on the service requirements of each of the applications hosted. Not implemented OSR-080 See REQ-2015- 574R01 The oneM2M System shall provide the capability to register applications in group or independently, based on their service requirements. Not implemented OSR-081 See REQ-2015- 0553R02 The oneM2M System shall be able to collect data that is broadcast (e.g. in industrial bus systems) according to data collection policies. Not implemented OSR-082 See REQ-2015- 0553R02 The oneM2M System shall allow the update, modification, or deletion of data collection policies within an M2M Application. Not implemented OSR-083 See REQ-2015- 0593R02 The oneM2M System shall be able to filter information from oneM2M Devices for a given set of parameters. Not implemented OSR-084 See REQ-2015- 0595R04 The oneM2M System shall be able to handle an event notification from an authorized M2M Application which triggers actions to be performed on the M2M Device (example: Turn on or off the monitoring). Not implemented OSR-085 See REQ-2015- 0608 The oneM2M System shall support resource caching of registered M2M Devices. Resource caching is a mechanism through which the oneM2M System retains resources of a registered M2M Device in temporarily inactive state by moving the resources to a temporary storage e.g. cache bin. Not implemented OSR-086 See REQ-2015- 0611R02 The oneM2M System shall enable M2M Gateways to discover M2M Infrastructure Nodes and M2M Devices available for data exchange. Implemented in Rel-1 OSR-087 See REQ-2015- 0611R02 The oneM2M System shall enable M2M Infrastructure Nodes and M2M Device to discover M2M Gateways available for data exchange. Implemented in Rel-1 OSR-088 See REQ-2015- 0611R02 The oneM2M System shall be able to support the capabilities for data repository (i.e. to collect/store) and for data transfer among authorized M2M Devices and M2M Gateways via M2M Area Networks by only involving the field domain. Implemented in Rel-1 OSR-089 See REQ-2015- 0620 The oneM2M System shall enable the cancellation of continuous data collection and/or the deletion of collected data when pre-defined conditions are met. Not implemented OSR-090 See REQ-2015- 0622R02 The oneM2M System shall be able to forward the M2M Application Data to M2M Application without storing the Data. Partially implemented (see note 22) OSR-091 See REQ-2015- 0622R02 The oneM2M System shall be able to notify interested oneM2M entities when it detects forwarded M2M Application Data was not delivered within expected time duration. Not implemented OSR-092 See REQ-2015- 0629 The oneM2M System shall provide the capability for monitoring and describing data streams with associated attributes e.g. data freshness, accuracy, sampling rate, data integrity. Not implemented OSR-093 See REQ-2015- 0630 The oneM2M System shall support transaction management to multiple devices or applications providing policy based mechanism that should be invoked (e.g. keep status, re-schedule, rollback) depending on the outcome of the desired operation. Not implemented OSR-094 See REQ-2015- 0631R02 The oneM2M System shall provide Information Model(s) to support interoperability among different devices/applications. Implemented in Rel-2 OSR-095 See REQ-2015- 0631R02 The oneM2M System should provide mappings between different Information Models from non-oneM2M System(s). Not implemented OSR-096 See REQ-2015- 0631R02 The oneM2M System should be able to interwork with non-oneM2M System(s). Implemented in Rel-2 OSR-097 See REQ-2015- 0583R01 The oneM2M System shall be able to share data collection policies among multiple M2M Devices/Gateways within an M2M Application Service, or among different M2M Application Services. Not implemented ETSI ETSI TS 118 102 V3.1.2 (2021-01) 13 oneM2M TS-0002 version 3.1.2 Release 3 Requirement ID Description Release OSR-098 See REQ-2016- 0055R02 The oneM2M system shall be able to support machine socialization functionalities (such as existence discovery, correlated task discovery, message interface discovery and process optimization for multiple machines with same tasks). Not implemented OSR-099 See REQ-2016- 0066R01 The oneM2M system shall enable continuity of services to M2M devices as they move across various geographic points in the oneM2M System(s). Implemented in Rel-3 OSR-100 See REQ-2017- 0006R02 The oneM2M system shall allow use of multiple communication methods (protocol bindings, serializations, and versions) between M2M Devices/Gateways and M2M application services. OSR-101 See REQ-2017- 0008R02 The oneM2M System shall enable discovery of M2M Application Servers, M2M Management Servers and M2M Devices available to an M2M Gateway for data exchange. OSR -102 See REQ-2017- 0008R02 The oneM2M System shall enable discovery of M2M Gateways available to a M2M Management Server and an M2M Device for data exchange. OSR-103 See REQ-2017- 0008R02 The oneM2M System shall be able to support the capabilities for data repository (i.e. to collect/store) and for data transfer from one or more M2M Devices or M2M Gateways, for delivery to one or more M2M Gateways via M2M Area Network without any assistance or instruction of M2M Management Servers and M2M Application Serve. OSR-104 See REQ-2017- 0008R02 Upon request from M2M Application Server, an M2M Gateway shall enable functions that pre-process (e.g. average) M2M data before providing them to the recipient. Not implemented OSR –105 See REQ-2017- 0008R02 Upon request, an M2M Gateway shall enable functions that erase M2M data (e.g. that have been sent or could not be sent to the recipient within a certain time) based on criteria from an M2M Application Server. Not implemented OSR-106 See REQ-2017- 0008R02 An M2M Gateway and/or an M2M Device shall be able to broadcast the need to receive/deliver specific data.to otherM2M Devices and/or M2M Gateways. Not implemented OSR –107 See REQ-2017- 0008R02 The oneM2M system shall enable M2M Gateways and/or M2M Devices to establish a connection to each other if able to receive/deliver the specific data. Not implemented OSR-108 See REQ-2017- 0008R02 The oneM2M System shall enable M2M Gateways to set conditions used for processing jointly group/aggregate data subscriptions to reduce the number of messages to M2M Devices and distribute the resulting notifications according to the set conditions. Implemented in Rel-3 OSR -109 See REQ-2017- 0008R02 The oneM2M System shall enable M2M Gateways to distribute notifications according to how data subscriptions have been grouped/aggregated. Implemented in Rel-3 OSR-110 See REQ-2017- 0008R02 The oneM2M System shall enable subscriptions to changes to multiple data sources (e.g. oneM2M resources) which aim to generate data publication (i.e. automatic notifications) if and only if the expected changes to each of those multiple resources occur concurrently. Implemented in Rel-3 OSR-111 See REQ-2017- 0018R01 The oneM2M system shall be able to support heterogeneous identification services, the recognition of external identification systems and converting an object identifier to a compatible identifier recognized by the oneM2M system. OSR-112 See REQ-2017- 0030R05 The oneM2M System shall enable the M2M Application to configure the notification interval in the M2M Devices. Implemented in Rel-1 OSR-113 See REQ-2017- 0030R05 The oneM2M System shall support communication between the Infrastructure Domain and M2M devices either directly or via a gateway. Implemented in Rel-1 OSR-114 See REQ-2017- 0030R05 The oneM2M System shall enable exchange of information between M2M applications via the Infrastructure Domain. Implemented in Rel-1 OSR-115 See REQ-2017- 0030R05 The oneM2M system shall be able to support service requests from M2M applications for communication with QoS requirement e.g. higher delivery priority, reliable delivery. Partially implemented OSR-116 See REQ-2017- 0030R05 The oneM2M system shall be able to support requests with time expiration or geography restriction. Implemented in Rel-2 OSR-117 See REQ-2017- 0030R05 The oneM2M System shall support setting the configuration for Geo-Fence based location services by a M2M Application. Implemented in Rel-2 ETSI ETSI TS 118 102 V3.1.2 (2021-01) 14 oneM2M TS-0002 version 3.1.2 Release 3 Requirement ID Description Release OSR-118 See REQ-2017- 0031R05 The oneM2M System shall enable exchanges of diagnostic data periodically between M2M Devices and the Infrastructure Domain. Rel-3/future releases OSR-119 See REQ-2017- 0031R05 The oneM2M system shall support a mechanism to describe the syntax and semantics format of the diagnostics data exchanged between the M2M Devices and the InfrastructureDomain. Rel-3/future releases? OSR-120 See REQ-2017- 0031R05 The oneM2M System shall be able to provide the service capability for location based services. Implemented OSR-121 See REQ-2017- 0031R05 The oneM2M System shall be able to provide the service capability supporting Over The Air management. Implemented OSR-122 See REQ-2017- 0031R05 The oneM2M system shall provide the capability for an M2M Device to maintain registration with multiple entities simultaneously. Rel-3/future releases? OSR-123 See REQ-2017- 0031R05 The oneM2M System shall enable exchange of information with the intended vehicles by unicast, multicast and/or broadcast. Partially implemented (note 23) OSR-124 See REQ-2017- 0031R05 The oneM2M System shall be able to transfer time critical information. For example for feeding back current road states to automatic driving control, the feedback time should be less than a few seconds (the distance between vehicles normally corresponds to a few seconds) to avoid unnecessary speed down/stop of following vehicles (see note 24). Rel-3/future releases? OSR-125 See REQ-2017- 0031R05 The oneM2M System shall be able to guarantee its reliability in order to receive/feedback messages from/to related M2M Devices (e.g. for Vehicular Domain) (see note 24) Rel-3/future releases? OSR-126 See REQ-2017- 0031R05 The oneM2M System shall enable sharing of service information between devices/GWs based on proximity (see note 24). Rel-3/future releases? OSR-127 See REQ-2017- 0031R05 The oneM2M System shall enable sending and receiving of service information between devices/GWs with minimized interruption (see note 24). Rel-3/future releases? OSR-128 See REQ-2017- 0031R05 The oneM2M System shall support mobile/portable M2M Gateway and/or Device. Rel-3/future releases? OSR-129 See REQ-2017- 0031R05 The oneM2M System shall support triggering M2M Devices for on-demand reporting regarding collected data. Rel-3/future releases? OSR-130 See REQ-2017- 0031R05 The oneM2M System shall enable the M2M Infrastructure to facilitate direct communication between two or more different M2M devices without having registered with one another. Rel-3/future releases? OSR-131 See REQ-2017- 0031R05 The oneM2M System shall be able to verify geographical location information from moving objects regardless of information accuracy. Rel-3/future releases? OSR-132 See REQ-2017- 0031R05 The oneM2M System shall be able to verify time synchronization. Rel-3/future releases? OSR-133 See REQ-2017- 0031R05 The oneM2M System shall be able to coordinate end-to-end reliable communications for applications that can have safety impacts. Rel-3/future releases? OSR-134 See REQ-2017- 0048R02 The oneM2M System shall enable provisioning, installation, configuration and registration methods of field devices for different management systems (e.g. allowing different entities to own and manage the device) or application systems (e.g. allowing different entities to utilize the device data). Future releases? OSR-135 See REQ-2017- 0048R02 The oneM2M System shall enable registrations to include information identifying the peer entities, and related information (e.g. management privilege, subscription, etc.), necessary for establishment of the respective peer relationships. Future releases? OSR-136 See REQ-2017- 0048R02 The oneM2M System shall enable registrations using a complete set of information context for the peer entities (termed "full registrations"). Future releases? OSR-137 See REQ-2017- 0048R02 The oneM2M System shall enable registrations using only a subset of information context for the peer entities (termed "lightweight registration"). Future releases? ETSI ETSI TS 118 102 V3.1.2 (2021-01) 15 oneM2M TS-0002 version 3.1.2 Release 3 Requirement ID Description Release OSR-138 See REQ-2017- 0048R02 The oneM2M System shall enable "lightweight registrations" instances with different entities, which pertain to a common peer entity, to use different sets of information about the common peer entity as needed. Future releases? OSR-139 See REQ-2017- 0048R02 The oneM2M System shall enable correlation of the "full registration" and the "lightweight registration" instances pertaining to a common peer entity. Future releases? OSR-140 See REQ-2017- 0048R02 The oneM2M System shall enable differentiation of the "full registrations" and the "lightweight registrations" instances pertaining to a common peer entity. Future releases? NOTE 1: The set of features or APIs to be supported depends on the M2M Common Services and access to available APIs. NOTE 2: The relation M2M Network Application to M2M Device/Gateway may be 1:1, 1:n, n:1 and/or n:m. NOTE 3: No roaming on M2M Service level is assumed by this requirement. NOTE 4: M2M Service Subscriptions are not Application subscriptions (e.g. Home Energy Management). NOTE 5: Transparent exchange of information implies information that is mainly interpreted by the M2M Application and the Underlying Network Provider. NOTE 6: Based on the Event Categories and via interworking with Underlying Networks, the oneM2M System can support differentiated services (by providing Quality-of-Service) requested by M2M Applications. NOTE 7: Geographical location information can be more than simply longitude, latitude and Geo-fence event. NOTE 8: "means" above does not imply only technical mechanisms, e.g. there is no protocol version negotiation. NOTE 9: In Rel-1 only GBA and localization are available. NOTE 10: Rel-1 covers: Location, Charging and billing services, Configuration and management of devices, Device information and profiles, Triggering. NOTE 11: This requirement applies to M2M Devices but not to devices interworked via M2M Area Networks. NOTE 12: Based on device triggering. NOTE 13: No Support for streamed communication. NOTE 14: Limitations to trigger (via Tsp interface) devices in a roamed-to network. NOTE 15: Detail syntax to describe Dynamic Context is not specified. NOTE 16: It is possible to deliver CoAP over SMS, but currently SMS message delivery interfaces are not explicitly defined. NOTE 17: For example, if the battery of Gateway is remained only 10% or below, the Gateway notifies the M2M service platform of the status. The M2M Application in the Infrastructure node will adjust the scheduling of reporting and notification based on the Event Categories associated with each message. Consequently, the M2M Gateway operates longer. NOTE 18: Void. NOTE 19: Only the M2M Service Administrative State can be notified. M2M Service Operational Status is not implemented. NOTE 20: This can be implemented based on preconfigured access rights. NOTE 21: In Rel-1 this is supported by means of the Mca interfaces, mapping the new service module to an AE. NOTE 22: In Rel-2 data are stored in the CSE but never get retrieved by other entities except by subscribe/notify mechanism. NOTE 23: Unicast communications have been implemented in Release 1. NOTE 24: Definition of "real time" and how to specify timing and reliability requirements is TBD. ETSI ETSI TS 118 102 V3.1.2 (2021-01) 16 oneM2M TS-0002 version 3.1.2 Release 3
d87eb3f66919df49f65eccf89c57cbd3
118 102
6.2 Management Requirements
Table 2: Management Requirements Requirement ID Description Release MGR-001 The oneM2M System shall be able to support management and configuration of M2M Gateways/ Devices including resource constrained M2M Devices. Implemented in Rel-1 MGR-002 The oneM2M System shall provide the capability to discover the M2M Area Networks including information about devices on those networks and the parameters (e.g. topology, protocol) of those networks. Implemented in Rel-1 MGR-003 The oneM2M System shall be able to provide the capability to maintain and describe the management Information Model of devices and parameters (e.g. topology, protocol) of M2M Area Networks. Implemented in Rel-1 MGR-004 The oneM2M System shall support common means to manage devices enabled by different management technologies (e.g. OMA DM, BBF TR-069 [i.4]). Implemented in Rel-1 MGR-005 The oneM2M System shall provide the capability to manage multiple devices in a grouped manner. Implemented in Rel-1 MGR-006 The oneM2M System shall provide the capability for provisioning and configuration of devices in M2M Area Networks. Implemented in Rel-1 MGR-007 The oneM2M System shall provide the capability for monitoring and diagnostics of M2M Gateways/Devices in M2M Area Networks. Implemented in Rel-1 MGR-008 The oneM2M System shall provide the capability for software management of devices in M2M Area Networks. Implemented in Rel-1 MGR-009 The oneM2M System shall provide the capability for rebooting and/or resetting of M2M Gateways/Devices and other devices in M2M Area Networks. Implemented in Rel-1 MGR-010 The oneM2M System shall provide the capability for authorizing devices to access M2M Area Networks. Implemented in Rel-1 MGR-011 The oneM2M System shall provide the capability for modifying the topology of devices in M2M Area Networks, subject to restriction based on M2M Area Network policies. Implemented in Rel-1 MGR-012 Upon detection of a new device the M2M Gateway shall be able to be provisioned by the M2M Service Infrastructure with an appropriate configuration which is required to handle the detected device. Partially implemented (see note) MGR-013 Void. MGR-014 The oneM2M System shall be able to retrieve events and information logged by M2M Gateways/ Devices and other devices in M2M Area Networks. Implemented in Rel-1 MGR-015 The oneM2M System shall be able to support firmware management (e.g. update) of M2M Gateways/ Devices and other devices in M2M Area Networks. Implemented in Rel-1 MGR-016 The oneM2M System shall be able to retrieve information related to the Static and Dynamic Device/Gateway Context for M2M Gateways/Devices as well as Device Context for other devices in M2M Area Networks. Implemented in Rel-1 MGR-017 The oneM2M System shall be capable of correlating Access Management elements provided by the technology specific Device Management Protocols to Access Management elements used by the oneM2M System. Implemented in Rel-1 MGR-018 See REQ-2015- 0555R02 The M2M Service Infrastructure shall be able to accept standardized configuration settings from an external configuration server to allow the M2M Devices to register. Not implemented MGR-019 See REQ-2015- 0555R02 The M2M Device shall be able to accept standardized configuration settings from an external configuration server in order to register to the oneM2M System. Not implemented NOTE: In Rel-1 no detection mechanism exists, but once an M2M Device is known at the Gateway it can be configured via the GW through DM. ETSI ETSI TS 118 102 V3.1.2 (2021-01) 17 oneM2M TS-0002 version 3.1.2 Release 3
d87eb3f66919df49f65eccf89c57cbd3
118 102
6.3 Semantics Requirements
d87eb3f66919df49f65eccf89c57cbd3
118 102
6.3.1 Ontology Related Requirements
Table 3: Ontology Requirements Requirement ID Description Release ONT-001 See REQ-2015- 0521R01 The M2M System shall support a standardized format for the rules/policies used to define service logic. Not implemented ONT-002 See REQ-2015- 0521R01 The M2M System shall support modelling semantic descriptions of Things (including relationships among them) by using ontologies. Implemented in Rel-2 ONT-003 See REQ-2015- 0521R01 The M2M System shall support a common modelling language for ontologies (e.g. OWL). Implemented in Rel-2 ONT-004 See REQ-2015- 0521R01 The M2M System should be able to provide translation capabilities from different modelling languages for ontologies to the language adopted by oneM2M if the expressiveness of the imported ontology allows. Not implemented ONT-005 See REQ-2015- 0521R01 The M2M System shall provide the capability to retrieve semantic descriptions and ontologies stored outside of the M2M System. Not implemented ONT-006 See REQ-2015- 0521R01 The M2M System shall provide support for linking ontologies defined in the context of the M2M System with ontologies defined outside this context. Not implemented ONT-007 See REQ-2015- 0521R01 The M2M System shall be able to support extending ontologies in the M2M System. Not implemented ONT-008 See REQ-2015- 0521R01 The M2M System shall be able to use ontologies that contain concepts representing aspects (e.g. a room) that are not represented by resources of the M2M System. Implemented in Rel-2 ONT-009 See REQ-2015- 0521R01 The M2M System shall be able to re-use common ontologies (e.g. location, time ontologies, etc.) which are commonly used in M2M Applications. Not implemented ONT-010 See REQ-2015- 0521R01 The M2M System shall be able to support simultaneous usage of multiple ontologies for the same M2M resource. Implemented in Rel-2 ONT-011 See REQ-2015- 0521R01 The M2M System shall provide the capability for making ontology available in the M2M System, e.g. through announcement. Not implemented ONT-012 See REQ-2015- 0521R01 The M2M System shall be able to support mechanisms to import external ontologies into the M2M System. Not implemented ONT-013 See REQ-2015- 0521R01 The M2M System shall be able to support update of ontologies. Not implemented ONT-014 See REQ-2015- 0521R01 The M2M System shall enable functions for data conversion based on ontologies. Not implemented ONT-015 See REQ-2015- 0521R01 The M2M System shall be able to model devices based on ontologies which may be available outside the M2M System (e.g. HGI device template). Implemented in Rel-2 ONT-016 See REQ-2015- 0521R01 The M2M System shall support storage, management and discovery of ontologies. Not implemented ONT-017 See REQ-2015- 0609 The oneM2M System shall support a semantic relation ("Is Paired To") between two M2M Devices. Not implemented ETSI ETSI TS 118 102 V3.1.2 (2021-01) 18 oneM2M TS-0002 version 3.1.2 Release 3
d87eb3f66919df49f65eccf89c57cbd3
118 102
6.3.2 Semantics Annotation Requirements
Table 4: Semantics Annotation Requirements Requirement ID Description Release ANN-001 See REQ-2015- 0521R01 The oneM2M System shall provide capabilities to manage semantic information about the oneM2M resources, e.g. create, retrieve, update, delete, associate/link. Implemented in Rel-2 ANN-002 See REQ-2015- 0521R01 The oneM2M System shall support a common language for semantic description, e.g. RDF. Implemented in Rel-2 ANN-003 See REQ-2015- 0521R01 The oneM2M System shall support semantic annotation of oneM2M resources for example application related data contained in containers. Implemented in Rel-2 ANN-004 See REQ-2015- 0521R01 The oneM2M System shall support semantic annotation based on related ontologies. Implemented in Rel-2 ANN-005 See REQ-2015- 0521R01 The oneM2M System shall provide the capability for making semantic descriptions available in the M2M System, e.g. announcement. Implemented in Rel-2 ANN-006 See REQ-2015- 0521R01 The oneM2M System shall enable applications to retrieve an ontology representation related to semantic information used in the M2M System. Not implemented ANN-007 See REQ-2015- 0521R01 The oneM2M system shall provide capabilities to manage data quality descriptions of resource. Not implemented
d87eb3f66919df49f65eccf89c57cbd3
118 102
6.3.3 Semantics Query Requirements
Table 5: Semantics Query Requirements Requirement ID Description Release QRY-001 See REQ-2015- 0521R01 The oneM2M System shall provide capabilities to discover M2M Resources based on semantic descriptions. Implemented in Rel-2
d87eb3f66919df49f65eccf89c57cbd3
118 102
6.3.4 Semantics Mashup Requirements
Table 6: Semantics Mashup Requirements Requirement ID Description Release MSH-001 See REQ-2015- 0521R01 The oneM2M System shall provide the capability to host processing functions for mash-up. Not implemented MSH-002 See REQ-2015- 0521R01 The oneM2M System shall enable M2M Applications to provide processing functions for mash-up. Not implemented MSH-003 See REQ-2015- 0521R01 The oneM2M System itself may provide pre-provisioned or dynamically created processing functions for mash-up. Not implemented MSH-004 See REQ-2015- 0521R01 The oneM2M System shall be able to create and execute mash-ups based on processing functions. Not implemented MSH-005 See REQ-2015- 0521R01 The oneM2M System shall be able to expose mash-ups as resources e.g. virtual devices. Not implemented ETSI ETSI TS 118 102 V3.1.2 (2021-01) 19 oneM2M TS-0002 version 3.1.2 Release 3
d87eb3f66919df49f65eccf89c57cbd3
118 102
6.3.5 Semantics Reasoning Requirements
Table 7: Semantics Reasoning Requirements Requirement ID Description Release RES-001 See REQ-2015- 0521R01 The oneM2M System shall be able to update ontologies as a result of the ontology reasoning. Not implemented RES-002 See REQ-2015- 0521R01 The oneM2M System shall be able to support semantic reasoning e.g. ontology reasoning or semantic rule-based reasoning. Not implemented RES-003 See REQ-2015- 0521R01 The oneM2M System shall be able to support adding and updating semantic information based on semantic reasoning. Not implemented
d87eb3f66919df49f65eccf89c57cbd3
118 102
6.3.6 Data Analytics Requirements
Table 8: Data Analytics Requirements Requirement ID Description Release ANA-001 See REQ-2015- 0521R01 The oneM2M System shall be able to support capabilities (e.g. processing function) for performing M2M data analytics based on semantic descriptions from M2M Applications and /or from the M2M System. Not implemented ANA-002 See REQ-2015- 0521R01 The oneM2M System shall provide the capability of interpreting and applying service logic (e.g. rules/policies of triggering operations upon other resources or attributes according to the change of the monitored resource) described with semantic annotation and ontology. Not implemented ANA-003 See REQ-2015- 0521R01 The oneM2M System shall support a standardized format for the rules/policies used to define service logic. Not implemented
d87eb3f66919df49f65eccf89c57cbd3
118 102
6.4 Security Requirements
Table 9: Security Requirements Requirement ID Description Release SER-001 The oneM2M System shall incorporate protection against threats to its availability such as Denial of Service attacks. Partially implemented in Rel-1 SER-002 The oneM2M System shall be able to ensure the Confidentiality of data. Implemented in Rel-1 SER-003 The oneM2M System shall be able to ensure the Integrity of data. Implemented in Rel-1 SER-004 In case where the M2M Devices support USIM/UICC and the Underlying Networks support network layer security, the oneM2M System shall be able to leverage device's USIM/UICC credentials and network's security capability e.g. 3GPP GBA for establishing the M2M Services and M2M Applications level security through interfaces to Underlying Network. Implemented in Rel-1 SER-005 In case where the M2M Devices support USIM/UICC and the Underlying Networks support network layer security, and when the oneM2M System is aware of Underlying Network's bootstrapping capability e.g. 3GPP GBA, the oneM2M System shall be able to expose this capability to M2M Services and M2M Applications through API. Implemented in Rel-1 SER-006 In case where the M2M Devices support USIM/UICC and the Underlying Networks support network layer security, the oneM2M System shall be able to leverage device's USIM/UICC Credentials when available to bootstrap M2M Security Association. Implemented in Rel-1 SER-007 When some of the components of an M2M Solution are not available (e.g. WAN connection lost), the oneM2M System shall be able to support the Confidentiality and the Integrity of data between authorized components of the M2M Solution that are available. Implemented in Rel-1 ETSI ETSI TS 118 102 V3.1.2 (2021-01) 20 oneM2M TS-0002 version 3.1.2 Release 3 Requirement ID Description Release SER-008 The oneM2M System shall support countermeasures against unauthorized access to M2M Services and M2M Application Services. Implemented in Rel-1 SER-009 The oneM2M System shall be able to support Mutual Authentication for interaction with Underlying Networks, M2M Services and M2M Application Services. Implemented in Rel-1 SER-010 The oneM2M System shall be able to support mechanisms for protection against misuse, cloning, substitution or theft of security credentials. Implemented in Rel-1 SER-011 The oneM2M System shall protect the use of the identity of an M2M Stakeholder within the oneM2M System against discovery and misuse by other stakeholders. Implemented in Rel-1 SER-012 The oneM2M System shall be able to support countermeasures against Impersonation attacks and replay attacks. Partially implemented in Rel-1 (see note 3) SER-013 The oneM2M System shall be able to provide the mechanism for integrity- checking on boot, periodically on run-time, and on software upgrades for software/hardware/firmware component(s) on M2M Device(s). Not implemented SER-014 The oneM2M System shall be able to provide configuration data to an authenticated and authorized M2M Application in the M2M Gateway/Device. Implemented in Rel-1 SER-015 The oneM2M System shall be able to support mechanisms to provide M2M Service Subscriber identity to authorized and authenticated M2M Applications when the oneM2M System has the M2M Service Subscriber's consent. Partially implemented (see note 4) SER-016 The oneM2M System shall be able to support non repudiation within the M2M service layer and in its authorized interactions with the network and application layers. Implemented in Rel-1 SER-017 The oneM2M System shall be able to mitigate threats identified in ETSI TR 118 508 [i.3]. Implemented in Rel-1 SER-018 The oneM2M System shall enable an M2M Stakeholder to use a resource or service and be accountable for that use without exposing its identity to other stakeholders. Partially implemented SER-019 The oneM2M System shall be able to use service-level Credentials present inside the M2M Device for establishing the M2M Services and M2M Applications level security. Implemented in Rel-1 SER-020 The oneM2M System shall enable legitimate M2M Service Providers to provision their own Credentials into the M2M Devices/Gateways. Implemented in Rel-1 (see note 5) SER-021 The oneM2M System shall be able to remotely and securely provision M2M security Credentials in M2M Devices and/or M2M Gateways. Implemented in Rel-1 (see note 5) SER-022 The oneM2M System shall enable M2M Application Service Providers to authorize interactions involving their M2M Applications on supporting entities (e.g. Devices/ Gateways/ Service infrastructure). Implemented in Rel-1 SER-023 Where a Hardware Security Module (HSM) is supported, the oneM2M System shall be able to rely on the HSM to provide local security. Partially implemented SER-024 The oneM2M System shall enable M2M Applications to use different and segregated security environments. Partially implemented SER-025 The oneM2M System shall be able to prevent unauthorized M2M Stakeholders from identifying and/or observing the actions of other M2M Stakeholders in the oneM2M System, e.g. access to resources and services (see note 1). Implemented in Rel-1 SER-026 The oneM2M System shall be able to provide mechanism for the protection of Confidentiality of the geographical location information (see note 2). Implemented in Rel-1 SER-027 See REQ-2015- 0558R01 The M2M System shall support grouping of M2M Applications that have the same access control rights towards one specific resources, together so that access control validation can be performed by validating if the M2M Application is a member of certain group. Implemented in Rel-2 SER-028 See REQ-2015- 0568R04 The oneM2M System shall enable security protocol end-points to protect portions of individual application-generated data so that intermediate entities (whether trusted or untrusted) forwarding the data are unable to access the protected portions of the data in clear text. Implemented in Rel-2 SER-029 See REQ-2015- 0568R04 The oneM2M System shall enable security protocol end-points to protect portions of individual application-generated data so that security protocol end-points can detect modification, including modification by intermediate service layer entities (whether trusted or untrusted) forwarding the data. Implemented in Rel-2 ETSI ETSI TS 118 102 V3.1.2 (2021-01) 21 oneM2M TS-0002 version 3.1.2 Release 3 Requirement ID Description Release SER-030 The oneM2M System shall enable security protocol end-points to protect portions of individual oneM2M messages so that intermediate entities (whether trusted or untrusted) forwarding the messages are unable to access the protected portions of the messages in clear text. Implemented in Rel-2 SER-031 See REQ-2015- 0569R03 The oneM2M System shall enable security protocol end-points to protect portions of individual oneM2M messages so that security protocol end-points can detect modification, including modification by intermediate service layer entities (whether trusted or untrusted) forwarding the messages. Implemented in Rel-2 SER-032 See REQ-2015- 0569R03 The oneM2M System shall enable security protocol end-points to establish security sessions which are used for protecting portions of one or more oneM2M messages so that intermediate entities (whether trusted or untrusted) forwarding the messages are unable to access the protected portions of the messages in clear text. Implemented in Rel-2 SER-033 See REQ-2015- 0569R03 The oneM2M System shall enable security protocol end-points to establish security sessions which are used for protecting portions of one or more oneM2M messages so that security protocol end-points can detect modification, including modification by intermediate service layer entities (whether trusted or untrusted) forwarding the messages. Implemented in Rel-2 SER-034 See REQ-2015- 0575R01 The oneM2M System shall enable security protocol end-points to protect portions of messages or data so that intermediate entities (whether trusted or untrusted) forwarding the messages or data are unable to access the protected portions of messages or data in clear text. Partially Implemented SER-035 See REQ-2015- 0575R01 The oneM2M System shall enable security protocol end-points to protect portions of messages or data so that security protocol end-points can detect modification, including modification by intermediate service layer entities (whether trusted or untrusted) forwarding the messages or data. Partially Implemented SER-036 See REQ-2015- 0575R01 The oneM2M System shall enable security protocol end-points to authenticate each other without relying on intermediate service layer entities (whether trusted or untrusted). Implemented in Rel-2 SER-037 See SEC-2015- 0515R02 The oneM2M System shall be able to support distributed authorization functions for making access control decisions, providing Access Control Policies and providing authorization attributes (e.g. roles). Partially implemented SER-038 See SEC-2015- 0515R02 The oneM2M System shall be able to expose an interoperable interface to provide Access Control Policies by means of specified access control policy language. Not implemented SER-039 See SEC-2015- 0515R02 The oneM2M System shall enable individuals to establish policies for controlling access to their personal identifiable information even when it may have been collected without their knowledge. Implemented in Rel-2 SER-040 See SEC-2015- 0517R05 When the M2M Devices are grouped and the M2M Gateway is authorized as the delegate of the group to access the M2M Server, the M2M Gateway shall be able to, perform Mutual Authentication with the M2M Server, on behalf of the M2M Devices in the group. Not implemented SER-041 See SEC-2015- 0517R05 When the M2M Devices are grouped and the M2M Gateway belongs to a third party, oneM2M System shall be able to protect Security and Privacy of communication between individual M2M Device and M2M Server from other M2M devices and the third party M2M Gateway. Implemented in Rel-2 SER-042 See SEC-2015- 0522R02 A secured API shall enable application and service layer entities to make use of sensitive functions and data residing within the Secure Environment, independently of the technical implementation of the Secure Environment. Not implemented SER-043 See REQ-2015- 0590R01 The oneM2M System shall enable authorizing a oneM2M entity to temporarily delegate its access rights (or a subset thereof) to another authorized oneM2M entity, wherein the dynamically delegated access rights shall not enable the "delegated-to" oneM2M entity to delegate the same rights in turn to a third oneM2M entity. Not implemented SER-044 See REQ-2015- 0591R04 For M2M Application Service data, that are processed by an M2M Application B in a M2M entity (e.g. M2M Gateway) on its path from an originator A to the recipient M2M Application C, the oneM2M System shall provide means that enable the recipient to verify both: • integrity of the data received by the M2M Application B from the originator A; and, at the same time: • that the M2M Application B that has processed the data has not been compromised. Not implemented ETSI ETSI TS 118 102 V3.1.2 (2021-01) 22 oneM2M TS-0002 version 3.1.2 Release 3 Requirement ID Description Release SER-045 See REQ-2015- 0604R02 The oneM2M System shall support classification of application data by M2M Applications into various security levels that are specified by oneM2M and support the mapping of these levels to applicable security capabilities. Not implemented SER-046 See REQ-2015- 0605R04 The oneM2M System shall enable to protect portions of individual application generated data that is at-rest (e.g. hosted data) for integrity protection and data creator Authentication. Implemented in Rel-2 SER-047 See REQ-2015- 0605R04 The oneM2M System shall enable to protect portions of individual application data at-rest (e.g. hosted data) for confidentiality protection. Implemented in Rel-2 SER-048 See REQ-2015- 0605R04 The oneM2M System shall ensure that the end-to-end data Credentials are protected for Confidentiality, integrity and against tampering. Implemented in Rel-2 SER-049 See REQ-2015- 0605R04 The oneM2M System shall ensure that the end-to-end data Credentials are protected from exposure to intermediate entities. Implemented in Rel-2 SER-050 See REQ-2015- 0620 The oneM2M System shall enable pre-defined conditions to be protected from unauthorized modification. Implemented in Rel-2 SER-051 See REQ-2015- 0620 The oneM2M System shall enable the deletion of M2M data produced/stored by the M2M Devices/Gateways based on request from an authorized entity. Implemented in Rel-2 SER-052 See REQ-2015- 0621R01 The oneM2M System shall store and process privacy preferences in an interoperable manner. Implemented in Rel-2 SER-053 See REQ-2015- 0621R01 The oneM2M System shall support privacy profiles at various levels to care for conditions of legal requirements, manufacturers, and data subjects. Implemented in Rel-2 SER-054 See REQ-2015- 0621R01 The oneM2M System shall be able to prioritize privacy profiles where there is a conflict between profiles (legal profile takes priority over data subject profile, for example). Implemented in Rel-2 SER-055 See REQ-2015- 0623R01 The oneM2M System shall be able to support configuration of security related settings of its infrastructure side components by a privileged user through standardized API. Not implemented SER-056 See REQ-2015- 0623R01 The oneM2M System shall allow overriding of security settings by a privileged User through standardized API. Not implemented SER-057 See REQ-2015- 0623R01 The oneM2M System shall support a mechanism enabling addition/deletion of information enabling authentication of oneM2M entities through standardized API. Not implemented SER-058 See REQ-2015- 0627R02 The oneM2M System shall enable delegation of security functions (e.g. message authentication/integrity protection) of an entity to a trust-worthy entity. Implemented in Rel-2 SER-059 See REQ-2015- 0628R01 The oneM2M System shall protect the authenticity, Integrity, and Confidentiality of the representation of the delegated access rights. Implemented in Rel-2 SER-060 See REQ-2015- 0628R01 The oneM2M System shall be able to revoke the representation of the delegated access rights. Implemented in Rel-2 SER-061 See 0585R01- App-ID Requirements The oneM2M System shall be able to verify the App-ID to support the detection of impersonation or to support revocation. Not implemented SER-062 See REQ-2016- 0056R01 The oneM2M System shall be able to reuse the privacy policy of the Underlying Network. Not implemented SER-063 See REQ-2016- 0056R01 The oneM2M System shall be able to share its privacy policy with the Underlying Network. Not implemented SER-064 See REQ-2017- 0005R03 The M2M Devices shall provide a mechanism to prevent installation or modification of the software/middleware/firmware which run on the M2M Devices, unless it is authorized by an allowed stakeholder. Implemented in Release 3? SER-065 See REQ-2017- 0005R03 The oneM2M System shall be able to detect installation or modification of the software/middleware/firmware of M2M Devices that has not been authorized by an allowed stakeholder. Implemented in Release 3? ETSI ETSI TS 118 102 V3.1.2 (2021-01) 23 oneM2M TS-0002 version 3.1.2 Release 3 Requirement ID Description Release SER-066 See REQ-2017- 0005R03 The oneM2M system shall enable allowed stakeholders to restrict or prevent operation of M2M devices using software/middleware/firmware that the stakeholders did not authorize. Implemented in Release 3? SER-067 See REQ-2017- 0005R03 The oneM2M system shall be able to prevent malfunction of M2M devices caused by receiving unsolicited messages or information. Implemented in Release 3? SER-068 See REQ-2017- 0030R05 The information exchanged within the oneM2M system shall use cryptographic technology to ensure information authentication and information integrity. Implemented in Rel-2 SER-069 See REQ-2017- 0030R05 The oneM2M system shall be able to securely transfer information by using an appropriate method such as digital signature. Implemented in Rel-2 SER-070 See REQ-2017- 0030R05 The oneM2M system shall be able to support security mechanisms to protect cryptographic keys and cryptographic operations by using tamper resistant elements such as TPM (Trusted Platform Module), HSM (Hardware Security Module) and SIM (Subscriber Identity Module). Partially implemented (see note 7) SER-071 See REQ-2017- 0030R05 The oneM2M system shall be able to support processing and granting of requests based on access rights of a resource if the required conditions are met Implemented in Rel-1 SER-072 See REQ-2017- 0030R05 The oneM2M system shall provide privacy protection mechanisms at the central server. Implemented in Rel-2 SER-073 See REQ-2017- 0031R05 The oneM2M system shall be able to support authentication using device key and the integrity check ofM2M Device(s). Rel-3? SER-074 See REQ-2017- 0031R05 The oneM2M system shall be able to support anonymization of the t information being provided, when requested by M2M Applications. Rel-3/future releases? SER-075 See REQ-2017- 0031R05 The oneM2M system shall apply appropriate security levels for Applications that can have safety impacts (e.g. protection from malicious attacks). Rel-3/future releases? NOTE 1: The above requirement does not cover items outside of the oneM2M System, e.g. Underlying Networks. NOTE 2: Geographical location information can be more than simply longitude and latitude. NOTE 3: Partly supported for Impersonation attacks not supported for Replay attacks. NOTE 4: The oneM2M System has no means to verify a subscriber's consent. This requirement is only fulfillable at application level. NOTE 5: Regarding remote provisioning, Release 1 supports remote provisioning of symmetric key credentials only. NOTE6: An M2M device may include e.g. firmware managed by an OEM vendor, middleware managed by a service provider and software managed by an application provider. The entity managing a software piece is designed as "allowed stakeholder" in the requirements above. NOTE 7: Support for SIM is supported in Release 1 and Release 2.
d87eb3f66919df49f65eccf89c57cbd3
118 102
6.5 Charging Requirements
Table 10: Charging Requirements Requirement ID Description Release CHG-001 The oneM2M System shall support collection of charging specific information related to the individual services facilitated by the oneM2M System (e.g. Data Management, Device Management and/or Connectivity Management). Collection of charging specific information shall be possible concurrent with the resource usage. The format of the recorded information shall be fully specified including mandatory and optional elements. Implemented in Rel-1 (see note 4) CHG-002 The oneM2M System shall support mechanisms to facilitate correlation of charging information (e.g. of a User) collected for M2M Services, M2M Application Services and services provided by Underlying Network Operators. Partially implemented (see note 2) CHG-003 The oneM2M System shall provide means to coordinate charging data records for data usages with differentiated QoS from the Underlying Network. Not implemented CHG-004 The oneM2M System shall be able to utilize existing charging mechanisms of Underlying Networks. Not implemented (see note 3) ETSI ETSI TS 118 102 V3.1.2 (2021-01) 24 oneM2M TS-0002 version 3.1.2 Release 3 Requirement ID Description Release CHG-005 The oneM2M System shall support transfer of the charging information records to the billing domain of the M2M Service Provider, for the purpose of: • subscriber billing; • inter-provider billing; • provider-to-subscriber accounting including additional functions like statistics. Implemented in Rel-1 CHG-006 The oneM2M System should support generation of charging events for the purpose of requesting resource usage Authorization from the real time credit control system where the subscriber account is located. The information contained in the charging events and the relevant chargeable events shall be fully specified including mandatory and optional elements (see note 1). Not implemented CHG-007 See REQ-2017- 0031R05 The oneM2M System shall support mechanisms to correlate charging information (e.g. data/records) from different M2M Application Service Providers. Rel-3/future releases? NOTE 1: A chargeable event is any activity, a provider may want to charge for that utilizes the resources and related M2M Services offered by such provider. A charging event is the set of charging information needed by the credit control system for resource authorization. NOTE 2: Information collected can be sent to the Underlying Networks which may use it for charging. NOTE 3: The oneM2M service layer can pass info to Underlying Networks but cannot use Underlying Network mechanism. Charging can be done by Underlying Network. This is covered by CHG-002. NOTE 4: Only supported in the Infrastructure Node.
d87eb3f66919df49f65eccf89c57cbd3
118 102
6.6 Operational Requirements
Table 11: Operational Requirements Requirement ID Description Release OPR-001 The oneM2M System shall provide the capability for monitoring and diagnostics of M2M Applications. Implemented in Rel-1 OPR-002 The oneM2M System shall provide the capability for software management of M2M Applications. Implemented in Rel-1 OPR-003 The oneM2M System shall be able to configure the execution state an M2M Application (start, stop, restart). Implemented in Rel-1 OPR-004 When suitable interfaces are provided by the Underlying Network, the oneM2M System shall have the ability to schedule traffic via the Underlying Network based on instructions received from the Underlying Network. Not implemented OPR-005 The oneM2M System shall be able to exchange information with M2M Applications related to usage and traffic characteristics of M2M Devices or M2M Gateways by the M2M Application. This should include support for the 3GPP feature called: "Time controlled" (see note). Implemented in Rel-2 OPR-006 Depending on availability of suitable interfaces provided by the Underlying Network the oneM2M System shall be able to provide information related to usage and traffic characteristics of M2M Devices or M2M Gateways to the Underlying Network. Implemented in Rel-2 OPR-007 See REQ-2015- 0550R03 The oneM2M System shall be able to support receipt of the status information of the Underlying Network if supported by the Underlying Network. Not implemented OPR-008 See REQ-2015- 0550R03 The oneM2M System shall be able to provide the M2M Applications with status information received from the Underlying Network. Not implemented OPR-009 See 0585R01- App-ID Requirements The format for registered App-IDs shall be able to support use by people and systems to readily determine whether the App-ID is registered and the Registration Authority which issued the App-ID, App Developer and App Name. Implemented in Rel-2 OPR-010 See 0585R01- App-ID Requirements The oneM2M System Registration Authorities shall be able to collect and maintain supporting required information when assigning an App-ID. Implemented in Rel-2 NOTE: "Time controlled" is equivalent to the MTC Features specified in clause 7.2 of ETSI TS 122 368 [1]. ETSI ETSI TS 118 102 V3.1.2 (2021-01) 25 oneM2M TS-0002 version 3.1.2 Release 3
d87eb3f66919df49f65eccf89c57cbd3
118 102
6.7 Communication Management Requirements
Table 12: Communication Management Requirements Requirement ID Description Release CMR-001 The oneM2M System shall provide to M2M Applications a communication service which provides buffering of messages to/from M2M Gateway/Device/ Infrastructure Domain. Implemented in Rel-1 CMR-002 The oneM2M System shall be able to support forwarding buffered messages depending on communication policies and based on service preference associated with the buffered messages. Implemented in Rel-1 CMR-003 The oneM2M System shall enable an M2M Application to send a communication request with the following service preference: • QoS parameters, including delay tolerance, for initiating the delivery of data; • categorizing communication requests into different levels of priority or QoS classes. Implemented in Rel-1 CMR-004 The oneM2M System shall be able to support concurrent processing of messages within M2M Gateways and/or M2M Devices from different sources with awareness for the service preference associated with the messages while observing the provisioned communication policies. Implemented in Rel-1 CMR-005 The oneM2M System shall be able to maintain context associated with M2M sessions (e.g. security context or network connectivity context during the interruption of the session). Partially implemented (see note 1) CMR-006 See REQ-2015- 0564R02 The oneM2M System shall support the ability for applications to categorize requested communications (priority, importance, etc.), so that the oneM2M System can adapt its actual communications (scheduling, aggregation, compression, etc.) by taking this categorization into account. Implemented in Rel-1 CMR-007 See REQ-2015- 0564R02 The oneM2M System shall support configurable communication policies that will define its communication patterns. Such policies shall take into account information received from the Underlying Network (such as information referred to in OPR-004) as well as information received from the Applications (such as the information referred to in OPR-005 or categorization of communications requested by the applications). Partially implemented (see note 2) CMR-008 See REQ-2015- 0564R02 The oneM2M System shall support data aggregation based on communication policies when exchanging data between the M2M Gateway/Device/Infrastructure Domain. Implemented in Rel-1 CMR-009 See REQ-2015- 0564R02 The oneM2M System should support data compression based on communication policies when exchanging data between the M2M Gateway/Device/Infrastructure Domain. Not implemented CMR-010 See REQ-2015- 0564R02 The oneM2M System shall support an additional randomized delay of communications, based on communication policies, when exchanging data between the M2M Gateway/Device/Infrastructure Domain. Implemented in Rel-2 CMR-011 See REQ-2015- 0564R02 The oneM2M System shall be able to monitor its own usage of the Underlying Networks over given periods of time: attempted communications, failed attempts and successful attempts. Implemented in Rel-2 CMR-012 See REQ-2015- 0564R02 The oneM2M System shall be able to restrict its own usage of the Underlying Networks, based on communication policies and on its monitored usage of them, when exchanging data between the M2M Gateway/Device/Infrastructure Domain. Implemented in Rel-2 CMR-013 See REQ-2015- 0564R02 The oneM2M System shall be able to refrain from using its own usage of the Underlying Networks, based on a time-based back-off procedure configurable in communication policies, when exchanging data between the M2M Gateway/Device/Infrastructure Domain. Implemented in Rel-2 CMR-014 See REQ-2015- 0564R02 The oneM2M System shall be able to restrict its own usage of the Underlying Networks, based on communication policies and on the date and time, when exchanging data between the M2M Gateway/Device/Infrastructure Domain. Implemented in Rel-1 CMR-015 See REQ-2015- 0601R01 The oneM2M System shall be able to identify a series of data (e.g. Time Series Data) and indicate individual data belonging to this series. Implemented in Rel-2 CMR-0016 See REQ-2017- 0001R03 The oneM2M system shall support the data to be transmitted to IoT platform with strict timing and packet loss requirements, determined by the application(s). Not implemented CMR-0017 See REQ-2017- 0001R03 The oneM2M system shall support the data to be transmitted from IoT platform to subscribed devices with highest priority, with strict timing and packet loss requirements, determined by the application(s). Not implemented ETSI ETSI TS 118 102 V3.1.2 (2021-01) 26 oneM2M TS-0002 version 3.1.2 Release 3 Requirement ID Description Release CMR-0018 See REQ-2017- 0001R03 The oneM2M System shall be able to detect and report the missing data in time series, for each source of time sensitive data which is sent to the IoT platform. Implemented in Rel-2 CMR-0019 See REQ-2017- 0001R03 The oneM2M System shall be able to detect and report the missing data in time series, for each time sensitive application receiving data. Implemented in Rel-2 NOTE 1: Long lived security context and registration is covered, M2M Sessions are not covered. NOTE 2: CMDH policies (application side) is implemented, information from the Underlying Network can be utilized but the method for provisioning via Mcn is not covered.
d87eb3f66919df49f65eccf89c57cbd3
118 102
6.8 LWM2M Interworking Requirements
Table 13: LWM2M Interworking Requirements Requirement ID Description Release LWM2M-001 See REQ-2015- 0517R04 The oneM2M System shall provide the capability to transparently transport LWM2M Objects between LWM2M Clients and M2M Applications. Implemented in Rel-2 LWM2M-002 See REQ-2015- 0517R04 The oneM2M System shall provide the capability to translate LWM2M Objects into a semantic representation of the LWM2M Object as oneM2M resources. Implemented in Rel-2 LWM2M-003 See REQ-2015- 0517R04 The oneM2M System shall provide the capabilities of the LWM2M Server in order to interwork between LWM2M Clients and M2M Applications. Implemented in Rel-2 LWM2M-004 See REQ-2015- 0517R04 The oneM2M System shall provide the capability for M2M Applications to discover LWM2M Clients using the LWM2M Client's Endpoint Name. Implemented in Rel-2 LWM2M-005 See REQ-2015- 0517R04 When transparently transporting LWM2M Objects, the oneM2M System shall provide the capability for M2M Applications to discover the defining of LWM2M Objects transported by the oneM2M System. Not implemented LWM2M-006 See REQ-2015- 0517R04 When interworking with LWM2M Objects, the oneM2M System shall provide the capability for M2M Applications to discover a LWM2M Object using the LWM2M Object's identifier. Implemented in Rel-2 LWM2M-007 See REQ-2015- 0517R04 The oneM2M System shall provide capability to onboard devices that incorporate a LWM2M Client. Implemented in Rel-2 LWM2M-008 See REQ-2015- 0517R04 The oneM2M System shall provide the capability to interoperate the underlying security mechanisms of the LWM2M Client with the security capabilities provided by the oneM2M System. Implemented in Rel-2
d87eb3f66919df49f65eccf89c57cbd3
118 102
7 Non-Functional Requirements (informative)
This clause is intended to gather high-level principles and guidelines that shall govern the design of the oneM2M System. Such principles and guidelines are fundamental to the design of the oneM2M System. But as they cannot necessarily be expressed as requirements per se, they shall be introduced and expressed in this clause. Table 14: Non-Functional Requirements Requirement ID Description Release NFR-001 Continua Health Alliance is incorporating a RESTful approach to its design. To support CHA, oneM2M should consider RESTful styles and approaches while designing the M2M architecture. Implemented in Rel-1 NFR-002 The oneM2M System should communicate using protocols that are efficient in terms of amount of exchanged information over amount of exchanged data measured in bytes. Implemented in Rel-1 ETSI ETSI TS 118 102 V3.1.2 (2021-01) 27 oneM2M TS-0002 version 3.1.2 Release 3 Annex A (informative): Requirements for the next release The requirements contained in this Annex are gathered and targeted for the next release of oneM2M: 1 Functional Requirements 1.1 Overall System Requirements 1.2 Management Requirements 1.3 Semantics Requirements 1.3.1 Ontology Related Requirements 1.3.2 Semantics Annotation Requirements 1.3.3 Semantics Query Requirements 1.3.4 Semantics Mashup Requirements 1.3.5 Semantics Reasoning Requirements 1.3.6 Data Analytics Requirements 1.4 Security Requirements 1.5 Charging Requirements 1.6 Operational Requirements 1.7 Communication Management Requirements 1.8 LWM2M Interworking Requirements ETSI ETSI TS 118 102 V3.1.2 (2021-01) 28 oneM2M TS-0002 version 3.1.2 Release 3 History Document history V3.1.2 January 2021 Publication
9ab246a740b04002bf9bf7eacc512119
118 106
1 Scope
The present document describes the protocol mappings between the management Resources for oneM2M and the BBF TR-181 [6].
9ab246a740b04002bf9bf7eacc512119
118 106
2 References
9ab246a740b04002bf9bf7eacc512119
118 106
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] Void. [4] BBF TR-069: "CPE WAN Management Protocol", Issue 1, Amendment 5, November 2013. NOTE: Available at https://www.broadband-forum.org/download/TR-069_Amendment-5.pdf. [5] BBF TR-106: "Data Model Template for TR-069-Enabled Devices", Issue 1, Amendment 7, September 2013. NOTE: Available at https://www.broadband-forum.org/download/TR-106_Amendment-7.pdf. [6] BBF TR-181: "Device Data Model for TR-069", Issue 2, Amendment 11", July 2016. NOTE: Available at https://www.broadband-forum.org/technical/download/TR-181_Issue-2_Amendment-11.pdf. [7] BBF TR-131: "ACS Northbound Interface Requirements", Issue 1, Amendment 1, August 015. NOTE: Available at http://www.broadband-forum.org/technical/download/TR-131.pdf. [8] ETSI TS 118 122: "oneM2M; Field Device Configuration (oneM2M TS-0022)".
9ab246a740b04002bf9bf7eacc512119
118 106
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 ETSI TS 118 106 V3.6.2 (2021-02) 7 oneM2M TS-0006 version 3.6.2 Release 3 [i.2] ETSI TS 118 111: "Common Terminology (oneM2M TS-0011)".
9ab246a740b04002bf9bf7eacc512119
118 106
3 Definition of terms, symbols and abbreviations
9ab246a740b04002bf9bf7eacc512119
118 106
3.1 Terms
For the purposes of the present document, the terms given in ETSI TS 118 111 [i.2] and the following apply: CPE Proxier: CPE that is capable of proxying the communication between an ACS and a Proxied Device as defined in BBF TR-069 [4]
9ab246a740b04002bf9bf7eacc512119
118 106
3.2 Symbols
Void.
9ab246a740b04002bf9bf7eacc512119
118 106
3.3 Abbreviations
For the purposes of the present document, the abbreviations given in ETSI TS 118 111 [i.2] 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 MAF M2M Authentication Function 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
9ab246a740b04002bf9bf7eacc512119
118 106
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]. ETSI ETSI TS 118 106 V3.6.2 (2021-02) 8 oneM2M TS-0006 version 3.6.2 Release 3
9ab246a740b04002bf9bf7eacc512119
118 106
5 Mapping of basic data types
BBF TR-106 [5] specifies the object structure supported by BBF TR-069 [4] enabled devices and specifies the structural requirements for the data hierarchy. This clause includes the mapping attribute data types to BBF TR-181 [6] parameters which follows the conventions of section 3 of BBF TR-106 [5] and data types described in table 4 of BBF TR-106 [5]. Table 5-1: Data Type Mapping oneM2M Data Types Mapping to data types in BBF TR-106 [5] Conversion Notes 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 Lists Comma separated Lists Data structure is represented by comma separated list as described in section 3.2.3 of BBF 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 4 000 (BAD_REQUEST) response status code shall be given.
9ab246a740b04002bf9bf7eacc512119
118 106
6 Mapping of identifiers
9ab246a740b04002bf9bf7eacc512119
118 106
6.0 Introduction
The BBF TR-069 [4] specification defines three (3) types of devices, known as CPEs, that are capable of being managed from the perspective of the BBF TR-069 [4] agent: • CPE that hosts the BBF TR-069 [4] agent: Section A.3.3.1 Inform of BBF 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 BBF TR-069 [4] agent.
9ab246a740b04002bf9bf7eacc512119
118 106
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 ETSI TS 118 101 [1]. CPE Device identifiers shall map to the nodeID attribute of the <node> resource. The CPE Device identifiers are obtained from the contents of the following attributes: • Device.DeviceInfo.ManufacturerOUI • Device.DeviceInfo.ProductClass • Device.DeviceInfo.SerialNumber ETSI ETSI TS 118 106 V3.6.2 (2021-02) 9 oneM2M TS-0006 version 3.6.2 Release 3 Virtual Device identifiers shall map to the nodeID attribute of the <node> 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 Embedded Device identifiers shall map to the nodeID attribute of the <node> 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
9ab246a740b04002bf9bf7eacc512119
118 106
6.2 Identifier of an object instance
The BBF 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).
9ab246a740b04002bf9bf7eacc512119
118 106
7 Mapping of resources
9ab246a740b04002bf9bf7eacc512119
118 106
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 BBF TR-181 [6] data model or the Remote Procedure Calls (RPCs) in BBF TR-069 [4].
9ab246a740b04002bf9bf7eacc512119
118 106
7.1 General mapping assumptions
9ab246a740b04002bf9bf7eacc512119
118 106
7.1.0 Introduction
BBF 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 BBF TR-106 [5] and BBF TR-181 [6] as well as RPCs described in BBF TR-069 [4]. As BBF TR-181 [6] is the model that the Resources are mapped, all Resources shall have the objects of the BBF TR-181 [6] namespace (e.g. "urn:broadband-forum-org:tr-181-2-7-0").
9ab246a740b04002bf9bf7eacc512119
118 106
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]. ETSI ETSI TS 118 106 V3.6.2 (2021-02) 10 oneM2M TS-0006 version 3.6.2 Release 3 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".
9ab246a740b04002bf9bf7eacc512119
118 106
7.1.2 Mapping of Embedded Devices
The BBF 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 BBF TR-181 [6] provides this information in a manner that is reliant on the Embedded Device's underlying technology (e.g. ZigBee®, UpnP). 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.
9ab246a740b04002bf9bf7eacc512119
118 106
7.2 Resource [deviceInfo]
The Resource [deviceInfo] is a read-only Resource that shall map to the Device.DeviceInfo object of BBF TR-181 [6] for CPE and Virtual Devices. The information shall be retrieved using the GetParameterValues RPC of BBF 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 [deviceInfo] BBF TR-181 [6] Parameter deviceLabel Device.DeviceInfo.SerialNumber manufacturer Device.DeviceInfo.Manufacturer model Device.DeviceInfo.ModelNumber deviceType Device.DeviceInfo.ProductClass fwVersion Device.DeviceInfo.SoftwareVersion if the device supports only 1 software version. If the device support multiple software versions this shall map to Device.DeviceInfo.AdditionalSoftwareVersion swVersion Device.DeviceInfo.SoftwareVersion hwVersion Device.DeviceInfo.HardwareVersion Table 7.2-2: Resource [deviceInfo] for Embedded Devices Attribute Name of [deviceInfo] BBF TR-181 [6] Parameter deviceLabel Comma separated list: "Device.ManagementServer.EmbeddedDevice.{i}.ControllerID, Device.ManagementServer.EmbeddedDevice.{i}.ProxiedDeviceID manufacturer No mapping available model No mapping available deviceType No mapping available fwVersion No mapping available swVersion No mapping available hwVersion No mapping available
9ab246a740b04002bf9bf7eacc512119
118 106
7.3 Resource [memory]
The Resource [memory] is a read-only Resource that shall map to the Device.DeviceInfo.MemoryStatus object of BBF TR-181 [6] for CPE and Virtual Devices. The information shall be retrieved using the GetParameterValues RPC of BBF TR-069 [4]. Attempts to modify the attributes of the memory Resource causes an error code "operation unsupported" to be returned. ETSI ETSI TS 118 106 V3.6.2 (2021-02) 11 oneM2M TS-0006 version 3.6.2 Release 3 Table 7.3-1: Resource [memory] Attribute Name of [memory] BBF TR-181 [6] Parameter memAvailable Device.DeviceInfo.MemoryStatus.Free memTotal Device.DeviceInfo.MemoryStatus.Total
9ab246a740b04002bf9bf7eacc512119
118 106
7.4 Resource [battery]
The Resource [battery] is a read-only Resource that shall map to an instance of Device.DeviceInfo.X_oneM2M_org_BatteryStatus.Battery.{i} object for CPE and Virtual Devices. The information shall be retrieved using the GetParameterValues RPC of BBF TR-069 [4]. Table 7.4-1: Resource [battery] Attribute Name of [battery] BBF TR-181 [6] Parameter batteryLevel Device.DeviceInfo.X_oneM2M_org_BatteryStatus.Battery.{i}.Level batteryStatus Device.DeviceInfo.X_oneM2M_org_BatteryStatus.Battery.{i}.Status
9ab246a740b04002bf9bf7eacc512119
118 106
7.5 Resource [areaNwkInfo]
The Resource [areaNwkInfo] is a multi-instance Resource where each instance of the Resource shall map to an instance of Device.X_oneM2M_org_CSE.{i}.M2MareaNetwork.{i} object. As the Resource [areaNwkInfo] is a multi-instance Resource, the M2MareaNetwork object is a multi-object instance that can be created and deleted. The M2MareaNetwork instance shall be created using the Add Object RPC of BBF TR-069 [4]. The M2MareaNetwork instance shall be deleted using the Delete Object RPC of BBF TR-069 [4]. The information of an M2MareaNetwork shall be retrieved using the GetParameterValues RPC of BBF TR-069 [4]. The information of an M2MareaNetwork shall be modified using the SetParameterValues RPC of BBF TR-069 [4]. Table 7.5-1: Resource [areaNwkInfo] Attribute Name of [areaNwkInfo] X_oneM2M_org Parameter areaNwkType Device.X_oneM2M_org_CSE.{i}.M2MareaNetwork.{i}.Type listOfDevices Device.X_oneM2M_org_CSE.{i}.M2MareaNetwork.{i}.ListOfDevices
9ab246a740b04002bf9bf7eacc512119
118 106
7.6 Resource [areaNwkDeviceInfo]
The Resource [areaNwkDeviceInfo] is a multi-instance Resource where each instance of the Resource shall map to an instance of Device.X_oneM2M_org_CSE.{i}.AreaNetworkDevice.{i} object. As the Resource [areaNwkDeviceInfo] is a multi-instance Resource, the AreaNetworkDevice object is a multi-object instance that can be created and deleted. Instances of the Resource [areaNwkDeviceInfo] are referenced in the listOfDevices attribute of the associated Resource [areaNwkInfo]. The M2MareaNetworkDevice instance shall be created using the Add Object RPC of BBF TR-069 [4]. The M2MareaNetworkDevice instance shall be deleted using the Delete Object RPC of BBF TR-069 [4]. The information of an M2MareaNetworkDevice shall be retrieved using the GetParameterValues RPC of BBF TR-069 [4]. ETSI ETSI TS 118 106 V3.6.2 (2021-02) 12 oneM2M TS-0006 version 3.6.2 Release 3 The information of an M2MareaNetworkDevice shall be modified using the SetParameterValues RPC of BBF TR-069 [4]. Table 7.6-1: Resource [areaNwkDeviceInfo] Attribute Name of [areaNwkDeviceInfo] X_oneM2M_org Parameter devId Device.X_oneM2M_org_CSE.{i}.M2MareaNetworkDevice.{i}.Host devType Device.X_oneM2M_org_CSE.{i}.M2MareaNetworkDevice.{i}.Type areaNwkId Reference to Device.X_oneM2M_org_CSE.{i}.M2MareaNetworkDevice.{i}.M2MareaNetwork sleepInterval Device.X_oneM2M_org_CSE.{i}.M2MareaNetworkDevice.{i}.SleepInterval sleepDuration Device.X_oneM2M_org_CSE.{i}.M2MareaNetworkDevice.{i}.SleepDuration status Device.X_oneM2M_org_CSE.{i}.M2MareaNetworkDevice.{i}.Status listOfNeighbors Device.X_oneM2M_org_CSE.{i}.M2MareaNetworkDevice.{i}.Neighbors
9ab246a740b04002bf9bf7eacc512119
118 106
7.7 Resource [eventLog]
The Resource [eventLog] is a multi-instance Resource where each instance of the Resource shall map to an instance of Device.DeviceInfo.X_oneM2M_org_Diagnostics.EventLog.{i} object. The EventLog instance shall be created using the Add Object RPC of BBF TR-069 [4]. The EventLog instance shall be deleted using the Delete Object RPC of BBF TR-069 [4]. The information of an EventLog instance shall be retrieved using the GetParameterValues RPC of BBF TR-069 [4]. The information of an EventLog instance shall be updated using the SetParameterValues RPC of BBF TR-069 [4]. Table 7.7-1: Resource [eventLog] Attribute Name of [eventLog] BBF TR-181 [6] Parameter logTypeId Device.DeviceInfo.X_oneM2M_org_Diagnostics.EventLog.{i}.Type logData Device.DeviceInfo.X_oneM2M_org_Diagnostics.EventLog.{i}.Data logStatus Device.DeviceInfo.X_oneM2M_org_Diagnostics.EventLog.{i}.Status logStart Set to "True", the Device.DeviceInfo.X_oneM2M_org_Diagnostics.EventLog.{i}.Enable parameter is set to "True". logStop Set to "True", the Device.DeviceInfo.X_oneM2M_org_Diagnostics.EventLog.{i}.Enable parameter is set to "False".
9ab246a740b04002bf9bf7eacc512119
118 106
7.8 Resource [deviceCapability]
The Resource [deviceCapability] represents a capability of device that can be administratively enabled or disabled. The lists of capabilities that are managed are defined in the enumeration of the capabilityName attribute. BBF TR-181 [6] data model defines a subset of capabilities listed in the deviceCapability enumeration. The supported device capabilities within BBF TR-181 [6] include: • LAN Interfaces: USB, Wi-Fi, HomePlug, MoCA, UPA. • Hardware Capabilities: SmartCardReader. The information shall be retrieved using the GetParameterValues RPC of BBF TR-069 [4]. The capabilities shall be enabled and disabled using the SetParameterValues RPC of BBF TR-069 [4]. ETSI ETSI TS 118 106 V3.6.2 (2021-02) 13 oneM2M TS-0006 version 3.6.2 Release 3 Table 7.8-1: Resource [capabilityInstance] Attribute Name of [capabilityInstance] BBF TR-181 [6] Parameter CapabilityName This attribute is fixed based on the value of the capabilityName attribute Attached Returns "True" CapabilityActionStatus Status is defined as: • Success if the SetParameterValues RPC indicates that the operation was successful • Failure if the response to the SetParameterValues RPCs indicates that the operation failed • In process if the SetParameterValues RPC is initiated but the response to the SetParameterValues RPC has not been received CurrentState USB: Device.USB.Interface.{i}.Enable Wi-Fi: Device.Wi-Fi.Radio.{i}.Enable HomePlug: Device.HomePlug.Interface.{i}.Enable MoCA: Device.MoCA.Interface.{i}.Enable UPA: Device.UPA.Interface.{i}.Enable SmartCardReader: Device.SmartCardReaders.SmartCardReader.{i}.Enable Enable USB: Device.USB.Interface.{i}.Enable Wi-Fi: Device.Wi-Fi.Radio.{i}.Enable HomePlug: Device.HomePlug.Interface.{i}.Enable MoCA: Device.MoCA.Interface.{i}.Enable UPA: Device.UPA.Interface.{i}.Enable SmartCardReader: Device.SmartCardReaders.SmartCardReader.{i}.Enable Disable Same parameter is used to disable a capability as the enable attribute
9ab246a740b04002bf9bf7eacc512119
118 106
7.9 Resource [firmware]
The Resource [firmware] represents a firmware instance and is not considered a TR-069 managed entity within the device until the firmware Resource's update attribute has been written a value of "True". When this occurs, the BBF TR-069 [4] Download RPC shall be invoked. NOTE: In many instances, the server from which the firmware is downloaded requires authentication in the form of Username and Password credentials. The CSE that executes firmware download will maintain the mapping of the username and password of the download server needed to download the firmware outside the lifecycle of the specific firmware. Table 7.9-1: Resource [firmware] Attribute Name of [firmware] RPC Download Arguments URL URL update When set to the value of "True" executes the Download operations with a FileType "1 Firmware Upgrade Image" is performed Username: Received from the CSE for the download server where the update is set to "True" Password: Received from the CSE for the download server where the update is set to "True" CommandKey: Automatically set by the CSE where the update is set to "True" in order to correlate the TransferComplete response FileSize: 0 (not used) TargetFileName: <empty> (not used) DelaySeconds: 0 (immediate) SuccessURL: <empty> (not used) FailureURL: <empty> (not used)
9ab246a740b04002bf9bf7eacc512119
118 106
7.10 Resource [software]
The Resource [software] is a multi-instance Resource where each instance of the Resource maps directly to an instance of Device.SoftwareModules.DeploymentUnit.{i} object for the deployment aspects (install, uninstall) of the Resource [software]. The install and uninstall operation of the Resource [software] is performed using a combination of the ChangeDUState and ChangeDUStateComplete RPCs. ETSI ETSI TS 118 106 V3.6.2 (2021-02) 14 oneM2M TS-0006 version 3.6.2 Release 3 Once a Resource [software] has been installed, the Resource shall be mapped to the associated Device.SoftwareModules.ExecutionUnit.{i} objects in order to activate and deactivate the associated execution unit. The Resource [software] version and name shall be retrieved using the GetParameterValues RPC of BBF TR-069 [4]. The activate and deactivate operations of the Resource [software] shall be performed by manipulating the Device.SoftwareModules.ExecutionUnit.{i}.RequestedState parameter using the SetParameterValues RPC. NOTE: The Resource [software] provides support for only 1 Execution Unit per Deployment Unit. If a Deployment Unit is discovered by the M2M Service Layer that contains multiple Execution Units for a Deployment Unit; only 1 Execution Unit is exposed. The selection of which Execution Unit is implementation specific. Table 7.10-1: Resource [software] Attribute Name of [software] Description version Device.SoftwareModules.DeploymentUnit.{i}.Version name Device.SoftwareModules.DeploymentUnit.{i}.Name URL Device.SoftwareModules.DeploymentUnit.{i}.URL install Use the ChangeDUState:InstallOpStruct installStatus Status is defined as: • Success if the ChangeDUStateComplete RPC indicates that the operation was successful • Failure if the response to the ChangeDUState or ChangeDUStateComplete RPCs indicates that the operation failed • In process if the ChangeDUState RPC is initiated but the ChangeDUStateComplete RPC has not been received Activate The action that activates software previously installed. Deactivate The action that deactivates software. activeStatus Status is defined as: • Success if the SetParameterValues RPC indicates that the operation was successful • Failure if the response to the SetParameterValues RPCs indicates that the operation failed • In process if the SetParameterValues RPC is initiated but the response to the SetParameterValues RPC has not been received Table 7.10-2: RPC ChangeDUState:InstallOpStruct Arguments RPC ChangeDUState:InstallOpStruct Argument URL: URL of the Server that M2M Node uses to download the DU. Username: Username credential of Server that the CPE uses to download the DU - Supplied by the CSE. Password: Password credential of Server that the CPE uses to download the DU - Supplied by the CSE. UUID: Supplied by the CSE and used to correlate the DU for the uninstall operation. ExecurtionEnvRef: <empty> not used. Table 7.10-3: RPC ChangeDUState:UninstallOpStruct Arguments RPC ChangeDUState:Uninstall OpStruct Argument UUID: UUID of the DU that was installed - Maintained by the CSE ExecutionEnvRef: <empty> not used
9ab246a740b04002bf9bf7eacc512119
118 106
7.11 Resource [reboot]
The Resource [reboot] maps to either the Reboot RPC or FactoryReset RPC of BBF TR-069 [4]. When the reboot attribute of the Resource [reboot] is set to "True", the CSE shall execute the Reboot RPC of BBF TR-069 [4]. When the factoryReset attribute of Resource [reboot] is set to "True", the CSE shall execute the FactoryReset RPC of BBF TR-069 [4]. ETSI ETSI TS 118 106 V3.6.2 (2021-02) 15 oneM2M TS-0006 version 3.6.2 Release 3 Table 7.11-1: Resource [reboot] Attribute Name of [reboot] Description reboot Executes the Reboot RPC factoryReset FactoryReset RPC Table 7.11-2: RPC Reboot Arguments RPC Reboot Arguments CommandKey: Automatically set by the CSE where the reboot is set to "True" in order to correlate the "M-Reboot" Event from the next Inform.
9ab246a740b04002bf9bf7eacc512119
118 106
7.12 Resource [cmdhPolicy]
9ab246a740b04002bf9bf7eacc512119
118 106
7.12.0 Introduction
The Resource [cmdhPolicy] represents a set of rules defining which CMDH parameters will be used by default when a request issued by a local originator contains the ec (event category) parameter but not all other CMDH parameters, see clause D.12 of ETSI TS 118 101 [1]. The Resource [cmdhPolicy] is a multi-instance Resource where each instance of the Resource shall map to an instance of Device.X_oneM2M_org_CSE.{i}.CMDH.Policy.{i} object. The Policy instance shall be created using the Add Object RPC of BBF TR-069 [4]. The Policy instance shall be deleted using the Delete Object RPC of BBF TR-069 [4]. The information of a Policy instance shall be retrieved using the GetParameterValues RPC of BBF TR-069 [4]. The information of a Policy instance shall be updated using the SetParameterValues RPC of BBF TR-069 [4]. Table 7.12.0-1: Resource [cmdhPolicy] Attribute Name of [cmdhPolicy] X_oneM2M_org Parameter name Device.X_oneM2M_org_CSE.{i}.CMDH.Policy.{i}.Name cmdhDefaults Device.X_oneM2M_org_CSE.{i}.CMDH.Policy.{i}.DefaultRule cmdhLimits Device.X_oneM2M_org_CSE.{i}.CMDH.Policy.{i}.LimitRules cmdhNetworkAccessRules Device.X_oneM2M_org_CSE.{i}.CMDH.Policy.{i}.NetworkAccessECRules cmdhBuffer Device.X_oneM2M_org_CSE.{i}.CMDH.Policy.{i}.BufferRules
9ab246a740b04002bf9bf7eacc512119
118 106
7.12.1 Resource [activeCmdhPolicy]
The Resource [activeCmdhPolicy] provides a link to the currently active set of CMDH policies, see clause D.12.1 of ETSI TS 118 101 [1]. The Resource [activeCmdhPolicy] is mapped to the Enable parameter of the Device.X_oneM2M_org_CSE.{i}.CMDH.Policy.{i} object. The information of a Policy instance shall be updated using the SetParameterValues RPC of BBF TR-069 [4]. Table 7.12.1-1: Resource [activeCmdhPolicy] Attribute Name of [activeCmdhPolicy] X_oneM2M_org Parameter cmdhPolicy Device.X_oneM2M_org_CSE.{i}.CMDH.Policy.{i}.Enable At most one Policy instance shall be enabled at a time. As such the Policy instance that has the Enable parameter with a value of "True" is the active CMDH policy. ETSI ETSI TS 118 106 V3.6.2 (2021-02) 16 oneM2M TS-0006 version 3.6.2 Release 3
9ab246a740b04002bf9bf7eacc512119
118 106
7.12.2 Resource [cmdhDefaults]
The Resource [cmdhDefaults] defines default CMDH policy values, see clause D.12.2 of ETSI TS 118 101 [1]. The Resource [cmdhDefaults] is a multi-instance Resource where each instance of the Resource shall map to an instance of Device.X_oneM2M_org_CSE.{i}.CMDH.Default.{i} object. The Default instance shall be created using the Add Object RPC of BBF TR-069 [4]. The Default instance shall be deleted using the Delete Object RPC of BBF TR-069 [4]. The information of a Default instance shall be retrieved using the GetParameterValues RPC of BBF TR-069 [4]. The information of a Default instance shall be updated using the SetParameterValues RPC of BBF TR-069 [4]. Table 7.12.2-1: Resource [cmdhDefaults] Attribute Name of [cmdhDefaults] X_oneM2M_org Parameter cmdhDefEcValue Device.X_oneM2M_org_CSE.{i}.CMDH.Default.{i}.DefaultECRules cmdhEcDefParamValues Device.X_oneM2M_org_CSE.{i}.CMDH.Default.{i}.DefaultECParamRules
9ab246a740b04002bf9bf7eacc512119
118 106
7.12.3 Resource [cmdhDefEcValue]
The Resource [cmdhDefEcValue] represents a value for the ec (event category) parameter of an incoming request, see clause D.12.3 of ETSI TS 118 101 [1]. The Resource [cmdhDefEcValue] is a multi-instance Resource where each instance of the Resource shall map to an instance of Device.X_oneM2M_org_CSE.{i}.CMDH.DefaultECRule.{i} object. The DefaultECRule instance shall be created using the Add Object RPC of BBF TR-069 [4]. The DefaultECRule instance shall be deleted using the Delete Object RPC of BBF TR-069 [4]. The information of a DefaultECRule instance shall be retrieved using the GetParameterValues RPC of BBF TR-069 [4]. The information of a DefaultECRule instance shall be updated using the SetParameterValues RPC of BBF TR-069 [4]. Table 7.12.3-1: Resource [cmdhDefEcValue] Attribute Name of [cmdhDefEcValue] X_oneM2M_org Parameter order Device.X_oneM2M_org_CSE.{i}.CMDH.DefaultECRule.{i}.Order defEcValue Device.X_oneM2M_org_CSE.{i}.CMDH.DefaultECRule.{i}.EventCategory requestOrigin Device.X_oneM2M_org_CSE.{i}.CMDH.DefaultECRule.{i}.RequestOrigin requestContext Device.X_oneM2M_org_CSE.{i}.CMDH.DefaultECRule.{i}.RequestContext requestContextNotification Device.X_oneM2M_org_CSE.{i}.CMDH.DefaultECRule.{i}.RequestContextNotification Enable requestCharacteristics Device.X_oneM2M_org_CSE.{i}.CMDH.DefaultECRule.{i}.RequestCharacteristics
9ab246a740b04002bf9bf7eacc512119
118 106
7.12.4 Resource [cmdhEcDefParamValues]
The Resource [cmdhEcDefParamValues] represents a specific set of default values for the CMDH related parameters rqet (request expiration timestamp), rset (result expiration timestamp), oet (operational execution time), rp (response persistence) and da (delivery aggregation) that are applicable for a given ec (event category) if these parameters are not specified in the request, see clause D.12.4 of ETSI TS 118 101 [1]. The Resource [cmdhEcDefParamValues] is a multi-instance Resource where each instance of the Resource shall map to an instance of Device.X_oneM2M_org_CSE.{i}.CMDH.DefaultECParamRule.{i} object. The DefaultECParamRule instance shall be created using the Add Object RPC of BBF TR-069 [4]. ETSI ETSI TS 118 106 V3.6.2 (2021-02) 17 oneM2M TS-0006 version 3.6.2 Release 3 The DefaultECParamRule instance shall be deleted using the Delete Object RPC of BBF TR-069 [4]. The information of a DefaultECParamRule instance shall be retrieved using the GetParameterValues RPC of BBF TR-069 [4]. The information of a DefaultECParamRule instance shall be updated using the SetParameterValues RPC of BBF TR-069 [4]. Table 7.12.4-1: Resource [cmdhEcDefParamValues] Attribute Name of [cmdhEcDefParamValues] X_oneM2M_org Parameter applicableEventCategory Device.X_oneM2M_org_CSE.{i}.CMDH.DefaultECParamRule.{i}.EventCategories defaultRequestExpTime Device.X_oneM2M_org_CSE.{i}.CMDH.DefaultECParamRule.{i}.RequestExpTime defaultResultExpTime Device.X_oneM2M_org_CSE.{i}.CMDH.DefaultECParamRule.{i}.ResultExpTime defaultOpExecTime Device.X_oneM2M_org_CSE.{i}.CMDH.DefaultECParamRule.{i}.OperationExecTime defaultRespPersistence Device.X_oneM2M_org_CSE.{i}.CMDH.DefaultECParamRule.{i}.ResponsePersistence defaultDelAggregation Device.X_oneM2M_org_CSE.{i}.CMDH.DefaultECParamRule.{i}.DeliveryAggregation
9ab246a740b04002bf9bf7eacc512119
118 106
7.12.5 Resource [cmdhLimits]
The Resource [cmdhLimits] represents limits for CMDH related parameter values, see clause D.12.5 of ETSI TS 118 101 [1]. The Resource [cmdhLimits] is a multi-instance Resource where each instance of the Resource shall map to an instance of Device.X_oneM2M_org_CSE.{i}.CMDH.Limit.{i} object. The Limit instance shall be created using the Add Object RPC of BBF TR-069 [4]. The Limit instance shall be deleted using the Delete Object RPC of BBF TR-069 [4]. The information of a Limit instance shall be retrieved using the GetParameterValues RPC of BBF TR-069 [4]. The information of a Limit instance shall be updated using the SetParameterValues RPC of BBF TR-069 [4]. Table 7.12.5-1: Resource [cmdhLimits] Attribute Name of [cmdhLimits] X_oneM2M_org Parameter order Device.X_oneM2M_org_CSE.{i}.CMDH.Limit.{i}.Order requestOrigin Device.X_oneM2M_org_CSE.{i}.CMDH.Limit.{i}.RequestOrigin requestContext Device.X_oneM2M_org_CSE.{i}.CMDH.Limit.{i}.RequestContext requestContextNotification Device.X_oneM2M_org_CSE.{i}.CMDH.Limit.{i}.RequestContextNotificationEnable requestCharacteristics Device.X_oneM2M_org_CSE.{i}.CMDH.Limit.{i}.RequestCharacteristics limitsEventCategory Device.X_oneM2M_org_CSE.{i}.CMDH.Limit.{i}.EventCategories limitsRequestExpTime Device.X_oneM2M_org_CSE.{i}.CMDH.Limit.{i}.RequestExpTime limitsResultExpTime Device.X_oneM2M_org_CSE.{i}.CMDH.Limit.{i}.ResultExpTime limitsOpExecTime Device.X_oneM2M_org_CSE.{i}.CMDH.Limit.{i}.OperationExecTime limitsRespPersistence Device.X_oneM2M_org_CSE.{i}.CMDH.Limit.{i}.ResponsePersistence limitsDelAggregation Device.X_oneM2M_org_CSE.{i}.CMDH.Limit.{i}.DeliveryAggregation
9ab246a740b04002bf9bf7eacc512119
118 106
7.12.6 Resource [cmdhNetworkAccessRules]
The Resource [cmdhNetworkAccessRules] defines the usage of underlying networks for forwarding information to other CSEs during processing of CMDH-related requests in a CSE, see clause D.12.6 of ETSI TS 118 101 [1]. The Resource [cmdhNetworkAccessRules] is a multi-instance Resource where each instance of the Resource shall map to an instance of Device.X_oneM2M_org_CSE.{i}.CMDH.NetworkAccessECRule.{i} object. The NetworkAccessECRule instance shall be created using the Add Object RPC of BBF TR-069 [4]. The NetworkAccessECRule instance shall be deleted using the Delete Object RPC of BBF TR-069 [4]. ETSI ETSI TS 118 106 V3.6.2 (2021-02) 18 oneM2M TS-0006 version 3.6.2 Release 3 The information of a NetworkAccessECRule instance shall be retrieved using the GetParameterValues RPC of BBF TR-069 [4]. The information of a NetworkAccessECRule instance shall be updated using the SetParameterValues RPC of BBF TR-069 [4]. Table 7.12.6-1: Resource [cmdhNetworkAccessRules] Attribute Name of [cmdhNetworkAccessRules] X_oneM2M_org Parameter applicableEventCategories Device.X_oneM2M_org_CSE.{i}.CMDH.NetworkAccessECRule.{i}.EventCategories cmdhNwAccessRule Device.X_oneM2M_org_CSE.{i}.CMDH.NetworkAccessECRule.{i}.NetworkAccess Rules
9ab246a740b04002bf9bf7eacc512119
118 106
7.12.7 Resource [cmdhNwAccessRule]
The Resource [cmdhNwAccessRule] define limits in usage of specific underlying networks for forwarding information to other CSEs during processing of CMDH-related requests, see clause D.12.7 of ETSI TS 118 101 [1]. The Resource [cmdhNwAccessRule] is a multi-instance Resource where each instance of the Resource shall map to an instance of Device.X_oneM2M_org_CSE.{i}.CMDH.NetworkAccessECRule.{i} object. The NetworkAccessRule instance shall be created using the Add Object RPC of BBF TR-069 [4]. The NetworkAccessRule instance shall be deleted using the Delete Object RPC of BBF TR-069 [4]. The information of a NetworkAccessRule instance shall be retrieved using the GetParameterValues RPC of BBF TR-069 [4]. The information of a NetworkAccessRule instance shall be updated using the SetParameterValues RPC of BBF TR-069 [4]. Table 7.12.7-1: Resource [cmdhNwAccessRule] Attribute Name of [cmdhNwAccessRule] X_oneM2M_org Parameter targetNetwork Device.X_oneM2M_org_CSE.{i}.CMDH.NetworkAccessRule.{i}.TargetNetworks minReqVolume Device.X_oneM2M_org_CSE.{i}.CMDH.NetworkAccessRule.{i}.MinimumReqVolume backOffParameters Device.X_oneM2M_org_CSE.{i}.CMDH.NetworkAccessRule.{i}.BackoffTime Device.X_oneM2M_org_CSE.{i}.CMDH.NetworkAccessRule.{i}.BackoffTimeIncrement Device.X_oneM2M_org_CSE.{i}.CMDH.NetworkAccessRule.{i}.MaximumBackoffTime otherConditions Device.X_oneM2M_org_CSE.{i}.CMDH.NetworkAccessRule.{i}.OtherConditions allowedSchedule Device.X_oneM2M_org_CSE.{i}.CMDH.NetworkAccessRule.{i}.AllowedSchedule
9ab246a740b04002bf9bf7eacc512119
118 106
7.12.8 Resource [cmdhBuffer]
The Resource [cmdhBuffer] represents limits in usage of buffers for temporarily storing information that needs to be forwarded to other CSEs during processing of CMDH-related requests in a CSE, see clause D.12.8 of ETSI TS 118 101 [1]. The Resource [cmdhBuffer] is a multi-instance Resource where each instance of the Resource shall map to an instance of Device.X_oneM2M_org_CSE.{i}.CMDH.Buffer.{i} object. The Buffer instance shall be created using the Add Object RPC of BBF TR-069 [4]. The Buffer instance shall be deleted using the Delete Object RPC of BBF TR-069 [4]. The information of a Buffer instance shall be retrieved using the GetParameterValues RPC of BBF TR-069 [4]. The information of a Buffer instance shall be updated using the SetParameterValues RPC of BBF TR-069 [4]. ETSI ETSI TS 118 106 V3.6.2 (2021-02) 19 oneM2M TS-0006 version 3.6.2 Release 3 Table 7.12.8-1: Resource [cmdhBuffer] Attribute Name of [cmdhBuffer] X_oneM2M_org Parameter applicableEventCategory Device.X_oneM2M_org_CSE.{i}.CMDH.Buffer.{i}.EventCategories maxBufferSize Device.X_oneM2M_org_CSE.{i}.CMDH.Buffer.{i}.MaximumBufferSize storagePriority Device.X_oneM2M_org_CSE.{i}.CMDH.Buffer.{i}.StoragePriority
9ab246a740b04002bf9bf7eacc512119
118 106
7.13 Resource Type <mgmtCmd>
Each mgmtCmd Resource shall map to BBF TR-069 [4] RPC commands based on the value of cmdType. Accordingly, execReqArgs shall contain arguments related to the corresponding BBF TR-069 [4] RPCs. The details about corresponding procedure mapping are described in clause 8.2. Table 7.13-1: Resource Type <mgmtCmd> Attribute cmdType of mgmtCmd Attribute execReqArgs of mgmtCmd cmdType = RESET Shall include all arguments related to BBF FactoryReset RPC cmdType = REBOOT Shall include all arguments related to BBF Reboot RPC cmdType = UPLOAD Shall include all arguments related to BBF Reboot RPC cmdType = DOWNLOAD Shall contain all arguments related to BBF Reboot RPC cmdType = SOFTWAREINSTALL Shall contain all arguments related to BBF ChangeDUState RPC which shall contain "InstallOpStruct" structure cmdType = SOFTWAREUNINSTALL Shall contain all arguments related to BBF ChangeDUState RPC which shall contain "UninstallOpStruct" structure
9ab246a740b04002bf9bf7eacc512119
118 106
7.14 Resource Type <execInstance>
The <execInstance> resource from ETSI TS 118 104 [2] shall map to BBF CancelTransfer RPC commands when it is disabled/cancelled using a Update operation or deleted using a Delete operation. The details are described in clause 8.2.
9ab246a740b04002bf9bf7eacc512119
118 106
7.15 Resource [registration]
The Resource [registration] represents the configuration information needed to register and AE or CSE with a Registrar CSE. The Resource [registration] is a multi-instance object where the key of the object is the originatorID (i.e. AE-ID, CSE-ID). The following rules are used to determine the object instance based on the originatorID: • When the originatorID resource is for a CSE-ID, the BBF TR-069 [4] object instance Device.X_oneM2M_org_CSE.{i} shall be used for the specified CSE-ID. • When the originatorID resource is for an AE-ID, the BBF TR-069 [4] object instance Device.X_oneM2M_org_AE.{i} shall be used for the specified AE-ID. The information shall be created using the Add Object RPC of BBF TR-069 [4]. The information shall be deleted using the Delete Object RPC of BBF TR-069 [4]. The information shall be retrieved using the GetParameterValues RPC of BBF TR-069 [4]. The capabilities shall be enabled and disabled using the SetParameterValues RPC of BBF TR-069 [4]. ETSI ETSI TS 118 106 V3.6.2 (2021-02) 20 oneM2M TS-0006 version 3.6.2 Release 3 Table 7.15-1: Resource [registration] for CSE Attribute Name of [registration] BBF TR-181 [6] Parameter (X_oneM2M_org_CSE) originatorID ID - See description of the type of object to instantiate poA PointOfAccess externalID ExternalID triggerRecipientID TriggerRecipientID mgmtLink [authenticationProfile] AuthenticationProfile (BBF TR-069 [4] reference parameter that references a row in the Device.X_oneM2M_org_SecuritySolution.AuthenticationProfile table) Table 7.15-2: Resource [registration] for AE Attribute Name of [registration] BBF TR-181 [6] Parameter (X_oneM2M_org_AE) originatorID ID - See description of the type of object to instantiate poA PointOfAccess appID ApplicationID mgmtLink [authenticationProfile] AuthenticationProfile (BBF TR-069 [4] reference parameter that references a row in the Device.X_oneM2M_org_SecuritySolution.AuthenticationProfile table)
9ab246a740b04002bf9bf7eacc512119
118 106
7.16 Resource [dataCollection]
The Resource [dataCollection] represents data collection (measurement) and transmittal (reporting) properties for an AE. The information shall be retrieved using the GetParameterValues RPC of BBF TR-069 [4]. The capabilities shall be enabled and disabled using the SetParameterValues RPC of BBF TR-069 [4]. Table 7.16-1: Resource [dataCollection] Attribute Name of [dataCollection] BBF TR-181 [6] Parameter containerPath ContainerPath reportingSchedule ReportingSchedule measurementSchedule CollectionSchedule
9ab246a740b04002bf9bf7eacc512119
118 106
7.17 Security Solutions
9ab246a740b04002bf9bf7eacc512119
118 106
7.17.1 Introduction
Clauses 7.17.2 to 7.17.6 of the present document contains information on how to map the security specific management resources from ETSI TS 118 122 [8] to managed objects and parameters as defined in the BBF TR-181 [6] data model or the Remote Procedure Calls (RPCs) in BBF TR-069 [4].
9ab246a740b04002bf9bf7eacc512119
118 106
7.17.2 Resource [authenticationProfile]
The Resource [authenticationProfile] represents configuration information regarding establishing mutually-authenticated secure communications. The security principal using this configuration information can be a CSE or AE or the Managed ADN/ASN/MN acting as security principal on behalf of AEs on the Node, see clause 7.1.4 of ETSI TS 118 122 [8]. The Resource [authenticationProfile] is a multi-instance Resource where each instance of the Resource shall map to an instance of Device.X_oneM2M_org_SecuritySolution.AuthenticationProfile.{i} object. The AuthenticationRule instance shall be created using the Add Object RPC of BBF TR-069 [4]. The AuthenticationRule instance shall be deleted using the Delete Object RPC of BBF TR-069 [4]. ETSI ETSI TS 118 106 V3.6.2 (2021-02) 21 oneM2M TS-0006 version 3.6.2 Release 3 The information of a AuthenticationProfile instance shall be retrieved using the GetParameterValues RPC of BBF TR-069 [4]. The information of a AuthenticationProfile instance shall be updated using the SetParameterValues RPC of BBF TR-069 [4]. Table 7.17.2-1: Resource [authenticationProfile] Attribute Name of [authenticationProfile] Parameters of Device.X_oneM2M_org_SecuritySolution.AuthenticationProfile.{i} SUID SUID TLSCiphersuites TLSCiphersuites symmKeyID SymmetricKeyID symmKeyValue SymmetricKeyValue MAFKeyRegLabels MAFKeyRegLabels MAFKeyRegDuration MAFKeyRegDuration mycertFingerprint MyCert (reference) rawPubKeyID RawPubKeyID mgmtLink [trustAnchorCred] TrustAnchorCredentials (list of references) The parameter MyCert is a BBF TR-069 [4] reference parameter that references a row in the Device.Security.Certificate table where the value of the mycertFingerprint attribute matches the value of a Device.Security.Certficate.{i}.X_oneM2M_org_Fingerprint parameter. The X_oneM2M_org_Fingerprint parameter shall be a unique key for the Device.Security.Certificate table. The parameter TrustAnchorCredentials is a list of BBF TR-069 [4] reference parameter where each entry in the list references a row in the Device.X_oneM2M_org_SecuritySolution.TrustAnchorCredential table.
9ab246a740b04002bf9bf7eacc512119
118 106
7.17.3 Resource [trustAnchorCred]
The Resource [trustAnchorCred] represents configuration information regarding certificates provided by certificate authorities used be managed entities to authenticate peer endpoints, see clause 7.1.6 of ETSI TS 118 122 [8]. The Resource [trustAnchorCred] is a multi-instance Resource where each instance of the Resource shall map to an instance of Device.X_oneM2M_org_SecuritySolution.TrustAnchorCredential.{i} object. The TrustAnchorCredential instance shall be created using the Add Object RPC of BBF TR-069 [4]. The TrustAnchorCredential instance shall be deleted using the Delete Object RPC of BBF TR-069 [4]. The information of a TrustAnchorCredential instance shall be retrieved using the GetParameterValues RPC of BBF TR-069 [4]. The information of a TrustAnchorCredential instance shall be updated using the SetParameterValues RPC of BBF TR-069 [4]. Table 7.17.3-1: Resource [trustAnchorCred] Attribute Name of [trustAnchorCred] Parameters of Device.X_oneM2M_org_SecuritySolution.TrustAnchorCredential.{i} certFingerprint Fingerprint URI RemoteTrustStore
9ab246a740b04002bf9bf7eacc512119
118 106
7.17.4 Resource [myCertFileCred]
The Resource [myCertFileCred] represents configuration information regarding certificates presented by the managed entity to remote entities for the establishment of secure communications, see clause 7.1.5 of ETSI TS 118 122 [8]. The Resource [myCertFileCred] is a multi-instance Resource where each instance of the Resource shall map to an instance of Device.Security.Certificate.{i} object. ETSI ETSI TS 118 106 V3.6.2 (2021-02) 22 oneM2M TS-0006 version 3.6.2 Release 3 The Certificate instance shall be created either using the Download RPC of BBF TR-069 [4] or via an out-of-band mechanism. The Certificate instance shall be deleted using the Download RPC of BBF TR-069 [4] or via an out-of-band mechanism. The information of a Certificate instance shall be retrieved using the GetParameterValues RPC of BBF TR-069 [4]. The information of a Certificate instance shall be updated using the SetParameterValues RPC of BBF TR-069 [4]. Table 7.17.4-1: Resource [myCertFileCred] Attribute Name of [myCertFileCred] Parameters of Device.Security.Credential.{i} SUIDs X_oneM2M_org_SUIDs myCertFileFormat X_oneM2M_org_Format myCertFileContent The certificate is downloaded as part of the Download RPC of BBF TR-069 [4] The parameter AuthenticationProfile is a BBF TR-069 [4] reference parameter that references a row in the Device.X_oneM2M_org_SecuritySolution.AuthenticationProfile table where the value of the mycertFingerprint attribute matches the value of a Device.Security.Certficate.{i}.X_oneM2M_org_Fingerprint parameter. The X_oneM2M_org_Fingerprint parameter shall be a unique key for the Device.Security.Certificate table.
9ab246a740b04002bf9bf7eacc512119
118 106
7.17.5 Resource [MAFClientRegCfg]
The Resource [MAFClientRegCfg] represents configuration information that permits a MAF client to register with a MAF, see clause 7.1.7 of ETSI TS 118 122 [8]. The Resource [MAFClientRegCfg] is a multi-instance Resource where each instance of the Resource shall map to an instance of Device.X_oneM2M_org_SecuritySolution.MAFClientRegistration.{i} object. The MAFClientRegistration instance shall be created using the Add Object RPC of BBF TR-069 [4]. The MAFClientRegistration instance shall be deleted using the Delete Object RPC of BBF TR-069 [4]. The information of a MAFClientRegistration instance shall be retrieved using the GetParameterValues RPC of BBF TR-069 [4]. The information of a MAFClientRegistration instance shall be updated using the SetParameterValues RPC of BBF TR-069 [4]. Table 7.17.5-1: Resource [MAFClientRegCfg] Attribute Name of [MAFClientRegCfg] Parameters of Device.X_oneM2M_org_SecuritySolution.MAFClientRegistration.{i} mgmtLink [authenticationProfile\ AuthenticationProfile (BBF TR-069 [4] reference parameter that references a row in the Device.X_oneM2M_org_SecuritySolution.AuthenticationProfile table) fqdn FQDN adminFQDN AdminFQDN httpPort HTTPPort coapPort CoAPPort websocketPort WebsocketPort expirationTime ExpirationTimeStamp
9ab246a740b04002bf9bf7eacc512119
118 106
7.17.6 Resource [MEFClientRegCfg]
The Resource [MEFClientRegCfg] represents configuration information that permits a MEF client to register with a MEF, see clause 7.1.8 of ETSI TS 118 122 [8]. The Resource [MEFClientRegCfg] is a multi-instance Resource where each instance of the Resource shall map to an instance of Device.X_oneM2M_org_SecuritySolution.MEFClientRegistration.{i} object. ETSI ETSI TS 118 106 V3.6.2 (2021-02) 23 oneM2M TS-0006 version 3.6.2 Release 3 The MEFClientRegistration instance shall be created using the Add Object RPC of BBF TR-069 [4]. The MEFClientRegistration instance shall be deleted using the Delete Object RPC of BBF TR-069 [4]. The information of a MEFClientRegistration instance shall be retrieved using the GetParameterValues RPC of BBF TR-069 [4]. The information of a MEFClientRegistration instance shall be updated using the SetParameterValues RPC of BBF TR-069 [4]. Table 7.17.6-1: Resource [MEFClientRegCfg] Attribute Name of [MEFClientRegCfg] Parameters of Device.X_oneM2M_org_SecuritySolution.MEFClientRegistration.{i} mgmtLink [authenticationProfile\ AuthenticationProfile (BBF TR-069 [4] reference parameter that references a row in the Device.X_oneM2M_org_SecuritySolution.AuthenticationProfile table) fqdn FQDN adminFQDN AdminFQDN httpPort HTTPPort coapPort CoAPPort websocketPort WebsocketPort expirationTime ExpirationTimeStamp
9ab246a740b04002bf9bf7eacc512119
118 106
8 Mapping of procedures for management
9ab246a740b04002bf9bf7eacc512119
118 106
8.0 Introduction
This clause contains all information on how to map management resource primitives from ETSI TS 118 104 [2] to the Remote Procedure Calls (RPCs) in BBF TR-069 [4].
9ab246a740b04002bf9bf7eacc512119
118 106
8.1 Resource Type <mgmtObj> primitive mappings
9ab246a740b04002bf9bf7eacc512119
118 106
8.1.0 Introduction
This clause contains all information on how to map Resource Type <mgmtObj> primitives from ETSI TS 118 104 [2] to the Remote Procedure Calls (RPCs) in BBF TR-069 [4].
9ab246a740b04002bf9bf7eacc512119
118 106
8.1.1 Alias-Based Addressing Mechanism
In order to utilize the Alias-Based Addressing Mechanism, the mechanism has to be supported by the ACS and CPE in order to map the M2M Service Layer identifier for the Resource instance to the CPE object instance. If the Alias-Based Addressing Mechanism feature is not supported by either the ACS or CPE, the CSE has to retain the mapping of the these M2M Resource instance identifiers.
9ab246a740b04002bf9bf7eacc512119
118 106
8.1.2 Create primitive mapping
9ab246a740b04002bf9bf7eacc512119
118 106
8.1.2.0 Introduction
The Create Request and Response primitives shall map to the AddObject RPC. The AddObject RPC is defined in BBF TR-069 [4] as a synchronous RPC and returns a successful response or one of the following fault codes in table 8.1.2.0-1. ETSI ETSI TS 118 106 V3.6.2 (2021-02) 24 oneM2M TS-0006 version 3.6.2 Release 3 Table 8.1.2.0-1: AddObject Fault Code Mapping Fault code Description Response Status Code 9001 Request denied (no reason specified) 4000 (BAD_REQUEST) 9002 Internal error 4000 (BAD_REQUEST) 9003 Invalid arguments 4000 (BAD_REQUEST) 9004 Resources exceeded (when used in association with SetParameterValues, this cannot be used to indicate Parameters in error) 4000 (BAD_REQUEST) 9005 Invalid Parameter name (associated with Set/GetParameterValues, GetParameterNames, Set/GetParameterAttributes, AddObject, and DeleteObject) 5001 (NOT_IMPLEMENTED)
9ab246a740b04002bf9bf7eacc512119
118 106
8.1.2.1 M2M Service Layer Resource Instance Identifier mapping
When the Resource is a multi-instance Resource, the AddObject RPC should utilize the Alias-Based Addressing Mechanism as defined in section 3.6.1 of BBF TR-069 [4] in order to use the Resource instance value of the URI.
9ab246a740b04002bf9bf7eacc512119
118 106
8.1.3 Delete primitive mapping
9ab246a740b04002bf9bf7eacc512119
118 106
8.1.3.1 Delete primitive mapping for deletion of Object Instances
The Delete Request and Response primitives that results in the deletion of a Resource shall map to the DeleteObject RPC. The DeleteObject RPC is defined in BBF TR-069 [4] as a synchronous RPC and returns a successful response or one of the following fault codes in table 8.1.3.1-1. Table 8.1.3.1-1: DeleteObject Fault Code Mapping Fault code Description Response Status Code 9001 Request denied (no reason specified) 4000 (BAD_REQUEST) 9002 Internal error 4000 (BAD_REQUEST) 9003 Invalid arguments 4000 (BAD_REQUEST) 9005 Invalid Parameter name (associated with Set/GetParameterValues, GetParameterNames, Set/GetParameterAttributes, AddObject, and DeleteObject) 5001 (NOT_IMPLEMENTED)
9ab246a740b04002bf9bf7eacc512119
118 106
8.1.3.2 Delete primitive mapping for software un-install operation
The Delete Request and Response primitives that results in a software un-install operation (e.g. Resource [software]) shall use the ChangeDUState mechanism defined in BBF TR-069 [4]. The ChangeDUState mechanism is an asynchronous command that consists of the synchronous ChangeDUState RPC for the un-installation request and the asynchronous ChangeDUStateComplete RPC. The ChangeDUState RPC returns a successful response or one of the following fault codes in table 8.1.3.2-1. A successful response means that the CPE has accepted the ChangeDUState RPC. Table 8.1.3.2-1: ChangeDUState Fault Code Mapping Fault code Description Response Status Code 9000 Method not supported 4000 (BAD_REQUEST) 9001 Request denied (no reason specified) 4000 (BAD_REQUEST) 9002 Internal error 4000 (BAD_REQUEST) 9004 Resources exceeded (when used in association with SetParameterValues, this cannot be used to indicate Parameters in error) 4000 (BAD_REQUEST) Once the CPE has attempted to change the state of the deployment unit, the CPE reports the result of the state change operation using the ChangeDUStateComplete RPC. The ChangeDUStateComplete RPC indicates a successful operation or one of the following fault codes in table 8.1.3.2-2. ETSI ETSI TS 118 106 V3.6.2 (2021-02) 25 oneM2M TS-0006 version 3.6.2 Release 3 Table 8.1.3.2-2: ChangeDUStateComplete Fault Code Mapping Fault code Description Response Status Code 9001 Request denied (no reason specified) 4000 (BAD_REQUEST) 9003 Invalid arguments 4000 (BAD_REQUEST) 9012 File transfer server authentication failure (associated with Upload, Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) 9013 Unsupported protocol for file transfer (associated with Upload, Download, ScheduleDownload, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) 9015 File transfer failure: unable to contact file server (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) 9016 File transfer failure: unable to access file (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) 9017 File transfer failure: unable to complete download (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) 9018 File transfer failure: file corrupted or otherwise unusable (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) 9022 Invalid UUID Format (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install, Update, and Uninstall) 4000 (BAD_REQUEST) 9023 Unknown Execution Environment (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install only) 4000 (BAD_REQUEST) 9024 Disabled Execution Environment (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install, Update, and Uninstall) 4000 (BAD_REQUEST) 9025 Deployment Unit to Execution Environment Mismatch (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install and Update) 4000 (BAD_REQUEST) 9026 Duplicate Deployment Unit (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install only) 4000 (BAD_REQUEST) 9027 System Resources Exceeded (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install and Update) 4000 (BAD_REQUEST) 9028 Unknown Deployment Unit (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Update and Uninstall) 4000 (BAD_REQUEST) 9029 Invalid Deployment Unit State (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install, Update and Uninstall) 4000 (BAD_REQUEST) 9030 Invalid Deployment Unit Update - Downgrade not permitted (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Update only) 4000 (BAD_REQUEST) 9031 Invalid Deployment Unit Update - Version not specified (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Update only) 4000 (BAD_REQUEST) 9032 Invalid Deployment Unit Update - Version already exists (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Update only) 4000 (BAD_REQUEST) ETSI ETSI TS 118 106 V3.6.2 (2021-02) 26 oneM2M TS-0006 version 3.6.2 Release 3
9ab246a740b04002bf9bf7eacc512119
118 106
8.1.4 Update primitive mapping
9ab246a740b04002bf9bf7eacc512119
118 106
8.1.4.1 Update primitive mapping for Parameter modifications
The Update Request and Response primitives that modifies the value of Resource attributes shall map to the SetParameterValues RPC. The SetParametersValue RPC is defined in BBF TR-069 [4] as a synchronous RPC and returns a successful response or one of the following fault codes in table 8.1.4.1-1. Table 8.1.4.1-1: SetParameterValues Fault Code Mapping Fault code Description Response Status Code 9001 Request denied (no reason specified) 4000 (BAD_REQUEST) 9002 Internal error 4000 (BAD_REQUEST) 9003 Invalid arguments 4000 (BAD_REQUEST) 9004 Resources exceeded (when used in association with SetParameterValues, this cannot be used to indicate Parameters in error) 4000 (BAD_REQUEST) 9005 Invalid Parameter name (associated with Set/GetParameterValues, GetParameterNames, Set/GetParameterAttributes, AddObject, and DeleteObject) 5001 (NOT_IMPLEMENTED) 9006 Invalid Parameter type (associated with SetParameterValues) 4000 (BAD_REQUEST) 9007 Invalid Parameter value (associated with SetParameterValues) 4000 (BAD_REQUEST) 9008 Attempt to set a non-writable Parameter (associated with SetParameterValues) 4000 (BAD_REQUEST)
9ab246a740b04002bf9bf7eacc512119
118 106
8.1.4.2 Update primitive mapping for upload file transfer operations
The Update Request and Response primitives that results in an upload file transfer operation (e.g. logStop attribute of the Resource [eventLog]) shall use the Upload mechanism defined in BBF TR-069 [4]. The Upload mechanism is an asynchronous command that consists of the synchronous Upload RPC for the Upload and the asynchronous TransferComplete RPC. The Upload RPC returns a successful response or one of the following fault codes in table 8.1.4.2-1. A successful response means that the CPE has accepted the Upload RPC. Table 8.1.4.2-1: Upload Fault Code Mapping Fault code Description Response Status Code 9000 Method not supported 4000 (BAD_REQUEST) 9001 Request denied (no reason specified) 4000 (BAD_REQUEST) 9002 Internal error 4000 (BAD_REQUEST) 9003 Invalid arguments 4000 (BAD_REQUEST) 9004 Resources exceeded (when used in association with SetParameterValues, this cannot be used to indicate Parameters in error) 4000 (BAD_REQUEST) 9011 Upload failure (associated with Upload, TransferComplete or AutonomousTransferComplete methods) 4000 (BAD_REQUEST) 9012 File transfer server authentication failure (associated with Upload, Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) 9013 Unsupported protocol for file transfer (associated with Upload, Download, ScheduleDownload, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) Once the CPE has attempted to upload the file, the CPE reports the result of the Upload operation using the TransferComplete RPC. The TransferComplete RPC indicates a successful operation or one of the following fault codes in table 8.1.4.2-2. ETSI ETSI TS 118 106 V3.6.2 (2021-02) 27 oneM2M TS-0006 version 3.6.2 Release 3 Table 8.1.4.2-2: TransferComplete Fault Code Mapping Fault code Description Response Status Code 9001 Request denied (no reason specified) 4000 (BAD_REQUEST) 9002 Internal error 4000 (BAD_REQUEST) 9010 File transfer failure (associated with Download, ScheduleDownload, TransferComplete or AutonomousTransferComplete methods) 4000 (BAD_REQUEST) 9011 Upload failure (associated with Upload, TransferComplete or AutonomousTransferComplete methods) 4000 (BAD_REQUEST) 9012 File transfer server authentication failure (associated with Upload, Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) 9014 File transfer failure: unable to join multicast group (associated with Download, TransferComplete or AutonomousTransferComplete methods) 4000 (BAD_REQUEST) 9015 File transfer failure: unable to contact file server (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) 9016 File transfer failure: unable to access file (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) 9017 File transfer failure: unable to complete download (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) 9018 File transfer failure: file corrupted or otherwise unusable (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) 9019 File transfer failure: file authentication failure (associated with Download, TransferComplete or AutonomousTransferComplete methods) 4000 (BAD_REQUEST) 9020 File transfer failure: unable to complete download within specified time windows (associated with TransferComplete method) 4000 (BAD_REQUEST)
9ab246a740b04002bf9bf7eacc512119
118 106
8.1.4.3 Update primitive mapping for download file transfer operations
The Update Request and Response primitives that results in a download file transfer operation (e.g. update attribute of Resource [firmware]) shall use the Download mechanism defined in BBF TR-069 [4]. The Download mechanism is an asynchronous command that consists of the synchronous Download RPC for the Download and the asynchronous TransferComplete RPC. The Download RPC returns a successful response or one of the following fault codes in table 8.1.4.3-1. A successful response means that the CPE has accepted the Download RPC. Table 8.1.4.3-1: Download Fault Code Mapping Fault code Description Response Status Code 9000 Method not supported 4000 (BAD_REQUEST) 9001 Request denied (no reason specified) 4000 (BAD_REQUEST) 9002 Internal error 4000 (BAD_REQUEST) 9003 Invalid arguments 4000 (BAD_REQUEST) 9004 Resources exceeded (when used in association with SetParameterValues, this cannot be used to indicate Parameters in error) 4000 (BAD_REQUEST) 9010 File transfer failure (associated with Download, ScheduleDownload, TransferComplete or AutonomousTransferComplete methods) 4000 (BAD_REQUEST) 9012 File transfer server authentication failure (associated with Upload, Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) 9013 Unsupported protocol for file transfer (associated with Upload, Download, ScheduleDownload, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) ETSI ETSI TS 118 106 V3.6.2 (2021-02) 28 oneM2M TS-0006 version 3.6.2 Release 3 Once the CPE has attempted to download the file, the CPE reports the result of the download operation using the TransferComplete RPC. The TransferComplete RPC indicates a successful operation or one of the following fault codes in table 8.1.4.3-2. Table 8.1.4.3-2: TransferComplete Fault Code Mapping Fault code Description Response Status Code 9001 Request denied (no reason specified) 4000 (BAD_REQUEST) 9002 Internal error 4000 (BAD_REQUEST) 9010 File transfer failure (associated with Download, ScheduleDownload, TransferComplete or AutonomousTransferComplete methods) 4000 (BAD_REQUEST) 9011 Upload failure (associated with Upload, TransferComplete or AutonomousTransferComplete methods) 4000 (BAD_REQUEST) 9012 File transfer server authentication failure (associated with Upload, Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) 9014 File transfer failure: unable to join multicast group (associated with Download, TransferComplete or AutonomousTransferComplete methods) 4000 (BAD_REQUEST) 9015 File transfer failure: unable to contact file server (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) 9016 File transfer failure: unable to access file (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) 9017 File transfer failure: unable to complete download (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods). 4000 (BAD_REQUEST) 9018 File transfer failure: file corrupted or otherwise unusable (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods) 4000 (BAD_REQUEST) 9019 File transfer failure: file authentication failure (associated with Download, TransferComplete or AutonomousTransferComplete methods) 4000 (BAD_REQUEST) 9020 File transfer failure: unable to complete download within specified time windows (associated with TransferComplete method) 4000 (BAD_REQUEST)
9ab246a740b04002bf9bf7eacc512119
118 106
8.1.4.4 Update primitive mapping for reboot operation
The Update Request and Response primitives that results in a reboot operation (e.g. reboot attribute of Resource [reboot]) shall use the Reboot RPC defined in BBF TR-069 [4]. The Reboot RPC is asynchronous command. The Reboot RPC returns a successful response or one of the following fault codes in table 8.1.4.4-1. Table 8.1.4.4-1: Reboot Fault Code Mapping Fault code Description Response Status Code 9001 Request denied (no reason specified) 4000 (BAD_REQUEST) 9002 Internal error 4000 (BAD_REQUEST) 9003 Invalid arguments 4000 (BAD_REQUEST)