Open APIs

Expand all | Collapse all

TMF API to be used for listing network elements' specification to a location

  • 1.  TMF API to be used for listing network elements' specification to a location

    Posted 4 days ago
    Hi Team,

    Could someone please help me to understand which TMF API I should use to query/list the network paths to a location?

    Many devices are used to provide service to particular location from a hub.
    There are many path to provide same service to a location from a hub.
    For a given location, I need to list all the paths.
    A path is consist of may devices and path will contain the details of devices.

    Thanks.

    ------------------------------
    Santosh Daharia
    TO BE VERIFIED
    ------------------------------


  • 2.  RE: TMF API to be used for listing network elements' specification to a location

    TM Forum Member
    Posted 3 days ago
    How about starting with TMF639 - resource inventory (assets available at the Open API table here)
    Your query would be on the Place of the Resource.
    But it might be that a planned Topology API would be a better fit, so @Dave Milham and @Yuval Stein, who are working on design for this API, might want to relate to your use case.
    Hope it helps​​

    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
    ------------------------------



  • 3.  RE: TMF API to be used for listing network elements' specification to a location

    TM Forum Member
    Posted 3 days ago
    Yes the Topology Graph API could be a way to do this. It is based on creating a discovered graph form multiple inventories which have the majority ( but note all)  of the source information on these kind of relationships. However we haven't quite finished it yet. But more help welcome. The requirement whcih you could use to assess suitability are in

    TR283 Business Requirements for a Multi-layer Topology Discovery Service v1.0.0



    ------------------------------
    Dave Milham
    TM Forum, Chief Architect
    ------------------------------



  • 4.  RE: TMF API to be used for listing network elements' specification to a location

    Posted 3 days ago
    @Dave Milham, Thanks for the resources you provided.

    Could you please also help me with a link where I can see related data models for TR283?

    Apologies for asking. Not sure where to look for a data-model for this. I could not find any related to this in the Open API table.

    Thanks,

    ------------------------------
    Santosh Daharia
    TO BE VERIFIED
    ------------------------------



  • 5.  RE: TMF API to be used for listing network elements' specification to a location

    TM Forum Member
    Posted 2 days ago
    If you are a TM forum member you can look a the the draft on the ODA project at
    TMF920A Topology Discovery Service Management API Component Suite Profile (ODA-553) - Open Digital Architecture Project - TM Forum Confluence
    this captures the graph Vertex Entity model.  in sectoin

    5.1.1.2. Draft Proposal Using Tooling


    I see Vance has responded and his proposal might be a simpler solution on the short term.

    ------------------------------
    Dave Milham
    TM Forum, Chief Architect
    ------------------------------



  • 6.  RE: TMF API to be used for listing network elements' specification to a location

    Posted 3 days ago
    Edited by Santosh Daharia 3 days ago
    @Jonathan Goldberg, Thanks Jonathan for ​response.
    I am completely new to the TMF APIs so not very sure what I should be using.

    My first choice was TMF639 however I find it difficult to map my physical devices, along the path, with the model given in the TMF639 document. So I requested for help here.
    Each path has multiple devices (resources) so I need something to which I can associate multiple resources. So I can't have a Resource Type as a top level parent.

    Today I checked, TMF638 - Service Inventory, Name does not suggest something related to Resources  but if I consider each path as a service then I can attach multiple devices as Resource to a path.I justify this thought considering the fact that a combination of devices make a single service to a customer.
    With this, I am not sure if I can use RelatedPlaceRef for address. If a user does multiple queries then It is possible to have multiple locations in the same case.

    Please advice if TMF638 sounds good or if you see any glitch. Technically this look easy option to me because I am able to map business objects to this data model, however there could be better options which I am not aware. This is difficult task for a newbie.

    Thanks.

    ------------------------------
    Santosh Daharia
    TO BE VERIFIED
    ------------------------------



  • 7.  RE: TMF API to be used for listing network elements' specification to a location

    TM Forum Member
    Posted 3 days ago
    Edited by Vance Shipley 3 days ago
    On Apr 06, 2021 22:03 @Santosh Daharia wrote:​
    > My first choice was TMF639 however I find it difficult to map my physical devices, along the path, with the model given in the TMF639 document.

    The future Topology Discovery API shall be what you would want for this use case however in the mean time you could accomplish what you describe using TMF639 Resource Inventory API by explicitly including the relationships in the inventory:

    "resourceRelationship": [
         {
              "relationshipType": "up",
              "resource": {
                   "id": "e94b36a8",
                   "href": "/resourceInventoryManagement/v4/resource/e94b36a8"
              }
         },
         {
              "relationshipType": "down",
              "resource": {
                   "id": "571a5968",
                   "href": "/resourceInventoryManagement/v4/resource/571a5968"
              }
         },
         {
              "relationshipType": "down",
              "resource": {
                   "id": "d3280a90",
                   "href": "/resourceInventoryManagement/v4/resource/d3280a90"
              }
         },
         ...
    ],

    Note there is currently no enumerated values for relationshipType, up and down in the above example were simply my choice for your use case, you may use whatever you like.

    ------------------------------
    Vance Shipley
    SigScale
    ------------------------------



  • 8.  RE: TMF API to be used for listing network elements' specification to a location

    Posted 3 days ago
    @Vance Shipley​, Thanks Vance Shipley for example. Probably I should have stated my issue in more detail.

    My physical network paths are constructed something like below. Three imaginary examples :-

    path1 = Hub1--------->Device1--------->Device2--------->Device3--------->Device4--------->Service Site1(Location1)
    path2 = Hub1--------->Device21--------->Device22--------->Device23--------->Device24--------->Service Site1(Location1)
    path3 = Hub1--------->Device31--------->Device32--------->Device33--------->Device34--------->Service Site31(Location31)

    I will try mapping my objects with the data model given in TMF639.

    Hub is Resource Type
    Device is Resource Type
    Site is Place Type
    Path is composite Type made from an array of Resource Type and a Place Type. In array, I can maintain the relationship as per the example you have given.
    Here I am not sure what Type from the Data Model given in TMF639 is Path Type. Is it Resource Type as well ? I could not see Resource within Resource Type. This is my issue where I am stuck while using TMF639. May I get some advice here please?

    Doing the same with TMF638 Data Model makes my life quite easy.

    Path is Service Type (Parent)
    Hub  and Device are Resource Type (supporting Resources; child of Path/Service Type, One to Many association)
    Site is Place Type (Related Places).


    ------------------------------
    Santosh Daharia
    TO BE VERIFIED
    ------------------------------



  • 9.  RE: TMF API to be used for listing network elements' specification to a location

    TM Forum Member
    Posted 3 days ago

    On Apr 07, 2021 02:45 @Santosh Daharia wrote:
    > Here I am not sure what Type from the Data Model given in TMF639 is Path Type. Is it Resource Type as well ? I could not  see Resource within Resource Type. This is my issue where I am stuck while using TMF639. May I get some advice here please?

    For Path you should use ResourceFunction (TMF664) which is intended for this purpose. It is a subclass of LogicalResource with the additional of two attributes to describe connectivity:

    {
         "id": "a1b9ec11",
         "href": "/resourceInventoryManagement/v4/resource/a1b9ec11",
         "@type": "ResourceFunction",
         "name": "Network Path",
         ...
        "resourceRelationship": [
              {
                   "relationshipType": "contains",
                   "resource": {
                        "id": "e94b36a8",
                        "href": "/resourceInventoryManagement/v4/resource/e94b36a8"
                   }
              },
              ...
         ],
         "connectionPoint": [

              {
                   "id": "1e8b5352,
                   "href": "/resourceInventoryManagement/v4/resource/1e8b5352",
                   "@referredType": "ConnectionPoint",
                   "name": "A end"
              },
              {
                   "id": "8caafda2",
                   "href": "/resourceInventoryManagement/v4/resource/8caafda2",
                   "@referredType": "ConnectionPoint",
                   "name": "Z end"
              }

         ],
         "connectivity": [
              "@type": "ResourceGraph",
              "name": "Adjacency Graph",
              "connection": [
                   {
                        "name": "First Path Component",
                        "associationType": "pointtoPoint",
                        "endpoint": [
                             {
                                  "id": "6f899dad",
                                  "href": "/resourceInventoryManagement/v4/resource/6f899dad",
                                  "@referredType": "ResourceFunction"
                             },
                             {
                                  "id": "b102347d",
                                  "href": "/resourceInventoryManagement/v4/resource/b102347d",
                                  "@referredType": "ResourceFunction"
                             }
                        ]
                   },
                   ...
                   {
                        "name": "Last Path Component",
                        "associationType": "pointtoPoint",
                        "endpoint": [
                             {
                                  "id": "00c2a0bd",
                                  "href": "/resourceInventoryManagement/v4/resource/00c2a0bd",
                                  "@referredType": "ResourceFunction"
                             },
                             {
                                  "id": "2f21fae3",
                                  "href": "/resourceInventoryManagement/v4/resource/2f21fae3",
                                  "@referredType": "ResourceFunction"
                             }
                        ]
                   }
              ],
         ]
    }

    The connectionPoint attribute describes the external connection points (i.e. A and Z ends) while the connectivity attribute describes the internal topology of the ResourceFunction as one or more graphs consisting of an array of edge descriptions.



    ------------------------------
    Vance Shipley
    SigScale
    ------------------------------



  • 10.  RE: TMF API to be used for listing network elements' specification to a location

    Posted 2 days ago
    Thanks @Vance Shipley and other team member as well. I was not expecting so fast response but got prompt responses.

    Apologies for late response. I got into full day training.
    TMF664​ looks perfect to me at first glance. I will go through the details.

    Thanks.

    ------------------------------
    Thanks,
    Santosh Daharia.
    ------------------------------



  • 11.  RE: TMF API to be used for listing network elements' specification to a location

    TM Forum Member
    Posted 2 days ago
    @Santosh Daharia be aware that TMF664 is an Activation API but if you don't require activation semantics you may manage ResourceFunction entities with the other Resource domain APIs including TMF639 Inventory. ​

    ------------------------------
    Vance Shipley
    SigScale
    ------------------------------