8.1 <mgmtObj> life cycle procedures

8.1.1 Introduction

The life cycle of the <mgmtObj> resource in the Hosting CSE(IN-CSE) is established either through the:

• Provisioning of the <mgmtObj> resource by the Configuration AE.
• Discovery of the <mgmtObj> resource by the Hosting CSE using the methods described in clause 6.1.

8.1.2 Setting configuration information on <mgmtObj> resource

The Configuration AE is able to configure the <mgmtObj> resources used for device configuration by either creating the <mgmtObj> resource or updating existing <mgmtObj> resources for the targeted AE or CSE. Likewise, the Configuration AE can delete the <mgmtObj> resource as part of a decommissioning process.

In some scenarios the <mgmtObj> resource may already exist due to pre-provisioning or a previous discovery action by the IN-CSE's interaction with the Configuration IPE, DM Server or ASN/MN or ADN node. As such the Configuration AE needs to first discover if the <mgmtObj> resource exists in the Hosting CSE. As <mgmtObj> resources are represented under the <node> resource of the ASN/MN or ADN node, the discovery operation's scope can use the <node> resource within the discovery criteria. Based on the results of the discovery the Configuration AE will either create or update the <mgmtObj> resource. Figure 8.1.2-1 depicts this flow.

Figure 8.1.2-1: Configuring attributes of a <mgmtObj> resource

Likewise, the Configuration AE may use the same approach to discover when deleting the <mgmtObj> resource as part of a decommissioning process or retrieval of the <mgmtObj> resource.

Note

In order for the IN-CSE to forward the request onto the DM Server, the <mgmtObj> resource is required to be configured with the path to the resource in the context of the technology specific protocol (e.g. LWM2M URI [i.4], OMA-DM path [i.3], BBF TR-069 path [i.2]). The fully qualified domain name can also be used if the IN-CSE does not know the address of the DM Server.

8.1.3 Management of <mgmtObj> resource on ASN/MN/ADN nodes

8.1.3.1 Introduction

Management of the <mgmtObj> object resources on ASN/MN or ADN nodes may be managed using one of the architectural methods described in clause 6.1.

8.1.3.2 Management using device management technologies

Clause 10.2.8 '<mgmtObj> Resource Procedures' of oneM2M TS-0001 [2] describes the procedures for M2M Nodes to represent their technology specific data as oneM2M resources within the IN-CSE.

Figure 8.1.3.2-1: Management using Device Management technologies

1. The Configuration AE issues a request for <mgmtObj> resource for an ASN/MN/ADN node that is managed using Device Management technologies.
2. The IN-CSE processes the request issued by Configuration AE.
3. The IN-CSE executes the Device Management command which is mapped from operation on <mgmtObj> resource to external management technologies.
4. The ASN/MN/ADN then creates, updates, deletes or retrieve the configuration parameters on the node, and returns the result of Device Management command.

8.1.3.3 Management using the Mca or Mcc reference point

Once M2M Service Layer operation is established between the AE or CSE and the Registrar/Hosting CSE, <mgmtObj> resources may be managed using the Mca or Mcc reference point by the AE or CSE respectively subscribing to receive changes to the <mgmtObj> resource using the subscription procedures defined in clause 10.2.11 of oneM2M TS-0001 [2]. Establishment of the M2M Service Layer operations includes actions such as establishing the appropriate security associations and registration of the CSEs and AEs.

Figure 8.1.3.3-1: Management using the Mca or Mcc reference point

1. Once M2M Service Layer operation is established, the AE or CSE on the ASN/MN/ADN node subscribes to the <mgmtObj> resource which is associated with the specific M2M Application functionality creating <subscription> resource.
2. When the Configurator AE creates, updates or delete the <mgmtObj> resource, the Configuration AE issues a request on the <mgmtObj> resource.
3. The Hosting CSE for the <mgmtObj> resource performs the operation on the resource as Receiver.
4. The Hosting CSE notifies the subscribed AE or CSE as the subscribed event message.
5. The AE or CSE configures the M2M Application on the ASN/MN or ADN node.

Alternatively, <mgmtObj> specializations hosted by the IN-CSE may be announced to a CSE on a MN or ASN node depending on whether the <mgmtObj> specialization type is announceable. If a <mgmtObj> specialization type is not announceable, the MN or ASN nodes shall be managed using the subscription mechanism as shown in the Figure 8.1.3.3-1.

The following <mgmtObj> specializations specified in the present document are announceable (i.e. announceable variants of this resource type are defined in the XSD of the respective <mgmtObj> specialization):

• [registration], [dataCollection]

The following <mgmtObj> specializations specified in the present document are not announceable (i.e. announceable variants of this resource type are not defined in the XSD of the respective _<mgmtObj> specialization):

• [authenticationProfile], [myCertFileCred], [trustAnchorCred], [MAFClientRegCfg], [MEFClientRegCfg], [OAuth2Authentication], [wificlient], [credentials]

When a <mgmtObj> specialization is announced to a CSE on a MN or ASN node, a <mgmtObjAnnc> resource specialization is created in this CSE. The AE residing on the same node as the CSE may subscribe to the <mgmtObjAnnc> specialization for receiving notifications when the original <mgmtObj> is updated by the Configuration AE.

8.1.3.4 Management using the oneM2M IPE technology

When ASN/MN or ADN nodes are configured using a Configuration IPE, the ASN/MN/ADN may periodically request the Configuration IPE to configure the ASN/MN/ADN node. The method that the ASN/MN/ADN uses to periodically request to be configured is unspecified in the present document. Once the Configuration IPE receives the request from the ASN/MN/ADN node, the Configuration IPE shall send a retrieve request to the Hosting CSE to obtain the applicable specialization of <mgmtObj> resources for the ASN/MN/ADN node. How the Configuration IPE maintains the mapping between the ASN/MN/ADN and the associated <node> and <mgmtObj> resources is unspecified in the present document.

Figure 8.1.3.4-1: Management using oneM2M IPE technology

1. The Configuration AE issues a CRUD request to <mgmtObj> resource which is associated with the functionality of targeted field device.
2. The Hosting CSE processes the CRUD request.
3. When the ASN/MN/ADN determines it needs to be configured, the ASN/MN/ADN issues a request to the Configuration IPE.
4. The Configuration IPE determines <mgmtObj> resource to refer as the source of configuration parameter for the targeted field device, and issues an operation on the <mgmtObj> or <node> resource.
5. When the RETRIEVE request is successfully performed, the Configuration IPE transforms the <mgmtObj> resource into a form understandable by ASN/MN/ADN node.
6. The ASN/MN/ADN configures setting parameters for the M2M Application.

Note

One possible method of exchanging information between the Configuration IPE and the ASN/MN/ADN is to simply serialize the <mgmtObj> resource using the MIME content types defined in clause 6.7 of oneM2M TS-0004 [4] 'oneM2M specific MIME media types'.