Open APIs

Expand all | Collapse all

Device management API's

  • 1.  Device management API's

    TM Forum Member
    Posted Jan 14, 2020 06:18
    Hello All,

    For operations to be performed on a device (CPE) like a modem or a hub, example reset your CPE or check device speed etc, what would be the corresponding open API?

    Thank you for your help

    Warm Regards,

    ------------------------------
    Suman Bagde

    ------------------------------


  • 2.  RE: Device management API's

    TM Forum Member
    Posted Jan 15, 2020 03:28
    Edited by Vance Shipley Jan 15, 2020 03:32
    Each of these would be represented with  a base class type of Resource and so you could use TMF639 Resource Inventory Management API to locate them. 
    If you provide a characteristic for device speed you could query with TMF639 to get the value.
    Where you really need to support conceptual operations you should implement a task resource as described in TMF630 section 8: Task Resource Pattern.  Your new (sub)resource should be named as a verb so in your case simple synchronous tasks might  be something like:
    POST /resourceInventoryManagement/v4/resource/42/checkSpeed
    Accept: application/json
    Content-Length: 0
     
    HTTP/1.1 200 OK
    Content-Type: application/json
    Content-Length: 25
    {
         "deviceSpeed": "10M"
    }
    ... and:
    POST /resourceInventoryManagement/v4/resource/42/reset
    Content-Length: 0
     
    HTTP/1.1 204 No Content
    Content-Length: 0
     
    A more sophisticated implementation may respond asynchronously with a created task resource and support a monitor. This is documented in TMF630 section 8.





  • 3.  RE: Device management API's

    TM Forum Member
    Posted Jan 16, 2020 02:49
    Thanks very much Vance.

    ------------------------------
    Suman Bagde
    Infosys
    ------------------------------



  • 4.  RE: Device management API's

    Posted Jan 15, 2020 08:40
    Hi Suman
    Who is exposing the API? Is it the device itself or a cloud entity like an ACS that acts as a mediator?

    Best regards,
    Oru

    ------------------------------
    Ori Lior
    GlobalLogic
    ------------------------------



  • 5.  RE: Device management API's

    TM Forum Member
    Posted Jan 16, 2020 02:47
    Hello,

    API will not be exposed by the device but a mediator

    Warm Regards,
    Suman

    ------------------------------
    Suman Bagde
    Infosys
    ------------------------------



  • 6.  RE: Device management API's

    Posted Jan 16, 2020 02:00
    Edited by Ori Lior Jan 16, 2020 02:00
    Anyway, my two cents - Assuming you mean to expose these APIs by a CPE as a replacement to TR-069, none of the TMF APIs is really suitable for this purpose, they are more suitable for B2B / M2M use cases and interaction between cloud based systems.
    I recommend to have a look at the work being done by the prpl foundation (high level APIs)

    Good luck,

    ------------------------------
    Ori Lior
    GlobalLogic
    ------------------------------