6.6 New LwM2M Objects

6.6.0 Introduction

These LwM2M Objects are specified by oneM2M organization. They have to be registered using the process defined by OMNA (Open Mobile Naming Authority).

The Object ID (e.g. "X") of the LwM2M Objects specified here, shall be allocated by OMNA, and will be in the range [2 048 - 10 240]

6.6.1 LwM2M CMDH Policy Objects

6.6.1.0 Introduction

The LwM2M Objects specified here are used for mapping the CMDH Policy Resources defined in oneM2M

This oneM2M CMDH Policy mapping is addressed through the specification of 10 specific LwM2M Objects registered in OMNA:

CmdhPolicy Object
(urn:oma:lwm2m:ext:2048)
ActiveCmdhPolicy Object
(urn:oma:lwm2m:ext:2049)
CmdhDefaults
(urn:oma:lwm2m:ext:2050)
CmdhDefEcValue Object
(urn:oma:lwm2m:ext:2051)
CmdhEcDefParamsValues Object
(urn:oma:lwm2m:ext:2052)
CmdhLimits Object
(urn:oma:lwm2m:ext:2053)
CmdhNetworkAccessRules Object
(urn:oma:lwm2m:ext:2054)
CmdhNwAccessRule Object
(urn:oma:lwm2m:ext:2055)
CmdhBuffer Object
(urn:oma:lwm2m:ext:2056)
CmdhBackOffParametersSet Object
(urn:oma:lwm2m:ext:2057)

6.6.1.1 CmdhPolicy Object

This Object provides links to set of rules associated with a specific CSE that governs the behavior of that CSE regarding rejecting, buffering and sending request or response messages via the Mcc reference point.

Table 6.6.1.1-1: Object definition

Name	Object ID	Instances	Mandatory	Object URN
CmdhPolicy	2048	Multiple	Optional	urn:oma:lwm2m:ext:2048

Table 6.6.1.1-2: Resource definitions

ID	Name	Operations	Instances	Mandatory	Type	Description
0	Name	RW	Single	Mandatory	String	Contains the name of a CmdhPolicy Object Instance
1	DefaultRule	RW	Single	Mandatory	Objlink	1 reference to CmdhDefaults Object Instance
2	LimitRules	RW	Multiple	Mandatory	Objlink	1 or more references to CmdhLimits Object Instances
3	NetworkAccessECRules	RW	Multiple	Mandatory	Objlink	1 or more references to CmdhNetworkAccessRules Object Instances
4	BufferRules	RW	Multiple	Mandatory	Objlink	1 or more references to CmdhBuffer Object Instances

6.6.1.2 ActiveCmdhPolicy Object

This Object provides a link to the currently active set of CMDH policies

Table 6.6.1.2-1: Object definition

Name	Object ID	Instances	Mandatory	Object URN
ActiveCmdhPolicy	2049	Single	Optional	urn:oma:lwm2m:ext:2049

Table 6.6.1.2-2: Resource definitions

ID	Name	Operations	Instances	Mandatory	Type	Range or Enumeration	Units	Description
0	ActiveLink	RW	Single	Mandatory	Objlink			Contains the reference to the CMDH policies (CmdhPolicy Object Instance) currently active for the associated CSE.

6.6.1.3 CmdhDefaults Object

Defines which CMDH related parameters will be used by default when a request or response message contains the Event Category parameter but not any other CMDH related parameters and which default Event Category parameter shall be used when none is given in the request or response message.

Table 6.6.1.3-1: Object definition

Name	Object ID	Instances	Mandatory	Object URN
CmdhDefaults	2050	Multiple	Optional	urn:oma:lwm2m:ext:2050

Table 6.6.1.3-2: Resource definitions

ID	Name	Operations	Instances	Mandatory	Type	Range or Enumeration	Units	Description
0	DefEcRules	RW	Multiple	Mandatory	Objlink			1 or more references to CmdhDefEcValue Object Instances containing default values for the ec (event category) parameter of an incoming request or response when this parameter is not indicated in the message itself
1	EcDefParamRules	RW	Multiple	Mandatory	Objlink			1 or more references to CmdhEcDefParamValues Object Instances

6.6.1.4 CmdhDef EcValues Object

This Object represents default set of values for the Event Category parameter of an incoming request or response message.

Table 6.6.1.4-1: Object definition

Name	Object ID	Instances	Mandatory	Object URN
CmdhDefECValues	2051	Multiple	Optional	urn:oma:lwm2m:ext:2051

Table 6.6.1.4-2: Resource definitions

ID	Name	Operations	Instances	Mandatory	Type	Description
0	Order	RW	Single	Mandatory	Integer	Contains an index defining the order of processing this CmdhDefEcValue Object Instance will be handled
1	DefEcValue	RW	Single	Mandatory	String	Represents the default Event category value to be applied when the conditions given in this Object Instance are matched
2	RequestOrigin	RW	Multiple	Mandatory	String	List of zero or more Local AE-IDs, App-IDs, or the strings "localAE" or "thisCSE"
3	RequestContext	RW	Single	Optional	String	Contains the requestContext information of this Object Instance which needs to be matched
4	RequestContextNotification	RW	Single	Optional	Boolean	Contains true/false flag indicating whether or not notification procedures apply.
5	RequestCharacteristics	RW	Single	Optional	String	Represents conditions pertaining to the request itself, (e.g. the requested *Response Type* ) than needs to be matched

6.6.1.5 CmdhEcDefParamValues Object

This 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	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
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

6.6.1.6 CmdhLimits Object

This 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 CmdhLimitsObject 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 CmdhLimitsObject Instance is applicable.
3	RequestContextNotification	RW	Single	Optional	Boolean			Contains true/false flag indicating whether or not notification procedures apply.
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
10	LimitsDelAggregation	RW	Multiple	Mandatory	String			Contains the permitted settings of the DeliveryAggregation parameter of request primitives. '0' means 'False' '1' means 'True' '0 1' means 'False' or 'True'

6.6.1.7 CmdhNetworkAccessRules Object

This 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

6.6.1.8 CmdhNwAccessRule Object

This 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	Units	Description
0	TargetNetwork	RW	Multiple	Mandatory	String		Contains identifiers of Underlying networks
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 C_mdhNwAccessRule_ 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 CmdhNwAccessRuleObject 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 Protocol TS-0004

6.6.1.9 CmdhBuffer Object

This 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

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. t Buffered requests associated with a lower storage priority shall be purged before buffered requests with a higher storage priority.

6.6.1.10 CmdhBackOffParametersSet Object

This 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
CmdhBackOffParametersSet	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 tme.
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	OptionalRandomBackoffTime	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.