Mplify-LSO-Interlude-SDK Janis Release

Download Link

Download the entire repository by clicking here

Introduction

All references to 'MEF Forum' or 'MEF' in the release documentation, links, and YAML files should be interpreted as references to 'Mplify Alliance' and 'Mplify' respectively. Since this release coincides with the transition of the name of MEF Forum to Mplify Alliance, changes were not made to all the files in this release. Standards that were already published will retain the "MEF" name.

Overview

This repository contains the release of the Interlude SDK. The SDK includes APIs for Service Order, Service Inventory, Performance Monitoring, and Streaming Management functions of the Service Orchestration Functionality (SOF) at the LSO Interlude Interface Reference Point (IRP) as defined in the Mplify LSO Reference Architecture.

Also included are Service schemas and Performance Monitoring definitions.

High-level release notes

• Updated documents:

  • Mplify W99.1 - LSO Service Ordering Management API - Developer Guide
  • Mplify 101 - LSO Carrier Ethernet Service Schemas and Developer Guide
  • Mplify 133.1 - Draft Release 1 Allegro, Interlude and Legato Fault Management and Performance Monitoring BR&UC
  • Mplify W135.1 - LSO Service Inventory Management API - Developer Guide
  • Mplify 136.1 - Draft Release 1 Allegro, Interlude and Legato Service Function Testing Business Requirements & Use Cases
  • MEF W143 - LSO Allegro, LSO Interlude and LSO Legato Performance Monitoring API - Developer Guide
  • Mplify W146 - LSO Allegro, LSO Interlude and LSO Legato Threshold Crossing Alerts API and Developer Guide - Developer Guide
  • MEF W148 - LSO Allegro, LSO Interlude and LSO Legato Fault Management API - Developer Guide
  • Mplify W149 - LSO Allegro, LSO Interlude and LSO Legato Service Function Testing API - Developer Guide

• No new Documents:

Scope

It includes API definitions for the following functional areas:

• Service Ordering - This includes support for
  • Service Order/OrderItem - Create and Retrieve operations only
  • Not in scope
    • Service Order/OrderItem - Amend/Modify/Cancel, Delete operations
• Service Inventory - This includes support for
  • Service - Retrieve operations only
  • Not in scope
    • Service - Create, Amend/Modify, Delete operations
• Alarm Management
• Fault Management
• Performance Monitoring
• Service Function Testing
• Streaming Management

In addition to the Service Provisioning APIs, the SDK includes the following Mplify Service Specification schemas:

• SD-WAN Services
• Carrier Ethernet Services
• L1 Connectivity Services
• IP/IP-VPN Services

The Mplify LSO Interlude SDK is released under the Apache 2.0 license.

More information about the LSO Interlude API reference point and its roadmap can be found here:

https://wiki.mplify.net/display/CESG/LSO+Interlude

Maturity Level

The API files contained in this SDK are evolving and subject to change. They are based on documents that are either work in progress or draft standards that have not yet completed the review cycles and approvals necessary to achieve the status as a Mplify standard. Mplify is making these publicly available at this time to invite wider industry review.

The maturity per functionality is presented as follows:

(*) is used to mark an item that changes its maturity compared to the previous release.

APIs and Developer Guides:

• Service Catalog API - early draft version, on hold, not to be used
• *Mplify W99.1 - LSO Service Ordering Management API - Developer Guide - Done. Ready for Letter Ballot
• *Mplify W135.1 - LSO Legato Service Inventory Management API - Developer Guide - Done. Ready for Letter Ballot

Service Schemas:

• SD-WAN (MEF W100) - work in progress - CfC#2
• *Carrier Ethernet (Mplify W101) - Done. Ready for Letter Ballot
• Internet Protocol (MEF W102) - work in progress - CfC#4
• LSO Legato Service Provisioning Specification - L1 (MEF W103) - work in progress - ready for CfC#1

SOAM:

• Mplify *W133.1 - Allegro, Interlude and Legato Fault Management and Performance Monitoring BR&UC - Draft Release 2

• Mplify *W136.1 - Service Function Testing Business Requirements and Use Cases - Draft Release 2

• Mplify *W143 - Performance Monitoring API and Developer Guide - work in progress - CfC#4

• Mplify *W146 - LSO Allegro, LSO Interlude and LSO Legato Threshold Crossing Alerts API and Developer Guide - Developer Guide - work in progress - ready for CfC#2

• Mplify W147 - Streaming Management API and Developer Guide - Done. Ready for Letter Ballot

• Mplify *W148 - LSO Allegro, LSO Interlude and LSO Legato Fault Management API - Developer Guide - work in progress - ready for CfC#2

• Mplify *W149 - LSO Allegro, LSO Interlude and LSO Legato Service Function Testing API - Developer Guide - work in progress - ready for CfC#2

• Mplify W153 - LSO IP Schemas and Developer Guide for SOAM early draft version, schemas only

• Security:

  • MEF 128.1 - Published Standard

Contents

This SDK contains the following items:

• COPYRIGHT - Copyright 2025 Mplify Forum
• LICENSE - Contains a copy of the Apache 2.0 license
• README - This file
• serviceApi - Definitions of the APIs are found in this directory, provided as yaml files.
• schema - Contains JSON schema files for service specifications.
• documentation - documentation including API/Schema developer guides and openapi-tools generated API descriptions in markdown format
  • supportingStandards - The rest of the documents and standards.
• generated
  • security - A not normative version of the standard APIs including the security profiles as required by MEF 128.1. Provided for evaluation.

Issues, questions, and Feedback

Issues should be reported with the use of GitHub issues. Questions and feedback should be asked either at Interlude SDK Discussions or directly to community_manager@mplify.net.

Reference Implementations

A reference implementation of the Mplify Service Instantiation API may be available from the ONAP EXTAPI project.

https://wiki.onap.org/display/DW/External+API+Framework+Project

Copyright

© Mplify Alliance 2025. All Rights Reserved.

Disclaimer

The information in this publication is freely available for reproduction and use by any recipient and is believed to be accurate as of its publication date. Such information is subject to change without notice and Mplify Alliance (Mplify) is not responsible for any errors. Mplify does not assume responsibility to update or correct any information in this publication. No representation or warranty, expressed or implied, is made by Mplify concerning the completeness, accuracy, or applicability of any information contained herein and no liability of any kind shall be assumed by Mplify as a result of reliance upon such information.

The information contained herein is intended to be used without modification by the recipient or user of this document. Mplify is not responsible or liable for any modifications to this document made by any other party.

The receipt or any use of this document or its contents does not in any way create, by implication or otherwise:

• (a) any express or implied license or right to or under any patent, copyright, trademark or trade secret rights held or claimed by any Mplify member which are or may be associated with the ideas, techniques, concepts or expressions contained herein; nor

• (b) any warranty or representation that any Mplify member will announce any product(s) and/or service(s) related thereto, or if such announcements are made, that such announced product(s) and/or service(s) embody any or all of the ideas, technologies, or concepts contained herein; nor

• (c) any form of relationship between any Mplify member and the recipient or user of this document.

Implementation or use of specific Mplify standards, specifications or recommendations will be voluntary, and no Member shall be obliged to implement them by virtue of participation in Mplify Alliance. Mplify is a non-profit international organization to enable the development and worldwide adoption of agile, assured and orchestrated network services. Mplify does not, expressly or otherwise, endorse or promote any specific products or services.