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

2. Motivations
DMG CSF should provide functionality for execution of management commands in End or Intermediate Nodes (e.g. M2M Devices or Gateways)
The Infrastructure Node should be able to expose management resources to M2M Network Applications.
The Infrastructure Node should provide a general approach and interface for M2M Network Applications to issue management commands.
M2M Network Applications may 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) should be enabled through the DMG CSF functionality

3. Basic Procedures A: Create <mgmtCmd> B: Execute <mgmtCmd>
Description: An M2M AE needs to issue management commands (e.g. Download) to an End Node (e.g. an M2M device)
A: Create <mgmtCmd>
Either the AE or the CSE itself creates a <mgmtCmd> resource at an Infrastructure Node (i.e. <IN-CSE 1>)
B: Execute <mgmtCmd>
The M2M Network Application as an AE sends an UPDATE to “<mgmtCmd>/exexEnable” to trigger the execution of the <mgmtCmd> at the End Node via the Infrastructure Node
UPDATE “…/<mgmtCmd>/execEnable”
This step will trigger the creation of command instance(s) (i.e. <mgmtCmd>/execInstances/<execInstance>)
C: Retrieve <mgmtCmd>
The M2M Network Application as an AE retrieves execution results from the Infrastructure Node (i.e. <IN-CSE01>).
RETRIEVE “…/<mgmtCmd>/execInstances/<execInstance>”

4. mgmtCmd Attributes:
E.g.: Device Information , Firmware, Software , Device Information, Battery, Memory, etc.
Attribute Name
Mandatory
/Optional
Type
Description
expirationTime M RW
See clause Common attributes.
accessRightID
See clause Common attributes.
searchStrings
creationTime RO
lastModifiedTime
description O
the text-format description of this resource
cmdType WO
The type to identify the command (e.g. download, reboot, etc.).
execReqArgs
Structured attribute (e.g. abstract type) to contain any command-specific arguments of the request.
execEnable
The attribute can be blank without any value or it can contain a URI that can be used to trigger execution of <mgmtCmd> using UPDATE method.
The arguments allow the IN-CSE to map the management command to the appropriate underlying management technology. The application will be management technology agnostic.

5. Create mgmtCmd Device or Gateway AE 1 CSE 1 CSE 2 mgmtCmd
(e.g. Infrastructure Node)
AE 1
(e.g. M2M Network Application)
Device or Gateway
Mca
CSE 2
(e.g. Intermediate Node/End Node ) 1
Mcc 2
mgmtCmd
(e.g. <mgmtCmd1>)
Normal Procedures:
Step 1: AE 1 issues CREATE method to create a new mgmtCmd (e.g. <mgmtCmd1>).
Step 2: CSE1 create s a new mgmtCmd resource. (e.g. <mgmtCmd1>) an sends the response back to AE 1. Ms
Management Client
(e.g. CPE in BBF TR069)
Management Server
(e.g. ACS in BBF TR069) DM
Protocol
CRUD Request
Response

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

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

8. Use Case
One M2M Network Application performing management operations (e.g. SW download) for multiple devices and multiple management technologies

9. Creation of resource(s)
OMA Mgmt Client
(i.e. DMC)
OMA Mgmt Server
(i.e. DMS)
Only one resource may be created , with multiple execInstances. The AE may use execEnable to execute the command one or more times, or it may use execInstance’s cheduling parameters
DM Protocol
(e.g. OMA DM) M2 M1 Ms
CSE I1
(e.g. Infrastructure Node)
CSE M1
Mcc
mgmtCmd <mgmtCmdDownloadA>
execInstanceM1
execInstanceM2
execInstanceN1
execinstanceN2
AE A
(e.g. M2M Network Application)
Mca
CSE N1
Mcc N2 N1 Ms
Each execInstance may have different arguments for scheduling or map through execReqArgs to a different management technology
BBF Mgmt Client (i.e. CPE)
BBF Mgmt Server
(i.e. ACS)
DM Protocol
(e.g. BBF CWMP)

10. mgmtCmd and execInstance
0::1 1
<execInstance>
“attribute” n
execStatus
execResult
execDisable
execMode
execNumber
execDelay
execReqArgs
execFrequency
execTarget
<mgmtCmd>
“attribute” n
execInstances 1
cmdType
execReqArgs
execEnable
0::1

11. <execInstance> Attributes:
Attribute Name
Mandatory/Optional
Type
Description
expirationTime M RO
See clause Common attributes.
accessRightID RW
creationTime
lastModifiedTime
execStatus
The status of <execInstance>. It can be initiated, started, finished, cancelled, or deleted.
execResult
The execution result of <execInstance>.
execDisable O
The attribute is used to cancel <execInstance> using UPDATE method.
execTarget
URI of the target on which the management command will be executed.
execMode
Modes used to specify how the command will be executed, e.g. Immediate Once, Immediate and Repeatedly, Random Once, Random and Repeatedly. In case repetition is required, the interval between two executions is specified by execFrequency.
execFrequency
The interval between two executions when execMode requires repetitions (i.e. Immediate and Repeatedly, or Random and Repeatedly).
execDelay
The delay before the instance should be executed.
execNumber
The number of times the instance should be executed.
execReqArgs
Structured attribute (e.g. abstract type) to contain any command-specific arguments used to trigger this <execInstance>.
Each execution may have a different status, which is exposed to the AE
If execution is disabled, the IN-CSE will notify the End Node and then delete the <execInstance>
Each instance can be executed with different arguments

12. Summary
mgmtCmd provides a RESTful and Abstracted approach for realizing DMG CSF’s function.
Provides generaliszd, RESTful methods to execute management commands in Intermediate Node/End Nodes such as devices or gateways.
The resource may reside in IN-CSE and be created by an AE or the CSE itself.
It exposes information such as execution status, arguments, etc. to the AEs
mgmtCmd allows interactions between DMG CSF and existing Management Servers to be transparent to and hidden from M2M Network Applications
mgmtCmd supports multiple execution instances of the same command with improved flexibility and reduced overhead.
RESTful methods can be applied for all execInstances under the same <mgmtCmd>, e.g. CREATE, DELETE
Execution of individual commands can be scheduled and/or triggered independently. Individual execInstances can be disabled.
Independent arguments allow for execution flexibility, including mapping to various management technologies
mgmtCmd provides a flexible approach for conversion between RESTful methods and non-RESTful conventional management commands.