Services Activation Director REST API 13.1 Patch Documentation

Network Activate   |   Transport Activate   |   OAM Insight   |   Sync Design   |   QoS

Overview of NetworkAppsAPI 13.1 release

2. JSON conversion from XML

4. Enhancement features available for API 13.1 release

5. Enhancement features available for API 13.1P1 release

6. Enhancement features available for API 13.1P2 release

7. Enhancement features available for API 14.1 release

1. Introduction    [ ▲Top ]

This document aims to provide the API reference Guide for NetworkAppsAPI 13.1 release, which can be used to build OSS-NBI APIs over the Network Activate application's Interfaces for Service provisioning and Service management APIs exposed by Network activate.

The APIs implemented in the NetworkAppsAPI provide wrapper to the Network Activate interfaces to do Service provisioning, Service Management, Audit Management and Customer Management actions. Apart from Network Activate (NA), the NetworkAppsAPI also provide some wrapper APIs to utilize the OAM-CFM profiles to be attached to Network activate's Service order and Performance Management (PM) APIs.

1.1 Juniper applications supported in 13.1 release     [ ▲Top ]


1) Network Activate

2) Transport Activate

3) OAM

4) Sync Design (Timing)

5) QoS

1.2 Payload /Response types supported XML and JSON     [ ▲Top ]

The Payload/Request could be both in XML format and JSON format, even though this reference guide shows only the XML type input/payload in the samples. There is an API available for converting any given XMl Payload into a JSON payload, which is detailed in the chapter 23 - JSON Conversion from XML of this document.

Similarly. Response could be both in XML format and JSON format, even though this reference guide shows only the XML type responses in the samples.

1.3 Media types supported     [ ▲Top ]

For API which employs GET method - Accept would be used, since only a Response is the involved operation here. The Accept type determines the type of the Response obtained, which could be either in XML or in JSON format.

For API which employs POST method - Content-type need to be used, which determines the type of the input payload / request that is sent.

For API which employs PUT method - Content-type need to be used, which determines the type of the input payload / request that is sent.

For API which employs DELETE method - Accept need to be used, since only a Response is the involved operation here. The Accept type determines the type of the Response obtained, which could be either in XML or in JSON format. For example for Add customer API, Content and Accept types for XML are given below: XML:

Content-Type: application/vnd.net.juniper.space.customer-management.customers+xml

Accept:application/vnd.net.juniper.space.customer-management.customers-status+xml

JSON for the same API operation would be:

Content-Type: application/vnd.net.juniper.space.customer-management.customers+json

Accept: application/vnd.net.juniper.space.customer-management.customers-status+json

1.4 Structure of request/response supported     [ ▲Top ]

Sample Request:

Sample Response:

2 JSON conversion from XML    [ ▲Top ]

For the ease of the users, an additional API has been provided for converting the XML inputs to JSON format.

If the XML inputs pertaining to the NetworkAppsAPI are given as input then the corresponding JSON format output can be got from this API.

Note: This only for the internal use.

URI : api/space/nsas/xml-json/convert">

METHOD : POST

Content-Type : application/xml

Accept: application/json

Sample Request: Converting the AddCustomer XML-Input to JSON-Input:

Sample Response : JSON format of the above XML

3. Transition guide for API 12.1 to 12.3 patch releases     [ ▲Top ]

3.1 Introduction

There were some major changes in terms of the API Signature and Structure for payload and response, between 12.1 and 12.3 releases. These were necessitated through the feedback points from the Customers. These changes are specified in detail in this document.

Also, in 12.3 the API signature went through a minor change – in that we have adopted the API Webcontext / grouping signature of /api/space/nsas/ - instead of /api/space.

3.2 Root level hierarchy

Root elements for request and response XML / structure in 12.1 and 12.3

In release 12.1 - The Data Type had Provisioning Data, Identity, Job, and OperationSpecificData present for both request and Response Top level Tags/resource structures.

This was optimized in 12.3 by Taking out The Response XML specific entities/tags and having them separately under Data type’s “Status Tag for Responses. Please refer to the attached XSD file for 12.3 XML schemas. (REST_Data_Model.xsd)

Further changes to the Top level organization of the Tags/ resource structures were implemented in 12.3 API.

The RPC kind of Payload / XML hierarchy Tags are eliminated / optimized from release 12.1 - to present a more REST standards - adhering Tag structure for Request and Response In release 12.3 of API

3.2.1 API 12.1

3.2.2 API 12.3

3.3 ServiceEndPointGroup

The Device Name and ID are brought into the ServiceEndPointGroup Tag / resource.

3.3.1 API 12.1

3.3.2 API 12.3

3.4 Custom action / Operation specific data

Custom Action like Save, SaveandValidate, DeployNow,DeployLater were given under operation specific Data in 12.1. This was optimized and was given under CustomAction Tag directly under Data type in 12.3 API's schema.

3.4.1 API 12.1

3.4.2 API 12.3

3.5 Service EndPoint Configuration Parameter types

The Configuration Parameter types (Dynamic types given during the Payload) undergo a small change in that a more specific signaling type is defined.

That is, Instead of giving PTPElineEndPointConfigParameterOrderType in 12.1, a more specific PTPElineLDPEndPointConfigParameterOrderType is given in 12.3 payloads.

3.5.1 API 12.1

3.5.2 API 12.3

3.6 Differences in response structure:

3.6.1 API 12.1

Sample Response:

3.6.2 API 12.3

Sample Response:

3.7 Enhancement features available in 12.3 over 12.1

These features were newly added for 12.3 and were not available in 12.1. Detailed information on these can be had from the above sections of this reference guide document.

3.7.1 Modified/Optimized the request/response structure

• We had changed the Request / response structure in lieu with comments/feedback for API 12.1

• in Previous sections we have indicated all the changes for the Payload Request / Response structures / XML schema

3.7.2 Added the support for service types L3VPN, VPLS and ELine-BGP

• Previously in API 12.1 only E-line (P2P) with LDP signaling services were supported

• From 12.3, L3VPN services, VPLS with BGP/LDP signaling are also supported.

• E-Line P2P with LDP signaling was available from 12.1 release onwards. In 12.3 we have added support for E-Line P2P with BGP signaling.

3.7.3 API 12.3 provides support for Service Definition creation

• This is supported for P2P, L3VPN VPLS SD creation is not supported

3.7.4 Support for Resource utilization API

While creating service order, there is a possibility that we may give already allocated VLAN ID/VC ID/RD/RT. To find out whether a particular resource is already allocated or not, Resource Pool API has been designed. Supported resources are:

• Vlan ID

• VC ID

• RD (Route Distinguisher)

• RT (Route Target)

• IPv4 Address profile supported for Create/Delete /GET/ GET All operations

3.7.5 Multi-homed Groups API

• Create/Get/Get All operations for Multi-homed group support for VPLS

3.7.6 Media types / Content types similar to space API

Content-Type: This is required to be given for all POST/PUT operations. For example.
application/vnd.net.juniper.space.service-management.service-order+xml

Accept: This is required to be given for Get operations. For example, application/vnd.net.juniper.space.service-management.service-order-status+xml

Note: versioning is not supported

3.7.7 JSON support for creation operations using JSON Payload

• From 12.3 We can give JSON Payloads for all supported APIs (POST/PUT operations)

3.7.8 Support for filters to view the list of services associated with a customer

• URI1 Get All services for a customer based on customer ID:

api/space/nsas/elan-vpls/service-management/services?customerId=1048781

• URI2 Get All services for a customer based on customer Name:

api/space/nsas/elan-vpls/serviceanagement/services?customerName=Customer_001

3.7.9 Clone service API

• Clone is supported for P2P

3.7.10 View service configuration change

• This is supported for Auditing and would return the Device configurations for both the devices used in a service.

3.7.11 Perform FA

• The modified response now includes - associated monitoring/ troubleshoot Job ID in the response – when FA is triggered.

Sample Response:

3.7.12 View Monitoring/troubleshoot results

• This API would return the troubleshoot results

3.7.13 Single Ended Service (support for unmanaged service at one end)

• We can now create ServiceOrder for P2P with SingleEnded provisioning input , giving one Device as unmanaged Device

Sample XML request:

3.7.14 View pending order configuration

• Support for viewing Pending Order config is added.

3.7.15 Single Job id for Bulk operations

• Previously in 12.1 we did not have a Single Job ID for Bulk operations, and in 12.3 this support is added.

Sample Response:

3.7.16 PE Device Details

• In GET All PE Device details response, we will not show interface details in 12.3 (in 12.1 we had showed)

• In GET PE device response, all Interface details/info are included and also the LSP tunnel name is included there.

3.7.17 Support for local switching of P2P/ATM/TDM Services

• A-End and Z-End interfaces can be configured from the same device for a single service. Supported for P2P/ATM/TDM

3.7.18 API URI grouping changed

• Instead of Web-context / URI Grouping of /api/space/nsas/ - in 12.1 , we now have /api/space/nsas/nsas in 12.3R1 release.

3.7.19 Service Template support

• Service Template can be queried and viewed

• Service Template can be attached with a Service Definition

• Service Definition attached with Service Template can be added to a Service Order

• Service Template creation support yet to be added

3.7.20 List Services which are down (P2P/VPLS/L3VPN)

• Get Services Filtered Based on Fault Status for Eline-P2P

• Get Services Filtered Based on Fault Status for Elan-VPLS

• Get Services Filtered Based on Fault Status for L3VPN

3.7.21 VRF table parameter (L3VPN)

VRF table parameter value should be provided in Service Definition creation. If the VRF table is not Editable then in Service Order, VRF table value cannot be altered.

If the VRF table is editable, then during service order creation, we can change value (True/False).

The operations supported for VRF-Table Label are:

• Create Service Definition (METHOD: POST)

api/space/nsas/l3vpn/service-management/service-definitions

• Get Service Definition (METHOD: GET)

api/space/nsas/ l3vpn/service-management/service-definitions/<servicedefinitionId>

• Create Service Order (METHOD: POST)

api/space/nsas/l3vpn /service-management/service-orders

• Get Service Order (METHOD: GET)

api/space/nsas/l3vpn /service-management/service-orders/<serviceorderId>

• Get Service (METHOD: GET)

api/space/nsas/l3vpn/service-management/services/<serviceId>

3.7.22 Manual RT/RD support

Manual Route Target (RT) / Route Distinguisher (RD) support should be added while creating VPLS/L3VPN service definition.

• If RT Autopick is not Editable in Service definition, In Service Order, Route Target value cannot be altered.

• If RT Autopick is editable in SD, then: We can set auto pick to false and should provide the value manually.

• RT Manual: Route Target value should be provided manually while creating Service Order.

• RT Manual (Hub Spoke): If definition is hub/spoke then Hub RT and Spoke RT should be provided manually.

The operations supported are:

Manual RT (VPLS):

• Get Service Definition (METHOD: GET)

api/space/nsas/elan-vpls/service-management/service-definitions/<servicedefinitionId>

• Create Service Order (METHOD: POST)

api/space/nsas/elan-vpls/service-management/service-orders

• Get Service Order (METHOD: GET)

api/space/nsas/elan-vpls/service-management/service-orders/<serviceorderId>

• Get Service (METHOD: GET)

api/space/nsas/elan-vpls/service-management/services/<serviceId>

Manual RT/RD (P2P):

• Create Service Definition (METHOD : POST)

api/space/nsas/eline-ptp/service-management/service-definitions

• Get Service Definition (METHOD : GET)

api/space/nsas/eline-ptp/service-management/service-definitions/<servicedefinitionId>

• Create Service Order (METHOD : POST)

api/space/nsas/eline-ptp/service-management/service-orders

• Get Service Order (METHOD : GET)

api/space/nsas/eline-ptp/service-management/service-orders/<serviceorderId>

• Get Service (METHOD : GET)

api/space/nsas/eline-ptp/service-management/services/<serviceId>

Manual RT/RD (L3VPN):

• Create Service Definition (METHOD : POST)

api/space/nsas/l3vpn/service-management/service-definitions

• Get Service Definition (METHOD : GET)

api/space/nsas/l3vpn/service-management/service-definitions/<servicedefinitionId>

• Create Service Order (METHOD : POST)

api/space/nsas/l3vpn/service-management/service-orders

• Get Service Order (METHOD : GET)

api/space/nsas/l3vpn/service-management/service-orders/<serviceorderId>

• Get Service (METHOD : GET)

api/space/nsas/l3vpn/service-management/services/<serviceId>

3.7.23 Service level CFM through NA

The operator can query/view pre-created CFM profiles. The operator can attach pre-created CFM profiles with Service Orders for P2P and VPLS.

Operations for Service level CFM through NA (applicable for P2P and VPLS services) are:

• GET All CFM profiles (METHOD: GET)

api/space/nsas/cfm-profiles/service-management/service-definitions

• GET CFM profile (METHOD: GET)

api/space/nsas/cfm-profiles/service-management/service-definitions/{cfm-profile-id}

• GET Service Order (METHOD: GET)

api/space/nsas/eline-ptp/service-management/service-orders/{serviceOrder-id}

• GET Service (METHOD: GET)

api/space/nsas/eline-ptp /service-management/services/{service-id}

• Create Service Order (P2P) (METHOD: POST)

/ api/space/nsas/ eline-ptp /service-management/service-orders

• Create Service Order (VPLS) (METHOD: POST)

api/space/nsas/ elan-vpls /service-management/service-orders

• Modify Service P2P (Adding CFM Profile) (METHOD: POST)

api/space/nsas/ eline-ptp /service-management/services/{service-id}

• Modify Service P2P (Disable CFM) (METHOD: POST)

api/space/nsas/ eline-ptp /service-management/services/{service-id}

• Modify Service VPLS (Adding CFM Profile) (METHOD: POST)

api/space/nsas/ elan-vpls /service-management/services/{service-id}

• Modify Service VPLS (Disable CFM) (METHOD: POST)

api/space/nsas/ elan-vpls /service-management/services/{service-id}

• Modify Service Add-sites (METHOD: POST)

api/space/nsas/elan-vpls/service-management/services/{service-id}/add-sites

• Modify Service Delete-sites (METHOD: POST)

api/space/nsas/elan-vpls/service-management/services/{service-id}/delete-sites

• View FA results P2P (with CFM) (METHOD: GET)

api/space/nsas/ eline-ptp /service-management/view-functional-audit/{service-id}

• View FA results VPLS (with CFM) (METHOD: GET)

api/space/nsas/ elan-vpls /service-management/ view-functional-audit/{service-id}

• View Troubleshooting results P2P (with CFM) (METHOD: GET)

api/space/nsas/ eline-ptp /service-management/ view-troubleshooting-results/{service-id}

• View Troubleshooting results VPLS (with CFM) (METHOD: GET)

api/space/nsas/ elan-vpls /service-management/ view-troubleshooting-results /{service-id}

• View Service Configuration Change P2P (with CFM) (METHOD: GET)

api/space/nsas/ eline-ptp /service-management/ view- serviceconfiguration -change /{service-id}

• View Service Configuration Change VPLS (with CFM) (METHOD: GET)

api/space/nsas/ elan-vpls /service-management/ view-serviceconfiguration -change/{service-id}

3.7.24 TPID parameter for Service Order/Service

• TPID parameter would be supported in the P2P and VPLS for both LDP and BGP

• Create Service Order (P2P-BGP) (METHOD: POST)

api/space/nsas/eline-ptp/service-management/service-orders

• Get Service Order (P2P-BGP/LDP) (METHOD: GET)

api/space/nsas/eline-ptp/service-management/service-orders/< serviceorder-id>

• Modify Service (P2P-BGP/LDP) (METHOD: POST)

api/space/nsas/eline-ptp/service-management/services/<service-id>

• GET Service (P2P-BGP/LDP) (METHOD: GET)

api/space/nsas/eline-ptp/service-management/services/< service-id>

• Create Service Order (VPLS- LDP/BGP) (METHOD: POST)

api/space/nsas/elan-vpls/service-management/service-orders

• Get Service Order (VPLS- LDP/BGP) (METHOD: GET)

api/space/nsas/elan-vpls/service-management/service-orders/<serviceorder-id>

• Modify Service (VPLS-BGP/LDP) (METHOD: POST)

api/space/nsas/elan-vpls/service-management/services/<service-id>

• Modify Service Add-sites (METHOD: POST)

api/space/nsas/elan-vpls/service-management/services/{service-id}/add-sites

• Modify Service Delete-sites (METHOD: POST)

api/space/nsas/elan-vpls/service-management/services/{service-id}/delete-sites

• Get Service (VPLS-LDP/BGP) (METHOD: GET)

api/space/nsas/elan-vpls/service-management/services/<service-id>

3.7.25 PW redundancy

PW redundancy is supported for VPLS-LDP and P2P (both LDP and BGP)

PW redundancy comes in two ways.

i) Node protection

ii) Interface protection

Currently, NA supports node protection .PW redundancy is supported for both LDP/BGP based point to point Service.(P2P and VPLS). The operations supported are:

• Create Service Order (P2P-LDP) (METHOD: GET)

api/space/nsas/eline-ptp/service-management/service-orders/redundancy

• Create Service Order (P2P-LDP-TDM) (METHOD: GET)

api/space/nsas/eline-ptp/service-management/service-orders/redundancy

• Get Service (P2P-LDP) (METHOD: GET)

api/space/nsas/eline-ptp/service-management/services/<service-id>

• Modify Service (P2P-LDP) (METHOD: POST)

api/space/nsas/eline-ptp/service-management/services/<service-id>

• Get Service Order (P2P-LDP) (METHOD: GET)

api/space/nsas/eline-ptp/service-management/service-orders/<serviceorder-id>

• Create Service Order (P2P-BGP) (METHOD: POST)

api/space/nsas/eline-ptp/service-management/service-orders/redundancy

• Get Service Order (P2P-BGP) (METHOD: GET)

api/space/nsas/eline-ptp/service-management/service-orders/< serviceorder-id>

• Modify Service (P2P-BGP) (METHOD: POST)

api/space/nsas/eline-ptp/service-management/services/< service-id>

• Create Service Order (VPLS–LDP) (METHOD: POST)

api/space/nsas/elan-vpls/service-management/service-orders

• Get Service Order (VPLS- LDP) (METHOD: GET)

api/space/nsas/elan-vpls/service-management/service-orders/<serviceorder-id>

• Get Service (VPLS-LDP) (METHOD: GET)

api/space/nsas/elan-vpls/service-management/services/<service-id>

• Modify Service Add-sites (METHOD: POST)

api/space/nsas/elan-vpls/service-management/services/{service-id}/add-sites

• Modify Service Delete-sites (METHOD: POST)

api/space/nsas/elan-vpls/service-management/services/{service-id}/delete-sites

3.7.26 PM stats collection

Operations that can be performed as part of PM Stats are:

3.7.26.1 Start PM collection

api/space/nsas/eline-ptp/service-management/services/{service-id}/performanceMonitoring/twoway-delay/operation

api/space/nsas/eline-ptp/service-management/services/{service-id}/performanceMonitoring/oneway-delay/operation

api/space/nsas/eline-ptp/service-management/services/{service-id}/performanceMonitoring/loss/operation

api/space/nsas/elan-vpls/service-management/services/{service-id}/performanceMonitoring/twoway-delay/operation

api/space/nsas/elan-vpls/service-management/services/{service-id}/performanceMonitoring/oneway-delay/operation

api/space/nsas/elan-vpls/service-management/services/{service-id}/performanceMonitoring/loss/operation

3.7.26.2 Stop PM Collection

api/space/nsas/eline-ptp/service-management/services/{service-id}/performanceMonitoring/twoway-delay/operation

api/space/nsas/eline-ptp/service-management/services/{service-id}/performanceMonitoring/oneway-delay/operation

api/space/nsas/eline-ptp/service-management/services/{service-id}/performanceMonitoring/loss/operation

api/space/nsas/elan-vpls/service-management/services/{service-id}/performanceMonitoring/twoway-delay/operation

api/space/nsas/elan-vpls/service-management/services/{service-id}/performanceMonitoring/oneway-delay/operation

api/space/nsas/elan-vpls/service-management/services/{service-id}/performanceMonitoring/loss/operation

3.7.26.3 Get PM Stats

api/space/nsas/eline-ptp/service-management/services/{service-id}/performanceMonitoring/twoway-delay/stats?maxResult=4 &deviceA=1234&deviceZ=3452

api/space/nsas/eline-ptp/service-management/services/{service-id}/performanceMonitoring/oneway-delay/stats ?maxResult=4 &deviceA=1234&deviceZ=3452

api/space/nsas/eline-ptp/service-management/services/{service-id}/performanceMonitoring/loss/stats?maxResult=4 &deviceA=1234&deviceZ=3452

api/space/nsas/elan-vpls/service-management/services/{service-id}/performanceMonitoring/twoway-delay/stats?maxResult=4 &deviceA=1234&deviceZ=3452

api/space/nsas/elan-vpls/service-management/services/{service-id}/performanceMonitoring/oneway-delay/stats?maxResult=4 &deviceA=1234&deviceZ=3452

api/space/nsas/elan-vpls/service-management/services/{service-id}/performanceMonitoring/loss/stats?maxResult=4 &deviceA=1234&deviceZ=3452

The query parameters are optional

3.7.26.4 Get PM status

api/space/nsas/eline-ptp/service-management/services/{service-id}/performanceMonitoring/twoway-delay/status?devicA=1234&deviceZ=3452

api/space/nsas/eline-ptp/service-management/services/{service-id}/performanceMonitoring/oneway-delay/status? deviceA=1234&deviceZ=3452

api/space/nsas/eline-ptp/service-management/services/{service-id}/performanceMonitoring/loss/status? deviceA=1234&deviceZ=3452

api/space/nsas/elan-vpls/service-management/services/{service-id}/performanceMonitoring/twoway-delay/status? deviceA=1234&deviceZ=3452

api/space/nsas/elan-vpls/service-management/services/{service-id}/performanceMonitoring/oneway-delay/status? deviceA=1234&deviceZ=3452

api/space/nsas/elan-vpls/service-management/services/{service-id}/performanceMonitoring/loss/status? deviceA=1234&deviceZ=3452

Note: The query parameters are optional

3.7.27 URI resources similar to Junos Space API

• If we try to find/list all the resources under : /api/space/nsas/ - they would be listed as:

< space >

< services >

< service rel = "cfm-service-management" href = " /api/space/nsas/cfm-profiles/service-management " />

< service rel = "customer-management" href = " /api/space/nsas/customer-management " />

< service rel = "pe-devices" href = " /api/space/nsas/device-roles/pe-devices " />

< service rel = "vpls-service-management" href = " /api/space/nsas/elan-vpls/service-management " />

< service rel = "eline-service-management" href = " /api/space/nsas/eline-ptp/service-management " />

< service rel = "l3vpn-service-management" href = " /api/space/nsas/l3vpn/service-management " />

< service rel = "mhg-management" href = " /api/space/nsas/prestage-devices/mhg-management " />

< service rel = "resource-utilization" href = " /api/space/nsas/resource-utilization " />

</ services>

</ space>

This behavior is modeled similar to Junos Space API relative resources.

3.7.28 Notification for Add/Modify/Delete operations of Service Order/Service

Now we can receive notifications for API triggered CRUD operations. These notifications may be created for Service provisioning like Creating/Modifying/Deleting any given resource(s).

The steps for receiving database change notification are already available in Junos Space REST API Documentation.

We only need to use/register the below mentioned topics to receive notifications related to P2P, L3VPN and VPLS Services.

• "target like 'api/space/nsas/eline-ptp/service-management%'";

• "target like 'api/space/nsas/l3vpn/service-management%'";

• "target like 'api/space/nsas/elan-vpls/service-management%'";

3.7.29 Clone and Bulk support in 12.3

Supported operations for Clone Service:

• Clone Service (P2P-LDP) (METHOD: POST)

api/space/nsas/eline-ptp/service-management/services/clone/<serviceId>

• Clone Service (P2P-BGP) (METHOD: POST)

api/space/nsas/eline-ptp/service-management/services/clone/<serviceId>

BULK operations Supported in 12.3R1

Operations supported for Bulk Service Orders:

• Bulk Create Service Order (P2P-LDP) (METHOD: POST)

api/space/nsas/eline-ptp/service-management/service-orders

• Bulk Create Service Order (P2P-BGP) (METHOD: POST)

api/space/nsas/eline-ptp/service-management/service-orders

3.8 Enhancement features implemented in 12.3 patch

These features were newly added for 12.3 patch release. Transport Activate is supported from this release (RSVPLSP/BFD). Detailed information on these can be had from the above sections of this reference guide document.

3.8.1 Transport Activate - Prestaging GET APIs

3.8.2 Transport Activate - RSVPLSP/BFD Service Order/Service APIs

3.8.3 Transport Activate - RSVPLSP/BFD Service Definition APIs

3.8.4 Network Activate - Prestaging APIs

3.8.5 Network Activate - Pw Redundancy VPLS BGP APIs

3.8.6 Network Activate - Pw Stitching VPLS to P2P APIs

3.8.7 Network Activate - Pw Stitching L3VPN to P2P APIs

3.8.8 Network Activate - Service with QoS Profile attached (P2P and VPLS) APIs.

4. Features supported in 13.1 release     [ ▲Top ]

4.1 Transport Activate - APIs supported/implemented in 13.1 release:

GRE APIs

4.1.1 Get All GRE Service Orders
4.1.2 Get GRE Service Order - Full Mesh
4.1.3 Create GRE Service Order - Full Mesh
4.1.4 Get GRE Service Order - Hub and Spoke
4.1.5 Create GRE Service Order - Hub and Spoke
4.1.6 Deploy/ validate already created Serivce order
4.1.7 Delete Service order
4.1.8 View Pending Order Configuration
4.1.9 GET All GRE SD
4.1.10 GET GRE SD
4.1.11 GET RSVP-LSP SD
4.1.12 GET All GRE Services
4.1.13 Get GRE Service - Full Mesh
4.1.14 Get GRE Service - Hub and Spoke
4.1.15 Perform Functional Audit - GRE Services
4.1.16 View Functional Audit Results - GRE Services
4.1.17 View Configuration change - GRE Services
4.1.18 Force Deploy - GRE Services
4.1.19 Decommission - GRE Services
4.1.20 Decommission Later
4.1.21 Modify Service - Full Mesh - Add Tunnels
4.1.22 Modify Service - Hub and Spoke - Add Tunnels
4.1.23 Modify Service - Full Mesh - Delete Tunnels
4.1.24 Modify Service - Hub and Spoke - Delete Tunnels
4.1.25 Modify Service - Hub and Spoke - Delete Tunnels
4.1.26 View Trouble Shoot Results

Note:
i) RSVP LSP with BFD support is already implemented in 12.3 patch.
ii) Static LSP is yet to be supported in Transport Activate.
iii) Also Service templates support is not yet implemented for TA.

4.2 Network Activate APIs supported in 13.1:

4.2.1 APIs for Fetching Service Details using Application name as filter
4.2.1.1 NA - P2P
4.2.1.2 NA - VPLS
4.2.1.3 Network Activate - L3VPN
4.2.1.4 Transport Activate - RSVPLSP with BFD
4.2.1.5 OAM- CFM
4.2.2 API to GET ID from Name
4.2.2.1 GetDeviceByName
4.2.2.2 GetServiceOrderByName
4.2.2.3 GetCustomerByName
4.2.2.4 GetServiceDefinitionByName
4.2.3 API to Fetch Details using Signaling Type (LDP/BGP)
4.2.3.1 Get Services by Signaling type:
GetAllVPLSServicesBySignalType
GetAllElinePTPServicesBySignalType

4.2.3.2 Get ServiceDefinition by Signaling Type
GetAllElinePTPServiceDefinitionsBySignalType
GetAllELANVPLSServiceDefinitionsBySignalType

4.2.3.3 Get All Service Order By Siganlling Type
4.2.4 P2P Service Definition - Create & Publish
4.2.5 L3VPN Service Definition - Create & Publish
L3VPN Support with Loopback service
4.2.6 Get L3VPN Hub & Spoke Service Order
4.2.7 Create L3VPN Hub & Spoke Service Order
4.2.8 Get L3VPN Full Mesh Service Order
4.2.9 Create L3VPN Full Mesh Service Order
4.2.10 Get L3VPN Hub & Spoke Services
4.2.11 Get L3VPN Full Mesh Services

Note:
i) CESOPSN PW support not yet implemented
ii) User stories EA-142, 144 for 13.1 need to be supported.

4.3 OAM APIs supported in 13.1:

4.3.1 Get All Devices
4.3.2 Get Device
4.3.3 Discover Devices
4.3.4 Get All Action Profiles (CFM)
4.3.5 Get Action Profile (CFM)
4.3.6 Get All CFM Service Order
4.3.7 Get CFM Service Order
4.3.8 Create SLA Profile
4.3.9 Get SLA Profile
4.3.10 Get All SLA Profile
4.3.11 Get CFM Service
4.3.12 Get All CFM Services
4.3.13 Modifying CFM Services
4.3.13.1 Add Local Devices
4.3.13.2 Add Remote Devices
4.3.13.3 Delete Local Devices
4.3.13.4 Delete RemoteDevices
4.3.14 Decomissioning Services
4.3.15 Perform Configuration Audit
4.3.16 Perform Functional Audit
4.3.17 View Configuration Audit Results
4.3.18 View Functional Audit Results
4.3.19 View Service Configuration Change Result
4.3.20 View Monitoring/Troubleshoot Results
4.3.21. Get All CFM Profiles
4.3.22. Get CFM Profile
4.3.23. Delete OAM SO
4.3.24. Create CFM Profile
4.3.25 Create CFM Service Order
4.3.26 View Pending Order Configuration
4.3.27 Deploy/Validate/ Partial Delete an already created SO
4.3.28 Publish/UnPublish CFM Profile
4.3.29. Create CFM Profile & Publish
4.3.30. Delete CFM Profile

Note:
i) All operations involving LFM profiles is pending


4.4 Timing / Sync Design APIs supported:

Timing - SyncE Order :

4.4.1 Get All SyncE Service Order
4.4.2 Get SyncE Service Order
4.4.3 Get All SyncE Services
4.4.4 Get SyncE Service
4.4.5 Get All SyncE Service Definitions
4.4.6 Get SyncE Service Definition
4.4.7 Create Servic Order
4.4.8 Get All Timing Devices
4.4.9 Get Timing Devices
Synce Services Audit
4.4.10 Perform functional Audit
4.4.11 Perform Configuration Audit
4.4.12 View Functional Audit
4.4.13 View Configuration Audit
4.4.14 View Service Configuration Change
Modify Services
4.4.15 Modify SyncE Service - for modification parameters and Input
4.4.16 Modify SyncE Service - for add devices and Input
4.4.17 Modify SyncE Service - for delete devices
4.4.18 Delete Service Order
4.4.19 Decommission Service

Timing - PTPorder:

4.4.20 Get All PTP Service Definitions
4.4.21 Get PTP Service Definition
4.4.22 Get All PTP Service Orders
4.4.23 Get PTP Service Order
4.4.24 Create PTP Service Order
4.4.25 Validate/Deploy a ServiceOrder
4.4.26 View Pending Order Configuration
4.4.27 Delete a ServiceOrder
4.4.28 Get All PTP Services
4.4.29 Get PTP Service
4.4.30 M odify PTP Service
4.4.31 AddDevices - Modify PTP Service
4.4.32 DeleteDevices - Modify PTP Services
4.4.33 Decommission PTP Service
4.4.34 Decommission Later PTP Service
PTP Services Audit
4.4.35 Perform Functional Audit
4.4.36 Perform Configuration Audit
4.4.37 View Functional Audit
4.4.38 View Configuration Audit
4.4.39 View Service Configuration Change

Note:
i) User stories of 13.1 EA-128, 132 and 133 of 13.1 need to be supported in Timing API.


5 QoS APIs supported in 13.1:

4.5.1 Get All QoS Domains
4.5.2 Get All QoS Schedulers
4.5.3 Get QoS Scheduler
4.5.4 Get QoS Domain
4.5.5 Get All QoS Drop Profile
4.5.6 Get QoS Drop Profile

Note:
i) Create operations /APIs not yet supported in API.

4.6 Vlan Normalization Support for P2 in Network Activate

6.1 Get a P2P SD with Vlan Normalization
4.6.2 Create a P2P SD with Vlan Normalization
4.6.3 Get P2P Service Order
4.6.4 Get P2P Service


4.7. InterfacIndex in API Response in Network Activate:

4.7.1 Get PE Device
4.7.2 Get Service

5. Enhancements in API 13.1P     [ ▲Top ]

5.1 NA - API

5.1.1 API to Create VPLS SD

5.1.2API to Modify Saved Service Order(P2P)

5.1.3 API to Modify Saved Service Order(VPLS)

5.1.4 API to Modify Saved Service Order(L3VPN)

5.1.5 API for L3VPN MVPN(SD)

5.1.6 API for L3VPN MVPN(SO)

5.1.7 API for L3VPN MVPN(Service)

5.1.8 API to create RFC2544 from NA Service(P2P)

5.2 OAM-API

5.2.1 API to Manage LFM Links

5.2.2 API to CFM Action Profile(Create)

5.2.3 API to CFM Action Profile(Delete)

5.2.4 API to CFM Action Profile(Publish/Unpublish)

5.2.5 API to LFM Action Profile(Get)

5.2.6 API to LFM Action Profile(GetAll)

5.2.7 API to LFM Action Profile(Create)

5.2.8 API to LFM Action Profile(Delete)

5.2.9 API to LFM Action Profile(Publish/Unpublish)

5.2.10 API for LFM Profile(Get)

5.2.11 API for LFM Profile (GetAll)

5.2.12 API for LFM Profile(Create)

5.2.13 API for LFM Profile(Delete)

5.2.14 API for LFM Profile (Publish/Unpublish)

5.2.15 API to RFC2544 Test (Get )

5.2.16 API to RFC2544 Test (SO)

5.2.17 API to RFC2544 Test (Get All SO)

5.2.18 API to RFC2544 Test (Create SO)

5.2.19 API to RFC2544 Test (Delete SO)

5.2.20 API to RFC2544 Test (Validate SO)

5.2.21 API to RFC2544 Test (Deploy SO)

5.2.22 API to RFC2544 Test (Get All Services)

5.2.23 API to RFC2544 Test (Get Service)

5.2.24 API to RFC2544 Test (Decommission Service)

5.2.25 API to RFC2544 Test (Start Test)

5.2.26 API to RFC2544 Test (Halt Test)

5.2.27 API to RFC2544 Test (View Results)

5.2.28 API to Attach Profiles to OAM Device(CFM AP)

5.2.29 API to Attach Profiles to OAM Device(LFM AP)

5.2.30 API to Attach Profiles to OAM Device(SLA Iterator Profile)

5.2.31 API to Detach Profiles from OAM Device(CFM AP)

5.2.32 API to Detach Profiles from OAM Device(LFM AP)

5.2.33 API to Detach Profiles from OAM Device(SLA Iterator Profile)

5.3 TA-API

5.3.1 API to Static LSP (Get SD)

5.3.2 API to Static LSP (Get All SD)

5.3.3 API to Static LSP (Get SO)

5.3.4 API to Static LSP (Get All SO)

5.3.5 API to Static LSP (Create SO)

5.3.6 API to Static LSP (Validate SO)

5.3.7 API to Static LSP (Deploy SO)

5.3.8 API to Static LSP (Get Service)

5.3.9 API to Static LSP (Get All Services)

5.3.10 API to Static LSP (Decomission Service)

5.3.11 API to Static LSP (Modify Service, FA)

6. Features supported in 13.1P2 release     [ ▲Top ]

6.1 Network Activate

Details of implementation changes/new features added for 13.1P2 release for NA

6.1.1. Customer Management API - [Version-2]


6.2 Transport Activate

Details of implementation changes/new features added for 13.1P2 release for TA

6.2.1. Transport Activate - Bulk-LSP Management API

Service Order

Service

6.2.2. Transport Activate - RSVP LSP- Full Mesh Management API

Service Order

Service

6.2.3. Transport Activate - Static LSP- Multi hop Management API

6.2.4. Transport Activate - RSVP Management API

6.2.5. Transport Activate - TA LSP Tags

6.2.6. Transport Activate - LSP Pattern

6.2.7. Transport Activate -RSVP without BFD

7. Features supported in 14.1 release     [ ▲Top ]

7.1 Network Activate

Details of implementation changes/new features added for 14.1 release for NA

Management API Objects   

VPLS   

7.1.1 PM Stats   

7.1.2 Eline P2P(with LDP)(Note: From 13.2P2 Vlan Normalization tag is supported to P2P-LDP)   

Service-Definition API   

Service-Order Management API   

Service Management API   

7.1.3. CESoPSN Support to P2P LDP TDM   

7.1.4. Network Activate-CPP   

7.1.5. Customer ER- UnitID handling and Vlan Normalization support   

7.1.6. Burst Size Calculation   

7.1.7. Resource Pool   


7.2 Transport Activate

Details of implementation changes/new features added for 14.1 release for TA


7.3 SyncE Design/Timing

Details of implementation changes/new features added for 14.1 release for TCA

7.3.1 SYNCE     [ ▲Top ]

7.3.2. PTP     [ ▲Top ]

7.3.3 Timing devices     [ ▲Top ]