Device Management using mgmtCmd resource Group Name: WG2/WG5 Source: InterDigital Communications Meeting Date: Agenda Item: TBD

oneM2M-XXX-2013-XXXX Motivations To execute management commands in End Node or Intermediate Node (e.g. M2M Devices or Gateways), is one of DMG CSF’s functions. The Infrastructure Node should be able to expose management resources to M2M Network Applications. The Infrastructure Node should provide general approach or interface for M2M Network Applications to issue management commands. M2M Network Applications do not need to understand underlying management protocols between remote entities and Management Server. Existing Management protocols using non-RESTFUL commands and RPCs (e.g. BBF) need to be enabled through the DMG CSF functionality 2

oneM2M-XXX-2013-XXXX mgmtCmd and execInstance 3 0::1 1 1 “attribute” n execStatus execResult execDisable execRegArgs n “attribute” n execInstances 1 cmdType execReqArgs execEnable 1 1 0::1

oneM2M-XXX-2013-XXXX Attributes: mgmtCmd execInstance Attribute NameMandatory /Optional TypeDescription expirationTimeMRWSee clause 9.X.X Common attributes. accessRightIDMRWSee clause 9.X.X Common attributes. searchStringsMRWSee clause 9.X.X Common attributes. creationTimeMROSee clause 9.X.X Common attributes. lastModifiedTimeMROSee clause 9.X.X Common attributes. descriptionORWthe text-format description of this resource cmdTypeMWOThe type to identify the command (e.g. urn:bbf:tr069:download). execReqArgsORWStructured attribute (e.g. abstract type) to contain any command- specific arguments of the request. execEnableMROThe attribute can be blank without any value or it can contain a URI that can be used to trigger execution of using UPDATE method. 4 Attribute NameMandatory /Optional TypeDescription expirationTimeMROSee clause 9.X.X Common attributes. accessRightIDMRWSee clause 9.X.X Common attributes. creationTimeMROSee clause 9.X.X Common attributes. lastModifiedTimeMROSee clause 9.X.X Common attributes. execStatusMROThe status of. It can be initiated, started, finished, cancelled, or deleted. execResultMROThe execution result of. execDisableORWThe attribute is used to cancel using UPDATE method, execRegArgsORWStructured attribute (e.g. abstract type) to contain any command- specific arguments used to trigger this.

A Simple Use Case Description: An M2M Network Application needs to issue management commands (e.g. Download) to a remote entity (e.g. an M2M device) Required Procedures: – 1: Create a mgmtCmd Either the AE or the CSE itself create a mgmtCmd resource at an Infrastructure Node – 2: Create a command instance for each AE issue Either the AE or the CSE itself create a mgmtCmd resource at an Infrastructure Node Execute a mgmtCmd The M2M Network Application as an AE triggers to execute the mgmtCmd at the Intermediate Node/End Node via the Infrastructure Node. – 3: Retrieve a mgmtCmd The M2M Network Application as an AE retrieves execution results from the Infrastructure Node.

Create mgmtCmd CSE D2 CSE I1 (e.g. Infrastructure Node) Mcc BBF Mgmnt Server (e.g. ACS) BBF Mgmnt Client Ms DM Protocols mgmtCmd (e.g. ) AE A (e.g. M2M Network Application) AE B (e.g. User Application) CSE D1 Mcc OMA Mgmnt Client OMA Mgmnt Server Ms DM Protocols Mca

Execute mgmtCmd CSE D2 CSE I1 (e.g. Infrastructure Node) Mcc BBF Mgmnt Server (e.g. ACS) BBF Mgmnt Client Ms DM Protocols mgmtCmd (e.g. ) execInstanceA1 execInstanceA2 execInstanceB1 execInstanceB2 AE A (e.g. M2M Network Application) Mca AE B (e.g. User Application) Mca CSE D1 Mcc OMA Mgmnt Client OMA Mgmnt Server Ms DM Protocols

Execute mgmtInstance CSE D2 CSE I1 (e.g. Infrastructure Node) Y BBF Mgmnt Server (e.g. ACS) BBF Mgmnt Client Ms DM Protocols mgmtCmd (e.g. ) execInstanceA1 execInstanceA2 execInstanceB1 execInstanceB2 AE A (e.g. M2M Network Application) X AE B (e.g. User Application) X CSE D1 Y OMA Mgmnt Client OMA Mgmnt Server Ms DM Protocols

Execute management commands CSE D2 CSE I1 (e.g. Infrastructure Node) Y BBF Mgmnt Server (e.g. ACS) BBF Mgmnt Client Ms mgmtCmd (e.g. ) execInstanceA1 execInstanceB1 execInstanceC1 execInstanceC2 AE A (e.g. M2M Network Application) X AE B (e.g. M2M Network Application) AE C (e.g. M2M Network Application) X X CSE D1 Y OMA Mgmnt Client OMA Mgmnt Server Ms

Execute mgmtCmd CSE 2 (e.g. Intermediate Node/End Node ) CSE 1 (Infrastructure Node) AE 1 (e.g. M2M Network Application) Y X Management Server (e.g. ACS in BBF TR069) Management Client (e.g. CPE in BBF TR069) Ms DM Protocols Device or Gateway Normal Procedures: Step 1: AE 1 issues UPDATE method to ’s attribute execEnable. Step 2: CSE1 invokes the Management Server to trigger it to execute on Intermediate Node/End Node (i.e. device or gateway). Step 3 & 4: Management Server talks to Management Client using existing mgmt protocols, which could be non-RESTful. Step 5: Management Server passes execution results to CSE 1. Then CSE 1 stores the results in the sub-resource of. mgmtCmd (e.g. )

Retrieve mgmtCmd CSE 2 (e.g. Intermediate Node/End Node ) CSE 1 (e.g. Infrastructure Node) AE 1 (e.g. M2M Network Application) mgmtCmd (e.g. ) Y X Management Server (e.g. ACS in BBF TR069) Management Client (e.g. CPE in BBF TR069) Ms DM Protocols Device or Gateway 1 Normal Procedures: Step 1: AE 1 issues RETRIEVE method to the resource or its sub-resource (e.g. to retrieve execution status and/or execution result of ). Step 2: CSE1 returns a general response which includes the resource representation of the resource as included in Step 1. 2

Summary mgmtCmd provides a RESTful approach for realizing DMG CSF’s function. – i.e. to execute management commands in Intermediate Node/End Node such as devices or gateways. mgmtCmd can reside in Infrastructure Node and is exposed to M2M Network Applications for facilitating them to issue management commands in a RESTful and general manner. – i.e. mgmtCmd provides a unified and RESTful interface for network applications. With mgmtCmd, interactions between DMG CSF and existing Management Servers are hidden from or transparent to M2M Network Applications mgmtCmd supports multiple execution instances of the same command with improved flexibility and reduced overhead. mgmtCmd provides a good approach for conversion between RESTful methods and non-RESTful conventional management commands.