oneM2M TS-0006Release Notes diff from v5.0.1 to v5.0.0oneM2M TS-0006Release Notes diff from v5.0.1 to v5.0.0This clause contains all information on how to map management resources from oneM2M TS-0004 [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].
BBF TR-069 [4] specifies a protocol for communication between a CPE (Customer Premises Equipment) and an ACS (Auto-Configuration Server (ACS). Any BBF 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").
The Device identifiers for CPEs are mapped to the Resource Types [deviceInfo].
For CPE and Virtual Devices map their Device Identifiers (OUI-[PC-]SN) to the manufacturer, deviceType and deviceLabel attributes of the Resource [deviceInfo].
For Embedded Devices, the ControllerID and ProxiedDeviceID parameters of the Device.ManagementServer.EmbeddedDevice.{i} object instance are mapped to the deviceLabel attribute of the Resource [deviceInfo] as a comma separated list: "Device.ManagementServer.EmbeddedDevice.{i}.ControllerID, Device.ManagementServer.EmbeddedDevice.{i}.ProxiedDeviceID".
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(R)®, UpPnP™).
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.
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. |
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: |
manufacturer
|
No mapping available
|
model
|
No mapping available
|
deviceType
|
No mapping available
|
fwVersion
|
No mapping available
|
swVersion
|
No mapping available
|
hwVersion
|
No mapping available
|
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.
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
|
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
|
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
|
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].
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 |
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
|
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 |
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".
|
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:
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.8‑1: Resource [deviceCapability]
Attribute Name of [deviceCapability]
|
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.
|
Attribute Name of [deviceCapability] |
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:
|
|
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.
|
|
The Resource [firmware] represents a firmware instance and is not considered a BBF 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 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 shall 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 |
RPC Download Arguments
|
|---|---|
URL
|
URL
|
update
|
When set to the value of "True" executes the Download operations with a FileType "1 Firmware Upgrade Image" |
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: |
|
DelaySeconds: 0 (immediate)
|
|
SuccessURL: |
|
FailureURL: |
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.
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. |
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:
|
|
activate
|
The action that activates software previously installed.
|
|
deactivate
|
The action that deactivates software.
|
|
activeStatus
|
Status is defined as:
|
|
Table 7.10‑2: RPC ChangeDUState:InstallOpStruct Arguments
Notes
| |
|---|---|
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.
|
Execu |
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: |
|
Name
|
Notes
|
UUID
|
UUID of the DU that was installed - Maintained by the CSE.
|
ExecutionEnvRef
|
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].
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
Notes
| |
|---|---|
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.
|
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 oneM2M 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 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‑1: Resource [cmdhPolicy]
Attribute Name of |
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
|
The Resource [activeCmdhPolicy] provides a link to the currently active set of CMDH policies, see clause D.12.1 of oneM2M 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 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. |
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. |
|
The Resource [cmdhDefaults] defines default CMDH policy values, see clause D.12.2 of oneM2M 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 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 |
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
|
The Resource [cmdhDefEcValue] represents a value for the ec (event category) parameter of an incoming request, see clause D.12.3 of oneM2M 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 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 |
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
|
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 oneM2M 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 BBF TR-069 [4].
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 |
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
|
The Resource [cmdhLimits] represents limits for CMDH related parameter values, see clause D.12.5 of oneM2M 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 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 |
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
|
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 oneM2M 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 BBF TR-069 [4].
The NetworkAccessECRule instance shall be deleted using the Delete Object RPC of BBF TR-069 [4].
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 |
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
|
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 oneM2M 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 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
|
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
|
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 oneM2M 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 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].
Table 7.12.8‑1: Resource [cmdhBuffer]
Attribute Name of |
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
|
Each mgmtCmd Resource shall map to BBF TR-069 RPC commands based on the value of cmdType. Accordingly, execReqArgs shall contain arguments related to the corresponding BBF TR-069 RPCs. The details about corresponding procedure mapping are described in clause 8.2.
Table 7.13‑1: Resource Type
Attribute cmdType of |
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.
|
The
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:
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].
Table 7.15‑1: Resource [registration] for CSE
Attribute Name of |
BBF TR-181 [6] Parameter (X_oneM2M_org_CSE)
|
|---|---|
originatorID
|
ID - See description of the type of object to instantiate.
|
poA
|
PointOfAccess
|
CSEBase
|
CSEBase - Resource-ID of the CSEBase of Registrar CSE.
|
CSE-ID
|
CSEID - CSE-ID of the Registrar CSE.
|
externalID
|
ExternalID
|
triggerRecipientID
|
TriggerRecipientID
|
mgmtLink [authenticationProfile]
|
AuthenticationProfile (BBF TR-069 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 |
BBF TR-181 [6] Parameter (X_oneM2M_org_AE)
|
|---|---|
originatorID
|
ID - See description of the type of object to instantiate.
|
poA
|
PointOfAccess
|
CSEBase
|
CSEBase - Resource-ID of the CSEBase of Registrar CSE.
|
CSE-ID
|
CSEID - CSE-ID of the Registrar CSE.
|
appID
|
ApplicationID
|
mgmtLink [authenticationProfile]
|
AuthenticationProfile (BBF TR-069 reference parameter that references a row in the Device.X_oneM2M_org_SecuritySolution.AuthenticationProfile table)
|
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
|
This clause contains information on how to map the security specific management resources from oneM2M TS-0022 clauses in the section of the present document contains information on how to map the security specific management resources from TS-0022 [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].
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 oneM2M TS-0022 [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].
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 |
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 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 reference parameter where each entry in the list references a row in the Device.X_oneM2M_org_SecuritySolution.TrustAnchorCredential table.
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 oneM2M TS-0022 [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 |
Parameters of Device.X_oneM2M_org_SecuritySolution.TrustAnchorCredential.{i}
|
|---|---|
certFingerprint
|
Fingerprint
|
URI
|
RemoteTrustStore
|
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 oneM2M TS-0022 [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.
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 |
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
|
The parameter AuthenticationProfile is a BBF TR-069 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.
The Resource [MAFClientRegCfg] represents configuration information that permits a MAF client to register with a MAF, see clause 7.1.7 of oneM2M TS-0022 [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 |
Parameters of Device.X_oneM2M_org_SecuritySolution.MAFClientRegistration.{i}
|
|---|---|
mgmtLink [authenticationProfile |
AuthenticationProfile (BBF TR-069 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
|
Editor note: Correct mgmtLink row above( -> [authenticationProfile] )
The Resource [MEFClientRegCfg] represents configuration information that permits a MEF client to register with a MEF, see clause 7.1.8 of oneM2M TS-0022 [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.
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 |
Parameters of Device.X_oneM2M_org_SecuritySolution.MEFClientRegistration.{i}
|
|---|---|
mgmtLink [authenticationProfile |
AuthenticationProfile (BBF TR-069 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
|
Editor note: Correct mgmtLink row above( -> [authenticationProfile] )