Open APIs

Expand all | Collapse all

TMF 664 ResourceFunction services.

  • 1.  TMF 664 ResourceFunction services.

    Posted May 27, 2020 08:07
    TMF 664 ResourceFunction Activation & Configuration API specification has services for Heal, Scale & Migrate. Once ResourceFunction gets created, which api specification should be used for handling other life cycle methods of created ResourceFunction like Start, Stop & Terminate ?
    Any specific REST api specification introduced for this ?

    ------------------------------
    ----------------------------
    Thanks & Regards
    Santosh
    SingTel Optus.
    ----------------------------
    ------------------------------


  • 2.  RE: TMF 664 ResourceFunction services.

    TM Forum Member
    Posted May 28, 2020 07:05
    TMF664 covers both the Activation and config of the Resource Function lifecycle and the virtualisation lifecycle.
    Full background to this API is in TR255 Suite of documents ( full list of documents at   RN361 Release Notes for TR255 Resource Function Activation and Configuration v5.0.1)

    This API was used to enable a couple of policy based management Real Virtuality catalysts  - see videos at https://www.tmforum.org/catalysts/real-virtuality-phase-ii/

    ------------------------------
    Dave Milham
    TM Forum chief architect
    ------------------------------



  • 3.  RE: TMF 664 ResourceFunction services.

    Posted May 30, 2020 00:52
    Hi Dave,
    Thanks for the reply. I have gone through the TR255 Suite and founf ResourceFunction services like Heal, Scale and Migrate. Similarly can we have Start, Stop and Terminate services as well ?


    ------------------------------
    Venkata Santosh Pavan Raju Baliyarusimhula
    SingTel Optus
    ------------------------------



  • 4.  RE: TMF 664 ResourceFunction services.

    TM Forum Member
    Posted Jun 01, 2020 01:57
    Linking in @Vance Shipley - as lead for the resource​ function API I'm sure he'll be able to add some constructive input to this thread.

    ------------------------------
    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.
    ------------------------------



  • 5.  RE: TMF 664 ResourceFunction services.

    TM Forum Member
    Posted Jun 01, 2020 08:28
    The TMF664 API is used for activation and configuration of resources having a type of ResourceFunction. You have the Heal, Migrate, Scale operations which are specific to ResourceFunctions. All Resources have the lifecycle attributes administrationState and operationalState.

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



  • 6.  RE: TMF 664 ResourceFunction services.

    TM Forum Member
    Posted Jun 03, 2020 22:29
    Dear Shipley,​

    We are trying to use TMF664 to do infrastructure resource activation, basically, start/stop/terminate/scale/heal virtual machines.  I have following questions

    1.  From my understanding, when I issue a start command to a  VM, its operation state should change to "Active". But it is categorized under usageStateType. I was thinking if it should come under the operational state?

    ResourceUsageStateType { "idle", "active", "busy" }
    ResourceAdminstrativeStateType { "locked", "unlocked" , "shutdown"}
    ResourceOperationStateType { "enable", "disable" }
    ResourceStatusType {"standby", "alarm", "available", "reserved", "unknown", "suspend"}

    2. Is it correct to extend the heal/migrate/scale to include start/stop/terminate commands to the resource?

    Thank you very much for your valuable input.

    Regards,
    Nahfees

    ------------------------------
    Mohamed Nahfees
    SingTel Optus
    ------------------------------



  • 7.  RE: TMF 664 ResourceFunction services.

    TM Forum Member
    Posted Jun 04, 2020 06:32
    Nahfees,

    You are indeed using TMF664 for what it is intended.

    1)  In the SID a LogicalResource has the boolean attribute isOperational which is "used to define the operational status of the object" which matches the API's operationalState attribute. The resourceStatus API attribute lines up with LogicalResource attribute lrStatus where it has similar but somewhat different values (I think we should reevaluate that enumeration). In any event you have a number of dimensions to a resource's state which should all be take together.  I suggest reading TR255 and GB922 Resources.

    2) You could polymorphically extend TMF664 however I'm not sure your use case requires it. I would start by using the attributes you've identified to drive the state changes.


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



  • 8.  RE: TMF 664 ResourceFunction services.

    TM Forum Member
    Posted 27 days ago
      |   view attached

    Hi  @Vance Shipley,

    We are looking to adopt TMF664. I have read TR255 and GB922 resources to get an understanding of the intended use cases.

    Regarding the API documentation, I am using v4.1 branch in Open API Data Model git repository and cannot see the corresponding conformance profile.

    Are there plans to release it and what are indicative timeline?

    Also, is there an explanation of the meaning of each value under Resource UsageState, AdministrativeState, OperationalState and Status? See attached.

    As per my interpretation they seem overlapping - thus seeking some clarity.

    Thanks,

    Anu



    ------------------------------
    Anu Aulakh
    Telstra Corporation
    ------------------------------



  • 9.  RE: TMF 664 ResourceFunction services.

    TM Forum Member
    Posted 27 days ago

    On Dec 21, 2020 19:39  @Anu Aulakh wrote:
    | Regarding the API documentation, I am using v4.1 branch in Open API Data Model git repository and cannot see the corresponding conformance profile.
    | Are there plans to release it and what are indicative timeline?

    Yes, it is planned.

    | Also, is there an explanation of the meaning of each value under Resource UsageState, AdministrativeState, OperationalState and Status? See attached.
    | As per my interpretation they seem overlapping - thus seeking some clarity.

    These are different dimensions of resource state. Administrative state is explicitly set and overrides operational state which allows you to keep an otherwise healthy resource unavailable. The operational state represents the current health status of the resource whereas usage state represents the status with respect to whether the resource may be used in service.



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



  • 10.  RE: TMF 664 ResourceFunction services.

    TM Forum Member
    Posted 27 days ago
    Edited by David Milham 27 days ago

    Vance is correct about operational and administrative states Its origins are in the original ITU ISO management standards Circa 1992. They are widely used in nearly all Network and Network transport standards   see ITU-T X731  at     ITU-T Recommendations 



    ------------------------------
    David Milham
    TM Forum Chief ArchItect
    ------------------------------



  • 11.  RE: TMF 664 ResourceFunction services.

    TM Forum Member
    Posted 27 days ago

    Thank you both  @Vance Shipley and  @David Milham for the references.



    ------------------------------
    Anu Aulakh
    Telstra Corporation
    ------------------------------



  • 12.  RE: TMF 664 ResourceFunction services.

    TM Forum Member
    Posted 14 hours ago

    Hi @Vance Shipley,

    Is there any indicative timeline as to when the conformance profile for TMF664 v4 will be released?

    Much thanks,
    Anu​



    ------------------------------
    Anu Aulakh
    Telstra Corporation
    ------------------------------