7.12 Resource [cmdhPolicy]
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 TS-0001 [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 TR-069 [4].
The Policy instance shall be deleted using the Delete Object RPC of TR-069 [4].
The information of a Policy instance shall be retrieved using the GetParameterValues RPC of TR-069 [4].
The information of a Policy instance shall be updated using the SetParameterValues RPC of TR-069 [4].
Table 7.12-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 |
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 TS-0001 [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 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. |
7.12.2 Resource [cmdhDefaults]
The Resource [cmdhDefaults] defines default CMDH policy values, see clause D.12.2 of TS-0001 [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 TR-069 [4].
The Default instance shall be deleted using the Delete Object RPC of TR-069 [4].
The information of a Default instance shall be retrieved using the GetParameterValues RPC of TR-069 [4].
The information of a Default instance shall be updated using the SetParameterValues RPC of 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 |
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 TS-0001 [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 TR-069 [4].
The DefaultECRule instance shall be deleted using the Delete Object RPC of TR-069 [4].
The information of a DefaultECRule instance shall be retrieved using the GetParameterValues RPC of TR-069 [4].
The information of a DefaultECRule instance shall be updated using the SetParameterValues RPC of 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}.RequestContextNotificationEnable |
| requestCharacteristics | Device.X_oneM2M_org_CSE.{i}.CMDH.DefaultECRule.{i}.RequestCharacteristics |
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 TS-0001 [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 TR-069 [4].
The DefaultECParamRule instance shall be deleted using the Delete Object RPC of TR-069 [4].
The information of a DefaultECParamRule instance shall be retrieved using the GetParameterValues RPC of TR069 [4].
The information of a DefaultECParamRule instance shall be updated using the SetParameterValues RPC of 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 |
7.12.5 Resource [cmdhLimits]
The Resource [cmdhLimits] represents limits for CMDH related parameter values, see clause D.12.5 of TS-0001 [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 TR-069 [4].
The Limit instance shall be deleted using the Delete Object RPC of TR-069 [4].
The information of a Limit instance shall be retrieved using the GetParameterValues RPC of TR-069 [4].
The information of a Limit instance shall be updated using the SetParameterValues RPC of 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 |
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 TS-0001 [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 TR-069 [4].
The NetworkAccessECRule instance shall be deleted using the Delete Object RPC of TR-069 [4].
The information of a NetworkAccessECRule instance shall be retrieved using the GetParameterValues RPC of TR069 [4].
The information of a NetworkAccessECRule instance shall be updated using the SetParameterValues RPC of TR069 [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}.NetworkAccessRules |
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 TS-0001 [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 TR-069 [4].
The NetworkAccessRule instance shall be deleted using the Delete Object RPC of TR-069 [4].
The information of a NetworkAccessRule instance shall be retrieved using the GetParameterValues RPC of TR-069 [4].
The information of a NetworkAccessRule instance shall be updated using the SetParameterValues RPC of 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 |
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 TS-0001 [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 TR-069 [4].
The Buffer instance shall be deleted using the Delete Object RPC of TR-069 [4].
The information of a Buffer instance shall be retrieved using the GetParameterValues RPC of TR-069 [4].
The information of a Buffer instance shall be updated using the SetParameterValues RPC of TR-069 [4].
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 |