Blue Planet MCP API Reference Guide

Release 18.06 450-3709-321 | Standard Issue 07.04, October 2018

Table of Contents
Legal notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Publication history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
October 2018 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
September 2018 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
September 2018 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
August 2018 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
April 2018 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
December 2017 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
September 2017 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
August 2017 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
July 2017. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
March 2017. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
About this document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Conventions used in this document. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Command strings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Prompts and responses from the system. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Directory and path names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Buttons and menu items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Keyboard keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Window and field names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Results of an action and comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
MCP REST API changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
MCP REST API overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
So, what are RESTful APIs?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
JSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Pagination. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Versioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Scale and redundancy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Documentation provided by Swagger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Topology and the TPE/FRE model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Termination Point Encapsulation (TPE) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Physical Termination Point (PTP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Connection Termination Point (CTP). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Floating Termination Point (FTP). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Forwarding Relationship Encapsulation (FRE) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
TPE and FRE APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Example service - OTU4 100G wavelength . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Using the REST API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Layer 0 infrastructure constraints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
OTU4 support matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Constraint examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
 Service intent states and transitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Service intent state definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Service activation process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Service deactivation process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Force failed activation or deactivation process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Service intent resource tracker. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Potential failing points in monitoring activating and deactivating . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Kafkacomet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Connect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
How-to subscribe: Offset and consumerId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Can I read from a specific Offset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Reference parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Protocol V2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Protocol V1 (Deprecated) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Subscription notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Obtain an API token . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Viewing the REST API documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
MCP REST API collections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
API Authorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Asset Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Commissioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Correlator Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Equipment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Equipment and Topology Planning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Equipment groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Equipment holders. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Equipment planning and provisioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Inventory Overlay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Market . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Network element configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Network element connection profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Network element enrollment (management sessions) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Network element synchronization states . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Network elements (constructs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Network elements location (physical) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
OnePlanner Import/Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Performance metrics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Policy Manager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Port inventory (TPEs). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Project Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
RADIUS connection profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
 Resource adapter controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Service provisioning (CD fixed) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Service provisioning (flex). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Services inventory (FREs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Shelf level view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Test and diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
UAC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Planning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Create a planning project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Plan a fiber route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Create a new route between TID or CLLI + NodeID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Commit the project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Plan a network change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Update an existing fiber route between TID or CLLI + NodeID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Commit the project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Plan equipment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Create an Add Equipment Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Plan Transponder bays and shelves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Plan an add/drop bank on an existing direction of a large ROADM. . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Plan CMDs to be associated with an existing add/drop bank . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Plan a Termination Equipment Group comprised of a 100G OTR . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Plan a Termination Equipment Group comprised of a 100G Regen . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Plan one or more pluggables associated with existing 10x10 Muxponders. . . . . . . . . . . . . . . . . . . . 69
Updating the customer code on equipment after submitting the planning request . . . . . . . . . . . . . 69
Producing a project list (optional) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Create manual topology for links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Commit a planning project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Commit a fiber route, equipment, or network change project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Query the project to see the status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Verify the planning project (optional) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Update a committed planning project (optional) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Store SRLG data on ROADM lines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Cancel a planning project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Cancel a planning project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Query the project to see the status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Re-use the project (optional) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Use a planning project list to validate inter-project compatibility and sequencing . . . . . . . . . . . . . . . . . 95
Project Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Create a new project list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Add an existing Fiber Route or Equipment planning project to a project list . . . . . . . . . . . . . . . . . . . 96
Create a new Equipment planning project in the context of an existing project list . . . . . . . . . . . . . 98
Heat dissipation policy overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Create a global heat dissipation policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Create a site heat dissipation policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Create a rack/bay heat dissipation policy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Retrieve or verify a heat dissipation policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
 Planning policy (equipment to be considered during on-line planning) . . . . . . . . . . . . . . . . . . . . . . . . . 111
GET all planning policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Get a planning policy by name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Get a planning policy by id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Create a new planning policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
ServiceProvisioningPolicy (SPP) validation errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Delete a planning policy by id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Modify a planning policy by id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Perform viability override . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Retrieve viability data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Create/update new viability data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Create/update all viability data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Retrieving a Project Validation Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Triggering a Project Validation Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Network element management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Commissioning management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Policy management for script generation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Policy management for SNMP provisioning. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Policy management for heterogeneous project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Policy management for license provisioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Policy management for Waveserver script generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Policy management for NTP provisioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Policy management for RADIUS server provisioning. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
IP subnetwork management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Policy management for craft launch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Generate the commissioning scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Generate commissioning scripts for a homogeneous project (6500) . . . . . . . . . . . . . . . . . . . . . . . . . . 211
Generate commissioning scripts for a homogeneous project (Waveserver) . . . . . . . . . . . . . . . . . . . . . 214
Generate commissioning scripts for a heterogeneous project (6500 and Waveserver). . . . . . . . . . . . 215
Retrieve the commissioning scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Retrieve commissioning scripts for a homogeneous project (6500) . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
Retrieve commissioning scripts for a homogeneous project (Waveserver). . . . . . . . . . . . . . . . . . . . . . 251
Retrieve commissioning scripts for a heterogeneous project (6500 and Waveserver) . . . . . . . . . . . . 252
Enroll a 6200 network element. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
Pre-commission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
Create a connection profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
Enroll a device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
View 6200 inventory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Retrieve a list of devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Retrieve a list of equipment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
Retrieve active alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
View the port inventory (TPEs). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
View the service inventory (FREs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Service provisioning after commissioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
Manually trigger service provisioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
Retrieve the service state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
 Retrieve management sessions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
Change a network element connection profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
Commission and configure a node or port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
Specify traffic enginering parameters for an IP interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
Changing the Waveserver Ai 1.1 DCN wayside . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
Retrieve health diagnostics from a node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Information for SAOS 6.x nodes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Information for SAOS 8.x nodes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
API calls to retrieve node health information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Retrieve control plane configuration data from a node. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
Requesting all Control Plane information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
Requesting specific control plane protocol configurations: SAOS 6.x and 8700. . . . . . . . . . . . . . . 297
Requesting specific control plane protocol configurations: 6500 . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
Create the Facility By Pass Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
Attributes: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
API calls to create the Facility By Pass Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Create/Edit the Facility By Pass Profile using shareable SRLG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
Functional Success Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
Attributes: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
API calls to create or edit the Facility By Pass Profile using shareable SRLG . . . . . . . . . . . . . . . . . 307
Edit the Facility By Pass Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
Attributes: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
API calls to edit the Facility By Pass Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
Delete the Facility By Pass Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
Attributes: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
API calls to delete the Facility By Pass Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
Retrieve the Facility By Pass Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
Attributes: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
API calls to retrieve the Facility By Pass Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
Retrieve the FRR Profile(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
Attributes: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
API calls to retrieve the FRR Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
Set/Unset the Facility By Pass Profile to an IP interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
Attributes: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
API calls to set/unset the Facility By Pass Profile to an IP interface. . . . . . . . . . . . . . . . . . . . . . . . . 341
Configuring a shareable SRLG list on a node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
Preparing for the operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
Retrieving the current SRLG list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
Replacing values in the current SRLG list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
Adding values to the SRLG list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
Removing values from the SRLG list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
Deleting all values from the SRLG list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
Configure Traffic Engineering (TE) parameters for an IP interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
SRLG Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
Updating an SRLG value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
Updating multiple SRLG values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363
 Updating SRLG value ranges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
Un-setting an SRLG value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
Adding an SRLG value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
Removing an SRLG value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
Place a network element into or out of maintenance mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
Retrieving the SessionID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
Setting the Maintenance Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
Network element scripts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
Execute a custom script with or without a profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
Execute a custom script with a profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
Execute a custom script without a profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
Get script execution result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
Troubleshoot a network element configuration using a custom script . . . . . . . . . . . . . . . . . . . . . . . . . 378
Using custom scripts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
Updating configuration properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383
Equipment management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
Retrieve an equipment inventory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
Retrieve heat dissipation reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
Service Intent Life Cycle Phase and Deployment State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394
Retrieve service intent life cycle phase and deployment state. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
Retrieve service intent life cycle phase and deployment state. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
Retrieve the FREs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
Packet service management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
Basic packet-related API calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
Retrieve all discovered / planned Ethernet services including the related TPEs . . . . . . . . . . . . . . . 402
Retrieve a discovered / planned Ethernet service by FRE ID, including the related TPEs . . . . . . . . 404
Retrieve a discovered / planned Ethernet service by FRE ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406
Retrieve all discovered / planned Ethernet services for a specific network construct . . . . . . . . . . 415
Retrieve a discovered / planned Ethernet service by a specific name . . . . . . . . . . . . . . . . . . . . . . . 417
Retrieve L2 service intent facade product ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
Retrieve MC-LAG service endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
Retrieve configuration resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424
Using the Service Inventory with Packet services management . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
API calls for managing E-Line services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
Provision unprot ELINE EVPL over MPLS prot/unprot tunnels with/wout QinQ spurs . . . . . . . . . . 435
Provision unprot ELINE EPL over MPLS prot/unprot tunnels with/wout QinQ spurs . . . . . . . . . . . 439
Provision an unprotected ELINE EVPL service over Linear QinQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
Provision an unprotected ELINE EPL service over Linear QinQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446
Provision unprotected ELINE services over MPLS transport with MS-PW excluding QinQ spurs . 450
Provision an E-LINE service over a unidirectional MPLS tunnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
Provision control frame tunneling on EPL and EVPL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
Provision an E-Line service with custom Class of Service (CoS) mapping. . . . . . . . . . . . . . . . . . . . 459
Provision 2-Endpoint ELINE pseudowire protection (QinQ spurs) . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
Provision a three-point E-Line service with pseudowire protection . . . . . . . . . . . . . . . . . . . . . . . . . . 468
Provision per-EVC policing option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
Provision constraints — QinQ only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
 Provision constraints — transport protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
Provision constraints — allow QinQ segments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482
Create a packet service with Control Frame Tunneling (CFT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
Provision service OAM configuration (802.1ag and Y.1731) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
Set the default DSCP CoS mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
Retrieve an ELINE service provisioning intent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494
Delete an ELINE service by provisioning intent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
Modify BPO-IFD properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497
API calls for managing E-LAN services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
Provision an E-LAN service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
Add an endpoint to an existing E-LAN service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504
Delete a single endpoint from an existing E-LAN service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
API calls for managing E-TREE services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512
Provision an E-Tree service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512
Add a leaf endpoint to an existing E-Tree service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
API calls for provisioning E-Access and E-Transit services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
Provision unprot E-ACCESS EVPL COS MPLS prot/unprot tunnels with/wout QinQ spurs . . . . . . 530
Provision unprot E-ACCESS EPL COS MPLS prot/unprot tunnels with/wout QinQ spurs . . . . . . . . 530
Provision E-ACCESS ELINE services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
Provision E-Transit E-Line services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
API calls for managing TDM packet services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547
Retrieve unprotected E1 TDM CEM service over static MPLS (6200 endpoints) . . . . . . . . . . . . . . . 547
Retrieve unprotected E1 TDM CEM over static MPLS (CES endpoints) . . . . . . . . . . . . . . . . . . . . . . 550
Retrieve unprotected E1 TDM CEM over static MPLS (CES and 6200 endpoints). . . . . . . . . . . . . . 552
Retrieve unprotected unchannelized E1 PDH CEM service over static MPLS (3932) . . . . . . . . . . . 555
Retrieve unprotected STS-1 TDM CEM over static MPLS (6500 PTS endpoints) . . . . . . . . . . . . . . 558
Retrieve a DS1 TDM endpoint (6500 PTS endpoints) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
Create/delete unprotected E1 TDM CEM service over static MPLS (6200 endpoints) . . . . . . . . . . 570
Create/delete unprotected E1 TDM CEM service over static MPLS (CES endpoints) . . . . . . . . . . . 575
Create/delete unprotected E1 TDM CEM service over static MPLS (CES and 6200 endpoints) . . 580
Create/delete unprotected unchannelized E1 PDH CEM over static MPLS . . . . . . . . . . . . . . . . . . . 585
API calls for managing Drop-and-continue services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590
Create a Drop-and-continue service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590
Add a service endpoint to a Drop-and-continue service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592
Delete a service endpoint from a Drop-and-continue service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593
Delete a Drop-and-continue service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
API calls for managing packet service profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
Provision Layer 2 default profile types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
Edit a profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
Delete a profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
Retrieve a profile (inventory and details) by ID or filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
Provision a Packet Service (EPL) using a profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604
API calls for editing packet services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
Edit service and endpoint attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
Edit the service description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
Edit the ENNI endpoints of a service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 612
 Edit ELINE service endpoint policers with bandwidth management . . . . . . . . . . . . . . . . . . . . . . . . . 615
Update management VLAN configurable properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617
API calls for testing packet services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
Retrieve MPLS-TP LSP status, LSP ping, and LSP traceroute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
Retrieve operational status of pseudowire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 621
Retrieve service — 802.1ag CFM & PW Ping. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624
Perform an 802.1ag linktrace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 626
Perform 802.1ag (CFM) loopback on a selected service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
Perform PW ping on a selected service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
Perform PW ping on a MS-PW based service from any T-PE or S-PE to any other T-PE or S-PE . . 638
Perform PW ping for a MS-PW based service from either direction . . . . . . . . . . . . . . . . . . . . . . . . . 638
Perform PW ping on a MS-PW based service that is all MPLS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 638
Perform PW ping on a MS-PW based service that is MPLS with QiQ spur(s). . . . . . . . . . . . . . . . . . 638
Perform pseudowire traceroute and retrieve test results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 639
Perform LSP ping on a selected tunnel and retrieve its results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644
Perform LSP traceroute on tunnel retrieve results between two E-LAN endpoints . . . . . . . . . . . . . 648
Perform port fac loopback CES AimValley CSoP Smart SFP retrieve results. . . . . . . . . . . . . . . . . . 653
Perform channel level fac loopback CES AimValley CSoP Smart SFP retrieve results . . . . . . . . . . 658
Perform port level terminal loopback on a CES AimValley CSoP Smart SFP . . . . . . . . . . . . . . . . . . 664
Perform channel level terminal loopback on a CES AimValley CSoP Smart SFP. . . . . . . . . . . . . . . 670
Perform channel level facility loopback on a 6200 2.5G MRO i/f card and retrieve its results . . . 676
Perform port level terminal loopback on a 6200 2.5G MRO i/f card and retrieve its results . . . . . 682
Perform channel level terminal loopback on a 6200 2.5G MRO i/f card and retrieve its results . . 688
Perform terminal loopback on a 6200 - 63xDS1/E1 i/f card and retrieve its results . . . . . . . . . . . . 694
Perform RFC2544 tests (latency, frame loss, throughput) retrieve results cancel . . . . . . . . . . . . . 700
API calls for managing packet infrastructure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
Retrieve discovered / planned static MPLS-TP LSP tunnels (protected and unprotected). . . . . . . 710
Retrieve the set of discovered / planned L2 services that traverse a specific LSP tunnel . . . . . . . 729
Retrieve all discovered / planned MPLS-TP LSP tunnels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736
Refreshing properties for links and tunnels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740
Retrieve IP links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 743
LAG show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 744
Perform static MPLS commissioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 746
Create static MPLS-TP tunnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 784
Delete a static MPLS-TP LSP tunnel (protected and unprotected) by provisioning intent . . . . . . . 798
Retrieve dynamic MPLS-TP tunnels. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 798
Create a dynamic MPLS-TP tunnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 802
Modify a dynamic MPLS co-routed tunnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812
Delete a dynamic MPLS-TP tunnel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 821
Unidirectional tunnels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 824
Retrieve an inventory of unidirectional TE tunnels. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 825
Create a unidirectional FRR tunnel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 842
Manage a unidirectional tunnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 849
Retrieve / view LLDP link bandwidth properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 850
Edit link bandwidth properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 852
Modify static MPLS-TP co-routed LSP tunnels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 852
 Add a backup tunnel to an MPLS-TP co-routed tunnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 855
Modify MPLS-TP LSP tunnel bandwidth call admission control (CAC). . . . . . . . . . . . . . . . . . . . . . . 860
Promote discovered LSP tunnels / EVCs to modify or delete - Manual . . . . . . . . . . . . . . . . . . . . . . 865
Perform tunnel group protection switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 869
Perform LSP protection switch on link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 874
Perform LSP protection restore on link. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 881
Perform LSP correction on node insertion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 887
Perform LSP correction on node deletion. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
Perform LSP resize for a dynamic MPLS tunnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 903
Retrieve the latest information about an MPLS tunnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 908
Manually invoke an immediate optimization for a unidirectional tunnel. . . . . . . . . . . . . . . . . . . . . . 933
Managing Fast Rerouting (FRR) profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 937
Transport service management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 944
Visualize optical power . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 944
Obtain the FRE(s) to report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 945
Channel power . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 959
Total power. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 974
Spectrum power. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 981
Create an OTU4 service intent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 990
Create a 100G service intent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 993
Create a 10G service intent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 995
Create an OTU4 service intent over planned equipment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 997
Create a service intent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 998
Deploy a service intent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 998
Retrieve a feasible route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 999
Undeploy a service intent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1002
Retrieve spectral allocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1003
Perform loopback test for connection validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1016
Retrieve results for a loopback test on transponder line ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1018
Manage bandwidth lockout for an OMS link section. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1021
Obtaining the FRE ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1022
Setting a bandwidth lockout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1022
Clearing a bandwidth lockout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1022
Querying for links subject to a bandwidth lockout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1022
Delete a discovered Layer 0 service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1026
Retrieve the thread pools available to process promotion requests . . . . . . . . . . . . . . . . . . . . . . . . 1027
Promote the discovered service to the MCP service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1027
Delete the service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1028
Channel margins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1028
Retrieve FRE identifier(s) using the Services inventory (FREs) API . . . . . . . . . . . . . . . . . . . . . . . . . 1029
Retrieve SNR margin data using the Performance Gauge API - example #1 . . . . . . . . . . . . . . . . . 1029
Retrieve SNR margin data using the Performance Gauge API - example #2 . . . . . . . . . . . . . . . . . 1030
Set the channel margin upgrade safety factor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1031
Retrieve the channel margin upgrade safety factor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1032
Set the channel margin upgrade validity factor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1032
Retrieve the channel margin upgrade validity factor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1033
 Retrieve co-routed FREs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1033
Add, update, or delete the customerName and note attributes for a planned or discovered service 1035
Add or update the userLabel attribute for a planned service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1036
Add or update the userLabel attribute for a discovered service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1038
Service port trails. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1049
Retrieve a service port trail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1049
Correlation engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1051
Query Layer 0 alarm to service correlation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1051
Query services affected by an alarm identifier. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1051
Query the counts of the services affected by alarm identifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1053
Query the correlated alarms for a service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1054
Query Layer 2 alarm to service correlation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1057
Query services affected by an alarm identifier. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1057
Query the counts of the services affected by alarm identifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1059
Query the correlated alarms for a service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1059
Performance monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1063
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1063
REST APIs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1064
Query real-time PMs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1065
54xx specific behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1067
Query historical PMs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1080
Change historical PM collection configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1082
Default configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1083
Node specific configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1084
Change the PM collection interval of an enrolled network element . . . . . . . . . . . . . . . . . . . . . . . . . . . 1085
Query request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1085
Update request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1086
Change the PM collection interval of new network elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1087
Query request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1088
Update request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1089
Query operational measurements for a service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1090
Query operational measurements for a facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1091
Threshold endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1093
Create one or more new thresholds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1094
Update any attributes of an existing threshold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1096
Update any attributes of one or more existing thresholds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1096
Delete an existing threshold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1098
Retrieve an existing threshold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1098
Retrieve all existing thresholds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1098
Threshold group endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1098
Create one or more new threshold groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1099
Update an existing threshold group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1100
Update one or more existing threshold groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1100
Delete an existing threshold group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1101
Retrieve an existing threshold group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1101
Retrieve all existing threshold groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1102
 Profile endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1102
Create one or more new resource profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1102
Update an existing resource profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1103
Update one or more existing resource profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1104
Delete an existing resource profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1105
Retrieve an existing resource profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1106
Retrieve all existing resource profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1106
Non-PM measurement data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1106
RTRV-OTM - Non-PM Measurements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1106
RTRV-PTP - Non-PM Measurements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1107
RTRV-INVENTORY - Non-PM Measurements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1107
RTRV-DOC-CH - Non-PM Measurements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1108
Sample TL1 Response from NE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1108
Sample Metrics as Kafka Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1111
Security management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1118
RADIUS setup and configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1118
LDAP setup and configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1118
Create a RADIUS profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1118
Integrate a RADIUS server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1119
Overview of RADIUS support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1120
Authenticating users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1122
Configuring RADIUS as the roles authority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1122
Install OpenLDAP on host. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1127
Configure LDAP directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1128
Creating groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1130
Creating users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1132
Configure Tron . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1133
Assigning roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1134
Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1135
Perform an offline backup of the MCP solution data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1136
Perform an offline restore of the MCP solution data using an offline backup file . . . . . . . . . . . . . . . 1140
Perform an online backup of the MCP solution data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1144
Perform an offline restore of the MCP solution data using an online backup file . . . . . . . . . . . . . . . . 1150
Display a list of MCP solution backup files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1156
Download an MCP solution backup file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1159
Upload an MCP solution backup file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1161
Delete an MCP solution backup file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1163
Retrieve audit/forensic logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1164
Changing the storage method for the NE maintenance profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1166
Change the time zone setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1168
Delete the time zone setting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1169
Alarm management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1170
Top level events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1170
Top level event - sample JSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1170
Filtered alarm - sample JSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1171
Filtered alarm data - sample JSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1172
 Filtered alarm attributes - sample JSON. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1172
Alarm data structure and attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1176
Query network alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1180
Query a network alarm by alarm identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1186
Count network alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1188
Query device types within network alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1189
Query device attributes by device identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1190
Acknowledge an active alarm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1190
Unacknowledge an active alarm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1191
Force clear an active alarm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1191
Manual clear an active alarm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1192
Query Layer 0 services affected by an alarm identifier and related counts . . . . . . . . . . . . . . . . . . . . . 1192
Query services affected by an alarm identifier. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1192
Query the counts of the services affected by alarm identifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1194
Query Layer 2 services affected by an alarm identifier and related counts . . . . . . . . . . . . . . . . . . . . . 1195
Query services affected by an alarm identifier. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1195
Query the counts of the services affected by alarm identifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1197
Query the alarm retention period . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1198
Set the alarm retention period . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1198
Create an alarms filter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1199
Query alarm filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1200
Delete an alarms filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1201
Query active alarm counts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1202
Change alarm severity for EMS-generated alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1203
MCP reports using the REST API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1205
Generating and scheduling reports using the REST API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1205
On-demand reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1206
Retrieving report data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1207
Deleting reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1208
Working with report schedules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1209
Alarms reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1210
Equipment reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1211
Network element list reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1212
LLDP reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1213
Pseudowire Committed Information rate (CIR) reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1214
Performance Monitoring (PM) Cycle Redundancy Check (CRC)/Dropped Packets reports . . . . . . . 1215
Photonic service reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1216
Transport client service reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1217
Transport client infrastructure reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1218
Packet service reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1220
Packet infrastructure reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1220
API call details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1221
Appendix A: Blue Planet MCP REST API permissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1231
Blue Planet MCP API Reference Guide, Release 18.06 Legal notices

Legal notices
THIS DOCUMENT CONTAINS CONFIDENTIAL AND TRADE SECRET INFORMATION OF CIENA
CORPORATION AND ITS RECEIPT OR POSSESSION DOES NOT CONVEY ANY RIGHTS TO REPRODUCE OR
DISCLOSE ITS CONTENTS, OR TO MANUFACTURE, USE, OR SELL ANYTHING THAT IT MAY DESCRIBE.
REPRODUCTION, DISCLOSURE, OR USE IN WHOLE OR IN PART WITHOUT THE SPECIFIC WRITTEN
AUTHORIZATION OF CIENA CORPORATION IS STRICTLY FORBIDDEN.

EVERY EFFORT HAS BEEN MADE TO ENSURE THAT THE INFORMATION IN THIS DOCUMENT IS
COMPLETE AND ACCURATE AT THE TIME OF PUBLISHING; HOWEVER, THE INFORMATION CONTAINED
IN THIS DOCUMENT IS SUBJECT TO CHANGE.

While the information in this document is believed to be accurate and reliable, except as otherwise
expressly agreed to in writing CIENA PROVIDES THIS DOCUMENT "AS IS" WITHOUT WARRANTY OR
CONDITION OF ANY KIND, EITHER EXPRESS OR IMPLIED. The information and/or products described in
this document are subject to change without notice. For the most up-to-date technical publications, visit
www.ciena.com.

Copyright © 2017-2018 Ciena® Corporation. All Rights Reserved

The material contained in this document is also protected by copyright laws of the United States of
America and other countries. It may not be reproduced or distributed in any form by any means, altered in
any fashion, or stored in a data base or retrieval system, without express written permission of the Ciena
Corporation.

Security

Ciena © cannot be responsible for unauthorized use of equipment and will not make allowance or credit
for unauthorized use or access.

Table 1. Contacting Ciena

CORPORATE HEADQUARTERS 410-694-5700 OR 800-921-1144 WWW.CIENA.COM

Customer Technical Support/Warranty

in North America 1-800-CIENA24 (243-6224)

410-865-4961

in Europe, Middle East, and 800-CIENA-24-7 (800-2436-

Africa 2247)

+44-207-012-5508

00 0800 77 454 (Slovenia)

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1
Blue Planet MCP API Reference Guide, Release 18.06 Legal notices

CORPORATE HEADQUARTERS 410-694-5700 OR 800-921-1144 WWW.CIENA.COM

in Asia-Pacific 800-CIENA-24-7 (800-2436-

2247)

+81-3-6367-3989

+91-124-4340-600

120 11104 (Vietnam)

000 8004401369 (India)

in Caribbean and Latin America 800-CIENA-24-7 (800-2436-

2247)

1230-020-0845 (Chile)

009 800-2436-2247 (Colombia)

0800-77-454 (Mexico and Peru)

00 008000442510 (Panama)

Sales and General Information North America: 1-800-207-3714 E-mail: [email protected]

International: +44 20 7012 5555

in North America 410-694-5700 or 800-207-3714 E-mail: [email protected]

in Europe +44-207-012-5500 (UK) E-mail: [email protected]

in Asia +81-3-3248-4680 (Japan) E-mail: [email protected]

in India +91-22-42419600 E-mail: [email protected]

in Latin America 011-5255-1719-0220 (Mexico E-mail: [email protected]

City)

Training E-mail: [email protected]

For additional office locations and phone numbers, please visit the Ciena site at www.ciena.com.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 2
Blue Planet MCP API Reference Guide, Release 18.06 Publication history

Publication history
October 2018
Standard Issue 07.04 of Blue Planet Manage, Control and Plan API Reference Guide, 450-3709-321

September 2018
Standard Issue 07.03 of Blue Planet Manage, Control and Plan API Reference Guide, 450-3709-321

Standard Issue 07.02 of Blue Planet Manage, Control and Plan API Reference Guide, 450-3709-321

September 2018
Standard Issue 07.02 of Blue Planet Manage, Control and Plan API Reference Guide, 450-3709-321

August 2018
Standard Issue 07.01 of Blue Planet Manage, Control and Plan API Reference Guide, 450-3709-321

April 2018
Standard Issue 06.02 of Blue Planet Manage, Control and Plan REST API Reference Guide, 450-3709-321

Standard Issue 06.01 of Blue Planet Manage, Control and Plan REST API Reference Guide, 450-3709-321

December 2017
Standard Issue 05.01 of Blue Planet Manage, Control and Plan REST API Reference Guide, 450-3709-321

September 2017
Standard Issue 04.01 of Blue Planet Manage, Control and Plan REST API Reference Guide, 450-3709-321

August 2017
Standard Issue 03.01 of Blue Planet Manage, Control and Plan REST API Reference Guide, 450-3709-321

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 3
Blue Planet MCP API Reference Guide, Release 18.06 Publication history

July 2017
Standard Issue 02.01 of Blue Planet Manage, Control and Plan REST API Reference Guide, 450-3709-321

March 2017
Standard Issue 01.01 of Blue Planet Manage, Control and Plan REST API Reference Guide, 450-3709-321

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 4
Blue Planet MCP API Reference Guide, Release 18.06 About this document

About this document

This document describes some of actions you can perform with calls to the Blue Plane MCP REST API.
These calls can be used to retrieve data about, and configure, the network infrastructure and services that
are managed by MCP.

The main reference tool for MCP’s REST API is contained in the MCP UI itself. To view this information,
open the MCP UI and select System → APIs. The resulting interactive display allows you to search for
calls by category, view supported parameters, configure sample calls, and view the responses to those
calls. For some of these calls, the UI also provides sample responses to certain types of call.

This document supplements the information contained in the UI for selected API calls. Generally, API calls
are documented here to provide examples of:

• using a single call to achieve one specific result (unlike the UI’s general description)
• using a series of calls to achieve a result (whereas the UI documents only individual calls)

Only a subset of all the available MCP REST API calls are documented here. For information about any
call not discussed in this document, see the API reference tool in the MCP UI.

Conventions used in this document

Throughout this online help document you will see system information, such as command strings and
prompts, and responses, represented in consistent ways.

Command strings
Command strings that you enter in a terminal window appear in bold face courier font as in the following
example:

cd /tmp

Note : You must enter the command string exactly as shown, including spaces, and press Enter.

Variable parameters appear in angle brackets, as in the following example:

mkdir /<directory name>

An explanation of the variable may follow the command string, as in the following example:

where

<directory name> is the name of the CD-ROM directory

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 5
Blue Planet MCP API Reference Guide, Release 18.06 About this document

Prompts and responses from the system

System prompts and responses appear in courier font as in the following example:

Press Enter to continue.

Directory and path names

Directory and path names appear in courier font as in the following example:

/opt

Buttons and menu items

Buttons and menu items in the application interface appear in bold face as in the following example:

Click OK.

In some cases, the user interface supports menu commands and buttons with equivalent capabilities. In
the procedures, we suggest the use of buttons where they exist. Menu command equivalents have the
same or equivalent name as the button, if you prefer to use them.

Keyboard keys
Keyboard key names appear in bold face as in the following example:

Press Enter.

Window and field names

Names of objects displayed in windows are written as shown on the screen. Since these expressions can
contain several words, all words in the name begin with capitals.

Results of an action and comments

Results of an action and comments are printed in italic type, as follows:

The window opens.

When a new window or dialog box opens as a result of a procedure step, the new context is included in
the following step, as follows:

In the Find dialog box, enter a User ID in the Name field.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 6
Blue Planet MCP API Reference Guide, Release 18.06 MCP REST API changes

MCP REST API changes

This section identifies REST API changes between MCP 18.02 and MCP 18.06.

Table 2. New MCP REST APIs

MICROSERVICE API DESCRIPTION

Alarms GET Retrieves the current alarm

/nsa/api/v2_0/alarms/filter/activ count
eAlarmCounts (critical/major/minor/warning).

Alarms POST Acknowledges alarm; deprecates

/nsa/api/v2_0/alarms/{Id}/ackn /nsa/api/v1/alarms/{Id}/acknow
owledge/{sequenceId} ledge.

Alarms POST Force clears an alarm;

/nsa/api/v2_0/alarms/{Id}/force- deprecates
clear/{sequenceId} /nsa/api/v1/alarms/{Id}/force-
clear.

Alarms POST Manually clears an alarm;

/nsa/api/v2_0/alarms/{Id}/manu deprecates
al-clear/{sequenceId} /nsa/api/v1/alarms/{Id}/manual-
clear.

Alarms POST Unacknowledges an alarm;

/nsa/api/v2_0/alarms/{Id}/unac deprecates
knowledge/{sequenceId} /nsa/api/v1/alarms/{Id}/unackn
owledge.

Authorization GET /rbac- Retrieves all permissions and

e/api/v1/admin/current- partitions based on the current
permissions user’s roles in the context of the
current GeoRed (active/standby)
state. Requires a valid
Authorization header (bearer
token).

Backup service GET Retrieves a list of all backups.

/backupservice/api/v2/backups

Backup service GET Retrieves a list of all schedules.

/backupservice/api/v2/schedule
s

Backup service GET Retrieves a list of all backups for

/backupservice/api/v2/schedule a specific schedule.
s/{id}/backups

Backup service POST Creates a new schedule.

/backupservice/api/v2/schedule
s

Backup service GET Retrieves a specific schedule.

/backupservice/api/v2/schedule
s/{id}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 7
Blue Planet MCP API Reference Guide, Release 18.06 MCP REST API changes

MICROSERVICE API DESCRIPTION

Backup service PATCH Updates a specific schedule.

/backupservice/api/v2/schedule
s/{id}

Backup service DELETE Deletes a specific schedule.

/backupservice/api/v2/schedule
s/{id}

Backup service GET Retrieves backup settings.

/backupservice/api/v2/backupS
ettings

Backup service PATCH Updates a specific backup

/backupservice/api/v2/backupS setting.
ettings/{id}

Backup service DELETE Deletes a specific completed

/backupservice/api/v1/restore/{j restore job.
obId}

Commissioning POST Creates IPV4 Subnet or IPV6

/commissioning/api/v2/ipsubne subnet or IPV4 and IPV6 subnet.
t/

Commissioning GET Retrieves IPSubnet allocated

/commissioning/api/v2/ipsubne using above call.
t/

Commissioning DELETE Delete the ipsubnet only when

/commissioning/api/v2/ipsubne IPAddresses are not allocated
t/ under the ipsubnet.

Commissioning POST Load the reserved IP for the

/commissioning/ap1/v2/reserve shelf.
dIP/

Commissioning GET Returns the TID data.

/commissioning/ap1/v2/reserve
dIP/?tid='MALTON'

Commissioning DELETE Delete the reserved IP for a

/commissioning/ap1/v2/reserve specified TID with shelf number.
dIP/

Correlator Engine GET Search affected services by

/affectedServicesByResource resource.

Correlator Engine GET Get number of affected services

/affectedServicesCountsByReso for resources.
urces

Equipment GET /nsi/api/v5/equipment Retrieve all equipment.

Equipment GET /nsi/api/search/equipment Retrieve all equipment (non-

versioned).

Equipment GET Retrieve all equipment.

/nsi/api/v1/search/equipment

Equipment planning and POST Plan equipment.

provisioning /ifd/api/v3/equipmentIntents

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 8
Blue Planet MCP API Reference Guide, Release 18.06 MCP REST API changes

MICROSERVICE API DESCRIPTION

Equipment planning and GET Retrieve all equipment intents.

provisioning /ifd/api/v3/equipmentIntents

Equipment planning and GET Retrieve an Equipment Intent

provisioning /ifd/api/v3/equipmentIntents/{id based on its identifier.
}

Equipment planning and PUT Updates equipment state for the

provisioning /ifd/api/v1/equipmentState/{equ specified service intent.
ipmentId}

Equipment and Topology GET Retrieves a validation report.

Planning /equipmenttopologyplanning/api
/v1/Reports/importvalidation

Equipment and Topology GET Retrieves a validation report for a

Planning /equipmenttopologyplanning/api specified planning project.
/v1/Reports/importvalidation/{pr
ojectId}

Equipment and Topology GET Retrieves node and equipment

Planning /equipmenttopologyplanning/api information for a specified
/v1/Reports/nodeandequipment planning project.
data/{projectId}

Equipment and Topology POST Generates a validation report.

Planning /equipmenttopologyplanning/api
/v1/Reports/importvalidation/ex
ecute

Equipment and Topology POST Generates a validation report for

Planning /equipmenttopologyplanning/api a specified planning project.
/v1/Reports/importvalidation/{pr
ojectId}/execute

Geo Controller (Geo Red) POST /geored/site/resync Request a resynchronization of

application data; typically
performed after a prolonged
inter-site outage.

Kafka POST /kafka-rest/api/v1/topics Creates a topic with the provided

configuration.

Kafka GET /kafka- Returns a topic and its metadata.

rest/api/v1/topics/{topicName}

Kafka PUT /kafka- ONLY USE DURING

rest/api/v1/topics/{topicName} MAINTENANCE WINDOW! Alters
a topic and its metadata.

Kafka DELETE /kafka- ONLY USE DURING

rest/api/v1/topics/{topicName} MAINTENANCE WINDOW!
Deletes a topic and its metadata.

Kafka GET /kafka- Returns topic state.

rest/api/v1/monitor/{topicName
}

Kafka GET /kafka- Returns a topic state with

rest/api/v1/monitor/{topicName respect to a consumergroup.
}/{consumerGroup}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 9
Blue Planet MCP API Reference Guide, Release 18.06 MCP REST API changes

MICROSERVICE API DESCRIPTION

Market POST /market/api/v1/sharing- Create a new Sharing

permissions Permission.

Market PUT /market/api/v1/sharing- Update an existing Sharing

permissions/{sharingPermission Permission by providing the full
Id} object.

Market PATCH /market/api/v1/sharing- Update an existing Sharing

permissions/{sharingPermission Permission by providing a partial
Id} object or a JSON Patch.

Market DELETE /market/api/v1/sharing- Delete a Sharing Permission.

permissions/{sharingPermission
Id}

Market GET /market/api/v1/sharing- Retrieve the content of a Sharing

permissions/{sharingPermission Permission.
Id}

Market GET /market/api/v1/sharing- List the content of Sharing

permissions Permissions in the system.

MCP View GET Retrieve topological paths at the

/revell/api/v2/serviceTrails/{frei physical level for a service using
d} a specified FRE ID.

MCP View GET Retrieve inter-nodal paths at the

/revell/api/v2/serviceTopology/{ level of the supporting services
freid} using a specified FRE ID.

Network element configuration GET Retrieve all custom scripts.

/configmgmt/api/v2/customScri
pts

Network element configuration GET Retrieve maintenance details for

/configmgmt/api/v1/neMainten all network elements.
anceDetails

Network element configuration GET Retrieve all NE maintenance

/configmgmt/api/v2/profiles profiles.

Network element configuration POST Create a NE maintenance profile.

/configmgmt/api/v2/profiles

Network element configuration PATCH Update a NE maintenance

/configmgmt/api/v2/profiles/{pr profile.
ofileId}

Network element configuration GET Retrieve all schedules.

/configmgmt/api/v1/schedules

Network element configuration PUT Update the specified schedule.

/configmgmt/api/v1/schedules/
{scheduleId}

Network element configuration DELETE Delete the specified schedule.

/configmgmt/api/v1/schedules/
{scheduleId}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 10
Blue Planet MCP API Reference Guide, Release 18.06 MCP REST API changes

MICROSERVICE API DESCRIPTION

Network element configuration PATCH Update schedule NEs.

/configmgmt/api/v1/schedules/
nes

Network element configuration GET Retrieve all script profiles.

/configmgmt/api/v2/scriptProfil
es

Network elements (constructs) PATCH Patch a networkConstruct

/nsi/api/v3/networkConstructs/{ expectation.
id}/expectations/{expectationId}

Network elements (constructs) GET Retrieve all networkConstructs.

/nsi/api/v5/networkConstructs

Network elements (constructs) GET Retrieve all networkConstructs

/nsi/api/search/networkConstru (non-versioned).
cts

Network elements (constructs) GET Retrieve all networkConstructs.

/nsi/api/v1/search/networkCons
tructs

Network elements (constructs) POST Realize a networkConstruct

/nsi/api/v5/networkConstructs/{ expectation.
id}/expectations/{networkConstr
uctExpectationId}/realize

Performance gauge GET Returns a summary of the

/perfg/api/v1/marginsummary current channel margins suitable
for display on the dashboard.

Performance gauge GET v2 API now supports paging.

/perfg/api/v2/channelmargin

GET /perfg/api/v2/fiberloss

Performance gauge GET v2 API supports direction as an

/perfg/api/v2/channelmargins/{f argument as either Tx or Rx.
reId}?dir={direction}

Performance gauge GET /perfg/api/v2/configs v2 for configuration variables

now available as a generic
PATCH /perfg/api/v2/configs "config" API.

Performance metrics PATCH /pm/api/v2/collections Bulk update collection

configuration for multiple
network elements.

Performance metrics GET Retrieve the collection

/pm/api/v2/collections/network configuration for the specified
elements/{networkelementname network element.
}

Performance metrics PATCH Update the collection

/pm/api/v2/collections/network configuration for the specified
elements/{networkelementname network element.
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 11
Blue Planet MCP API Reference Guide, Release 18.06 MCP REST API changes

MICROSERVICE API DESCRIPTION

Performance metrics PATCH Update the collection

/pm/api/v2/collections/network configuration of all network
elements/types/{type} elements for the specified type.

Performance metrics GET Retrieve the collection

/pm/api/v2/collections/template configuration template of the
s/{type} specified network element type.

Performance metrics PATCH Update the collection

/pm/api/v2/collections/template configuration template for the
s/{type} specified network element type.

Port inventory (TPEs) GET /nsi/api/v5/tpes Retrieve all TPEs.

Port inventory (TPEs) GET /nsi/api/search/tpes Retrieve all TPEs (non-

versioned).

Port inventory (TPEs) GET /nsi/api/v1/search/tpes Retrieve all TPEs.

Resiliency Controller POST /nsi/api/v1/controllers If a controller does not exist, one

is created.

Resiliency Controller GET Retrieve a specified controller.

/nsi/api/v1/controllers/{controll
erId}

Resiliency Controller DELETE Delete a specified controller.

/nsi/api/v1/controllers/{controll
erId}

Resiliency Controller GET Retrieve the planned attributes

/nsi/api/v1/controllers/{controll for a specified controller.
erId}/controllerPlanned

Resiliency Controller GET Retrieve the expectations for a

/nsi/api/v1/controllers/{controll specified controller.
erId}/expectations

Resiliency Controller POST Add a controller expectation.

/nsi/api/v1/controllers/{controll
erId}/expectations

Resiliency Controller DELETE Delete a controller expectation.

/nsi/api/v1/controllers/{controll
erId}/expectations/{expectationI
d}

Services inventory (FREs) PATCH Patch a FRE expectation.

/nsi/api/v4/fres/{freId}/expectati
ons/{freExpId}

Services inventory (FREs) GET /nsi/api/v5/fres Retrieve all FREs.

Services inventory (FREs) GET /nsi/api/search/fres Retrieve all FREs (non-

versioned).

Services inventory (FREs) GET /nsi/api/v1/search/fres Retrieve all FREs.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 12
Blue Planet MCP API Reference Guide, Release 18.06 MCP REST API changes

MICROSERVICE API DESCRIPTION

Submarine GET Retrieve the following data for a

/submarine/api/v1/srs/cableSys specified Cable System, Cable
temDetails?resourceType=[resou Station, Customer and Fiber Pair:
rce data
type]&cableSystem=[Cable Topology to view fiber topology
System details
Name]&cableStation=[Cable
station Attributes to view cable attribute
name]&customer=[Customer details.
Name]&fiberPair=[Fiber pair ID]
Repeater to view a list of
repeaters details

Table 3. Modified MCP REST APIs

MICROSERVICE API DESCRIPTION

Asset Manager GET /asset- Pagination is now supported.

manager/api/v1/keys The following parameters
configure page size and control
page navigation and are
common across all APIs that
support pagination:

offset - Requested offset within

the total result set to be the first
element in the paged response.
Default is 0.

limit - The maximum number of

elements to return in a single
paged request. Default is 1000.

pageToken - String encoding

paging information from the
nextPageToken attribute of a
previous request in order to
optimize a follow-up paged
request. Limit and offset values
are cached with the token and do
not need to be specified in
subsequent queries; however,
the values may be overridden by
specifying the parameters with a
subsequent query.

Asset Manager GET /asset- Pagination is now supported as

manager/api/v1/areas/{areaNa described above.
me}/pullrequests

Asset Manager GET /asset- Pagination is now supported as

manager/api/v1/areas/{areaNa described above.
me}/upgrades

Authorization GET /rbac- Added "tokenType" top-level

e/api/v1/admin/current-account string response attribute;
possible values include "token",
"apiKey", or (should never
happen) "unknown".

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 13
Blue Planet MCP API Reference Guide, Release 18.06 MCP REST API changes

MICROSERVICE API DESCRIPTION

Global Configuration Service GET /gcs/api/v1/config A new query parameter

password has been added to
access password protected
configurations.

Global Configuration Service POST /gcs/api/v1/config A new resource field password

has been added to protect the
configuration from unauthorized
access and changes.

Global Configuration Service PATCH /gcs/api/v1/config A new resource field password

has been added. The provided
value must match the stored
value to successfully edit the
configuration.

Global Configuration Service PUT /gcs/api/v1/config A new resource field password

has been added. The provided
value must match the stored
value to successfully overwrite
the configuration.

Global Configuration Service DELETE /gcs/api/v1/config A new resource field password

has been added. The provided
value must match the stored
value to successfully delete the
configuration.

Market POST /market/api/v1/resources A new sharingPermissionId

attribute is added to the
Resource model. This attribute is
optional and defaults to
"visibleToSubTenants" when not
specified with shared=true.

Market PUT sharingPermissionId attribute is

/market/api/v1/resources/{reso added to the Resource model.
urceId} The behavior of the PUT is the
same as other attributes except
that if the resource is
shared=true and no
sharingPermissionId is specified
in the request body, the attribute
will become
visibleToSubTenants.

shared attribute on a
discovered=true Resource can
no longer be changed using non-
observed-PUT.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 14
Blue Planet MCP API Reference Guide, Release 18.06 MCP REST API changes

MICROSERVICE API DESCRIPTION

Market PUT sharingPermissionId attribute is

/market/api/v1/resources/{reso added to the Resource model.
urceId}/observed The behavior of the observed-
PUT is the same as other
attributes except that if the
resource is shared=true and no
sharingPermissionId is specified
in the request body, the attribute
will become
visibleToSubTenants.

shared attribute on a
discovered=true Resource can
no longer be changed using
observed-PUT.

Market PATCH sharingPermissionId attribute is

/market/api/v1/resources/{reso added to the Resource model
urceId} and can be modified using
PATCH or JSON-PATCH.

shared attribute on a
discovered=true Resource can
no longer be changed using non-
observed-PATCH.

Market PATCH sharingPermissionId attribute is

/market/api/v1/resources/{reso added to the Resource model
urceId}/observed and can be modified using
PATCH or JSON-PATCH.

shared attribute on a
discovered=true resource can
now be changed using observed-
PATCH.

Market GET sharingPermissionId attribute is

/market/api/v1/resources/{reso added to the Resource model
urceId} and will be shown in the GET
response if it is set on the
resource.

Market GET /market/api/v1/resources sharingPermissionId attribute is

added to the Resource model
and will be shown in the GET
response if it is set on the
resources.

Market POST sharingPermissionId attribute is

/market/api/v1/resources/valida added to the Resource model
te and will be passed to RA or
Custom validation plans.

Market POST sharingPermissionId attribute is

/market/api/v1/resources/{reso added to the Resource model
urceId}/validate and will be passed to RA or
Custom validation plans.

Market GET /domains partial string filtering is added to

the API via the p param for title,
description, and domainType.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 15
Blue Planet MCP API Reference Guide, Release 18.06 MCP REST API changes

MICROSERVICE API DESCRIPTION

Market GET /resource- partial string filtering is added to

providers/{resourceProviderId}/d the API via the p param for title,
omains description, and domainType.

Market GET /products q filtering will return a 400 when

filtered by an invalid domain ID
to be coherent with behaviors on
other APIs with ref-type
attributes.

OpenROADM NBI PUT Two new parameters username

/openroadmnbi/restconf/operati and password have been added
ons/configure to update username and
password for callback URLs.

OpenROADM NBI GET Two new parameters username

/openroadmnbi/restconf/data/c and password have been added
onfiguration to retrieve username and
password for callback URLs.

Project Management POST Block commits of projects that

/projectmanagement/api/v1/Pla are part of a ProjectList.
nningProjects/Commit?name=[p
roject number]

Project Management DELETE Check dependencies for multi-

/projectmanagement/api/v1/Pla node site equipment spares in
nningProjects?checkDependenci addition to the standard
es=true&name=[project number] equipment dependencies.

Resource adapter controller PUT Now returns code 202. Client is

/ractrl/api/v1/sessions/{session responsible to poll and wait until
_id} the session gets updated in the
DB.

Resource adapter controller DELETE Now returns code 202. Client is

/ractrl/api/v1/sessions/{session responsible to poll and wait until
_id} the session is deleted from the
DB.

Table 4. Removed MCP REST APIs

MICROSERVICE API DESCRIPTION

Alarms GET /nsa/api/v1/alarms Old GET alarms from cassandra

API; deprecated/hidden since
MCP 17.06.

Commissioning GET Old IPSubnet API to retrieve IPV4

/commissioning/api/v1/ipsubne Subnet; deprecated from MCP
t/ 18.06.

Commissioning POST Old IPSubnet API to load IPV4

/commissioning/api/v1/ipsubne Subnet; deprecated from MCP
t/ 18.06.

Commissioning DELETE Old IPSubnet API to delete the

/commissioning/api/v1/ipsubne IPSubnet; depreacated from
t/ MCP 18.06.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 16
Blue Planet MCP API Reference Guide, Release 18.06 MCP REST API changes

MICROSERVICE API DESCRIPTION

Commissioning POST Old Reserved IPAddress API to

/commissioning/ap1/v1/deploye load; deprecated from MCP
dIP/ 18.06.

Commissioning GET Old Reserved IPAddress API to

/commissioning/ap1/v1/deploye retrieve; deprecated from MCP
dIP/?tid = 'TID' 18.06.

Commissioning DELETE Old Reserved IPAddress API to

/commissioning/ap1/v1/deploye DELETE; deprecated from MCP
dIP/ 18.06.

Equipment GET Deleted from MCP 18.06.

/nsi/api/v2_0/equipment/{equip
mentId}

Equipment POST /nsi/api/v2_0/equipment Deleted from MCP 18.06.

Equipment PUT Deleted from MCP 18.06.

/nsi/api/v2_0/equipment/{equip
mentId}

Equipment POST Deleted from MCP 18.06.

/nsi/api/v2_0/equipment/mainte
nanceOperations

Equipment DELETE Deleted from MCP 18.06.

/nsi/api/v2_0/equipment/{equip
mentId}

Equipment GET /nsi/api/v4/equipment Deleted from MCP 18.06.

Equipment planning and POST Deprecated from MCP 18.06.

provisioning /ifd/api/v2/equipmentIntents

Equipment planning and GET Deprecated from MCP 18.06.

provisioning /ifd/api/v2/equipmentIntents

Equipment planning and GET Deprecated from MCP 18.06.

provisioning /ifd/api/v2/equipmentIntents/{id
}

MCP View GET Deprecated from MCP 18.06.

/revell/api/v1/serviceTrails/{frei
d}

MCP View POST Deprecated from MCP 18.06.

/revell/api/v1/serviceTrails

Network elements (constructs) PUT Deleted from MCP 18.06.

/nsi/api/v3/networkConstructs/{
id}/expectations

Network elements (constructs) PUT Deleted from MCP 18.06.

/nsi/api/v3/networkConstructs/{
id}/userData/{userDataKey}

Network elements (constructs) DELETE Deleted from MCP 18.06.

/nsi/api/v3/networkConstructs/{
id}/userData/{userDataKey}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 17
Blue Planet MCP API Reference Guide, Release 18.06 MCP REST API changes

MICROSERVICE API DESCRIPTION

Network elements (constructs) POST Deleted from MCP 18.06.

/nsi/api/v2_0/networkConstruct
s

Network elements (constructs) PUT Delete from MCP 18.06.

/nsi/api/v2_0/networkConstruct
s/{id}/expectations/{networkCon
structExpectationId}/{attributeN
ame}

Network elements (constructs) POST Deleted from MCP 18.06.

/nsi/api/v2_0/networkConstruct
s/{id}/expectations

Network elements (constructs) PUT Deleted from MCP 18.06.

/nsi/api/v2_0/networkConstruct
s/{id}/userData/{userDataKey}

Network elements (constructs) DELETE Deleted from MCP 18.06.

/nsi/api/v2_0/networkConstruct
s/{id}/userData/{userDataKey}

Network elements (constructs) PUT Deleted from MCP 18.06.

/nsi/api/v2_0/networkConstruct
s/{id}/identifiers/{identifierKey}

Network elements (constructs) DELETE Deleted from MCP 18.06.

/nsi/api/v2_0/networkConstruct
s/{id}/identifiers/{identifierKey}

Network elements (constructs) GET Deleted from MCP 18.06.

/nsi/api/v2_0/networkConstruct
s/{id}/expectations/{networkCon
structExpecationId}

Network elements (constructs) DELETE Deleted from MCP 18.06.

/nsi/api/v2_0/networkConstruct
s/{id}/expectations/{networkCon
structExpecationId}

Network elements (constructs) DELETE Deleted from MCP 18.06.

/nsi/api/v2_0/networkConstruct
s/{id}

Network elements (constructs) GET Deleted from MCP 18.06.

/nsi/api/v2_0/networkConstruct
s

Network elements (constructs) GET Deleted from MCP 18.06.

/nsi/api/v2_0/networkConstruct
s/{id}

Network elements (constructs) GET Deprecated from MCP 18.06.

/nsi/api/v4/networkConstructs

Port inventory (TPEs) GET /nsi/api/v2_0/tpes/{tpeId} Deleted from MCP 18.06.

Port inventory (TPEs) POST /nsi/api/v2_0/tpes Deleted from MCP 18.06.

Port inventory (TPEs) DELETE Deleted from MCP 18.06.

/nsi/api/v2_0/tpes/{tpeId}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 18
Blue Planet MCP API Reference Guide, Release 18.06 MCP REST API changes

MICROSERVICE API DESCRIPTION

Port inventory (TPEs) PUT /nsi/api/v2_0/tpes/{tpeId} Deleted from MCP 18.06.

Port inventory (TPEs) GET /nsi/api/v4/tpes Deprecated from MCP 18.06.

Services inventory (FREs) GET /nsi/api/v2_0/fres/{freId} Deleted from MCP 18.06.

Services inventory (FREs) POST Deleted from MCP 18.06.

/nsi/api/v2_0/fres/slrgOperation

Services inventory (FREs) DELETE Deleted from MCP 18.06.

/nsi/api/v2_0/fres/{freId}

Services inventory (FREs) POST Deprecated from MCP 18.06.

/nsi/api/v3/fres/{freId}/discover
ed/validate

Services inventory (FREs) GET /nsi/api/v3/fres/{freId} Deprecated from MCP 18.06.

Services inventory (FREs) PUT Deprecated from MCP 18.06.

/nsi/api/v2_0/fres/{id}/identifier
s/{identifierKey}

Services inventory (FREs) DELETE Deprecated from MCP 18.06.

/nsi/api/v2_0/fres/{id}/identifier
s/{identifierKey}

Services inventory (FREs) POST Deprecated from MCP 18.06.

/nsi/api/v2_0/fres/{freId}/unidire
ctionalStitch

Services inventory (FREs) GET /nsi/api/v4/fres Deprecated from MCP 18.06.

Table 5. Removed topics

TOPIC DESCRIPTION

bp.aeprocessor.v1.alarms Version 1 northbound alarms feed topic. Use

version 2: bp.aeprocessor.v2_0.alarms.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 19
Blue Planet MCP API Reference Guide, Release 18.06 MCP REST API overview

MCP REST API overview

This section provides an overview of the Blue Planet Manage, Control and Plan (MCP) implementation of
REpresentational State Transfer application programming interfaces (REST API).

Topics covered in this section include the following:

• So, what are RESTful APIs?

• JSON
• Pagination
• Versioning
• Scale and redundancy
• Authentication
• Documentation provided by Swagger

So, what are RESTful APIs?

A Representational state transfer (REST) or RESTful API defines a set of functions to which developers
can send requests and receive responses. REST is a widely adopted standard with a machine-readable
scheme and extensive tooling (open source and otherwise) available off-the-shelf for client code
development, generation, and validation.

The REST API interaction is performed using the HTTP/HTTPS protocol. In part, this provides firewall
friendliness using Port 80 (HTTP) and 443 (HTTPS).

HTTP verbs are re-used to identify REST operations.

Table 6. HTTP verbs

HTTP VERB CRUD (CREATE, RETREIVE, UPDATE, AND DELETE)

POST Create

GET Read

PUT Update/Replace

PATCH Update/Modify

DELETE Delete

Table 7. HTTP result codes

STATUS CODE DESCRIPTION

200 Success. Used for GET, PUT, and PATCH.

201 Created. Used for successful POST requests.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 20
Blue Planet MCP API Reference Guide, Release 18.06 MCP REST API overview

STATUS CODE DESCRIPTION

204 Success with no content. Used for successful DELETE

requests.

400 Bad request. This is used for validation errors and other
known verification.

401 Unauthorized. Authentication failed.

403 Forbidden. Permissions denied.

404 Resource not found. Used when accessing unknown

resources.

500 Internal server error. This is used when handling unknown

exceptions.

JSON
All native REST API requests and responses use the JSON format. JSON is the most common format
used with REST and is more compact and faster to parse than XML: see http://www.json.org and
http://json-schema.org.

JSON is a well-standardized human-readable format like XML, but is favored as it has the advantage of
being more compact for API-type usage. What follows is a short example showing how an object
("aliasNames") can have one or more attributes with an assigned value in an easy to read format. In this
example, only one attribute ("name") is being assigned a value.

"aliasNames": [
{
"aliasType": "CustomerName",
"name": "CustService1"
}

Blue Planet MCP REST APIs seek to be fully JSON API compliant
(http://jsonapi.org) where possible. The Content-Type: application/json is used in all HTTP headers as
demonstrated below:

curl -X GET --header “Accept: application/json”

--header “Authorization: Bearer 470c7ee96b8a102a9f90”
“https://onxl1234/nsi/api/vi/networkConstructs ?limit=20”

Pagination
For GET requests that return lists of objects, pagination is supported so that not all objects are returned at
once. MCP REST APIs employ two jsonapi.org approved pagination approaches:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 21
Blue Planet MCP API Reference Guide, Release 18.06 MCP REST API overview

• Offset/Limit-based: ?page[offset]=<int>&page[limit]=<int>
• Cursor-based: ?page[offset]=<cursor>&page[limit]=<cursor>

The cursor-based approach provides the cursor value in the response message.

Versioning
Each MCP REST API is provided with a version number in the API (for example, /tron/api/v1/tokens/). A
REST API’s initial version is v1.

If a REST API change is made that is backwards incompatible, the version number is incremented. This
does not include updates that add new optional parameters. Older versions of a REST API can continue to
be used and will be available for use for a period of time (contact Ciena for details about the official
support period).

Note: The IFD API version numbers (for example, “v2” in “ifd.v2.resourceTypes”) that appear in this
document do not necessarily reflect the IFD API version numbers associated with this current Blue Planet
MCP release. They are provided only as an example. IFD API version numbers may be higher than those
shown in this chapter. All clients interacting with the MCP intent-based service provisioning APIs (BPO-
IFD) must adapt to the version associated with the new MCP server release version after the upgrade is
completed.

The supported releases and related version numbers are as follows:

• 18.06: V5
• 18.02: V4
• 17.10: V3

Scale and redundancy

Northbound REST clients scale is achieved using a (high availability proxy) HAProxy software load
balancer. The HAProxy is the entry point for each MCP instance and is the endpoint for all REST API
requests.

HAProxy uses a floating virtual IP (VIP) address to provide redundancy. All REST clients point to the MCP
"Site IP" virtual IP address.

Using this approach, both scale and redundancy are achieved for interfacing to Northbound clients. MCP
can add more capacity and ability to handle more requests and as an added benefit the REST API client
does not have to change under failure scenarios.

Authentication
MCP REST API provides authentication according to OAuth2 (https://oauth.net/2/). HTTPs is used by

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 22
Blue Planet MCP API Reference Guide, Release 18.06 MCP REST API overview

default for all MCP REST calls to ensure all data, including passwords, is protected.

A REST API call is made to MCP with a username, password, and a timeout attribute. Upon successful
authentication, MCP returns an OAuth token. The token expires at the specified timeout. The token can
then be used repeatedly in subsequent REST API calls by the client until the token expires.

Documentation provided by Swagger

MCP REST APIs are documented within the MCP product itself using Swagger (http://swagger.io).
Swagger is a powerful representation of RESTful APIs, providing interactive documentation and tools that
make it easier for users to understand the API structure and API requirements. Swagger has a large
ecosystem of API tooling with many developers supporting Swagger in many programming languages
and deployment environments.

MCP REST API documentation (in HTML) is generated at compile time and is shipped with the product.
The Swagger UI is integrated in to the MCP management UI and as a result the REST API documentation
is available, always up to date, and synchronized with the software.

To access the Swagger REST API documentation on your MCP server, log in to the UI
(https://<server_name>/ui/) and select the System menu and then select APIs (Interactive API Specs).

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 23
Blue Planet MCP API Reference Guide, Release 18.06 Topology and the TPE/FRE model

Topology and the TPE/FRE model

Blue Planet MCP uses a generic internal data model called the TPE/FRE Model .

This model is based upon the the ONF Common Information Model
(ONF TR-512).

• Ciena is the editor of this model in ONF and has contributed heavily to the model’s development.
• ONF-CIM is used in MEF and ITU-T G.7711.
• The MCP Model is aligned with the TM Forum SID Converged Network ABE.

The TPE/FRE model is designed to be generic and independent of the underlying network protocols and
multi-layers.

MCP functional micro-services operate on this model for equipment and topology.

• Data is stored in Cassandra in this format.

• The TPE/FRE model is expressed in JSON through APIs and the Message Bus.

The TPE/FRE model allows MCP micro-services to promote re-use and be more generic and data-driven;
for example, multi-layer and device agnostic PCE, Network and Service Inventory (NSI), Service
Management (IFD), and UI.

The Resource Adapter (RA) Framework allows MCP to mediate to external models.

This section includes the following topics:

• Termination Point Encapsulation (TPE)

• Forwarding Relationship Encapsulation (FRE)
• TPE and FRE APIs

Termination Point Encapsulation (TPE)

Termination Point Encapsulation (TPE) represents the encapsulation of one, or more, functions that
terminate/originate a signal, that adapt a signal for use and that enable a signal to propagate.

Each encapsulated layer (ITU-T) is represented by a Layer Termination (LT) and can be seen as
synonymous with a protocol.

The Layer Termination encapsulates the functions and points associated with one instance of termination
of a layer (ITU-T).

A TPE is a collection of Layer Terminations, each TPE representing a layer (a layer rate; for example, OMS,
OTS, OCH, ODU0, Ethernet) and the applicable attributes of that layer.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 24
Blue Planet MCP API Reference Guide, Release 18.06 Topology and the TPE/FRE model

TpeStructureType indicates the structure type of this TPE (PTP, CTP, FTP):

• Physical termination point (PTP)

• Connection termination point (CTP)
• Floating termination point (FTP)

Note: These termination points can be hierarchical.

Physical Termination Point (PTP)

A Physical Termination Point (PTP) represents a physical port that is anchored to a card. The
tpeStructureType is PTP. An example of a PTP:
/Shelf/slot/<subslot/slot>/portNum.

Connection Termination Point (CTP)

A Connection Termination Point (CTP) represents a connection termination which may, or may not, be
participating in a connection (see Forwarding Relationship Encapsulation (FRE)]). CTPs anchor to a PTP,
FTP, or another CTP. Uniqueness is ensured using the TPE’s localIdAttributes.

tpeStructureType:

• CTPServerToClient
• CTPClientToServer
• CTPClientToClient
• CTPServerToDomain

Examples of a CTP include:

• A CTP can be anchored to PTPs, FTPs and other CTPs (for example, multiple ODU hierarchies).
• A CTP can be uniquely identified by channelization information and other properties (for example, EVC,
pseudowire) sometimes in conjunction with the identifying information of the CTP owner or peer.

Floating Termination Point (FTP)

A Floating Termination Point (FTP) represents a floating (logical) termination point that is not a physical
port and may, or may not, be anchored to a card. The tpeStructureType is FTP.

Examples of a FTP include:

• Anchored –- associated with an equipment

• /Shelf/slot/<subslot/slot>/LogicalPortName

For example, a 40G MUX port 100. The network element does report this as a numeric port but it is

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 25
Blue Planet MCP API Reference Guide, Release 18.06 Topology and the TPE/FRE model

technically not a physical port. This is interpreted as LogicalPortName=“100” instead of

portNum=“100”.

• /Shelf/Slot/LogicalPortName (where logicalPortName = LagName or LagId).

For example, 6500 LAG on L2SS or L2MOTR.

• Semi-floating – not necessarily associated with an equipment but bound to a NC LogicalPortName

(where logicalPortName = LagName or LagId).

Forwarding Relationship Encapsulation (FRE)

Forwarding Relationship Encapsulation (FRE) represents connection oriented traffic flow (SNC,
connection, XC) and connectionless traffic flow (FDFr and MFDFr) and caters to all aspects of route
description.

An FRE can have two, or more, end points (EndPointRoles) and these endpoints reference TPEs.

FREs can be partitioned into underlying FREs. It must be possible to correlate a FRE to the FRE’s server
(and the FRE’s server’s server) and in the reverse navigation.

There are three categories of the networkRole: FRE_AP, eFRE, and iFRE.

• FRE_AP - at least one of the members is an access point

• eFRE - an FRE that connects externally two (or more) adjacent layer termination points (LT)
• iFRE - anything that does not fall under eFRE and FRE_AP

TPE and FRE APIs

The base APIs for retrieving TPE and FRE topology data are as follows:

• /nsi/api/tpes
• /nsi/api/fres

Get all of the TPEs and FREs for a service intent identifier (id). This includes the port trail down to the
OCH/OTSi layer.

/nsi/api/fres?freExpectations.serviceIntent.id={id}&include=tpes

Example: Get all of the TPEs and FREs for a service intent name. This includes the port trail down to the
OCH/OTSi layer.

/ifd/api/v1/serviceIntents?label=<service_name>

Example: where <service_name> could be the CLFI.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 26
Blue Planet MCP API Reference Guide, Release 18.06 Topology and the TPE/FRE model

Use the resulting serviceIntent.id parameter as the {id} in the example above.

Example: Get all of the ROADM line FREs.

/nsi/api/fres?group=infrastructure

Get all of theTPEs and FREs for a network construct.

/nsi/api/fres?include=tpes&networkConstruct.id={id}

Example service - OTU4 100G wavelength

The following call is performed against the OTU4 100G wavelength service.

/nsi/api/fres?include=tpes&freExpectations.serviceIntent.id=<X>

Figure 1. Example wavelength service

The figure below identifies the TPEs and FREs on the OTU4 100G wavelength service.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 27
Blue Planet MCP API Reference Guide, Release 18.06 Topology and the TPE/FRE model

Figure 2. Example wavelength service with TPEs and FREs indicated

The partitioned FREs provided for each OTSi (OCH) iFRE are the ones shown in green in the figure below.
To see the internal adjacency relationships, look at the FRE endpoint CTP TPEs and then get the parent
PTP TPE and look at the adjacency.

Figure 3. Example wavelength service with partitioned FREs indicated

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 28
Blue Planet MCP API Reference Guide, Release 18.06 Using the REST API

Using the REST API

This section describes how to view the REpresentational State Transfer application programming
interfaces (REST API) documentation and how to obtain an authorization token for use in API operations.

This section includes the following topics:

• Layer 0 infrastructure constraints

• Service intent states and transitions
• Kafkacomet
• Obtain an API token
• Procedure

Layer 0 infrastructure constraints

This section describes constraints for Layer 0 infrastructure services.

The section includes the following topics:

• Overview
• OTU4 support matrix
• Constraint examples

Overview
The following table describes the supported Layer 0 infrastructure service constraints.

Table 8. Layer 0 infrastructure service constraints

SERVICE TYPE CONSTRAINTS SUPPORTED

10GE/100GE/OTM4 client NONE. Constraints are not supported for client services.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 29
Blue Planet MCP API Reference Guide, Release 18.06 Using the REST API

SERVICE TYPE CONSTRAINTS SUPPORTED

OTU4 (Infrastructure) The following constraints are mandatory constraints. If any

of these constraints are not met, path calculation fails and
an indication of which constraints caused the failure is
provided.

includeRouteObjects: List of Nodes ("routeObjectType":

"NODE_NAME") and/or ROADMLines ("routeObjectType":
"ROADM_LINE_NAME") and/or Sites ("routeObjectType":
"SITE_NAME") to be included in the route calculation
(includeRouteObjects and excludeRouteObjects constraints
can be combined).

• excludeRouteObjects: List of Nodes ("routeObjectType":

"NODE_NAME") and/or ROADMLines ("routeObjectType":
"ROADM_LINE_NAME") and/or Sites ("routeObjectType":
"SITE_NAME") to be excluded from the route calculation
(includeRouteObjects and excludeRouteObjects
constraints can be combined).
• diverseObjects: List of (up to four) Service Names (based
on Service Intent’s "userLabel") to be route Link-diverse
from. Optionally, can also be node and/or srlg and/or Site
diverse. No other constraint may be specified.
• coRoutedService: Single Service name that the service
shall be co-routed with. No other constraint may be
specified.

OTU4 support matrix

Table 9. OTU4 support matrix

NOTE INCLU INCLU INCLU EXCLU EXCLU EXCLU DIVER DIVER DIVER DIVER CO-
1 DE DE DE DE DE DE SITY SITY + SITY + SITY + ROUTE
NODE_ ROAD SITE_N NODE_ ROAD SITE_N EXISTI NODED SRLGD SITEDI D
NAME M_LIN AME NAME M_LIN AME NG IVERSI IVERSI VERSIT SERVIC
E_NAM E_NAM SERVIC TY TY Y E
E E E

Includ - Note Y Y Y Note Y Y N N N N N

e 2 3
NODE
_NAM
E

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 30
Blue Planet MCP API Reference Guide, Release 18.06 Using the REST API

NOTE INCLU INCLU INCLU EXCLU EXCLU EXCLU DIVER DIVER DIVER DIVER CO-
1 DE DE DE DE DE DE SITY SITY + SITY + SITY + ROUTE
NODE_ ROAD SITE_N NODE_ ROAD SITE_N EXISTI NODED SRLGD SITEDI D
NAME M_LIN AME NAME M_LIN AME NG IVERSI IVERSI VERSIT SERVIC
E_NAM E_NAM SERVIC TY TY Y E
E E E

Includ - Y Y Y Note Y N N N N N
e 3
ROAD
M_LIN
E_NA
ME

Includ - Y Y Y N N N N N
e
SITE_
NAME

Exclud - Note Y Y N N N N
e 2
NODE
_NAM
E

Exclud - Y N N N N N
e
ROAD
M_LIN
E_NA
ME

Exclud - N N N N N
e
SITE_
NAME

Divers - Y Y Y N
ity
existin
g
servic
e

Divers - Y Y N
ity +
nodeD
iversit
y

Divers - Y N
ity +
srlgDi
versity

Divers - N
ity +
siteDiv
ersity

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 31
Blue Planet MCP API Reference Guide, Release 18.06 Using the REST API

NOTE INCLU INCLU INCLU EXCLU EXCLU EXCLU DIVER DIVER DIVER DIVER CO-
1 DE DE DE DE DE DE SITY SITY + SITY + SITY + ROUTE
NODE_ ROAD SITE_N NODE_ ROAD SITE_N EXISTI NODED SRLGD SITEDI D
NAME M_LIN AME NAME M_LIN AME NG IVERSI IVERSI VERSIT SERVIC
E_NAM E_NAM SERVIC TY TY Y E
E E E

co- -
routed
servic
e

Note 1: Y/N indicates Whether the constraints can (Y) or cannot (N) be combined.

Note 2: Include or Exclude of 6500 Amplifier Node Types is not supported.

Note 3: Exclude constraint supercedes the Include constraint for the same object.

Constraint examples
This section provides three constraint examples.

Include/Exclude Node constraint

"constraints": \{

"excludeRouteObjects": [

"routeObjectType": "ROADM_LINE_NAME",
"roadmLineName": "a43bb456-091b-4ebd-958d-2c899c8b4183::TPE_a43bb456-
091b-4ebd-958d-2c899c8b4183::EQPT_21_1-5-PTP"
},
{
"routeObjectType": "NODE_NAME",
"nodeName": "\{\{NODEA}”
}
]
},

Co-route constraint

"constraints": \{
"coRoutedService": "configOTU4_1RLC"
},

Diversity constraint

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 32
Blue Planet MCP API Reference Guide, Release 18.06 Using the REST API

"constraints": \{
"diverseObjects":
\{ "existingService": [
"configOTR_AB_12_1_1","configOTU4_1Diverse"
],
"nodeDiversity": false,
"srlgDiversity": true,
"siteDiversity": false
}
},

Service intent states and transitions

This section covers the following topics:

• Service intent state definitions

• Service activation process
• Service deactivation process
• Force failed activation or deactivation process
• Service intent resource tracker
• Troubleshooting
• Potential Failing points in monitoring activating and deactivating

Service intent state definitions

This section includes descriptions of the states representing the successful service intent life cycles (see
States representing successful service intent life cycles) and the states representing the error cases (see
See States representing error cases).

Table 10. States representing successful service intent life cycles

STATE DESCRIPTION

CREATED The service intent is being created. This state is associated

with execution of the REST POST:/ifd/api/v1/serviceIntents.

PLANNED The service intent is successfully created with all associated

resources reserved as TPE/FRE expectations.

DEPLOYING The service intent is being provisioned by IFD. This state is

associated with the execution of the REST
POST:/ifd/api/v1/serviceIntents/{id}/deploy .

ACTIVATING (aka DEPLOYED) The service intent is being provisioned by

the RA. IFD is tracking provisioning status of all associated
resources (TPE/FRE expectations). See Service activation
process.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 33
Blue Planet MCP API Reference Guide, Release 18.06 Using the REST API

STATE DESCRIPTION

UNDEPLOYING The service intent is being deprovisioned by IFD. This state is

associated with the execution of the REST
POST:/ifd/api/v1/serviceIntents/{id}/undeploy .

Note: For Layer 0 services, this state includes the transition of

all top-level FREs to Out-Of-Service (OOS) again using NSI.

DEACTIVATING (aka UNDEPLOYED) The service intent is being deprovisioned

by the RA. IFD is tracking deprovisioning status of all
associated resources (FRE deletions). See Service
deactivation process.

DEACTIVATED The service intent is successfully deprovisioned in the

network.

DELETED This definition is only used in the published service intent just
before being deleted from the database.

Table 11. States representing error cases

STATE FAILREASON DESCRIPTION

FAILED_DEPLOYING Failure during the execution of

the
POST:/ifd/api/v1/serviceIntents/{
id}/deploy .

FAILED_UNDEPLOYING Failure during the execution of

the
POST:/ifd/api/v1/serviceIntents/{
id}/undeploy .

FAILED_ACTIVATING EXPECTATION_MISMATCH IFD received mismatch error of

at least one resource (TPE/FRE
expectation) during the service
activation process.

FAILED_ACTIVATING USER_FORCED See the Force failed activation or

deactivation process.

FAILED_DEACTIVATING USER_FORCED See the Force failed activation or

deactivation process.

Service activation process

The service intent state transition between ACTIVATING and ACTIVATED/FAILED_ACTIVATING is
implemented as follows:

• NSI to produce an expectation validation event each time a TPE/FRE actual is changed. The payload is
the result of deep comparison between the new actual and its included expectation.
• IFD to consume all these expectation validation events and track them in relation with their associated
service intents.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 34
Blue Planet MCP API Reference Guide, Release 18.06 Using the REST API

NSI

• All service intent resources as TPE/FRE expectations are stored in NSI (aka IFD ServiceRealization).
• Creation/Update of each TPE/FRE actual triggers a validation (deep comparison) with its associated
expectations.

The outcome of this validation is published as an event to a kafka topic; bp.nsi.v1.validation of the
following two event types:

• bp.v1.tpeExpectationValidated
• bp.v1.freExpectationValidated
◦ All events are sent with an order directive that is set with the service intent ID to ensure that all
events associated with the same service intent are sent to the kafka of the same cluster partition.

This is important to prevent any concerns about Cassandra data replication and allow IFD to
consume all these events in relation to the service intent on the same cluster partition as well.

IFD

• Listens to the above topics for expectation validation status reporting (events).
• Use the Service intent resource tracker to handle all the service intent activation state transitions.

Service deactivation process

The service intent state transition between DEACTIVATING and DEACTIVATED is implemented by IFD on
monitoring the deletion of the top-level actual FRE involved in the definition of the given service intent.

NSI

• Publishes to the bp.nsi.v1.changes.fre topic an FRE change event for the deletion of each actual FRE.

IFD

• Consumes the FRE change events and act on all the deletion events.
• Use the Service intent resource tracker to handle the service intent deactivation state changes.

Force failed activation or deactivation process

The following REST API is supported by IFD:

POST:/ifd/api/v1/serviceIntents/{id}/forceFailState

The purpose of this REST API is to move away from a stuck provisioning process/following states:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 35
Blue Planet MCP API Reference Guide, Release 18.06 Using the REST API

• from ACTIVATING to FAILED_ACTIVATING

• from DEACTIVATING to FAILED_DEACTIVATING

There are many reasons why an IFD service intent state may be stuck while in a provisioning state:

• There is no timeout exercised during these transient states.So, it will always remain in the transient
state until the conditions are met to switch to the corresponding target steady state (ACTIVATED or
DEACTIVATED).
• See state machine or states description table above.
• See Potential failing points in monitoring activating and deactivating

Service intent resource tracker

The table Monitored service intent processes describes how the resource tracker monitors the progress
of the following service intent processes:

Table 12. Monitored service intent processes

SERVICE INTENT PROCESS RESOURCE TRACKER DESCRIPTION

Provisioning (activation) • A resource tracker is set for each one of the TPE and FRE
expectations that define the service intent route.
• It is initialized in the ACTIVATING state.
• It is associated with the registered
ExpectationListener.java.

Deprovisioning (deactivation) • A resource tracker is set for each one of the FRE (actual)
that is to be deleted.
• It is initialized in the DEACTIVATING state.
• It is associated with the registered
FreChangeListener.java.

Troubleshooting
How can I monitor the progress of a service intent ACTIVATING or DEACTIVATING? IFD supports a REST
API to allow reporting of all the resource tracker states for any given service intent ID. The REST API
endpoint is: GET:/ifd/api/v1/serviceIntents/{id}/resourceTrackers. See Service intent resource tracker.

Why is the service intent stuck in ACTIVATING? Verify the following in this order:

• State of the IFD resource trackers for the given service intent
◦ See How can I monitor the progress of a service intent ACTIVATING or DEACTIVATING?

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 36
Blue Planet MCP API Reference Guide, Release 18.06 Using the REST API

• Interpretation of the resource trackers after a reasonable waiting time to allow for the provisioning to
be exercised:
◦ All are still ACTIVATING

IFD did not receive ANY or failed to process ALL expectation validation events.

◦ Some are ACTIVATED

IFD has received some of the valid expectation validation events.

• You should try to verify if the service is really provisioned in the network using one of the following:
◦ Log in the node (using CESD CLI or Site Manager) to verify that the node(s) are provisioned as
expected, or
◦ Use another application such as OneControl WSM (L0) or PSM (L2) to see that the service is
properly created and discovered
◦ If the service is provisioned in the network then we are dealing with a potential issue.
◦ See Potential failing points in monitoring activating and deactivating

Recovery steps:

• The only way to potentially recover is to send an NSI resynchronization to each node involved in the
service intent route (use MCP UI or REST API).
• Use the ForceFailState REST API. See Force failed activation or deactivation process

Potential failing points in monitoring activating and deactivating

The IFD implementation for the transition of a service intent from ACTIVATING to ACTIVATED or
DEACTIVATING to DEACTIVATED is complex because it relies on many components.

The following list is a description of some of the potential failing points for each component:

IFD

• May have failed to consume/process the events.

• Check IFD logs or kafka (see the last bullet in the IFD section).
• Check content of the service_intent resource trackers table in the IFD space (that is, use DBeaver to
export the intent record to JSON).
◦ some resource tracker states may have already been received (ACTIVATED)
◦ All of them must be ACTIVATING to have the service intent state transitioning
◦ See Service intent resource tracker.
• Check kafka topic: bp.nsi.v1.validation (all TPE/FRE expectation validation events published by NSI
every time an actual is created/updated).

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 37
Blue Planet MCP API Reference Guide, Release 18.06 Using the REST API

NSI

• May have failed to receive (from IFD) or execute resynchronization (deep-discovery) as post-
provisioning process (Layer 2 only).
• May have failed to consume, validate (deep comparison between actual/ expectation TPE/FRE) and
publish.
• Check NSI logs.
• You can also retrieve all TPEs and FREs by service intent ID (simply using Swagger).
◦ You can check if some of the actuals are not yet discovered (that is, there are no CTP actual
attributes—only the expectation).

RA

• May have failed to execute a provisioning command (sent by IFD during deploying).
• May have failed to execute resynchronization (Layer 2 nodes) or process AO (Layer 0 and Layer 1).
• See Service intent resource tracker.

Kafkacomet
This service relays messages from Kafka topics to a websocket connection. Clients can establish a
websocket connection and send a subscription for one or more Kafka topics. If the connection is
established, all Kafka messages from the subscribed topic are relayed to the websocket client. The client
may disconnect or unsubscribe from topics at any time.

Connect

#V1 (user_id) acts as consumerId

ws(s)://<host>:<port>/kafkacomet/socket/websocket?user_id=<userId>

#V2

ws(s)://<host>:<port>/kafkacomet/socket/websocket

Authentication

By default authentication must be provided in order to open a websocket connection with kafkacomet.

The client must provide either a uac.authorization cookie with the value set to a valid token, or an
Authorization bearer <token> header with the connection request.

Failure to provide valid authentication will result in a websocket: bad handshake error, along with a 401
Status code.

The requirement for authentication can be disabled using the Global Configuration Service, by setting the

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 38
Blue Planet MCP API Reference Guide, Release 18.06 Using the REST API

kafkacomet authentication configuration to false.

How-to subscribe: Offset and consumerId

When subscribing to a topic, you also have to provide a consumerId (v2) or user_id (v1) as well as, an
offset of latest or earliest (default: latest). If the consumerId is not specified, one will be generated and
returned in the response.

When subscribing to a topic for the very first time with a consumerId, the offset determines where you
begin to read messages from the topic.

You can read all messages from the beginning or start with the next message to be produced to the topic.
Note: Messages may expire or compacted based on topic configuration. So, the earliest message is not
always the first message ever produced to the topic.

Once subscribed, Kafka keeps track of the topic offset for your consumerId. If you lose connection or
unsubscribe and resubscribe later with the same consumerId, you start where you left off.

Can I read from a specific Offset

No. Exposing this requires the client to do the heavy lifting, tracking offsets per consumer per partition per
topic. So far, no use case justified the resulting complexity.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 39
Blue Planet MCP API Reference Guide, Release 18.06 Using the REST API

Reference parameter
Each request has a ref parameter, it is used to associate the request with its response.

Protocol V2

Heartbeat

If the server does not receive a heartbeat every 30 seconds in the absence of any other messages, the
connection will be terminated.

Request:

{
"v2" : {
"ref" : 1,
"operation" : "heartbeat"
}
}

Response:

{
"v2" : {
"ref" : 1,
"response" : {
"success" : true
}
}
}

Ping/Pong Frame

As an alternative to Heartbeat messages, one can send a Ping Frames to the websocket server. The
payload for this message is arbitrary data.

This will keep the connection alive and prevent the server from terminating it, just like the Heartbeat
message does. The only difference is that the server answers with a Pong Frame, which contains the
exact same data that was sent with the Ping Frame. The Ping Frame needs to be send at an interval < 30
seconds.

This implementation is according to RFC6455.

Subscribe

Subscribe to a topic. Streaming starts with the most recent message Request:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 40
Blue Planet MCP API Reference Guide, Release 18.06 Using the REST API

{
"v2" : {
"ref" : 2,
"operation" : "subscribe",
"consumerId" : "myConsumer", # Generated and returned in response, if not
specified
"topics" : [
{
"name" : "bp.aeprocessor.v2_0.alarms",
"startAt" : "latest"
}
]
}
}

You will receive one notification per topic you subscribed to

Response:

{
"v2" : {
"ref" : 2,
"operation": "subscribe",
"consumerId" : "<specified or generated consumerId>",
"response" : {
"topic" : "bp.aeprocessor.v2_0.alarms",
"success" : true
}
}
}

Unsubscribe

Request:

{
"v2" : {
"ref" : 4,
"operation" : "unsubscribe",
"response" : {
"topic" : "bp.aeprocessor.v2_0.alarms",
"success" : true
}
}
}

Topic Message Notification

The body is the kafka message JSON object

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 41
Blue Planet MCP API Reference Guide, Release 18.06 Using the REST API

{
"v2" : {
"operation" : "relay",
"message" : {
"topic" : "srcTopic",
"body" : {},
}
}
}

Error Messages

{
"v2" : {
"ref" : 2,
"operation" : "<operation>",
"response" : {
"error" : "Something went wrong"
}
}
}

Protocol V1 (Deprecated)

Heartbeat

If the server does not receive a heartbeat every 30 seconds in the absence of any other messages, the
connection will be terminated.

Request:

{"topic":"phoenix","event":"heartbeat","payload":{},"ref":"7"}

Response:

{"topic":"phoenix","ref":"7","payload":{"status":"ok","response":{},"event":"phx_re
ply"}

Ping/Pong Frame

As an alternative to Heartbeat messages, one can send a Ping Frames to the websocket server. The
payload for this message is arbitrary data.

This will keep the connection alive and prevent the server from terminating it, just like the Heartbeat

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 42
Blue Planet MCP API Reference Guide, Release 18.06 Using the REST API

message does. The only difference is that the server answers with a Pong Frame, which contains the
exact same data that was sent with the Ping Frame. The Ping Frame needs to be send at an interval < 30
seconds.

This implementation is according to RFC6455.

Subscribe

Subscribe to a topic. Streaming starts with the most recent message Request:

{"topic":"topics:bp.aeprocessor.v2_0.alarms","event":"phx_join","payload":{},"ref":
"1"}

Response:

{"topic":"topics:equipment","ref":"1","payload":{"status":"ok","response":{}},"even
t":"phx_reply"}

Unsubscribe

Request:

{"topic":"topics:bp.aeprocessor.v2_0.alarms","event":"phx_leave","ref":"1"}

Response:

{"topic": "topics:bp.aeprocessor.v2_0.alarms", "ref": "2", "payload": {"status":

"ok", "response": {}}, "event": "phx_reply"}

Topic Message Notification

{"topic":"topics:bp.aeprocessor.v2_0.alarms","payload":{"body":{"value":"{\"test\":
\"message\"}"}},"event":"shout"}

Error Messages

{"topic": "topics:bp.aeprocessor.v2_0.alarms", "ref": "2", "payload": {"status":

"error", "response": "TestError message"}, "event": "phx_reply"}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 43
Blue Planet MCP API Reference Guide, Release 18.06 Using the REST API

Subscription notifications
Applications that care about whether or not their topic is subscribed to can listen on the topic
bp.kafkacomet.v1.channel.administration for subscription notifications. The notifications consist of a
join message sent out when a topic is subscribed to e.g.:

{"version":1,"header":{"envelopeId":"a2e2d89a-8049-464e-8a3c-
8258a878be4d","timestamp":"2017-08-22T20:41:41.224Z","traceId":"9eef9356-87e5-4d27-
a9d8-0c1ee8986585","upstreamId":"a0ae2c64-bdf4-4372-8cc9-
5abf1ec9aba6"},"event":{"_type":"bp.kafkacomet.v1.admin","op":"CHANNEL_JOINED","cha
nnel":"bp.aeprocessor.v2_0.alarms"}}

and a close message sent out when all subscribers for a channel are gone:

{"version":1,"header":{"envelopeId":"4e3a2444-8c72-4d3a-9586-
11c97fa53164","timestamp":"2017-08-22T20:42:40.374Z","traceId":"a43ac7d8-0cd3-4d01-
8f78-ab3d4800094e","upstreamId":"147203b2-596a-4ab1-aa64-
3442e3e05e08"},"event":{"_type":"bp.kafkacomet.v1.admin","op":"CHANNEL_CLOSED","cha
nnel":"bp.aeprocessor.v2_0.alarms"}}

Consumers of this topic must be idempotent, since it is not guaranteed that each
join/close message will be sent only once. Each host will send a join/close
message when a subscription is created, or a channel is closed. E.g. with 2
IMPORTANT
KafkaComet instances, when bp.aeprocessor.v2_0.alarms is joined, 2
CHANNEL_JOINED messages will be sent on
bp.kafkacomet.v1.channel.administration for bp.aeprocessor.v2_0.alarms.

Client
This client can be used to test. It will subscribe to a topic and display incoming messages. Use Ctrl+C to
gracefully quit.

Usage:

-addr Adress to connect to. Protocol, host and optional port.

i.e: ws://10.186.0.12 or wss://10.186.0.12:443
-topic Topic to subscribe to
-cg Consumer group
-version Protocol version: v1 or v2
-verbose Prints all request and response messages

Example:

go run client/client.go -addr ws://172.18.0.4:8080 -topic

bp.aeprocessor.v2_0.alarms -version v2 -cg <group> -verbose true

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 44
Blue Planet MCP API Reference Guide, Release 18.06 Using the REST API

Obtain an API token

To obtain an API token, use the User Access Control (UAC) API. You make use of the authentication token
on subsequent operations.

Considerations
• Tokens have a maximum expiry time limit of 24 hours.
• Tokens that are generated and used in a request (API or UI) are considered active tokens and are
subject to the Session Inactivity Timeout value.
• Tokens that are generated but not used in a request (API or UI) are not considered active tokens and
are not subject to the Session Inactivity Timeout value. Tokens will expire at the maximum expiry time
limit of 24 hours.

Figure 4. Obtain an API token API

Before you obtain the API token, make sure that you have Blue Planet MCP credentials (user name and
password).

POST {{MCP_SERVER}}/tron/api/v1/tokens

Enter a valid username, password and tenant. A token is created.

Figure 5. Example of created token in Response Body

Copy the token into the token field in the Swagger UI header. Subsequent operations in Swagger UI will
use this token.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 45
Blue Planet MCP API Reference Guide, Release 18.06 Using the REST API

Figure 6. Example of token copied into the token field

Procedure
• Viewing the REST API documentation

Viewing the REST API documentation

Use this procedure to view the MCP REST API documentation.

You can display the list of operations (or the expanded list of operations) for multiple REST APIs at the
same time.

Prerequisites

Before you perform this procedure:

• You are assigned the necessary security role to execute these APIs. For more information about roles,
see Appendix A: Blue Planet MCP REST API permissions.
• You are logged into Blue Planet MCP.

Steps

1. Select System > APIs (Interactive API Specs).

The list of available API categories is displayed in the left panel.

2. Select a Resource Group.

The APIs for the selected Resource Group are displayed.

Listing operations related to a REST API

3. Click the required API and click List Operations.

The list of operations is displayed.

4. Hide the list by clicking the URI or the Show/Hide toggle.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 46
Blue Planet MCP API Reference Guide, Release 18.06 Using the REST API

5. Repeat step 3 and step 4 for other REST APIs, as applicable.

Expanding operations related to a REST API

6. Click the required URI and click Expanded Operations.

The expanded list of operations displays.

7. Hide the list by clicking the URI or the Show/Hide toggle.

8. Repeat step 6 and step 7 for other REST APIs, as applicable.

End

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 47
Blue Planet MCP API Reference Guide, Release 18.06 MCP REST API collections

MCP REST API collections

This section provides a brief description of the REST API Resource Groups supported by MCP.

Alarms
APIs to manage network alarms.

API Authorization
APIs to configure the permissions necessary to use specific, or all, MCP APIs.

Asset Manager
APIs to manage SSH public keys, upgrade requests, and area files.

Commissioning
APIs to manage commissioning scripts.

Correlator Engine
APIs to correlate network alarms to services.

Equipment
APIs to manage network equipment.

Equipment and Topology Planning

APIs to anticipate equipment and topology requirements.

Equipment groups
APIs to manage equipment groups.

Equipment holders
APIs to manage equipment holders.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 48
Blue Planet MCP API Reference Guide, Release 18.06 MCP REST API collections

Equipment planning and provisioning

APIs to manage equipment intents.

Inventory Overlay
APIs to create and retrieve debug logs and to manage service trails for FREs.

Market
APIs to manage Markets.

Network element configuration

APIs to manage network element configurations.

Network element connection profiles

APIs to manage connection profiles.

MCP provides a default set of network element (NE) connection profiles that can be used to enroll
network elements. A NE connection profile contains details on how to connect to a device type, includes
the connection type to be used (for example, SSH) and also includes the credentials needed to login into
the device.

A user tasked to enroll network elements selects a NE connection profile by reference. This user does not
see the network element login credentials. This ensures network elements are enrolled in a consistent
and secure way.

Existing NE connection profiles can be modified and new profiles can be created.

Network element enrollment (management sessions)

APIs to manage the discovery and enrollment management sessions.

Network element synchronization states

APIs to manage network element inventory synchronization states.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 49
Blue Planet MCP API Reference Guide, Release 18.06 MCP REST API collections

Network elements (constructs)

APIs to manage network constructs and physical locations.

Network elements location (physical)

APIs to manage network elements physical locations.

OnePlanner Import/Export
APIs to retrieve a OnePlanner file from MCP for the entire network and to import a network from
OnePlanner to MCP.

Performance metrics
APIs to collect and query network element performance measurements (PMs).

Policy Manager
APIs to manage policies.

Port inventory (TPEs)

APIs to manage TPEs and TPE expectations. For more information about Termination Point
Encapsulation (TPE), see Topology and the TPE/FRE model.

Project Management
APIs to manage Planning Projects.

RADIUS connection profiles

APIs to manage RADIUS connection profiles.

Resource adapter controller

APIs to manage resource adapters.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 50
Blue Planet MCP API Reference Guide, Release 18.06 MCP REST API collections

Service provisioning (CD fixed)

APIs to deploy and undeploy a Fixed Grid CD service in the network.

Service provisioning (flex)

APIs to deploy and undeploy a Flexible Grid service in the network.

Services inventory (FREs)

APIs to manage FREs and FRE expectations. For more information about Forwarding Relationship
Encapsulation (FRE), see Topology and the TPE/FRE model.

Shelf level view

APIs to manage network element shelf level graphics and layouts.

Test and diagnostics

APIs to manage network testing and diagnostic functions (for example, loopback and link trace).

UAC
APIs to manage the MCP system security.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 51
Blue Planet MCP API Reference Guide, Release 18.06 Planning

Planning
This section describes some of the planning tasks that you can perform using MCP REST APIs.

This section includes the following topics:

• Create a planning project

• Plan a fiber route
• Plan a network change
• Plan equipment
• Create manual topology for links
• Commit a planning project
• Cancel a planning project
• Use a planning project list to validate inter-project compatibility and sequencing
• Heat dissipation policy overview
• Create a global heat dissipation policy
• Create a site heat dissipation policy
• Create a rack/bay heat dissipation policy
• Retrieve or verify a heat dissipation policy
• Planning policy (equipment to be considered during on-line planning)
• Perform viability override
• Retrieving a Project Validation Report

Create a planning project

A Planning Project is a container for a set of changes that can be applied to the network. Planning
Projects can be used to plan for the addition of new Fiber Routes or new Equipment at existing sites.
Planning Projects are hypothetical in nature until they are Committed. Once committed, planning projects
become Intent and have a Completion Date associated with them.

Note: Multiple operations per project are not currently supported. Each project must be of type equipment
(one per site) or fiber route.

To create a planning project, use the Project Management API.

Requirements

Before you start, make sure that you know the planning project definition.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 52
Blue Planet MCP API Reference Guide, Release 18.06 Planning

In your request, modify the example to create a planning project definition, as required.

• The Name must be 1 to 16 alphanumeric characters.

• Dates must be in ISO 8601 format.
• The description is optional.

Sample request

POST {{MCP_SERVER}}/projectmanagment/api/v1/PlanningProjects

{
"name": "ProjectList1_MixEQPT"
}

Sample response

{
"id": "94a527ba-3bb3-44c0-9761-5d11ac2df2a3",
"name": "ProjectList1_MixEQPT",
"projects": [],
"failureReasons": [],
"state": "New",
"syncState": "New"
}

Note: You will copy the project ID or Name from the Response body when you run other APIs.

Plan a fiber route

This section includes the following topics:

• Create a new route between TID or CLLI + NodeID and

• Commit the project

Instructions follow on how to add a new fiber route (ROADM line) to a network with new or existing
ROADMs. You create a sequence of fiber sections between new or existing ROADM nodes. One or more
Line nodes may be present along the route.

Requirements

Before you start, make sure that you have

• Blue Planet MCP Client UI credentials (user name and password)

• for existing ROADMs, enrolled ROADMs to which the degree shelves will be added
• an API token

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 53
Blue Planet MCP API Reference Guide, Release 18.06 Planning

• created a planning project (see Creating a planning project ).

Note: Re-using the same project container for multiple fiber route or equipment projects is not supported.
In other words, only one fiber route or equipment project is supported per planning project.

• the following customer documentation (as applicable):

◦ OnePlanner 6.0.1806 User Guide - Part A (Common), 450-3550-001
◦ OnePlanner 6.0.1806 User Guide-Part B (Designing a Photonic Network), 450-3550-001
◦ the 6500 Packet-Optical Platform, 323-1851-XXX Release 11.5 (or higher) customer documentation
to add new ROADMs and perform system lineup and testing (SLAT) based on the submitted plan

Create a new route between TID or CLLI + NodeID

To create a new route between the TID or CLLI + NodeID, use the Equipment and Topology Planning API.

Note 1: TID or CLLI + NodeID can be used for referencing a node in Fiber Route and Equipment projects.
Use the TID if it is known; otherwise, use CLLI + Node ID.

Note 2: The nodeID is assigned by the user for Gateway Network Elements (GNE). The nodeID must be
unique within a CLLI.

Sample request

POST {{MCP_SERVER}}/equipmenttopologyplanning/api/v1/FiberRoutes

Using the sample provided (as follows), define the Fiber Route as follows:

1. Replace the project ID or Name as required. Copy the new project ID or Name into the appropriate field
(“Id” or “Name”).
2. Set the TID or CLLI+Node ID for the A and Z ends.
3. Set the fiber properties.
4. Set the node types.
5. Optionally, include any ILAs along the span.

Note: Make sure that the direction you specify in the command is a new direction at the existing
ROADM.

Sample request

{
"project":{
"Name":"{{PROJECT_Route1}}"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 54
Blue Planet MCP API Reference Guide, Release 18.06 Planning

},
"sections":[
{
"fiberPairs":[
{
"aEndNode":{
"tid": "{{SITEA}}"
},
"zEndNode":{
"clli": "{{SITEJ}}",
"nodeId": "{{J}}"

},
"cableId":"Cable100",
"aTozFiber":{
"number":100,
"fiberType":"NDSF"
},
"zToaFiber":{
"number":101,
"fiberType":"NDSF"
}
}
],
"aEndPointAttributes":
{
"directionId":3,
"totalNumberOfCmds":1
},
"zEndPointAttributes":
{
"directionId":1,
"totalNumberOfCmds":1
},
"facilities":{
"facilityAtoZ":"SiteAtoJ",
"facilityZtoA":"SiteJtoA"
}
},
. . .
],
"nodes":[
{
"nodeIdentity":{
"tid": "{{SITEA}}"
},
"geoLocation":{
"latitude":36.8203525,
"longitude":-94.8559042
},
"nodeType":"ROADMSMALL"
},
{
"nodeIdentity":{
"clli": "{{SITEJ}}",
"nodeId": "{{J}}"
},
"geoLocation":{
"latitude":36.8303525,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 55
Blue Planet MCP API Reference Guide, Release 18.06 Planning

"longitude":-94.9559042
},
"nodeType":"ROADMLARGE"
. . .
}
]
}

Perform the following using the OnePlanner Client. (For details, see the OnePlanner 6.0.1806 User Guide.)

1. Load the route into the OnePlanner Client.

2. Edit the fiber information, the DCN name, Route ID, and Domain name.

Note: Editing the Route ID and Domain name is optional but recommended to avoid issues (for
example, redundant Domain names or Route IDs).

3. Run ROD.
4. Save the route back to the MCP server.

Project Equipment Summary (optional)

Retrieve a list, grouped by kit, of all the equipment belonging to the project, that is, a Project Equipment
Summary.

To retrieve a Project Equipment Summary, use the Equipment and Topology Planning API.

Sample request

GET {{MCP_SERVER}}/equipmenttopologyplanning/api/v3/EquipmentSummary

Use the project ID or Name (from the preceding section), as follows:

GET
{{MCP_SERVER}}/equipmenttopologyplanning/api/v3/EquipmentSummary?projects={{PROJECT_Route1
}}

{
"projectEquipmentSummary": [
{
"source": {
"project": {
"id": "094772a4-9bd4-4b8a-8b1d-ec9aadc4b012",
"name": "NewACRoute2"
}
},
"equipmentSummary": [
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 56
Blue Planet MCP API Reference Guide, Release 18.06 Planning

"node": {
"nodeIdentity": {
"tid": "PV0410C"
},
"nodeType": "ROADMLARGE",
"amplifierConfigurationType": "Unsupported"
},
"equipmentKits": [
{
"equipmentKitId": "CNASDNLGCTLRBAYD2P",
"oin": "33333.333",
"shelves": [
[
{
"key": "RACK",
"value": "4"
},
{
"key": "PHYSICAL_SHELF",
"value": "1"
}
],
[
{
"key": "RACK",
"value": "4"
},
{
"key": "PHYSICAL_SHELF",
"value": "2"
}
]
],
"maintenanceSpare": false
},
{
"equipmentKitId": "CNASDNSMD14X8",
"oin": "33333.333",
"shelves": [
[
{
"key": "RACK",
"value": "1"
},
{
"key": "PHYSICAL_SHELF",
"value": "1"
}
]
],
"maintenanceSpare": true
},
...
]
}
]
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 57
Blue Planet MCP API Reference Guide, Release 18.06 Planning

Commit the project

Commit the project to create the intent by performing Commit a planning project.

Provision the intent (optional)

Perform the following tasks:

1. Verify the equipment intent as follows. (Optional.)

a. Launch the Blue Planet MCP Client UI:

https://<hostname>/ui

b. Log in if required.
c. Select Network > Resources > Equipment.

The Equipment window displays.

d. Select the Network Elements to which the equipment will be added.

e. Observe the planned equipment.
2. Add the new shelves and perform system lineup and testing (SLAT) based on the submitted plan.

For details, see the applicable customer documentation:

6500 Packet-Optical Platform, 323-1851-XXX Release 11.5 or higher.

3. Verify the new Fiber Route as follows. (This step is optional.)

a. Select Network > Services > Transport infrastructure.

The ROADM Lines window displays.

b. Validate that a ROADM line exists with the endpoints you specified.
4. Verify the equipment intent as follows. (Optional.)
a. Launch the Blue Planet MCP Client UI:

https://<hostname>/ui

b. Log in if required.
c. Select Network > Resources > Equipment.

The Equipment window displays, reporting the total displayed equipment and the selected
equipment.

5. Refine by the Network Elements to which the equipment will be added.

6. Observe the planned equipment.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 58
Blue Planet MCP API Reference Guide, Release 18.06 Planning

7. Add the new ROADMs and perform system lineup and testing (SLAT) on the new ROADMs, based on
the submitted plan.

For details, see the applicable customer documentation: 6500 Packet-Optical Platform, 323-1851-XXX,
Release 11.5 or higher.

8. Enroll the new ROADMs.

For details, see the procedures on enrolling a single network element enrolling multiple network
elements in the Blue Planet MCP User Guide, 450-3709-301.

9. Verify the new Fiber Route as follows. (Optional.)

a. Select Network > Services > Transport infrastructure.
b. Validate that a ROADM line exists between the new ROADMs.

Plan a network change

This chapter provides instructions on how to modify an existing fiber route (ROADM line) by changing the
fibers, turning down nodes, and/or adding new nodes.

Requirements

Before you start, make sure that you have

• Blue Planet MCP Client UI credentials (user name and password)

• the fiber route (ROADM line) to modify already exists
• an API token
• created a planning project (see Creating a planning project ).

Note: Re-using the same project container for multiple network change projects is not supported. In other
words, only one network change project is supported per planning project.

• the following customer documentation (as applicable):

◦ OnePlanner 5.5.18.03 User Guide - Part A (Common), 450-3550-004
◦ OnePlanner 5.5.18.03 User Guide-Part B (Designing a Photonic Network), 450-3550-004
◦ the 6500 Packet-Optical Platform, 323-1851-XXX Release 11.5 (or higher) customer documentation
to add new ROADMs and perform system lineup and testing (SLAT) based on the submitted plan

Update an existing fiber route between TID or CLLI + NodeID

To update an existing route, use the Equipment and Topology Planning API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 59
Blue Planet MCP API Reference Guide, Release 18.06 Planning

Note 1: TID or CLLI + NodeID can be used for referencing a node in Fiber Route and Equipment projects.
Use the TID if it is known; otherwise, use CLLI + Node ID.

Note 2: The nodeID is assigned by the user for Gateway Network Elements (GNE). The nodeID must be
unique within a CLLI.

Sample request

PUT MCP_SERVER/equipmenttopologyplanning/api/v1/fiberroutes

Using the sample provided (as follows), define the Fiber Route as follows:

1. Replace the project ID or Name as required. Copy the new project ID or Name into the appropriate field
(“Id” or “Name”).
2. Set the TID or CLLI+Node ID for the A and Z ends.
3. Set the fiber properties.
4. Set the node types.
5. Optionally, include any ILAs along the span.

Note: 3 Make sure the facilityAtoZ and facilityZtoA match exactly the ROADM line to modify that exists in
the network.

Sample request

{
"project":{
"name":"{{PROJECT_ID}}"
},
"sections":[
{
"fiberPairs":[
{
"aEndNode":{
"tid":"Node1"
},
"zEndNode":{
"tid":"Node2"
},
"cableId":"Cable10",
"aTozFiber":{
"number":1,
"fiberType":"NDSF",
},
"zToaFiber":{
"number":2,
"fiberType":"NDSF",
}
}
],
"aEndPointAttributes":
{
"directionId":1,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 60
Blue Planet MCP API Reference Guide, Release 18.06 Planning

"totalNumberOfCmds":0
},
"zEndPointAttributes":
{
"directionId":1,
"totalNumberOfCmds":0
},
"facilities":{
"facilityAtoZ":"1 DWDMU Node1 Node2",
"facilityZtoA":"2 DWDMU Node1 Node2"
}
}
],
"nodes":[
{
"nodeIdentity":{
"tid":"Node1"
},
"geoLocation":{
"latitude":11.11,
"longitude":11.11
},
"nodeType":"ROADMLARGE"
},
{
"nodeIdentity":{
"tid":"Node2"
},
"geoLocation":{
"latitude":64.6,
"longitude":64.6
},
"nodeType":"ROADMSMALL"
}
]
}

Sample response

{
"addedNodes": [],
"removedNodes": [
{
"tid": "SiteA"
}
],
"addedFibers": [
{
"aEndNode": {
"tid": "Node1"
},
"zEndNode": {
"tid": "Node2"
},
"cableId": "Cable10",
"aTozFiber": {
"number": 1,
"fiberType": "NDSF",
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 61
Blue Planet MCP API Reference Guide, Release 18.06 Planning

"zToaFiber": {
"number": 2,
"fiberType": "NDSF",
}
}
],
"removedFibers": [
{
"aEndNode": {
"tid": "Node1"
},
"zEndNode": {
"tid": "SiteA"
},
"cableId": "Cable1",
"lengthKm": 70,
"aTozFiber": {
"name": "Node1-11-1-5",
"number": 1,
"fiberType": "NDSF",
"lossDb": 16
},
"zToaFiber": {
"name": "SiteA-0-1-5",
"number": 2,
"fiberType": "NDSF",
"lossDb": 16
}
},
{
"aEndNode": {
"tid": "SiteA"
},
"zEndNode": {
"tid": "Node2"
},
"cableId": "Cable5",
"lengthKm": 40,
"aTozFiber": {
"name": "SiteA-0-4-5",
"number": 1,
"fiberType": "NDSF",
"lossDb": 12
},
"zToaFiber": {
"name": "Node2-11-1-5",
"number": 2,
"fiberType": "NDSF",
"lossDb": 12
}
}
]
}

Note 4: The above assumes the ROADM line had topology of Node1 - SiteA - Node2

Node 5: The network change project modified it to be Node1 - Node2

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 62
Blue Planet MCP API Reference Guide, Release 18.06 Planning

Perform the following using the OnePlanner Client. (For details, see the OnePlanner 5.5.18.03 User Guide.)

1. Load the route into the OnePlanner Client.

2. Edit the fiber information.
3. Run ROD.
4. Save the route back to the MCP server.

Commit the project

Commit the project to create the intent by performing commit a planning project (see commit a planning
project).

Plan equipment
Instructions follow on how to plan new equipment at existing ROADM nodes. New equipment can be one
or more of the following:

• transponder bays (and shelves)

• add/drop banks
• CMDs to existing add/drop banks
• termination equipment groups associated with existingCMDs, comprised of either:
◦ 10x10G Muxponder with 10G pluggable(s) and 100G OCLD or
◦ 100G OCI and 100G OCLD or
◦ 100G OTR
◦ a 100G Regen (comprised of two 100G OCLDs in adjacentslots in a transponder shelf

If the transponder shelf has no empty slots, the cards can also be slotted in mixed/photonic
shelves.

• one or more pluggables associated with existing 10x10G Muxponders

This section includes the following topics:

• Create an Add Equipment Request

Note: You must create an Add Equipment Request and perform one or more of the following tasks:

• Plan Transponder bays and shelves and

• Plan an add/drop bank on an existing direction of a large ROADM
• Plan CMDs to be associated with an existing add/drop bank
• Plan a Termination Equipment Group comprised of a 100G OTR

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 63
Blue Planet MCP API Reference Guide, Release 18.06 Planning

• Plan a Termination Equipment Group comprised of a 100G Regen

• Plan one or more pluggables associated with existing 10x10 Muxponders
• Updating the customer code on equipment after submitting the planning request

Termination equipment groups associated with existing CMDs are comprised of either:

• 10x10G Muxponder with 10G pluggables(s) and 100G OCLD or

• 100G OCI and 100G OCLD or
• 100G OTR (Note: The instructions in Plan a Termination Equipment Group comprised of a 100G OTR
relate to 100G OTR only, not the other CMDs in this list.) or
• a 100G Regen (two 100G OCLDs in adjacent slots) in a transponder shelf

Note: If the transponder shelf has no empty slots, the cards can also be slotted in mixed/photonic
shelves.

Requirements

Before you start, make sure that you have

• logged into the Blue Planet MCP Client UI

• enrolled or committed plans for ROADMs for both ends of the link
• an API token
• created a planning project Create a planning project

Note 1: Reusing the same planning project with multiple Equipment projects or Fiber Routes projects is
not supported. Add all the equipment within the same command.

Note 2: If adding equipment to a node that is being introduced or modified by another planning project,
you must commit the previous project (see commit a planning project) before its equipment can be used
to add more new equipment. Alternatively, a ProjectList may be used to plan equipment on an
uncommitted node. For details, see Project Lists.

• if you are adding an add/drop bank, a large ROADM network element where at least one direction
exists (real or planned) without the corresponding add/drop bank
• performed the following

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 64
Blue Planet MCP API Reference Guide, Release 18.06 Planning

CAUTION

Risk of topology configuration operations failure

Confirm the following before inserting add/drop cards planned using an

equipment project:

• all member shelves are associated with the primary shelf in an alarm-free
state, and
• all member shelves are in service

Failure to do so can result in topology configuration operations failures at the

network element.

Create an Add Equipment Request

To add equipment to your project (plan equipment), use the Equipment and Topology Planning API.

Sample request

POST {MCP_SERVER}/equipmenttopologyplanning/api/v1/Equipment

Create an AddEquipmentRequest by modifying the sample request as follows:

1. Set the projectId or ProjectName to the ID or Name of the project to which the equipment will be
added.
2. Optionally, set the ProjectList id or name to the ID or Name of the ProjectList that the new equipment
is to be planned relative to.
3. In nodeIdentity, specify the TID or CLLI+Node ID of the device to which the equipment will be added.

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 65
Blue Planet MCP API Reference Guide, Release 18.06 Planning

{
"project": {
"id": "string",
"name": "string"
},
"projectList": {
"id": "string",
"name": "string"
},
"equipmentAdditions": [
{
"nodeIdentity": {
"clli": "string",
"nodeId": 0,
"tid": "string"
},

Plan Transponder bays and shelves

Provide a Transponder bay section. Specify the bayID of one or more bays.

Note: The bayID must be higher than 15.

Sample request

"transponderBays": [
{
"bayId": 0
}
]}

Plan an add/drop bank on an existing direction of a large ROADM

Provide an addDropBanks section. Specify the direction id and the total required CMD count.

Sample request

"addDropBanks": [
{
"addDropBankId": 2,
"totalCmdCount": 1
}
]

Plan CMDs to be associated with an existing add/drop bank

Provide a cmds section. Specify the part number or part provisioning name, the add/drop bank to connect

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 66
Blue Planet MCP API Reference Guide, Release 18.06 Planning

to, and the total required CMD count.

Sample request

"cmds": [
{
"equipmentSpec": {
"partNumber": "string"
},
"addDropBankId": 0,
"totalCount": 0
}
],

Plan a Termination Equipment Group comprised of a 100G OTR

Provide a termination EquipmentGroup with the product engineering code (PEC) or the provisioning name
of the OTR to be added. Specify the add-drop bank to which the equipment will be added.

Note: The instructions in this section relate to 100G OTR only.

Sample request

"terminationEquipmentGroups": [
{
"equipments": [
{
"equipmentSpec":
{ "partNumber": "NTK529BB"},
"
]
},
{
"equipmentSpec":
{ "partNumber": "NTK539UJ" },
"additionalAttributes": [
{
"key": "ADDDROPBANK",
"value": "1"
}
]
}
]
}

Plan a Termination Equipment Group comprised of a 100G

Regen
This example is for a 100G Regen with two 100G OCLDs in adjacent slots in a transponder shelf.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 67
Blue Planet MCP API Reference Guide, Release 18.06 Planning

Provide a termination EquipmentGroup with the product engineering code (PEC) or the provisioning name
of the interface cards to be added. Optionally, specify the add/drop bank. If the add/drop bank is not
specified, the API will pick diversified add/drop banks if they have a pair of free CMD ports. Specify the
add/drop bank to which the equipment will be added.

Note: If the transponder shelf has no empty slots, the cards can also be slotted in mixed/photonic
shelves.

Sample request

"terminationEquipmentGroups": [
{
"equipments": [
{
"equipmentSpec": {
"partNumber": "NTK539UJ"
},
"customerCode": "code",
"additionalAttributes": [
{
"key": "ADDDROPBANK",
"value": "2"
}
]
},
{
"equipmentSpec": {
"partNumber": "NTK539UJ"
},
"customerCode": "code",
"additionalAttributes": [
{
"key": "ADDDROPBANK",
"value": "5"
}
]
}
],
"regen":true
}
]

Note: The example shows two add/drop banks. If you specify only one add/drop bank or do not specify
any add/drop bank, then the add/drop bank(s) will be automatically selected based on the equipment
diversity rule. Both Regen cards are located in the same shelf. Each of the Regen cards will be connected
to an add/drop bank in a different shelf. (For example, Regen card A is connected to the add/drop bank in
Shelf X and Regen card B is connected to the add/drop bank in Shelf Y.)

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 68
Blue Planet MCP API Reference Guide, Release 18.06 Planning

Plan one or more pluggables associated with existing 10x10

Muxponders
Provide a pluggables section with the product engineering code (PEC) or provisioning name of the
pluggables to be added and specify the location (of the existing Muxponder) for the pluggable.

Optionally, specify the customer code associated with the pluggable.

Sample request

"pluggables": [
{
"equipmentSpec": {
"partNumber": "string"
},
"location": {
"mgmtAccess": "TL1_ACCESS",
"address": [
{
"key": "RACK",
"value": "string",
"pattern": "string"
}
]
},
"customerCode": "string"
}

Updating the customer code on equipment after submitting the

planning request
To update the customer code on equipment after submitting the planning request, perform the following
tasks:

1. Query the equipment by equipment intent.

2. Update the customer code.

Note: Only equipments which were planned using MCP can be updated. You cannot use this API to
update discovered equipments.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 69
Blue Planet MCP API Reference Guide, Release 18.06 Planning

Sample request

{
"data": {
"attributes": {
"intentId": "5a33f196-09ef-4ab4-b45b-1c19036f910a",
"equipment": [
{
"eqpId": "6522bec9-603e-36af-b8f6-5b8148fba41d::EQPT_1_41",
"customerCode": "New customer code"
}
]
}
}
}

Producing a project list (optional)

To create a new project list, use the Project Management API.

Sample request

POST {MCP_SERVER}/projectmanagement/api/v2/ProjectLists

Perform the following tasks:

1. Specify the Project ID or Name (already created based on Create an Add Equipment Request).
2. Commit the project to create the intent by performing commit a planning project.
3. Create a ProjectList by modifying the Sample request as follows:
a. Optionally, set the ProjectList id or name to the ID or Name of the ProjectList that the new
equipment is to be planned relative to.
b. Set the projectId or ProjectName to the ID or Name of the project to which the equipment will be
added.

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 70
Blue Planet MCP API Reference Guide, Release 18.06 Planning

{
"id": "string",
"name": "string",
"validatedDate": "2017-03-10T15:21:05.490Z",
"committedDate": "2017-03-10T15:21:05.490Z",
"projects": [
{
"id": "string",
"name": "string"
}
],
"failureReasons": [
{
"project": {
"id": "string",
"name": "string"
},
"failureReasons": [
"string"
]
}
],
"state": "New",
"syncState": "New"
}

Create manual topology for links

You can create manual topology for links, so that services can be routed over sections of the network
where topology cannot be discovered.

Note: This action is only available for users with “update inventory” privileges.

Manual topology REST interface includes the following:

• REST endpoint for Manual Topology creation

POST {{MCP_SERVER}}/ifd/api/v3/equipmentIntents

• REST endpoint for fetching Manual Topology

GET {{MCP_SERVER}}/nsi/api/v3/fres?freExpectations.equipmentIntent.id=EQUIP_INTENT_ID

• Rest endpoint for deleting Manual Topology

DELETE {{MCP_SERVER}}/ifd/api/equipmentIntents/EQUIP_INTENT_ID

Sample Manual Topology request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 71
Blue Planet MCP API Reference Guide, Release 18.06 Planning

"data" : {
"attributes" : {
"equipmentGroups" : [ ],
"equipment" : [ {
"eqpId" : "G5832-4-SITEB-014::1::EQPT-2-9",
"projectID" : "FR123",
"networkElements" : [ {
"name" : "G5832-4-SITEB-014",
"deviceType" : "PN6x",
"softwareVersion" : "12.3"
} ],
"shelf" : "2",
"slot" : "9",
"endpoints" : [ {
"port" : "5",
"layerTerminations" : [ {
"layerRate" : "OTU2e",
"manualAdjacencyPackage" : {
"adjacencyType" : "TXRX",
"localTag" : "G5832-4-SITEB-014-2-9-5",
"provisionedRemoteTag" : "G5832-4-SITED-016-4-2-2",
"remoteTagFormat" : "PID-SH-SL-PRT",
"adjacencyMechanism" : "OTU",
"linkAttributes" : {
"tags" : [ "Manual Topology" ],
"description" : "Topology description for Manual Topology in case
of TPEs exist",
"userLabel" : "Ref to third party network"
}
},
"cfmPackages" : [ ],
"trafficProfiles" : [ ],
"boundaries" : [ ],
"bundleIds" : [ ]
} ],
"controlPlaneLines" : [ ]
} ],
"equipmentOperation" : "UPDATE_ADJ"
}, {
"eqpId" : "G5832-4-SITED-016::1::EQPT-4-2",
"projectID" : "FR124",
"networkElements" : [ {
"name" : "G5832-4-SITED-016",
"deviceType" : "PN6x",
"softwareVersion" : "12.3"
} ],
"shelf" : "4",
"slot" : "2",
"endpoints" : [ {
"port" : "2",
"layerTerminations" : [ {
"layerRate" : "OTU2e",
"manualAdjacencyPackage" : {
"adjacencyType" : "TXRX",
"localTag" : "G5832-4-SITED-016-4-2-2",
"provisionedRemoteTag" : "G5832-4-SITEB-014-2-9-5",
"remoteTagFormat" : "PID-SH-SL-PRT",
"adjacencyMechanism" : "OTU",
"linkAttributes" : {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 72
Blue Planet MCP API Reference Guide, Release 18.06 Planning

"tags" : [ "Manual Topology" ],

"description" : "Topology description for Manual Topology in case
of TPEs exist",
"userLabel" : "Ref to third party network"
}
},
"cfmPackages" : [ ],
"trafficProfiles" : [ ],
"boundaries" : [ ],
"bundleIds" : [ ]
} ],
"controlPlaneLines" : [ ]
} ],
"equipmentOperation" : "UPDATE_ADJ"
} ]
}
}
}

Sample Manual Topology Fres with expectations

{
"data": [
{
"id": "6582320231977506248",
"type": "fres",
"attributes": {
"operationState": "In Service",
"deploymentState": "discovered",
"derivedAttributes": {
"intentLifeCyclePhase": "adopting discovered",
"intentDeploymentState": "waiting to adopt"
},
"displayData": {
"intentLifeCyclePhaseString": "Discovered",
"operationState": "Up",
"adminState": "Enabled"
},
"resourceState": "plannedAndDiscovered",
"policies": {
"defaultAttributeSourcePolicy": "discoveredOverPlanned",
"overrides": [
{
"attributeName": "attributes.userLabel",
"policies": [
"plannedOverDiscovered"
]
},
{
"attributeName": "attributes.description",
"policies": [
"plannedOverDiscovered"
]
}
]
},
"tags": [

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 73
Blue Planet MCP API Reference Guide, Release 18.06 Planning

"Manual",
"Topology"
],
"userLabel": "Ref to third party network",
"mgmtName": "",
"nativeName": "",
"layerRate": "OTU2",
"layerRateQualifier": "OTU2e",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"manual"
],
"adminState": "In Service",
"active": true,
"additionalAttributes": {
"isActual": "true"
},
"reliability": "auto",
"description": "Topology description for Manual Topology in case of
TPEs exist",
"resilienceLevel": "unprotected"
},
"relationships": {
"freExpectations": {
"data": [
{
"type": "freExpectations",
"id": "6582320231977506248::8a6c7d43-0bdd-468d-b2f8-
a71a319052da"
}
]
},
"freDiscovered": {
"data": {
"type": "freDiscovered",
"id": "6582320231977506248"
}
},
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "6582320231977506248:1"
},
{
"type": "endPoints",
"id": "6582320231977506248:2"
}
]
}
}
}
],
"included": [
{
"id": "6582320231977506248:1",
"type": "endPoints",
"attributes": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 74
Blue Planet MCP API Reference Guide, Release 18.06 Planning

"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "b3d22bd3-41b7-36f5-8d97-
6b980ac29adf::TPE_b3d22bd3-41b7-36f5-8d97-6b980ac29adf::EQPT_4_2-2-
CTPServerToClient"
}
]
}
}
},
{
"id": "6582320231977506248:2",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "c861b612-71bd-35ab-8489-
923da73ac2af::TPE_c861b612-71bd-35ab-8489-923da73ac2af::EQPT_2_9-5-
CTPServerToClient"
}
]
}
}
},
{
"id": "6582320231977506248::8a6c7d43-0bdd-468d-b2f8-a71a319052da",
"type": "freExpectations",
"attributes": {
"userLabel": "Ref to third party network",
"mgmtName": "",
"nativeName": "",
"layerRate": "OTU2",
"layerRateQualifier": "OTU2e",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"manual"
],
"adminState": "In Service",
"active": true,
"reliability": "auto",
"description": "Topology description for Manual Topology in case of
TPEs exist",
"resilienceLevel": "unprotected"
},
"relationships": {
"equipmentIntent": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 75
Blue Planet MCP API Reference Guide, Release 18.06 Planning

"data": {
"type": "equipmentIntents",
"id": "8a6c7d43-0bdd-468d-b2f8-a71a319052da"
}
},
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "6582320231977506248:1"
},
{
"type": "endPoints",
"id": "6582320231977506248:2"
}
]
}
}
}
]
}

Sample Manual Topology Tpes with expectations

{
"links": {},
"data": [
{
"id": "b3d22bd3-41b7-36f5-8d97-6b980ac29adf::TPE_b3d22bd3-41b7-36f5-
8d97-6b980ac29adf::EQPT_4_2-2-CTPServerToClient",
"type": "tpes",
"attributes": {
"state": "IS",
"identifiers": [
{
"networkConstructId": "b3d22bd3-41b7-36f5-8d97-
6b980ac29adf",
"nodalId": "b3d22bd3-41b7-36f5-8d97-
6b980ac29adf::TPE_b3d22bd3-41b7-36f5-8d97-6b980ac29adf::EQPT_4_2-2-
CTPServerToClient"
}
],
"resourceState": "plannedAndDiscovered",
"structureType": "CTPServerToClient",
"nativeName": "OTUTTP-4-2-2",
"locations": [
{
"managementType": "tl1",
"shelf": "4",
"slot": "2",
"port": "2"
}
],
"layerTerminations": [
{
"layerRate": "OTU2",
"layerRateQualifier": "OTU2e",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 76
Blue Planet MCP API Reference Guide, Release 18.06 Planning

"structureType": "full layer fixed",

"terminationState": "layer termination permanently
terminated",
"adminState": "up",
"operationalState": "up",
"active": true,
"nativeName": "OTUTTP-4-2-2",
"additionalAttributes": {
"numOtnTribSlots": "1",
"otnLineRate": "OTU2e",
"forwardingState": "LT_CANNOT_FORWARD_TO_FROM_FRE"
}
},
{
"layerRate": "DSR",
"structureType": "full layer fixed",
"terminationState": "layer termination permanently
terminated",
"active": true,
"additionalAttributes": {
"forwardingState": "LT_CANNOT_FORWARD_TO_FROM_FRE"
}
}
],
"stackDirection": "bidirectional",
"displayAlias": "OTUTTP-4-2-2",
"fgiSpecificationRefList": [
"ODU_Switch_FG:1:4"
],
"totalCapacity": [
{
"layer": "ODU2e",
"capacity": 1,
"capacitySize": {
"size": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8"
],
"pattern": {
"type": "LIST",
"format": "TribSlot"
},
"unit": "ODU0TS"
}
}
],
"usedCapacity": [
{
"layer": "ODU2e",
"capacity": 0,
"capacitySize": {
"size": [],
"pattern": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 77
Blue Planet MCP API Reference Guide, Release 18.06 Planning

"type": "LIST",
"format": "TribSlot"
},
"unit": "ODU0TS"
}
}
],
"cardType": "P10GSOEL",
"active": true,
"lifeCycleRules": {
"autoCreatedByNetwork": true,
"autoDeletedByNetwork": true
},
"additionalAttributes": {
"alarmResourceId": "OTUTTP-4-2-2"
}
},
"relationships": {
"tpePlanned": {
"data": {
"type": "tpePlanned",
"id": "b3d22bd3-41b7-36f5-8d97-6b980ac29adf::TPE_b3d22bd3-
41b7-36f5-8d97-6b980ac29adf::EQPT_4_2-2-CTPServerToClient"
}
},
"tpeExpectations": {
"data": [
{
"type": "tpeExpectations",
"id": "b3d22bd3-41b7-36f5-8d97-
6b980ac29adf::TPE_b3d22bd3-41b7-36f5-8d97-6b980ac29adf::EQPT_4_2-2-
CTPServerToClient::8a6c7d43-0bdd-468d-b2f8-a71a319052da"
}
]
},
"tpeDiscovered": {
"data": {
"type": "tpeDiscovered",
"id": "b3d22bd3-41b7-36f5-8d97-6b980ac29adf::TPE_b3d22bd3-
41b7-36f5-8d97-6b980ac29adf::EQPT_4_2-2-CTPServerToClient"
}
},
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "b3d22bd3-41b7-36f5-8d97-6b980ac29adf"
},
"meta": {
"partiallyPopulated": true
}
},
"equipment": {
"data": {
"type": "equipment",
"id": "b3d22bd3-41b7-36f5-8d97-6b980ac29adf::EQPT_4_2_2"
}
},
"owningServerTpe": {
"data": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 78
Blue Planet MCP API Reference Guide, Release 18.06 Planning

"type": "tpes",
"id": "b3d22bd3-41b7-36f5-8d97-6b980ac29adf::TPE_b3d22bd3-
41b7-36f5-8d97-6b980ac29adf::EQPT_4_2-2-PTP"
}
}
}
},
{
"id": "c861b612-71bd-35ab-8489-923da73ac2af::TPE_c861b612-71bd-35ab-
8489-923da73ac2af::EQPT_2_9-5-CTPServerToClient",
"type": "tpes",
"attributes": {
"state": "IS",
"identifiers": [
{
"networkConstructId": "c861b612-71bd-35ab-8489-
923da73ac2af",
"nodalId": "c861b612-71bd-35ab-8489-
923da73ac2af::TPE_c861b612-71bd-35ab-8489-923da73ac2af::EQPT_2_9-5-
CTPServerToClient"
}
],
"resourceState": "plannedAndDiscovered",
"structureType": "CTPServerToClient",
"nativeName": "OTUTTP-2-9-5",
"locations": [
{
"managementType": "tl1",
"shelf": "2",
"slot": "9",
"port": "5"
}
],
"layerTerminations": [
{
"layerRate": "OTU2",
"layerRateQualifier": "OTU2e",
"structureType": "full layer fixed",
"terminationState": "layer termination permanently
terminated",
"adminState": "up",
"operationalState": "up",
"active": true,
"nativeName": "OTUTTP-2-9-5",
"additionalAttributes": {
"numOtnTribSlots": "1",
"otnLineRate": "OTU2e",
"forwardingState": "LT_CANNOT_FORWARD_TO_FROM_FRE"
}
},
{
"layerRate": "DSR",
"structureType": "full layer fixed",
"terminationState": "layer termination permanently
terminated",
"active": true,
"additionalAttributes": {
"forwardingState": "LT_CANNOT_FORWARD_TO_FROM_FRE"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 79
Blue Planet MCP API Reference Guide, Release 18.06 Planning

}
],
"stackDirection": "bidirectional",
"displayAlias": "OTUTTP-2-9-5",
"fgiSpecificationRefList": [
"ODU_Switch_FG:1:2"
],
"totalCapacity": [
{
"layer": "ODU2e",
"capacity": 1,
"capacitySize": {
"size": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8"
],
"pattern": {
"type": "LIST",
"format": "TribSlot"
},
"unit": "ODU0TS"
}
}
],
"usedCapacity": [
{
"layer": "ODU2e",
"capacity": 0,
"capacitySize": {
"size": [],
"pattern": {
"type": "LIST",
"format": "TribSlot"
},
"unit": "ODU0TS"
}
}
],
"cardType": "PXFP",
"active": true,
"lifeCycleRules": {
"autoCreatedByNetwork": true,
"autoDeletedByNetwork": true
},
"additionalAttributes": {
"alarmResourceId": "OTUTTP-2-9-5"
}
},
"relationships": {
"tpePlanned": {
"data": {
"type": "tpePlanned",
"id": "c861b612-71bd-35ab-8489-923da73ac2af::TPE_c861b612-

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 80
Blue Planet MCP API Reference Guide, Release 18.06 Planning

71bd-35ab-8489-923da73ac2af::EQPT_2_9-5-CTPServerToClient"
}
},
"tpeExpectations": {
"data": [
{
"type": "tpeExpectations",
"id": "c861b612-71bd-35ab-8489-
923da73ac2af::TPE_c861b612-71bd-35ab-8489-923da73ac2af::EQPT_2_9-5-
CTPServerToClient::8a6c7d43-0bdd-468d-b2f8-a71a319052da"
}
]
},
"tpeDiscovered": {
"data": {
"type": "tpeDiscovered",
"id": "c861b612-71bd-35ab-8489-923da73ac2af::TPE_c861b612-
71bd-35ab-8489-923da73ac2af::EQPT_2_9-5-CTPServerToClient"
}
},
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "c861b612-71bd-35ab-8489-923da73ac2af"
},
"meta": {
"partiallyPopulated": true
}
},
"equipment": {
"data": {
"type": "equipment",
"id": "c861b612-71bd-35ab-8489-923da73ac2af::EQPT_2_9_5"
}
},
"owningServerTpe": {
"data": {
"type": "tpes",
"id": "c861b612-71bd-35ab-8489-923da73ac2af::TPE_c861b612-
71bd-35ab-8489-923da73ac2af::EQPT_2_9-5-PTP"
}
}
}
}
],
"included": [
{
"id": "b3d22bd3-41b7-36f5-8d97-6b980ac29adf::TPE_b3d22bd3-41b7-36f5-
8d97-6b980ac29adf::EQPT_4_2-2-CTPServerToClient::8a6c7d43-0bdd-468d-b2f8-
a71a319052da",
"type": "tpeExpectations",
"attributes": {
"layerTerminations": [
{
"layerRate": "OTU2",
"layerRateQualifier": "OTU2e",
"structureType": "full layer fixed",
"terminationState": "layer termination permanently
terminated",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 81
Blue Planet MCP API Reference Guide, Release 18.06 Planning

"adminState": "up",
"operationalState": "up",
"active": true,
"manualAdjacencyPackage": {
"adjacencyType": "TXRX",
"localTag": "G5832-4-SITED-016-4-2-2",
"provisionedRemoteTag": "G5832-4-SITEB-014-2-9-5",
"remoteTag": "G5832-4-SITEB-014-2-9-5",
"remoteTagFormat": "PID-SH-SL-PRT",
"adjacencyMechanism": "OTU",
"linkAttributes": {
"tags": [
"Manual",
"Topology"
],
"description": "Topology description for Manual
Topology in case of TPEs exist",
"userLabel": "Ref to third party network"
}
},
"nativeName": "OTUTTP-4-2-2",
"additionalAttributes": {
"numOtnTribSlots": "1",
"otnLineRate": "OTU2e",
"forwardingState": "LT_CANNOT_FORWARD_TO_FROM_FRE"
}
},
{
"layerRate": "DSR",
"structureType": "full layer fixed",
"terminationState": "layer termination permanently
terminated",
"active": true,
"additionalAttributes": {
"forwardingState": "LT_CANNOT_FORWARD_TO_FROM_FRE"
}
}
],
"stackDirection": "bidirectional",
"active": true,
"additionalAttributes": {
"alarmResourceId": "OTUTTP-4-2-2",
"stitchingInput": "true"
}
},
"relationships": {
"equipmentIntent": {
"data": {
"type": "equipmentIntents",
"id": "8a6c7d43-0bdd-468d-b2f8-a71a319052da"
}
},
"owningServerTpe": {
"data": {
"type": "tpes",
"id": "b3d22bd3-41b7-36f5-8d97-6b980ac29adf::TPE_b3d22bd3-
41b7-36f5-8d97-6b980ac29adf::EQPT_4_2-2-PTP"
}
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 82
Blue Planet MCP API Reference Guide, Release 18.06 Planning

}
},
{
"id": "c861b612-71bd-35ab-8489-923da73ac2af::TPE_c861b612-71bd-35ab-
8489-923da73ac2af::EQPT_2_9-5-CTPServerToClient::8a6c7d43-0bdd-468d-b2f8-
a71a319052da",
"type": "tpeExpectations",
"attributes": {
"layerTerminations": [
{
"layerRate": "OTU2",
"layerRateQualifier": "OTU2e",
"structureType": "full layer fixed",
"terminationState": "layer termination permanently
terminated",
"adminState": "up",
"operationalState": "up",
"active": true,
"manualAdjacencyPackage": {
"adjacencyType": "TXRX",
"localTag": "G5832-4-SITEB-014-2-9-5",
"provisionedRemoteTag": "G5832-4-SITED-016-4-2-2",
"remoteTag": "G5832-4-SITED-016-4-2-2",
"remoteTagFormat": "PID-SH-SL-PRT",
"adjacencyMechanism": "OTU",
"linkAttributes": {
"tags": [
"Manual",
"Topology"
],
"description": "Topology description for Manual
Topology in case of TPEs exist",
"userLabel": "Ref to third party network"
}
},
"nativeName": "OTUTTP-2-9-5",
"additionalAttributes": {
"numOtnTribSlots": "1",
"otnLineRate": "OTU2e",
"forwardingState": "LT_CANNOT_FORWARD_TO_FROM_FRE"
}
},
{
"layerRate": "DSR",
"structureType": "full layer fixed",
"terminationState": "layer termination permanently
terminated",
"active": true,
"additionalAttributes": {
"forwardingState": "LT_CANNOT_FORWARD_TO_FROM_FRE"
}
}
],
"stackDirection": "bidirectional",
"active": true,
"additionalAttributes": {
"alarmResourceId": "OTUTTP-2-9-5",
"stitchingInput": "true"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 83
Blue Planet MCP API Reference Guide, Release 18.06 Planning

},
"relationships": {
"equipmentIntent": {
"data": {
"type": "equipmentIntents",
"id": "8a6c7d43-0bdd-468d-b2f8-a71a319052da"
}
},
"owningServerTpe": {
"data": {
"type": "tpes",
"id": "c861b612-71bd-35ab-8489-923da73ac2af::TPE_c861b612-
71bd-35ab-8489-923da73ac2af::EQPT_2_9-5-PTP"
}
}
}
}
]
}

Commit a planning project

This section includes the following topics:

• Commit a fiber route, equipment, or network change project

• Query the project to see the status
• Verify the planning project (optional) (using the BP MCP UI)
• Update a committed planning project (optional) (using OnePlanner)
• Store SRLG data on ROADM lines

Requirements

Before you start, make sure that you have performed the applicable task: * Plan a fiber route * Plan
equipment

Note: A site ID might change during the planning phase of project. Only at commit time will the value be
final. The OnePlanner UI might not show the updated site ID after the project is committed.

Commit a fiber route, equipment, or network change project

To Commit a fiber route, equipment, or network change project, use the Project Management API. Use
one of two options, as required:

• Option A

• Option B

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 84
Blue Planet MCP API Reference Guide, Release 18.06 Planning

Sample request — Option A

POST {{MCP_SERVER}}/projectmanagement/api/v1/PlanningProjects/{id}/commitOperation

Sample request — Option B

POST {{MCP_SERVER}}/projectmanagement/api/v1/PlanningProjects/commitOperation

Enter the id or name (as applicable) into the Value field.

POST
{{MCP_SERVER}}/projectmanagement/api/v1/PlanningProjects/Commit?name={{PROJECT_Route1}}

Sample response

200 Ok

Query the project to see the status

Query the project to see its status by using the Project Management API.

Sample request

GET {{MCP_SERVER}}/projectmanagement/api/v1/PlanningProjects

The operation will be complete when the project state indicates: “Committed”.

Sample response

{
"Id": "094772a4-9bd4-4b8a-8b1d-ec9aadc4b012",
"Name": "NewACRoute2",
"CompletionDate": "2017-12-31T23:59:59+00:00",
"ExpirationDate": null,
"State": "Committing",
"Description": null,
"StatusMessage": "Fiber route request succeeded",
"IntentId": null,
"ProjectListId": "94a527ba-3bb3-44c0-9761-5d11ac2df2a3"
}

If the state is “Committing”, wait a few seconds and issue the query again.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 85
Blue Planet MCP API Reference Guide, Release 18.06 Planning

Verify the planning project (optional)

Verify the equipment intent as follows. (Optional.)

1. Launch the Blue Planet MCP Client UI: https://<hostname>/ui

2. Log in if required.
3. Select Network > Resources > Equipment.

The Equipment window displays.

4. Select the Network Elements to which the equipment will be added.

5. From the Availability option, check Planned.
6. Observe the planned equipment.

Update a committed planning project (optional)

After a planning project is committed, you can update the following attributes, if required: fiber number,
fiber loss and amplifier provisioning.

1. Open the project in the OnePlanner client and modify the fiber number, fiber loss, or amplifier
provisioning attributes. See “Editing the fiber parameters for a committed Blue Planet MCP project” in
the OnePlanner 6.0.1806 User Guide – Part B (Designing a Photonic network), 450-3550-001, for more
details.
2. Run ROD without the equipment placement option if amplifiers need to be re-provisioned.
3. Save the project back to the Blue Planet MCP server.
4. Make sure you re-create the commissioning script, if required. For more details, see Generate
commissioning scripts.

Store SRLG data on ROADM lines

This section provides examples for updating Shared Resource Link Group (SRLG) data on ROADM lines
and retrieving that data:

• Update SRLG data on ROADM lines

• Retrieve SRLG data by ID
• Delete SRLG data on ROADM lines

Update SRLG data on ROADM lines

To manually update SRLG data, use the SRLG API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 86
Blue Planet MCP API Reference Guide, Release 18.06 Planning

Requirements

Provide the following attributes:

• resourceId: Is the FreId of the ROADM line.

• resourceType: Is the Fre.
• resourceName: Is the userLabel of the ROADM line.

Note: Provide either the resourceId or resourceName. If both attributes are present, there will be a
failure due to ambiguity.

• srlgSet: Is an object of plannedStartDate and list of srlgValues. If plannedStartDate is not provided,

then IFD will use the current date. The date format is “YYYY-MM-DDTHH:MM:SS.SSSZ”.

Sample request

PUT {{MCP_SERVER}}/ifd/api/v1/srlg

Sample request body

{
"data": {
"attributes": {
"resourceName": "1 DWDMU PV0754A111 PV0754B111",
"resourceType": "Fre",
"srlgSet": [
{
"srlgValues": [
"10234",
"20567"
],
"plannedStartDate": "2019-11-19T11:37:29.739Z"
}
]
}
}
}

Sample response

A response code of 200 indicates that the SRLG was successfully updated.

Sample response body

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 87
Blue Planet MCP API Reference Guide, Release 18.06 Planning

{
"data": {
"id": "b9dcfb7a-4043-47ad-9dbe-b4c31e3f1479",
"requestType": "srlgRequest",
"attributes": {
"resourceId": "<<freId>>>",
"resourceType": "Fre",
"srlgSet": [
{
"srlgValues": [
"abc"
],
"structuredSRLGValues": []
}
]
}
}
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 88
Blue Planet MCP API Reference Guide, Release 18.06 Planning

Retrieve SRLG data by ID

To retrieve SRLG data by ID, use the SRLG API.

Requirements

In the resourceID field, provide the FreId of the ROADM line.

Sample request

GET {{MCP_SERVER}}/ifd/api/v1/srlg/{id}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 89
Blue Planet MCP API Reference Guide, Release 18.06 Planning

{
"data": {
"requestType": "srlgRequest",
"attributes": {
"resourceId": "-2665141645553035328",
"resourceType": "Fre",
"srlgSet": [
{
"id": "0579fff9-9557-42c6-9d88-978aef0a691f",
"srlgValues": [
"att10"
],
"structuredSRLGValues": []
},
{
"id": "10ceb9e4-4772-42b1-b2e5-2b165a0cd8ed",
"plannedStartDate": "2018-11-19T11:37:29.739Z",
"srlgValues": [
"10697",
"10234"
],
"structuredSRLGValues": []
},
{
"id": "89a81a60-a1fa-4a11-bfca-2b778df0439f",
"plannedStartDate": "2019-11-19T11:37:29.739Z",
"srlgValues": [
"10234",
"20567"
],
"structuredSRLGValues": []
},
{
"id": "c29a68ff-256c-4cf3-b1e6-f8bd4d76d83e",
"plannedStartDate": "2018-06-24T17:02:15.632Z",
"srlgValues": [
"20234",
"30567"
],
"structuredSRLGValues": []
},
{
"id": "daf570c3-21f8-46c1-94b2-9d928897cf19",
"plannedStartDate": "2018-06-24T17:00:26.149Z",
"srlgValues": [
"10697",
"10234"
],
"structuredSRLGValues": []
}
]
}
}
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 90
Blue Planet MCP API Reference Guide, Release 18.06 Planning

Delete SRLG data on ROADM lines

To delete update SRLG data, use the SRLG API.

Requirements

If the empty srlgSet (srlgSet with no value) is applied, then the existing SLRG data is deleted.

Sample request

PUT {{MCP_SERVER}}/ifd/api/v1/srlg

Sample request body

{
"data": {
"attributes": {
"resourceId": "-1051233137015796590",
"resourceType": "Fre",
"srlgSet": []
}
}
}

Sample response body

{
"data": {
"id": "0a5e1eb9-2f19-4bf5-9775-50e0d4f56f6e",
"requestType": "srlgRequest",
"attributes": {
"resourceId": "-1051233137015796590",
"resourceType": "Fre",
"srlgSet": []
}
}
}

Cancel a planning project

Instructions follow on how to

• cancel a planning project that was previously committed

• recommit a planning project that was previously cancelled

Canceling a committed planning project issues a DELETE on the intent and transitions the project state to

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 91
Blue Planet MCP API Reference Guide, Release 18.06 Planning

Canceled. The project and its associated planning data are not deleted.

WARNING

Risk of failure to delete intent

The intent is not deleted if either of the following conditions are true:

• A service (planned or realized) exists that is using equipment in the intent to be

deleted.
• Any of the equipment in the associated intent has already been realized by
inserting equipment in the relevant slots.

To cancel a project even if equipment has been realized, set the “ignoreEquipmentProvisioining” flag to
“true” in the cancelOperation.

To check if there are other projects that depend on the project being cancelled, set the
"checkDependencies" flag to "true" in the cancelOperation. If any dependencies are found, then cancelling
the project fails and lists the projects that depend on the project being cancelled.

WARNING

Risk of an inconsistent state in the network

Cancelling a project without setting the "checkDependencies" flag to "true" can

result in an inconsistent state in the network that may impact further project
planning.

Recommendation: Always set the "checkDependencies" flag to "true" in the

cancelOperation.

Requirements

Before you start, make sure that you

• are logged into the Blue Planet MCP client UI

• have the following customer documentation (as applicable):
◦ OnePlanner 6.0.1806 User Guide - Part A (Common),450-3550-001
◦ OnePlanner 6.0.1806 User Guide - Part B (Designing a Photonic Network), 450-3550-001

This section includes the following topics:

• Cancel a planning project

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 92
Blue Planet MCP API Reference Guide, Release 18.06 Planning

• Query the project to see the status

• Re-use the project (optional)

Cancel a planning project

To cancel a planning project, use the Project Management API. Use one of two options, as required:

• Option A

• Option B

Sample request — Option A

POST {{MCP_SERVER}}/projectmanagement/api/v1/PlanningProjects/cancel

Sample request — Option B

POST {{MCP_SERVER}}/projectmanagement/api/v1/PlanningProjects/{id)/cancel

In your request (Option B), specify the ID or name of a project, as applicable.

POST
{{MCP_SERVER}}/projectmanagement/api/v1/PlanningProjects/{{PROJECT_ID_Route1}}/CancelOperatio
n

Sample response — Option B

200 Ok

Query the project to see the status

Query the project to see its status by using the Project Management API.

Sample request

GET {{MCP_SERVER}}/projectmanagement/api/v1/PlanningProjects

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 93
Blue Planet MCP API Reference Guide, Release 18.06 Planning

{
"Id": "094772a4-9bd4-4b8a-8b1d-ec9aadc4b012",
"Name": "NewACRoute2",
"CompletionDate": "2017-12-31T23:59:59+00:00",
"ExpirationDate": null,
"State": "Cancelling",
"Description": null,
"StatusMessage": "Intent accepted by IFD",
"IntentId": "8283a874-e892-412e-8386-ab9735e544ec",
"ProjectListId": "94a527ba-3bb3-44c0-9761-5d11ac2df2a3"
}

Sample request

GET {{MCP_SERVER}}/projectmanagement/api/v1/PlanningProjects/094772a4-9bd4-4b8a-8b1d-
ec9aadc4b012

Sample response

{
"Id": "094772a4-9bd4-4b8a-8b1d-ec9aadc4b012",
"Name": "NewACRoute2",
"CompletionDate": "2017-12-31T23:59:59+00:00",
"ExpirationDate": null,
"State": "InProcess",
"Description": null,
"StatusMessage": "Intent 8283a874-e892-412e-8386-ab9735e544ec deleted from IFD",
"IntentId": "",
"ProjectListId": "94a527ba-3bb3-44c0-9761-5d11ac2df2a3"
}

If the state is “Cancelling”, wait a few seconds and issue the query again.

The operation is complete when the project state indicates: “CancelFailed”.

Re-use the project (optional)

A cancelled project can be reused. The following changes are allowed:

• Project rename
• Project date change
• Fiber characteristic changes (OnePlanner client).

Make sure to save the changes back to the MCP server.

• Link Engineering Validation (OnePlanner client).

Make sure to save the changes back to the MCP server.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 94
Blue Planet MCP API Reference Guide, Release 18.06 Planning

To reuse the project after it has been cancelled, perform commit a planning project.

Use a planning project list to validate inter-project

compatibility and sequencing
To create, populate and validate a list of planning projects for compatibility with one another and with an
up-to-date capture of the network, see the Project List workflow.

Project Lists
ProjectLists allow individual projects created by one or more users to be sequenced and validated against
each other, against the network, and against all previously committed projects.

As Projects are added to a ProjectList, they are validated against existing Projects in the list.

While adding projects, if a conflict is detected, or if a required dependency is missing, the Project will be
rejected.

Multiple ProjectLists may coexist.

Ports and slots are not reserved until projects are committed.

Figure 7. Project List workflow

This section includes the following topics:

• Create a new project list

• Add an existing Fiber Route or Equipment planning project to a project list
• Create a new Equipment planning project in the context of an existing project list

Requirements

Before you start, make sure that you

• are logged into the Blue Planet MCP client UI

• have an API token

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 95
Blue Planet MCP API Reference Guide, Release 18.06 Planning

• created individual planning projects for Fiber Routes to be included in the Project List (see Create a
planning project and Plan a fiber route )

Create a new project list

To create a new project list, use the Project Management API.

Sample request

POST {{MCP_SERVER}}/projectmanagment/api/v2/ProjectLists

{
"name": "ProjectList1"
}

Modify the example to create a planning project list, as required. The Name must be 1 to 16 alphanumeric
characters.

Note either the project list ID or name in the following Example response body. You will copy the project
list ID or name from the response body and use it in other REST API tasks.

Sample response

{
"id": "9306343e-e253-4c8a-b5e1-3b9edf5530e1",
"name": "TomPL",
"projects": [],
"failureReasons": {},
"state": "New",
"syncState": "New"
}

Add an existing Fiber Route or Equipment planning project to a

project list
To add an existing Fiber Route or Equipment planning project to a project list, use the Project
Management API.

Sample request

POST {{MCP_SERVER}}/projectmanagment/api/v2/ProjectLists/{projectListName}/addProject

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 96
Blue Planet MCP API Reference Guide, Release 18.06 Planning

{
"projectName": "{{PROJECT_Route1}}"
}

Modify the example to add a planning project, as required.

• The Project List Name uniquely identifies the ProjectList that the Project is to be added to.
• The Project Name uniquely identifies the Fiber Route or Equipment project that is to be added to the
Project List.

Sample response

{
"id": "94a527ba-3bb3-44c0-9761-5d11ac2df2a3",
"name": "ProjectList1_MixEQPT",
"projects": [],
"failureReasons": [],
"state": "New",
"syncState": "Synchronizing"
}

Note: The AddProject may take some time to complete.

Poll the status of the ProjectList periodically until syncState is either LastProjectAddSynchronized or
LastProjectAddFailed.

Retrieve the Project Lists using the Project Management API.

Sample response

GET {{MCP_SERVER}}/projectmanagment/api/v2/ProjectLists

Specify the name of the Project to poll.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 97
Blue Planet MCP API Reference Guide, Release 18.06 Planning

[
{
"id": "94a527ba-3bb3-44c0-9761-5d11ac2df2a3",
"name": "ProjectList1_MixEQPT",
"projects": [
{
"id": "094772a4-9bd4-4b8a-8b1d-ec9aadc4b012",
"name": "NewACRoute2"
}
],
"failureReasons": [],
"state": "Valid",
"syncState": "LastProjectAddSynchronized"
}
]

Repeat the task Add an existing Fiber Route or Equipment planning project to a project list for every
existing planning project, as applicable.

Create a new Equipment planning project in the context of an

existing project list
To create a new Equipment Planning project in the context of an existing project list, perform the
following procedures in the order listed:

• Create a planning project

• Plan equipment.

Note: In Plan equipment, be sure to include the optional Project List ID or name.

Note: Creating a new Equipment Planning project in the context of an existing project list ensures that the
slots assigned to newly planned equipment take into account other planned equipment that are included
in other projects in the project list.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 98
Blue Planet MCP API Reference Guide, Release 18.06 Planning

Heat dissipation policy overview

A certain number of traffic-carrying circuit packs are added to a bay, depending on the tolerable heat
dissipation level of the bay. Decreasing this value means that fewer circuit packs can be added to a bay.
Once the blocking heat dissipation threshold value of a bay has been met, no more circuit packs can be
added to it. The set of circuit packs will then, in turn, be added to another bay in the configuration.

To determine the number of cards that can be added to a bay, the system first considers the traffic-
carrying circuit packs, pluggables, common equipment, photonic equipment, and spares.

When you are adding a number of circuit packs to a bay, messages similar to the following can display in
the response body:

1. If circuits packs are being added to a bay without breaching the threshold, the following appears in the
response body with the status “Ok”.

{
"heatDissipationThresholdStatus": {
"status": "Ok",
"warningThreshold": [],
"blockingThreshold": []
}
}

2. If circuits packs are being added to a bay breaching the warning threshold but not the blocking one,
the following appears in the response body with the status “Warning” and the calculated heat value of
the current and added circuit packs. The bay getting added with a breaching threshold is also
identified by threshold type (Global/Site/Bay).

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 99
Blue Planet MCP API Reference Guide, Release 18.06 Planning

{
"heatDissipationThresholdStatus": {
"status": "Warning",
"warningThreshold": [{
"bay": {
"nodeIdentity": {
"clli": "SITEA",
"tid": "SITEA1"
},
"location": {
"mgmtAccess": "TL1_ACCESS",
"address": [{
"key": "RACK",
"value": "1"
}]
}
},
"calculatedHeatDissipation": 1760,
"heatDissipationThreshold": {
"warningThreshold": "1502",
"blockingThreshold": "1900"
},
"thresholdType": "Global"
}],
"blockingThreshold": []
}
}

3. If a circuits pack’s power breaches the warning and blocking thresholds, the following appears in the
response body with the status “Exceeded” if it will not get added to any bays in that site. The
calculated heat value of the presently slotted circuit packs also appears. The power and PECs of the
first unslotted circuit packs and the threshold type (Global/Site/Bay) are also included in the response
body.

{
"heatDissipationThresholdStatus": {
"status": "Exceeded",
"warningThreshold": [],
"blockingThreshold": [{
"bay": {
"nodeIdentity": {
"clli": "SITEA",
"tid": "SITEA1"
},
"location": {
"mgmtAccess": "TL1_ACCESS",
"address": [{
"key": "RACK",
"value": "1"
}]
}
},
"calculatedHeatDissipation": 986,
"heatDissipationThreshold": {
"warningThreshold": "500",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 100
Blue Planet MCP API Reference Guide, Release 18.06 Planning

"blockingThreshold": "600"
},
"thresholdType": "Global"
},
{
"bay": {
"nodeIdentity": {
"clli": "SITEA",
"tid": "SITEA1"
},
"location": {
"mgmtAccess": "TL1_ACCESS",
"address": [{
"key": "RACK",
"value": "2"
}]
}
},
"calculatedHeatDissipation": 783,
"heatDissipationThreshold": {
"warningThreshold": "500",
"blockingThreshold": "600"
},
"thresholdType": "Global"
}
],
"unslottedEquipmentGroups": [{
"unslottedEquipmentHeatDissipation": [{
"pec": "NTK539UJ",
"power": 160
},
{
"pec": "NTK529AC",
"power": 85
},
{
"pec": "160-9115-900",
"power": 13
}
]
}]
}
}

A single Heat Dissipation REST API for all heat dissipation settings (Global, Site, Rack/Bay) can be used to
provide the ability to set either or both of the two thresholds.

Two thresholds (“Threshold 1” - Warning and “Threshold 2” - Block) for heat dissipation in watts can be
set globally for all bays in the network, per site for all bays in a specific site or for a specific rack/bay.

All heat dissipation settings (global, site, rack/bay) can be set for either or both of the two thresholds.

The thresholds are applied in the order: global threshold > overridden by per site threshold > overridden by
per rack/bay threshold.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 101
Blue Planet MCP API Reference Guide, Release 18.06 Planning

Specific tasks you can perform with the Heat Dissipation REST API are:

• Create a global heat dissipation policy

• Create a site heat dissipation policy
• Create a rack/bay heat dissipation policy
• Retrieve or verify a heat dissipation policy

Supported REST API calls for heat dissipation include:

• GET {{MCP_SERVER}}/equipmenttopologyplanning/api/v1/PlanningPolicies - Retrieve all the created

policies. Currently, only one policy named “Heat dissipation threshold policy” is supported.
• POST {{MCP_SERVER}}/equipmenttopologyplanning/api/v1/PlanningPolicies - Create a new planning
policy.
• DELETE {{MCP_SERVER}}/equipmenttopologyplanning/api/v1/PlanningPolicies/{id} - Delete a
planning policy by ID.
• GET {{MCP_SERVER}}/equipmenttopologyplanning/api/v1/PlanningPolicies/{id} - Get a planning
policy by ID.
• PUT {{MCP_SERVER}}/equipmenttopologyplanning/api/v1/PlanningPolicies/{id} - Update the
specified planning policy.

Create a global heat dissipation policy

Use this procedure to create a global heat dissipation policy.

To create a global heat dissipation policy, use the Equipment and Topology Planning API.

Requirements

Before you start, make sure that

• you have Blue Planet MCP credentials (user name and password) and planner permissions
• the network elements and fiber routes are planned
• the projects for the network elements and fiber routes are in a Committed state
• you know the tolerable heat dissipation level for each bay (prescribed by your company)
• you understand the Heat dissipation policy overview. In your request, modify the example to create a
heat dissipation policy, as required.
• Specify a name that is unique.

Note: For now you can give only the name “Heat dissipation threshold policy” to the policy. If the heat
dissipation policy is created with any other name, it is not considered.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 102
Blue Planet MCP API Reference Guide, Release 18.06 Planning

• Specify the value in watts for the warning and blocking thresholds.

Sample request

POST {{MCP_SERVER}}/equipmenttopologyplanning/api/v1/PlanningPolicies

{
"name": "Heat dissipation threshold policy",
"heatDissipationThresholdPolicy": {
"globalHeatDissipationPolicy": {
"warningThreshold": "600",
"blockingThreshold": "700"
}
}
}

Sample response

{
"id": "cb481b74-d4b7-4d4f-87fa-0660cfe21c2b",
"name": "Heat dissipation threshold policy",
"heatDissipationThresholdPolicy": {
"globalHeatDissipationPolicy": {
"warningThreshold": "600",
"blockingThreshold": "700"
},
"siteHeatDissipationPolicies": [],
"bayHeatDissipationPolicies": []
},
"userActivityInfo": {
"createdByUserName": "admin",
"creationTime": "2017-07-19T17:36:02.090458+00:00"
}
}

Create a site heat dissipation policy

Use this procedure to create a site heat dissipation policy.

To create a site heat dissipation policy, use the Equipment and Topology Planning API.

Requirements

Before you start, make sure that

• you have Blue Planet MCP credentials (user name and password) and planner permissions
• the network elements and fiber routes are planned

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 103
Blue Planet MCP API Reference Guide, Release 18.06 Planning

• the projects for the network elements and fiber routes are in a Committed state
• you know the tolerable heat dissipation level for each bay (prescribed by your company)
• you understand the Heat dissipation policy overview. In your request, modify the example to create a
heat dissipation policy, as required.
• Specify a name that is unique.

Note: For now you can give only the name “Heat dissipation threshold policy” to the policy. If the heat
dissipation policy is created with any other name, it is not considered.

• Specify the value in watts for the warning and blocking thresholds.

Sample request - site only

POST {{MCP_SERVER}}/equipmenttopologyplanning/api/v1/PlanningPolicies

{
"name": "Heat dissipation threshold policy",
"heatDissipationThresholdPolicy": {
"siteHeatDissipationPolicies": [{
"clli": "SITEA",
"heatDissipationThreshold": {
"warningThreshold": 500,
"blockingThreshold": 900
}
},
{
"clli": "SITEB",
"heatDissipationThreshold": {
"warningThreshold": 500,
"blockingThreshold": 130
}
}
]
}
}

Sample request - global and site policies in one call

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 104
Blue Planet MCP API Reference Guide, Release 18.06 Planning

{
"name": "Heat dissipation threshold policy",
"heatDissipationThresholdPolicy": {
"globalHeatDissipationPolicy": {
"warningThreshold": "1030",
"blockingThreshold": "1040"
},
"siteHeatDissipationPolicies": [{
"clli": "SITEA",
"heatDissipationThreshold": {
"warningThreshold": "1040",
"blockingThreshold": "1050"
}
}],
"bayHeatDissipationPolicies": []
}
}

See Sample response - site policy only and Sample response - global and site policies in one call for
details.

Create a rack/bay heat dissipation policy

Use this procedure to create a rack/bay heat dissipation policy.

To create a rack/bay heat dissipation policy, use the Equipment and Topology Planning API.

Requirements

Before you start, make sure that

• you have Blue Planet MCP credentials (user name and password) and planner permissions
• the network elements and fiber routes are planned
• the projects for the network elements and fiber routes are in a Committed state
• you know the tolerable heat dissipation level for each bay (prescribed by your company)
• you understand the Heat dissipation policy overview. In your request, modify the example to create a
heat dissipation policy, as required.
• Specify a name that is unique.

Note: For now you can give only the name “Heat dissipation threshold policy” to the policy. If the heat
dissipation policy is created with any other name, it is not considered.

• Specify the value in watts for the warning and blocking thresholds.

Sample request - rack/bay only

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 105
Blue Planet MCP API Reference Guide, Release 18.06 Planning

POST {{MCP_SERVER}}/equipmenttopologyplanning/api/v1/PlanningPolicies

{
"name": "Heat dissipation threshold policy",
"heatDissipationThresholdPolicy": {
"globalHeatDissipationPolicy": {},
"siteHeatDissipationPolicies": [],
"bayHeatDissipationPolicies": [{
"bay": {
"nodeIdentity": {
"clli": "SITEA",
"nodeId": "1"
},
"location": {
"mgmtAccess": "TL1_ACCESS",
"address": [{
"key": "RACK",
"value": 1
}]
}
},
"heatDissipationThreshold": {
"warningThreshold": "1243",
"blockingThreshold": "1243"
}
}]
}
}

Sample request - global, site and rack/bay policies in one call

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 106
Blue Planet MCP API Reference Guide, Release 18.06 Planning

{
"name": "Heat dissipation threshold policy",
"heatDissipationThresholdPolicy": {
"globalHeatDissipationPolicy": {
"warningThreshold": 1030,
"blockingThreshold": 1040
},
"siteHeatDissipationPolicies": [{
"clli": "SITEA",
"heatDissipationThreshold": {
"warningThreshold": 1042,
"blockingThreshold": 1050
}
}],
"bayHeatDissipationPolicies": [{
"bay": {
"nodeIdentity": {
"clli": "SITEA",
"nodeId": 1
},
"location": {
"mgmtAccess": "TL1_ACCESS",
"address": [{
"key": "RACK",
"value": 2
}]
}
},
"heatDissipationThreshold": {
"warningThreshold": 1040,
"blockingThreshold": 1040
}
}]
}
}

See Sample response - site policy only and Sample response - global and site policies in one call for
details.

Retrieve or verify a heat dissipation policy

Use this procedure to retrieve or verify a global, site or bay heat dissipation policy.

To retrieve the policy, use the Equipment and Topology Planning API.

Sample request

GET {{MCP_SERVER}}/equipmenttopologyplanning/api/v1/PlanningPolicies

Sample response - global heat dissipation policy

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 107
Blue Planet MCP API Reference Guide, Release 18.06 Planning

{
"id": "cb481b74-d4b7-4d4f-87fa-0660cfe21c2b",
"name": "Heat dissipation threshold policy",
"heatDissipationThresholdPolicy": {
"globalHeatDissipationPolicy": {
"warningThreshold": "600",
"blockingThreshold": "700"
},
"siteHeatDissipationPolicies": [],
"bayHeatDissipationPolicies": []
},
"userActivityInfo": {
"createdByUserName": "admin",
"creationTime": "2017-07-19T17:36:02.090458+00:00"
}
}

Sample response - site policy only

{
"id": "8f158a71-408e-4012-b027-fb152d0fa740",
"name": "Heat dissipation threshold policy",
"heatDissipationThresholdPolicy": {
"globalHeatDissipationPolicy": {},
"siteHeatDissipationPolicies": [{
"clli": "SITEA",
"heatDissipationThreshold": {
"warningThreshold": "1244",
"blockingThreshold": "1245"
}
}],
"bayHeatDissipationPolicies": []
},
"userActivityInfo": {
"lastModifiedByUserName": "admin",
"lastModifiedTime": "2017-07-19T18:36:30.586366+00:00"
}
}

Sample response - global and site policies in one call

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 108
Blue Planet MCP API Reference Guide, Release 18.06 Planning

{
"id": "8f158a71-408e-4012-b027-fb152d0fa740",
"name": "Heat dissipation threshold policy",
"heatDissipationThresholdPolicy": {
"globalHeatDissipationPolicy": {
"warningThreshold": "1030",
"blockingThreshold": "1040"
},
"siteHeatDissipationPolicies": [{
"clli": "SITEA",
"heatDissipationThreshold": {
"warningThreshold": "1040",
"blockingThreshold": "1050"
}
}],
"bayHeatDissipationPolicies": []
},
"userActivityInfo": {
"createdByUserName": "admin",
"creationTime": "2017-07-19T18:27:19.723557+00:00"
}
}

Sample response - rack/bay policy only

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 109
Blue Planet MCP API Reference Guide, Release 18.06 Planning

{
"id": "8f158a71-408e-4012-b027-fb152d0fa740",
"name": "Heat dissipation threshold policy",
"heatDissipationThresholdPolicy": {
"globalHeatDissipationPolicy": {},
"siteHeatDissipationPolicies": [],
"bayHeatDissipationPolicies": [{
"bay": {
"nodeIdentity": {
"clli": "SITEA",
"nodeId": 1
},
"location": {
"mgmtAccess": "TL1_ACCESS",
"address": [{
"key": "RACK",
"value": "1"
}]
}
},
"heatDissipationThreshold": {
"warningThreshold": "1243",
"blockingThreshold": "1243"
}
}]
},
"userActivityInfo": {
"lastModifiedByUserName": "admin",
"lastModifiedTime": "2017-07-19T19:25:55.481999+00:00"
}
}

Sample response - global, site and rack/bay policies in one call

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 110
Blue Planet MCP API Reference Guide, Release 18.06 Planning

{
"id": "8f158a71-408e-4012-b027-fb152d0fa740",
"name": "Heat dissipation threshold policy",
"heatDissipationThresholdPolicy": {
"globalHeatDissipationPolicy": {
"warningThreshold": "1030",
"blockingThreshold": "1040"
},
"siteHeatDissipationPolicies": [{
"clli": "SITEA",
"heatDissipationThreshold": {
"warningThreshold": "1042",
"blockingThreshold": "1050"
}
}],
"bayHeatDissipationPolicies": [{
"bay": {
"nodeIdentity": {
"clli": "SITEA",
"nodeId": 1
},
"location": {
"mgmtAccess": "TL1_ACCESS",
"address": [{
"key": "RACK",
"value": "2"
}]
}
},
"heatDissipationThreshold": {
"warningThreshold": "1040",
"blockingThreshold": "1040"
}
}]
},
"userActivityInfo": {
"lastModifiedByUserName": "admin",
"lastModifiedTime": "2017-07-19T19:26:42.133156+00:00"
}
}

Planning policy (equipment to be considered during on-

line planning)
Equipment to be considered during on-line planning is specified via a global policy. Current policy
objective includes:

• Service Provisioning Policy (SPP) - line and service card preferences, and mappings.

This policy has the capability to Rank Service Equipment (ranking of client cards per line card and ranking
of plugs for a given client card and rate). Creation and modification of policy is accomplished using REST
APIs.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 111
Blue Planet MCP API Reference Guide, Release 18.06 Planning

Note: In 17.06 the user is advised to create only one Service Provisioning Policy. MCP will use first
planning policy that has Service Provisioning Policy section defined and therefore it is advisable not to
have more than one to avoid confusion.

This section includes the following topics:

• Get all planning policies

• Get a planning policy by name
• Get a planning policy by id
• Create a new planning policy
• ServiceProvisioningPolicy (SPP) validation errors
• Delete a planning policy by id
• Modify a planning policy by id

GET all planning policies

To get all planning policies, use the Equipment and Topology Planning API.

Sample request

GET {{MCP_SERVER}}/equipmenttopologyplanning/api/v1/PlanningPolicies

Sample response

[
{
"id": "dbd49f70-318f-4b8d-b05d-37497e713711",
"name": "Valid planning policy with only ServiceProvisioningPolicy",
"serviceProvisioningPolicy": {
"cardPolicies": [
{
"cardPec": "NTK529AC",
"certifiedMatePecs": [
"NTK539UJ",
"NTK539UX",
"NTK539UN",
"NTK539BB",
"NTK539BE",
"NTK539BH",
"NTK539BN"
],
"certifiedClientPluggables": [
{
"rate": "DSR_100GE",
"pec": "160-9114-900"
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 112
Blue Planet MCP API Reference Guide, Release 18.06 Planning

"rate": "DSR_100GE",
"pec": "160-9115-900"
},
{
"rate": "DSR_100GE",
"pec": "NTTA03AA"
},
{
"rate": "DSR_100GE",
"pec": "NTTA03GJ"
},
{
"rate": "DSR_100GE",
"pec": "NTTA03HE"
},
{
"rate": "DSR_100GE",
"pec": "NTTA01CE"
},
{
"rate": "DSR_100GE",
"pec": "160-9113-900"
},
{
"rate": "DSR_100GE",
"pec": "NTTA01AA"
},
{
"rate": "DSR_100GE",
"pec": "NTTA03BE"
},
{
"rate": "OTM4",
"pec": "160-9114-900"
},
{
"rate": "OTM4",
"pec": "160-9115-900"
},
{
"rate": "OTM4",
"pec": "NTTA01CE"
},
{
"rate": "OTM4",
"pec": "NTTA03BE"
}
]
},
{
"cardPec": "NTK529BX",
"certifiedMatePecs": [
"NTK539UJ",
"NTK539UX",
"NTK539UN",
"NTK539BB",
"NTK539BE",
"NTK539BH",
"NTK539BN"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 113
Blue Planet MCP API Reference Guide, Release 18.06 Planning

],
"certifiedClientPluggables": [
{
"rate": "DSR_10GE",
"pec": "NTTP81BA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP81DA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP81AA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP80BA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP80DA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP81KA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HB"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HC"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HD"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HE"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HF"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HG"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HH"
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 114
Blue Planet MCP API Reference Guide, Release 18.06 Planning

"rate": "DSR_10GE",
"pec": "NTTP83BA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84AA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84BA"
},
{
"rate": "OTM2",
"pec": "NTTP80DA"
},
{
"rate": "OTM2",
"pec": "NTTP81KA"
},
{
"rate": "OTM2",
"pec": "NTTP84HA"
},
{
"rate": "OTM2",
"pec": "NTTP84HB"
},
{
"rate": "OTM2",
"pec": "NTTP84HC"
},
{
"rate": "OTM2",
"pec": "NTTP84HD"
},
{
"rate": "OTM2",
"pec": "NTTP84HE"
},
{
"rate": "OTM2",
"pec": "NTTP84HF"
},
{
"rate": "OTM2",
"pec": "NTTP84HG"
},
{
"rate": "OTM2",
"pec": "NTTP84HH"
},
{
"rate": "OTM2",
"pec": "NTTP83BA"
},
{
"rate": "OTM2",
"pec": "NTTP84AA"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 115
Blue Planet MCP API Reference Guide, Release 18.06 Planning

{
"rate": "OTM2",
"pec": "NTTP84BA"
},
{
"rate": "OTM2",
"pec": "NTTP86AA"
},
{
"rate": "OTM2",
"pec": "NTTP86BA"
}
]
},
{
"cardPec": "NTK539UJ",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539UX",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539UN",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539BB",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539BE",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539BH",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 116
Blue Planet MCP API Reference Guide, Release 18.06 Planning

],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539BN",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK538DZ",
"certifiedMatePecs": [],
"certifiedClientPluggables": [
{
"rate": "DSR_100GE",
"pec": "160-9400-900"
},
{
"rate": "DSR_100GE",
"pec": "160-9401-900"
},
{
"rate": "DSR_100GE",
"pec": "160-9402-900"
},
{
"rate": "DSR_100GE",
"pec": "160-9403-900"
},
{
"rate": "OTM4",
"pec": "160-9400-900"
},
{
"rate": "OTM4",
"pec": "160-9401-900"
},
{
"rate": "OTM4",
"pec": "160-9402-900"
},
{
"rate": "OTM4",
"pec": "160-9403-900"
}
]
}
]
},
"userActivityInfo": {
"createdByUserName": "sensfan",
"creationTime": "2017-05-22T22:05:43.579+00:00",
"lastModifiedByUserName": "bobama",
"lastModifiedTime": "2017-05-22T22:31:45.855+00:00"
}
}
]

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 117
Blue Planet MCP API Reference Guide, Release 18.06 Planning

Get a planning policy by name

To get a planning policy by name, use the Equipment and Topology Planning API.

Sample request

GET {{MCP_SERVER}}/equipmenttopologyplanning/api/v1/PlanningPolicies/?name=Valid planning

policy with only ServiceProvisioningPolicy

Sample response

[
{
"id": "dbd49f70-318f-4b8d-b05d-37497e713711",
"name": "Valid planning policy with only ServiceProvisioningPolicy",
"serviceProvisioningPolicy": {
"cardPolicies": [
{
"cardPec": "NTK529AC",
"certifiedMatePecs": [
"NTK539UJ",
"NTK539UX",
"NTK539UN",
"NTK539BB",
"NTK539BE",
"NTK539BH",
"NTK539BN"
],
"certifiedClientPluggables": [
{
"rate": "DSR_100GE",
"pec": "160-9114-900"
},
{
"rate": "DSR_100GE",
"pec": "160-9115-900"
},
{
"rate": "DSR_100GE",
"pec": "NTTA03AA"
},
{
"rate": "DSR_100GE",
"pec": "NTTA03GJ"
},
{
"rate": "DSR_100GE",
"pec": "NTTA03HE"
},
{
"rate": "DSR_100GE",
"pec": "NTTA01CE"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 118
Blue Planet MCP API Reference Guide, Release 18.06 Planning

{
"rate": "DSR_100GE",
"pec": "160-9113-900"
},
{
"rate": "DSR_100GE",
"pec": "NTTA01AA"
},
{
"rate": "DSR_100GE",
"pec": "NTTA03BE"
},
{
"rate": "OTM4",
"pec": "160-9114-900"
},
{
"rate": "OTM4",
"pec": "160-9115-900"
},
{
"rate": "OTM4",
"pec": "NTTA01CE"
},
{
"rate": "OTM4",
"pec": "NTTA03BE"
}
]
},
{
"cardPec": "NTK529BX",
"certifiedMatePecs": [
"NTK539UJ",
"NTK539UX",
"NTK539UN",
"NTK539BB",
"NTK539BE",
"NTK539BH",
"NTK539BN"
],
"certifiedClientPluggables": [
{
"rate": "DSR_10GE",
"pec": "NTTP81BA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP81DA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP81AA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP80BA"
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 119
Blue Planet MCP API Reference Guide, Release 18.06 Planning

"rate": "DSR_10GE",
"pec": "NTTP80DA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP81KA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HB"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HC"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HD"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HE"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HF"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HG"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HH"
},
{
"rate": "DSR_10GE",
"pec": "NTTP83BA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84AA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84BA"
},
{
"rate": "OTM2",
"pec": "NTTP80DA"
},
{
"rate": "OTM2",
"pec": "NTTP81KA"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 120
Blue Planet MCP API Reference Guide, Release 18.06 Planning

{
"rate": "OTM2",
"pec": "NTTP84HA"
},
{
"rate": "OTM2",
"pec": "NTTP84HB"
},
{
"rate": "OTM2",
"pec": "NTTP84HC"
},
{
"rate": "OTM2",
"pec": "NTTP84HD"
},
{
"rate": "OTM2",
"pec": "NTTP84HE"
},
{
"rate": "OTM2",
"pec": "NTTP84HF"
},
{
"rate": "OTM2",
"pec": "NTTP84HG"
},
{
"rate": "OTM2",
"pec": "NTTP84HH"
},
{
"rate": "OTM2",
"pec": "NTTP83BA"
},
{
"rate": "OTM2",
"pec": "NTTP84AA"
},
{
"rate": "OTM2",
"pec": "NTTP84BA"
},
{
"rate": "OTM2",
"pec": "NTTP86AA"
},
{
"rate": "OTM2",
"pec": "NTTP86BA"
}
]
},
{
"cardPec": "NTK539UJ",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 121
Blue Planet MCP API Reference Guide, Release 18.06 Planning

],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539UX",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539UN",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539BB",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539BE",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539BH",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539BN",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK538DZ",
"certifiedMatePecs": [],
"certifiedClientPluggables": [
{
"rate": "DSR_100GE",
"pec": "160-9400-900"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 122
Blue Planet MCP API Reference Guide, Release 18.06 Planning

{
"rate": "DSR_100GE",
"pec": "160-9401-900"
},
{
"rate": "DSR_100GE",
"pec": "160-9402-900"
},
{
"rate": "DSR_100GE",
"pec": "160-9403-900"
},
{
"rate": "OTM4",
"pec": "160-9400-900"
},
{
"rate": "OTM4",
"pec": "160-9401-900"
},
{
"rate": "OTM4",
"pec": "160-9402-900"
},
{
"rate": "OTM4",
"pec": "160-9403-900"
}
]
}
]
},
"userActivityInfo": {
"createdByUserName": "sensfan",
"creationTime": "2017-05-22T22:05:43.579+00:00",
"lastModifiedByUserName": "bobama",
"lastModifiedTime": "2017-05-22T22:31:45.855+00:00"
}
}
]

Get a planning policy by id

To get a planning policy by id, use the Equipment and Topology Planning API.

Sample request

GET {{MCP_SERVER}}/equipmenttopologyplanning/api/v1/PlanningPolicies/dbd49f70-318f-4b8d-b05d-
37497e713711

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 123
Blue Planet MCP API Reference Guide, Release 18.06 Planning

[
{
"id": "dbd49f70-318f-4b8d-b05d-37497e713711",
"name": "Valid planning policy with only ServiceProvisioningPolicy",
"serviceProvisioningPolicy": {
"cardPolicies": [
{
"cardPec": "NTK529AC",
"certifiedMatePecs": [
"NTK539UJ",
"NTK539UX",
"NTK539UN",
"NTK539BB",
"NTK539BE",
"NTK539BH",
"NTK539BN"
],
"certifiedClientPluggables": [
{
"rate": "DSR_100GE",
"pec": "160-9114-900"
},
{
"rate": "DSR_100GE",
"pec": "160-9115-900"
},
{
"rate": "DSR_100GE",
"pec": "NTTA03AA"
},
{
"rate": "DSR_100GE",
"pec": "NTTA03GJ"
},
{
"rate": "DSR_100GE",
"pec": "NTTA03HE"
},
{
"rate": "DSR_100GE",
"pec": "NTTA01CE"
},
{
"rate": "DSR_100GE",
"pec": "160-9113-900"
},
{
"rate": "DSR_100GE",
"pec": "NTTA01AA"
},
{
"rate": "DSR_100GE",
"pec": "NTTA03BE"
},
{
"rate": "OTM4",
"pec": "160-9114-900"
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 124
Blue Planet MCP API Reference Guide, Release 18.06 Planning

"rate": "OTM4",
"pec": "160-9115-900"
},
{
"rate": "OTM4",
"pec": "NTTA01CE"
},
{
"rate": "OTM4",
"pec": "NTTA03BE"
}
]
},
{
"cardPec": "NTK529BX",
"certifiedMatePecs": [
"NTK539UJ",
"NTK539UX",
"NTK539UN",
"NTK539BB",
"NTK539BE",
"NTK539BH",
"NTK539BN"
],
"certifiedClientPluggables": [
{
"rate": "DSR_10GE",
"pec": "NTTP81BA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP81DA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP81AA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP80BA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP80DA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP81KA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HB"
},
{
"rate": "DSR_10GE",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 125
Blue Planet MCP API Reference Guide, Release 18.06 Planning

"pec": "NTTP84HC"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HD"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HE"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HF"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HG"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HH"
},
{
"rate": "DSR_10GE",
"pec": "NTTP83BA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84AA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84BA"
},
{
"rate": "OTM2",
"pec": "NTTP80DA"
},
{
"rate": "OTM2",
"pec": "NTTP81KA"
},
{
"rate": "OTM2",
"pec": "NTTP84HA"
},
{
"rate": "OTM2",
"pec": "NTTP84HB"
},
{
"rate": "OTM2",
"pec": "NTTP84HC"
},
{
"rate": "OTM2",
"pec": "NTTP84HD"
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 126
Blue Planet MCP API Reference Guide, Release 18.06 Planning

"rate": "OTM2",
"pec": "NTTP84HE"
},
{
"rate": "OTM2",
"pec": "NTTP84HF"
},
{
"rate": "OTM2",
"pec": "NTTP84HG"
},
{
"rate": "OTM2",
"pec": "NTTP84HH"
},
{
"rate": "OTM2",
"pec": "NTTP83BA"
},
{
"rate": "OTM2",
"pec": "NTTP84AA"
},
{
"rate": "OTM2",
"pec": "NTTP84BA"
},
{
"rate": "OTM2",
"pec": "NTTP86AA"
},
{
"rate": "OTM2",
"pec": "NTTP86BA"
}
]
},
{
"cardPec": "NTK539UJ",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539UX",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539UN",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 127
Blue Planet MCP API Reference Guide, Release 18.06 Planning

"certifiedClientPluggables": []
},
{
"cardPec": "NTK539BB",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539BE",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539BH",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539BN",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK538DZ",
"certifiedMatePecs": [],
"certifiedClientPluggables": [
{
"rate": "DSR_100GE",
"pec": "160-9400-900"
},
{
"rate": "DSR_100GE",
"pec": "160-9401-900"
},
{
"rate": "DSR_100GE",
"pec": "160-9402-900"
},
{
"rate": "DSR_100GE",
"pec": "160-9403-900"
},
{
"rate": "OTM4",
"pec": "160-9400-900"
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 128
Blue Planet MCP API Reference Guide, Release 18.06 Planning

"rate": "OTM4",
"pec": "160-9401-900"
},
{
"rate": "OTM4",
"pec": "160-9402-900"
},
{
"rate": "OTM4",
"pec": "160-9403-900"
}
]
}
]
},
"userActivityInfo": {
"createdByUserName": "sensfan",
"creationTime": "2017-05-22T22:05:43.579+00:00",
"lastModifiedByUserName": "bobama",
"lastModifiedTime": "2017-05-22T22:31:45.855+00:00"
}
}
]

Create a new planning policy

To create a new planning policy, use the Equipment and Topology Planning API.

Sample request

POST {{MCP_SERVER}}/equipmenttopologyplanning/api/v1/PlanningPolicies

Note: This example creates planning policy with only service provisioning policy. Content of the request is
validated and the request will fail if validation fails. Examples of validation errors are shown in the
following topic (Create a new planning policy - validation errors).

{
"name": "Valid planning policy with only ServiceProvisioningPolicy",
"serviceProvisioningPolicy": {
"cardPolicies": [
{
"cardPec": "NTK529AC",
"certifiedMatePecs": [
"NTK539UJ",
"NTK539UX",
"NTK539UN",
"NTK539BB",
"NTK539BE",
"NTK539BH",
"NTK539BN"
],
"certifiedClientPluggables": [

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 129
Blue Planet MCP API Reference Guide, Release 18.06 Planning

{
"rate": "DSR_100GE",
"pec": "160-9114-900"
},
{
"rate": "DSR_100GE",
"pec": "160-9115-900"
},
{
"rate": "DSR_100GE",
"pec": "NTTA03AA"
},
{
"rate": "DSR_100GE",
"pec": "NTTA03GJ"
},
{
"rate": "DSR_100GE",
"pec": "NTTA03HE"
},
{
"rate": "DSR_100GE",
"pec": "NTTA01CE"
},
{
"rate": "DSR_100GE",
"pec": "160-9113-900"
},
{
"rate": "DSR_100GE",
"pec": "NTTA01AA"
},
{
"rate": "DSR_100GE",
"pec": "NTTA03BE"
},
{
"rate": "OTM4",
"pec": "160-9114-900"
},
{
"rate": "OTM4",
"pec": "160-9115-900"
},
{
"rate": "OTM4",
"pec": "NTTA01CE"
},
{
"rate": "OTM4",
"pec": "NTTA03BE"
}
]
},
{
"cardPec": "NTK529BX",
"certifiedMatePecs": [
"NTK539UJ",
"NTK539UX",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 130
Blue Planet MCP API Reference Guide, Release 18.06 Planning

"NTK539UN",
"NTK539BB",
"NTK539BE",
"NTK539BH",
"NTK539BN"
],
"certifiedClientPluggables": [
{
"rate": "DSR_10GE",
"pec": "NTTP81BA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP81DA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP81AA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP80BA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP80DA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP81KA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HB"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HC"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HD"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HE"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HF"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HG"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 131
Blue Planet MCP API Reference Guide, Release 18.06 Planning

{
"rate": "DSR_10GE",
"pec": "NTTP84HH"
},
{
"rate": "DSR_10GE",
"pec": "NTTP83BA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84AA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84BA"
},
{
"rate": "OTM2",
"pec": "NTTP80DA"
},
{
"rate": "OTM2",
"pec": "NTTP81KA"
},
{
"rate": "OTM2",
"pec": "NTTP84HA"
},
{
"rate": "OTM2",
"pec": "NTTP84HB"
},
{
"rate": "OTM2",
"pec": "NTTP84HC"
},
{
"rate": "OTM2",
"pec": "NTTP84HD"
},
{
"rate": "OTM2",
"pec": "NTTP84HE"
},
{
"rate": "OTM2",
"pec": "NTTP84HF"
},
{
"rate": "OTM2",
"pec": "NTTP84HG"
},
{
"rate": "OTM2",
"pec": "NTTP84HH"
},
{
"rate": "OTM2",
"pec": "NTTP83BA"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 132
Blue Planet MCP API Reference Guide, Release 18.06 Planning

},
{
"rate": "OTM2",
"pec": "NTTP84AA"
},
{
"rate": "OTM2",
"pec": "NTTP84BA"
},
{
"rate": "OTM2",
"pec": "NTTP86AA"
},
{
"rate": "OTM2",
"pec": "NTTP86BA"
}
]
},
{
"cardPec": "NTK539UJ",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539UX",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539UN",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539BB",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539BE",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 133
Blue Planet MCP API Reference Guide, Release 18.06 Planning

{
"cardPec": "NTK539BH",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539BN",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK538DZ",
"certifiedMatePecs": [],
"certifiedClientPluggables": [
{
"rate": "DSR_100GE",
"pec": "160-9400-900"
},
{
"rate": "DSR_100GE",
"pec": "160-9401-900"
},
{
"rate": "DSR_100GE",
"pec": "160-9402-900"
},
{
"rate": "DSR_100GE",
"pec": "160-9403-900"
},
{
"rate": "OTM4",
"pec": "160-9400-900"
},
{
"rate": "OTM4",
"pec": "160-9401-900"
},
{
"rate": "OTM4",
"pec": "160-9402-900"
},
{
"rate": "OTM4",
"pec": "160-9403-900"
}
]
}
]
}
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 134
Blue Planet MCP API Reference Guide, Release 18.06 Planning

Sample response

{
"id": "dbd49f70-318f-4b8d-b05d-37497e713711",
"name": "Valid planning policy with only ServiceProvisioningPolicy",
"serviceProvisioningPolicy": {
"cardPolicies": [
{
"cardPec": "NTK529AC",
"certifiedMatePecs": [
"NTK539UJ",
"NTK539UX",
"NTK539UN",
"NTK539BB",
"NTK539BE",
"NTK539BH",
"NTK539BN"
],
"certifiedClientPluggables": [
{
"rate": "DSR_100GE",
"pec": "160-9114-900"
},
{
"rate": "DSR_100GE",
"pec": "160-9115-900"
},
{
"rate": "DSR_100GE",
"pec": "NTTA03AA"
},
{
"rate": "DSR_100GE",
"pec": "NTTA03GJ"
},
{
"rate": "DSR_100GE",
"pec": "NTTA03HE"
},
{
"rate": "DSR_100GE",
"pec": "NTTA01CE"
},
{
"rate": "DSR_100GE",
"pec": "160-9113-900"
},
{
"rate": "DSR_100GE",
"pec": "NTTA01AA"
},
{
"rate": "DSR_100GE",
"pec": "NTTA03BE"
},
{
"rate": "OTM4",
"pec": "160-9114-900"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 135
Blue Planet MCP API Reference Guide, Release 18.06 Planning

},
{
"rate": "OTM4",
"pec": "160-9115-900"
},
{
"rate": "OTM4",
"pec": "NTTA01CE"
},
{
"rate": "OTM4",
"pec": "NTTA03BE"
}
]
},
{
"cardPec": "NTK529BX",
"certifiedMatePecs": [
"NTK539UJ",
"NTK539UX",
"NTK539UN",
"NTK539BB",
"NTK539BE",
"NTK539BH",
"NTK539BN"
],
"certifiedClientPluggables": [
{
"rate": "DSR_10GE",
"pec": "NTTP81BA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP81DA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP81AA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP80BA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP80DA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP81KA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HB"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 136
Blue Planet MCP API Reference Guide, Release 18.06 Planning

{
"rate": "DSR_10GE",
"pec": "NTTP84HC"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HD"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HE"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HF"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HG"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HH"
},
{
"rate": "DSR_10GE",
"pec": "NTTP83BA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84AA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84BA"
},
{
"rate": "OTM2",
"pec": "NTTP80DA"
},
{
"rate": "OTM2",
"pec": "NTTP81KA"
},
{
"rate": "OTM2",
"pec": "NTTP84HA"
},
{
"rate": "OTM2",
"pec": "NTTP84HB"
},
{
"rate": "OTM2",
"pec": "NTTP84HC"
},
{
"rate": "OTM2",
"pec": "NTTP84HD"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 137
Blue Planet MCP API Reference Guide, Release 18.06 Planning

},
{
"rate": "OTM2",
"pec": "NTTP84HE"
},
{
"rate": "OTM2",
"pec": "NTTP84HF"
},
{
"rate": "OTM2",
"pec": "NTTP84HG"
},
{
"rate": "OTM2",
"pec": "NTTP84HH"
},
{
"rate": "OTM2",
"pec": "NTTP83BA"
},
{
"rate": "OTM2",
"pec": "NTTP84AA"
},
{
"rate": "OTM2",
"pec": "NTTP84BA"
},
{
"rate": "OTM2",
"pec": "NTTP86AA"
},
{
"rate": "OTM2",
"pec": "NTTP86BA"
}
]
},
{
"cardPec": "NTK539UJ",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539UX",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539UN",
"certifiedMatePecs": [
"NTK529AC",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 138
Blue Planet MCP API Reference Guide, Release 18.06 Planning

"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539BB",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539BE",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539BH",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539BN",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK538DZ",
"certifiedMatePecs": [],
"certifiedClientPluggables": [
{
"rate": "DSR_100GE",
"pec": "160-9400-900"
},
{
"rate": "DSR_100GE",
"pec": "160-9401-900"
},
{
"rate": "DSR_100GE",
"pec": "160-9402-900"
},
{
"rate": "DSR_100GE",
"pec": "160-9403-900"
},
{
"rate": "OTM4",
"pec": "160-9400-900"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 139
Blue Planet MCP API Reference Guide, Release 18.06 Planning

},
{
"rate": "OTM4",
"pec": "160-9401-900"
},
{
"rate": "OTM4",
"pec": "160-9402-900"
},
{
"rate": "OTM4",
"pec": "160-9403-900"
}
]
}
]
},
"userActivityInfo": {
"createdByUserName": "",
"creationTime": "2017-07-12T13:49:28.3783341+00:00"
}
}

ServiceProvisioningPolicy (SPP) validation errors

SPP policy request like creation (POST) and modification (PUT) requests are validated. Below is example
of the policy that triggers all possible validation errors that could be returned to the user.

To create a new planning policy, use the Equipment and Topology Planning API.

Sample request

POST {{MCP_SERVER}}/equipmenttopologyplanning/api/v1/PlanningPolicies

Note: This example creates planning policy with only service provisioning policy (with validation errors).

{
"id":"Testing validation",
"name": "",
"serviceProvisioningPolicy": {
"cardPolicies": [
{
"cardPec": "",
"certifiedMatePecs": [],
"certifiedClientPluggables": []
},
{
"cardPec": "PEC_XYZZZZZZ",
"certifiedMatePecs": [],
"certifiedClientPluggables": []
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 140
Blue Planet MCP API Reference Guide, Release 18.06 Planning

{
"cardPec": "NTK539QK",
"certifiedMatePecs": [
"NTK529BB",
"NTK529BA",
"NTK529AC"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK538UM",
"certifiedMatePecs": [
"BLA1",
"BLA2"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK529BA",
"certifiedMatePecs": [],
"certifiedClientPluggables": [
{
"rate": "DSR_10GE",
"pec": "NTTP30CF"
},
{
"rate": "DSR_10GE",
"pec": "160-9111-900"
}
]},
{
"cardPec": "NTK529AC",
"certifiedMatePecs": [
"NTK539QK",
"NTK539UX",
"FANTOM_CARD"
],
"certifiedClientPluggables": [
{
"rate": "DSR_100GE",
"pec": "160-9114-900"
},
{
"rate": "DSR_100GE",
"pec": "160-9115-900"
}
]},
{
"cardPec": "NTK539UJ",
"certifiedMatePecs": [
"NTK529BB",
"NTK529BA",
"NTK529AC"
],
"certifiedClientPluggables": [
{
"rate": "DSR_100GE",
"pec": "160-9114-900"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 141
Blue Planet MCP API Reference Guide, Release 18.06 Planning

]},
{
"cardPec": "NTK538BJ",
"certifiedMatePecs": [],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK529BB",
"certifiedMatePecs": [
"NTK539QK",
"NTK539UJ"
],
"certifiedClientPluggables": [
{
"rate": "DSR_10GE",
"pec": ""
},
{
"rate": "DSR_10GE",
"pec": "NTTP84BA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84BA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP80DA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84AA"
},
{
"rate": "OTM2",
"pec": "PEC_PLUG_XYZ"
}
]},
{
"cardPec": "NTK539QK",
"certifiedMatePecs": [
"NTK529BB",
"NTK529BA",
"NTK529AC"
],
"certifiedClientPluggables": []}
]
},
"userActivityInfo": {
"createdByUserName": "sensfan",
"creationTime": "2017-05-31T15:18:59.458+00:00"
}
}

Sample response

Note: All possible validation errors for ServiceProvisioningPolicy and most PlanningPolicy validation

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 142
Blue Planet MCP API Reference Guide, Release 18.06 Planning

errors are shown in this example. Heat dissipation policy validation errors are not covered here.

{
"errors": [
{
"title": "Planning policy id can't be specified."
},
{
"title": "Planning policy name can't be empty."
},
{
"title": "Planning policy UserActivityInfo can't be specified."
},
{
"title": "CardPolicy[0].CardPec:. Can't be an empty string."
},
{
"title": "CardPolicy[1].CardPec:PEC_XYZZZZZZ. Not valid or supported
PEC."
},
{
"title": "CardPolicy[2].CardPec:NTK539QK is not unique. CardPolicy
indexies with same cardPec:2,9."
},
{
"title": "CardPolicies[3].CardPec:NTK538UM should not have any
CertifiedMatePecs defined. Leave this section empty."
},
{
"title": "CardPolicies[4].CardPec:NTK529BA has no certified mate card
pecs defined in CertifiedMatePecs section."
},
{
"title": "CardPolicies[5].CardPec:NTK529AC.
CertifiedMatePecs[1]:NTK539UX doesn't have CardPolicy defined."
},
{
"title": "CardPolicies[5].CardPec:NTK529AC.
CertifiedMatePecs[2]:FANTOM_CARD. Not valid or supported PEC."
},
{
"title": "CardPolicies[6].CardPec:NTK539UJ doesn't support client
pluggables. Leave CertifiedClientPluggables section empty."
},
{
"title": "CardPolicies[7].CardPec:NTK538BJ has no pluggables records
defined in CertifiedClientPluggables section."
},
{
"title": "CardPolicies[8].CardPec:NTK529BB. CertifiedClientPluggables
section contains duplicate pec records for rates:DSR_10GE."
},
{
"title": "CardPolicies[8].CardPec:NTK529BB.
CertifiedClientPluggables[0] record with rate:DSR_10GE has pec information
missing."
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 143
Blue Planet MCP API Reference Guide, Release 18.06 Planning

"title": "CardPolicies[8].CardPec:NTK529BB.
CertifiedClientPluggables[5] record is not valid. Rate:OTM2 and/or pec:PEC_PLUG_XYZ
combination is not supported."
},
{
"title": "CardPolicy[9].CardPec:NTK539QK is not unique. CardPolicy
indexies with same cardPec:2,9."
}
]
}

Delete a planning policy by id

To delete a planning policy by id, use the Equipment and Topology Planning API.

Sample request

DELETE {{MCP_SERVER}}/equipmenttopologyplanning/api/v1/PlanningPolicies/dbd49f70-318f-4b8d-
b05d-37497e713711

Sample response

204 - No content

Modify a planning policy by id

To modify a planning policy by id, use the Equipment and Topology Planning API.

Sample request

PUT {{MCP_SERVER}}/equipmenttopologyplanning/api/v1/PlanningPolicies/dbd49f70-318f-4b8d-b05d-
37497e713711

Note: This example modifies service provisioning policy section of the planning policy with id dbd49f70-
318f-4b8d-b05d-37497e713711. Policy is modified so that the following two (OTM4) client pluggables of
NTK529AC card are removed from the policy: NTTA01CE and NTTA03BE.

Note: Whole policy body details should be sent in the PUT (modified) request once modifications are
done to the original details of the policy.

{
"name": "Valid planning policy with only ServiceProvisioningPolicy",
"serviceProvisioningPolicy": {
"cardPolicies": [

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 144
Blue Planet MCP API Reference Guide, Release 18.06 Planning

{
"cardPec": "NTK529AC",
"certifiedMatePecs": [
"NTK539UJ",
"NTK539UX",
"NTK539UN",
"NTK539BB",
"NTK539BE",
"NTK539BH",
"NTK539BN"
],
"certifiedClientPluggables": [
{
"rate": "DSR_100GE",
"pec": "160-9114-900"
},
{
"rate": "DSR_100GE",
"pec": "160-9115-900"
},
{
"rate": "DSR_100GE",
"pec": "NTTA03AA"
},
{
"rate": "DSR_100GE",
"pec": "NTTA03GJ"
},
{
"rate": "DSR_100GE",
"pec": "NTTA03HE"
},
{
"rate": "DSR_100GE",
"pec": "NTTA01CE"
},
{
"rate": "DSR_100GE",
"pec": "160-9113-900"
},
{
"rate": "DSR_100GE",
"pec": "NTTA01AA"
},
{
"rate": "DSR_100GE",
"pec": "NTTA03BE"
},
{
"rate": "OTM4",
"pec": "160-9114-900"
},
{
"rate": "OTM4",
"pec": "160-9115-900"
}
]
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 145
Blue Planet MCP API Reference Guide, Release 18.06 Planning

"cardPec": "NTK529BX",
"certifiedMatePecs": [
"NTK539UJ",
"NTK539UX",
"NTK539UN",
"NTK539BB",
"NTK539BE",
"NTK539BH",
"NTK539BN"
],
"certifiedClientPluggables": [
{
"rate": "DSR_10GE",
"pec": "NTTP81BA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP81DA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP81AA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP80BA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP80DA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP81KA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HB"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HC"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HD"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HE"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HF"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 146
Blue Planet MCP API Reference Guide, Release 18.06 Planning

{
"rate": "DSR_10GE",
"pec": "NTTP84HG"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HH"
},
{
"rate": "DSR_10GE",
"pec": "NTTP83BA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84AA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84BA"
},
{
"rate": "OTM2",
"pec": "NTTP80DA"
},
{
"rate": "OTM2",
"pec": "NTTP81KA"
},
{
"rate": "OTM2",
"pec": "NTTP84HA"
},
{
"rate": "OTM2",
"pec": "NTTP84HB"
},
{
"rate": "OTM2",
"pec": "NTTP84HC"
},
{
"rate": "OTM2",
"pec": "NTTP84HD"
},
{
"rate": "OTM2",
"pec": "NTTP84HE"
},
{
"rate": "OTM2",
"pec": "NTTP84HF"
},
{
"rate": "OTM2",
"pec": "NTTP84HG"
},
{
"rate": "OTM2",
"pec": "NTTP84HH"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 147
Blue Planet MCP API Reference Guide, Release 18.06 Planning

},
{
"rate": "OTM2",
"pec": "NTTP83BA"
},
{
"rate": "OTM2",
"pec": "NTTP84AA"
},
{
"rate": "OTM2",
"pec": "NTTP84BA"
},
{
"rate": "OTM2",
"pec": "NTTP86AA"
},
{
"rate": "OTM2",
"pec": "NTTP86BA"
}
]
},
{
"cardPec": "NTK539UJ",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539UX",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539UN",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539BB",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539BE",
"certifiedMatePecs": [
"NTK529AC",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 148
Blue Planet MCP API Reference Guide, Release 18.06 Planning

"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539BH",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539BN",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK538DZ",
"certifiedMatePecs": [],
"certifiedClientPluggables": [
{
"rate": "DSR_100GE",
"pec": "160-9400-900"
},
{
"rate": "DSR_100GE",
"pec": "160-9401-900"
},
{
"rate": "DSR_100GE",
"pec": "160-9402-900"
},
{
"rate": "DSR_100GE",
"pec": "160-9403-900"
},
{
"rate": "OTM4",
"pec": "160-9400-900"
},
{
"rate": "OTM4",
"pec": "160-9401-900"
},
{
"rate": "OTM4",
"pec": "160-9402-900"
},
{
"rate": "OTM4",
"pec": "160-9403-900"
}
]
}
]

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 149
Blue Planet MCP API Reference Guide, Release 18.06 Planning

}
}

Sample response

{
"id": "dbd49f70-318f-4b8d-b05d-37497e713711",
"name": "Valid planning policy with only ServiceProvisioningPolicy",
"serviceProvisioningPolicy": {
"cardPolicies": [
{
"cardPec": "NTK529AC",
"certifiedMatePecs": [
"NTK539UJ",
"NTK539UX",
"NTK539UN",
"NTK539BB",
"NTK539BE",
"NTK539BH",
"NTK539BN"
],
"certifiedClientPluggables": [
{
"rate": "DSR_100GE",
"pec": "160-9114-900"
},
{
"rate": "DSR_100GE",
"pec": "160-9115-900"
},
{
"rate": "DSR_100GE",
"pec": "NTTA03AA"
},
{
"rate": "DSR_100GE",
"pec": "NTTA03GJ"
},
{
"rate": "DSR_100GE",
"pec": "NTTA03HE"
},
{
"rate": "DSR_100GE",
"pec": "NTTA01CE"
},
{
"rate": "DSR_100GE",
"pec": "160-9113-900"
},
{
"rate": "DSR_100GE",
"pec": "NTTA01AA"
},
{
"rate": "DSR_100GE",
"pec": "NTTA03BE"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 150
Blue Planet MCP API Reference Guide, Release 18.06 Planning

},
{
"rate": "OTM4",
"pec": "160-9114-900"
},
{
"rate": "OTM4",
"pec": "160-9115-900"
}
]
},
{
"cardPec": "NTK529BX",
"certifiedMatePecs": [
"NTK539UJ",
"NTK539UX",
"NTK539UN",
"NTK539BB",
"NTK539BE",
"NTK539BH",
"NTK539BN"
],
"certifiedClientPluggables": [
{
"rate": "DSR_10GE",
"pec": "NTTP81BA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP81DA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP81AA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP80BA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP80DA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP81KA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HB"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HC"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 151
Blue Planet MCP API Reference Guide, Release 18.06 Planning

{
"rate": "DSR_10GE",
"pec": "NTTP84HD"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HE"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HF"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HG"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84HH"
},
{
"rate": "DSR_10GE",
"pec": "NTTP83BA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84AA"
},
{
"rate": "DSR_10GE",
"pec": "NTTP84BA"
},
{
"rate": "OTM2",
"pec": "NTTP80DA"
},
{
"rate": "OTM2",
"pec": "NTTP81KA"
},
{
"rate": "OTM2",
"pec": "NTTP84HA"
},
{
"rate": "OTM2",
"pec": "NTTP84HB"
},
{
"rate": "OTM2",
"pec": "NTTP84HC"
},
{
"rate": "OTM2",
"pec": "NTTP84HD"
},
{
"rate": "OTM2",
"pec": "NTTP84HE"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 152
Blue Planet MCP API Reference Guide, Release 18.06 Planning

},
{
"rate": "OTM2",
"pec": "NTTP84HF"
},
{
"rate": "OTM2",
"pec": "NTTP84HG"
},
{
"rate": "OTM2",
"pec": "NTTP84HH"
},
{
"rate": "OTM2",
"pec": "NTTP83BA"
},
{
"rate": "OTM2",
"pec": "NTTP84AA"
},
{
"rate": "OTM2",
"pec": "NTTP84BA"
},
{
"rate": "OTM2",
"pec": "NTTP86AA"
},
{
"rate": "OTM2",
"pec": "NTTP86BA"
}
]
},
{
"cardPec": "NTK539UJ",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539UX",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539UN",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 153
Blue Planet MCP API Reference Guide, Release 18.06 Planning

{
"cardPec": "NTK539BB",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539BE",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539BH",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK539BN",
"certifiedMatePecs": [
"NTK529AC",
"NTK529BX"
],
"certifiedClientPluggables": []
},
{
"cardPec": "NTK538DZ",
"certifiedMatePecs": [],
"certifiedClientPluggables": [
{
"rate": "DSR_100GE",
"pec": "160-9400-900"
},
{
"rate": "DSR_100GE",
"pec": "160-9401-900"
},
{
"rate": "DSR_100GE",
"pec": "160-9402-900"
},
{
"rate": "DSR_100GE",
"pec": "160-9403-900"
},
{
"rate": "OTM4",
"pec": "160-9400-900"
},
{
"rate": "OTM4",
"pec": "160-9401-900"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 154
Blue Planet MCP API Reference Guide, Release 18.06 Planning

},
{
"rate": "OTM4",
"pec": "160-9402-900"
},
{
"rate": "OTM4",
"pec": "160-9403-900"
}
]
}
]
},
"userActivityInfo": {
"createdByUserName": "",
"creationTime": "2017-07-12T13:49:28.3783341+00:00"
}
}

Perform viability override

The following steps are required to update/create MCP viability data:

• Obtain the existing viability data from the viability microservice (see Retrieve viability data).
• If you are going to replace all of the MCP viability data, update the data obtained in Step 1 or append
new data to the data obtained in Step 1. Proceed to Create/update all viability data.

If you do not want to replace all of the MCP viability data; you only want to add a new verification path
to the MCP viability data or you want to update some of the existing MCP viability data, proceed to
Create/update new viability data.

Retrieve viability data

Sample requests

GET {{MCP_SERVER}}/viability/api/v1/ViableRoutes/ViabilityData

or

GET {{MCP_SERVER}}/viability/api/v1/ViableRoutes/ViabilityData?freIds=1338565178451080725

Note: Multiple FRE identifiers (comma delimited) can be specified for retrieval.

Sample response: verification path format

{
"VerificationPaths": [
{
"vpName": "VP55",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 155
Blue Planet MCP API Reference Guide, Release 18.06 Planning

"amplifiedSpanCount": 2,
"fiberLatency": 98,
"mateVpName": "VP56",
"modulationClass": "MC_100GWL38QAM",
"aEndVpEndPoint": {
"dwdmInterface": "WL3EMDM8QAMCLS1",
"cmdType": "CCMD12",
"wssType": "UNKNOWN",
"diaAmpType": "none",
"splitterCouplerType": "none",
"coadmAmpType": "OME_MLA3",
"demuxAmpType": "none",
"diaWssType": "none",
"diaSplitterCouplerType": "none"
},
"zEndVpEndPoint": {
"dwdmInterface": "WL3EMDM8QAMCLS1",
"cmdType": "CCMD12",
"wssType": "UNKNOWN",
"diaAmpType": "none",
"splitterCouplerType": "none",
"coadmAmpType": "OME_MLA3",
"demuxAmpType": "none",
"diaWssType": "none",
"diaSplitterCouplerType": "none"
},
"opsEnabled": false,
"parentLongPathVpId": "VP55",
"pmd": 0.447213595499958,
"status": "Passed",
"validationResult": {
"calcMode": "Normal",
"rcvDispersionMargin": 244.347974866246,
"rcvDispersionMarginMax": 421.39660370451,
"optimumDispersionShift": 0,
"dispersionShiftFiberType": "NDSF",
"lowDispersionMargin": 0,
"highDispersionMargin": 0,
"simulatedOsnr": 24.0355934462621,
"adjustedReceiverOsnr": 23.4955934462621,
"rcvOsnrMargin": 7.86139698894605,
"rcvPowerMax": -8.97918548131621,
"rcvPowerMaxMargin": 11.4791854813162,
"rcvPowerMin": -9.07585443270938,
"rcvPowerMinMargin": 8.92414556729062,
"requiredReceiverPowerMax": 4,
"requiredReceiverPowerMin": -20,
"transmitterPowerReduction": 0,
"leVerificationCertification": "FTV_Certified",
"mpi": -39.0886750627875,
"prfber": 0.032,
"allocMarginPdl": 0.897156062232207,
"maxRxPower": 1,
"e2pn": -25.1878876047514,
"estimatedPadValue": 0,
"failureReasonSeverity": "Error",
"failureReasonType": ""
},
"vpOmsRoute": [

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 156
Blue Planet MCP API Reference Guide, Release 18.06 Planning

{
"freid": "-9118497143917145132",
"aEndNcid": "5a9d6653-4d9d-436e-93e2-be38cb9596f1",
"aEndNodeName": "NE1",
"omsTlName": "Oms-WSS-TX-1326-WSS-RX-1628",
"length": 10,
"routeIndex": 1,
"zEndNcid": "e888e7de-657c-425b-a5d8-4ed12172761d",
"zEndNodeName": "NE2"
},
{
"freid": "206160161395439961",
"aEndNcid": "e888e7de-657c-425b-a5d8-4ed12172761d",
"aEndNodeName": "NE2",
"omsTlName": "Oms-WSS-TX-1477-WSS-RX-1426",
"length": 10,
"routeIndex": 2,
"zEndNcid": "71284161-d693-4cdc-af6b-39e25a637a01",
"zEndNodeName": "NE3"
}
],
"vpSourceNodeName": "NE1",
"vpDestinationNodeName": "NE3",
"vpSourceNcid": "5a9d6653-4d9d-436e-93e2-be38cb9596f1",
"vpDestinationNcid": "71284161-d693-4cdc-af6b-39e25a637a01",
"vpType": "FtvFlex",
"mcMixType": "Pure",
"channelSpacing": 50,
"startFrequency": 191.325,
"endFrequency": 196.125,
"txSnrBias": 0
},
{
"vpName": "VP59",
"amplifiedSpanCount": 1,
"fiberLatency": 49,
"mateVpName": "VP60",
"modulationClass": "MC_100GWL38QAM",
"aEndVpEndPoint": {
"dwdmInterface": "WL3EMDM8QAMCLS1",
"cmdType": "CCMD12",
"wssType": "UNKNOWN",
"diaAmpType": "none",
"splitterCouplerType": "none",
"coadmAmpType": "OME_MLA3",
"demuxAmpType": "none",
"diaWssType": "none",
"diaSplitterCouplerType": "none"
},
"zEndVpEndPoint": {
"dwdmInterface": "WL3EMDM8QAMCLS1",
"cmdType": "CCMD12",
"wssType": "UNKNOWN",
"diaAmpType": "none",
"splitterCouplerType": "none",
"coadmAmpType": "OME_MLA3",
"demuxAmpType": "none",
"diaWssType": "none",
"diaSplitterCouplerType": "none"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 157
Blue Planet MCP API Reference Guide, Release 18.06 Planning

},
"opsEnabled": false,
"parentLongPathVpId": "VP55",
"pmd": 0.316227766016838,
"status": "Passed",
"validationResult": {
"calcMode": "Normal",
"rcvDispersionMargin": 95.0372292082571,
"rcvDispersionMarginMax": 237.816033746884,
"optimumDispersionShift": -11,
"dispersionShiftFiberType": "NDSF",
"simulatedOsnr": 24.5803656909155,
"rcvPowerMax": -8.97918548131621,
"rcvPowerMaxMargin": 11.4791854813162,
"rcvPowerMin": -9.07585443270938,
"rcvPowerMinMargin": 8.92414556729062,
"requiredReceiverPowerMax": 4,
"requiredReceiverPowerMin": -20,
"transmitterPowerReduction": 0,
"leVerificationCertification": "FTV_Certified",
"mpi": -39.248261845928,
"allocMarginPdl": 0.812280739646091,
"maxRxPower": 1,
"estimatedPadValue": 0,
"failureReasonSeverity": "Error",
"failureReasonType": ""
},
"vpOmsRoute": [
{
"freid": "206160161395439961",
"aEndNcid": "e888e7de-657c-425b-a5d8-4ed12172761d",
"aEndNodeName": "NE2",
"omsTlName": "Oms-WSS-TX-1477-WSS-RX-1426",
"length": 10,
"routeIndex": 1,
"zEndNcid": "71284161-d693-4cdc-af6b-39e25a637a01",
"zEndNodeName": "NE3"
}
],
"vpSourceNodeName": "NE2",
"vpDestinationNodeName": "NE3",
"vpSourceNcid": "e888e7de-657c-425b-a5d8-4ed12172761d",
"vpDestinationNcid": "71284161-d693-4cdc-af6b-39e25a637a01",
"vpType": "FtvFlex",
"mcMixType": "Pure",
"channelSpacing": 50,
"startFrequency": 191.325,
"endFrequency": 196.125,
"txSnrBias": 0
}
]
}

Create/update new viability data

Use this API request to replace some of the MCP viability data or to add new viability data to MCP with a

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 158
Blue Planet MCP API Reference Guide, Release 18.06 Planning

single verification path in each request.

Sample request

PUT {{MCP_SERVER}}/viability/api/v1/ViableRoutes/ViabilityData

Note: For the input format, see Sample response: verification path format.

Sample response A response code of 200 indicates that MCP was successfully updated.

Create/update all viability data

Use this API request to delete and replace ALL of the MCP viability data. You must include all of the
required viability data as input to this request.

Sample request

POST {{MCP_SERVER}}/viability/api/v1/ViableRoutes/ViabilityData

Note: For the input format, see Sample response: verification path format.

Sample response A response code of 200 indicates that MCP was successfully updated.

Retrieving a Project Validation Report

To retrieve the project import validation report using the GET command, you can either use the Project Id
or Project Name to access the report:

Using the project name:

GET
{MCP_SERVER}/equipmenttopologyplanning/api/v1/Reports/importvalidation?projectName=project1

Using the Name Id:

GET {MCP_SERVER}/equipmenttopologyplanning/api/v1/Reports/importvalidation/1d444858-a375-
4f16-984f-603fbe707670

This is a sample GET response:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 159
Blue Planet MCP API Reference Guide, Release 18.06 Planning

{
"generationDate": "2018-07-04T17:21:52.785+00:00",
"version": "MCP(2.7.144)",
"source": {
"project": {
"id": "1d444858-a375-4f16-984f-603fbe707670",
"name": "WS1"
}
},
"results": [
{
"version": "MCP(2.7.144)",
"status": "Passed",
"severity": "Error",
"title": "Incomplete Fiber Routes",
"description": "Look for incomplete fiber routes",
"details": "All new fiber routes terminate at an OADM"
},
{
"version": "MCP(2.7.144)",
"status": "Passed",
"severity": "Error",
"title": "Unsupported Equipment",
"description": "Look for unsupported or unrecognized equipment",
"details": "All new equipment is supported"
},
{
"version": "MCP(2.7.144)",
"status": "Passed",
"severity": "Error",
"title": "Project Type",
"description": "Validate the project type",
"details": "Project type is valid."
},
{
"version": "MCP(2.7.144)",
"status": "Failed",
"severity": "Error",
"title": "WaveServer Node Properties",
"description": "Some new WaveServer nodes have missing properties",
"details": "The following WaveServer nodes have missing properties:\nNode
'WS1' is missing properties: 'Member Id' and 'Group Id'\nNode 'WS2' is missing
properties: 'Member Id' and 'Group Id'\n"
},
{
"version": "MCP(2.7.144)",
"status": "Passed",
"severity": "Error",
"title": "Potential merge conflict",
"description": "Look for potential merge conflicts",
"details": "No conflicting entities have been found in the original and
planned networks.\nThe current network is empty or could not be retrieved. Merge
conflict detection with the current network was not performed."
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 160
Blue Planet MCP API Reference Guide, Release 18.06 Planning

Triggering a Project Validation Report

To trigger the validation, you can POST using either the Project Id or Project Name as with the GET
command.

Using the project name:

POST
{MCP_SERVER}/equipmenttopologyplanning/api/v1/Reports/importvalidation/execute?projectName=Pr
oject1

Using the Name Id:

POST {MCP_SERVER}/equipmenttopologyplanning/api/v1/Reports/importvalidation/1d444858-a375-
4f16-984f-603fbe707670/execute

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 161
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Network element management

You can manage network elements using MCP REST APIs. The following topics are covered:

• Commissioning management
• Generate the commissioning scripts
• Generate commissioning scripts for a homogeneous project (6500)
• Generate commissioning scripts for a homogeneous project (Waveserver)
• Generate commissioning scripts for a heterogeneous project consisting of (6500 and Waveserver)
• Retrieve the commissioning scripts
• Retrieve commissioning scripts for a homogeneous project (6500)
• Retrieve commissioning scripts for a homogeneous project (Waveserver)
• Retrieve commissioning scripts for a heterogeneous project consisting of (6500 and Waveserver)
• Enroll a 6200 network element
• View 6200 inventory
• Service provisioning after commissioning
• Change a network element connection profile
• Commission and configure a node or port
• Changing the Waveserver Ai 1.1 DCN wayside
• Retreive health diagnostics from a node
• Retrieve control plane configuration data from a node
• Create the Facility By Pass Profile
• Create/Edit the Facility By Pass Profile using shareable SRLG
• Edit the Facility By Pass Profile
• Delete the Facility By Pass Profile
• Retrieve the Facility By Pass Profile
• Retrieve the FRR Profile(s)
• Set/Unset the Facility By Pass Profile to an IP interface
• Configuring a shareable SRLG list on a node
• Configure Traffic Engineering (TE) parameters for an IP interface
• Place a network element into or out of maintenance mode

Commissioning management
This section describes network element commissioning management.

The following policy types are supported by the commissioning API:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 162
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

• For script generation of a homogeneous project only consisting of 6500 nodes: Public_IPV4_v1,
Public_IPV6_v1 (6500-specific policies):

Supports DCN Example 4 in the 6500 Packet-Optical Platform Data Communications Planning and User
Guide, 323-1851-101.

◦ Private_IPV4_v1 (6500 specific policy, not supported in MCP 18.06)

◦ Public_IPV6_v1 (6500 specific policy)
• For script generation of a homogeneous project only consisting of Waveserver nodes: Waveserver_v1.
• For script generation of a heterogeneous project consisting of 6500 and Waveserver nodes:
Heterogeneous_v1.
• For license configuration: License_6500_v1
• For SNMP configuration: SNMP_6500_v1
• For NTP configuration: NTP_Defaults_v1
• For 6500 equipment commissioning: EQPT_6500_v1
• For RADIUS servers configuration: Radius_Defaults_v1
• For craft user interface launch: Craft_UI_Launch_v1

Tasks include:

• Policy management for script generation

• Policy management for SNMP provisioning
• Policy management for Heterogeneous project
• Policy management for license provisioning
• Policy management for waveserver script generation
• Policy management for NTP provisioning
• Policy management for RADIUS server provisioning
• IP subnetwork management
• Policy management for craft launch

Policy management for script generation

Manage policies for script generation.

Tasks include:

• Retrieve all policy types

• Create a policy for script generation of a homogeneous nodes project
• Create a policy for script generation of a heterogeneous nodes project
• Retrieve all policies or a single policy

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 163
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

• Set an active policy for script generation

• Retrieve policy data
• Update a policy
• Reset a policy to the defaults

Retrieve all policy types

Retrieve all of the policy types using the commissioning API.

Sample request

GET {{MCP_SERVER}}/commissioning/api/v1/policyTypes/

Sample response

{
"data": [
{
"master_template": "master_ws_v1.tmpl",
"supported_operation": "POST_SCRIPTS_v1",
"handler_class":
"commissioning.services.scripts.waveserver.v1.CWSHandlerV1.CWSHandlerV1",
"policy_type": "Waveserver_v1",
"defaults_file": "waveserver_v1.json"
},
{
"master_template": "None",
"supported_operation": "Radius_Defaults_v1",
"handler_class":
"commissioning.services.radius.RadiusHandler.RadiusHandler",
"policy_type": "Radius_Defaults_v1",
"defaults_file": "radius_defaults_v1.json"
},
{
"master_template": "None",
"supported_operation": "NTP_Defaults_v1",
"handler_class": "commissioning.services.ntp.NTPHandler.NTPHandler",
"policy_type": "NTP_Defaults_v1",
"defaults_file": "ntp_defaults_v1.json"
},
{
"master_template": "master_private_ipv4_v1.tmpl",
"supported_operation": "POST_SCRIPTS_v1",
"handler_class":
"commissioning.services.scripts.private_ipv4.v1.PrivateIPV4HandlerV1.PrivateIPV4Han
dlerV1",
"policy_type": "Private_IPV4_v1",
"defaults_file": "private_ipv4_v1.json"
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 164
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"master_template": "None",
"supported_operation": "CRAFT_UI_LAUNCH_v1",
"handler_class": "None",
"policy_type": "Craft_UI_Launch_v1",
"defaults_file": "craft_ui_launch_v1.json"
},
{
"master_template": "master_public_ipv4_v1.tmpl",
"supported_operation": "POST_SCRIPTS_v1",
"handler_class":
"commissioning.services.scripts.public_ipv4.v1.PublicIPV4HandlerV1.PublicIPV4Handle
rV1",
"policy_type": "Public_IPV4_v1",
"defaults_file": "public_ipv4_v1.json"
},
{
"master_template": "master_heterogeneous_v1.tmpl",
"supported_operation": "POST_SCRIPTS_v1",
"handler_class":
"commissioning.services.scripts.heterogeneous.v1.HeterogeneousHandlerV1.Heterogeneo
usHandlerV1",
"policy_type": "Heterogeneous_v1",
"defaults_file": "heterogeneous_v1.json"
},
{
"master_template": "master_snmp_6500_v1.tmpl",
"supported_operation": "SNMP_6500_v1",
"handler_class": "commissioning.services.snmp.SNMPHandler.SNMPHandler",
"policy_type": "SNMP_6500_v1",
"defaults_file": "snmp_6500_v1.json"
},
{
"master_template": "master_public_ipv6_v1.tmpl",
"supported_operation": "POST_SCRIPTS_v1",
"handler_class":
"commissioning.services.scripts.public_ipv6.v1.PublicIPV6HandlerV1.PublicIPV6Handle
rV1",
"policy_type": "Public_IPV6_v1",
"defaults_file": "public_ipv6_v1.json"
},
{
"master_template": "master_eqpt_6500_v1.tmpl",
"supported_operation": "EQPT_6500_v1",
"handler_class":
"commissioning.services.eqpt.EquipmentCommissioning.EquipmentCommissioning",
"policy_type": "EQPT_6500_v1",
"defaults_file": "eqpt_6500_v1.json"
}
]
}

Create a policy for script generation of a homogeneous nodes project

Create a policy for script generation of a homogeneous nodes project using the commissioning API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 165
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Requirements

• Provide the values for the new policy.

• For the policyType, use a policy type supported for script generation. See Retrieve all policy types.
• To set an active policy, set state to Active.
• Supported policy types for 6500 nodes:
◦ Private_IPV4_v1
◦ Public_IPV4_v1
◦ Public_IPV6_v1
• Supported policy types for Waveserver nodes: Waveserver_v1.

Sample request

POST {{MCP_SERVER}}/commissioning/api/v1/policy/

Sample input to create a Public_IPV4_v1 policy

{
"policyName": "Policy01",
"policyType": "Public_IPV4_v1",
"description": "DCN routable policy",
"customerName": "Telus",
"state": "New"
}

Sample response

{
"data": [
{
"attributes": {
"policy_name": "Policy01",
"state": "New",
"supported_operation": "POST_SCRIPTS_v1",
"description": "DCN routable policy",
"customer_name": "telus"
},
"type": "Public_IPV4_v1",
"id": "201ba295-3888-4b2d-9a4a-9d254de0c6a0"
}
]
}

Sample input to create a Public_IPV6_v1 policy

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 166
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"policyName": "Policy06",
"policyType": "Public_IPV6_v1",
"description": "DCN routable policy",
"customerName": "Telus",
"state": "New"
}

Sample response

{
"data": [
{
"attributes": {
"policy_name": "Policy06",
"state": "New",
"supported_operation": "POST_SCRIPTS_v1",
"description": "DCN routable policy",
"customer_name": "telus"
},
"type": "Public_IPV6_v1",
"id": "201ba295-3888-4b2d-9a4a-9d254de0c6a0"
}
]
}

Note: The value for "id" in this response is used in a subsequent request.

Create a policy for script generation of a heterogeneous nodes project

Create a policy for script generation of a heterogeneous nodes project using the commissioning API.

Requirements

• Provide the values for the new policy.

• For the policyType, use a policy type supported for script generation. See Retrieve all policy types.
• To activate this plicy, set state to Active.
• Supported policy types for 6500 nodes:
◦ Private_IPV4_v1
◦ Public_IPV4_v1
▪ Support for NEMODE, ETHGFPRFI and Span Loss Margin is provided. The default values are:
SONET for NEMODE, ENABLED for ETHGFPRFI, and 3 dB for Span Loss Margin.
◦ Public_IPV6_v1

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 167
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

• Supported policy types for Waveserver nodes: Waveserver_v1.

Sample request

POST {{MCP_SERVER}}/commissioning/api/v1/policy/

Sample input

{
"policyName": "Policy for 6500 and waveserver nodes projects",
"policyType": "Heterogeneous_v1",
"description": "Heterogeneous policy",
"customerName": "AT&T",
"state": "New"
}

Sample response

{
"data": [
{
"attributes": {
"policy_name": "Policy for 6500 and waveserver nodes projects",
"state": "New",
"supported_operation": "POST_SCRIPTS_v1",
"description": "Heterogeneous policy",
"customer_name": "AT&T"
},
"type": "Heterogeneous_v1",
"id": "6802171a-e686-4cc2-8677-ea7cc8977133"
}
]
}

Note: The value for "id" in this response is used in a subsequent request.

Retrieve all policies or a single policy

Retrieve all policies (user or system) or a single policy using the commissioning API.

Requirements

• To retrieve all policies, leave the "id" parameter blank.

• To retrieve a single policy, provide the "id" value.

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 168
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

To retrieve all policies:

GET {{MCP_SERVER}}/commissioning/api/v1/policy/

To retrieve a single policy:

GET {{MCP_SERVER}}/commissioning/api/v1/policy/?id=1b312740-d6b7-4aee-8037-744215515d52

Sample response (for ALL policies)

{
"data": [
{
"attributes": {
"policy_name": "Default Policy for Craft UI Launch 1",
"state": "Active",
"supported_operation": "CRAFT_UI_LAUNCH_v1",
"description": "Default policy for Craft UI Launch",
"customer_name": "default"
},
"type": "Craft_UI_Launch_v1",
"id": "706d670e-9724-4a02-92bb-7a13957f7496"
},
{
"attributes": {
"policy_name": "Default Policy for Radius 1",
"state": "Active",
"supported_operation": "Radius_Defaults_v1",
"description": "Default policy for Radius commissioning",
"customer_name": "default"
},
"type": "Radius_Defaults_v1",
"id": "435fc50c-7ada-4f0a-ace2-5c39b7c322ad"
},
{
"attributes": {
"policy_name": "Default Policy for NTP 1",
"state": "Active",
"supported_operation": "NTP_Defaults_v1",
"description": "Default policy for NTP commissioning",
"customer_name": "default"
},
"type": "NTP_Defaults_v1",
"id": "2f42a246-0f78-4cef-a98f-ee4589247e07"
},
{
"attributes": {
"policy_name": "Default Policy for 6500 SNMP 1",
"state": "Active",
"supported_operation": "SNMP_6500_v1",
"description": "Default policy for 6500 SNMP commissioning",
"customer_name": "default"
},
"type": "SNMP_6500_v1",
"id": "794b6fc0-7de5-49b1-970e-af8181546c33"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 169
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"attributes": {
"policy_name": "Default Policy for 6500 Equipment 1",
"state": "Active",
"supported_operation": "EQPT_6500_v1",
"description": "Default policy for 6500 Equipment commissioning",
"customer_name": "default"
},
"type": "EQPT_6500_v1",
"id": "0d1f63b5-9966-41d3-8952-26a08d358179"
}
]
}

Sample response (for a single policy)

{
"data": [
{
"attributes": {
"policy_name": "Policy01",
"state": "New",
"supported_operation": "POST_SCRIPTS_v1",
"description": "DCN routable policy",
"customer_name": "telus"
},
"type": "Public_IPV4_v1",
"id": "1b312740-d6b7-4aee-8037-744215515d52"
}
]
}

Set an active policy for script generation

Set an active policy for script generation using the commissioning API.

Requirements

• Use a value for "id" as indicated in a response from Create a policy for script generation of a
homogeneous nodes project, Create a policy for script generation of a heterogeneous nodes project or
Retrieve all policies.
• Use a value for "policy" as indicated in the sample input.

Sample request

PUT {{MCP_SERVER}}/commissioning/api/v1/policy/?id=1b312740-d6b7-4aee-8037-744215515d52

Sample input

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 170
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"state": "Active"
}

Sample response

A response code of 200 indicates a successful activation of a policy for script generation.

Retrieve policy data

Retrieve policy data using the commissioning API.

Requirements

• To retrieve all policies data, leave the "id" parameter blank.

• To retrieve a single policy data, provide the "id" value.

Sample request

To retrieve all policies' data:

GET {{MCP_SERVER}}/commissioning/api/v1/policyDefaults/

To retrieve a single policy’s data:

GET {{MCP_SERVER}}/commissioning/api/v1/policyDefaults/?id=1b312740-d6b7-4aee-8037-
744215515d52

Sample response (for a single policy - Public_IPV4_v1)

{
"data": [
{
"attributes": {
"additionalAttributes": {
"data": {
"node": [
{
"shelf": [
{
"shelfattributes": {
"colan": {
"isColan": true,
"ipType": "IPV4",
"colanRouting": "ospfCircuit"
},
"radius": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 171
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"active": true,
"authState": "DISABLE",
"state": "ENABLE",
"proxyServer": "N",
"accounting": "DISABLE"
},
"gne": {
"isGne": true,
"gneConfiguration": "REDUNDANT",
"gneAccess": "OSPF"
}
},
"isTIDc": "ENABLE",
"primary": "Enable",
"shelfType": null
},
{
"shelfattributes": {
"colan": {
"isColan": false,
"ipType": "IPV4",
"colanRouting": "ospfCircuit"
},
"radius": {
"active": false,
"authState": "DISABLE",
"state": "ENABLE",
"proxyServer": "N",
"accounting": "DISABLE"
},
"gne": {
"isGne": false,
"gneConfiguration": null,
"gneAccess": null
}
},
"isTIDc": "ENABLE",
"primary": "Disable",
"shelfType": null
}
],
"nodeType": "OADM"
},
{
"shelf": [
{
"shelfattributes": {
"colan": {
"isColan": false,
"ipType": "IPV4",
"colanRouting": "ospfCircuit"
},
"radius": {
"active": true,
"authState": "DISABLE",
"state": "ENABLE",
"proxyServer": "N",
"accounting": "DISABLE"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 172
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"gne": {
"isGne": false,
"gneConfiguration": "REDUNDANT",
"gneAccess": "OSPF"
}
},
"isTIDc": "ENABLE",
"primary": "Enable",
"shelfType": null
}
],
"nodeType": "ILA"
},
{
"shelf": [
{
"shelfattributes": {
"colan": {
"isColan": false,
"ipType": "IPV4",
"colanRouting": "ospfCircuit"
},
"radius": {
"active": true,
"authState": "DISABLE",
"state": "ENABLE",
"proxyServer": "N",
"accounting": "DISABLE"
},
"gne": {
"isGne": false,
"gneConfiguration": "REDUNDANT",
"gneAccess": "OSPF"
}
},
"isTIDc": "ENABLE",
"primary": "Enable",
"shelfType": null
}
],
"nodeType": "DGE"
}
],
"shelfIPDefaults": {
"shelfNetMaskV4": "255.255.255.255",
"isOSPFRequired": true
},
"ilanDefaults": {
"ilanIP": "0.0.0.0",
"ilanNetmask": "255.255.255.255",
"ilanPrts": [
{
"ilanOutPrt": "OUT",
"ilanInPrt": "IN",
"family": {
"familyType": "S-Series"
}
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 173
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"ilanOutPrt": "OUT1",
"ilanInPrt": "IN1",
"family": {
"familyType": "T-Series"
}
}
],
"ilanIPType": "UnNumbered"
},
"comms": {
"shelfRouting": "geoOSPF",
"telnetState": "ON",
"ipTypeDcn": "IPV4",
"idleTimeOut": 30,
"httpRest": "OFF",
"httpsState": "ON",
"colanOverrideSupported": true,
"familySpecific": [
{
"sshMaxSessions": 18,
"family": {
"familyType": "S-Series"
}
},
{
"sshMaxSessions": 28,
"family": {
"familyType": "T-Series"
}
}
],
"oscRouting": "OSPF",
"httpState": "OFF"
},
"photonicDefaults": {
"oscMode": "DISABLED",
"spanLossMargin": "3.0"
},
"general": {
"linepevstat": "AUTO",
"bitsMode": "SONET",
"autoProvCRS": "ON",
"autoEquipMode": "DISABLED",
"neMode": [
{
"value": "SONET",
"family": {
"familyType": "S-Series"
}
},
{
"value": "NONE",
"family": {
"familyType": "T-Series"
}
}
],
"shelfSync": "YES",
"airFilterReplacementAlarm": "ENABLE",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 174
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"LASEROFFFARENDFAIL": "DISABLED",
"pathsdth": 6,
"csfmcastmac": "0180C2880001",
"tcaSuppression": "NO",
"pathswcrit": {
"oduSignalDegrade": false,
"alarmIndicationSignal": true,
"lossOfPointer": false,
"traceIdentifierMismatch": false,
"pathSignalDegrade": false,
"pathUnequipped": false,
"pathExcessiveBitError": false,
"payloadLabelMismatch": false
},
"minCooling": "HIGHFLOW",
"ainsTimeOut": {
"hours": 0,
"minutes": 5
},
"bayFICinAO": "FALSE",
"gcc0mode": "DISABLED",
"lineFlappingThreshold": 3,
"ndpMode": "ON",
"enhEqptMgmt": "DISABLED",
"pthaisinsert": {
"lossOfMultiframe": false,
"alarmIndicationSignal": true,
"lossOfPointer": true,
"traceIdentifierMismatch": false,
"payloadLabelUnequipped": false,
"payloadLabelMismatch": false
},
"lineFlappingRaiseTime": 300,
"eth10gmapping": "GFPSTD",
"ethgfprfiupi": 5,
"extendedShelfNumber": "DISABLE",
"alarmHoldOff": "2.5",
"spareEquipmentPrimaryState": "OOS-MA",
"pathpevstat": "MAN",
"ainsEquipmentAlarmMode": null,
"csControl": "OFF",
"autoprovfac": "ON",
"docautodellos": "NO",
"patheberth": 4,
"isFICRequired": false,
"ainsEquipmentSuppressSlotAlarm": null,
"ethgfprfi": "ENABLED",
"fiberLossDetection": "ENABLED",
"alarmInfo": {
"name": true,
"label": false,
"fic": false,
"cardType": false,
"disable": false,
"clfi": true,
"subnetName": false,
"waveLength": false,
"physicalShelf": false,
"bayNumber": false

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 175
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

},
"airFilterReplacementTimer": "730",
"ainsEquipmentTimeOut": {
"hours": 0,
"minutes": 5
},
"autoRoute": "DISABLE",
"lineFlappingClearTime": 300,
"gcc1mode": "DISABLED",
"ainsEquipmentDefault": null,
"alarmCorrelation": "ON"
},
"radiusDefaults": {
"primaryAccProfileName": "",
"alternate": "LOCAL",
"isRadiusRequired": true,
"secondaryAccProfileName": "",
"proxyTimeout": 30,
"secondaryProfileName": "RADIUS Authentication
Secondary",
"defaultPort": 1812,
"queryMode": "ROUND_ROBIN",
"timeout": 15,
"genSecret": "N",
"fallback": "Local",
"primaryProfileName": "RADIUS Authentication Primary"
},
"osrpDefaults": {
"osrpData": [
{
"layer": "L0",
"udpPort": 51001
}
]
}
}
}
},
"type": "Public_IPV4_v1",
"id": "26ad791c-d750-4f44-a20d-2b8f7708a8f7"
}
]
}

Update a policy

Update a policy for script generation using the commissioning API.

Requirements

• Provide the "id" value obtained from Create a policy for script generation of a homogeneous nodes
project, Create a policy for script generation of a heterogeneous nodes project or from Retrieve all

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 176
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

policies or a single policy.

• Provide values for the defaults parameter obtained from Retrieve all policies or a single policy (that is,
first GET the policy data, update the values as desired in that data, and then provide that updated data
here under the defaults parameter).

Sample request

POST {{MCP_SERVER}}/commissioning/api/v1/policyDefaults/?id=1b312740-d6b7-4aee-8037-
744215515d52

Sample input (for the Public_IPV4_v1 policy)

Note: The Public_IPV4_v1 policy configures nodes according to DCN Example 4 in the 6500 Packet-
Optical Platform Data Communications Planning and User Guide, 323-1851-101.

{
"data": [
{
"attributes": {
"additionalAttributes": {
"data": {
"node": [
{
"shelf": [
{
"shelfattributes": {
"colan": {
"isColan": true,
"ipType": "IPV4",
"colanRouting": "ospfCircuit"
},
"radius": {
"active": true,
"authState": "DISABLE",
"state": "ENABLE",
"proxyServer": "N",
"accounting": "DISABLE"
},
"gne": {
"isGne": true,
"gneConfiguration": "REDUNDANT",
"gneAccess": "OSPF"
}
},
"isTIDc": "ENABLE",
"primary": "Enable",
"shelfType": null
},
{
"shelfattributes": {
"colan": {
"isColan": false,
"ipType": "IPV4",
"colanRouting": "ospfCircuit"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 177
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

},
"radius": {
"active": false,
"authState": "DISABLE",
"state": "ENABLE",
"proxyServer": "N",
"accounting": "DISABLE"
},
"gne": {
"isGne": false,
"gneConfiguration": null,
"gneAccess": null
}
},
"isTIDc": "ENABLE",
"primary": "Disable",
"shelfType": null
}
],
"nodeType": "OADM"
},
{
"shelf": [
{
"shelfattributes": {
"colan": {
"isColan": false,
"ipType": "IPV4",
"colanRouting": "ospfCircuit"
},
"radius": {
"active": true,
"authState": "DISABLE",
"state": "ENABLE",
"proxyServer": "N",
"accounting": "DISABLE"
},
"gne": {
"isGne": false,
"gneConfiguration": "REDUNDANT",
"gneAccess": "OSPF"
}
},
"isTIDc": "ENABLE",
"primary": "Enable",
"shelfType": null
}
],
"nodeType": "ILA"
},
{
"shelf": [
{
"shelfattributes": {
"colan": {
"isColan": false,
"ipType": "IPV4",
"colanRouting": "ospfCircuit"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 178
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"radius": {
"active": true,
"authState": "DISABLE",
"state": "ENABLE",
"proxyServer": "N",
"accounting": "DISABLE"
},
"gne": {
"isGne": false,
"gneConfiguration": "REDUNDANT",
"gneAccess": "OSPF"
}
},
"isTIDc": "ENABLE",
"primary": "Enable",
"shelfType": null
}
],
"nodeType": "DGE"
}
],
"shelfIPDefaults": {
"shelfNetMaskV4": "255.255.255.255",
"isOSPFRequired": true
},
"ilanDefaults": {
"ilanIP": "0.0.0.0",
"ilanNetmask": "255.255.255.255",
"ilanPrts": [
{
"ilanOutPrt": "OUT",
"ilanInPrt": "IN",
"family": {
"familyType": "S-Series"
}
},
{
"ilanOutPrt": "OUT1",
"ilanInPrt": "IN1",
"family": {
"familyType": "T-Series"
}
}
],
"ilanIPType": "UnNumbered"
},
"comms": {
"shelfRouting": "geoOSPF",
"telnetState": "ON",
"ipTypeDcn": "IPV4",
"idleTimeOut": 30,
"httpRest": "OFF",
"httpsState": "ON",
"colanOverrideSupported": true,
"familySpecific": [
{
"sshMaxSessions": 18,
"family": {
"familyType": "S-Series"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 179
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

}
},
{
"sshMaxSessions": 28,
"family": {
"familyType": "T-Series"
}
}
],
"oscRouting": "OSPF",
"httpState": "OFF"
},
"photonicDefaults": {
"oscMode": "DISABLED",
"spanLossMargin": "3.0"
},
"general": {
"linepevstat": "AUTO",
"bitsMode": "SONET",
"autoProvCRS": "ON",
"autoEquipMode": "DISABLED",
"neMode": [
{
"value": "SONET",
"family": {
"familyType": "S-Series"
}
},
{
"value": "NONE",
"family": {
"familyType": "T-Series"
}
}
],
"shelfSync": "YES",
"airFilterReplacementAlarm": "ENABLE",
"LASEROFFFARENDFAIL": "DISABLED",
"pathsdth": 6,
"csfmcastmac": "0180C2880001",
"tcaSuppression": "NO",
"pathswcrit": {
"oduSignalDegrade": false,
"alarmIndicationSignal": true,
"lossOfPointer": false,
"traceIdentifierMismatch": false,
"pathSignalDegrade": false,
"pathUnequipped": false,
"pathExcessiveBitError": false,
"payloadLabelMismatch": false
},
"minCooling": "HIGHFLOW",
"ainsTimeOut": {
"hours": 0,
"minutes": 5
},
"bayFICinAO": "FALSE",
"gcc0mode": "DISABLED",
"lineFlappingThreshold": 3,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 180
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"ndpMode": "ON",
"enhEqptMgmt": "DISABLED",
"pthaisinsert": {
"lossOfMultiframe": false,
"alarmIndicationSignal": true,
"lossOfPointer": true,
"traceIdentifierMismatch": false,
"payloadLabelUnequipped": false,
"payloadLabelMismatch": false
},
"lineFlappingRaiseTime": 300,
"eth10gmapping": "GFPSTD",
"ethgfprfiupi": 5,
"extendedShelfNumber": "DISABLE",
"alarmHoldOff": "2.5",
"spareEquipmentPrimaryState": "OOS-MA",
"pathpevstat": "MAN",
"ainsEquipmentAlarmMode": null,
"csControl": "OFF",
"autoprovfac": "ON",
"docautodellos": "NO",
"patheberth": 4,
"isFICRequired": false,
"ainsEquipmentSuppressSlotAlarm": null,
"ethgfprfi": "ENABLED",
"fiberLossDetection": "ENABLED",
"alarmInfo": {
"name": true,
"label": false,
"fic": false,
"cardType": false,
"disable": false,
"clfi": true,
"subnetName": false,
"waveLength": false,
"physicalShelf": false,
"bayNumber": false
},
"airFilterReplacementTimer": "730",
"ainsEquipmentTimeOut": {
"hours": 0,
"minutes": 5
},
"autoRoute": "DISABLE",
"lineFlappingClearTime": 300,
"gcc1mode": "DISABLED",
"ainsEquipmentDefault": null,
"alarmCorrelation": "ON"
},
"radiusDefaults": {
"primaryAccProfileName": "",
"alternate": "LOCAL",
"isRadiusRequired": true,
"secondaryAccProfileName": "",
"proxyTimeout": 30,
"secondaryProfileName": "RADIUS Authentication
Secondary",
"defaultPort": 1812,
"queryMode": "ROUND_ROBIN",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 181
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"timeout": 15,
"genSecret": "N",
"fallback": "Local",
"primaryProfileName": "RADIUS Authentication Primary"
},
"osrpDefaults": {
"osrpData": [
{
"layer": "L0",
"udpPort": 51001
}
]
}
}
}
},
"type": "Public_IPV4_v1",
"id": "26ad791c-d750-4f44-a20d-2b8f7708a8f7"
}
]

Sample input (for the Heterogeneous_v1 policy)

{
"data": [
{
"attributes": {
"additionalAttributes": {
"data": {
"nodes": [
{
"nodeType": "6500",
"policyId": "9bbb05f6-c1c2-485e-9984-
b205f8a90b42"
},
{
"nodeType": "waveserver_ai",
"policyId": "a495b9d5-d654-41af-abf1-
f1d53d8d37b6"
}
]
}
}
},
"type": "Heterogeneous_v1",
"id": "6802171a-e686-4cc2-8677-ea7cc8977133"
}
]
}

Reset a policy to the defaults

Set an active policy for script generation to the default values using the commissioning API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 182
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Requirements

Use a value for "id" as indicated in a response from Create a policy for script generation of a
homogeneous nodes project, Create a policy for script generation of a heterogeneous nodes project or
Retrieve all policies.

Sample request

DELETE {{MCP_SERVER}}/commissioning/api/v1/policyDefaults/?id=1b312740-d6b7-4aee-8037-
744215515d52

Sample response

A response code of 200 indicates a successful reset of the specified policy to default values.

Policy management for SNMP provisioning

Manage policies for SNMP provisioning.

Tasks include:

• Retrieve the SNMP policy identifier. Perform Retrieve all policies or a single policy.

The response identifies all of the policies available for commissioning. Within this response, locate the
policy name Default Policy for 6500 SNMP 1. Record the value of the 'id' parameter.

• Retrieve SNMP policy data

• Update SNMP policy data

Retrieve SNMP policy data

Retrieve SNMP policy data using the commissioning API.

Requirements

Use the value of the 'id' parameter previously retrieved.

Sample request

GET {{MCP_SERVER}}/commissioning/api/v1/policyDefaults/?id=1b312740-d6b7-4aee-8037-
744215515d52

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 183
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Sample response

{
"data": [
{
"attributes": {
"additionalAttributes": {
"data": {
"snmp": {
"userCommunity": {
"cstr": ""
},
"trap": {
"trapConfig": "ENABLE_ALL",
"udpPort": "162",
"version": "V3",
"destinations": {
"site_2": "5.6.7.8",
"site_1": "1.2.3.4"
}
},
"agent": {
"agentState": "ENABLED",
"tcaReporting": "OFF",
"version": "V3",
"proxy": "ON",
"alarmMasking": "OFF",
"trapInterface": "AUTO",
"trapMib": "NORTELCIENA"
},
"usmUser": {
"storageType": "NONVOLATILE",
"priv": "NOPRIV",
"usergroup": "OM5Kcustomer1Group"
}
}
}
}
},
"type": "SNMP_6500_v1",
"id": "09ae5fef-4bd9-44fc-a985-616f68dc0078"
}
]
}

Update SNMP policy data

Update SNMP policy data using the commissioning API.

Requirements

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 184
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

• Provide the "id" value obtained from Retrieve all policies or a single policy.
• Provide values for the defaults parameter obtained from Retrieve SNMP policy data (that is, first GET
the policy data and then provide this data to set trap, agents and use community parameters here
under the defaults parameter).

Sample request

POST {{MCP_SERVER}}/commissioning/api/v1/policyDefaults/

Sample input

{
"data": [
{
"attributes": {
"additionalAttributes": {
"data": {
"snmp": {
"userCommunity": {
"cstr": ""
},
"trap": {
"trapConfig": "ENABLE_ALL",
"udpPort": "162",
"version": "V3",
"destinations": {
"site_2": "5.6.7.8",
"site_1": "1.2.3.4"
}
},
"agent": {
"agentState": "ENABLED",
"tcaReporting": "OFF",
"version": "V3",
"proxy": "ON",
"alarmMasking": "OFF",
"trapInterface": "AUTO",
"trapMib": "NORTELCIENA"
},
"usmUser": {
"storageType": "NONVOLATILE",
"priv": "NOPRIV",
"usergroup": "OM5Kcustomer1Group"
}
}
}
}
},
"type": "SNMP_6500_v1",
"id": "09ae5fef-4bd9-44fc-a985-616f68dc0078"
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 185
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Policy management for heterogeneous project

Manage policies for a project with heterogeneous nodes.

Tasks include:

• Retrieve a heterogeneous policy

• Update a heterogeneous policy

Retrieve a heterogeneous policy

Retrieve a heterogeneous policy defaults using the commissioning API.

Requirements

Use the value of the 'id' parameter previously retrieved.

Sample request

GET {{MCP_SERVER}}/commissioning/api/v1/policyDefaults/

Sample response

{
"data": [
{
"attributes": {
"additionalAttributes": {
"data": {
"nodes": [
{
"nodeType": "6500",
"policyId": ""
},
{
"nodeType": "waveserver_ai",
"policyId": ""
}
]
}
},
"type": "Heterogeneous_v1",
"id": "09ae5fef-4bd9-44fc-a985-616f68dc0078"
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 186
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Update an heterogeneous policy

Update an heterogeneous policy using the commissioning API.

Requirements

• Provide the "id" value obtained from retrieve all policies or a single policy.
• Provide values for the node specific policy ids.

Sample request

PUT {{MCP_SERVER}}/commissioning/api/v1/policyDefaults/

Sample input

{
"data": [
{
"attributes": {
"additionalAttributes": {
"data": [
{
"attributes": {
"additionalAttributes": {
"data": {
"nodes": [
{
"nodeType": "6500",
"policyId": "{{PUBLIC_IPV4_V1_POLICY_ID_01}}"
},
{
"nodeType": "waveserver_ai",
"policyId": "{{WS_V1_POLICY_ID_01}}"
}
]
}
}
},
"type": "Heterogeneous_v1",
"id": "{{HETERO_V1_POLICY_ID_01}}"
}
]
}
}
},
"type": "Heterogeneous_v1"
"id": "09ae5fef-4bd9-44fc-a985-616f68dc0078"
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 187
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Note: Currently a heterogeneous project can contain only 6500 and Waveserver nodes. Heterogeneous
policy defaults should contain policy id for device specific policies.

Policy management for license provisioning

Manage policies for license provisioning.

Tasks include:

• Perform retrieve all policies or a single policy.

The response identifies all of the policies available for commissioning. Within this response, locate the
policy name Default Policy for 6500 license 1. Record the value of the 'id' parameter.

• Retrieve a license policy

• Update a license policy

Retrieve a license policy

Retrieve a license policy using the commissioning API.

Requirements

Use the value of the 'id' parameter previously retrieved.

Sample request

GET {{MCP_SERVER}}/commissioning/api/v1/policyDefaults/

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 188
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": [
{
"attributes": {
"additionalAttributes": {
"data": {
"license": {
"policy": "DEFAULT",
"protocol": "HTTPS",
"server": {
"port": {
"HTTPS": "7100",
"HTTP": "7200"
}
},
"products": [
{
"productType": "6500",
"isRequired": true,
"overrideLicenseServer": false
},
{
"productType": "waveserver",
"isRequired": true,
"overrideLicenseServer": false
}
]
}
}
},
"type": "License_6500_v1",
"id": "63a120f2-de41-495d-9ba3-46ce8b066d2b"
}
]
}

Update a license policy

Update a license policy using the commissioning API.

Requirements

• Provide the "id" value obtained from retrieve all policies or a single policy.
• Provide values for the defaults parameter obtained from Retrieve a license policy (that is, first GET the
policy data and then provide this data to set protocol, port parameters here under the defaults
parameter).

Sample request

PUT {{MCP_SERVER}}/commissioning/api/v1/policyDefaults/

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 189
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Sample input

{
"data": [
{
"attributes": {
"additionalAttributes": {
"data": {
"license": {
"policy": "DEFAULT",
"protocol": "HTTPS",
"server": {
"port": {
"HTTPS": "7100",
"HTTP": "7200"
}
},
"products": [
{
"productType": "6500",
"isRequired": true,
"overrideLicenseServer": false
},
{
"productType": "waveserver",
"isRequired": true,
"overrideLicenseServer": false
}
]
}
}
},
"type": "License_6500_v1",
"id": "63a120f2-de41-495d-9ba3-46ce8b066d2b"
}
]

Policy management for Waveserver script generation

Manage policies for generation of Waveserver script.

Tasks include:

• Perform Retrieve all policies or a single policy.

The response identifies all policies available for commissioning. Within this response, locate the policy
name Default Policy for Waveserver_v1. Record the value of the 'id' parameter.

• Retrieve a Waveserver policy

• Update a Waveserver policy

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 190
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Retrieve a Waveserver policy

Retrieve a Waveserver policy using the commissioning API.

Requirements

Use the value of the 'id' parameter previously retrieved.

Sample request

GET {{MCP_SERVER}}/commissioning/api/v1/policyDefaults/

Sample response

{
"data": [
{
"attributes": {
"additionalAttributes": {
"data": {
"general": {
"hostNameIsMemberName": true
}
},
"type": "Waveserver_v1",
"id": "63a120f2-de41-495d-9ba3-46ce8b066d2b"
}
]
}

Update a Waveserver policy

Update a Waveserver policy using the commissioning API.

Requirements

• Provide the "id" value obtained from Retrieve all policies or a single policy.
• Provide values for the defaults parameter obtained from Retrieve a Waveserver policy.

Sample request

PUT {{MCP_SERVER}}/commissioning/api/v1/policyDefaults/

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 191
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Sample input

{
"data": [
{
"attributes": {
"additionalAttributes": {
"data": {
"general": {
"hostNameIsMemberName": true
}
},
"type": "Waveserver_v1",
"id": "63a120f2-de41-495d-9ba3-46ce8b066d2b"
}
]

Policy management for NTP provisioning

Manage policies for NTP provisioning.

Tasks include:

• Retrieve the NTP policy identifier. Perform retrieve all policies or a single policy.

The response identifies all of the policies available for commissioning. Within this response, locate the
policy name Default Policy for NTP. Record the value of the 'id' parameter.

• Retrieve NTP policy data

• Update NTP policy data

Retrieve NTP policy data

Retrieve NTP policy data using the commissioning API.

Requirements

Use the value of the 'id' parameter previously retrieved.

Sample request

GET {{MCP_SERVER}}/commissioning/api/v1/policyDefaults/?id=1b312740-d6b7-4aee-8037-
744215515d52

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 192
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": [
{
"attributes": {
"additionalAttributes": {
"data": {
"ntp": {
"authentication": {
"attributes": {
"encryptedKey": "abcd",
"keyId": 1,
"key": "ab",
"fileName": "a"
}
},
"products": [
{
"isRequired": true,
"authentication": {
"md5Auth": false
},
"serverReferences": [
{
"attributeKey": "S1",
"attributeName": "seraddress1"
},
{
"attributeKey": "S2",
"attributeName": "seraddress2"
},
{
"attributeKey": "S3",
"attributeName": "seraddress3"
},
{
"attributeKey": "S4",
"attributeName": "seraddress4"
},
{
"attributeKey": "S5",
"attributeName": "seraddress5"
}
],
"productType": "6500",
"client": {
"attributes": {
"pollingInterval": "60",
"sync": "ACTIVE"
}
}
},
{
"isRequired": true,
"authentication": {
"md5Auth": true
},
"serverReferences": [
{
"attributeKey": "S1",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 193
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"attributeName": "1"
}
],
"productType": "waveserver",
"client": {
"attributes": {
"pollingInterval": "16",
"mode": "polling"
}
}
}
],
"servers": [
{
"key": "S1",
"address": {
"ip": "0.0.0.0"
}
},
{
"key": "S2",
"address": {
"ip": "0.0.0.0"
}
},
{
"key": "S3",
"address": {
"ip": "0.0.0.0"
}
},
{
"key": "S4",
"address": {
"ip": "0.0.0.0"
}
},
{
"key": "S5",
"address": {
"ip": "0.0.0.0"
}
}
]
}
}
}
},
"type": "NTP_Defaults_v1",
"id": "2f42a246-0f78-4cef-a98f-ee4589247e07"
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 194
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Update NTP policy data

Update NTP policy data using the commissioning API.

Requirements

• Provide the "id" value obtained from Retrieve all policies or a single policy.
• Provide values for the defaults parameter obtained from Retrieve NTP policy data (that is, first GET the
policy data and then provide this data to set polling interval and server references here under the
defaults parameter).

Sample request

POST {{MCP_SERVER}}/commissioning/api/v1/policyDefaults/?id=1b312740-d6b7-4aee-8037-
744215515d52

Sample input

{
"data": [
{
"attributes": {
"additionalAttributes": {
"data": {
"ntp": {
"servers": [
{
"key": "S1",
"address": {
"ip": "0.0.0.0"
}
}
],
"authentication": {
"attributes": {
"keyId": 1,
"key": "ab",
"encryptedKey": "abcd",
"fileName": "a"
}
},
"products": [
{
"productType": "6500",
"serverReferences": [
{
"attributeName": "SERVER1",
"attributeKey": "S1"
}
],

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 195
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"isRequired": true,
"client": {
"attributes": {
"pollingInterval": "60",
"sync": "ACTIVE"
}
},
"authentication": {
"md5Auth": false
}
},
{
"productType": "waveserver",
"serverReferences": [
{
"attributeName": "1",
"attributeKey": "S1"
}
],
"isRequired": true,
"client": {
"attributes": {
"pollingInterval": "16",
"mode": "polling"
}
},
"authentication": {
"md5Auth": true
}
}
]
}
}
}
},
"type": "NTP_Defaults_v1",
"id": "07629276-1126-4a21-ab33-990eef8b17d1"
}
]
}

Policy management for RADIUS server provisioning

Manage policies for RADIUS server provisioning.

Tasks include:

• Retrieve the RADIUS policy identifier. Perform Retrieve all policies or a single policy.

The response identifies all of the policies available for commissioning. Within this response, locate the
policy name Default Policy for Radius 1. Record the value of the 'id' parameter.

• Retrieve NTP policy data

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 196
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

• Update NTP policy data

Retrieve RADIUS policy data

Retrieve RADIUS policy data using the commissioning API.

Requirements

Use the value of the 'id' parameter previously retrieved.

Sample request

GET {{MCP_SERVER}}/commissioning/api/v1/policyDefaults/?id=1b312740-d6b7-4aee-8037-
744215515d52

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 197
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": [
{
"attributes": {
"additionalAttributes": {
"data": {
"radius": {
"products": [
{
"isRequired": true,
"radiusServerReferences": [
{
"attributeName": "PRIMARY",
"serverKey": "S1"
},
{
"attributeName": "SECONDARY",
"serverKey": "S2"
}
],
"productType": "6500"
}
],
"servers": [
{
"address": {
"ip": "0.0.0.0",
"port": "1812"
},
"description": "RADIUS server access info in
a centralized store",
"key": "S1",
"name": "RADIUS profile 1"
},
{
"address": {
"ip": "0.0.0.0",
"port": "1812"
},
"description": "RADIUS server access info in
a centralized store",
"key": "S2",
"name": "RADIUS profile 2"
}
]
}
}
}
},
"type": "Radius_Defaults_v1",
"id": "435fc50c-7ada-4f0a-ace2-5c39b7c322ad"
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 198
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Update RADIUS policy data

Update RADIUS policy data using the commissioning API.

Requirements

• Provide the "id" value obtained from Retrieve all policies or a single policy.
• Provide values for the defaults parameter obtained from Retrieve RADIUS policy data (that is, first GET
the policy data and then provide this data to set RADIUS server IPs and assign these RADIUS server
IPs to each product (for example, 6500 or Waveserver) here under the defaults parameter).

Sample request

POST {{MCP_SERVER}}/commissioning/api/v1/policyDefaults/?id=1b312740-d6b7-4aee-8037-
744215515d52

Sample input

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 199
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": [
{
"attributes": {
"additionalAttributes": {
"data": {
"radius": {
"products": [
{
"isRequired": true,
"radiusServerReferences": [
{
"attributeName": "PRIMARY",
"serverKey": "S1"
},
{
"attributeName": "SECONDARY",
"serverKey": "S2"
}
],
"productType": "6500"
}
],
"servers": [
{
"address": {
"ip": "0.0.0.0",
"port": "1812"
},
"description": "RADIUS server access info in
a centralized store",
"key": "S1",
"name": "RADIUS profile 1"
},
{
"address": {
"ip": "0.0.0.0",
"port": "1812"
},
"description": "RADIUS server access info in
a centralized store",
"key": "S2",
"name": "RADIUS profile 2"
}
]
}
}
}
},
"type": "Radius_Defaults_v1",
"id": "d15cdf4c-c07b-4514-ad36-9936d8ad16db"
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 200
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

IP subnetwork management
Manage an IPv4 or IPv6 subnetwork.

Tasks include:

• Allocate an IP subnetwork
• Retrieve an IP subnetwork
• Delete an IP subnetwork
• Load Reserved Shelf IP Data
• Retrieve Reserved Shelf IP Data
• Delete Reserved Shelf IP Data

Allocate an IP subnetwork

Allocate a IPv4 or IPv6 subnetwork and OspfArea for the shelf of 6500 network elements using the
commissioning API.

Requirements

• Provide the IP value with CIDR.

• Provide the ospfArea.
• Provide the IP6 value with CIDR.
• Provide the ospfAreaV3.
• Provide the type.

IPSubnet creation body

{
"data": {
"attributes": {
"IP": "string",
"ospfArea": "string",
"ospfAreav3": "string",
"IP6": "string"
},
"type": "string"
}
}

Replace the following parameters as required:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 201
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

• [IP] - (string) - a range of IPv4 addresses used to allocate the shelf IPv4 address in commissioning (for
example, 147.23.24.24)
• [IP6] - (string) - a range of IPv6 addresses used to allocate the shelf IPv6 address in commissioning
(for example, 2081::4)
• [CIDR] - (string) - number of IP addresses under the IPSubnet (for example, 22)
• [OspfArea] - (string) – OspfAreaV2 of the IPSubnet (for example, 0.0.0.3)
• [OspfAreaV3] – (string) – OspfAreaV3 of the IPSubnet
• [type] - (string) - an optional parameter. If this parameter is not provided, shelf is the default. Other
possible values for usage include Craft which will be used for craft.

Sample request

POST {{MCP_SERVER}}/commissioning/api/v2/ipsubnet/

Sample response

A response code of 201 indicates successful creation of the IPv4 or IPv6 subnetwork.

Retrieve an IP subnetwork

Retrieve details about an allocated IP subnetwork.

Requirements

Perform Allocate an IP subnetwork.

Sample request

GET {{MCP_SERVER}}/commissioning/api/v2/ipsubnet/

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 202
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": [
{
"attribute": {
"IP": [
"10.183.0.0/22"
"1,2"
],
"ospfArea": "2.0.0.0"
},
"type": "shelf",
"id": "9591f3b2-251f-4e45-9e90-34451f3e7c0"
},
{

"attribute": {
"IP": [
"2081::4/22"
"1,2"
],
"ospfArea": "0.0.0.3"
},
"type": "shelf",
"id": "838a1be9-15b6-42c6-880f-f4bf3a29d304"
}
}
}

Delete an IP subnetwork

Delete an IPv4 or IPv6 subnetwork using the commissioning API.

You can only delete those subnets which do not contain any shelf IP addresses.

Requirements

• Perform Allocate an IP subnetwork.

• Provide the ospfArea value obtained from Retrieve an IP subnetwork.
• Provide the subnetId value obtained from Retrieve an IP subnetwork.

IPSubnet deletion body

{
"subnetId": "[SUBNETID]",
"ospfArea": "[OSPFAREA]"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 203
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Replace the following parameters as required:

• [SUBNETID] - (string) - a unique identifier retrieved from Retrieve an IP subnetwork. For example,
"ccff736d-4e7f-4752-8531-f1b180219f61".
• [OSPFAREA] - (string) - the IP address of the OspfArea to be deleted (for example, 0.0.0.2)

Sample request

DELETE {{MCP_SERVER}}/commissioning/api/v2/ipsubnet/

Sample response

A response code of 200 indicates successful creation of the IP subnetwork.

Load Reserved Shelf IP Data

There are shelves on the network which are already deployed and assigned IPv4 or IPv6 addresses. Use
this API to reserve shelf IPv4 or IPv6 data in commissioning.

• User can reserve shelf IPv4 or IPv6 Network data using REST for 6500 devices in commissioning. To
load the shelves IP data, post a REST request using the underneath URL with the following body:

Sample request

POST{{MCP_SERVER}}/commissioning/api/v2/reservedIP/

Requirements

• Provide shelfNumber.
• Provide projectId if associated with shelf.
• Provide the ospfAreaV3.
• Provide the ospfArea.
• Provide the IP6 value as IPV6.
• Provide the IP value as IPV4.
• Provide tid associated with the NE.
• Provide type value, default is shelf.
• Provide projectName if associated with shelf.

Reserve IP Address body

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 204
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

[
{
"shelfNumber": "string",
"projectId": "string",
"ospfAreaV3": "string",
"ospfArea": "string",
"IP6": "string",
"IP": "string",
"tid": "string",
"type": "string",
"projectName": "string"
}
]

The following parameters need to be substituted into the sample body above:

• [shelfNumber] – (string) – shelf number, for example 1

• [projectId] – (string) – MCP Project Id
• [ospfAreaV3] – (string) – the IP address of the OspfAreaV3
• [ospfArea] - (string) - the IP address of the OspfAreaV2, for example 0.0.0.2
• [IP6] – (string) – reserved IPV6Address of the shelf
• [IP] – (string) – reserved IPV4Address of the shelf
• [tid] – (string) – Target Identifier
• [type] – (string) - Default is shelf
• [projectName] – (string) – MCP Project Name

Sample response

A response code of 200 indicates successful reservation of the IP subnetwork.

Retrieve Reserved Shelf IP Data

To retrieve the reserved Shelf IP data, use the Commissioning API.

Prerequisite:

User should have invoked Load Reserved Shelf IP Data.

Sample request

GET {{MCP_SERVER}}/commissioning/api/v2/reservedIP/?tid=<tid>

Provide the value of the tid parameter in the text box. Tid (Target Identifier) of the deployed shelf with IP
Address.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 205
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Sample response

{
"ospfArea": "0.0.0.3",
"projectName": "",
"projectid": "",
"shelfIP": "2018::1",
"shelfNumber": "1",
"tid": "sidtid1",
"usage": "shelf"
}
{
"ospfArea": "2.0.0.0",
"projectName": "",
"projectid": "",
"shelfIP": "10.183.0.1",
"shelfNumber": "1",
"tid": "sidtid1",
"usage": "shelf"
}

Delete Reserved Shelf IP Data

To delete the Reserved Shelf IP data, use the Commissioning API.

Prerequisite:

User should have invoked Load Reserved Shelf IP Data.

Sample Request

DELETE {{MCP_SERVER}}/commissioning/api/v2/reservedIP/

Request

Reserved shelf IP data deletion body parameter

{
"tid": "[TargetIdentifier]",
"shelfNumber": "[ShelfNumber]"
}

The following parameters need to be substituted into the sample body above:

• [TargetIdentifier] - (string) - Target Identifier of the deployed shelf (e.g. "MALTON")

• [ShelfNumber] - (string) - shelf number (e.g. "3")

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 206
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Sample response

On successful deletion of reserved shelf, the REST HTTP response 200 will be returned.

Policy management for craft launch

Manage policies for network element craft launch.

Requirements

6500 Site Manager software is installed on a known server. For more information about installing 6500
Site Manager, see Blue Planet Installation Guide, 450-3709-201.

Tasks include:

• Retrieve the craft policy

• Update the craft policy to identify the location of the 6500 Site Manager software

Retrieve the craft launch policy

Retrieve the craft launch policy using the commissioning API.

Requirements

Enter Craft_UI_Launch_v1 as the value of the type parameter.

Sample request

GET {{MCP_SERVER}}/commissioning/api/v1/policyDefaults/

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 207
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": [
{
"attributes": {
"additionalAttributes": {
"data": {
"craftLaunch": {
"nodes": [
{
"attributes": {
"server": "Site_Manager_GUI_Server_host_name",
"craftFolder": "sitemanager",
"port": "8443",
"preferredProtocol": "https",
"craftLaunchLabel": "Site manager"
},
"nodeType": "6500"
},
{
"attributes": {
"port": "",
"preferredProtocol": "https",
"craftLaunchLabel": "6200 Node manager"
},
"nodeType": "6200"
}
]
}
}
}
},
"type": "Craft_UI_Launch_v1",
"id": "706d670e-9724-4a02-92bb-7a13957f7496"
}
]
}

Update the craft policy to identify the location of the 6500 Site Manager software

Update the craft launch policy to identify the location of the 6500 Site Manager software using the
commissioning API.

Requirements

• Provide the "id" value obtained from Retrieve the craft policy.
• Using the response from Retrieve the craft policy, replace the value of the 'server' attribute
(nodeType="6500" and craftLaunchLabel="Site manager") with the hostname or IP address of the
server that is hosting the 6500 Site Manager software. In the sample input below,
'Site_Manager_GUI_Server_host_name' has been replaced with hostname 'halifax02'.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 208
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Sample request

PUT {{MCP_SERVER}}/commissioning/api/v1/policyDefaults/

Sample input

{
"data": [
{
"attributes": {
"additionalAttributes": {
"data": {
"craftLaunch": {
"nodes": [
{
"attributes": {
"server": "halifax02",
"craftFolder": "sitemanager",
"port": "8443",
"preferredProtocol": "https",
"craftLaunchLabel": "Site manager"
},
"nodeType": "6500"
},
{
"attributes": {
"port": "",
"preferredProtocol": "https",
"craftLaunchLabel": "6200 Node manager"
},
"nodeType": "6200"
}
]
}
}
}
},
"type": "Craft_UI_Launch_v1",
"id": "706d670e-9724-4a02-92bb-7a13957f7496"
}
]
}

Sample response

A response code of 201 indicates that the craft launch policy was successfully updated.

Generate the commissioning scripts

To generate the commissioning scripts, use the Commissioning API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 209
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Requirements

Before you start, make sure that you have

• committed a fiber route or equipment planning project

• set the following:
◦ IP address
◦ the name
◦ the user data
• created a RADIUS profile to add the primary and secondary RADIUS server details. You do not need to
perform this procedure for each project.
• an active policy for scripts generation and the policy data has been set
• allocated shelf IPv4 subnets
• configured SNMP policy data

Sample request

POST {{MCP_SERVER}}/commissioning/api/v1/scripts/

Provide the value of the projectname parameter in the text box and an Optional Parameter PolicyId of
commissioning policy. The projectname value specifies the project name of the planned network in RPT.

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 210
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"devicetypesURLs": [
{
"deviceType": "6500",
"script": {
"link":
"http://localhost:8080/commissioning/api/v1/scripts/?projectname=GfDeg1&devicetype=
6500"
}
}
],
"projectId": "",
"nodes": [
{
"nodeType": "OADM",
"deviceType": "6500",
"nodeName": "sidtid1",
"script": {
"link":
"http://localhost:8080/commissioning/api/v1/scripts/?projectname=GfDeg1&devicetype=
6500&nodename=sidtid1"
}
},
{
"nodeType": "OADM",
"deviceType": "6500",
"nodeName": "sidtid2",
"script": {
"link":
"http://localhost:8080/commissioning/api/v1/scripts/?projectname=GfDeg1&devicetype=
6500&nodename=sidtid2"
}
}
],
"relatedProjects": [],
"projectName": "GfDeg1"
}
}

Note 1: Above Post Response contains the link to the scripts instead of scripts in earlier version of
commissioning. Copy the contents of the response and save it to a text file with the extension .json.

Note 2: To apply a commissioning script to an NE, follow the procedure for "Commissioning via a script"
in the 6500 Packet Optical Platform Commissioning and Testing, 323-1851-221, Issue 3 or later customer
documentation.

Generate commissioning scripts for a homogeneous

project (6500)
To generate the commissioning scripts, use the Commissioning API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 211
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Requirements

Ensure the following tasks are complete:

• a fiber route or equipment planning project is committed

• set the following attributes:
◦ IP address
◦ name
◦ user data
• you have configured RADIUS policy data to add the primary and secondary RADIUS server details. The
RADIUS policy has been set to active. You do not need to perform this procedure for each project.
• an active policy for scripts generation and the policy data has been set
• allocated shelf IPv4 subnets
• configured SNMP policy data

Sample request

POST {{MCP_SERVER}}/commissioning/api/v1/scripts/

• Provide the value of the projectname parameter in the text box. The value specifies the project name
of the planned network in RPT.
• Provide the value of the policyid to in the text box. The specified policy would be used to generate
commissioning scripts.
• A policy for one of the following policy types can be used to generate scripts for 6500 nodes:
◦ Private_IPV4_v1
◦ Public_IPV4_v1
◦ Public_IPV6_v1
• To create the policy, see Create a policy for script generation of a homogeneous nodes project.

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 212
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"devicetypesURLs": [
{
"deviceType": "6500",
"script": {
"link":
"http://localhost:8080/commissioning/api/v1/scripts/?projectname=AddFbRFDILANTB1&de
vicetype=6500"
}
}
],
"projectId": "",
"nodes": [
{
"nodeType": "OADM",
"deviceType": "6500",
"nodeName": "OTTAWA----9876543210",
"script": {
"link":
"http://localhost:8080/commissioning/api/v1/scripts/?projectname=AddFbRFDILANTB1&de
vicetype=6500&nodename=OTTAWA----9876543210"
}
},
{
"nodeType": "ILA",
"deviceType": "6500",
"nodeName": "MALTON----1472583690",
"script": {
"link":
"http://localhost:8080/commissioning/api/v1/scripts/?projectname=AddFbRFDILANTB1&de
vicetype=6500&nodename=MALTON----1472583690"
}
},
{
"nodeType": "OADM",
"deviceType": "6500",
"nodeName": "DALLAS----0123456789",
"script": {
"link":
"http://localhost:8080/commissioning/api/v1/scripts/?projectname=AddFbRFDILANTB1&de
vicetype=6500&nodename=DALLAS----0123456789"
}
}
],
"relatedProjects": [],
"projectName": "AddFbRFDILANTB1"
}
}

Use the links provided in the response to retrieve the scripts for each node.

Note: To apply a commissioning script to a network element, see "Commissioning via a script" in 6500
Packet Optical Platform Commissioning and Testing, 323-1851-221, Issue 3, or later.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 213
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Generate commissioning scripts for a homogeneous

project (Waveserver)
To generate the commissioning scripts, use the Commissioning API.

Requirements

Ensure the following tasks are complete:

• a fiber route or equipment planning project is committed

• set the following attributes:
◦ IP address
◦ name
◦ user data
• you have configured RADIUS policy data to add the primary and secondary RADIUS server details. The
RADIUS policy has been set to active. You do not need to perform this procedure for each project.
• an active policy for Waveserver scripts generation and the policy data has been set

Sample request

POST {{MCP_SERVER}}/commissioning/api/v1/scripts/

• Provide the value of the projectname parameter in the text box. The value specifies the project name
of the planned network in RPT.
• Provide the value of the policyid to in the text box. The specified policy would be used to generate
commissioning scripts.
• A policy for the following policy type can be used to generate scripts for Waveserver nodes:
Waveserver_v1.
• To create the policy, see Create a policy for script generation of a homogeneous nodes project.

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 214
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"devicetypesURLs": [
{
"deviceType": "WaveserverAi",
"script": {
"link":
"http://localhost:8080/commissioning/api/v1/scripts/?projectname=WS6500Project&devi
cetype=WaveserverAi"
}
}
],
"projectId": "",
"nodes": [
{
"nodeType": "",
"deviceType": "WaveserverAi",
"nodeName": "WS2",
"script": {
"link":
"http://localhost:8080/commissioning/api/v1/scripts/?projectname=WS6500Project&devi
cetype=WaveserverAi&nodename=WS2"
}
},
{
"nodeType": "",
"deviceType": "WaveserverAi",
"nodeName": "WS3",
"script": {
"link":
"http://localhost:8080/commissioning/api/v1/scripts/?projectname=WS6500Project&devi
cetype=WaveserverAi&nodename=WS3"
}
}
],
"relatedProjects": [],
"projectName": "WS6500Project"
}
}

Use the links provided in the response to retrieve the scripts for each node.

Note: To apply a commissioning script to a network element, see "Commissioning via a script" in 6500
Packet Optical Platform Commissioning and Testing, 323-1851-221, Issue 3, or later.

Generate commissioning scripts for a heterogeneous

project (6500 and Waveserver)
To generate the commissioning scripts, use the Commissioning API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 215
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Requirements

Ensure the following tasks are complete:

• a fiber route or equipment planning project is committed

• set the following attributes:
◦ IP address
◦ name
◦ user data
• you have configured RADIUS policy data to add the primary and secondary RADIUS server details. The
RADIUS policy has been set to active. You do not need to perform this procedure for each project.
• Policies data are set for following policy types:
◦ 6500 node policy (Private_IPV4_v1 or Public_IPV4_v1 or Public_IPV6_v1)
◦ Waveserver node policy (Waveserver_v1)
◦ heterogeneous policy (Heterogeneous_v1)
• To create node-specific policy, see Create a policy for script generation of a homogeneous nodes
project.
• To create a heterogeneous policy, see Create a policy for script generation of a heterogeneous nodes
• an active heterogeneous policy for scripts generation and the policy data has been set. In the
heterogeneous policy data, set policyid for:
◦ a 6500 node. Policy type for this can be Private_IPV4_v1 or Public_IPV4_v1 or Public_IPV6_v1
◦ a Waveserver node
• allocated shelf IPv4 subnets
• configured SNMP policy data

Sample request

POST {{MCP_SERVER}}/commissioning/api/v1/scripts/

• Provide the value of the projectname parameter in the text box. The value specifies the project name
of the planned network in RPT.
• Provide the value of the policyid to in the text box. The specified policy would be used to generate
commissioning scripts.
• A policy for the following policy type can be used to generate scripts for a heterogeneous nodes
project: Heterogeneous_v1.

Sample response

{
"data": {
"devicetypesURLs": [
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 216
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"deviceType": "WaveserverAi",
"script": {
"link":
"http://localhost:8080/commissioning/api/v1/scripts/?projectname=WS6500Project&devi
cetype=WaveserverAi"
}
},
{
"deviceType": "6500",
"script": {
"link":
"http://localhost:8080/commissioning/api/v1/scripts/?projectname=WS6500Project&devi
cetype=6500"
}
}
],
"projectId": "",
"nodes": [
{
"nodeType": "OADM",
"deviceType": "6500",
"nodeName": "sidtid1",
"script": {
"link":
"http://localhost:8080/commissioning/api/v1/scripts/?projectname=WS6500Project&devi
cetype=6500&nodename=sidtid1"
}
},
{
"nodeType": "OADM",
"deviceType": "6500",
"nodeName": "sidtid2",
"script": {
"link":
"http://localhost:8080/commissioning/api/v1/scripts/?projectname=WS6500Project&devi
cetype=6500&nodename=sidtid2"
}
},
{
"nodeType": "",
"deviceType": "WaveserverAi",
"nodeName": "WS2",
"script": {
"link":
"http://localhost:8080/commissioning/api/v1/scripts/?projectname=WS6500Project&devi
cetype=WaveserverAi&nodename=WS2"
}
},
{
"nodeType": "",
"deviceType": "WaveserverAi",
"nodeName": "WS3",
"script": {
"link":
"http://localhost:8080/commissioning/api/v1/scripts/?projectname=WS6500Project&devi
cetype=WaveserverAi&nodename=WS3"
}
}
],

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 217
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"relatedProjects": [],
"projectName": "WS6500Project"
}
}

Use the links provided in the response to retrieve the scripts for each node.

Note: To apply a commissioning script to a network element, see "Commissioning via a script" in 6500
Packet Optical Platform Commissioning and Testing, 323-1851-221, Issue 3, or later.

Retrieve the commissioning scripts

To retrieve the commissioning scripts, use the Commissioning API.

Before you retrieve the commissioning scripts, make sure that you Generate the commissioning scripts.

Sample request

GET {{MCP_SERVER}}/commissioning/api/v1/scripts/

Provide the value of the projectname parameter which specifies the project name of the planned network
in RPT in the text box and optional parameters devicetype which specifies the device type planned
network (6500, Waveserver) and nodename in a planned network.

Sample response for 6500

{
"data": {
"projectId": "",
"nodes": [
{
"nodeType": "OADM",
"deviceType": "6500",
"nodeName": "sidtid1",
"shelves": [
{
"shelfId": "1",
"primary": "Enable",
"scripts": [
{
"release": "12.1",
"sequenceId": "1",
"commands": [
{
"commandType": "comment",
"command": "\\\"This TL1 Script was created with Commissioning
MicroService for: { \"DeviceType\":\"6500\", \"NodeType\":\"OADM\",
\"TID\":\"sidtid1\", \"Shelf\": \"1\", \"FIC\": \"fic_NE1_Shelf1\", \"Primary\":

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 218
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

\"Enable\", \"Release\":\"12.1\", \"Timestamp\":\"2018-02-21_11-41-41-862000\",

\"FileName\":\"6500_sidtid1-SHELF-1_1.bch\", \"relatedProjects\":\"\"} \"\\;"
},
{
"commandType": "macro",
"command": "\\\"PROMPT= Please confirm configuring node:
sidtid1, Shelf: 1, FIC: fic_NE1_Shelf1 and Release: 12.1\"\\;"
},
{
"commandType": "tl1",
"command": "SET-SID:GenTID1:SHELF-0:1::\"sidtid1\";"
},
{
"commandType": "tl1",
"command": "ENT-SHELF:sidtid1:SHELF-
1:1:::SITEID=1,SITENAME=\"Site1\",,FIC=\"fic_NE1_Shelf1\",,,,,,,PRIMARY=Enable,TIDC
=Enable,EXTENDEDSHELF=DISABLE,,;"
},
{
"commandType": "macro",
"command": "\\\"Set Current Date and Time\"\\;"
},
{
"commandType": "tl1",
"command": "ED-SYS:sidtid1:SHELF-
1:1:::NEMODE=SONET,PATHSWCRIT=AIS,PTHAISINSERT=AIS&LOP,PATHSDTH=6,PATHEBERTH=4,MINC
OOLING=HIGHFLOW,,,,ETHGFPRFI=USERDEF,ETHGFPRFIUPI=5,PATHPEVSTAT=MAN,LINEPEVSTAT=AUT
O,GCC0MODE=DISABLED,GCC1MODE=DISABLED,NDPMODE=ON,LASEROFFFARENDFAIL=DISABLED,ALMHO=
2.5,BITSMODE=SONET,OSCMODE=DISABLED,ALMCORR=ON,BAYFICINAO=FALSE,,,CSFMCASTMAC=0180C
2880001,,,,,,AINSTIMEOUT=0-5,AINSEQPTTIMEOUT=0-
5,,FIBERLOSSDETECTION=ENABLED,,,SHELFSYNCH=YES,,,,,,,,,AUTOROUTEDEF=DISABLE,CSCTRL=
OFF,ENHEQPTMGMT=DISABLED,ALARMINFO=CLFI&NM,,,DOCAUTODELLOS=YES,TCASUPPRESSION=NO,,A
UTOPROVFAC=ON,AUTOPROVCRS=ON,ETH10GMAPPING=GFPSTD,LFAENABLE=NO,LFARAISETIME=300,LFA
CLEARTIME=300,LFATHRESHOLD=3,,,,,,,,,CTRLMODEDFLT=12.5,DBDFLT=6.25,,;"
},
{
"commandType": "tl1",
"command": "ENT-IP:sidtid1:SHELF-
1:1::20.0.0.1:NETMASK=255.255.255.255,,,,,;"
},
{
"commandType": "tl1",
"command": "ED-AUTOEQUIP:sidtid1:SLOT-1-ALL:1:::MODE=DISABLED;"
},
{
"commandType": "tl1",
"command": "ED-TELNET:sidtid1:SHELF-
1:1:::MAXSESSIONS=3,IDLETIMEOUT=30,SERVER=ENABLED;"
},
{
"commandType": "macro",
"command": "\\\"Delay Time (seconds)= 5\"\\;"
},
{
"commandType": "tl1",
"command": "ED-SSH:sidtid1:SHELF-
1:1:::MAXSESSIONS=18,IDLETIMEOUT=30,SERVER=ENABLED,,,;"
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 219
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"commandType": "tl1",
"command": "ED-HTTP:sidtid1:SHELF-
1:1:::HTTP=OFF,HTTPS=ON,REST=OFF,,;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:sidtid1:FIM-1-
51:1::NTK504CD:,,,,,,,,,,,,,,,,,:IS,;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:sidtid1:SP-1-
42:1::NTK555EA:,,,,,,,,,,,,,,,,,:IS,;"
},
{
"commandType": "tl1",
"command": "ENT-FFP-EQPT:sidtid1:SP-1-41,SP-1-
42:1:::PS=1PLUS1,,,;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:sidtid1:WSSOPM-1-
4:1::NTK553MA:,,,,,,,,,,,,,,,,,:IS,;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:sidtid1:XLA-1-
3:1::NTK552KA:,,,,,,,,,,,,,,,,,:IS,;"
},
{
"commandType": "tl1",
"command": "RMV-AMP:sidtid1:AMP-1-3-8:1::::,;"
},
{
"commandType": "tl1",
"command": "ED-AMP:sidtid1:AMP-1-3-
8:1:::,GAINMODE=High,,,,,TARGGAINTILT=0.0,,,,,,,,TOPOFFSET=0.0,,,REFBW=12.5:,;"
},
{
"commandType": "tl1",
"command": "RST-AMP:sidtid1:AMP-1-3-8:1:;"
},
{
"commandType": "tl1",
"command": "RMV-AMP:sidtid1:AMP-1-3-6:1::::,;"
},
{
"commandType": "tl1",
"command": "ED-AMP:sidtid1:AMP-1-3-
6:1:::,GAINMODE=High,,,,,TARGGAINTILT=0.0,,,,,,,,TOPOFFSET=0.0,,,REFBW=12.5:,;"
},
{
"commandType": "tl1",
"command": "RST-AMP:sidtid1:AMP-1-3-6:1:;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:sidtid1:ESAM-1-
2:1::NTK552JT:,,,,,,,,,,,,,,,,,:IS,;"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 220
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

},
{
"commandType": "tl1",
"command": "ED-ADJ:sidtid1:ADJ-1-2-5:1:::PROVFEADDR=sidtid2-1-
2-8,,ADJTYPE=LINE,,;"
},
{
"commandType": "tl1",
"command": "ED-ADJ-LINE:sidtid1:ADJ-1-2-
5:1:::FIBERTYPE=NDSF,TARGSPANLOSS=3.5,,SPANLOSSMARGIN=0.0,;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:sidtid1:P155M-1-2-
2:1::NTK592NG:,,,,,,,,,,,,,,,,,:IS,;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:sidtid1:CCMD12-1-
1:1::NTK508FA:,,,,,,,,,,,,,,,,,:IS,;"
},
{
"commandType": "tl1",
"command": "RMV-AMP:sidtid1:AMP-1-1-25:1::::,;"
},
{
"commandType": "tl1",
"command": "ED-AMP:sidtid1:AMP-1-1-
25:1:::AMPMODE=Gain,,,TARGGAIN=20,,,,,,,,,,,,,,:,;"
},
{
"commandType": "tl1",
"command": "RST-AMP:sidtid1:AMP-1-1-25:1:;"
},
{
"commandType": "tl1",
"command": "ENT-OSPF-ROUTER:sidtid1:SHELF-
1:1:::ROUTERID=20.0.0.1,,ASBR=OFF,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-OSPF-CIRCUIT:sidtid1:SHELF-
1:1:::NETAREA=2.0.0.0,,,,,,,,,,,,,,,,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-OSPF-CIRCUIT:sidtid1:OSC-1-2-
2:1:::NETAREA=2.0.0.0,,,,,,,,,,,,,,,,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-LAN:sidtid1:COLAN-1-X:1:::,,;"
},
{
"commandType": "tl1",
"command": "ENT-IP:sidtid1:COLAN-1-
X:1::10.186.243.65:NETMASK=255.255.255.224,,,,,;"
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 221
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"commandType": "tl1",
"command": "ENT-OSPF-CIRCUIT:sidtid1:COLAN-1-
X:1:::NETAREA=2.0.0.0,,,,,,,,,,,,,,,,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-GNE:sidtid1:Shelf-1:1::REDUNDANT,OSPF:,,,;"
},
{
"commandType": "tl1",
"command": "SET-ATTR-REMAUTH:sidtid1:SHELF-
1:1::PRIMARY,,:STATE=ENABLE,RADIUS=1.2.3.4,PORT=1812,TO=15,GENSECRET=N,;"
},
{
"commandType": "tl1",
"command": "SET-ATTR-REMAUTH:sidtid1:SHELF-
1:1::SECONDARY,,:STATE=ENABLE,RADIUS=5.6.7.8,PORT=1812,TO=15,GENSECRET=N,;"
},
{
"commandType": "tl1",
"command": "SET-REMAUTH-ALTERNATE:sidtid1:SHELF-1:1::LOCAL;"
},
{
"commandType": "tl1",
"command": "SET-ATTR-CSA:sidtid1:SHELF-
1:1:::,QUERYMODE=ROUND_ROBIN,;"
},
{
"commandType": "tl1",
"command": "ENT-OTS:sidtid1:OTS-1-
1:1:::OSID=D1,TXPATH=1,DOCIND=Y,,CFGTYPE=CHA,SUBTYPE=ROADM,,,,,,,,,OSC=OSC-1-2-
2,,,,,,,,,,,,PROVCTRLMODE=12.5,REFBW=12.5GHZ;"
},
{
"commandType": "tl1",
"command": "ED-TOPO-SLOTSEQ:sidtid1:SLOTSEQ-1-1-1:1:::ADDSEQ=1-
4&1-3&1-2,DROPSEQ=1-2&1-3&1-4,,;"
},
{
"commandType": "tl1",
"command": "ENT-OSRP:sidtid1:OSRP0-1-
1:1:::NODENAME=\"sidtid1\",NODEID=0001,TL1IPADDR=10.186.243.65,TYPE=PROV,UDPPORT=51
001;"
},
{
"commandType": "tl1",
"command": "ED-TOPO-TIDSLOTSEQ:sidtid1:TIDSLOTSEQ-1-51-
1:1:::ADDSEQ=1-4,DROPSEQ=1-4,;"
},
{
"commandType": "tl1",
"command": "ED-TOPO-TIDSLOTSEQ:sidtid1:TIDSLOTSEQ-1-51-
2:1:::ADDSEQ=1-4,DROPSEQ=1-4,;"
},
{
"commandType": "tl1",
"command": "ED-TOPO-TIDSLOTSEQ:sidtid1:TIDSLOTSEQ-1-51-
10:1:::ADDSEQ=1-1,DROPSEQ=1-1,;"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 222
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"commandType": "macro",
"command": "\\\"PROMPT= Successfully completed script. Please
execute the Shelf All script.\"\\;"
}
],
"deviceType": "6500",
"scriptId": "6500_sidtid1-SHELF-1_1.bch"
}
]
}
]
}
],
"relatedProjects": [],
"projectName": "GfDeg1"
}
}
Copy the contents of the response and save it to a text file with the extension
.json.

Sample response for Waveserver

\"This CLI Script was created with Commissioning MicroService for: {"DeviceType":"WaveserverAi",
"NodeType":"", "NodeName":"WS1", "Shelf": "1", "Primary": "Enable", "Release":"1.0", "Timestamp":"2018-02-
21_11-27-27-922000", "FileName":"WS_WS1_1.bch"} "\;

software show

system set member-id 5 site-id 120 host-name WS1 group-id 10 member-name WS1

configuration save

dhcp client disable

interface set interface local ip 10.12.24.24/255.255.255.0

interface set gateway 10.12.24.0

configuration save

ntp client set polling-interval 16

ntp client set mode polling

ntp client add server 0.0.0.0:1

ntp client enable server 0.0.0.0:1

configuration save

Copy the contents of the response and save it to a text file with the extension .txt.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 223
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Note: To apply a commissioning script to an 6500 NE, follow the procedure for "Commissioning via a
script" in the 6500 Packet Optical Platform Commissioning and Testing, 323-1851-221, Issue 3 or later
customer documentation. If Network Element name changes after generating the scripts, Scripts will be
deleted as part of name change events. User will have to re-generate the scripts.

Note: To apply a commissioning script to an NE, follow the procedure for "Commissioning via a script" in
the 6500 Packet Optical Platform Commissioning and Testing, 323-1851-221, Issue 3 or later customer
documentation.

Retrieve commissioning scripts for a homogeneous

project (6500)
To retrieve the commissioning scripts, use the Commissioning API.

Requirements

Before you retrieve the commissioning scripts, ensure that you Generate commissioning scripts for a
homogeneous project only consisting of 6500 nodes.

Note: You can also retrieve scripts using links provided for each node in the response from Generate
commissioning scripts for a homogeneous project only consisting of 6500 nodes.

Sample request

GET {{MCP_SERVER}}/commissioning/api/v1/scripts/

Provide the value of the projectname parameter in the text box. Its value specifies the project name of the
planned network in RPT.

Sample response

{
"data": {
"projectId": "",
"nodes": [
{
"nodeType": "OADM",
"deviceType": "6500",
"nodeName": "OTTAWA----9876543210",
"shelves": [
{
"shelfId": "11",
"primary": "Enable",
"scripts": [
{
"release": "11.5",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 224
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"sequenceId": "1",
"commands": [
{
"commandType": "comment",
"command": "\\\"This TL1 Script was created with Commissioning
MicroService for: { \"DeviceType\":\"6500\", \"NodeType\":\"OADM\",
\"TID\":\"OTTAWA----9876543210\", \"Shelf\": \"11\", \"FIC\": \"OMED_2180\",
\"Primary\": \"Enable\", \"Release\":\"11.5\", \"Timestamp\":\"2017-11-29_12-30-13-
043000\", \"FileName\":\"6500_OTTAWA----9876543210-SHELF-11_1.bch\",
\"relatedProjects\":\"\"} \"\\;"
},
{
"commandType": "macro",
"command": "\\\"PROMPT= Please confirm configuring node:
OTTAWA----9876543210, Bay: 1, Shelf: 1, FIC: OMED_2180 and Release: 11.5\"\\;"
},
{
"commandType": "tl1",
"command": "SET-SID:GenTID1:SHELF-0:1::\"\"OTTAWA----
9876543210\"\";"
},
{
"commandType": "tl1",
"command": "ENT-SHELF:OTTAWA----9876543210:SHELF-
11:1:::SITEID=1968,SITENAME=\"OTWAON080MD2\",,FIC=\"OMED_2180\",BAYNUM=1,PHYSSHELF=
1,LOCATION=\"-94.8559042, 36.8203525\",SUBNETNAME=\"DCN-1234-DLLS-
OTWA\",,,PRIMARY=Enable,TIDC=Enable,EXTENDEDSHELF=ENABLE,,;"
},
{
"commandType": "tl1",
"command": "SET-CLLI:OTTAWA----9876543210::1::\"OTWAON080MD\";"
},
{
"commandType": "macro",
"command": "\\\"Set Current Date and Time\"\\;"
},
{
"commandType": "tl1",
"command": "SET-NODE-TYPE:OTTAWA----9876543210::1::OADM;"
},
{
"commandType": "tl1",
"command": "ED-SYS:OTTAWA----9876543210:SHELF-
11:1:::NEMODE=SONET,,,,,,,,PROVCURRENT=3x60,,,,,GCC0MODE=DISABLED,GCC1MODE=DISABLED
,,,ALMHO=0,,OSCMODE=Disabled,ALMCORR=ON,BAYFICINAO=True,,,,,,,,,AINSTIMEOUT=24-
00,,,,,,,,,,,,,AUTOROUTEDEF=DISABLE,,ENHEQPTMGMT=ENABLED,ALARMINFO=CRDTYP&WVLNGTH&F
IC&SBNTNM&PHYSSHLF&BYNMBR&CLFI,,,DOCAUTODELLOS=YES,TCASUPPRESSION=Yes,,AUTOPROVFAC=
ON,AUTOPROVCRS=ON,ETH10GMAPPING=GFPMACOSTR,,,,,,,,,,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-IP:OTTAWA----9876543210:SHELF-
11:1::20.0.0.1:NETMASK=255.255.255.255,,,,,;"
},
{
"commandType": "tl1",
"command": "ED-AUTOEQUIP:OTTAWA----9876543210:SLOT-11-
ALL:1:::MODE=DISABLED;"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 225
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"commandType": "tl1",
"command": "ED-TELNET:OTTAWA----9876543210:SHELF-
11:1:::MAXSESSIONS=3,IDLETIMEOUT=30,SERVER=ENABLED;"
},
{
"commandType": "macro",
"command": "\\\"Delay Time (seconds)= 5\"\\;"
},
{
"commandType": "tl1",
"command": "ED-SSH:OTTAWA----9876543210:SHELF-
11:1:::MAXSESSIONS=18,,SERVER=ENABLED,,;"
},
{
"commandType": "tl1",
"command": "ED-HTTP:OTTAWA----9876543210:SHELF-
11:1:::HTTP=OFF,,REST=OFF,;"
},
{
"commandType": "tl1",
"command": "ED-SLDD:OTTAWA----9876543210:SHELF-
11:1:::ADMINSTATE=ON,,;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:OTTAWA----9876543210:FIM-11-
51:1::NTK504CC:,,,,,,,,,,,,,,,,,:IS,;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:OTTAWA----9876543210:SP-11-
42:1::NTK555FA:,,,,,,,,,,,,,,,,,:OOS-MA,;"
},
{
"commandType": "tl1",
"command": "RST-EQPT:OTTAWA----9876543210:SP-11-42:1;"
},
{
"commandType": "tl1",
"command": "ENT-FFP-EQPT:OTTAWA----9876543210:SP-11-41,SP-11-
42:1:::PS=1PLUS1,,,;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:OTTAWA----9876543210:CCMD12-11-
31:1::NTK508FA:,,,,,,,,,,,,,,,,,:OOS-MA,;"
},
{
"commandType": "tl1",
"command": "RST-EQPT:OTTAWA----9876543210:CCMD12-11-31:1;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:OTTAWA----9876543210:CCMD12-11-
21:1::NTK508FA:,,,,,,,,,,,,,,,,,:IS,;"
},
{
"commandType": "tl1",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 226
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"command": "RMV-AMP:OTTAWA----9876543210:AMP-11-21-25:1::::,;"
},
{
"commandType": "tl1",
"command": "ED-AMP:OTTAWA----9876543210:AMP-11-21-
25:1:::AMPMODE=Gain,,,TARGGAIN=20,,,,,,,,,,,,,:,;"
},
{
"commandType": "tl1",
"command": "RST-AMP:OTTAWA----9876543210:AMP-11-21-25:1:;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:OTTAWA----9876543210:SMD-11-
14:1::NTK553GC:,,,,,,,,,,,,,,,,,:OOS-MA,;"
},
{
"commandType": "tl1",
"command": "RST-EQPT:OTTAWA----9876543210:SMD-11-14:1;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:OTTAWA----9876543210:XLA-11-
13:1::NTK552KA:,,,,,,,,,,,,,,,,,:OOS-MA,;"
},
{
"commandType": "tl1",
"command": "RST-EQPT:OTTAWA----9876543210:XLA-11-13:1;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:OTTAWA----9876543210:SMD-11-
11:1::NTK553GC:,,,,,,,,,,,,,,,,,:IS,;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:OTTAWA----9876543210:WSSOPM-11-
7:1::NTK553MA:,,,,,,,,,,,,,,,,,:OOS-MA,;"
},
{
"commandType": "tl1",
"command": "RST-EQPT:OTTAWA----9876543210:WSSOPM-11-7:1;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:OTTAWA----9876543210:SAM-11-
6:1::NTK552JN:,,,,,,,,,,,,,,,,,:OOS-MA,;"
},
{
"commandType": "tl1",
"command": "RST-EQPT:OTTAWA----9876543210:SAM-11-6:1;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:OTTAWA----9876543210:P155M-11-6-
2:1::NTK592NG:,,,,,,,,,,,,,,,,,:OOS-MA,;"
},
{
"commandType": "tl1",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 227
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"command": "RST-EQPT:OTTAWA----9876543210:P155M-11-6-2:1;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:OTTAWA----9876543210:WSSOPM-11-
4:1::NTK553MA:,,,,,,,,,,,,,,,,,:IS,;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:OTTAWA----9876543210:XLA-11-
2:1::NTK552KA:,,,,,,,,,,,,,,,,,:IS,;"
},
{
"commandType": "tl1",
"command": "RMV-AMP:OTTAWA----9876543210:AMP-11-2-8:1::::,;"
},
{
"commandType": "tl1",
"command": "ED-AMP:OTTAWA----9876543210:AMP-11-2-
8:1:::,GAINMODE=High,,,,TARGPKPOW=2.6,TARGGAINTILT=-0.4,,,,,,,,TOPOFFSET=-0.6,,:,;"
},
{
"commandType": "tl1",
"command": "RST-AMP:OTTAWA----9876543210:AMP-11-2-8:1:;"
},
{
"commandType": "tl1",
"command": "RMV-AMP:OTTAWA----9876543210:AMP-11-2-6:1::::,;"
},
{
"commandType": "tl1",
"command": "ED-AMP:OTTAWA----9876543210:AMP-11-2-
6:1:::,GAINMODE=High,,,,TARGPKPOW=2.3,TARGGAINTILT=-0.4,,,,,,,,TOPOFFSET=-0.9,,:,;"
},
{
"commandType": "tl1",
"command": "RST-AMP:OTTAWA----9876543210:AMP-11-2-6:1:;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:OTTAWA----9876543210:SAM-11-
1:1::NTK552JN:,,,,,,,,,,,,,,,,,:IS,;"
},
{
"commandType": "tl1",
"command": "ED-ADJ:OTTAWA----9876543210:ADJ-11-1-
5:1:::PROVFEADDR=\"MALTON----1472583690-0-4-8\",,ADJTYPE=LINE,,;"
},
{
"commandType": "tl1",
"command": "ED-ADJ-LINE:OTTAWA----9876543210:ADJ-11-1-
5:1:::FIBERTYPE=NDSF,TARGSPANLOSS=19.0,,SPANLOSSMARGIN=1.0,;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:OTTAWA----9876543210:P155M-11-1-
2:1::NTK592NG:,,,,,,,,,,,,,,,,,:IS,;"
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 228
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"commandType": "tl1",
"command": "ENT-OSPF-ROUTER:OTTAWA----9876543210:SHELF-
11:1:::ROUTERID=20.0.0.1,,ASBR=ON,,;"
},
{
"commandType": "tl1",
"command": "ENT-OSPF-CIRCUIT:OTTAWA----9876543210:SHELF-
11:1:::NETAREA=92.0.0.0,,,,,,,,,,,,,,,,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-OSPF-CIRCUIT:OTTAWA----9876543210:OSC-11-1-
2:1:::NETAREA=92.0.0.0,,,,,,,,,,,,,,,,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-LAN:OTTAWA----9876543210:COLAN-11-X:1:::;"
},
{
"commandType": "tl1",
"command": "ENT-IP:OTTAWA----9876543210:COLAN-11-
X:1::47.134.24.168:NETMASK=255.255.252.0,,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-IPSTATICRT:OTTAWA----9876543210:SHELF-
11:1:::IPADDR=0.0.0.0,NETMASK=0.0.0.0,CIRCUIT=COLAN-11-
X,,NEXTHOP=47.134.24.1,COST=5,;"
},
{
"commandType": "tl1",
"command": "ENT-GNE:OTTAWA----9876543210:Shelf-
11:1::REDUNDANT,PRIVATEIP:,,SUBNETNAME=\"DCN-1234-DLLS-OTWA\",;"
},
{
"commandType": "tl1",
"command": "ENT-IISIS-ROUTER:OTTAWA----9876543210:SHELF-
11:1:::,,,;"
},
{
"commandType": "tl1",
"command": "ENT-LAN:OTTAWA----9876543210:ILAN-11-IN:1:::;"
},
{
"commandType": "tl1",
"command": "ENT-IP:OTTAWA----9876543210:ILAN-11-
IN:1::0.0.0.0:NETMASK=255.255.255.255,,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-IISIS-CIRCUIT:OTTAWA----9876543210:ILAN-11-
IN:1:::,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-LAN:OTTAWA----9876543210:ILAN-11-OUT:1:::;"
},
{
"commandType": "tl1",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 229
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"command": "ENT-IP:OTTAWA----9876543210:ILAN-11-
OUT:1::0.0.0.0:NETMASK=255.255.255.255,,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-IISIS-CIRCUIT:OTTAWA----9876543210:ILAN-11-
OUT:1:::,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-IISIS-CIRCUIT:OTTAWA----9876543210:SHELF-
11:1:::,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-OSPF-RDENTRY:OTTAWA----9876543210:SHELF-
11:1:::IPADDR=20.0.0.0,NETMASK=255.255.255.255,METRIC=500,METRICTYPE=INTERNAL,LEAKL
ISTID=ISISRDLIST;"
},
{
"commandType": "tl1",
"command": "ENT-IISIS-RDENTRY:OTTAWA----9876543210:SHELF-
11:1:::IPADDR=20.0.4.0,NETMASK=255.255.255.255,METRIC=50,METRICTYPE=EXTERNAL,LEAKLI
STID=OSPFRDLIST;"
},
{
"commandType": "tl1",
"command": "ENT-OSPF-RDENTRY:OTTAWA----9876543210:SHELF-
11:1:::IPADDR=0.0.0.0,NETMASK=0.0.0.0,METRIC=500,METRICTYPE=INTERNAL,LEAKLISTID=STA
TICRDLIST;"
},
{
"commandType": "tl1",
"command": "ENT-IISIS-RDENTRY:OTTAWA----9876543210:SHELF-
11:1:::IPADDR=0.0.0.0,NETMASK=0.0.0.0,METRIC=50,METRICTYPE=EXTERNAL,LEAKLISTID=STAT
ICRDLIST;"
},
{
"commandType": "tl1",
"command": "ENT-OTS:OTTAWA----9876543210:OTS-11-
1:1:::OSID=\"E2A9EVHF\",TXPATH=4,DOCIND=Y,,CFGTYPE=CHA,SUBTYPE=ROADM,,,,,,,,,,,,,,,
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,;"
},
{
"commandType": "tl1",
"command": "ED-TOPO-SLOTSEQ:OTTAWA----9876543210:SLOTSEQ-11-1-
1:1:::ADDSEQ=11-4&11-2&11-1,DROPSEQ=11-1&11-2&11-4,,;"
},
{
"commandType": "tl1",
"command": "ENT-NE-LIST:OTTAWA----9876543210:SHELF-
11:1:::RNETID=\"MALTON----1472583690\",,;"
},
{
"commandType": "tl1",
"command": "ENT-NE-LIST:OTTAWA----9876543210:SHELF-
11:1:::RNETID=\"DALLAS----0123456789\",GNE=Yes,GNEIPADDR=47.134.24.180;"
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 230
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"commandType": "tl1",
"command": "SET-ATTR-REMAUTH:OTTAWA----9876543210:SHELF-
11:1::PRIMARY,,:STATE=ENABLE,RADIUS=10.10.100.1,PORT=1812,TO=15,GENSECRET=N,;"
},
{
"commandType": "tl1",
"command": "SET-ATTR-REMAUTH:OTTAWA----9876543210:SHELF-
11:1::SECONDARY,,:STATE=ENABLE,RADIUS=10.20.200.2,PORT=1812,TO=15,GENSECRET=N,;"
},
{
"commandType": "tl1",
"command": "SET-REMAUTH-ALTERNATE:OTTAWA----9876543210:SHELF-
11:1::LOCAL;"
},
{
"commandType": "tl1",
"command": "SET-ATTR-CSA:OTTAWA----9876543210:SHELF-
11:1:::AUTHSTATE=DISABLE,QUERYMODE=ROUND_ROBIN,;"
},
{
"commandType": "tl1",
"command": "ED-TOPO-TIDSLOTSEQ:OTTAWA----9876543210:TIDSLOTSEQ-
11-51-1:1:::ADDSEQ=11-4,DROPSEQ=11-4,;"
},
{
"commandType": "tl1",
"command": "ED-TOPO-TIDSLOTSEQ:OTTAWA----9876543210:TIDSLOTSEQ-
11-51-2:1:::ADDSEQ=11-4,DROPSEQ=11-4,;"
},
{
"commandType": "tl1",
"command": "ED-TOPO-TIDSLOTSEQ:OTTAWA----9876543210:TIDSLOTSEQ-
11-51-3:1:::ADDSEQ=11-4,DROPSEQ=11-4,;"
},
{
"commandType": "tl1",
"command": "ED-TOPO-TIDSLOTSEQ:OTTAWA----9876543210:TIDSLOTSEQ-
11-51-4:1:::ADDSEQ=11-4,DROPSEQ=11-4,;"
},
{
"commandType": "tl1",
"command": "ED-TOPO-TIDSLOTSEQ:OTTAWA----9876543210:TIDSLOTSEQ-
11-51-77:1:::ADDSEQ=11-11,DROPSEQ=11-11,;"
},
{
"commandType": "tl1",
"command": "ED-TOPO-TIDSLOTSEQ:OTTAWA----9876543210:TIDSLOTSEQ-
11-51-78:1:::ADDSEQ=11-11,DROPSEQ=11-11,;"
},
{
"commandType": "tl1",
"command": "ED-TOPO-TIDSLOTSEQ:OTTAWA----9876543210:TIDSLOTSEQ-
11-51-79:1:::ADDSEQ=11-11,DROPSEQ=11-11,;"
},
{
"commandType": "tl1",
"command": "ED-TOPO-TIDSLOTSEQ:OTTAWA----9876543210:TIDSLOTSEQ-
11-51-80:1:::ADDSEQ=11-11,DROPSEQ=11-11,;"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 231
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"commandType": "tl1",
"command": "ED-TOPO-TIDSLOTSEQ:OTTAWA----9876543210:TIDSLOTSEQ-
11-11-6:1:::ADDSEQ=11-21,DROPSEQ=11-21,;"
},
{
"commandType": "tl1",
"command": "ED-IP:OTTAWA----9876543210:LAN-11-
42:1::11.0.0.1:NETMASK=255.255.255.252,,HOSTONLY=OFF,,,;"
},
{
"commandType": "tl1",
"command": "ENT-IISIS-CIRCUIT:OTTAWA----9876543210:LAN-11-
42:1:::,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-OSPF-CIRCUIT:OTTAWA----9876543210:LAN-11-
42:1:::NETAREA=92.0.0.0,,,,,,,,,,,,,,PASSIVE=ON,,,,,;"
},
{
"commandType": "macro",
"command": "\\\"PROMPT= The remaining operation in script 1 is
changing the craft port IP address. The session to the craft port will likely drop
due to the IP address change before a response is received. After clicking \"Ok\"
please wait 30 seconds for the ED-IP command to execute then close the TL1 Command
Builder application and disconnect Site Manager. If this is the last shelf specific
script 1 for this TIDc, please connect your computer to the craft port of the
primary. Reset/renew the IP address on your computer and log back into the primary
and execute the Shelf All script.\"\\;"
},
{
"commandType": "tl1",
"command": "ED-IP:OTTAWA----9876543210:LAN-11-
41:1::11.0.0.5:NETMASK=255.255.255.252,,HOSTONLY=OFF,,,;"
},
{
"commandType": "macro",
"command": "\\\"PROMPT= Successfully completed script 1. Please
reset/renew the IP address on your computer and log back into the primary and
execute the Shelf All script.\"\\;"
}
],
"deviceType": "6500",
"scriptId": "6500_OTTAWA----9876543210-SHELF-11_1.bch"
}
]
},
{
"shelfId": "ALL",
"scripts": [
{
"release": "11.5",
"sequenceId": "1",
"commands": [
{
"commandType": "macro",
"command": "\\\"PROMPT= This is the Shelf: All script for node:
OTTAWA----9876543210. You must be connected to the Primary shelf craft port or via

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 232
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

a DCN port to execute this script. Please confirm script 1 has been executed for
all shelves in this TID. All shelves must have their ILAN cables connected, be
visible and alarm free before executing this script.\"\\;"
},
{
"commandType": "tl1",
"command": "ENT-IISIS-CIRCUIT:OTTAWA----9876543210:LAN-11-
41:1:::,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-OSPF-CIRCUIT:OTTAWA----9876543210:LAN-11-
41:1:::NETAREA=92.0.0.0,,,,,,,,,,,,,,PASSIVE=ON,,,,,;"
},
{
"commandType": "tl1",
"command": "ED-TL1GW:OTTAWA----9876543210:SHELF-
11:1:::GNE=ENABLED,RNE=ENABLED;"
},
{
"commandType": "macro",
"command": "\\\"PROMPT= Successfully completed
commissioning.\"\\;"
}
],
"deviceType": "6500",
"scriptId": "6500_OTTAWA----9876543210-SHELF-ALL_1.bch"
}
]
}
]
},
{
"nodeType": "ILA",
"deviceType": "6500",
"nodeName": "MALTON----1472583690",
"shelves": [
{
"shelfId": "0",
"primary": "Enable",
"scripts": [
{
"release": "11.5",
"sequenceId": "1",
"commands": [
{
"commandType": "comment",
"command": "\\\"This TL1 Script was created with Commissioning
MicroService for: { \"DeviceType\":\"6500\", \"NodeType\":\"ILA\",
\"TID\":\"MALTON----1472583690\", \"Shelf\": \"0\", \"FIC\": \"OME_0322\",
\"Primary\": \"Enable\", \"Release\":\"11.5\", \"Timestamp\":\"2017-11-29_12-30-13-
076000\", \"FileName\":\"6500_MALTON----1472583690-SHELF-0_1.bch\",
\"relatedProjects\":\"\"} \"\\;"
},
{
"commandType": "macro",
"command": "\\\"PROMPT= Please confirm configuring node:
MALTON----1472583690, Bay: 0, Shelf: 0, FIC: OME_0322 and Release: 11.5\"\\;"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 233
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"commandType": "tl1",
"command": "SET-SID:GenTID1:SHELF-0:1::\"\"MALTON----
1472583690\"\";"
},
{
"commandType": "tl1",
"command": "ENT-SHELF:MALTON----1472583690:SHELF-
0:1:::SITEID=14696,SITENAME=\"MALTON22CG13\",,FIC=\"OME_0322\",BAYNUM=0,PHYSSHELF=0
,LOCATION=\"-94.55555, 36.8203525\",SUBNETNAME=\"DCN-1234-DLLS-
OTWA\",,,PRIMARY=Enable,TIDC=Enable,EXTENDEDSHELF=ENABLE,,;"
},
{
"commandType": "tl1",
"command": "SET-CLLI:MALTON----1472583690::1::\"MALTON22CG1\";"
},
{
"commandType": "macro",
"command": "\\\"Set Current Date and Time\"\\;"
},
{
"commandType": "tl1",
"command": "SET-NODE-TYPE:MALTON----1472583690::1::ILA;"
},
{
"commandType": "tl1",
"command": "ED-SYS:MALTON----1472583690:SHELF-
0:1:::NEMODE=SONET,,,,,,,,PROVCURRENT=20,,,,,GCC0MODE=DISABLED,GCC1MODE=DISABLED,,,
ALMHO=0,,OSCMODE=Disabled,ALMCORR=ON,BAYFICINAO=True,,,,,,,,,AINSTIMEOUT=24-
00,,,,,,,,,,,,,AUTOROUTEDEF=DISABLE,,ENHEQPTMGMT=ENABLED,ALARMINFO=CRDTYP&WVLNGTH&F
IC&SBNTNM&PHYSSHLF&BYNMBR&CLFI,,,DOCAUTODELLOS=YES,TCASUPPRESSION=Yes,,AUTOPROVFAC=
ON,AUTOPROVCRS=ON,ETH10GMAPPING=GFPMACOSTR,,,,,,,,,,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-IP:MALTON----1472583690:SHELF-
0:1::192.0.0.1:NETMASK=255.255.255.255,,,,,;"
},
{
"commandType": "tl1",
"command": "ED-AUTOEQUIP:MALTON----1472583690:SLOT-0-
ALL:1:::MODE=DISABLED;"
},
{
"commandType": "tl1",
"command": "ED-TELNET:MALTON----1472583690:SHELF-
0:1:::MAXSESSIONS=3,IDLETIMEOUT=30,SERVER=ENABLED;"
},
{
"commandType": "macro",
"command": "\\\"Delay Time (seconds)= 5\"\\;"
},
{
"commandType": "tl1",
"command": "ED-SSH:MALTON----1472583690:SHELF-
0:1:::MAXSESSIONS=18,,SERVER=ENABLED,,;"
},
{
"commandType": "tl1",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 234
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"command": "ED-HTTP:MALTON----1472583690:SHELF-
0:1:::HTTP=OFF,,REST=OFF,;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:MALTON----1472583690:SP-0-
16:1::NTK555FA:,,,,,,,,,,,,,,,,,:OOS-MA,;"
},
{
"commandType": "tl1",
"command": "RST-EQPT:MALTON----1472583690:SP-0-16:1;"
},
{
"commandType": "tl1",
"command": "ENT-FFP-EQPT:MALTON----1472583690:SP-0-15,SP-0-
16:1:::PS=1PLUS1,,,;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:MALTON----1472583690:XLA-0-
14:1::NTK552KA:,,,,,,,,,,,,,,,,,:OOS-MA,;"
},
{
"commandType": "tl1",
"command": "RST-EQPT:MALTON----1472583690:XLA-0-14:1;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:MALTON----1472583690:SAM-0-
13:1::NTK552JN:,,,,,,,,,,,,,,,,,:OOS-MA,;"
},
{
"commandType": "tl1",
"command": "RST-EQPT:MALTON----1472583690:SAM-0-13:1;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:MALTON----1472583690:P155M-0-13-
2:1::NTK592NG:,,,,,,,,,,,,,,,,,:OOS-MA,;"
},
{
"commandType": "tl1",
"command": "RST-EQPT:MALTON----1472583690:P155M-0-13-2:1;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:MALTON----1472583690:SAM-0-
4:1::NTK552JN:,,,,,,,,,,,,,,,,,:IS,;"
},
{
"commandType": "tl1",
"command": "ED-ADJ:MALTON----1472583690:ADJ-0-4-
5:1:::PROVFEADDR=\"OTTAWA----9876543210-11-1-8\",,ADJTYPE=LINE,,;"
},
{
"commandType": "tl1",
"command": "ED-ADJ-LINE:MALTON----1472583690:ADJ-0-4-
5:1:::FIBERTYPE=NDSF,TARGSPANLOSS=19.0,,SPANLOSSMARGIN=1.0,;"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 235
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"commandType": "tl1",
"command": "ENT-EQPT:MALTON----1472583690:P155M-0-4-
2:1::NTK592NG:,,,,,,,,,,,,,,,,,:IS,;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:MALTON----1472583690:XLA-0-
2:1::NTK552KA:,,,,,,,,,,,,,,,,,:IS,;"
},
{
"commandType": "tl1",
"command": "RMV-AMP:MALTON----1472583690:AMP-0-2-8:1::::,;"
},
{
"commandType": "tl1",
"command": "ED-AMP:MALTON----1472583690:AMP-0-2-
8:1:::,GAINMODE=High,,,,TARGPKPOW=2.3,TARGGAINTILT=-0.4,,,,,,,,TOPOFFSET=-0.9,,:,;"
},
{
"commandType": "tl1",
"command": "RST-AMP:MALTON----1472583690:AMP-0-2-8:1:;"
},
{
"commandType": "tl1",
"command": "RMV-AMP:MALTON----1472583690:AMP-0-2-6:1::::,;"
},
{
"commandType": "tl1",
"command": "ED-AMP:MALTON----1472583690:AMP-0-2-
6:1:::,GAINMODE=High,,,,TARGPKPOW=2.3,TARGGAINTILT=-0.4,,,,,,,,TOPOFFSET=-0.9,,:,;"
},
{
"commandType": "tl1",
"command": "RST-AMP:MALTON----1472583690:AMP-0-2-6:1:;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:MALTON----1472583690:SAM-0-
1:1::NTK552JN:,,,,,,,,,,,,,,,,,:IS,;"
},
{
"commandType": "tl1",
"command": "ED-ADJ:MALTON----1472583690:ADJ-0-1-
5:1:::PROVFEADDR=\"DALLAS----0123456789-11-1-8\",,ADJTYPE=LINE,,;"
},
{
"commandType": "tl1",
"command": "ED-ADJ-LINE:MALTON----1472583690:ADJ-0-1-
5:1:::FIBERTYPE=NDSF,TARGSPANLOSS=19.0,,SPANLOSSMARGIN=1.0,;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:MALTON----1472583690:P155M-0-1-
2:1::NTK592NG:,,,,,,,,,,,,,,,,,:IS,;"
},
{
"commandType": "tl1",
"command": "ENT-OSPF-ROUTER:MALTON----1472583690:SHELF-

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 236
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

0:1:::ROUTERID=192.0.0.1,,ASBR=ON,,;"
},
{
"commandType": "tl1",
"command": "ENT-OSPF-CIRCUIT:MALTON----1472583690:SHELF-
0:1:::NETAREA=92.0.0.0,,,,,,,,,,,,,,,,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-OSPF-CIRCUIT:MALTON----1472583690:OSC-0-4-
2:1:::NETAREA=92.0.0.0,,,,,,,,,,,,,,,,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-OSPF-CIRCUIT:MALTON----1472583690:OSC-0-1-
2:1:::NETAREA=92.0.0.0,,,,,,,,,,,,,,,,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-OTS:MALTON----1472583690:OTS-0-
1:1:::OSID=\"E2A9EVHF\",TXPATH=2,DOCIND=N,,CFGTYPE=AMP,SUBTYPE=AMP,,,,,,,,,,,,,,,,,
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,AMPMATE=OTS-0-2,,,,,,,,,;"
},
{
"commandType": "tl1",
"command": "ED-TOPO-SLOTSEQ:MALTON----1472583690:SLOTSEQ-0-2-
1:1:::ADDSEQ=0-4,DROPSEQ=0-4,,;"
},
{
"commandType": "tl1",
"command": "ED-TOPO-SLOTSEQ:MALTON----1472583690:SLOTSEQ-0-1-
1:1:::ADDSEQ=0-2&0-1,DROPSEQ=0-1&0-2,,;"
},
{
"commandType": "tl1",
"command": "SET-ATTR-REMAUTH:MALTON----1472583690:SHELF-
0:1::PRIMARY,,:STATE=ENABLE,RADIUS=20.0.0.1,PORT=1812,TO=30,GENSECRET=Y,;"
},
{
"commandType": "tl1",
"command": "SET-ATTR-REMAUTH:MALTON----1472583690:SHELF-
0:1::SECONDARY,,:STATE=ENABLE,RADIUS=20.0.4.1,PORT=1812,TO=30,GENSECRET=Y,;"
},
{
"commandType": "tl1",
"command": "SET-REMAUTH-ALTERNATE:MALTON----1472583690:SHELF-
0:1::LOCAL;"
},
{
"commandType": "tl1",
"command": "SET-ATTR-CSA:MALTON----1472583690:SHELF-
0:1:::AUTHSTATE=DISABLE,QUERYMODE=ROUND_ROBIN,;"
},
{
"commandType": "tl1",
"command": "ED-IP:MALTON----1472583690:LAN-0-
16:1::11.0.0.13:NETMASK=255.255.255.252,,HOSTONLY=OFF,,,;"
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 237
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"commandType": "tl1",
"command": "ENT-OSPF-CIRCUIT:MALTON----1472583690:LAN-0-
16:1:::NETAREA=92.0.0.0,,,,,,,,,,,,,,PASSIVE=ON,,,,,;"
},
{
"commandType": "macro",
"command": "\\\"PROMPT= The remaining operation in script 1 is
changing the craft port IP address. The session to the craft port will likely drop
due to the IP address change before a response is received. After clicking \"Ok\"
please wait 30 seconds for the ED-IP command to execute then close the TL1 Command
Builder application and disconnect Site Manager. If this is the last shelf specific
script 1 for this TIDc, please connect your computer to the craft port of the
primary. Reset/renew the IP address on your computer and log back into the primary
and execute the Shelf All script.\"\\;"
},
{
"commandType": "tl1",
"command": "ED-IP:MALTON----1472583690:LAN-0-
15:1::11.0.0.9:NETMASK=255.255.255.252,,HOSTONLY=OFF,,,;"
},
{
"commandType": "macro",
"command": "\\\"PROMPT= Successfully completed script 1. Please
reset/renew the IP address on your computer and log back into the primary and
execute the Shelf All script.\"\\;"
}
],
"deviceType": "6500",
"scriptId": "6500_MALTON----1472583690-SHELF-0_1.bch"
}
]
},
{
"shelfId": "ALL",
"scripts": [
{
"release": "11.5",
"sequenceId": "1",
"commands": [
{
"commandType": "macro",
"command": "\\\"PROMPT= This is the Shelf: All script for node:
MALTON----1472583690. You must be connected to the Primary shelf craft port or via
a DCN port to execute this script. Please confirm script 1 has been executed for
all shelves in this TID. All shelves must have their ILAN cables connected, be
visible and alarm free before executing this script.\"\\;"
},
{
"commandType": "tl1",
"command": "ENT-OSPF-CIRCUIT:MALTON----1472583690:LAN-0-
15:1:::NETAREA=92.0.0.0,,,,,,,,,,,,,,PASSIVE=ON,,,,,;"
},
{
"commandType": "tl1",
"command": "ED-TL1GW:MALTON----1472583690:SHELF-
0:1:::GNE=ENABLED,RNE=ENABLED;"
},
{
"commandType": "macro",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 238
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"command": "\\\"PROMPT= Successfully completed

commissioning.\"\\;"
}
],
"deviceType": "6500",
"scriptId": "6500_MALTON----1472583690-SHELF-ALL_1.bch"
}
]
}
]
},
{
"nodeType": "OADM",
"deviceType": "6500",
"nodeName": "DALLAS----0123456789",
"shelves": [
{
"shelfId": "11",
"primary": "Enable",
"scripts": [
{
"release": "11.5",
"sequenceId": "1",
"commands": [
{
"commandType": "comment",
"command": "\\\"This TL1 Script was created with Commissioning
MicroService for: { \"DeviceType\":\"6500\", \"NodeType\":\"OADM\",
\"TID\":\"DALLAS----0123456789\", \"Shelf\": \"11\", \"FIC\": \"OMED_2181\",
\"Primary\": \"Enable\", \"Release\":\"11.5\", \"Timestamp\":\"2017-11-29_12-30-13-
095000\", \"FileName\":\"6500_DALLAS----0123456789-SHELF-11_1.bch\",
\"relatedProjects\":\"\"} \"\\;"
},
{
"commandType": "macro",
"command": "\\\"PROMPT= Please confirm configuring node:
DALLAS----0123456789, Bay: 1, Shelf: 1, FIC: OMED_2181 and Release: 11.5\"\\;"
},
{
"commandType": "tl1",
"command": "SET-SID:GenTID1:SHELF-0:1::\"\"DALLAS----
0123456789\"\";"
},
{
"commandType": "tl1",
"command": "ENT-SHELF:DALLAS----0123456789:SHELF-
11:1:::SITEID=37329,SITENAME=\"DLLSTXRNDS11\",,FIC=\"OMED_2181\",BAYNUM=1,PHYSSHELF
=1,LOCATION=\"-94.0333333, 36.8203525\",SUBNETNAME=\"DCN-1234-DLLS-
OTWA\",,,PRIMARY=Enable,TIDC=Enable,EXTENDEDSHELF=ENABLE,,;"
},
{
"commandType": "tl1",
"command": "SET-CLLI:DALLAS----0123456789::1::\"DLLSTXRNDS1\";"
},
{
"commandType": "macro",
"command": "\\\"Set Current Date and Time\"\\;"
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 239
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"commandType": "tl1",
"command": "SET-NODE-TYPE:DALLAS----0123456789::1::OADM;"
},
{
"commandType": "tl1",
"command": "ED-SYS:DALLAS----0123456789:SHELF-
11:1:::NEMODE=SONET,,,,,,,,PROVCURRENT=3x60,,,,,GCC0MODE=DISABLED,GCC1MODE=DISABLED
,,,ALMHO=0,,OSCMODE=Disabled,ALMCORR=ON,BAYFICINAO=True,,,,,,,,,AINSTIMEOUT=24-
00,,,,,,,,,,,,,AUTOROUTEDEF=DISABLE,,ENHEQPTMGMT=ENABLED,ALARMINFO=CRDTYP&WVLNGTH&F
IC&SBNTNM&PHYSSHLF&BYNMBR&CLFI,,,DOCAUTODELLOS=YES,TCASUPPRESSION=Yes,,AUTOPROVFAC=
ON,AUTOPROVCRS=ON,ETH10GMAPPING=GFPMACOSTR,,,,,,,,,,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-IP:DALLAS----0123456789:SHELF-
11:1::20.0.4.1:NETMASK=255.255.255.255,,,,,;"
},
{
"commandType": "tl1",
"command": "ED-AUTOEQUIP:DALLAS----0123456789:SLOT-11-
ALL:1:::MODE=DISABLED;"
},
{
"commandType": "tl1",
"command": "ED-TELNET:DALLAS----0123456789:SHELF-
11:1:::MAXSESSIONS=3,IDLETIMEOUT=30,SERVER=ENABLED;"
},
{
"commandType": "macro",
"command": "\\\"Delay Time (seconds)= 5\"\\;"
},
{
"commandType": "tl1",
"command": "ED-SSH:DALLAS----0123456789:SHELF-
11:1:::MAXSESSIONS=18,,SERVER=ENABLED,,;"
},
{
"commandType": "tl1",
"command": "ED-HTTP:DALLAS----0123456789:SHELF-
11:1:::HTTP=OFF,,REST=OFF,;"
},
{
"commandType": "tl1",
"command": "ED-SLDD:DALLAS----0123456789:SHELF-
11:1:::ADMINSTATE=ON,,;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:DALLAS----0123456789:SP-11-
42:1::NTK555FA:,,,,,,,,,,,,,,,,,:OOS-MA,;"
},
{
"commandType": "tl1",
"command": "RST-EQPT:DALLAS----0123456789:SP-11-42:1;"
},
{
"commandType": "tl1",
"command": "ENT-FFP-EQPT:DALLAS----0123456789:SP-11-41,SP-11-
42:1:::PS=1PLUS1,,,;"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 240
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

},
{
"commandType": "tl1",
"command": "ENT-EQPT:DALLAS----0123456789:CCMD12-11-
31:1::NTK508FA:,,,,,,,,,,,,,,,,,:OOS-MA,;"
},
{
"commandType": "tl1",
"command": "RST-EQPT:DALLAS----0123456789:CCMD12-11-31:1;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:DALLAS----0123456789:CCMD12-11-
21:1::NTK508FA:,,,,,,,,,,,,,,,,,:IS,;"
},
{
"commandType": "tl1",
"command": "RMV-AMP:DALLAS----0123456789:AMP-11-21-25:1::::,;"
},
{
"commandType": "tl1",
"command": "ED-AMP:DALLAS----0123456789:AMP-11-21-
25:1:::AMPMODE=Gain,,,TARGGAIN=20,,,,,,,,,,,,,:,;"
},
{
"commandType": "tl1",
"command": "RST-AMP:DALLAS----0123456789:AMP-11-21-25:1:;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:DALLAS----0123456789:SMD-11-
17:1::NTK553GB:,,,,,,,,,,,,,,,,,:OOS-MA,;"
},
{
"commandType": "tl1",
"command": "RST-EQPT:DALLAS----0123456789:SMD-11-17:1;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:DALLAS----0123456789:XLA-11-
16:1::NTK552KA:,,,,,,,,,,,,,,,,,:OOS-MA,;"
},
{
"commandType": "tl1",
"command": "RST-EQPT:DALLAS----0123456789:XLA-11-16:1;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:DALLAS----0123456789:SMD-11-
14:1::NTK553GB:,,,,,,,,,,,,,,,,,:IS,;"
},
{
"commandType": "tl1",
"command": "ED-ADJ:DALLAS----0123456789:ADJ-11-14-
10:1:::PROVFEADDR=\"DALLAS----0123456789-11-13-8\",,ADJTYPE=LIM,,;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:DALLAS----0123456789:XLA-11-

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 241
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

13:1::NTK552KA:,,,,,,,,,,,,,,,,,:IS,;"
},
{
"commandType": "tl1",
"command": "ED-ADJ:DALLAS----0123456789:ADJ-11-13-
5:1:::PROVFEADDR=\"DALLAS----0123456789-11-14-9\",,ADJTYPE=SMD,,;"
},
{
"commandType": "tl1",
"command": "RMV-AMP:DALLAS----0123456789:AMP-11-13-8:1::::,;"
},
{
"commandType": "tl1",
"command": "ED-AMP:DALLAS----0123456789:AMP-11-13-
8:1:::,GAINMODE=Low,,TARGGAIN=15.0,,,TARGGAINTILT=0.0,,,,,,,,TOPOFFSET=0.0,,:,;"
},
{
"commandType": "tl1",
"command": "RST-AMP:DALLAS----0123456789:AMP-11-13-8:1:;"
},
{
"commandType": "tl1",
"command": "RMV-AMP:DALLAS----0123456789:AMP-11-13-6:1::::,;"
},
{
"commandType": "tl1",
"command": "ED-AMP:DALLAS----0123456789:AMP-11-13-
6:1:::,GAINMODE=High,,TARGGAIN=20.0,,,TARGGAINTILT=0.0,,,,,,,,TOPOFFSET=-4.0,,:,;"
},
{
"commandType": "tl1",
"command": "RST-AMP:DALLAS----0123456789:AMP-11-13-6:1:;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:DALLAS----0123456789:WSSOPM-11-
11:1::NTK553LB:,,,,,,,,,,,,,,,,,:IS,;"
},
{
"commandType": "tl1",
"command": "ED-ADJ:DALLAS----0123456789:ADJ-11-11-
4:1:::PROVFEADDR=\"DALLAS----0123456789-11-4-19\",,ADJTYPE=WSS,,;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:DALLAS----0123456789:WSSOPM-11-
7:1::NTK553LB:,,,,,,,,,,,,,,,,,:OOS-MA,;"
},
{
"commandType": "tl1",
"command": "RST-EQPT:DALLAS----0123456789:WSSOPM-11-7:1;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:DALLAS----0123456789:SAM-11-
6:1::NTK552JN:,,,,,,,,,,,,,,,,,:OOS-MA,;"
},
{
"commandType": "tl1",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 242
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"command": "RST-EQPT:DALLAS----0123456789:SAM-11-6:1;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:DALLAS----0123456789:P155M-11-6-
2:1::NTK592NG:,,,,,,,,,,,,,,,,,:OOS-MA,;"
},
{
"commandType": "tl1",
"command": "RST-EQPT:DALLAS----0123456789:P155M-11-6-2:1;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:DALLAS----0123456789:WSSOPM-11-
4:1::NTK553LB:,,,,,,,,,,,,,,,,,:IS,;"
},
{
"commandType": "tl1",
"command": "ED-ADJ:DALLAS----0123456789:ADJ-11-4-
20:1:::PROVFEADDR=\"DALLAS----0123456789-11-11-3\",,ADJTYPE=WSS,,;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:DALLAS----0123456789:XLA-11-
2:1::NTK552KA:,,,,,,,,,,,,,,,,,:IS,;"
},
{
"commandType": "tl1",
"command": "RMV-AMP:DALLAS----0123456789:AMP-11-2-8:1::::,;"
},
{
"commandType": "tl1",
"command": "ED-AMP:DALLAS----0123456789:AMP-11-2-
8:1:::,GAINMODE=High,,,,TARGPKPOW=2.6,TARGGAINTILT=-0.4,,,,,,,,TOPOFFSET=-0.6,,:,;"
},
{
"commandType": "tl1",
"command": "RST-AMP:DALLAS----0123456789:AMP-11-2-8:1:;"
},
{
"commandType": "tl1",
"command": "RMV-AMP:DALLAS----0123456789:AMP-11-2-6:1::::,;"
},
{
"commandType": "tl1",
"command": "ED-AMP:DALLAS----0123456789:AMP-11-2-
6:1:::,GAINMODE=High,,,,TARGPKPOW=2.3,TARGGAINTILT=-0.4,,,,,,,,TOPOFFSET=-0.9,,:,;"
},
{
"commandType": "tl1",
"command": "RST-AMP:DALLAS----0123456789:AMP-11-2-6:1:;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:DALLAS----0123456789:SAM-11-
1:1::NTK552JN:,,,,,,,,,,,,,,,,,:IS,;"
},
{
"commandType": "tl1",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 243
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"command": "ED-ADJ:DALLAS----0123456789:ADJ-11-1-
5:1:::PROVFEADDR=\"MALTON----1472583690-0-1-8\",,ADJTYPE=LINE,,;"
},
{
"commandType": "tl1",
"command": "ED-ADJ-LINE:DALLAS----0123456789:ADJ-11-1-
5:1:::FIBERTYPE=NDSF,TARGSPANLOSS=19.0,,SPANLOSSMARGIN=1.0,;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:DALLAS----0123456789:P155M-11-1-
2:1::NTK592NG:,,,,,,,,,,,,,,,,,:IS,;"
},
{
"commandType": "tl1",
"command": "ENT-OSPF-ROUTER:DALLAS----0123456789:SHELF-
11:1:::ROUTERID=20.0.4.1,,ASBR=ON,,;"
},
{
"commandType": "tl1",
"command": "ENT-OSPF-CIRCUIT:DALLAS----0123456789:SHELF-
11:1:::NETAREA=92.0.0.0,,,,,,,,,,,,,,,,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-OSPF-CIRCUIT:DALLAS----0123456789:OSC-11-1-
2:1:::NETAREA=92.0.0.0,,,,,,,,,,,,,,,,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-LAN:DALLAS----0123456789:COLAN-11-X:1:::;"
},
{
"commandType": "tl1",
"command": "ENT-IP:DALLAS----0123456789:COLAN-11-
X:1::47.134.24.180:NETMASK=255.255.252.0,,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-IPSTATICRT:DALLAS----0123456789:SHELF-
11:1:::IPADDR=0.0.0.0,NETMASK=0.0.0.0,CIRCUIT=COLAN-11-
X,,NEXTHOP=47.134.24.1,COST=5,;"
},
{
"commandType": "tl1",
"command": "ENT-GNE:DALLAS----0123456789:Shelf-
11:1::REDUNDANT,PRIVATEIP:,,SUBNETNAME=\"DCN-1234-DLLS-OTWA\",;"
},
{
"commandType": "tl1",
"command": "ENT-IISIS-ROUTER:DALLAS----0123456789:SHELF-
11:1:::,,,;"
},
{
"commandType": "tl1",
"command": "ENT-LAN:DALLAS----0123456789:ILAN-11-IN:1:::;"
},
{
"commandType": "tl1",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 244
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"command": "ENT-IP:DALLAS----0123456789:ILAN-11-
IN:1::0.0.0.0:NETMASK=255.255.255.255,,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-IISIS-CIRCUIT:DALLAS----0123456789:ILAN-11-
IN:1:::,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-LAN:DALLAS----0123456789:ILAN-11-OUT:1:::;"
},
{
"commandType": "tl1",
"command": "ENT-IP:DALLAS----0123456789:ILAN-11-
OUT:1::0.0.0.0:NETMASK=255.255.255.255,,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-IISIS-CIRCUIT:DALLAS----0123456789:ILAN-11-
OUT:1:::,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-IISIS-CIRCUIT:DALLAS----0123456789:SHELF-
11:1:::,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-OSPF-RDENTRY:DALLAS----0123456789:SHELF-
11:1:::IPADDR=20.0.4.0,NETMASK=255.255.255.255,METRIC=500,METRICTYPE=INTERNAL,LEAKL
ISTID=ISISRDLIST;"
},
{
"commandType": "tl1",
"command": "ENT-IISIS-RDENTRY:DALLAS----0123456789:SHELF-
11:1:::IPADDR=20.0.0.0,NETMASK=255.255.255.255,METRIC=50,METRICTYPE=EXTERNAL,LEAKLI
STID=OSPFRDLIST;"
},
{
"commandType": "tl1",
"command": "ENT-OSPF-RDENTRY:DALLAS----0123456789:SHELF-
11:1:::IPADDR=0.0.0.0,NETMASK=0.0.0.0,METRIC=500,METRICTYPE=INTERNAL,LEAKLISTID=STA
TICRDLIST;"
},
{
"commandType": "tl1",
"command": "ENT-IISIS-RDENTRY:DALLAS----0123456789:SHELF-
11:1:::IPADDR=0.0.0.0,NETMASK=0.0.0.0,METRIC=50,METRICTYPE=EXTERNAL,LEAKLISTID=STAT
ICRDLIST;"
},
{
"commandType": "tl1",
"command": "ENT-OTS:DALLAS----0123456789:OTS-11-
2:1:::,TXPATH=254,DOCIND=N,,CFGTYPE=CHA,SUBTYPE=DIOADM,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,;"
},
{
"commandType": "tl1",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 245
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"command": "ENT-OTS:DALLAS----0123456789:OTS-11-
3:1:::,TXPATH=252,DOCIND=N,,CFGTYPE=CHA,SUBTYPE=COADM,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-OTS:DALLAS----0123456789:OTS-11-
1:1:::OSID=\"E2A9EVHF\",TXPATH=1,DOCIND=Y,,CFGTYPE=CHA,SUBTYPE=ROADM,,,,,,,,,,,,,,,
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,;"
},
{
"commandType": "tl1",
"command": "ED-TOPO-SLOTSEQ:DALLAS----0123456789:SLOTSEQ-11-2-
1:1:::ADDSEQ=11-13&11-11,DROPSEQ=11-11&11-13,,;"
},
{
"commandType": "tl1",
"command": "ED-TOPO-SLOTSEQ:DALLAS----0123456789:SLOTSEQ-11-3-
1:1:::ADDSEQ=11-14,DROPSEQ=11-14,,;"
},
{
"commandType": "tl1",
"command": "ED-TOPO-SLOTSEQ:DALLAS----0123456789:SLOTSEQ-11-3-
2:1:::ADDSEQ=11-21,DROPSEQ=11-21,,;"
},
{
"commandType": "tl1",
"command": "ED-TOPO-SLOTSEQ:DALLAS----0123456789:SLOTSEQ-11-1-
1:1:::ADDSEQ=11-4&11-2&11-1,DROPSEQ=11-1&11-2&11-4,,;"
},
{
"commandType": "tl1",
"command": "ENT-NE-LIST:DALLAS----0123456789:SHELF-
11:1:::RNETID=\"MALTON----1472583690\",,;"
},
{
"commandType": "tl1",
"command": "ENT-NE-LIST:DALLAS----0123456789:SHELF-
11:1:::RNETID=\"OTTAWA----9876543210\",GNE=Yes,GNEIPADDR=47.134.24.168;"
},
{
"commandType": "tl1",
"command": "SET-ATTR-REMAUTH:DALLAS----0123456789:SHELF-
11:1::PRIMARY,,:STATE=ENABLE,RADIUS=10.10.100.1,PORT=1812,TO=15,GENSECRET=N,;"
},
{
"commandType": "tl1",
"command": "SET-ATTR-REMAUTH:DALLAS----0123456789:SHELF-
11:1::SECONDARY,,:STATE=ENABLE,RADIUS=10.20.200.2,PORT=1812,TO=15,GENSECRET=N,;"
},
{
"commandType": "tl1",
"command": "SET-REMAUTH-ALTERNATE:DALLAS----0123456789:SHELF-
11:1::LOCAL;"
},
{
"commandType": "tl1",
"command": "SET-ATTR-CSA:DALLAS----0123456789:SHELF-
11:1:::AUTHSTATE=DISABLE,QUERYMODE=ROUND_ROBIN,;"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 246
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

},
{
"commandType": "tl1",
"command": "ED-IP:DALLAS----0123456789:LAN-11-
42:1::11.0.0.17:NETMASK=255.255.255.252,,HOSTONLY=OFF,,,;"
},
{
"commandType": "tl1",
"command": "ENT-IISIS-CIRCUIT:DALLAS----0123456789:LAN-11-
42:1:::,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-OSPF-CIRCUIT:DALLAS----0123456789:LAN-11-
42:1:::NETAREA=92.0.0.0,,,,,,,,,,,,,,PASSIVE=ON,,,,,;"
},
{
"commandType": "macro",
"command": "\\\"PROMPT= The remaining operation in script 1 is
changing the craft port IP address. The session to the craft port will likely drop
due to the IP address change before a response is received. After clicking \"Ok\"
please wait 30 seconds for the ED-IP command to execute then close the TL1 Command
Builder application and disconnect Site Manager. If this is the last shelf specific
script 1 for this TIDc, please connect your computer to the craft port of the
primary. Reset/renew the IP address on your computer and log back into the primary
and execute the Shelf All script.\"\\;"
},
{
"commandType": "tl1",
"command": "ED-IP:DALLAS----0123456789:LAN-11-
41:1::11.0.0.21:NETMASK=255.255.255.252,,HOSTONLY=OFF,,,;"
},
{
"commandType": "macro",
"command": "\\\"PROMPT= Successfully completed script 1. Please
connect to the primary shelf in the TID and execute the Shelf: All script.\"\\;"
}
],
"deviceType": "6500",
"scriptId": "6500_DALLAS----0123456789-SHELF-11_1.bch"
}
]
},
{
"shelfId": "12",
"primary": "Disable",
"scripts": [
{
"release": "11.5",
"sequenceId": "1",
"commands": [
{
"commandType": "comment",
"command": "\\\"This TL1 Script was created with Commissioning
MicroService for: { \"DeviceType\":\"6500\", \"NodeType\":\"OADM\",
\"TID\":\"DALLAS----0123456789\", \"Shelf\": \"12\", \"FIC\": \"OMED_2176\",
\"Primary\": \"Disable\", \"Release\":\"11.5\", \"Timestamp\":\"2017-11-29_12-30-
13-125000\", \"FileName\":\"6500_DALLAS----0123456789-SHELF-12_1.bch\",
\"relatedProjects\":\"\"} \"\\;"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 247
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

},
{
"commandType": "macro",
"command": "\\\"PROMPT= Please confirm configuring node:
DALLAS----0123456789, Bay: 1, Shelf: 2, FIC: OMED_2176 and Release: 11.5\"\\;"
},
{
"commandType": "tl1",
"command": "SET-SID:GenTID1:SHELF-0:1::\"\"DALLAS----
0123456789\"\";"
},
{
"commandType": "tl1",
"command": "ENT-SHELF:DALLAS----0123456789:SHELF-
12:1:::SITEID=37329,SITENAME=\"DLLSTXRNDS11\",,FIC=\"OMED_2176\",BAYNUM=1,PHYSSHELF
=2,LOCATION=\"-94.0333333, 36.8203525\",SUBNETNAME=\"DCN-1234-DLLS-
OTWA\",,,PRIMARY=Disable,TIDC=Enable,EXTENDEDSHELF=ENABLE,,;"
},
{
"commandType": "macro",
"command": "\\\"Set Current Date and Time\"\\;"
},
{
"commandType": "tl1",
"command": "SET-NODE-TYPE:DALLAS----0123456789::1::OADM;"
},
{
"commandType": "tl1",
"command": "ED-SYS:DALLAS----0123456789:SHELF-
12:1:::NEMODE=SONET,,,,,,,,PROVCURRENT=4x60,,,,,GCC0MODE=DISABLED,GCC1MODE=DISABLED
,,,ALMHO=0,,OSCMODE=Disabled,ALMCORR=ON,BAYFICINAO=True,,,,,,,,,AINSTIMEOUT=24-
00,,,,,,,,,,,,,AUTOROUTEDEF=DISABLE,,ENHEQPTMGMT=ENABLED,ALARMINFO=CRDTYP&WVLNGTH&F
IC&SBNTNM&PHYSSHLF&BYNMBR&CLFI,,,DOCAUTODELLOS=YES,TCASUPPRESSION=Yes,,AUTOPROVFAC=
ON,AUTOPROVCRS=ON,ETH10GMAPPING=GFPMACOSTR,,,,,,,,,,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-IP:DALLAS----0123456789:SHELF-
12:1::20.0.4.2:NETMASK=255.255.255.255,,,,,;"
},
{
"commandType": "tl1",
"command": "ED-AUTOEQUIP:DALLAS----0123456789:SLOT-12-
ALL:1:::MODE=DISABLED;"
},
{
"commandType": "tl1",
"command": "ED-TELNET:DALLAS----0123456789:SHELF-
12:1:::MAXSESSIONS=3,IDLETIMEOUT=30,SERVER=ENABLED;"
},
{
"commandType": "macro",
"command": "\\\"Delay Time (seconds)= 5\"\\;"
},
{
"commandType": "tl1",
"command": "ED-SSH:DALLAS----0123456789:SHELF-
12:1:::MAXSESSIONS=18,,SERVER=ENABLED,,;"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 248
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"commandType": "tl1",
"command": "ED-HTTP:DALLAS----0123456789:SHELF-
12:1:::HTTP=OFF,,REST=OFF,;"
},
{
"commandType": "tl1",
"command": "ED-SLDD:DALLAS----0123456789:SHELF-
12:1:::ADMINSTATE=ON,,;"
},
{
"commandType": "tl1",
"command": "ENT-EQPT:DALLAS----0123456789:SP-12-
42:1::NTK555FA:,,,,,,,,,,,,,,,,,:IS,;"
},
{
"commandType": "tl1",
"command": "ENT-FFP-EQPT:DALLAS----0123456789:SP-12-41,SP-12-
42:1:::PS=1PLUS1,,,;"
},
{
"commandType": "tl1",
"command": "ENT-IISIS-ROUTER:DALLAS----0123456789:SHELF-
12:1:::,,,;"
},
{
"commandType": "tl1",
"command": "ENT-LAN:DALLAS----0123456789:ILAN-12-IN:1:::;"
},
{
"commandType": "tl1",
"command": "ENT-IP:DALLAS----0123456789:ILAN-12-
IN:1::0.0.0.0:NETMASK=255.255.255.255,,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-IISIS-CIRCUIT:DALLAS----0123456789:ILAN-12-
IN:1:::,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-LAN:DALLAS----0123456789:ILAN-12-OUT:1:::;"
},
{
"commandType": "tl1",
"command": "ENT-IP:DALLAS----0123456789:ILAN-12-
OUT:1::0.0.0.0:NETMASK=255.255.255.255,,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-IISIS-CIRCUIT:DALLAS----0123456789:ILAN-12-
OUT:1:::,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-IISIS-CIRCUIT:DALLAS----0123456789:SHELF-
12:1:::,,,,;"
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 249
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"commandType": "tl1",
"command": "ED-TL1GW:DALLAS----0123456789:SHELF-
12:1:::GNE=ENABLED,RNE=ENABLED;"
},
{
"commandType": "macro",
"command": "\\\"PROMPT= Successfully completed script 1. Please
execute script 1 for all remaining shelves in this TID. When script 1 has been
executed for all shelves in the TID connect to the primary shelf in the TID and
execute the Shelf: All script.\"\\;"
}
],
"deviceType": "6500",
"scriptId": "6500_DALLAS----0123456789-SHELF-12_1.bch"
}
]
},
{
"shelfId": "ALL",
"scripts": [
{
"release": "11.5",
"sequenceId": "1",
"commands": [
{
"commandType": "macro",
"command": "\\\"PROMPT= This is the Shelf: All script for node:
DALLAS----0123456789. You must be connected to the Primary shelf craft port or via
a DCN port to execute this script. Please confirm script 1 has been executed for
all shelves in this TID. All shelves must have their ILAN cables connected, be
visible and alarm free before executing this script.\"\\;"
},
{
"commandType": "tl1",
"command": "ENT-IISIS-CIRCUIT:DALLAS----0123456789:LAN-11-
41:1:::,,,,;"
},
{
"commandType": "tl1",
"command": "ENT-OSPF-CIRCUIT:DALLAS----0123456789:LAN-11-
41:1:::NETAREA=92.0.0.0,,,,,,,,,,,,,,PASSIVE=ON,,,,,;"
},
{
"commandType": "tl1",
"command": "ED-TL1GW:DALLAS----0123456789:SHELF-
11:1:::GNE=ENABLED,RNE=ENABLED;"
},
{
"commandType": "macro",
"command": "\\\"PROMPT= Successfully completed
commissioning.\"\\;"
}
],
"deviceType": "6500",
"scriptId": "6500_DALLAS----0123456789-SHELF-ALL_1.bch"
}
]
}
]

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 250
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

}
],
"relatedProjects": [],
"projectName": "AddFbRFDILANTB1"
}
}

Copy the contents of the response and save it to a text file with the extension .json.

Note: To apply a commissioning script to a network element, see "Commissioning via a script" in 6500
Packet Optical Platform Commissioning and Testing, 323-1851-221, Issue 3 or later.

Retrieve commissioning scripts for a homogeneous

project (Waveserver)
To retrieve the commissioning scripts, use the Commissioning API.

Requirements

• Before you retrieve the commissioning scripts, ensure that you Generate commissioning scripts for a
homogeneous project only consisting of Waveserver nodes.
• A commissioning script provided for a node consists of CLI commands required to commission a
Waveserver node.
• Save this script in a file and execute it on a Waveserver at the CLI prompt.

Sample request

GET {{MCP_SERVER}}/commissioning/api/v1/scripts/

• Provide the value of the projectname parameter in the text box. The value specifies the project name
of the planned network in RPT.
• Provide the value of the devicetype as Waveserver in the text box.
• Provide the value of the nodename in the text box.

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 251
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

\"This CLI Script was created with Commissioning MicroService for:

{"DeviceType":"WaveserverAi", "NodeType":"", "NodeName":"WS2", "Shelf": "1",
"Primary": "Enable", "Release":"", "Timestamp":"2017-11-29_14-01-06-626000",
"FileName":"WS_WS2_1.bch"} "\;
software show
system set member-id 5 site-id 12 host-name WSAi1 group-id 6 member-name WSAi1
system set site-longitude 78.43621 site-latitude 23.9769
configuration save
dhcp client disable
interface set interface local ip 10.11.12.13/255.255.255.250
interface set gateway 10.20.30.40
configuration save
ntp client set polling-interval 16
ntp client set mode polling
ntp client add server 0.0.0.0:1
ntp client enable server 0.0.0.0:1
configuration save

Save the response in a file and execute the commands at the CLI prompt of a Waveserver node.

Retrieve commissioning scripts for a heterogeneous

project (6500 and Waveserver)
To retrieve the commissioning scripts, use the Commissioning API.

Requirements

Before you retrieve the commissioning scripts, ensure that you Generate commissioning scripts for a
heterogeneous project consisting of 6500 nodes and Waveserver nodes.

Note: You can also retrieve scripts using links provided for each node in the response from Generate
commissioning scripts for a heterogeneous project consisting of 6500 nodes and Waveserver nodes.

Sample request

GET {{MCP_SERVER}}/commissioning/api/v1/scripts/

• Provide the value of the projectname parameter in the text box. The value specifies the project name
of the planned network in RPT.
• Provide the value of the devicetype as Waveserver in the text box.
• Provide the value of the nodename in the text box.

Sample response (for a 6500 node script)

Refer sample response in Retrieve commissioning scripts for a homogeneous project only consisting of

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 252
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

6500 nodes.

Sample response (for a Waveserver node script)

Refer sample response from Retrieve commissioning scripts for a homogeneous project only consisting
of Waveserver nodes.

Enroll a 6200 network element

This section provides an example of how to manually enroll a 6200 network element (NE). Tasks include:

1. Pre-commission
2. Create a connection profile
3. Enroll a device

Requirements

To enroll a 6200 device, the device must be:

• Running software release 2.1 or later.

• Pre-commissioned.

Pre-commission
Complete the following tasks to pre-commission the device.

Control plane setup

• Create the Router ID interface

• Set Node ID to Router ID
• For ports on which MPLS tunnels are to be created, in the port switching parameters section, set
"Enable MPLS" to "Enable" and also set "Enable BPDU Tunneling" to "true"

Add a new 6200 device to the network

• Enable SNMP: navigate to Security-Security Settings, set "SNMP Agent" field to Enable
• 6200 lldp: enable lldp and TLV for links. Ensure sysName as part of LLDP, as currently needed for
linking stitching in MCP
• Pre-commission the device with a default level 3 Maintenance Domain (MD) in the tunnel and
pseudowire space for tunnel and pseudowire provisioning
• Manually create the MD on the device to be used as the default MD for provisioning (during
provisioning, the 6200 RA looks in the MIB table for a default level 3 MD and uses it for provisioning)
• For 6200 BFD, there is no need to create profiles separately because they are configured as part of
tunnel creation

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 253
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Note: 6200 does not support AIS.

Create a connection profile

To enroll a 6200 device, create a connection profile (currently supported only via REST for 6200 devices).

To create the profile, use the Network element connection profiles API.

Requirements

To create a 6200 device profile, two protocol endpoints must be added: "snmp" and "http_rest". The
SNMP protocol allows the 6200 resource adapter (RA) to query device parameters using SNMP, and the
HTTP_REST protocol allows the 6200 RA to submit HTML requests to the device.

Replace these parameters in the sample profile creation request body:

• [NAME] - (string) - a unique identifier that describes the profile (such as "6200_NE_Profile")
• [DESCRIPTION] - (string) - a description for the profile (such as "6200 multi-protocol profile")
• [SNMP_PORT] - (integer) - SNMP port used to perform SNMP queries on the device (usually "161")
• [COMMUNITY_STRING] - (string) - community string for SNMP protocol (such as "public")
• [SNMP_VERSION] - (string) - protocol version to communicate via SNMP (such as "v2c")
• [HTTP_PORT] - (integer) - HTTP port used to communicate to the device via HTML (usually "20080")
• [USERNAME] - (string) - username used to login to the device’s node manager (HTML interface)
• [PASSWORD] - (string) - password used to login to the device’s node manager (HTML interface)

Once you create a profile for the device, you receive a response that contains information about the
profile created. To enroll a device, you need the profile ID that is returned in this response.

Sample request

POST {{MCP_SERVER}}/discovery/api/v1/neprofiles

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 254
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "neConnectionProfile",
"attributes": {
"name":
"[NAME]",
"profileDescription": "[DESCRIPTION]",
"typeGroup": "/typeGroups/Ciena6200",
"isDefault": true,
"isEnabled": true,
"protocolEndpoints": {
"snmp": {
"connection": {
"hostport": [SNMP_PORT]
},
"authentication": {
"community": "[COMMUNITY_STRING]",
"version": "[SNMP_VERSION]"
}
},
"http_rest": {
"connection": {
"hostport": [HTTP_PORT]
},
"authentication": {
"scheme":
"http", "auth":
{
"username": "[USERNAME]",
"password": "[PASSWORD]"
}
}
}
}
}
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 255
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"id": "84a03f76-ca10-4144-870e-df4db582f931",
"type": "neConnectionProfile",
"attributes": {
"name": "6200_NE_Profile",
"profileDescription": "6200 multi-protocol profile",
"typeGroup": "/typeGroups/Ciena6200",
"isDefault": true,
"isEnabled": true,
"protocolEndpoints":
{
"snmp": {
"connection": {
"hostport": 161
},
"authentication": {
"community": "public",
"version": "v2c"
}
},
"http_rest": {
"connection": {
"hostport": 20080
},
"authentication"
: { "scheme":
"http",
"auth": {
"username": "USERNAME",
"password": "PASSWORD"
}
}
}
}
}
}
}

The response stores the profile ID in the data.id attribute (that is, "84a03f76-ca10-4144-870e-
df4db582f931").

To retrieve the profile ID after creating the connection profile, issue the GET
{{MCP_SERVER}}/discovery/api/v1/neprofiles request on the same URL as used for the POST request.

You receive a list of all profiles on the host machine. Ciena recommends you find the profile with the
same name as used for the POST request and note it down for use in the enrollment request.

Enroll a device
Once a connection profile is created, you can enroll a 6200 device. To enroll the device, use the Network
element enrollment (management sessions) API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 256
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Requirements

Specify the following attributes in the enrollment request:

• [6200_IP] - (string) - IP address of the 6200 device (such as "10.11.12.13") (Currently only IPv4 is
supported.)
• [6200_PROFILE_ID] - the ID of the 6200 profile created in Create a connection profile.

Sample request

POST {{MCP_SERVER}}/discovery/api/v3/managementSessions

{
"data": {
"type": "managementSessions",
"attributes": {
"ipAddress": "[6200_IP]",
"typeGroup": "/typeGroups/Ciena6200",
"discoveryState": "CONNECTING",
"profile": "[6200_PROFILE_ID]"
}
}
}

After this request is performed, MCP triggers enrollment and synchronization of the device. The device
then becomes inventoried and viewable in the MCP UI. Note the "discoveryState" of "CONNECTING"
triggers the device enrollment.

View 6200 inventory

Ciena recommends that you view device information through the MCP UI, but you may want to view it
through Swagger (that is, requests exposed in System > REST API documentation) instead.

This section provides an example of how to manually view 6200 inventory. Tasks include:

• Retrieve a list of devices

• Retrieve a list of equipment
• Retrieve active alarms
• View the port inventory (TPEs)
• View the service inventory (FREs)

Once enrollment for a 6200 device starts, MCP communicates with the 6200 resource adapter (RA) and
triggers shallow and deep discovery for the device. Note that shallow discovery is named "session-
discovery" in the API. Shallow and deep discovery finds the following categories of attributes on the

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 257
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

device:

• Nodal information - IP, MAC Address, device type, typeGroup, etc.

• Equipment and equipment holders - pluggable, power fan equipment, etc.
• Local and remote LLDP information
• TPE and FRE information:
◦ Port information
◦ MPLS tunnels and all relevant information about the tunnel
◦ Services on tunnels and all relevant information about the service
• Active alarms on the device

Note: The following request examples use a sample Network Construct ID of "2fd1c4a7-630f-30fa-b48f-
18beb7c40c1d". This unique ID is also called networkConstruct.id (previously NCID). Many queries
require this ID.

Retrieve a list of devices

To retrieve a list of devices and their unique identifiers (as "id" in the response), use the Network elements
(constructs) API.

Sample request

GET {{MCP_SERVER}}/nsi/api/networkConstructs?limit=20

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 258
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": [
{
"id": "2fd1c4a7-630f-30fa-b48f-18beb7c40c1d",
"type": "networkConstructs",
"attributes": {
"ipAddress": "10.11.12.13",
"typeGroup": "Ciena6200",
"resourceType": "6200",
"associationState": "GOA",
"deviceType": "6200",
"softwareVersion": "02105601",
"accessIdentifier": "SHELF-1",
"macAddress": "0x0004950DD992",
"name": "MY_6200",
"geoLocation": {
"zone": "SJ",
"longitude": "",
"latitude": ""
},
"serialNumber": "M8112480",
"deviceVersion": "CIENA,6200,ADM,02105601",
"additionalAttributes": {},
"capabilitySpecRef": "6200.json",
"networkConstructType": "networkElement",
"l2Data": [
{
"shelf": "1",
"loopbackAddresses": [
"10.11.12.13"
],
"staticTunnelLabelRange": {
"minValue": 16,
"maxValue": 4095
},
"dynamicLabelRange": {
"minValue": 0,
"maxValue": 0
},
"staticVcLabelRange": {
"minValue": 4096,
"maxValue": 8191
}
}
]
},
"relationships": {
"managementSession": {
"data": {
"type": "managementSessions",
"id": "ef568f94-9049-4e91-9408-757e6aff898e"
}
}
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 259
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Retrieve a list of equipment

To retrieve a list of equipment on the network element, use the Equipment API.

Sample request

GET {{MCP_SERVER}}/nsi/api/equipment?networkConstruct.id=2fd1c4a7-630f-30fa-b48f-
18beb7c40c1d&limit=ALL

Sample response

{
"data": [
{
"id": "2fd1c4a7-630f-30fa-b48f-18beb7c40c1d::EQPT_10",
"type": "equipment",
"attributes": {
"locations": [
{
"managementType": "saos",
"slot": "10"
}
],
"category": "shelf",
"nativeName": "Fan+OAM-10",
"provisionedSpec": {
"serialNumber": ""
},
"installedSpec": {
"serialNumber": ""
},
"state": "OOS",
"cardType": "Fan",
"maintenanceMode": false
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "2fd1c4a7-630f-30fa-b48f-18beb7c40c1d"
}
}
}
},
{
"id": "2fd1c4a7-630f-30fa-b48f-18beb7c40c1d::EQPT_1_2_1",
"type": "equipment",
"attributes": {
"locations": [
{
"managementType": "saos",
"shelf": "1",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 260
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"slot": "2",
"port": "1"
}
],
"category": "pluggable",
"nativeName": "PGEFC-1-2-1",
"provisionedSpec": {
"serialNumber": "08FY07002588 ",
"type": "PGEFC-1-2-1",
"partNumber": "XCVR-010M31 ",
"additionalAttributes": {
"eqpWidth": "1"
}
},
"installedSpec": {
"serialNumber": "08FY07002588 ",
"type": "PGEFC-1-2-1",
"partNumber": "XCVR-010M31 ",
"additionalAttributes": {
"eqpWidth": "1"
}
},
"state": "IS",
"cardType": "PGEFC-1-2-1",
"maintenanceMode": false
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "2fd1c4a7-630f-30fa-b48f-18beb7c40c1d"
}
},
"equipmentHolder": {
"data": {
"type": "equipmentHolders",
"id": "2fd1c4a7-630f-30fa-b48f-18beb7c40c1d::EQPTHLD_1_2_1"
}
}
}
}
]
}

Retrieve active alarms

Retrieve a list of active alarms on devices using the Alarms API.

Sample request

GET {{MCP_SERVER}}/nsa/api/v1/alarms?status=active&fields=all&limit=30

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 261
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Sample response

{
"data": [
{
"type": "alarm",
"id": "-1299290880639205018",
"attributes": {
"id": "-1299290880639205018",
"resource": "MEP-MCP-Prot62006x_Protect",
"ra-alarm-id": "3989",
"node-id": "7f39766f-4a52-448e-9e68-cf07bcf3b3fa",
"node-type": "6200",
"native-condition-type": "LOCC",
"native-condition-type-qualifier": "658",
"condition-severity": "CRITICAL",
"service-affecting": "SERVICE_AFFECTING",
"condition-source": "NETWORK",
"condition-state": "ACTIVE",
"manual-clearable": false,
"additional-text": "Connectivity Check Failed",
"first-raise-time": "2017-03-06T10:52:07.000+0000",
"last-raise-time": "2017-03-06T10:52:07.000+0000",
"number-of-occurrences": 1,
"acknowledge-state": "NOT_ACKNOWLEDGED",
"additional-attrs": {
"source": "6200:MplsTpMEP-0-0-1-1-2-2"
}
}
},
{
"type": "alarm",
"id": "-1501069848203798886",
"attributes": {
"id": "-1501069848203798886",
"resource": "MEP-Demo_159-200_Pr_23-27_Work",
"ra-alarm-id": "3990",
"node-id": "7f39766f-4a52-448e-9e68-cf07bcf3b3fa",
"node-type": "6200",
"native-condition-type": "LOCC",
"native-condition-type-qualifier": "658",
"condition-severity": "CRITICAL",
"service-affecting": "SERVICE_AFFECTING",
"condition-source": "NETWORK",
"condition-state": "ACTIVE",
"manual-clearable": false,
"additional-text": "Connectivity Check Failed",
"first-raise-time": "2017-03-06T10:52:12.000+0000",
"last-raise-time": "2017-03-06T10:52:12.000+0000",
"number-of-occurrences": 1,
"acknowledge-state": "NOT_ACKNOWLEDGED",
"additional-attrs": {
"source": "6200:MplsTpMEP-0-0-1-1-3-3"
}
}
},
{
"type": "alarm",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 262
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"id": "-1651645470242266090",
"attributes": {
"id": "-1651645470242266090",
"resource": "P10GETH-1-2-3",
"ra-alarm-id": "3448",
"node-id": "7f39766f-4a52-448e-9e68-cf07bcf3b3fa",
"node-type": "6200",
"native-condition-type": "EQPT_MISMATCH",
"native-condition-type-qualifier": "360",
"condition-severity": "CRITICAL",
"service-affecting": "SERVICE_AFFECTING",
"condition-source": "NETWORK",
"condition-state": "ACTIVE",
"manual-clearable": false,
"additional-text": "SFP Auto Provision Mismatch",
"first-raise-time": "2016-02-16T15:16:34.000+0000",
"last-raise-time": "2016-02-16T15:16:34.000+0000",
"number-of-occurrences": 1,
"acknowledge-state": "NOT_ACKNOWLEDGED",
"additional-attrs": {
"source": "6200:SFP-1-2-3"
}
}
},
],
"links": {
"next": {
"href":
"https://2.3.4.5/api/nsa/api/v1/alarms?offset=0028001000000020001335373231363835363
93833323631373832313900000776657273696f6e007fffffe1a656d6c330effe4911c46176a334601b
0003:7f39766f-4a52-448e-9e68-cf07bcf3b3fa&limit=30",
"meta": {
"nextOffset":
"002800100000002000133537323136383536393833323631373832313900000776657273696f6e007f
ffffe1a656d6c330effe4911c46176a334601b0003:7f39766f-4a52-448e-9e68-cf07bcf3b3fa"
}
}
},
"meta": {}
}

View the port inventory (TPEs)

To view the port information for a device, use the Port inventory (TPEs) API.

The port inventory (TPEs) request returns port information, as well as tunnel and service information, at
the physical port level.

Sample request

GET {{MCP_SERVER}}/nsi/api/tpes?networkConstruct.id=2fd1c4a7-630f-30fa-b48f-
18beb7c40c1d&content=detail&limit=500

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 263
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Sample response

{
"links": {},
"data": [
{
"id": "2fd1c4a7-630f-30fa-b48f-
18beb7c40c1d::TPE_1_2_1_CTPServerToClient_VLAN_4096",
"type": "tpes",
"attributes": {
"structureType": "CTPServerToClient",
"locations": [
{
"managementType": "saos",
"port": "Port_Eth-1000-1-2-1",
"vlan": "4096"
}
],
"layerTerminations": [
{
"layerRate": "ETHERNET",
"structureType": "exposed lone cp",
"terminationState": "layer termination cannot terminate",
"active": true,
"signalIndex": {
"mappingTable": [
{
"direction": "RXTX",
"label": "4096"
}
]
},
"additionalAttributes": {
"interfaceType": "INNI",
"egressAction.etherType": "",
"egressAction.label": "4096",
"signalContentType": "VLAN"
}
}
],
"stackDirection": "bidirectional",
"displayAlias": "ETH-1-2-1-4096",
"identifiers": [
{
"networkConstructId": "2fd1c4a7-630f-30fa-b48f-18beb7c40c1d",
"nodalId": "2fd1c4a7-630f-30fa-b48f-
18beb7c40c1d::TPE_1_2_1_CTPServerToClient_VLAN_4096"
}
]
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "2fd1c4a7-630f-30fa-b48f-18beb7c40c1d"
}
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 264
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"owningServerTpe": {
"data": {
"type": "tpes",
"id": "2fd1c4a7-630f-30fa-b48f-18beb7c40c1d::TPE_1_2_1_PTP"
}
}
}
},
{
"id": "2fd1c4a7-630f-30fa-b48f-18beb7c40c1d::TPE_1_2_1_PTP",
"type": "tpes",
"attributes": {
"structureType": "PTP",
"nativeName": "Port_Eth-1000-1-2-1",
"userLabel": "Port_Eth-1000-1-2-1",
"locations": [
{
"managementType": "saos",
"shelf": "1",
"slot": "2",
"port": "1"
}
],
"layerTerminations": [
{
"layerRate": "ETHERNET",
"structureType": "lone adapter",
"terminationState": "layer termination cannot terminate",
"active": true,
"adjacencyPackage": {
"adjacencyType": "TXRX",
"localTag": "SJ_6200_220-0a6f32dc-Port_Eth-1000-1-2-1",
"provisionedRemoteTag": "SJ_6200_159-0a6f329f-Port_Eth-1000-1-2-2",
"remoteTag": "SJ_6200_159-0a6f329f-Port_Eth-1000-1-2-2",
"topologySourceTag": "DISCOVERED"
},
"additionalAttributes": {
"macAddress": "00:04:95:0f:04:78",
"acceptableFrameType": "all",
"signalContentType": "mac_transport",
"stp": "disabled",
"mtu": "9616",
"floodContainment": "disabled"
}
},
{
"layerRate": "DSR_ETHERNET",
"structureType": "full layer fixed",
"terminationState": "layer termination permanently terminated",
"active": true,
"additionalAttributes": {
"adminSpeed": "1 Gbps",
"autoNegotiation": "enable",
"dsrType": "UNKNOWN",
"adminFlowControl": "manualDisable",
"operSpeed": "1 Gbps",
"adminDuplex": "full"
}
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 265
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"layerRate": "OS",
"structureType": "full layer fixed",
"terminationState": "layer termination permanently terminated",
"active": true
},
{
"layerRate": "PHY",
"structureType": "full layer fixed",
"terminationState": "layer termination permanently terminated",
"active": true
}
],
"stackDirection": "bidirectional",
"displayAlias": "ETH-1-2-1",
"fgiSpecificationRefList": [
"Packet_6x_Common_FG:1:1"
],
"totalCapacity": [
{
"layer": "ETHERNET",
"capacity": 4094,
"capacitySize": {
"size": [
"0-4094"
],
"pattern": {
"type": "RANGE"
},
"unit": "SVID"
}
},
{
"layer": "ETHERNET",
"capacity": 4094,
"capacitySize": {
"size": [
"0-4094"
],
"pattern": {
"type": "RANGE"
},
"unit": "CVID"
}
}
],
"usedCapacity": [
{
"layer": "ETHERNET",
"capacity": 1,
"capacitySize": {
"size": [
"4096"
],
"pattern": {
"type": "RANGE"
},
"unit": "SVID"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 266
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

}
],
"identifiers": [
{
"networkConstructId": "2fd1c4a7-630f-30fa-b48f-18beb7c40c1d",
"nodalId": "2fd1c4a7-630f-30fa-b48f-18beb7c40c1d::TPE_1_2_1_PTP"
}
],
"additionalAttributes": {
"portType": "ethernet"
}
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "2fd1c4a7-630f-30fa-b48f-18beb7c40c1d"
}
},
"clientTpes": {
"data": [
{
"type": "tpes",
"id": "2fd1c4a7-630f-30fa-b48f-
18beb7c40c1d::TPE_1_2_1_CTPServerToClient_VLAN_4096"
}
]
}
}
}
]
}

View the service inventory (FREs)

To view the service information for a device, use the Services inventory (FREs) API.

The service inventory (FREs) request returns tunnel and service information at the service level.

Sample request

GET {{MCP_SERVER}}/nsi/api/fres?networkConstruct.id=2fd1c4a7-630f-30fa-b48f-
18beb7c40c1d&limit=30

Sample response

{
"links": {},
"data": [
{
"id": "-3520365371114410288",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 267
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"type": "fres",
"attributes": {
"userLabel": "",
"mgmtName": "",
"nativeName": "",
"layerRate": "ETHERNET",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"signalContentType": "IP",
"additionalAttributes": {
"isActual": "true"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "-3520365371114410288:1"
},
{
"type": "endPoints",
"id": "-3520365371114410288:2"
}
]
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "2fd1c4a7-630f-30fa-b48f-18beb7c40c1d::FRE_IP_ETH-1-2-2"
},
{
"type": "fres",
"id": "7006946602095382927"
},
{
"type": "fres",
"id": "efc2f602-f8a5-3287-a357-c0a2ab4b1119::FRE_IP_ETH-1-2-2"
}
]
}
}
},
{
"id": "-4540001329902763454",
"type": "fres",
"attributes": {
"userLabel": "Jane_159-171_PE_16-58_B",
"mgmtName": "",
"nativeName": "",
"layerRate": "MPLS",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 268
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

],
"signalContentType": "LSP",
"additionalAttributes": {
"isActual": "true"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "-4540001329902763454:1"
},
{
"type": "endPoints",
"id": "-4540001329902763454:2"
}
]
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "2fd1c4a7-630f-30fa-b48f-18beb7c40c1d::FRE_MPLS_Jane_159-
171_PE_16-58_B_transit"
},
{
"type": "fres",
"id": "-3520365371114410288"
}
]
}
}
},
{
"id": "2fd1c4a7-630f-30fa-b48f-18beb7c40c1d::FRE_IP_ETH-1-2-2",
"type": "fres",
"attributes": {
"mgmtName": "",
"layerRate": "ETHERNET",
"multiHighestStackLayerRate": "ETHERNET",
"networkRole": "IFRE",
"directionality": "bidirectional",
"topologySources": [
"discovered"
],
"operationState": "fully operating",
"deploymentState": "complete in network",
"signalContentType": "IP",
"identifiers": [
{
"networkConstructId": "2fd1c4a7-630f-30fa-b48f-18beb7c40c1d",
"nodalId": "2fd1c4a7-630f-30fa-b48f-18beb7c40c1d::FRE_IP_ETH-1-2-2"
}
],
"additionalAttributes": {
"isActual": "true"
}
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 269
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "2fd1c4a7-630f-30fa-b48f-18beb7c40c1d::FRE_IP_ETH-1-2-2::EP0"
},
{
"type": "endPoints",
"id": "2fd1c4a7-630f-30fa-b48f-18beb7c40c1d::FRE_IP_ETH-1-2-2::EP1"
}
]
},
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "2fd1c4a7-630f-30fa-b48f-18beb7c40c1d"
}
}
}
}
]
}

Service provisioning after commissioning

When no errors occur during network element commissioning, services are automatically provisioned
after successful discovery of the network element. However, if errors occur during the provisioning of
these services, you can manually trigger service provisioning.

Tasks include:

1. Manually trigger service provisioning

2. Retrieve the service state
3. Retrieve management sessions

Requirements

Before you begin, make sure that you have:

• If required, set the trap destination in the commissioning SNMP policy data.
• If required, you have configured the SNMP defaults in the commissioning SNMP policy defaults.

Manually trigger service provisioning

Manually trigger service provisioning after automated service provisioning has failed using the following
commissioning API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 270
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Requirements

Provide the value of the session_id parameter in the text box. This value specifies the management
session_id for the NE. You retrieve the management session_id using the instructions in section Retrieve
management sessions.

Sample request

POST {{MCP_SERVER}}/commissioning/api/v1/services/

Sample input

{
"session_id": "148e227f-1962-4b4d-ba59-dc9b12627ac6"
}

Sample response

A response code of 201 indicates successful service provisioning of the services.

Retrieve the service state

Retrieve the state of services provisioned by commissioning using the following commissioning API.

Sample request

GET {{MCP_SERVER}}/commissiong/api/v1/services/

Sample response

{
"data": [
{
"device": {
"release": "11.5",
"type": "6500",
"name": "PV0196A"
},
"services": [
{
"operations": [
{
"commands": [
{
"status": "provisioned",
"command": "ED-SNMP::SHELF-
11:1:::SNMPAGENT=ENABLED,VERSION=v3,,,,,,,;",
"type": "tl1",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 271
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"id": "SHELF-11"
}
],
"type": "ED-SNMP"
},
{
"commands": [
{
"status": "provisioned",
"command": "ED-TRAP-DEST::DEST-11-1:1::\"1.2.3.4\":,,,,;",
"type": "tl1",
"id": "1.2.3.4"
},
{
"status": "provisioned",
"command": "ED-TRAP-DEST::DEST-11-2:1::\"5.6.7.8\":,,,,;",
"type": "tl1",
"id": "5.6.7.8"
}
],
"type": "ED-TRAP-DEST"
},
{
"commands": [
{
"status": "provisioned",
"command": "ENT-USER-USM::SHELF-
11:1:::UID=\"admin\",AUTH=MD5,AUTHPASSWORD=\"qwertyuiop\",PRIV=DES,PRIVPASSWORD=\"q
wertyuiop\",USERGROUP=\"OM5Kcustomer1Group\",;",
"type": "tl1",
"id": "admin"
}
],
"type": "ENT-USER-USM"
}
],
"name": "SNMP"
}
],
"nc_id": "24483f02-09e9-3b42-9c29-aa122c5f82b2"
}
]
}

Retrieve management sessions

Retrieve management session information using the following discovery API.

Requirements

Provide the value of the network element TID or IP address in the text box.

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 272
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

GET {{MCP_SERVER}}/discover/api/managementSessions

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 273
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"meta": {
"total": 1
},
"links": {
"current": "https://onxv0378/api/discovery/api/managementSessions?name=3903-
6&limit=20"
},
"data": [
{
"id": "ff36451b-134a-4fde-9a20-5332f3f251f9",
"type": "managementSessions",
"attributes": {
"displayData": {
"displayState": "CONNECTED"
},
"ipAddress": "10.92.19.223",
"typeGroup": "/typeGroups/CienaPacket",
"name": "3903-6",
"profile": "59c0fc94-a261-4209-b66e-34ec7b7a0783",
"resourceType": "3903x",
"discoveryState": "COMPLETED",
"created": "2017-05-23T18:10:41.269+0000",
"associationState": "GOA",
"managementAddresses": [
"10.92.19.223"
],
"sessionType": "gatewayNE",
"onPreferredGNE": true,
"connectionAddress": "10.92.19.223",
"preferredConnectionAddress": {
"address": "10.92.19.223",
"cost": 0
},
"connectionStates": [
{
"protocolType": "cli",
"connectionState": "CONNECTED"
},
{
"protocolType": "snmp",
"connectionState": "CONNECTED"
}
]
},
"relationships": {
"preferredGateway": {
"data": {
"type": "managementSessions",
"id": "ff36451b-134a-4fde-9a20-5332f3f251f9"
}
}
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 274
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Change a network element connection profile

Use this procedure to change the MCP security profile for a pre-enrolled or enrolled network element.

The network element connection profile contains device credentials and connection ports to the network
element.

The changed profile takes effect the next time the MCP server connects to the network element. Specific
updates include:

• Change credentials in the network element profile.

• For devices with failover paths, such as dual GNE, the updated profile is used when a failure occurs.
• For devices without failover paths, the updated profile is only used if the device is manually
resynchronized once it has gone LOA or force-reconnect Otherwise, the RA uses cached credentials.

Use the management sessions API to change the network element connection profile.

Requirements

The network element must already be pre-enrolled or enrolled.

Sample request

PATCH {{MCP_SERVER}}/discovery/api/v4/managementSessions/{sessionId}

{
"operations" : [
{
"op": "replace",
"attributes": {
"profile" : "<NE_PROFILE_ID>"
}
}]
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 275
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"id": "32c3c340-d9b8-49a7-b7dd-22dced75985d",
"type": "managementSessions",
"attributes": {
"displayData": {
"displayState": "CONNECTED"
},
"ipAddress": "10.182.191.170",
"typeGroup": "CienaWaveserver",
"name": "US-IL-Midway-WS001",
"profile": "8d65b066-46c9-4da4-8a86-cbf173b2f65a",
. . .
}
}
}

Commission and configure a node or port

To commission and configure a node or port, use the Network element configuration API.

The following samples relate to 8700.

Sample request

POST {{MCP_SERVER}}/configmgmt/api/v1/jobs

Specify the following attributes:

• maxConnections - maximum connection

• scheduleTime - time to when the job should be executed
• scriptName - to specify the name of the script to execute; in this example, it is the portConfig script

Note: The scriptname varies for different commissioning, as follows:

◦ Port - portConfig
◦ Port Interface - portInterfaceConfig
◦ Node - nodeConfig
• profileName - profile name
• type - type of job (for example, job)
• action - to specify the type of actions (create, delete) that can be performed on the script (in this
example, it is create)
• neName - network element name

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 276
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

• neType - network element type

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "portConfig",
"inputs": [
{
"data": [
{
"type": "tpes",
"name": "8700",
"attributes": {
"action": "create",
"locations": [
{
"slot": "1",
"port": "1"
}
],
"layerTerminations": [
{
"layerRate": "ETHERNET",
"additionalAttributes": {
"description": "ciena"
}
}
]
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a"
}
]
}
}
},
"included": [
{
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"type": "networkElement",
"attributes": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 277
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"ncId": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"neName": "87c_0009",
"ipAddress": "10.182.130.100",
"neType": "8700"
}
}
]
}

Sample response

{
"jobId": "6f057d9f-c912-435b-8f0b-47cab0f540b2",
"status": "COMPLETED",
"input": {
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "portConfig",
"inputs": [
{
"data": [
{
"type": "tpes",
"name": "8700",
"attributes": {
"action": "create",
"locations": [
{
"slot": "1",
"port": "1"
}
],
"layerTerminations": [
{
"layerRate": "ETHERNET",
"additionalAttributes": {
"description": "test1"
}
}
]
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 278
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"type": "networkConstructs",
"id": "76a16478-c95f-4f80-b7dd-aa947798ed45"
}
]
}
}
},
"included": [
{
"id": "76a16478-c95f-4f80-b7dd-aa947798ed45",
"type": "networkElement",
"attributes": {
"ncId": "76a16478-c95f-4f80-b7dd-aa947798ed45",
"neName": "87_4333n8",
"ipAddress": "10.182.36.111",
"neType": "8700"
}
}
]
},
"output": {
"data": {
"type": "jobResults",
"attributes": {
"scriptResults": [
{
"scriptName": "portConfig",
"status": "COMPLETED",
"commandResults": [
{
"command": "set-port.json",
"result": {
"result": {
"data": "",
"result": "success"
},
"parameters": {
"data": [
{
"attributes": {
"action": "create",
"layerTerminations": [
{
"additionalAttributes": {
"description": "test1"
},
"layerRate": "ETHERNET"
}
],
"locations": [
{
"slot": "1",
"port": "1"
}
]
},
"type": "tpes",
"name": "8700"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 279
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

]
},
"command": "set-port.json"
}
}
]
}
]
}
}
}
}

Specify traffic enginering parameters for an IP interface

To specify the traffic enginering parameters for an IP interface use the Network element configuration
API.

The following samples relate to SRLG.

Sample request

POST {{MCP_SERVER}}/configmgmt/api/v1/jobs

Specify the following attributes:

• Region Id - Describes region component. First 6 bits are allocated for region
• Type: Describes risk type component. Bits 7-10 are allocated for risk type
• Summary Bit : Describes summary bit. Bit 11 is allocated for summary bit.
◦ Summary Bit = 0 - MCP will never automatically overwrite
◦ Summary Bit = 1 - MCP will automatically overwrite once propagation from lower layers is
supported
• Risk value: Describes risk value bits. Lower 21 bits are allocated for risk values

Example

Manually entered ROADM Degree risk against an IP interface

• 0x19E001E3 (0001,10 01,11 1 0,0000,0000,0001,1110,0011)

◦ Region Id = 6 (assuming controllerId.value will be set to 6)
◦ Summary Bit = 1 (so MCP will automatically overwrite once propagation from lower layers is
supported)
◦ Risk id = 483

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 280
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Allocated bits update process

SRLG value bits are configured in RA container. This can be modified by modifying the values in
commissioning_properties.py file.

REGION_ID_BIT_ALLOCATION = '6' # CONTROLLER_ID

RISK_TYPE_BIT_ALLOCATION = '4' # TYPE

RISK_SUMMARY_BIT_ALLOCATION = '1' # SUMMARY

RISK_VALUE_BIT_ALLOCATION = '21' # RISK_VALUE

cli command used for setting SRLG:

mpls traffic-engg set ip-interface <interface_name> srlg <srlg_value>

Request payload for updating values

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 281
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "portInterfaceConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "update",
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 483,
"linkCost": 200
"interfaceName": "if",
"resourceColorGroupName": "tdm_color_gr"
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

Request payload for unsetting values

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 282
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "portInterfaceConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "unset",
"srlg": null,
"linkCost": null,
"resourceColorGroupName": null,
"interfaceName": "if"
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

Request payload for adding srlg value

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 283
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "portInterfaceConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "add",
"interfaceName": "if",
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 483
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

Request payload for removing srlg value

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 284
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "portInterfaceConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "remove",
"interfaceName": "if",
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 483
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 285
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Changing the Waveserver Ai 1.1 DCN wayside

Use this procedure to set the DCN Mode to Wayside -channel or management through the Waveserver’s
API request.

1. To retrieve the current value for the DCN Mode, send the following GET request on the RA:

Sample request

GET {{MCP_SERVER}}/>/ ractrl/api/v1/devices/{{device-id}}/ attributes

Sample response

{
"data": {
"member-id": "32",
"site-id": "1",
"group-id": "7",
"line-protection": "unprotected",
"encryption": "NOT_SUPPORTED",
"site-name": "",
"line-ports": [
{
"id": "2-1",
"wavelength": "1566.78",
"frequency": "191.342500",
"transmission-mode": "56-400",
"oduk-termination-mode": "passthrough"
},
{
"id": "2-2",
"wavelength": "1566.78",
"frequency": "191.342500",
"transmission-mode": "56-400",
"oduk-termination-mode": "passthrough"
},
{
"id": "3-1",
"wavelength": "1528.71",
"frequency": "196.107500",
"transmission-mode": "56-200",
"oduk-termination-mode": "passthrough"
},
{
"id": "3-2",
"wavelength": "1528.71",
"frequency": "196.107500",
"transmission-mode": "56-200",
"oduk-termination-mode": "passthrough"
}
],
"group-name": "",
"host-name": "WS3012-FPE-REGEN",
"member-name": "First Product Evaluation Shelf",
"comm-interfaces": [

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 286
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"index": "1",
"name": "ILAN-1",
"operational-state": "down",
"mode": "management",
"admin-state": "enabled",
"type": "ethernet"
},
{
"index": "2",
"name": "ILAN-2",
"operational-state": "down",
"mode": "management",
"admin-state": "enabled",
"type": "ethernet"
},
{
"index": "3",
"name": "DCN",
"operational-state": "up",
"mode": "management",
"admin-state": "enabled",
"type": "ethernet"
},
{
"index": "4",
"name": "CONSOLE",
"operational-state": "up",
"mode": "management",
"admin-state": "enabled",
"type": "serial"
}
]
}
}

2. To edit the current value for the DCN Mode, send the following PATCH request on the RA:

PATCH {{MCP_SERVER}}/>/ ractrl/api/v1/devices/{{device-id}}/ attributes

Body

{"data": {"comm-interfaces": [{"index": "3", "mode": "management"}]}}

Sample response

Status Code:201 OK

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 287
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Retrieve health diagnostics from a node

The MCP REST API supports the retrieval of information from individual nodes pertaining to the node’s
"health". This includes information about the node’s state that is not directly related to services and
connections like temperature, CPU usage, etc.

SAOS 8x platforms maintain extensive health tracking records, monitoring almost every single aspect of
the chassis.

SAOS 6x platforms maintain more limited records focused on key data.

Information for SAOS 6.x nodes

SAOS 6x platforms maintain records of key data such as temperature, CPU state, and memory usage.
This includes:

• cpu-load-average
• cpu-utilization
• memory-utilization
• temperature
• power

Information for SAOS 8.x nodes

SAOS 8x platforms matain elaborate health tracking for almost every single aspect of the chassis.

• 8700 devices support the following health item categories:

◦ CPU
◦ memory-usage
◦ power
◦ temperature
• 6500 devices support the following health item categories:
◦ CPU
◦ memory-usage

API calls to retrieve node health information

Use the JOB POST REST API of Network Element Configuration in MCP to invoke requests:

/configmgmt/api/v1/jobs

Include the following parameters in your request:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 288
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

• Attributes: healthitem
• Type: string
• Values: temperature
• Script Name: HealthDiagnosticShow

The following examples show sample API calls requesting health diagnostics for both 6500 and 8700
nodes.

Display health diagnostic for temperature on a SAOS 6x device

Sample request

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "healthDiagnosticShow",
"inputs": [
{
"healthitem": "temperature"
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 289
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Response

[
{
"category": "Temperature",
"origin": "Chassis",
"item": "n/a",
"healthState": "Normal",
"currentValue": "17 C",
"minMaxValue": "17 C / 29 C",
"rangeLimit": "-40 C / 65 C"
}

Request to display health diagnostics for CPU on an 8700 device:

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 290
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "healthDiagnosticShow",
"inputs": [
{
"healthitem": "CPU"
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

Response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 291
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

[
{
"origin": "LM1",
"category": "CPU Usage",
"item": "Utilization (%)",
"minMaxValue": "0 / 16",
"rangeLimit": "0 / 100",
"healthState": "Normal",
"currentValue": "4"
},
{
"origin": "LM2",
"category": "CPU Usage",
"item": "Utilization (%)",
"minMaxValue": "0 / 28",
"rangeLimit": "0 / 100",
"healthState": "Normal",
"currentValue": "1"
}
]

Request to display health diagnostic information for memory usage on a 6500 device:

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 292
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "healthDiagnosticShow",
"inputs": [
{
"shelf":"11",
"group":"9",
"healthitem": "memory-usage"
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

Response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 293
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"11-9-LM2RAM (KB)": {
"origin": "LM2",
"category": "Memory Usage",
"healthState": "Normal",
"group": "9",
"shelf": "11",
"currentValue": "483029",
"item": "RAM (KB)",
"rangeLimit": "- / 981934",
"minMaxValue": "- / 483084"
},
"11-9-LM2SAOS (KB)": {
"origin": "LM2",
"category": "Memory Usage",
"healthState": "Normal",
"group": "9",
"shelf": "11",
"currentValue": "483029",
"item": "SAOS (KB)",
"rangeLimit": "- / 981934",
"minMaxValue": "- / 483084"
}
}

Retrieve control plane configuration data from a node

The MCP REST API supports the retrieval of information pertaining to control plane protocols from
individual nodes. This includes information about:

• RSVP-TE: enabled/disabled, and settings

• LDP: enabled/disabled
• ISIS routing instance: exists/does not, and properties

Retreiving this information is supported for the following nodes:

• SAOS 6.x nodes

• 6500
• 8700

You use the Configuration Management/JOBS API to request this information:

/configmgmt/api/v1/jobs

Requesting all Control Plane information

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 294
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "controlPlaneProtocolShow",
"inputs": [
{
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

Response

{
"81-7-ldp_timers": {
"ldpGrMaxPeerReconnect(sec)": 180,
"ldpGrMaxPeerRecovery(sec)": 240,
"group": "7",
"ldpHelloHoldTime(sec)": 180,
"shelf": "81",
"ldpGrReconnectTime(sec)": 90,
"ldpGrRecoveryTime(sec)": 180,
"ldpKeepaliveHoldTime(sec)": 180
},
"81-7-rsvp-te-protocol-parameters": {
"rsvpteFrrCapability": 3,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 295
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"rsvpteRsvpGrMode": "n/a",
"group": "7",
"rsvpteRefreshInterval(sec)": 30,
"rsvpteRsvpAdminStatus": "up",
"rsvpteLspSetupPriority": 7,
"rsvpteRsvpOperStatus": "up",
"rsvpteUseHopbyHop": "true",
"rsvpteRsvpGrAdminStatus": "false",
"shelf": "81",
"rsvpteLspHoldingPriority": 0,
"rsvpteBlockadeMultiple": 2,
"rsvpteRowStatus": "active",
"rsvpteRsvpExtention": 1,
"rsvpteRefresh Multiple": 3
},
"81-7-rsvp-te_global_state_timers": {
"rsvpteRsvpResvTearConfRx": 0,
"rsvpteRsvpPathRx": 0,
"rsvpteRsvpUnknownTx": 0,
"rsvpteRsvpPathErrorTx": 0,
"rsvpteRetryInterval(sec)": 3,
"rsvpteRestartTime(sec)": 60,
"rsvpteRsvpResvConfTx": 0,
"rsvpteRsvpHelloACKTx": 0,
"rsvpteRsvpResvConfRx": 0,
"rsvptePWRecoveryTime(sec)": 180,
"rsvpteRsvpResvTx": 0,
"rsvpteRsvpResvTearRx": 0,
"rsvpteRsvpResvRx": 2824,
"rsvpteRsvpHelloRx": 0,
"group": "7",
"rsvpteRetryMaxDefaul": 10,
"rsvpteRsvpDiscardedRx": 0,
"rsvpteTunnelRecoveryTime(sec)": 120,
"rsvpteRsvpHelloTx": 0,
"rsvpteTotalActivationPeriod(sec)": "infinite",
"rsvpteRsvpPathTearTx": 0,
"rsvpteRsvpUnknownRx": 0,
"rsvpteRsvpResvErrorRx": 0,
"rsvpteRetryInfiniteState": "on",
"rsvpteRsvpResvErrorTx": 0,
"rsvpteRsvpHelloACKRx": 0,
"rsvptePseudowireStatus": "on",
"rsvpteRsvpPathTearRx": 0,
"rsvpteRsvpResvTearConfTx": 0,
"rsvpteRsvpCorruptPktDrop": 0,
"rsvpteRsvpSRefreshRx": 0,
"rsvpteRsvpPathTx": 2795,
"rsvpteRsvpPathErrorRx": 0,
"shelf": "81",
"rsvpteRsvpSRefreshTx": 0,
"rsvptePseudowireCapability": "on",
"rsvpteActivationInterval(sec)": 300,
"rsvpteRsvpTearTx": 0
},
"81-7-ldp_global_settings": {
"grMode": "n/a",
"group": "7",
"ldpAdminState": "enabled",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 296
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"ldpOperState": "enabled",
"shelf": "81",
"ldpGrAdminState": "disabled"
},
"81-7-isis_instance_details": {
"isis#ofInterfaceAttachments": 3,
"isisArea": "49.0001",
"isisLspMaxLifetime(secs)": 1200,
"shelf": "81",
"isisGRMaxL1DbSyncTime": 60,
"isisGRMaxRecoveryTime": 65535,
"isisSystemId(fromLoopbackIp)": "0010:0117:0081",
"isisTEState": "enable",
"grMode": "helper",
"isisAreaInstanceName": "ce_03",
"isisAreaAuthenticationType": "none",
"isisGRMaxRestartTime": 10,
"isisDBMergedUpdates": 0,
"isisAreaPassword": "not-set",
"isisDBPendingUpdates": 0,
"isisTERouterId": "1.1.170.81",
"isisSpfThresholdRestartLimit": 7,
"isisDomainName": "",
"group": "7",
"isisSpfMaxDelay": 1200,
"isisAreaISSnpAuthentication": "yes",
"isisSpfThresholdUpdateStart": 20,
"isisHostName": "\"65PTS-0581-A23\"",
"isisLevel": "l1",
"isisIndex": 3,
"isisDCSysInstance(internal)": 3,
"isisSpfThresholdUpdateRestart": 20,
"isisAdminState": "enable",
"isisAreaObjectIndex": 3,
"isisLspRefreshInterval(secs)": 900,
"isisAreaISSendOnly": "no"
}
}

Requesting specific control plane protocol configurations: SAOS

6.x and 8700
Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 297
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "controlPlaneProtocolShow",
"inputs": [
{
"data":[
{
"attributes":{
"protocols":[
"ldp"
]
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

Response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 298
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"ldp_global_settings": {
"grMode": "n/a",
"ldpGrAdminState": "disabled",
"ldpAdminState": "enabled",
"ldpOperState": "enabled"
},
"ldp_timers": {
"ldpGrMaxPeerReconnect(sec)": 180,
"ldpGrMaxPeerRecovery(sec)": 240,
"ldpHelloHoldTime(sec)": 180,
"ldpGrReconnectTime(sec)": 0,
"ldpGrRecoveryTime(sec)": 0,
"ldpKeepaliveHoldTime(sec)": 180
}
}

Requesting specific control plane protocol configurations: 6500

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 299
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "controlPlaneProtocolShow",
"inputs": [
{
"shelf":"81",
"group":"7",
"data":[
{
"attributes":{
"protocols":[
"ldp"
]
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

Response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 300
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"81-7-ldp_timers": {
"ldpGrMaxPeerReconnect(sec)": 180,
"ldpGrMaxPeerRecovery(sec)": 240,
"group": "7",
"ldpHelloHoldTime(sec)": 180,
"shelf": "81",
"ldpGrReconnectTime(sec)": 90,
"ldpGrRecoveryTime(sec)": 180,
"ldpKeepaliveHoldTime(sec)": 180
},
"81-7-ldp_global_settings": {
"grMode": "n/a",
"group": "7",
"ldpAdminState": "enabled",
"ldpOperState": "enabled",
"shelf": "81",
"ldpGrAdminState": "disabled"
}
}

Create the Facility By Pass Profile

Use this procedure to create a facility-by-pass (FB) profile at the NE level. The NE allows creation of
multiple FB profiles in the system to allow them to be attached to IP interface. You can create the facility-
by-pass profile on the following Network elements:

• 6500-T and 6500-PTS (Release 13.0)

• 6x MPLS capable node 6.17.1

To create a FB profile on the Network element, execute the CLI command:

mpls tunnel-auto-fb-profile create auto-fb-profile <auto-fb-profile-name string >

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 301
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

[bandwidth-percentage-source <user | fast-reroute-object>

bandwidth-percentage-value <NUMBER: 0...100>]

[setup-hold-priority-source <user | fast-reroute-object>

setup-hold-priority-value <NUMBER: 0...7>]

[link-preference <yes | no>]

[affinity-source <user | fast-reroute-object>

< color-group-include-all <MPLS TE Admin Color Group> |

color-group-include-any <MPLS TE Admin Color Group> |

color-group-exclude-any <MPLS TE Admin Color Group> >]

[srlg-mode < maximal | strict | none>]

Attributes:
ACTION ATTRIBUTES TYPE VALUES DESCRIPTION

create

profileName string

bandwidthPercentag string User fast-reroute-

eSource object

bandwidthPercentag integer 0 - 100

eValue

linkPreference string Yes

No

affinitySource string user fast-reroute-

object

affinityDisjoint string Yes

No

setupHoldPrioritySou string user fast-reroute-

rce object

setupHoldPriorityVal 0-7
ue

srlgMode string maximal strict none

ignore

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 302
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

ACTION ATTRIBUTES TYPE VALUES DESCRIPTION

colourGroupIncludeA string
ny

colourGroupIncludeA string
ll

colourGroupExclude string
Any

API calls to create the Facility By Pass Profile

Use the JOB POST REST API of Network Element Configuration in MCP to invoke requests:

/configmgmt/api/v1/jobs

Request payload to create FB profile on 6x device.

Sample request:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 303
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "fbProfileConfig",
"inputs": [
{
"data": [
{
"attributes":{
"action": "create",
"profileName":"fb_test_affinity",
"bandwidthPercentageSource":"user",
"bandwidthPercentageValue":50,
"linkPreference":"no",
"affinitySource":"user",
"colourGroupIncludeAny":"FB_BLUE",
"colourGroupIncludeAll":"FB_RED",
"affinityDisjoint":"no",
"setupHoldPrioritySource":"user",
"srlgMode":"maximal"
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 304
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Request payload to create FB profile on 6500 device.

Sample request:

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "fbProfileConfig",
"inputs": [
{
"shelf":"81",
"group":"7",
"data": [
{
"attributes":{
"action": "create",
"profileName":"fb_test_affinity",
"bandwidthPercentageSource":"user",
"bandwidthPercentageValue":50,
"linkPreference":"no",
"affinitySource":"user",
"colourGroupIncludeAny":"FB_BLUE",
"colourGroupIncludeAll":"FB_RED",
"affinityDisjoint":"no",
"setupHoldPrioritySource":"user",
"srlgMode":"maximal"
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 305
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

Create/Edit the Facility By Pass Profile using shareable

SRLG
Use this procedure to create or edit a facility-by-pass (FB) profile at the NE level with the shareable SRLG
list. The user manually provides the shareable SRLG or the SRLG automatically fills in based on the NE
shareable SRLG if it exists.

Users can provide an optional property of remoteNode to allow MCP to automatically set the
linkBypassSRLG based on that information.

Users can also allow MCP to auto-assign shareable SRLG.

Functional Success Criteria

• Ability to create/edit a facility-bypass profile with shareable SRLG.
• Ability to automatically fill the shareable SRLG based on shareable NE SRLG.

To create FB profile with SRLG values on the Network element, execute the CLI command:

mpls tunnel-auto-fb-profile create auto-fb-profile fb_profile bandwidth-percentage-source user

bandwidth-percentage-value 50 setup-hold-priority-source user link-preference no affinity-source user
affinity-disjoint no srlg-mode maximal share-srlg-link 434110950,434110951 share-srlg-node
434110947,434110948,434110949\n

To unset the fb profile with SRLG values on the Network element, execute the CLI command:

mpls tunnel-auto-fb-profile unset auto-fb-profile fb_test_affinity bandwidth-percentage-source

bandwidth-percentage-value setup-hold-priority-source link-preference affinity-source affinity-disjoint
srlg-mode share-srlg-link share-srlg-node\n

Attributes:

Create FB profile

Action: Create
Attributes: remoteNEName, shareSrlgNode, shareSrlgLink
Type: string, list, list
Values: none, none, none

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 306
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Description: none, List contains node SRLG values, List contains link SRLG values

Update/Set FB profile

Action: Set
Attributes: remoteNEName, shareSrlgNode, shareSrlgLink
Type: string, list, list
Values: none, none, none
Description: none, List contains node SRLG values, List contains link SRLG values

Unset FB profile

Action: Set
Attributes: shareSrlgNode, shareSrlgLink
Type: none, none
Values: none, none
Description: List contains node SRLG values, List contains link SRLG values

API calls to create or edit the Facility By Pass Profile using

shareable SRLG
Use the JOB POST REST API of Network Element Configuration in MCP to invoke requests:

/configmgmt/api/v1/jobs

Request payload to create FB profile on 6x NE.

Sample request:

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "fbProfileConfig",
"inputs": [
{
"data": [
{
"attributes":{
"action": "create",
"profileName":"fb_profile",
"bandwidthPercentageSource":"user",
"bandwidthPercentageValue":50,
"linkPreference":"no",
"affinitySource":"user",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 307
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"affinityDisjoint":"no",
"setupHoldPrioritySource":"user",
"srlgMode":"maximal",
"shareSrlgNode": [
{
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 483
},
{
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 484
},
{
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 485
}
],
"shareSrlgLink": [
{
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 486
},
{
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 487
}
]
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 308
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

Request payload to create FB profile for 6500 NE.

Sample request:

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "fbProfileConfig",
"inputs": [
{
"shelf": "11",
"group": "9"
"data": [
{
"attributes":{
"action": "create",
"profileName":"fb_profile",
"bandwidthPercentageSource":"user",
"bandwidthPercentageValue":50,
"linkPreference":"no",
"affinitySource":"user",
"affinityDisjoint":"no",
"setupHoldPrioritySource":"user",
"srlgMode":"maximal",
"shareSrlgNode": [
{
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 483
},
{
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 484
},
{
"srlgRegionId": 6,
"srlgRiskType": 7,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 309
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"srlgRiskSummary": 1,
"srlgRiskValue": 485
}
],
"shareSrlgLink": [
{
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 486
},
{
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 487
}
]
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

Request payload to update/set FB profile on 6x NE.

Sample request:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 310
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "fbProfileConfig",
"inputs": [
{
"data": [
{
"attributes":{
"action": "update",
"profileName":"fb_test_affinity",
"bandwidthPercentageSource":"user",
"bandwidthPercentageValue":55,
"linkPreference":"yes",
"affinitySource":"user",
"affinityDisjoint":"yes",
"setupHoldPrioritySource":"user",
"srlgMode":"maximal",
"shareSrlgNode": [
{
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 483
},
{
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 484
},
{
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 485
}
],
"shareSrlgLink": [
{
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 486
},
{
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 487
}
]
}
}
]

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 311
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

Request payload to update/set FB profile on 6500 devices.

Sample request:

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "fbProfileConfig",
"inputs": [
{
"shelf": "11",
"group": "9",
"data": [
{
"attributes":{
"action": "update",
"profileName":"fb_test_affinity",
"bandwidthPercentageSource":"user",
"bandwidthPercentageValue":55,
"linkPreference":"yes",
"affinitySource":"user",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 312
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"affinityDisjoint":"yes",
"setupHoldPrioritySource":"user",
"srlgMode":"maximal",
"shareSrlgNode": [
{
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 483
},
{
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 484
},
{
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 485
}
],
"shareSrlgLink": [
{
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 486
},
{
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 487
}
]
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 313
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

Request payload to unset FB profile on 6x NE.

Sample request:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 314
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "fbProfileConfig",
"inputs": [
{
"data": [
{
"attributes":{
"action": "unset",
"profileName":"fb_test_affinity",
"bandwidthPercentageSource":null,
"bandwidthPercentageValue":null,
"linkPreference":null,
"affinitySource":null,
"affinityDisjoint":null,
"setupHoldPrioritySource":null,
"srlgMode":null,
"shareSrlgLink":null,
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 315
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Request payload to create autofill FB profile on 6500 devices.

Sample request:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 316
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "fbProfileConfig",
"inputs": [
{
"shelf": "11",
"group": "9",
"data": [
{
"attributes":{
"action": "create",
"profileName":"fb_test_affinity",
"bandwidthPercentageSource":"user",
"bandwidthPercentageValue":55,
"linkPreference":"yes",
"affinitySource":"user",
"affinityDisjoint":"yes",
"setupHoldPrioritySource":"user",
"srlgMode":"maximal"
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 317
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Edit the Facility By Pass Profile

Use this procedure to edit a facility-by-pass (FB) profile to change some of the network work properties.

• 6500-T and 6500-PTS (Release 13.0)

• 6x MPLS capable node 6.17.1

To edit FB profile on the Network element, execute the CLI command:

mpls tunnel-auto-fb-profile set fb-profile <auto-fb-profile-name string>

[bandwidth-percentage-source <user | fast-reroute-object>

bandwidth-percentage-value <NUMBER: 1...100>]

[setup-hold-priority-source <user | fast-reroute-object>

setup-hold-priority-value <NUMBER: 0...7>]

[link-preference <yes | no>]

[affinity-source <user | fast-reroute-object>

< color-group-include-all <MPLS TE Admin Color Group> |

color-group-include-any <MPLS TE Admin Color Group> |

color-group-exclude-any <MPLS TE Admin Color Group> >]

[srlg-mode < maximal | strict | none>]

[force-apply]

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 318
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

mpls tunnel-auto-fb-profile unset fb-profile <auto-fb-profile-name string (1...31)>

[bandwidth-percentage-source

bandwidth-percentage-value

[setup-hold-priority-source

setup-hold-priority-value]

[affinity-source

< color-group-include-all |

color-group-include-any |

color-group-exclude-any> ]

[srlg-mode]

[link-preference]

Attributes:
ACTION ATTRIBUTES TYPE VALUES DESCRIPTION

update

profileName string

bandwidthPercentag string User fast-reroute-

eSource object

bandwidthPercentag integer 0 - 100

eValue

linkPreference string Yes

No

affinitySource string user fast-reroute-

object

affinityDisjoint string Yes

No

setupHoldPrioritySou string user fast-reroute-

rce object

setupHoldPriorityVal 0-7
ue

srlgMode string maximal strict none

ignore

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 319
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

ACTION ATTRIBUTES TYPE VALUES DESCRIPTION

colourGroupIncludeA string
ny

colourGroupIncludeA string
ll

colourGroupExclude string
Any

forceApply boolean True

False

update

profileName

bandwidthPercentag
eSource

bandwidthPercentag
eValue

linkPreference

affinitySource

affinityDisjoint

setupHoldPrioritySou
rce

setupHoldPriorityVal
ue

srlgMode

colourGroupIncludeA
ny

colourGroupIncludeA
ll

colourGroupExclude
Any

API calls to edit the Facility By Pass Profile

Use the JOB POST REST API of Network Element Configuration in MCP to invoke requests:

/configmgmt/api/v1/jobs

Request payload to update FB profile on 6x device.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 320
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Sample request:

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "fbProfileConfig",
"inputs": [
{
"data": [
{
"attributes":{
"action": "update",
"profileName":"fb_test_affinity",
"bandwidthPercentageSource":"user",
"bandwidthPercentageValue":100,
"linkPreference":"yes",
"affinitySource":"user",
"affinityDisjoint":"yes",
"setupHoldPrioritySource":"user",
"srlgMode":"maximal"
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 321
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Request payload to update FB profile on 6500 device.

Sample request:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 322
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "fbProfileConfig",
"inputs": [
{
"shelf":"81",
"group":"7",
"data": [
{
"attributes":{
"action": "update",
"profileName":"fb_test_affinity",
"bandwidthPercentageSource":"user",
"bandwidthPercentageValue":100,
"linkPreference":"yes",
"affinitySource":"user",
"affinityDisjoint":"yes",
"setupHoldPrioritySource":"user",
"srlgMode":"maximal"
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 323
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Request payload to unset FB profile on 6x device.

Sample request:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 324
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "fbProfileConfig",
"inputs": [
{
"data": [
{
"attributes":{
"action": "unset",
"profileName":"fb_test_affinity",
"bandwidthPercentageSource":null,
"bandwidthPercentageValue":null,
"linkPreference":null,
"affinitySource":null,
"affinityDisjoint":null,
"setupHoldPrioritySource":null,
"srlgMode":null
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

Request payload to unset FB profile on 6500 device.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 325
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Sample request:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 326
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "fbProfileConfig",
"inputs": [
{
"shelf":"81",
"group":"7",
"data": [
{
"attributes":{
"action": "unset",
"profileName":"fb_test_affinity",
"bandwidthPercentageSource":null,
"bandwidthPercentageValue":null,
"linkPreference":null,
"affinitySource":null,
"affinityDisjoint":null,
"setupHoldPrioritySource":null,
"srlgMode":null
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 327
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Delete the Facility By Pass Profile

Use this procedure to delete a facility-by-pass (FB) profile at the NE level for the following Network
elements:

• 6500-T and 6500-PTS (Release 13.0)

• 6x MPLS capable node 6.17.1

To delete a FB profile on the Network element, execute the CLI command:

mpls tunnel-auto-fb-profile delete auto-fb-profile <auto-fb-profile-name string>

Attributes:
Action: deleted
Attributes: profileName
Type: string
Values: none
Description: none

API calls to delete the Facility By Pass Profile

Use the JOB POST REST API of Network Element Configuration in MCP to invoke requests:

/configmgmt/api/v1/jobs

Request payload to delete FB profile on 6x device.

Sample request:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 328
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "fbProfileConfig",
"inputs": [
{
"data": [
{
"attributes":{
"action": "delete",
"profileName": "fb_profile"
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

Request payload to delete FB profile on 6500 device.

Sample request:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 329
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "fbProfileConfig",
"inputs": [
{
"shelf":"81",
"group":"7",
"data": [
{
"attributes":{
"action": "delete",
"profileName": "fb_profile"
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

Retrieve the Facility By Pass Profile

Use this procedure to retrieve a facility-by-pass (FB) profile at the NE level for the following Network
elements:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 330
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

• 6500-T and 6500-PTS (Release 13.0)

• 6x MPLS capable node 6.17.1

To display all Auto FB Profiles on the Network element, execute the CLI command:

mpls tunnel-auto-fb-profile show

To display specific Auto FB Profile on the Network element, execute the CLI command:

mpls tunnel-auto-fb-profile show auto-fb-profile <auto-fb-profile-name string>

Attributes:
Action: deleted
Attributes: profileName
Type: string
Values: none
Description: none

API calls to retrieve the Facility By Pass Profile

Use the JOB POST REST API of Network Element Configuration in MCP to invoke requests:

/configmgmt/api/v1/jobs

Request payload to display all FB profiles.

Sample request:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 331
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "fbProfileShow",
"inputs": [
{
"data": [
{
"attributes":{
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

Response to display all FB profiles on 6x device.

Sample response:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 332
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"11-9-DefaultAutoFbProfile": {
"profileName": "DefaultAutoFbProfile",
"userCount": 4,
"fbProfileIndex": 1,
"group": "9",
"shelf": "11"
},
"11-9-test_fb1": {
"profileName": "test_fb1",
"userCount": 0,
"fbProfileIndex": 2,
"group": "9",
"shelf": "11"
}
}

Response to display all FB profiles on 6500 device.

Sample response:

{
"11-9-DefaultAutoFbProfile": {
"profileName": "DefaultAutoFbProfile",
"userCount": 4,
"fbProfileIndex": 1,
"group": "9",
"shelf": "11"
},
"11-9-test_fb1": {
"profileName": "test_fb1",
"userCount": 0,
"fbProfileIndex": 2,
"group": "9",
"shelf": "11"
}
}

Request payload to display specific FB profile.

Sample request:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 333
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "fbProfileShow",
"inputs": [
{
"shelf":"81",
"group":"7",
"data": [
{
"attributes":{
"profileName":"fb_test_affinity"
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

Response to display specific FB profiles on 6x device.

Sample response:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 334
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

[
{
"linkPreference": "no",
"setupHoldPrioritySource": "user",
"setupHoldPriority": 0,
"bandwidthPercentageSource": "user",
"affinityDisjoint": "no",
"colourGroupIncludeAll": "-",
"affinitySource": "fast_reroute object",
"protectedInterface": "ipCtrl_1, ipCtrl_5, ipCtrl_6, ipCtrl_3",
"fbProfileIndex": 1,
"bandwidthPercentageValue": 0,
"profileName": "fb_test_affinity",
"colourGroupIncludeAny": "-",
"srlgMode": "none",
"colourGroupExcludeAny": "-",
"userCount": 4
}
]

Response to display specific FB profiles on 6500 device.

Sample response:

{
"11-9-DefaultAutoFbProfile": {
"linkPreference": "no",
"setupHoldPrioritySource": "user",
"setupHoldPriority": 0,
"bandwidthPercentageSource": "user",
"affinityDisjoint": "no",
"colourGroupIncludeAll": "-",
"affinitySource": "fast_reroute object",
"protectedInterface": "ipCtrl_1, ipCtrl_5, ipCtrl_6, ipCtrl_3",
"fbProfileIndex": 1,
"bandwidthPercentageValue": 0,
"profileName": "fb_test_affinity",
"colourGroupIncludeAny": "-",
"srlgMode": "none",
"colourGroupExcludeAny": "-",
"userCount": 4,
"group": "9",
"shelf": "11"
}
}

Retrieve the FRR Profile(s)

Use this procedure to retrieve the FRR profile(s).

To display all FRR Profiles on the network element, execute the CLI command:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 335
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

mpls tunnel-frr-profile show

To display specific FRR Profile on the network element, execute the CLI command:

mpls tunnel-frr-profile show frr-profile <frr-profile-name string>

Attributes:
Action: none
Attributes: profileName
Type: string
Values: none
Description: none

API calls to retrieve the FRR Profile

Use the JOB POST REST API of Network Element Configuration in MCP to invoke requests:

/configmgmt/api/v1/jobs

Request payload to display all FRR profiles.

Sample request:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 336
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "frrProfileShow",
"inputs": [
{
"data": [
{
"attributes":{
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

Response to display all FRR profiles on 6x device.

Sample response:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 337
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

[
{
"bwProtection": "no",
"nodeProtection": "no",
"protectionMethod": "facility",
"profileName": "DefaultFrrProfile",
"userCount": 0
},
{
"bwProtection": "no",
"nodeProtection": "no",
"protectionMethod": "detour",
"profileName": "frr_profile",
"userCount": 0
},
{
"bwProtection": "no",
"nodeProtection": "no",
"protectionMethod": "facility",
"profileName": "frr_prof",
"userCount": 0
}
]

Response to display all FRR profiles on 6500 device.

Sample response:

{
"11-9-DefaultFrrProfile": {
"bwProtection": "no",
"nodeProtection": "no",
"group": "9",
"shelf": "11",
"profileName": "DefaultFrrProfile",
"protectionMethod": "facility",
"userCount": 0
},
"11-9-frr_prof": {
"bwProtection": "no",
"nodeProtection": "no",
"group": "9",
"shelf": "11",
"profileName": "frr_prof",
"protectionMethod": "facility",
"userCount": 0
}
}

Request payload to display specific FRR profile.

Sample request:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 338
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "frrProfileShow",
"inputs": [
{
"shelf":"81",
"group":"7",
"data": [
{
"attributes":{
"profileName":"frr_profile"
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

Response to display specific FRR profiles on 6x device.

Sample response:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 339
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

[
{
"bwProtection": "no",
"frrProfileIndex": 2,
"setupPriority": 0,
"hopLimit": 255,
"colourGroupIncludeAll": "0",
"protectionMethod": "facility",
"bandwidth": 1000,
"nodeProtection": "no",
"holdPriority": 0,
"colourGroupIncludeAny": "0",
"colourGroupExcludeAny": "0",
"profileName": "frr_profile",
"userCount": "0"
}
]

Response to display specific FRR profiles on 6500 device.

Sample response:

{
"11-9-DefaultFrrProfile space": {
"bwProtection": "no",
"frrProfileIndex": 1,
"setupPriority": 0,
"hopLimit": 255,
"colourGroupIncludeAll": "-",
"protectionMethod": "facility",
"group": "9",
"bandwidth": 1000,
"nodeProtection": "yes",
"holdPriority": 0,
"shelf": "11",
"profileName": "frr_profile",
"colourGroupIncludeAny": "-",
"colourGroupExcludeAny": "-",
"userCount": "0"
}
}

Set/Unset the Facility By Pass Profile to an IP interface

Use this procedure to set or unset a facility-by-pass (FB) profile to an individual IP interface at the NE level
for the following Network elements:

• 6500-T and 6500-PTS (Release 13.0)

• 6x MPLS capable node 6.17.1

To set facility bypass profile to an ip interface on the Network element, execute the CLI command:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 340
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

mpls traffic-eng set ip-interface <interfaceName> frr-auto-fb-profile <AutoFbProfile>

To unset facility bypass profile to an ip interface on the Network element, execute the CLI command:

mpls traffic-eng unset ip-interface < interfaceName > frr-auto-fb-profile

Attributes:

Set facility bypass profile to an ip interface

Action: update
Attributes: interfaceName, frrAutoFbProfile
Type: string. string
Values: none, none
Description: none, none

Unset facility bypass profile to an ip interface

Action: Unset
Attributes: interfaceName
Type: string
Values: none
Description: none

API calls to set/unset the Facility By Pass Profile to an IP

interface
Use the JOB POST REST API of Network Element Configuration in MCP to invoke requests:

/configmgmt/api/v1/jobs

Request payload to set FB profile on 6x device.

Sample request:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 341
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "portInterfaceConfig",
"inputs": [
{
"data": [
"type": "ipInterfaces",
"attributes": {
"action": "update",
"interfaceName": "ip_Ctrl2",
"frrAutoFbProfile": "fb_profile"
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

Request payload to unset FB profile on 6x device.

Sample request:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 342
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "portInterfaceConfig",
"inputs": [
{
"shelf": "11",
"group": "9",
"data": [
"type": "ipInterfaces",
"attributes": {
"action": "update",
"interfaceName": "ip_Ctrl2",
"frrAutoFbProfile": "fb_profile"
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

Request payload to unset FB profile on 6500 device.

Sample request:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 343
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "portInterfaceConfig",
"inputs": [
{
"data": [
"type": "ipInterfaces",
"attributes": {
"action": "unset",
"interfaceName": "ip_Ctrl2",
"frrAutoFbProfile": null
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

Request payload to unset FB profile on 6500 device.

Sample request:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 344
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "portInterfaceConfig",
"inputs": [
{
"shelf": "11",
"group": "9",
"data": [
"type": "ipInterfaces",
"attributes": {
"action": "unset",
"interfaceName": "ip_Ctrl2",
"frrAutoFbProfile": "fb_profile"
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

Configuring a shareable SRLG list on a node

You can use the MCP REST API to assign a set of shareable Shared Risk Link Group (SRLG) values to
node supporting packet services and infrastructure. This information can then be taken into account

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 345
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

when using strict SRLG routing of dynamic MPLS corouted tunnels and unidirectional Facility Bypass (FB)
tunnels.

The list of SRLG values is optional and is entered to allow MCP to automatically identify SRLG values that
are permitted to be shared when creating co-routed tunnels, FB profiles, or FB tunnels. This shareable
SRLG is not propagated/stored to the node level and is stored only at MCP level.

For example, the shareable SRLG value can allow you to identify the ROADM risk that has has to be
shared between primary and backup even during strict SRLG diversity.

MCP will automatically detect the SRLG values being used if they are configured on the node, and will use
these for any protected, dynamic corouted MPLS tunnel with strict/mandatory diversity constraints.

Note: The SRLG value will follow the 32-bit-based mapping the operator defines instead of being a flat 32
bit integer value.

The set of shareable or permitted SRLG values is managed as a list, and so the MCP REST API allows you
to:

• set all initial values for the list

• add new values to the list
• remove values from the list
• reset the list so that it is empty

You can also use the API to query a node and retrieve the data presently contained in the list.

This topic includes the following sections:

• Preparing for the operation

• Retrieving the current SRLG list
• Replacing values in the current SRLG list
• Adding values to the SRLG list
• Removing values from the SRLG list
• Deleting all values from the SRLG list

Preparing for the operation

The API calls used to work with SRLG values on a node use a "workflow operations" model. To issue the
API calls required to interact with the SRLG lists on nodes, you must first obtain a
'MplsOperationContainer' resource ID:

GET
{BP_SERVER}/bpocore/market/api/v1/resources?exactTypeId=ifd.v2.resourceTypes.MplsOperationConta
iner

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 346
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

This call would produce a response resembling the following:

{
"items": [
{
"id": "5ad8c359-63a0-4d51-85d3-790bcd500a89",
"label": "Resource for ifd.v5.resourceTypes.MplsOperationContainer",
"resourceTypeId": "ifd.v5.resourceTypes.MplsOperationContainer",
"productId": "5ad8c341-3dd4-4b8b-86c9-951c969a8884",
"tenantId": "78bb407f-1023-4b89-a615-a4b569a00b77",
"shared": false,
"properties": {},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {
"templateResources": {}
},
"updatedAt": "2018-04-19T16:27:05.982Z",
"createdAt": "2018-04-19T16:27:05.766Z",
"autoClean": false
},
...

The required ID is shown in the 'id' field of the returned object.

You can then use this ID to issue a REST API query to start any of the SRLG operations. This is done with
a call resembling:

POST {BP_SERVER}/bpocore/market/api/v1/resources/{RID}/operations/

The call will include a JSON body particular to each type of operation, as described later.

All SRLG operations are Asynchronous. To verify whether the ongoing operation is complete, and whether
it was successful or not, you must issue GET requests using the operation ID returned by the starting
request:

GET {BP_SERVER}/bpocore/market/api/v1/resources/{RID}/operations/{OID}

where RID is the OperationContainer resource ID and OID is the Operations ID returned by the operation
request.

The 'state' field of that reply indicates if the operation is complete and 'successful' or 'failed'. If supported,
the response will also provide the replied data (e.g. SRLG value list) in the 'outputs' field (as indicated
below)

For example this call:

GET {BP_SERVER}/bpocore/market/api/v1/resources/5ad8c359-63a0-4d51-85d3-

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 347
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

790bcd500a89/operations/5ad8c3a8-0be1-469b-968a-e19925887f0a

where "5ad8c3a8-0be1-469b-968a-e19925887f0a" is the Resource and Operations IDs from previous

GET/POST request, will produce a response like the one shown below.

{
"id": "5ad8c3a8-0be1-469b-968a-e19925887f0a",
"resourceId": "5ad8c359-63a0-4d51-85d3-790bcd500a89",
"interface": "getPermittedNodalSrlg",
"inputs": {
"networkElement": {
"name": "3930_MCP_4"
}
},
"outputs": {
"srlgValues": [
{
"srlgRiskSummary": 0,
"srlgValue": "0x04400017",
"srlgRegionId": 1,
"srlgRiskValue": 23,
"srlgRiskType": "ROADM Node"
}
]
},
"state": "successful",
"reason": "",
"progress": [],
"providerData": {},
"createdAt": "2018-04-19T16:28:24.547Z",
"updatedAt": "2018-04-19T16:28:25.041Z",
"resourceStateConstraints": {},
"executionGroup": "lifecycle"
}

In the return example above, note the following:

• "srlgValues": [
◦ signifies the beginning of the SRLG values associated with the target node, in object format
• "srlgValue": "0x04400017"
◦ the full numerical value is provided along with the broken down fields
• "srlgRiskType": "ROADM Node"
◦ note the enum-name translation of the numerical value
• "state": "successful",
◦ must ensure the state is successfull, if executing, must poll anew

When initiating an IFD Operation, a JSON-structured body is given with two fields;

'interface' names the operation to be performed, and 'inputs' is a structure whose fields provide the
parameters to the operation.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 348
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

The values of those fields depends on the operation to be performed.

Retrieving the current SRLG list

The IFD operation (interface) to retrieve the current Permitted Nodal SRLG values for a given node is
'getPermittedNodalSrlg'.

The provided 'inputs' has one field, 'networkElement', with one sub-field 'name' idenfying the target node.

The successful reply ('outputs') also contains one field, 'srlgValues', which is a list of SRLG objects as
shown in earlier examples (for example [ {'srlgRiskType': 'ROADM Node', …}, … ] ). If no SRLG values are
present, or if the values cannot be retrieved for any reason, an empty list is returned. If values are present,
note that the individual elements of the list will provide all the fields interpreted from the SRLG value by
the schema, as well as the 'srlgValue' field with the numerical form of the value.

For example, a call to retrieve the current set of SRLG values stored on a node would resemble the
following:

POST {BP_SERVER}/bpocore/market/api/v1/resources/5ad8c359-63a0-4d51-85d3-
790bcd500a89/operations

where "5ad8c359-63a0-4d51-85d3-790bcd500a89" is a Resource ID obtained from a previous GET

request, would include the following:

{
"interface": "getPermittedNodalSrlg",
"inputs": {
"networkElement": {
"name": "3930_MCP_4"
}
}
}

This would result in a response resembling the following:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 349
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"id": "5ad8c6aa-803e-42bf-a8aa-fedb6e5a8ec1",
"resourceId": "5ad8c359-63a0-4d51-85d3-790bcd500a89",
"interface": "getNodalSrlg",
"inputs": {
"networkElement": {
"name": "3930_MCP_4"
}
},
"outputs": {},
"state": "requested",
"reason": "",
"progress": [],
"providerData": {},
"createdAt": "2018-04-19T16:41:14.288Z",
"updatedAt": "2018-04-19T16:41:14.288Z",
"resourceStateConstraints": {},
"executionGroup": "lifecycle"
}

Replacing values in the current SRLG list

The IFD operation (interface) to update the current Permitted Nodal SRLG values for a given node is
'updatePermittedNodalSrlg'.

The provided 'inputs' has three fields:

• 'networkElement'/'name', the target node identified by name,

• 'operation', is 'add', 'remove', 'replace', or 'delete', and
• 'srglValues', is a list of SRLG objects (same as for the get), not needed for 'delete'.

For the 'replace' action, the list of given SRLG values included in the call will replace the list of SRLG
values current stored on the target node. If the list on the node contains no values, then these values
simply populate the list.

For example:

POST {BP_SERVER}/bpocore/market/api/v1/resources/5ad8e33d-ca63-4830-b677-
ca7d918bcb2d/operations

where 5ad8e33d-ca63-4830-b677-ca7d918bcb2d is theResource ID from previous GET request, would

include the following:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 350
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"interface": "updatePermittedNodalSrlg",
"inputs": {
"networkElement": {
"name": "3930_MCP_4"
},
"operation": "replace",
"srlgValues": [
{
"srlgRiskSummary": 0,
"srlgRegionId": 1,
"srlgRiskValue": 255,
"srlgRiskType": "ROADM Node"
}
]
}
}

This response to this call would resemble the following:

{
"id": "5ad8e3d2-d779-41ab-be35-dc44f4e53eb8",
"resourceId": "5ad8e33d-ca63-4830-b677-ca7d918bcb2d",
"interface": "updatePermittedNodalSrlg",
"inputs": {
"networkElement": {
"name": "3930_MCP_4"
},
"operation": "replace",
"srlgValues": [
{
"srlgRiskSummary": 0,
"srlgRegionId": 1,
"srlgRiskValue": 255,
"srlgRiskType": "ROADM Node"
}
]
},
"outputs": {},
"state": "requested",
"reason": "",
"progress": [],
"providerData": {},
"createdAt": "2018-04-19T18:45:39.017Z",
"updatedAt": "2018-04-19T18:45:39.017Z",
"resourceStateConstraints": {},
"executionGroup": "lifecycle"
}

The following call:

GET {BP_SERVER}/bpocore/market/api/v1/resources/5ad8e33d-ca63-4830-b677-
ca7d918bcb2d/operations/5ad8e3d2-d779-41ab-be35-dc44f4e53eb8

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 351
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

where 5ad8e33d-ca63-4830-b677-ca7d918bcb2d and 5ad8e3d2-d779-41ab-be35-dc44f4e53eb8 are the

Resource and Operations IDs from previous GET/POST request, would result in a response that
resembled the following:

{
"id": "5ad8e3d2-d779-41ab-be35-dc44f4e53eb8",
"resourceId": "5ad8e33d-ca63-4830-b677-ca7d918bcb2d",
"interface": "updatePermittedNodalSrlg",
"inputs": {
"networkElement": {
"name": "3930_MCP_4"
},
"operation": "replace",
"srlgValues": [
{
"srlgRiskSummary": 0,
"srlgRegionId": 1,
"srlgRiskValue": 255,
"srlgRiskType": "ROADM Node"
}
]
},
"outputs": {
"srlgValues": [
{
"srlgRiskSummary": 0,
"srlgValue": "0x044000ff",
"srlgRegionId": 1,
"srlgRiskValue": 255,
"srlgRiskType": "ROADM Node"
}
]
},
"state": "successful",
"reason": "",
"progress": [],
"providerData": {},
"createdAt": "2018-04-19T18:45:39.017Z",
"updatedAt": "2018-04-19T18:45:39.518Z",
"resourceStateConstraints": {},
"executionGroup": "lifecycle"
}

Adding values to the SRLG list

For the 'add' action, the specified values are added to those already in the SRLG list on the node (if any).
For example the following call:

POST {BP_SERVER}/bpocore/market/api/v1/resources/5ad8e33d-ca63-4830-b677-
ca7d918bcb2d/operations

where 5ad8e33d-ca63-4830-b677-ca7d918bcb2d/ is the Resource ID from a previous GET request, would

include the following:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 352
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"interface": "updatePermittedNodalSrlg",
"inputs": {
"networkElement": {
"name": "3930_MCP_4"
},
"operation": "add",
"srlgValues": [
{
"srlgRiskSummary": 0,
"srlgRegionId": 1,
"srlgRiskValue": 22,
"srlgRiskType": "Card"
}
]
}
}

And the response would resemble the following:

{
"id": "5ad8e496-22c0-4ad3-aa4d-001161ed5378",
"resourceId": "5ad8e33d-ca63-4830-b677-ca7d918bcb2d",
"interface": "updatePermittedNodalSrlg",
"inputs": {
"networkElement": {
"name": "3930_MCP_4"
},
"operation": "add",
"srlgValues": [
{
"srlgRiskSummary": 0,
"srlgRegionId": 1,
"srlgRiskValue": 22,
"srlgRiskType": "Card"
}
]
},
"outputs": {},
"state": "requested",
"reason": "",
"progress": [],
"providerData": {},
"createdAt": "2018-04-19T18:48:54.127Z",
"updatedAt": "2018-04-19T18:48:54.127Z",
"resourceStateConstraints": {},
"executionGroup": "lifecycle"
}

The following call:

GET {BP_SERVER}/bpocore/market/api/v1/resources/5ad8e33d-ca63-4830-b677-
ca7d918bcb2d/operations/5ad8e496-22c0-4ad3-aa4d-001161ed5378

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 353
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

where 5ad8e33d-ca63-4830-b677-ca7d918bcb2d and 5ad8e496-22c0-4ad3-aa4d-001161ed5378 are the

Resource and Operations IDs from a previous GET/POST request, would result in a response resembling
the following:

{
"id": "5ad8e496-22c0-4ad3-aa4d-001161ed5378",
"resourceId": "5ad8e33d-ca63-4830-b677-ca7d918bcb2d",
"interface": "updatePermittedNodalSrlg",
"inputs": {
"networkElement": {
"name": "3930_MCP_4"
},
"operation": "add",
"srlgValues": [
{
"srlgRiskSummary": 0,
"srlgRegionId": 1,
"srlgRiskValue": 22,
"srlgRiskType": "Card"
}
]
},
"outputs": {
"srlgValues": [
{
"srlgRiskSummary": 0,
"srlgValue": "0x044000ff",
"srlgRegionId": 1,
"srlgRiskValue": 255,
"srlgRiskType": "ROADM Node"
},
{
"srlgRiskSummary": 0,
"srlgValue": "0x05800016",
"srlgRegionId": 1,
"srlgRiskValue": 22,
"srlgRiskType": "Card"
}
]
},
"state": "successful",
"reason": "",
"progress": [],
"providerData": {},
"createdAt": "2018-04-19T18:48:54.127Z",
"updatedAt": "2018-04-19T18:48:54.794Z",
"resourceStateConstraints": {},
"executionGroup": "lifecycle"
}

Removing values from the SRLG list

For the 'remove' action, the values given in 'srlgValues' are removed from the list associated with the
target node if they are present, and other values are left intact.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 354
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

For example the following call:

POST {BP_SERVER}/bpocore/market/api/v1/resources/5ad8e33d-ca63-4830-b677-
ca7d918bcb2d/operations

in which 5ad8e33d-ca63-4830-b677-ca7d918bcb2d is the Resource ID from previous GET request, would

include the following:

{
"interface": "updatePermittedNodalSrlg",
"inputs": {
"networkElement": {
"name": "3930_MCP_4"
},
"operation": "remove",
"srlgValues": [
{
"srlgRiskSummary": 0,
"srlgRegionId": 1,
"srlgRiskValue": 255,
"srlgRiskType": "ROADM Node"
}
]
}
}

This call would result in a response resembling the following:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 355
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"id": "5ad8e5ec-f970-4934-96e4-2aeb1b437311",
"resourceId": "5ad8e33d-ca63-4830-b677-ca7d918bcb2d",
"interface": "updatePermittedNodalSrlg",
"inputs": {
"networkElement": {
"name": "3930_MCP_4"
},
"operation": "remove",
"srlgValues": [
{
"srlgRiskSummary": 0,
"srlgRegionId": 1,
"srlgRiskValue": 255,
"srlgRiskType": "ROADM Node"
}
]
},
"outputs": {},
"state": "requested",
"reason": "",
"progress": [],
"providerData": {},
"createdAt": "2018-04-19T18:54:36.624Z",
"updatedAt": "2018-04-19T18:54:36.624Z",
"resourceStateConstraints": {},
"executionGroup": "lifecycle"
}

The following call:

GET {BP_SERVER}/bpocore/market/api/v1/resources/5ad8e33d-ca63-4830-b677-
ca7d918bcb2d/operations/5ad8e5ec-f970-4934-96e4-2aeb1b437311

where resources/5ad8e33d-ca63-4830-b677-ca7d918bcb2d and 5ad8e5ec-f970-4934-96e4-

2aeb1b437311 are the Resource and Operations IDs from previous GET/POST request, would result in a
response like the following:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 356
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"id": "5ad8e5ec-f970-4934-96e4-2aeb1b437311",
"resourceId": "5ad8e33d-ca63-4830-b677-ca7d918bcb2d",
"interface": "updatePermittedNodalSrlg",
"inputs": {
"networkElement": {
"name": "3930_MCP_4"
},
"operation": "remove",
"srlgValues": [
{
"srlgRiskSummary": 0,
"srlgRegionId": 1,
"srlgRiskValue": 255,
"srlgRiskType": "ROADM Node"
}
]
},
"outputs": {
"srlgValues": [
{
"srlgRiskSummary": 0,
"srlgValue": "0x05800016",
"srlgRegionId": 1,
"srlgRiskValue": 22,
"srlgRiskType": "Card"
}
]
},
"state": "successful",
"reason": "",
"progress": [],
"providerData": {},
"createdAt": "2018-04-19T18:54:36.624Z",
"updatedAt": "2018-04-19T18:54:37.112Z",
"resourceStateConstraints": {},
"executionGroup": "lifecycle"
}

Deleting all values from the SRLG list

For the 'delete' action, no 'srlgValues' is included in 'inputs' and all current SRLG values associated with
the target node are removed.

For example the following call:

POST {BP_SERVER}/bpocore/market/api/v1/resources/5ad8e33d-ca63-4830-b677-
ca7d918bcb2d/operations

in which 5ad8e33d-ca63-4830-b677-ca7d918bcb2d is the Resource ID from previous GET request, would

include the following:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 357
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"interface": "updatePermittedNodalSrlg",
"inputs": {
"networkElement": {
"name": "3930_MCP_4"
},
"operation": "delete"
}
}

This call would produce a response that resembles the following:

{
"id": "5ad8e6d6-346b-48ed-ab00-9e451798c2df",
"resourceId": "5ad8e33d-ca63-4830-b677-ca7d918bcb2d",
"interface": "updatePermittedNodalSrlg",
"inputs": {
"networkElement": {
"name": "3930_MCP_4"
},
"operation": "delete"
},
"outputs": {},
"state": "requested",
"reason": "",
"progress": [],
"providerData": {},
"createdAt": "2018-04-19T18:58:30.504Z",
"updatedAt": "2018-04-19T18:58:30.504Z",
"resourceStateConstraints": {},
"executionGroup": "lifecycle"
}

The following call:

GET {BP_SERVER}/bpocore/market/api/v1/resources/5ad8e33d-ca63-4830-b677-
ca7d918bcb2d/operations/5ad8e6d6-346b-48ed-ab00-9e451798c2df

in which 5ad8e33d-ca63-4830-b677-ca7d918bcb2d and 5ad8e6d6-346b-48ed-ab00-9e451798c2df ar

ethe Resource and Operations IDs from a previous GET/POST request, would produce a result that
resembled the following:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 358
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"id": "5ad8e6d6-346b-48ed-ab00-9e451798c2df",
"resourceId": "5ad8e33d-ca63-4830-b677-ca7d918bcb2d",
"interface": "updatePermittedNodalSrlg",
"inputs": {
"networkElement": {
"name": "3930_MCP_4"
},
"operation": "delete"
},
"outputs": {
"srlgValues": []
},
"state": "successful",
"reason": "",
"progress": [],
"providerData": {},
"createdAt": "2018-04-19T18:58:30.504Z",
"updatedAt": "2018-04-19T18:58:31.024Z",
"resourceStateConstraints": {},
"executionGroup": "lifecycle"
}

Configure Traffic Engineering (TE) parameters for an IP

interface
You can use the MCP REST API to configure Traffic Engineering parameters for an IP interface, including:

• SRLG
• Link Cost
• Link Cost
• Affinity values

The MPLS control plane can use these properties when computing optimal network paths.

This topic includes the following sections:

• SRLG Attributes
• Updating an SRLG value
• Updating multiple SRLG values
• Updating SRLG value ranges
• Un-setting an SRLG value
• Adding an SRLG value
• Removing an SRLG value

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 359
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

SRLG Attributes
When setting SRLG values, the API call uses the following attributes:

ACTION ATTRIBUTES TYPE VALUES DESCRIPTION

update

srlValues List contains SRLG

values

srlgRegionId integer

srlgRiskType integer

srlgRiskSummary integer

srlgRiskValue integer

linkCost integer

resourceColorGrou string
pName

isSrlgValuesRange boolean True False

unset

srlValues List contains SRLG

values

linkCost integer

resourceColorGrou string
pName

add/remove

srlValues List contains SRLG

values

srlgRegionId integer

srlgRiskType integer

srlgRiskSummary integer

srlgRiskValue integer

isSrlgValuesRange boolean True False

These values in an API call body, together with values for link cost, and affinity, would resemble the
following example:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 360
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"srlgValues":[
{
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 483
},
],
"linkCost": 200,
"interfaceName": "if",
"resourceColorGroupName": "tdm_color_gr"

Updating an SRLG value

A request to update an SRLG value would include a body resembling the following:

Sample request payload

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 361
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "ipInterfaceConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "update",
"srlgValues":[
{
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 483
}
],
"linkCost": 200,
"interfaceName": "if",
"resourceColorGroupName": "tdm_color_gr"
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{MANAGEMENT_SESSION_ID}"
}
]
}
}
},
"included": [
{
"id": "{MANAGEMENT_SESSION_ID}",
"type": "networkElement",
"attributes": {
"ncId": "{MANAGEMENT_SESSION_ID}",
"neName": "{NE_NAME}",
"ipAddress": "{NE_IP_ADDRESS}",
"neType": "{NE_TYPE}"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 362
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Updating multiple SRLG values

A request to update multiple SRLG values would include a body resembling the following:

Sample request payload

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "ipInterfaceConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "update",
"srlgValues":[
{
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 483
},
{
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 484
},
{
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 485
}
],
"linkCost": 200,
"interfaceName": "if",
"resourceColorGroupName": "tdm_color_gr"
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 363
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

"type": "networkConstructs",
"id": "{MANAGEMENT_SESSION_ID}"
}
]
}
}
},
"included": [
{
"id": "{MANAGEMENT_SESSION_ID}",
"type": "networkElement",
"attributes": {
"ncId": "{MANAGEMENT_SESSION_ID}",
"neName": "{NE_NAME}",
"ipAddress": "{NE_IP_ADDRESS}",
"neType": "{NE_TYPE}"
}
}
]
}

Updating SRLG value ranges

A request to update SRLG value ranges would include a body resembling the following:

Sample request payload

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "ipInterfaceConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "update",
"srlgValues":[
{
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 485
},
{
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 490
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 364
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

],
"isSrlgValuesRange": true,
"linkCost": 200,
"interfaceName": "if",
"resourceColorGroupName": "tdm_color_gr"
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{MANAGEMENT_SESSION_ID}"
}
]
}
}
},
"included": [
{
"id": "{MANAGEMENT_SESSION_ID}",
"type": "networkElement",
"attributes": {
"ncId": "{MANAGEMENT_SESSION_ID}",
"neName": "{NE_NAME}",
"ipAddress": "{NE_IP_ADDRESS}",
"neType": "{NE_TYPE}"
}
}
]
}

Un-setting an SRLG value

A request to un-set an SRLG value would include a body resembling the following:

Sample request payload

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 365
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "ipInterfaceConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "unset",
"srlgValues": null,
"linkCost": null,
"resourceColorGroupName": null,
"interfaceName": "if"
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{MANAGEMENT_SESSION_ID}"
}
]
}
}
},
"included": [
{
"id": "{MANAGEMENT_SESSION_ID}",
"type": "networkElement",
"attributes": {
"ncId": "{MANAGEMENT_SESSION_ID}",
"neName": "{NE_NAME}",
"ipAddress": "{NE_IP_ADDRESS}",
"neType": "{NE_TYPE}"
}
}
]
}

Adding an SRLG value

A request to add SRLG value would include a body resembling the following:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 366
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Sample request payload

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 367
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "ipInterfaceConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "add",
"interfaceName": "if",
"srlgValues":[
{
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 483
}
]
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{MANAGEMENT_SESSION_ID}"
}
]
}
}
},
"included": [
{
"id": "{MANAGEMENT_SESSION_ID}",
"type": "networkElement",
"attributes": {
"ncId": "{MANAGEMENT_SESSION_ID}",
"neName": "{NE_NAME}",
"ipAddress": "{NE_IP_ADDRESS}",
"neType": "{NE_TYPE}"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 368
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Removing an SRLG value

A request to remove SRLG values would include a body resembling the following:

Sample request payload

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 369
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "ipInterfaceConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "remove",
"interfaceName": "if",
"srlgValues":[
{
"srlgRegionId": 6,
"srlgRiskType": 7,
"srlgRiskSummary": 1,
"srlgRiskValue": 483
}
]
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{MANAGEMENT_SESSION_ID}"
}
]
}
}
},
"included": [
{
"id": "{MANAGEMENT_SESSION_ID}",
"type": "networkElement",
"attributes": {
"ncId": "{MANAGEMENT_SESSION_ID}",
"neName": "{NE_NAME}",
"ipAddress": "{NE_IP_ADDRESS}",
"neType": "{NE_TYPE}"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 370
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

Place a network element into or out of maintenance mode

You can use the MCP REST API to place a network element into, or out of, maintenance mode. This can
be helpful when a troubled node is generating excessive events or alarms, as these will cease once the
network element is in Maintenance Mode. Once the issue is resolved you can take the node out of
Maintenance Mode, which will cause the node to be rediscovered and resynchronized.

There are two related operations that you can invoke with this API call: "inMaintenance" and
"outMaintenance". Each will change the connectivity state of a specific node’s ManagementSession:

• inMaintenance - if the ManagementSession is currently in a CONNECTED/COMPLETED

discoveryState, this operation will initiate the process to put the network element into a Loss of
Association (LOA) state, and will disconnect the Resource Adapter (RA) session.
• outMaintenance - if the ManagementSession is currently in a FAILED state (with the Fail Reason as
"Under Maintenance"), this operation will re-initiate the enrollment process to reconnect and
resynchronize the network element.

This action uses the following API calls:

Retrieving the SessionID

The first step in managing a network element’s Maintenance Mode is to retrieve that network element’s
sessionId. You do this a a GET operation using the following call:

GET/discovery/api/v4/managementSessions

The API returns the list of management sessions and their Connection state.

Setting the Maintenance Mode

Once you have identified the sessionId of the target network element, use that value as part of the
following API call:

PATCH/discovery/api/v4/managementSessions/{sessionId}

• A device that has a connection state of COMPLETED/CONNECTED can be placed inMaintenance.

• A device that has a connection state of PENDING and a ‘failureReason’ as ‘Under Maintenance’ can be
placed outMaintenance.

In each case, the body of the API call will include an operation specifier resembling the following:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 371
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"operations" : [
{
"op": "{operationName}"
}]
}

For example:

{
"operations" : [
{
"op": "inMaintenance"
}]
}

The API response will resemble the following:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 372
Blue Planet MCP API Reference Guide, Release 18.06 Network element management

{
"data": {
"id": "0a13aa66-8d13-449d-8675-29ceb1574a30",
"type": "managementSessions",
"attributes": {
"displayData": {
"displayState": "CONNECTED"
},
"ipAddress": "10.182.129.189",
"typeGroup": "PN6x",
"name": "VAN",
"profile": "6d0419a5-0433-4a97-8708-a8e5f3951661",
"resourceType": "3930",
"discoveryState": "COMPLETED",
"enrollmentTime": "2018-09-06T11:41:57.912+0000",
"created": "2018-09-06T11:41:41.049+0000",
"lastResyncTime": "2018-09-19T09:09:35.579+0000",
"associationState": "GOA",
"pokeCount": 0,
"pokeInterval": 0,
"lastPokeTime": 0,
"failureUpdatedTime": 1537348175579,
"managementAddresses": [
"10.182.129.189",
"4.4.4.4"
],
"sessionType": "gatewayNE",
"onPreferredGNE": true,
"connectionAddress": "10.182.129.189",
"preferredConnectionAddress": {
"address": "10.182.129.189",
"cost": 0
},
"connectionStates": [
{
"protocolType": "cli",
"connectionState": "CONNECTED"
},
{
"protocolType": "snmp",
"connectionState": "CONNECTED"
}
]
},
"relationships": {
"preferredGateway": {
"data": {
"type": "managementSessions",
"id": "0a13aa66-8d13-449d-8675-29ceb1574a30"
}
}
}
}
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 373
Blue Planet MCP API Reference Guide, Release 18.06 Network element scripts

Network element scripts

You can execute custom scripts using MCP REST APIs. The following topic is covered:

• Execute a custom script with or without a profile

• Troubleshoot a network element configuration using a custom script

Execute a custom script with or without a profile

This section provides an example of how to execute a custom script with or without a profile.

Use the API to do the following:

• troubleshoot any aspect of configuration to determine whether a device has been configured correctly
• run a "show" type of command to view the results returned by the network element.

The results may be about a configuration aspect or any run time states (for example, the results of
routing tables).

Tasks include:

• Execute a custom script with a profile

Use a custom profile, if you want to use variables with specific values while executing the custom
script.

• Execute a custom script without a profile

• Get script execution result

To execute a custom script, use the Network Element Configuration API.

Examples of a custom script and a custom script profile follow.

Example of a custom script

{
"commands": [
"port set port 1 description ${description}"
]
}

Example of a custom script profile

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 374
Blue Planet MCP API Reference Guide, Release 18.06 Network element scripts

description=MCPTest2

Execute a custom script with a profile

Specify the value of input field description as userdata in relationships and included json structure. If you
also specify the profile with input field description defined in the profile, then the value of description in
userdata will override the value defined in profile.

Sample request

POST {{MCP_SERVER}}/configmgmt/api/v1/jobs

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": 10,
"scheduleTime": "2016-07-02T15:04:06Z",
"scripts": [
{
"scriptName": "cliCutThrough",
"inputs": [
{
"cmdFile": "createProfileScript1",
"protocolType": "cli"
}
],
"relationships": {
"profile": {
"data": {
"type": "profiles",
"id": "0"
}
},
"userdata": {
"data": {
"type": "userdata",
"id": "0"
}
}
}
}
]
},
"relationships": {
"connectionAttributes": {
"data": [
{
"type": "connectionAttributes",
"id": "G4218-1"
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 375
Blue Planet MCP API Reference Guide, Release 18.06 Network element scripts

}
},
"included": [
{
"id": "G4218-1",
"type": "connectionAttributes",
"attributes": {
"neName": "G4218-1",
"neType": "6500",
"typeGroup": "Ciena6500"
}
},
{
"type": "profiles",
"id": "0",
"attributes": {
"file": "cmdProfile1"
}
},
{
"type": "userdata",
"id": "0",
"attributes": {
"description": "My Test"
}
}
]
}

Sample response

{
"jobId": "bc1328ab-7649-4162-8fac-920061f5f578"
}

To obtain the result, see Get script execution result.

Execute a custom script without a profile

Specify the value of the input field description as userdata in relationships and included json structure.

Sample request

POST {{MCP_SERVER}}/configmgmt/api/v1/jobs

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 376
Blue Planet MCP API Reference Guide, Release 18.06 Network element scripts

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": 10,
"scheduleTime": "1522657184615",
"scripts": [
{
"scriptName": "cliCutThrough",
"inputs": [
{
"cmdFile": "createProfileScript1",
"protocolType": "cli"
}
],
"relationships": {
"userdata": {
"data": {
"type": "userdata",
"id": "0"
}
}
}
}
]
},
"relationships": {
"connectionAttributes": {
"data": [
{
"type": "connectionAttributes",
"id": "65SD_2124"
}
]
}
}
},
"included": [
{
"type": "userdata",
"id": "0",
"attributes": {
"description": "My Test"
}
},
{
"id": "65SD_2124",
"type": "connectionAttributes",
"attributes": {
"neName": "65SD_2124",
"neType": "6500",
"typeGroup": "Ciena6500"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 377
Blue Planet MCP API Reference Guide, Release 18.06 Network element scripts

Sample response

{
"jobId": "a0efb41c-fd37-446f-9830-bb13d855aa2a"
}

To obtain the result, see Get script execution result.

Get script execution result

Use the following request to get the execution result for the script executed using the Jobs API.

Specify the job id from the response of the POST call.

Sample request

GET {{MCP_SERVER}}/configmgmt/api/v1/jobs/{{job_id}}

Troubleshoot a network element configuration using a

custom script
This section provides an example of how to troubleshoot a network element configuration using a
custom script. You can:

• troubleshoot any aspect of a configuration (whether supported by MCP or not) to determine whether a
device has been configured correctly, and
• run a "show" type of command to view the results returned by the network element of any run time
states (for example, the results of routing tables).

Use the Network Element Configuration API to perform the following tasks:

• Request payload for executing a custom script

• Get script execution results

You can also update an aging timer to clear the results of custom scripts from the database. Use the
Global Config Service API to perform the following tasks:

• Update property — configAsyncJobsAndTasksRetentionDays

• Update property — auditOperationsRetentionDays

Two subsections follow:

• Using custom scripts

• Updating configuration properties

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 378
Blue Planet MCP API Reference Guide, Release 18.06 Network element scripts

Using custom scripts

Request payload for executing a custom script

Example formats of a requested payload

Script name is 'cliCutThrough' or 'tl1CutThrough'.

The following sample is of a CLI script.

Sample request

POST {{MCP_SERVER}}/configmgmt/api/v1/jobs

Specify the scriptName and any other attributes, as required.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 379
Blue Planet MCP API Reference Guide, Release 18.06 Network element scripts

"data": {
"type": "jobs",
"attributes": {
"maxConnections": 10,
"scheduleTime": "2016-07-02T15:04:06Z",
"scripts": [
{
"scriptName": "cliCutThrough",
"inputs": [
{
"cmdFile": "aisShow",
"protocolType": "cli"
}
]
}
]
},
"relationships": {
"connectionAttributes": {
"data": [
{
"type": "connectionAttributes",
"id": "{{NE_NAME0}}"
},
{
"type": "connectionAttributes",
"id": "{{NE_NAME1}}"
}
]
}
}
},
"included": [
{
"id": "{{NE_NAME0}}",
"type": "connectionAttributes",
"attributes": {
"neName": "{{NE_NAME0}}",
"neType": "{{NE_TYPE0}}",
"typeGroup": "{{NE_TYPE_GROUP0}}"
}
},
{
"id": "{{NE_NAME1}}",
"type": "connectionAttributes",
"attributes": {
"neName": "{{NE_NAME1}}",
"neType": "{{NE_TYPE1}}",
"typeGroup": "{{NE_TYPE_GROUP1}}"
}
}
]
}

To obtain the result, see Get script execution results.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 380
Blue Planet MCP API Reference Guide, Release 18.06 Network element scripts

Get script execution results

Use the following request to get the response of the requested payload. This sample follows from the
previous API call and relates to the execution of a CLI custom script.

Sample request

GET {{MCP_SERVER}}/configmgmt/api/v1/jobs/{{jobId}}

Specify the job Id.

Sample response

{
"jobId": "26ada294-a131-4c64-b02b-fcc4948fba50",
"status": "COMPLETED",
"input": {
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2016-07-02T15:04:06.000+0000",
"scripts": [
{
"scriptName": "cliCutThrough",
"inputs": [
{
"cmdFile": "aisShow",
"protocolType": "cli"
}
]
}
]
},
"relationships": {
"connectionAttributes": {
"data": [
{
"type": "connectionAttributes",
"id": "87_5844n3"
},
{
"type": "connectionAttributes",
"id": "87_5844n2"
}
]
}
}
},
"included": [
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 381
Blue Planet MCP API Reference Guide, Release 18.06 Network element scripts

"id": "87_5844n3",
"type": "connectionAttributes",
"attributes": {
"neName": "87_5844n3",
"neType": "8700",
"typeGroup": "PN8x"
}
},
{
"id": "87_5844n2",
"type": "connectionAttributes",
"attributes": {
"neName": "87_5844n2",
"neType": "8700",
"typeGroup": "PN8x"
}
}
]
},
"output": {
"data": {
"type": "jobResults",
"attributes": {
"scriptResults": [
{
"scriptName": "cliCutThrough",
"status": "COMPLETED",
"commandResults": [
{
"command": "cfg-clipush.json",
"result": {
"result": {
"data":
"+------------------------------------------------------------+\n+
AIS GLOBAL PARAMETERS
+\n+------------------------------------------------------------+\n| Admin
State | Enabled |\n+--------------------------
+---------------------------------+",
"result": "success"
},
"parameters": {
"commands": [
"ais show"
]
},
"command": "cfg-clipush.json"
},
"id": "87_5844n2"
},
{
"command": "cfg-clipush.json",
"result": {
"result": {
"data":
"+------------------------------------------------------------+\n+
AIS GLOBAL PARAMETERS
+\n+------------------------------------------------------------+\n| Admin
State | Enabled |\n+--------------------------
+---------------------------------+",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 382
Blue Planet MCP API Reference Guide, Release 18.06 Network element scripts

"result": "success"
},
"parameters": {
"commands": [
"ais show"
]
},
"command": "cfg-clipush.json"
},
"id": "87_5844n3"
}
]
}
]
}
}
}
}

In the above samples the cmdFile attribute in script input is aisShow. The aisShow is a cli custom script
uploaded into the system with the {{MCP_SERVER}}/configmgmt/api/v1/customScripts API

aisShow Custom Script file

{
"commands": [
"ais show"
]
}

Updating configuration properties

Update property — configAsyncJobsAndTasksRetentionDays

Use the Global Config Service API to update a property. In the following sample, the property is
'configAsyncJobsAndTasksRetentionDays'.

Sample request

POST {{MCP_SERVER}}/gcs/api/v1/config

Specify the title, name, and any other attributes, as required.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 383
Blue Planet MCP API Reference Guide, Release 18.06 Network element scripts

[
{
"title": "configAsyncJobsAndTasksRetentionDays",
"name": "configAsyncJobsAndTasksRetentionDays",
"application": "configmgmt",
"partition": "configmgmt",
"value": "2",
"description": "configAsyncJobsAndTasksRetentionDays",
"instance": "-"
}
]

Sample response

[
{
"application": "configmgmt",
"description": "configAsyncJobsAndTasksRetentionDays",
"instance": "-",
"key": "configmgmt/-/configmgmt/configAsyncJobsAndTasksRetentionDays",
"name": "configAsyncJobsAndTasksRetentionDays",
"partition": "configmgmt",
"title": "configAsyncJobsAndTasksRetentionDays",
"value": "2"
}
]

Sample request

PATCH {{MCP_SERVER}}/gcs/api/v1/config

[
{
"title": "configAsyncJobsAndTasksRetentionDays",
"name": "configAsyncJobsAndTasksRetentionDays",
"application": "configmgmt",
"partition": "configmgmt",
"value": "3",
"description": "configAsyncJobsAndTasksRetentionDays",
"instance": "-"
}
]

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 384
Blue Planet MCP API Reference Guide, Release 18.06 Network element scripts

[
{
"application": "configmgmt",
"description": "configAsyncJobsAndTasksRetentionDays",
"instance": "-",
"key": "configmgmt/-/configmgmt/configAsyncJobsAndTasksRetentionDays",
"name": "configAsyncJobsAndTasksRetentionDays",
"partition": "configmgmt",
"title": "configAsyncJobsAndTasksRetentionDays",
"value": "3"
}
]

Update property — auditOperationsRetentionDays

Use the Global Config Service API to audit a property. In the following sample, the property is
'auditOperationsRetentionDays'.

Sample request

POST {{MCP_SERVER}}/gcs/api/v1/config

Specify the title, name, and any other attributes, as required.

[
{
"title": "auditOperationsRetentionDays",
"name": "auditOperationsRetentionDays",
"application": "configmgmt",
"partition": "configmgmt",
"value": "2",
"description": "auditOperationsRetentionDays",
"instance": "-"
}
]

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 385
Blue Planet MCP API Reference Guide, Release 18.06 Network element scripts

[
{
"application": "configmgmt",
"description": "auditOperationsRetentionDays",
"instance": "-",
"key": "configmgmt/-/configmgmt/auditOperationsRetentionDays",
"name": "auditOperationsRetentionDays",
"partition": "configmgmt",
"title": "auditOperationsRetentionDays",
"value": "2"
}
]

Sample request

PATCH {{MCP_SERVER}}/gcs/api/v1/config

[
{
"title": "auditOperationsRetentionDays",
"name": "auditOperationsRetentionDays",
"application": "configmgmt",
"partition": "configmgmt",
"value": "3",
"description": "auditOperationsRetentionDays",
"instance": "-"
}
]

Sample response

[
{
"application": "configmgmt",
"description": "auditOperationsRetentionDays",
"instance": "-",
"key": "configmgmt/-/configmgmt/auditOperationsRetentionDays",
"name": "auditOperationsRetentionDays",
"partition": "configmgmt",
"title": "auditOperationsRetentionDays",
"value": "3"
}
]

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 386
Blue Planet MCP API Reference Guide, Release 18.06 Equipment management

Equipment management
You can manage equipment using MCP REST APIs. The following topics are covered:

• Retrieve an equipment inventory

• Retrieve heat dissipation reports

Retrieve an equipment inventory

To retrieve equipment for an inventory, use the Equipment API.

Requirements

You must specify a Network Construct identifier, such as 2d7104cc-5add-3497-81f3-

2baf742e14a0::EQPT_1 . All other input parameters are optional.

Sample request

GET {{MCP_SERVER}}/nsi/api/equipment

Sample response

{
"data": [
{
"id": "2d7104cc-5add-3497-81f3-2baf742e14a0::EQPT_1",
"type": "equipment",
"attributes": {
"locations": [
{
"managementType": "tl1",
"shelf": "1"
}
],
"category": "shelf",
"nativeName": "SHELF-1",
"provisionedSpec": {
"hardwareVersion": "1",
"serialNumber": "NNTMHQDP0167",
"manufacturer": "CIENA",
"type": "6500 32-Slot Packet-Optical Shelf Assembly",
"partNumber": "NTK603AA",
"version": "REL1110Z.EY",
"displayLabels": {
"clei": "WOMNH10GRB"
},
"additionalAttributes": {
"eqpWidth": "1"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 387
Blue Planet MCP API Reference Guide, Release 18.06 Equipment management

}
},
"state": "IS",
"cardType": "SHELF",
"siteName": "",
"siteId": "0",
"maintenanceMode": false,
"additionalAttributes": {
"physShelf": "0",
"bayNum": "0",
"rel": " 02 ",
"mdat": "2010-09",
"location": "",
"extendedShelf": "DISABLE",
"subnetName": "",
"primary": "ENABLE"
}
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "2d7104cc-5add-3497-81f3-2baf742e14a0"
}
},
"equipmentHolder": {
"data": {
"type": "equipmentHolders",
"id": "2d7104cc-5add-3497-81f3-2baf742e14a0::EQPTHLD_1"
}
}
}
},
{
"id": "2d7104cc-5add-3497-81f3-2baf742e14a0::EQPT_1_10",
"type": "equipment",
"attributes": {
"locations": [
{
"managementType": "tl1",
"shelf": "1",
"slot": "10"
}
],
"category": "shelf",
"nativeName": "XC-1-10",
"provisionedSpec": {
"hardwareVersion": "1",
"manufacturer": "CIENA",
"type": "X-Conn 3200G PKT/OTN Type 2",
"partNumber": "NTK616BA",
"additionalAttributes": {
"eqpWidth": "1"
}
},
"state": "OOS",
"secondaryState": "UEQ",
"cardType": "XC",
"maintenanceMode": false,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 388
Blue Planet MCP API Reference Guide, Release 18.06 Equipment management

"additionalAttributes": {
"eqptGroupId": "EQPTGRP-1-9"
}
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "2d7104cc-5add-3497-81f3-2baf742e14a0"
}
},
"equipmentHolder": {
"data": {
"type": "equipmentHolders",
"id": "2d7104cc-5add-3497-81f3-2baf742e14a0::EQPTHLD_1_10"
}
}
}
},

...

{
"id": "2d7104cc-5add-3497-81f3-2baf742e14a0::EQPT_1_FAN_46",
"type": "equipment",
"attributes": {
"locations": [
{
"managementType": "tl1",
"shelf": "1",
"subshelf": "FAN",
"slot": "46"
}
],
"category": "shelf",
"nativeName": "",
"installedSpec": {
"hardwareVersion": "1",
"serialNumber": "NNTMPV001PYT",
"manufacturer": "CIENA",
"type": "Fan",
"partNumber": "NTK607AA",
"version": " 01 ",
"displayLabels": {
"clei": "WOCUAMNMAA"
},
"additionalAttributes": {
"eqpWidth": "1"
}
},
"cardType": "FAN",
"maintenanceMode": false
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "2d7104cc-5add-3497-81f3-2baf742e14a0"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 389
Blue Planet MCP API Reference Guide, Release 18.06 Equipment management

},
"equipmentHolder": {
"data": {
"type": "equipmentHolders",
"id": "2d7104cc-5add-3497-81f3-2baf742e14a0::EQPTHLD_1_FAN_46"
}
}
}
}
]
}

Retrieve heat dissipation reports

To retrieve heat dissipation reports, use the Equipment and Topology Planning API.

• Retrieve heat dissipation report for the full network (no parameters):

GET /equipmenttopologyplanning/api/v1/HeatDissipationReport

• Retrieve heat dissipation report by CLLI (Site Name):

GET /equipmenttopologyplanning/api/v1/HeatDissipationReport?physicalLocations=CLLI1|Site2

• Retrieve heat dissipation report for one, or more, nodes by TID:

GET /equipmenttopologyplanning/api/v1/HeatDissipationReport?tidNames=NE1|NE2

• Retrieve heat dissipation report for one, or more, bays or racks within a specified TID:

GET /equipmenttopologyplanning/api/v1/HeatDissipationReport?tidNames=NE1&racks=2|3

• Retrieve heat dissipation report for one, or more, nodes by CLLI + NodeId:

GET /equipmenttopologyplanning/api/v1/HeatDissipationReport?nodeIdentities=clli1::1|clli2::2

• Retrieve heat dissipation report for one, or more, bays or racks within a specified CLLI + NodeId:

GET /equipmenttopologyplanning/api/v1/HeatDissipationReport?nodeIdentities=clli1::1&racks=1|2

Note: In All the above REST API filter-sets [i.e combinations of CLLI, Node-ID, TIDs], if you provide
combinations of valid and invalid filter-sets, response would be generated based on valid filter-sets.
However, you would not see the validation error message with respect to any invalid filter-set.

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 390
Blue Planet MCP API Reference Guide, Release 18.06 Equipment management

GET /equipmenttopologyplanning/api/v1/HeatDissipationReport

Sample response

{
"sites": [
{
"name": "SITEB2",
"tids": [
{
"nodeIdentity": {
"clli": "SITEB",
"nodeId": 2,
"tid": "SITEB2"
},
"racks": [
{
"rack": {
"mgmtAccess": "TL1_ACCESS",
"address": [
{
"key": "RACK",
"value": "1"
}
]
},
"calculatedHeatDissipationInWatts": 710,
"perShelfHeatDissipation": [
{
"physicalShelf": 1,
"calculatedHeatDissipationInWatts": 710
}
],
"heatDissipationThreshold": {
"warningThreshold": "8000",
"blockingThreshold": "10000"
},
"thresholdType": "Global"
},
{
"rack": {
"mgmtAccess": "TL1_ACCESS",
"address": [
{
"key": "RACK",
"value": "2"
}
]
},
"calculatedHeatDissipationInWatts": 827,
"perShelfHeatDissipation": [
{
"physicalShelf": 1,
"calculatedHeatDissipationInWatts": 514
},
{
"physicalShelf": 2,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 391
Blue Planet MCP API Reference Guide, Release 18.06 Equipment management

"calculatedHeatDissipationInWatts": 313
}
],
"heatDissipationThreshold": {
"warningThreshold": "8000",
"blockingThreshold": "10000"
},
"thresholdType": "Global"
}
]
}
]
},
{
"name": "SITEA1",
"tids": [
{
"nodeIdentity": {
"clli": "SITEA",
"nodeId": 1,
"tid": "SITEA1"
},
"racks": [
{
"rack": {
"mgmtAccess": "TL1_ACCESS",
"address": [
{
"key": "RACK",
"value": "1"
}
]
},
"calculatedHeatDissipationInWatts": 1105,
"perShelfHeatDissipation": [
{
"physicalShelf": 1,
"calculatedHeatDissipationInWatts": 792
},
{
"physicalShelf": 2,
"calculatedHeatDissipationInWatts": 313
}
],
"heatDissipationThresholdCrossed": "blocking",
"heatDissipationThreshold": {
"warningThreshold": "800",
"blockingThreshold": "1080"
},
"thresholdType": "Rack"
}
]
}
]
},
{
"name": "SITEC1",
"tids": [
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 392
Blue Planet MCP API Reference Guide, Release 18.06 Equipment management

"nodeIdentity": {
"clli": "SITEC",
"nodeId": 1,
"tid": "SITEC1"
},
"racks": [
{
"rack": {
"mgmtAccess": "TL1_ACCESS",
"address": [
{
"key": "RACK",
"value": "1"
}
]
},
"calculatedHeatDissipationInWatts": 1105,
"perShelfHeatDissipation": [
{
"physicalShelf": 1,
"calculatedHeatDissipationInWatts": 792
},
{
"physicalShelf": 2,
"calculatedHeatDissipationInWatts": 313
}
],
"heatDissipationThreshold": {
"warningThreshold": "8000",
"blockingThreshold": "10000"
},
"thresholdType": "Global"
}
]
}
]
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 393
Blue Planet MCP API Reference Guide, Release 18.06 Service Intent Life Cycle Phase and Deployment State

Service Intent Life Cycle Phase and

Deployment State
Blue Planet MCP supports services throughout its full life cycle from being planned,
committed/scheduled for deployment, deploying, deployed and finally undeployed/retired. Life cycle
phases are defined to represent the different phases of the services; the associated deployment states
provide additional details.

All packet and transport infrastructures and services that are provisioned through Market APIs support
the life cycle phase and deployment state feature.

The following table captures the service use cases and the associated life cycle phase and deployment
states.

Table 13. Service use cases and the associated life cycle phase and deployment states

SERVICE USE CASES SERVICE LIFE CYCLE PHASE SERVICE DEPLOYMENT STATE

Brownfield discovered services ADOPTING_DISCOVERED WAITING_TO_ADOPT

ready for adoption for MCP
management

Service endpoints are validated, WAITING_TO_DEPLOY READY_TO_DEPLOY

routed and service is scheduled
for future deployment

Service is in the process of being DEPLOYING DEPLOYMENT_IN_PROGRESS

deployed

Service failed deployment DEPLOYING INCOMPLETE_DEPLOYMENT

Service is successfully deployed DEPLOYING INCOMPLETE_NOT_READY_CON

but requested and observable FLICT
properties do not match

Service is successfully deployed ASSURING COMPLETE_FULLY_READY

and assuring/carrying traffic for
end customers

Service was successfully ASSURING INCOMPLETE_NOT_READY

deployed but was modified from
other non-MCP interfaces/craft
resulting in service topology
discrepancy

Service was successfully ASSURING INCOMPLETE_NOT_READY_CON

deployed but was modified from FLICT
other non-MCP interfaces/craft
result in service property
discrepancies

Service is in the process of being RETIRING UNDEPLOYMENT_IN_PROGRESS

un-deployed

Service failed un-deployment RETIRING INCOMPLETE_UNDEPLOYMENT

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 394
Blue Planet MCP API Reference Guide, Release 18.06 Service Intent Life Cycle Phase and Deployment State

SERVICE USE CASES SERVICE LIFE CYCLE PHASE SERVICE DEPLOYMENT STATE

Service is successfully un- RETIRING UNDEPLOYED

deployed

Note: The IFD API version numbers (for example, “v2” in “ifd.v2.resourceTypes”) that appear in this
chapter do not necessarily reflect the IFD API version numbers associated with this current Blue Planet
MCP release. They are provided only as an example. IFD API version numbers may be higher than those
shown in this chapter. For a list of supported releases and their related version numbers, see the
"Versioning" section in the MCP REST API overview chapter.

This section includes the following topics:

• Retrieve service intent life cycle phase and deployment state

Retrieve service intent life cycle phase and deployment

state
All packet and transport infrastructures and services that are provisioned through Market APIs support
the life cycle phase and deployment state feature (as described in Service use cases and the associated
life cycle phase and deployment states).

The Service intent life cycle phase and deployment state are returned as properties of Market resources
retrieved with Market resource GET APIs for all ifd.v2.resourceTypes.ServiceIntent or a specific
ServiceIntent resource by ID.

This section includes the following topics:

• Retrieve service intent life cycle phase and deployment state

• Retrieve the FREs

Retrieve service intent life cycle phase and deployment state

To retrieve Service Intent Life Cycle Phase and Deployment State, use Market API.

Sample request

GET
{{MCP_SERVER}}/bpocore/market/api/v1/resources?resourceTypeId=ifd.v2.resourceTypes.ServiceInte
nt&offset=0&limit=1000

Specify the following attribute:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 395
Blue Planet MCP API Reference Guide, Release 18.06 Service Intent Life Cycle Phase and Deployment State

• resourceTypeId

{
"items": [
{
"id": "594d6725-7b1d-46c2-aba4-a5345cad9dc3",
"label": "test-mpls-e",
"resourceTypeId": "ifd.v2.resourceTypes.MplsTunnelIntent",
"productId": "594c86cb-b1cb-46e9-9a25-5c7bbafc409e",
"tenantId": "c9806289-b7eb-4809-84e0-46b329abe68d",
"shared": false,
"properties": {
"deploymentState": "COMPLETE_FULLY_READY",
"endPoints": [
"594d6724-fd49-4936-a400-8065b2cb7631",
"594d6724-0797-403a-b768-7333a52bd2b1"
],
"sysgen_turnDownDateTime": "9999-12-31T23:59:59.999999+00:00",
"protectionType": "UNPROTECTED",
"directionality": "bidirectional",
"label": "test-mpls-e-label",
"bandwidth": {
"bookingFactor": 1,
"assignedBandwidth": 1,
"assignedBandwidthUnit": "mbps",
"bandwidthLockout": false
},
"aliasNames": [
{
"aliasType": "MANAGEMENT_NAME",
"name": "test-mpls-e"
}
],
"sysgen_turnUpDateTime": "2017-06-23T19:08:24.122010+0000",
"layerRate": "MPLS_PROTECTION",
"interactive_mode": "true",
"lifeCyclePhase": "ASSURING"
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-06-23T19:10:11.174Z",
"createdAt": "2017-06-23T19:08:21.201Z",
"autoClean": false
}
],
"total": 1,
"offset": 0,
"limit": 1000
}

Note: The same ServiceIntent with id "594d6725-7b1d-46c2-aba4-a5345cad9dc3" above can be retrieved

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 396
Blue Planet MCP API Reference Guide, Release 18.06 Service Intent Life Cycle Phase and Deployment State

with a Market GET resource with the specific resource ID.

Sample request

GET {{MCP_SERVER}}/bpocore/market/api/v1/resources/594d6725-7b1d-46c2-aba4-
a5345cad9dc3?full=false

Sample response

{
"id": "594d6725-7b1d-46c2-aba4-a5345cad9dc3",
"label": "test-mpls-e",
"resourceTypeId": "ifd.v2.resourceTypes.MplsTunnelIntent",
"productId": "594c86cb-b1cb-46e9-9a25-5c7bbafc409e",
"tenantId": "c9806289-b7eb-4809-84e0-46b329abe68d",
"shared": false,
"properties": {
"deploymentState": "COMPLETE_FULLY_READY",
"endPoints": [
"594d6724-fd49-4936-a400-8065b2cb7631",
"594d6724-0797-403a-b768-7333a52bd2b1"
],
"sysgen_turnDownDateTime": "9999-12-31T23:59:59.999999+00:00",
"protectionType": "UNPROTECTED",
"directionality": "bidirectional",
"label": "test-mpls-e-label",
"bandwidth": {
"bookingFactor": 1,
"assignedBandwidth": 1,
"assignedBandwidthUnit": "mbps",
"bandwidthLockout": false
},
"aliasNames": [
{
"aliasType": "MANAGEMENT_NAME",
"name": "test-mpls-e"
}
],
"sysgen_turnUpDateTime": "2017-06-23T19:08:24.122010+0000",
"layerRate": "MPLS_PROTECTION",
"interactive_mode": "true",
"lifeCyclePhase": "ASSURING"
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-06-23T19:10:11.174Z",
"createdAt": "2017-06-23T19:08:21.201Z",
"autoClean": false
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 397
Blue Planet MCP API Reference Guide, Release 18.06 Service Intent Life Cycle Phase and Deployment State

Retrieve the FREs

You can retrieve the FREs that realize the Service Intent "594d6725-7b1d-46c2-aba4-a5345cad9dc3" with
the Service inventory (FREs) API.

Sample request

GET {{MCP_SERVER}}/nsi/api/fres?limit=30&freExpectations.serviceIntent.id=594d6725-7b1d-46c2-
aba4-a5345cad9dc3

Specify the following attribute:

• freExpectations.serviceIntent.id

Sample response

Note the intentLifeCyclePhase "assuring" and intentDeploymentState "complete fully ready" as obtained
with the Market GET resource API above.

{
"id": "-4946399755113670964",
"type": "fres",
"attributes": {
"userLabel": "",
"mgmtName": "test-mpls-e",
"nativeName": "",
"layerRate": "MPLS_PROTECTION",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"deploymentState": "complete in network",
"active": true,
"additionalAttributes": {
"protectionRole": "primary",
"isActual": "true"
},
"derivedAttributes": {
"intentLifeCyclePhase": "assuring",
"intentDeploymentState": "complete fully ready"
},
"displayData": {
"intentLifeCyclePhaseString": "Deployed",
"intentDeploymentStateString": "Succeeded"
},
"resourceState": "plannedAndDiscovered"
},
"relationships": {
"endPoints": {
"data": [

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 398
Blue Planet MCP API Reference Guide, Release 18.06 Service Intent Life Cycle Phase and Deployment State

{
"type": "endPoints",
"id": "-4946399755113670964:1"
},
{
"type": "endPoints",
"id": "-4946399755113670964:2"
}
]
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "3e2f7c06-2329-3ab4-9f73-d98015447ccc::FRE_MPLS-
PROTECTION_test-mpls-e_headEnd"
},
{
"type": "fres",
"id": "3416064508099810071"
},
{
"type": "fres",
"id": "fe954a03-2609-3ebe-bb29-5dc73c34280a::FRE_MPLS-
PROTECTION_test-mpls-e_tailEnd"
}
]
},
"freExpectations": {
"data": [
{
"type": "freExpectations",
"id": "-4946399755113670964::594d6725-7b1d-46c2-aba4-a5345cad9dc3"
}
]
}
}
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 399
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Packet service management

This section describes some of the packet service management tasks that you can perform using MCP
REST APIs.

Release 18.06 extends Layer 2 functionality for Ethernet service and MPLS tunnel discovery, retrieval,
visualization, provisioning, and troubleshooting on the following new device releases:

• CES PN with SAOS 6.17.1

• 8700 with SAOS 8.6.0.5
• 6500 S-series 11.1.6
• 6500 S-series 12.21
• 6500 S-series 12.3
• 6500 S-series PTS with 13.0

Key extended Layer 2 functionality introduced in Release 18.06 includes:

• E-Tree services > E-Tree services over MPLS

• TDM services (CEM service discovery, inventory, retrieval, and visualization on 6500 PTS with 13.0)
• Multipoint Drop and Continue services
• L2 service creation with the option to select a custom CoS map
• L2 service creation with the option to select a custom L2 Control Frame Tunnel map
• Link retention under failure scenarios

Note: The IFD API version numbers (for example, “v2” in “ifd.v2.resourceTypes”) that appear in this
chapter do not necessarily reflect the IFD API version numbers associated with this current Blue Planet
MCP release. They are provided only as an example. IFD API version numbers may be higher than those
shown in this chapter. For a list of supported releases and their related version numbers, see the
"Versioning" section in the MCP REST API overview chapter.

This section is divided into the following sub-sections:

• Basic packet-related API calls

• API calls for managing E-Line services

• API calls for managing E-LAN services

• API calls for managing E-TREE services

• API calls for provisioning E-Access and E-Transit services

• API calls for managing TDM packet services

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 400
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

• API calls for managing packet service profiles

• API calls for editing packet services

• API calls for testing packet services

• API calls for managing packet infrasructure

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 401
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Basic packet-related API calls

This section describes the basic API calls used to view the existing packet service inventory managed by
MCP:

• Retrieve all discovered / planned Ethernet services including the related TPEs
• Retrieve a discovered / planned Ethernet service by FRE ID, including the related TPEs
• Retrieve a discovered / planned Ethernet service by FRE ID
• Retrieve all discovered / planned Ethernet services for a specific network construct
• Retrieve a discovered / planned Ethernet service by a specific name
• Retrieve L2 service intent façade product ID
• Retrieve MC-LAG service endpoints
• Retrieve configuration resources
• Using the Service Inventory with Packet services management

Retrieve all discovered / planned Ethernet services including the

related TPEs
To retrieve all Ethernet services (including the related TPEs), use the Services Inventory (FREs) API.

Note: You can also use this API call for service discovery and inventory of an E-LAN service with one of
the following endpoints: CES SAOS 6.x, 8700 SAOS 8.x, or 6500-S Packet Fabric.

Sample request

GET {{MCP_SERVER}}/nsi/api/fres

Specify the layerRate as ETHERNET and include tpes.

https://<mcphostname>/nsi/api/fres?layerRate=ETHERNET&type=service&include=tpes

Sample response

{
"links": {},
"data": {
"id": "-4403482275221078930",
"type": "fres",
"attributes": {
"userLabel": "nsiEPL2nodes251",
"mgmtName": "nsiEPL2nodes251",
"nativeName": "",
"layerRate": "ETHERNET",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 402
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"networkRole": "IFRE",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"signalContentType": "VCE",
"additionalAttributes": {
"isActual": "true"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "-4403482275221078930:1"
},
{
"type": "endPoints",
"id": "-4403482275221078930:2"
}
]
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "2c06ee34-6e8f-30a8-9f1b-4be2828ad966::FRE_EVC_nsiEPL2nodes251"
},
{
"type": "fres",
"id": "6339825355743757921"
},
{
"type": "fres",
"id": "f240cfdf-bd82-32ea-9040-1cd2fcfc29e7::FRE_EVC_nsiEPL2nodes251"
}
]
}
}
},
"included": [
{
"id": "-4403482275221078930:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "2c06ee34-6e8f-30a8-9f1b-
4be2828ad966::TPE_18_CTPServerToClient_VCE_nsiEPL2nodes251"
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 403
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

}
},

...,

}
}
}
]
}

Retrieve a discovered / planned Ethernet service by FRE ID,

including the related TPEs
To retrieve a service by FRE ID (including the related TPEs), use the Services Inventory (FREs) API.

Sample request

GET {{MCP_SERVER}}/nsi/api/fres

Specify the FRE ID and include tpes.

https://<mcp_server>/nsi/api/fres/-1154537279236972192?include=tpes

Sample response

{
"data": {
"id": "-1154537279236972192",
"type": "fres",
"attributes": {
"userLabel": "",
"mgmtName": "apMcpLsp",
"nativeName": "",
"layerRate": "MPLS_PROTECTION",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"additionalAttributes": {
"protectionRole": "All",
"signaled": "false",
"isActual": "true",
"lspName": "apMcpLsp",
"resiliency": "Normal",
"subType": "TP",
"coRouted": "true"
}
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 404
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "-1154537279236972192:1"
},
{
"type": "endPoints",
"id": "-1154537279236972192:2"
}
]
},
"decomposedFres": {
"data": [
{
"type": "fres",
"id": "8366750368065437314"
}
]
}
}
},
"included": [
{
"id": "-1154537279236972192:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "2c06ee34-6e8f-30a8-9f1b-4be2828ad966::TPE_FTP_MPLS-
PROTECTION_apMcpLsp_tailEnd"
}
]
}
}
},

...,

{
"id": "f240cfdf-bd82-32ea-9040-1cd2fcfc29e7::TPE_FTP_MPLS-
PROTECTION_apMcpLsp_headEnd",
"type": "tpes",
"attributes": {
"structureType": "FTP",
"locations": [
{
"managementType": "saos",
"tunnelRole": "headEnd",
"lspName": "apMcpLsp"
}
],

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 405
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"layerTerminations": [
{
"layerRate": "MPLS_PROTECTION",
"structureType": "exposed tcp",
"terminationState": "layer termination cannot terminate",
"active": true,
"additionalAttributes": {
"tunnelRole": "headEnd",
"tunnelType": "ingress-corouted-static",
"lspName": "apMcpLsp"
}
}
],
"stackDirection": "bidirectional",
"displayAlias": "apMcpLsp",
"fgiSpecificationRefList": [
"Packet_6x_Common_FG:1:1",
"Packet_MPLS_PW_Common_FG:1:1",
"Packet_Must_Not_Connect_ETHERNET_FG:1:1"
]
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "f240cfdf-bd82-32ea-9040-1cd2fcfc29e7"
}
},
"clientTpes": {
"data": [
{
"type": "tpes",
"id": "f240cfdf-bd82-32ea-9040-
1cd2fcfc29e7::TPE_CTPServerToClient_PW_apMcpMpls_PW_1"
}
]
}
}
}
]
}

Retrieve a discovered / planned Ethernet service by FRE ID

This section includes the following topics:

• Retrieve an ELAN service

• Retrieve an ETREE single root service
• Retrieve an ETREE dual root service

To perform these actions, use the Services Inventory (FREs) API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 406
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Retrieve an ELAN service

This API call applies to an ELAN service discovery and inventory of a mix of devices and a mix of Static
MPLS with/without QiQ spur(s)

Sample request

GET {{MCP_SERVER}}/nsi/api/fres/<FRE_ID>

Specify the FRE_ID of the ELAN service.

Sample response

{
"id": "8325238053737931966",
"type": "fres",
"attributes": {
"userLabel": "elanMix",
"mgmtName": "elanMix",
"nativeName": "",
"layerRate": "ETHERNET",
"networkRole": "IFRE",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"internalStructure": "multipoint",
"deploymentState": "discovered",
"signalContentType": "EVC",
"cfmPackages": [
{
"cfmServiceName": "elanMix",
"ccmPriority": "7",
"ccmInterval": "1",
"ccmIntervalUnit": "sec",
"cfmAdminState": "enabled",
"maName": "elanMix",
"mdName": "md4",
"mdLevel": "4",
"megId": "md4elanMix"
}
],
"active": true,
"additionalAttributes": {
"isActual": "true"
},
"derivedAttributes": {
"intentLifeCyclePhase": "adopting discovered",
"intentDeploymentState": "waiting to adopt"
},
"displayData": {
"intentLifeCyclePhaseString": "Discovered",
"intentDeploymentStateString": "Not applicable"
},
"resourceState": "discovered"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 407
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "8325238053737931966:1"
},
{
"type": "endPoints",
"id": "8325238053737931966:2"
},
{
"type": "endPoints",
"id": "8325238053737931966:3"
},
{
"type": "endPoints",
"id": "8325238053737931966:4"
}
]
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "2563070733983653934"
},
{
"type": "fres",
"id": "-2205306370477567000"
},
{
"type": "fres",
"id": "8532712b-e4e3-38a8-b480-c4859b84792f::FRE_EVC_elanMix"
},
{
"type": "fres",
"id": "-1453185902365064204"
},
{
"type": "fres",
"id": "9b846371-3ee8-3de0-96c2-c981249f67ab::FRE_EVC_elanMix"
},
{
"type": "fres",
"id": "1221571713885248970"
},
{
"type": "fres",
"id": "ca650c7d-59a3-3fcd-b202-54a178f42445::FRE_EVC_elanMix"
},
{
"type": "fres",
"id": "305acccd-6b68-3267-b274-42a56435703d::FRE_EVC_elanMix"
}
]
}
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 408
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Retrieve an ETREE single root service

This API call applies to service discovery and inventory of an ETREE single root over Static MPLS
transport only with

• MS-PW (6.x (leaf), 8700 (leaf or root), 6500 PF (leaf or root)

• SS-PW (6.x (leaf), 8700 (leaf or root), 6500 PF (leaf or root)

This API call also applies to 6200 (leaf only) - single root config - over Static MPLS.

Sample request

GET {{MCP_SERVER}}/nsi/api/fres/<FRE_ID>

Specify the FRE_ID of the ETREE service.

Sample response

Note: The endpoint "role" has a single "root". The "role" of each of the other endpoints is "leaf".

{
"data": {
"id": "1484498907288457250",
"type": "fres",
"attributes": {
"operationState": "In Service",
"deploymentState": "discovered",
"derivedAttributes": {
"intentLifeCyclePhase": "adopting discovered",
"intentDeploymentState": "waiting to adopt"
},
"displayData": {
"intentLifeCyclePhaseString": "Discovered"
},
"resourceState": "discovered",
"policies": {
"defaultAttributeSourcePolicy": "discoveredOverPlanned",
"overrides": [
{
"attributeName": "attributes.userLabel",
"policies": [
"plannedOverDiscovered"
]
}
]
},
"serviceClass": "EVC",
"userLabel": "EVP-TREE OneControl",
"mgmtName": "mcpEvTree",
"nativeName": "",
"layerRate": "ETHERNET",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 409
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"internalStructure": "hub_and_spoke",
"networkRole": "IFRE",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"adminState": "In Service",
"signalContentType": "EVC",
"cfmPackages": [
{
"cfmServiceName": "mcpEvTree",
"ccmPriority": "7",
"ccmInterval": "1",
"ccmIntervalUnit": "sec",
"cfmAdminState": "enabled",
"maName": "mcpEvTree",
"mdName": "md4",
"mdLevel": "4",
"megId": "md4mcpEvTree"
}
],

...,

"active": true,
"additionalAttributes": {
"isActual": "true"
},
"reliability": "manual"
},
"relationships": {
"freDiscovered": {
"data": {
"type": "freDiscovered",
"id": "1484498907288457250"
}
},
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "1484498907288457250:1"
},
{
"type": "endPoints",
"id": "1484498907288457250:2"
},
{
"type": "endPoints",
"id": "1484498907288457250:3"
}
]
},
"partitionFres": {
"data": [

...,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 410
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

}
}
},
"included": [
{
"id": "1484498907288457250:1",
"type": "endPoints",
"attributes": {
"role": "root",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "1dc5fc42-4d80-360c-8621-
3244fb221cfa::TPE_2_11_CTPServerToClient_SUBPORT_1_2_11_mcpEvTree_1"
}
]
}
}
},
{
"id": "1484498907288457250:2",
"type": "endPoints",
"attributes": {
"role": "leaf",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "2c06ee34-6e8f-30a8-9f1b-
4be2828ad966::TPE_6_CTPServerToClient_VCE_mcpEvTree"
}
]
}
}
},
{
"id": "1484498907288457250:3",
"type": "endPoints",
"attributes": {
"role": "leaf",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "7ef3d3b5-89ba-3120-8e14-
820eb004d696::TPE_32_CTPServerToClient_VCE_mcpEvTree"
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 411
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

}
}
]
}

Retrieve an ETREE dual root service

This API call applies to service discovery and inventory of an ETREE dual root (same node) over Static
MPLS (SS-PW / MS-PW) (6.x (leaf), 8700 (leaf or root), 6500 PF (leaf or root).

This API call also applies to 6200 (leaf only) dual root over Static MPLS.

Sample request

GET {{MCP_SERVER}}/nsi/api/fres/<FRE_ID>

Specify the FRE_ID of the ETREE service.

Sample response

Note: The endpoint "role" has two roots (each called "root"). The "role" of each of the other endpoints is
"leaf".

{
"data": {
"id": "627972058992349753",
"type": "fres",
"attributes": {
"operationState": "Out of Service",
"deploymentState": "discovered",
"derivedAttributes": {
"intentLifeCyclePhase": "adopting discovered",
"intentDeploymentState": "waiting to adopt"
},
"displayData": {
"intentLifeCyclePhaseString": "Discovered"
},
"resourceState": "discovered",
"policies": {
"defaultAttributeSourcePolicy": "discoveredOverPlanned",
"overrides": [
{
"attributeName": "attributes.userLabel",
"policies": [
"plannedOverDiscovered"
]
}
]
},
"serviceClass": "EVC",
"userLabel": "ETREE 2 Root",
"mgmtName": "Evptree2Root",
"nativeName": "",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 412
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"layerRate": "ETHERNET",
"internalStructure": "hub_and_spoke",
"networkRole": "IFRE",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"adminState": "In Service",
"signalContentType": "EVC",

...,

,
"active": true,
"additionalAttributes": {
"isActual": "true"
},
"reliability": "manual"
},
"relationships": {
"freDiscovered": {
"data": {
"type": "freDiscovered",
"id": "627972058992349753"
}
},
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "627972058992349753:1"
},
{
"type": "endPoints",
"id": "627972058992349753:2"
},
{
"type": "endPoints",
"id": "627972058992349753:3"
},
{
"type": "endPoints",
"id": "627972058992349753:4"
}
]
},
"partitionFres": {
"data": [

...,

]
}
}
},
"included": [
{
"id": "627972058992349753:1",
"type": "endPoints",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 413
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"attributes": {
"role": "root",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "1dc5fc42-4d80-360c-8621-
3244fb221cfa::TPE_2_11_CTPServerToClient_SUBPORT_1_2_11_Evptree2Root_1"
}
]
}
}
},
{
"id": "627972058992349753:2",
"type": "endPoints",
"attributes": {
"role": "root",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "1dc5fc42-4d80-360c-8621-
3244fb221cfa::TPE_2_16_CTPServerToClient_SUBPORT_1_2_16_Evptree2Root_1"
}
]
}
}
},
{
"id": "627972058992349753:3",
"type": "endPoints",
"attributes": {
"role": "leaf",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "2c06ee34-6e8f-30a8-9f1b-
4be2828ad966::TPE_7_CTPServerToClient_VCE_Evptree2Root"
}
]
}
}
},
{
"id": "627972058992349753:4",
"type": "endPoints",
"attributes": {
"role": "leaf",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 414
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "7ef3d3b5-89ba-3120-8e14-
820eb004d696::TPE_32_CTPServerToClient_VCE_Evptree2Root"
}
]
}
}
}
]
}

Retrieve all discovered / planned Ethernet services for a specific

network construct
To retrieve all tunnels, use the Services Inventory (FREs) API.

Sample request

GET {{MCP_SERVER}}/nsi/api/fres

Specify the networkConstruct ID (NC ID).

https://<mcp_server>/nsi/api/fres?networkConstruct.id=2c06ee34-6e8f-30a8-9f1b-4be2828ad966

Sample response

{
"links": {},
"data": [
{
"id": "-1154537279236972192",
"type": "fres",
"attributes": {
"userLabel": "",
"mgmtName": "apMcpLsp",
"nativeName": "",
"layerRate": "MPLS_PROTECTION",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"additionalAttributes": {
"protectionRole": "All",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 415
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"signaled": "false",
"isActual": "true",
"lspName": "apMcpLsp",
"resiliency": "Normal",
"subType": "TP",
"coRouted": "true"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "-1154537279236972192:1"
},
{
"type": "endPoints",
"id": "-1154537279236972192:2"
}
]
},
"decomposedFres": {
"data": [
{
"type": "fres",
"id": "8366750368065437314"
}
]
}
}
}
],
"included": [
{
"id": "-1154537279236972192:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "2c06ee34-6e8f-30a8-9f1b-4be2828ad966::TPE_FTP_MPLS-
PROTECTION_apMcpLsp_tailEnd"
}
]
}
}
},
{
"id": "-1154537279236972192:2",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 416
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "f240cfdf-bd82-32ea-9040-1cd2fcfc29e7::TPE_FTP_MPLS-
PROTECTION_apMcpLsp_headEnd"
}
]
}
}
}
]
}

Retrieve a discovered / planned Ethernet service by a specific

name
To retrieve a service by a specifc name, use the Services Inventory (FREs) API.

Sample request

GET {{MCP_SERVER}}/nsi/api/fres

Specify the service name.

https://<mcp_server>/nsi/api/fres?type=service&managementName=nsiEPL2nodes251

Sample response

{
"links": {},
"data": [
{
"id": "-4403482275221078930",
"type": "fres",
"attributes": {
"userLabel": "nsiEPL2nodes251",
"mgmtName": "nsiEPL2nodes251",
"nativeName": "",
"layerRate": "ETHERNET",
"networkRole": "IFRE",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"signalContentType": "VCE",
"additionalAttributes": {
"isActual": "true"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 417
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "-4403482275221078930:1"
},
{
"type": "endPoints",
"id": "-4403482275221078930:2"
}
]
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "2c06ee34-6e8f-30a8-9f1b-4be2828ad966::FRE_EVC_nsiEPL2nodes251"
},
{
"type": "fres",
"id": "6339825355743757921"
},
{
"type": "fres",
"id": "f240cfdf-bd82-32ea-9040-1cd2fcfc29e7::FRE_EVC_nsiEPL2nodes251"
}
]
}
}
},
{
"id": "2c06ee34-6e8f-30a8-9f1b-4be2828ad966::FRE_EVC_nsiEPL2nodes251",
"type": "fres",
"attributes": {
"userLabel": "nsiEPL2nodes251",
"mgmtName": "nsiEPL2nodes251",
"nativeName": "",
"layerRate": "ETHERNET",
"multiHighestStackLayerRate": "ETHERNET",
"networkRole": "IFRE",
"directionality": "bidirectional",
"topologySources": [
"discovered"
],
"operationState": "fully operating",
"deploymentState": "complete in network",
"signalContentType": "EVC",
"additionalAttributes": {
"isActual": "true",
"reservedVlan": "4007"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 418
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"id": "2c06ee34-6e8f-30a8-9f1b-
4be2828ad966::FRE_EVC_nsiEPL2nodes251::EP0"
},
{
"type": "endPoints",
"id": "2c06ee34-6e8f-30a8-9f1b-
4be2828ad966::FRE_EVC_nsiEPL2nodes251::EP1"
}
]
},
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "2c06ee34-6e8f-30a8-9f1b-4be2828ad966"
}
}
}
},

...,

{
"id": "f240cfdf-bd82-32ea-9040-1cd2fcfc29e7::FRE_EVC_nsiEPL2nodes251::EP1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "f240cfdf-bd82-32ea-9040-
1cd2fcfc29e7::TPE_3_CTPServerToClient_VCE_nsiEPL2nodes251"
}
]
}
}
}
]
}

Retrieve L2 service intent facade product ID

To retrieve the product ID of the L2 service intent facade to be used in provisioning service intents /
resources, use the Market API.

Sample request

GET {{MCP_Server}}}/bpocore/market/api/v1/products

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 419
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Sample response

{
"items": [
{
"id": "d98b75d1-bdc2-4bf1-9d59-59e680ee9d3f",
"resourceTypeId": "tosca.resourceTypes.IpVpnService",
"title": "Versa-based IP VPN Service",
"description": "A full-featured IP VPN solution for use with Versa Director
on top of VMWare.",
"active": true,
"domainId": "built-in",
"constraints": {},
"providerData": {
"template": "versa.serviceTemplates.IpVpnService"
}
},
{
"id": "f97d1a40-3ff1-5a9d-9bcc-83f65d96ef56",
"resourceTypeId": "tosca.resourceTypes.NumberPool",
"title": "Number Pool",
"description": "Creates a pool of numbers from which to assign values to
resources.",
"active": true,
"domainId": "built-in",
"constraints": {},
"providerData": {}
},
{
"id": "f3cc5de2-2df0-5fa3-869e-2409df6e5786",
"resourceTypeId": "tosca.resourceTypes.IpV4AddressPool",
"title": "IPv4 Address Pool",
"description": "A IPV4 address pool for use with DHCP servers or otherwise
assigning to resources.",
"active": true,
"domainId": "built-in",
"constraints": {},
"providerData": {}
},

... ,

{
"id": "58c33ae8-8603-44ef-b697-87a2bc4a799e",
"resourceTypeId": "ifd.v1.resourceTypes.MplsTunnelIntentFacade",
"title": "product for MplsTunnelIntentFacade",
"active": true,
"domainId": "built-in",
"constraints": {},
"providerData": {
"template": "ifd.v1.serviceTemplates.MplsTunnelIntentFacade"
}
},
{
"id": "58c33ae8-f5e1-4475-97cf-91142e24d2cf",
"resourceTypeId": "ifd.v1.resourceTypes.NodeInsertionWorkflow",
"title": "product for NodeInsertionWorkflow",
"active": true,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 420
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"domainId": "built-in",
"constraints": {},
"providerData": {
"template": "ifd.v1.serviceTemplates.NodeInsertionWorkflow"
}
},
{
"id": "58c33ae8-47b7-4c3c-86c7-c023d80b5d51",
"resourceTypeId": "ifd.v1.resourceTypes.ServicePromotionContainer",
"title": "product for ServicePromotionContainer",
"active": true,
"domainId": "built-in",
"constraints": {},
"providerData": {
"template": "ifd.v1.serviceTemplates.ServicePromotionContainer"
}
},
{
"id": "58c33ae8-760f-4a16-a920-ccc61dacafac",
"resourceTypeId": "ifd.v1.resourceTypes.LspBandwidthProfile",
"title": "product for LspBandwidthProfile",
"active": true,
"domainId": "built-in",
"constraints": {},
"providerData": {
"template": "ifd.v1.serviceTemplates.LspBandwidthProfile"
}
},
{
"id": "58c33ae8-e38e-4e69-aedc-f47c62cae505",
"resourceTypeId": "ifd.v1.resourceTypes.MplsOperationContainer",
"title": "product for MplsOperationContainer",
"active": true,
"domainId": "built-in",
"constraints": {},
"providerData": {
"template": "ifd.v1.serviceTemplates.MplsOperationContainer"
}
}
],
"total": 29,
"offset": 0,
"limit": 1000
}

Retrieve MC-LAG service endpoints

You can use the REST API retrieve a set of service endpoint ports for a packet service that includes MC-
LAG endpoints.

Sample request

The following request retrieves service endpoint ports applicable for an EVPL service, including MC-LAG

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 421
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

ports:

GET
{{MCP_SERVER}}/nsi/api/tpes?namedQuery=portsL2ApplicableEVPLWithMcLag&networkConstruct.id={
{NC_ID}}

Sample response

{
"data": [
{
"id": "46682de1-0871-3f17-9a4c-34a02cf97074::TPE_FTP_LAG_MCLAG_08_61",
"type": "tpes",
"attributes": {
"identifiers": [
{
"networkConstructId": "46682de1-0871-3f17-9a4c-34a02cf97074",
"nodalId": "46682de1-0871-3f17-9a4c-
34a02cf97074::TPE_FTP_LAG_MCLAG_08_61"
}
],
"resourceState": "discovered",
"structureType": "FTP",
"nativeName": "MCLAG_08_61",
"locations": [
{
"managementType": "saos",
"lagName": "MCLAG_08_61"
}
],
"layerTerminations": [
{
"layerRate": "LAG",
"structureType": "exposed tcp",
"terminationState": "layer termination permanently terminated",
"active": true,
"signalIndex": {},
"additionalAttributes": {
"acceptableFrameType": "all",
"multiChassis": "true",
"allPorts": "6/20",
"protectionPorts": "6/20",
"minimumLag": "disabled",
"stp": "disabled",
"mtu": "2000",
"floodContainment": "disabled",
"macAddress": "9c:7a:03:f9:83:e0",
"lagId": "4097",
"totalBandwidth": "0",
"totalBandwidthUnit": "mbps",
"lacpMode": "lacp"
}
}
],
...

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 422
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Similarly, you can retrieve service endpoint ports applicable for an EPL service including MC-LAG ports
with a call like the following:

GET
{{MCP_SERVER}}/nsi/api/tpes?namedQuery=portsL2ApplicableEPLWithMcLag&networkConstruct.id={{
NC_ID}}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 423
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": [
{
"id": "46682de1-0871-3f17-9a4c-34a02cf97074::TPE_FTP_LAG_MCLAG_08_61",
"type": "tpes",
"attributes": {
"identifiers": [
{
"networkConstructId": "46682de1-0871-3f17-9a4c-34a02cf97074",
"nodalId": "46682de1-0871-3f17-9a4c-
34a02cf97074::TPE_FTP_LAG_MCLAG_08_61"
}
],
"resourceState": "discovered",
"structureType": "FTP",
"nativeName": "MCLAG_08_61",
"locations": [
{
"managementType": "saos",
"lagName": "MCLAG_08_61"
}
],
"layerTerminations": [
{
"layerRate": "LAG",
"structureType": "exposed tcp",
"terminationState": "layer termination permanently terminated",
"active": true,
"signalIndex": {},
"additionalAttributes": {
"acceptableFrameType": "all",
"multiChassis": "true",
"allPorts": "6/20",
"protectionPorts": "6/20",
"minimumLag": "disabled",
"stp": "disabled",
"mtu": "2000",
"floodContainment": "disabled",
"macAddress": "9c:7a:03:f9:83:e0",
"lagId": "4097",
"totalBandwidth": "0",
"totalBandwidthUnit": "mbps",
"lacpMode": "lacp"
}
}
],
...

Retrieve configuration resources

To retrieve configuration resources, use the Market API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 424
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Sample request

GET MCP_SERVER/bpocore/market/api/v1/resources?exactTypeId=ifd.v4.resourceTypes.IfdConfig

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 425
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"items": [
{
"id": "58b4407b-e3b4-4627-a6be-c19bcd4f1ed3",
"label": "Ifd Config Label",
"resourceTypeId": "ifd.resourceTypes.IfdConfig",
"productId": "58b43dc6-749e-44fa-9bdb-cea4887ba820",
"tenantId": "e1e0516f-cfc8-4832-871f-ed46ad3b27b8",
"shared": false,
"properties": {
"configurationProperties": {
"ifd.l0.setExplicitFrequency": {
"default": "true",
"supportedValues": "true, false",
"value": "true"
},
"ifd.l2.truncateSubportName": {
"default": "true",
"supportedValues": "true, false",
"value": "true"
},
"ifd.l2.managementVlans": {
"default": "127",
"supportedValues": "1-4094",
"value": "127"
},
"ifd.l2.maximumTransmissionUnit": {
"default": "2000",
"supportedValues": "1-9200",
"value": "2000"
},
"ifd.l2.statusTlv": {
"default": "on",
"supportedValues": "on, off",
"value": "on"
}
}
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-02-27T15:06:37.570Z",
"createdAt": "2017-02-27T15:06:35.647Z",
"autoClean": false
}
],
"total": 1,
"offset": 0,
"limit": 1000
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 426
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Using the Service Inventory with Packet services management

This section includes the following topics:

• Retrieve a TPE / FRE including CFT, CFM attributes

• Retrieve an FRE E-ACCESS service
• Retrieve an FRE 3-point service

To perform these actions, use the Services inventory (FREs) API.

Retrieve a TPE / FRE including CFT, CFM attributes

Sample request — Get FRE

GET {{MCP_SERVER}}/nsi/api/fres/5251477270190592826

Sample response — Get FRE

{
"data": {
"id": "5251477270190592826",
"type": "fres",
"attributes": {
"userLabel": "nsiEVPL2nodeCfm",
"mgmtName": "nsiEVPL2nodeCfm",
"nativeName": "",
"layerRate": "ETHERNET",
"networkRole": "IFRE",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"deploymentState": "discovered",
"signalContentType": "EVC",
"cfmPackages": [
{
"cfmServiceName": "nsiEVPL2nodeCfm",
"ccmPriority": "7",
"ccmInterval": "1",
"ccmIntervalUnit": "sec",
"cfmAdminState": "enabled",
"maName": "nsiEVPL2nodeCfm",
"mdName": "md4",
"mdLevel": "4",
"megId": "md4nsiEVPL2nodeCfm"
}
],
"usedBandwidth": [
{
"layer": "ETHERNET",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 427
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"capacity": 1,
"capacitySize": {
"size": [
"1.0"
],
"pattern": {
"type": "POOL",
"format": "number"
},
"unit": "mbps"
}
}
],
"additionalAttributes": {
"isActual": "true"
},
"resourceState": "discovered"
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "5251477270190592826:1"
},
{
"type": "endPoints",
"id": "5251477270190592826:2"
}
]
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "976c2e3e-c33c-3763-8930-747ced188789::FRE_EVC_nsiEVPL2nodeCfm"
},
{
"type": "fres",
"id": "8155802752880622380"
},
{
"type": "fres",
"id": "be46d052-43f6-30bc-99dc-ce698d576cc7::FRE_EVC_nsiEVPL2nodeCfm"
}
]
}
}
},

Sample request — Get TPE

GET {{MCP_SERVER}}/nsi/api/tpes/ 976c2e3e-c33c-3763-8930-

747ced188789::TPE_1_1_CTPServerToClient_SUBPORT_1_1_1_nsiEVPL2nodeCfm_1

Sample response — Get TPE

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 428
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"id": "976c2e3e-c33c-3763-8930-
747ced188789::TPE_1_1_CTPServerToClient_SUBPORT_1_1_1_nsiEVPL2nodeCfm_1",
"type": "tpes",
"attributes": {
"structureType": "CTPServerToClient",
"locations": [
{
"managementType": "saos",
"slot": "1",
"port": "1",
"subport": "1_1_1_nsiEVPL2nodeCfm_1",
"vce": "nsiEVPL2nodeCfm"
}
],
"layerTerminations": [
{
"layerRate": "ETHERNET",
"structureType": "exposed lone cp",
"terminationState": "layer termination cannot terminate",
"active": true,
"cfmPackages": [
{
"cfmServiceName": "nsiEVPL2nodeCfm",
"mep": [
{
"mepId": "1",
"ccmTransmitState": "on",
"mepAdminState": "enabled",
"mepType": "up",
"mepMacAddress": "02:b6:24:67:00:10",
"ccmPriority": "7",
"vlanId": "0"
}
]
}
],
"signalIndex": {
"mappingTable": [
{
"direction": "RX",
"label": "234"
}
]
},
"additionalAttributes": {
"interfaceType": "UNI",
"ingressCosMapName": "Default_ResolvedCosProfile",
"controlFrameTunneling": "disabled",
"evcId": "nsiEVPL2nodeCfm",
"signalContentType": "VCE",
"ingressCosPolicy": "L2PcpCos"
}
}
],
"stackDirection": "bidirectional",
"displayAlias": "1-1-1_1_1_nsiEVPL2nodeCfm_1",
"identifiers": [

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 429
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"networkConstructId": "976c2e3e-c33c-3763-8930-747ced188789",
"nodalId": "976c2e3e-c33c-3763-8930-
747ced188789::TPE_1_1_CTPServerToClient_SUBPORT_1_1_1_nsiEVPL2nodeCfm_1"
}
],
"resourceState": "discovered"
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "976c2e3e-c33c-3763-8930-747ced188789"
}
},
"equipment": {
"data": {
"type": "equipment",
"id": "976c2e3e-c33c-3763-8930-747ced188789::EQPT_1_1"
}
},
"owningServerTpe": {
"data": {
"type": "tpes",
"id": "976c2e3e-c33c-3763-8930-747ced188789::TPE_1_1_PTP"
}
}
}
}
}

Retrieve an FRE E-ACCESS service

Sample request

GET {{MCP_SERVER}}/nsi/api/fres/5923233899135724614

Sample response

{
"data": {
"id": "5923233899135724614",
"type": "fres",
"attributes": {
"userLabel": "E-ACCESS",
"mgmtName": "mcpEplSS",
"nativeName": "",
"layerRate": "ETHERNET",
"networkRole": "IFRE",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"deploymentState": "discovered",
"signalContentType": "EVC",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 430
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"cfmPackages": [
{
"cfmServiceName": "mcpEplSS",
"ccmPriority": "7",
"ccmInterval": "1",
"ccmIntervalUnit": "sec",
"cfmAdminState": "enabled",
"maName": "mcpEplSS",
"mdName": "md4",
"mdLevel": "4",
"megId": "md4mcpEplSS"
}
],
"usedBandwidth": [
{
"layer": "ETHERNET",
"capacity": 1,
"capacitySize": {
"size": [
"1.0"
],
"pattern": {
"type": "POOL",
"format": "number"
},
"unit": "mbps"
}
}
],
"additionalAttributes": {
"isActual": "true"
},
"resourceState": "discovered"
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "5923233899135724614:1"
},
{
"type": "endPoints",
"id": "5923233899135724614:2"
}
]
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "d40d3557-a34d-327a-8772-e70f7ed16cc7::FRE_EVC_mcpEplSS"
},
{
"type": "fres",
"id": "478545052946224925"
},
{
"type": "fres",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 431
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"id": "e0966cda-1da0-383d-a7b4-6b96b740b0bb::FRE_EVC_mcpEplSS"
}
]
}
}
},

Retrieve an FRE 3-point service

Sample request

GET {{MCP_SERVER}}/nsi/api/fres/7703079907264562752

Sample response

{
"data": {
"id": "7703079907264562752",
"type": "fres",
"attributes": {
"userLabel": "sc3pt",
"mgmtName": "sc3pt",
"nativeName": "",
"layerRate": "ETHERNET",
"networkRole": "IFRE",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"deploymentState": "discovered",
"signalContentType": "EACCESS",
"usedBandwidth": [
{
"layer": "ETHERNET",
"capacity": 1,
"capacitySize": {
"size": [
"1.0"
],
"pattern": {
"type": "POOL",
"format": "number"
},
"unit": "mbps"
}
}
],
"additionalAttributes": {
"isActual": "true"
},
"resourceState": "discovered"
},
"relationships": {
"endPoints": {
"data": [

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 432
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"type": "endPoints",
"id": "7703079907264562752:1"
},
{
"type": "endPoints",
"id": "7703079907264562752:2"
},
{
"type": "endPoints",
"id": "7703079907264562752:3"
}
]
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "8218377d-45de-3028-9941-19df45d0008e::FRE_EVC_sc3pt"
},
{
"type": "fres",
"id": "1906330421959389233"
},
{
"type": "fres",
"id": "1dc5fc42-4d80-360c-8621-3244fb221cfa::FRE_EVC_sc3pt"
},
{
"type": "fres",
"id": "46682de1-0871-3f17-9a4c-34a02cf97074::FRE_EVC_sc3pt"
}
]
}
}
},
"included": [
{
"id": "7703079907264562752:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "1dc5fc42-4d80-360c-8621-
3244fb221cfa::TPE_1_1_CTPServerToClient_SUBPORT_1_1_sc3pt_1"
}
]
}
}
},
{
"id": "7703079907264562752:2",
"type": "endPoints",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 433
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "46682de1-0871-3f17-9a4c-
34a02cf97074::TPE_5_3_CTPServerToClient_SUBPORT_5_3_sc3pt_1"
}
]
}
}
},
{
"id": "7703079907264562752:3",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "8218377d-45de-3028-9941-
19df45d0008e::TPE_13_CTPServerToClient_VCE_sc3pt"
}
]
}
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 434
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

API calls for managing E-Line services

This section describes the API calls used retrieve, provision, and delete E-Line services:

• Provision unprot ELINE EVPL over MPLS prot/unprot tunnels with/wout QinQ spurs
• Provision unprot ELINE EPL over MPLS prot/unprot tunnels with/wout QinQ spurs
• Provision an unprotected ELINE EVPL service over Linear QinQ
• Provision an unprotected ELINE EPL service over Linear QinQ
• Provision unprotected ELINE services over MPLS transport with MS-PW excluding QinQ spurs
• Provision an E-LINE service over a unidirectional MPLS tunnel
• Provision control frame tunneling on EPL and EVPL
• Provision an E-Line service with custom CoS mapping
• Provision 2-Endpoint ELINE pseudowire protection (QinQ spurs)
• Provision a three-point E-Line service with pseudowire protection
• Provision per-EVC policing option
• Provision constraints — QinQ only
• Provision constraints — transport protection
• Provision constraints — allow QinQ segments
• Provision service OAM configuration (802.1ag and Y.1731)
• Create a packet service with Control Frame Tunneling (CFT)
• Provision the default DSCP CoS mapping
• Retrieve an ELINE service provisioning intent
• Delete an ELINE service by provisioning intent
• Modify BPO-IFD properties

Provision unprot ELINE EVPL over MPLS prot/unprot tunnels

with/wout QinQ spurs
To provision an ELINE EVPL service over MPLS transport between 5160 & 3931 nodes with a constraint to
include a specific node in the route and fixed CoS mapping with pBit of 5, use the Market API.

Note: The API call used to create a service can include the following constraints:

• constraints.transport.directionality, to constrain the service to unidirectional or bidirectional MPLS

tunnels
• constraints.transport.signal to constrain the service to use dynamic or static MPLS tunnels

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 435
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

If you omit these constraints, MCP’s Path Computation Engine (PCE) will choose a best-effort path that
can either be based on unidirectional or bi-directional LSP.

Sample request

POST {{MCP Server}}/bpocore/market/api/v1/resources

{
"productId": “58cabe48-3594-485c-8135-62ba563afe94”,
"desiredOrchState": "requested",
"label": "Facade EVPL_over_MPLS_created_from_postman",
"discovered": false,
"properties": {
"name": "TestEvplMpls_1",
"customerName": "Customer Name",
"serviceType": "EVPL",
"serverTrailList": [],
"structure": "P2P",
"type": "FDFR",
"endpoints": [
{
"settings":{
"node": "5160_0051",
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
878
]
},
"ingressCosMapping": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 5
},
"location": {
"port": "9"
}
}
]
}
]
}
]
}
},
{
"settings": {
"node": "3931_0018",
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"filter": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 436
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"outerVlanId": [
878
]
},
"ingressCosMapping": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 5
},
"location": {
"port": "4"
}
}
]
}
]
}
]
}
}
],
"routeMeta": {
"originator": "BP2"
},
"linearOnly":false
},
"routingConstraints": {
"includeRouteObjects": [
{
"objectType": "NODE_NAME",
"value": ["5150_0025"],
"constraintType": "HARD"
}
]
}
}

Sample response

{
"id": "58cae7f0-434c-40e2-b6e4-417108f47cc3",
"label": "Facade EVPL_over_MPLS_created_from_postman",
"resourceTypeId": "ifd.v1.resourceTypes.L2ServiceIntentFacade",
"productId": "58cabe48-3594-485c-8135-62ba563afe94",
"tenantId": "dd9744f5-38e1-45f6-b203-f6ee975941e7",
"shared": false,
"properties": {
"serviceType": "EVPL",
"serverTrailList": [],
"name": "TestEvplMpls_1",
"endpoints": [
{
"settings": {
"node": "5160_0051",
"role": "A_UNI",
"details": [
{
"flowSettings": [

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 437
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"filter": {
"outerVlanId": [
878
]
},
"ingressCosMapping": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 5
},
"location": {
"port": "9"
}
}
]
}
]
}
]
}
},
{
"settings": {
"node": "3931_0018",
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
878
]
},
"ingressCosMapping": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 5
},
"location": {
"port": "2"
}
}
]
}
]
}
]
}
}
],
"customerName": "Customer Name",
"routeMeta": {
"originator": "BP2"
},
"linearOnly":false
},
"routingConstraints": {
"includeRouteObjects": [
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 438
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"objectType": "NODE_NAME",
"value": ["5150_0025"],
"constraintType": "HARD"
}
]
},
"structure": "P2P",
"type": "FDFR",
"serviceState": "OUT_OF_SERVICE",
"lastTransition": "TRANSITION_NONE"
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-03-16T19:30:57.090Z",
"createdAt": "2017-03-16T19:30:57.090Z",
"autoClean": false
}

Provision unprot ELINE EPL over MPLS prot/unprot tunnels

with/wout QinQ spurs
To provision an ELINE EPL service over MPLS transport between 5160 & 3931 nodes with a constraint to
include a specific node in the route and fixed CoS mapping with pBit of 5, use the Market API.

Note: The API call used to create a service can include the following constraints:

• constraints.transport.directionality, to constrain the service to unidirectional or bidirectional MPLS

tunnels
• constraints.transport.signal to constrain the service to use dynamic or static MPLS tunnels

If you omit these constraints, MCP’s Path Computation Engine (PCE) will choose a best-effort path that
can either be based on unidirectional or bi-directional LSP.

Sample request

POST {{MCP Server}}/bpocore/market/api/v1/resources

{
"productId": “58cabe48-3594-485c-8135-62ba563afe94”,
"desiredOrchState": "requested",
"label": "Facade EPL_over_MPLS_created_from_postman",
"discovered": false,
"properties": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 439
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"name": "TestEplMpls_1",
"customerName": "Customer Name",
"serviceType": "EPL",
"serverTrailList": [],
"structure": "P2P",
"type": "FDFR",
"endpoints": [
{
"settings":{
"node": "5142_0043",
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"ingressCosMapping": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 5
},
"location": {
"port": "23"
}
}
]
}
]
}
]
}
},
{
"settings": {
"node": "3960_0011",
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"ingressCosMapping": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 5
},
"location": {
"port": "4"
}
}
]
}
]
}
]
}
}
],
"routeMeta": {
"originator": "BP2"
},
"linearOnly":false
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 440
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"routingConstraints": {
"includeRouteObjects": [
{
"objectType": "NODE_NAME",
"value": ["5150_0025"],
"constraintType": "HARD"
}
]
}
}

Sample response

{
"id": "58cae7f0-434c-40e2-b6e4-417108f47cc3",
"label": "Facade EPL_over_MPLS_created_from_postman",
"resourceTypeId": "ifd.v1.resourceTypes.L2ServiceIntentFacade",
"productId": "58cabe48-3594-485c-8135-62ba563afe94",
"tenantId": "dd9744f5-38e1-45f6-b203-f6ee975941e7",
"shared": false,
"properties": {
"serviceType": "EPL",
"serverTrailList": [],
"name": "TestEplMpls_1",
"endpoints": [
{
"settings": {
"node": "5160_0051",
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"ingressCosMapping": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 5
},
"location": {
"port": "9"
}
}
]
}
]
}
]
}
},
{
"settings": {
"node": "3931_0018",
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"ingressCosMapping": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 441
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"ingressCosPolicy": "fixed",
"ingressCosPbit": 5
},
"location": {
"port": "2"
}
}
]
}
]
}
]
}
}
],
"customerName": "Customer Name",
"routeMeta": {
"originator": "BP2"
},
"linearOnly":false
},
"routingConstraints": {
"includeRouteObjects": [
{
"objectType": "NODE_NAME",
"value": ["5150_0025"],
"constraintType": "HARD"
}
]
},
"structure": "P2P",
"type": "FDFR",
"serviceState": "OUT_OF_SERVICE",
"lastTransition": "TRANSITION_NONE"
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-03-16T19:30:57.090Z",
"createdAt": "2017-03-16T19:30:57.090Z",
"autoClean": false
}

Provision an unprotected ELINE EVPL service over Linear QinQ

To provision an ELINE EVPL service over Linear transport between 5160 & 3931 nodes with a constraint
to include a specific route, scheduled deployment, and fixed CoS mapping with pBit of 5, use the Market
API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 442
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Note: The API call used to create a service can include the following constraints:

• constraints.transport.directionality, to constrain the service to unidirectional or bidirectional MPLS

tunnels
• constraints.transport.signal to constrain the service to use dynamic or static MPLS tunnels

If you omit these constraints, MCP’s Path Computation Engine (PCE) will choose a best-effort path that
can either be based on unidirectional or bi-directional LSP.

Sample request

POST {{MCP Server}}/bpocore/market/api/v1/resources

{
"productId": “58cabe48-3594-485c-8135-62ba563afe94”,
"desiredOrchState": "requested",
"label": "Facade EVPL_over_LINEAR_created_from_postman",
"discovered": false,
"properties": {
"name": "TestEvplQinQ_1",
"customerName": "Customer Name",
"serviceType": "EVPL",
"serverTrailList": [],
"structure": "P2P",
"type": "FDFR",
"endpoints": [
{
"settings":{
"node": "5160_0051",
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
878
]
},
"ingressCosMapping": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 5
},
"location": {
"port": "9"
}
}
]
}
]
}
]
}
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 443
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"settings": {
"node": "3931_0018",
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
878
]
},
"ingressCosMapping": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 5
},
"location": {
"port": "2"
}
}
]
}
]
}
]
}
}
],
"routeMeta": {
"originator": "BP2"
},
"linearOnly":true
},
"routingConstraints": {
"includeRouteObjects": [
{
"objectType": "NODE_NAME",
"value": ["5150_0025"],
"constraintType": "HARD"
}
]
}
}

Sample response

{
"id": "58cae7f0-434c-40e2-b6e4-417108f47cc3",
"label": "Facade EVPL_over_LINEAR_created_from_postman",
"resourceTypeId": "ifd.v1.resourceTypes.L2ServiceIntentFacade",
"productId": "58cabe48-3594-485c-8135-62ba563afe94",
"tenantId": "dd9744f5-38e1-45f6-b203-f6ee975941e7",
"shared": false,
"properties": {
"serviceType": "EVPL",
"serverTrailList": [],
"name": "TestEvplQinQ_1",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 444
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"endpoints": [
{
"settings": {
"node": "5160_0051",
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
878
]
},
"ingressCosMapping": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 5
},
"location": {
"port": "9"
}
}
]
}
]
}
]
}
},
{
"settings": {
"node": "3931_0018",
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
878
]
},
"ingressCosMapping": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 5
},
"location": {
"port": "2"
}
}
]
}
]
}
]
}
}
],
"customerName": "Customer Name",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 445
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"routeMeta": {
"originator": "BP2"
},
"linearOnly":true
},
"routingConstraints": {
"includeRouteObjects": [
{
"objectType": "NODE_NAME",
"value": ["5150_0025"],
"constraintType": "HARD"
}
]
},
"structure": "P2P",
"type": "FDFR",
"serviceState": "OUT_OF_SERVICE",
"lastTransition": "TRANSITION_NONE"
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-03-16T19:30:57.090Z",
"createdAt": "2017-03-16T19:30:57.090Z",
"autoClean": false
}

Provision an unprotected ELINE EPL service over Linear QinQ

To provision an ELINE EPL service over Linear transport between 5160 & 3931 nodes with a constraint to
include a specific route, scheduled deployment, and fixed CoS mapping with pBit of 5, use the Market API.

Note: The API call used to create a service can include the following constraints:

• constraints.transport.directionality, to constrain the service to unidirectional or bidirectional MPLS

tunnels
• constraints.transport.signal to constrain the service to use dynamic or static MPLS tunnels

If you omit these constraints, MCP’s Path Computation Engine (PCE) will choose a best-effort path that
can either be based on unidirectional or bi-directional LSP.

Sample request

POST {{MCP Server}}/bpocore/market/api/v1/resources

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 446
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"productId": “58cabe48-3594-485c-8135-62ba563afe94”,
"desiredOrchState": "requested",
"label": "Facade EPL_over_LINEAR_created_from_postman",
"discovered": false,
"properties": {
"name": "TestEplQinQ_1",
"customerName": "Customer Name",
"serviceType": "EPL",
"serverTrailList": [],
"structure": "P2P",
"type": "FDFR",
"endpoints": [
{
"settings":{
"node": "5142_0043",
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"ingressCosMapping": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 5
},
"location": {
"port": "23"
}
}
]
}
]
}
]
}
},
{
"settings": {
"node": "3960_0011",
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"ingressCosMapping": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 5
},
"location": {
"port": "4"
}
}
]
}
]
}
]
}
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 447
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

],
"routeMeta": {
"originator": "BP2"
},
"linearOnly":true
},
"routingConstraints": {
"includeRouteObjects": [
{
"objectType": "NODE_NAME",
"value": ["5150_0025"],
"constraintType": "HARD"
}
]
}
}

Sample response

{
"id": "58cae7f0-434c-40e2-b6e4-417108f47cc3",
"label": "Facade EPL_over_LINEAR_created_from_postman",
"resourceTypeId": "ifd.v1.resourceTypes.L2ServiceIntentFacade",
"productId": "58cabe48-3594-485c-8135-62ba563afe94",
"tenantId": "dd9744f5-38e1-45f6-b203-f6ee975941e7",
"shared": false,
"properties": {
"serviceType": "EPL",
"serverTrailList": [],
"name": "TestEplQinQ_1",
"endpoints": [
{
"settings": {
"node": "5160_0051",
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"ingressCosMapping": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 5
},
"location": {
"port": "9"
}
}
]
}
]
}
]
}
},
{
"settings": {
"node": "3931_0018",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 448
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"ingressCosMapping": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 5
},
"location": {
"port": "2"
}
}
]
}
]
}
]
}
}
],
"customerName": "Customer Name",
"routeMeta": {
"originator": "BP2"
},
"linearOnly":true
},
"routingConstraints": {
"includeRouteObjects": [
{
"objectType": "NODE_NAME",
"value": ["5150_0025"],
"constraintType": "HARD"
}
]
},
"structure": "P2P",
"type": "FDFR",
"serviceState": "OUT_OF_SERVICE",
"lastTransition": "TRANSITION_NONE"
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-03-16T19:30:57.090Z",
"createdAt": "2017-03-16T19:30:57.090Z",
"autoClean": false
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 449
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Provision unprotected ELINE services over MPLS transport with

MS-PW excluding QinQ spurs
To provision ELINE services, use the Market API.

Note: The API call used to create a service can include the following constraints:

• constraints.transport.directionality, to constrain the service to unidirectional or bidirectional MPLS

tunnels
• constraints.transport.signal to constrain the service to use dynamic or static MPLS tunnels

If you omit these constraints, MCP’s Path Computation Engine (PCE) will choose a best-effort path that
can either be based on unidirectional or bi-directional LSP.

Sample request

POST {{MCP_SERVER}}/bpocore/market/api/v1/resources

Specify the attributes in the properties section as in the following suggestions:

• "allowQinQSpur": false
• "protectedPseudowire": false
• "transportProtection": "PROTECTED_BEST_EFFORT"

{
"productId": "{{L2_SVC_FACADE_PRODUCT_ID}}",
"properties": {
"serviceType": "EVPL",
"allowQinQSpur": false,
"name": "unpMsPw",
"protectedPseudowire": false,
"lastTransition": "TRANSITION_NONE",
"transportProtection": "PROTECTED_BEST_EFFORT",
"primaryPathConstraints": {
"includeRouteObjects": [
{
"constraintType": "HARD",
"value": [
"87_4333n5"
],
"objectType": "NODE_NAME"
}
],
"excludeRouteObjects": [
{
"constraintType": "HARD",
"value": [

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 450
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"87_4333n4"
],
"objectType": "NODE_NAME"
}
]
},
"interactive_mode": "false",
"linearOnly": false,
"routeMeta": {
"originator": "BP2"
},
"oamEnabled": false,
"endpoints": [
{
"settings": {
"node": "87_4333n6",
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
3415
]
},
"controlFrameTunneling": "disabled",
"location": {
"slot": "1",
"port": "7"
},

"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]
}
]
}
},
{
"settings": {
"node": "87_4333n7",
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
3415
]
},
"controlFrameTunneling": "disabled",
"location": {
"slot": "1",
"port": "7"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 451
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]
}
]
}
}
],
"type": "FDFR",
"structure": "P2P",
"customerName": "DefaultCustomerName"
}
}

Sample response

{
"id": "59284f5b-24d9-4973-894a-9790dcd3144d",
"resourceTypeId": "ifd.v2.resourceTypes.L2ServiceIntentFacade",
"productId": "5926fd2e-40a7-40fc-a67a-753ff87a8216",
"tenantId": "00067aa3-335d-45e8-8fd8-eff7bd16a92f",
"shared": false,
"properties": {
"serviceType": "EVPL",
"name": "unpMsPw",
"oamEnabled": false,
"allowQinQSpur": false,
"endpoints": [
{
"settings": {
"node": "87_4333n6",
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
3415
]
},
"controlFrameTunneling": "disabled",
"location": {
"slot": "1",
"port": "7"
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]
}
]
}
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 452
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"settings": {
"node": "87_4333n7",
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
3415
]
},
"controlFrameTunneling": "disabled",
"location": {
"slot": "1",
"port": "7"
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]
}
]
}
}
],
"customerName": "DefaultCustomerName",
"protectedPseudowire": false,
"transportProtection": "PROTECTED_BEST_EFFORT",
"routeMeta": {
"originator": "BP2"
},
"structure": "P2P",
"interactive_mode": "false",
"primaryPathConstraints": {
"includeRouteObjects": [
{
"constraintType": "HARD",
"value": [
"87_4333n5"
],
"objectType": "NODE_NAME"
}
],
"excludeRouteObjects": [
{
"constraintType": "HARD",
"value": [
"87_4333n4"
],
"objectType": "NODE_NAME"
}
]
},
"type": "FDFR",
"serviceState": "OUT_OF_SERVICE",
"lastTransition": "TRANSITION_NONE",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 453
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"linearOnly": false,
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-05-26T15:52:59.477Z",
"createdAt": "2017-05-26T15:52:59.477Z",
"autoClean": false
}

Note: To retrieve information, use the NSI getTPE/getFRE REST API (see Using the Service Inventory with
Packet services management. )

Provision an E-LINE service over a unidirectional MPLS tunnel

MCP supports the provisioning of E-Line services over unidirectional tunnels in much the same way they
are provisioned over bi-directional tunnels.

MCP supports dynamic MPLS unidirectional tunnels using the following devices as LER or LSRs:

• 6500-T release 13.0 both in TIDc and non-TIDc configurations

• 6500 PTS release 13.0 in non-TIDc configuration
• 5170, when MPLS capable

This topic provides examples of provisioning an E-Line service over a unidirectional tunnel. Key elements
of the API call that constrain the service to transport over a unidirectoinal tunnel are these properties:

• constraints.transport.directionality
◦ bidirectional
◦ unidirectional
• constraints.transport.signal
◦ Static
◦ Dynamic

To provision E-Line services, use the Market API.

This topic includes two sections:

• Constrain tunnel directionality when provisioning an E-Line service

• Constrain directionality and include/exclude specific LSPs

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 454
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Constrain tunnel directionality when provisioning an E-Line service

Below is an example of the API calls used to create an E-Line service that is explicitly constrained to use a
unidirectional tunnel, but is not constrained to include or exclude any specific objects.

Create the facade:

{
"productId": "{{L2_SVC_FACADE_PRODUCT_ID}}",
"properties": {
"serviceType": "EVPL",
"allowQinQSpur": false,
"name": "jmEVPL",
"protectedPseudowire": false,
"transportProtection": "UNPROTECTED_ONLY",
"linearOnly": false,
"routeMeta": {
"originator": "BP2"
},
"oamEnabled": false,
"type": "FDFR",
"structure": "P2P",
"endpoints": [
{
"settings": {
"node": "SIM1",
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"location": {
"shelf": "1",
"eqptGrp": "41",
"slot": "2",
"port": "20"
},
"filter": {
"outerVlanId": [
781
]
}
}
]
}
]
}
},
{
"settings": {
"node": "SIM2",
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 455
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"location": {
"shelf": "1",
"eqptGrp": "41",
"slot": "1",
"port": "20"
},
"filter": {
"outerVlanId": [
781
]
}
}
]
}
]
}
}
],
"constraints": {
"transport": {
"directionality": "unidirectional",
"signal": "Dynamic"
}
}
}
}

Constrain directionality and include/exclude specific LSPs

You can also use the Constraints block of the API call to require specific LSPs to be included in the
service path, and specify those that should be included in each direction. The following call constrains the
service path:

• to use unidirectional, unprotected dynamic tunnels

• to strictly include the node SIM2 and the LSP sim1sim2 on the A to Z path
• to strictly use the LSP sim2sim1 on the Z to A path.

Create the facade:

{
"productId": "{{L2_SVC_FACADE_PRODUCT_ID}}",
"properties": {
"serviceType": "EVPL",
"allowQinQSpur": false,
"name": "jmEVPL",
"protectedPseudowire": false,
"transportProtection": "PROTECTED_ONLY",
"linearOnly": false,
"routeMeta": {
"originator": "BP2"
},
"oamEnabled": false,
"type": "FDFR",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 456
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"structure": "P2P",
"endpoints": [
{
"settings": {
"node": "SIM1",
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"location": {
"shelf": "1",
"eqptGrp": "41",
"slot": "2",
"port": "20"
},
"filter": {
"outerVlanId": [
781
]
}
}
]
}
]
}
},
{
"settings": {
"node": "SIM2",
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"location": {
"shelf": "1",
"eqptGrp": "41",
"slot": "1",
"port": "20"
},
"filter": {
"outerVlanId": [
781
]
}
}
]
}
]
}
}
],
"constraints": {
"transport": {
"directionality": "unidirectional",
"signal": "Dynamic"
},
"routes": [{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 457
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"protection": "UNPROTECTED",
"direction": ["A", "Z"],
"includeRouteObjects": [{
"constraintType": "HARD",
"locations": [{
"nodeName": "SIM2",
"lspName": "sim1sim2"
}
],
"objectType": "LSP_NAME"
}
]
}, {
"protection": "UNPROTECTED",
"direction": ["Z", "A"],
"includeRouteObjects": [{
"constraintType": "HARD",
"locations": [{
"nodeName": "SIM1",
"lspName": "sim2sim1"

}
],
"objectType": "NODE_NAME"
}
]
}
]
}
}
}

Provision control frame tunneling on EPL and EVPL

To provision the control frame tunneling option on EPL or EVPL, use the Market API.

Sample request

POST {{MCP_SERVER}}/bpocore/market/api/v1/resources

Specify the following attribute:

• "controlFrameTunneling": "enabled"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 458
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"productId": "{{L2T_PRODUCT_ID}}",
"label": "L2 EVPL Layer Termination A",
"discovered": false,
"properties":
{
"layerRate": "ETHERNET",
"evcPortType": "MAPPED",
"interfaceType": "UNI",
"signalIndex": {
"mappingTable": [
{ "label": "402" }
]
},
"ingressCosSetting": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 5
},
"ingressPolicer": {
"cir": 1000,
"eir": 500,
"cbs": 200,
"ebs": 100
},
"controlFrameTunneling": "enabled"
}

Sample response

No textual response except the HTTP status code

Note: To retrieve information, use the NSI getTPE/getFRE REST API (see Using the Service Inventory with
Packet services management. )

Provision an E-Line service with custom Class of Service (CoS)

mapping
You can use the MCP API to specify a customized CoS setting at each endpoint of a service during
service provisioning.

Note: You can include the same parameters when adding an endpoint to an E-LAN service to configure
the new endpoint to use a customized CoS mapping.

You might want to use a customized CoS mapping to rearrange adjacent service provider CoS, or to
merge together existing CoS mappings. (For example, on a SAOS 6x platform a PBit of 0 and DEI of 0 are
transparently mapped to an internal CoS of 0 and color of 0 in the default map. You might want to use a
customized mapping to group both PBit 0 and PBit 1, and map them to an internal CoS of 1)

The CoS maps you refer to using this API call must have already been created on the device.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 459
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Use the Market API to provision a service with a custom CoS mapping.

Sample request:

POST {{MCP_SERVER}}/bpocore/market/api/v1/resources

Note that in the following API calls:

• L2_SVC_FACADE_PRODUCT_ID is a product ID to create Layer-2 Service in Facade.

• SVC_RSC_ID is the Facade resource ID of the Layer-2 service.

Note in particular the following CoS parameters for the service endpoints the sample call provided below:

"ingressCosSetting": { "ingressCosPolicy": "L2PcpCos"

"ingressCosSetting": { "ingressCosPolicy": "custom", "ingressCosMapName": "CustomCosMap"

Sample request:

{
"productId": "{{L2_SVC_FACADE_PRODUCT_ID}}",
"properties": {
"serverTrailList": [],
"serviceType": "EVPL",
"name": "EVPLCustomCoS",
"type": "FDFR",
"structure": "P2P",
"customerName": "DefaultCustomerName",
"routeMeta": {
"originator": "BP2"
},
"endpoints": [
{
"settings": {
"node": "3938_0032",
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
781
]
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
},
"location": {
"port": "1"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 460
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

}
]
}
]
}
},
{
"settings": {
"node": "5142_0049",
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
781
]
},
"ingressCosSetting": {
"ingressCosPolicy": "custom",
"ingressCosMapName": "CustomCosMap"
},
"location": {
"port": "19"
}
}
]
}
]
}
}
]
}
}

Sample response

{
"id": "5b327718-e9fb-49bf-8abe-f7c8a75f6724",
"resourceTypeId": "ifd.v5.resourceTypes.L2ServiceIntentFacade",
"productId": "5b326fdb-94a0-4811-9deb-b44d6316847c",
"tenantId": "6c64eec6-79db-4dfa-80e8-17df1eeeb8b8",
"shared": false,
"properties": {
"serviceType": "EVPL",
"serverTrailList": [],
"name": "EVPLCustomCoS",
"endpoints": [
{
"settings": {
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"location": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 461
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"port": "1"
},
"filter": {
"outerVlanId": [
781
]
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]
}
],
"node": "3938_0032"
}
},
{
"settings": {
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "19"
},
"filter": {
"outerVlanId": [
781
]
},
"ingressCosSetting": {
"ingressCosMapName": "CustomCosMap",
"ingressCosPolicy": "custom"
}
}
]
}
],
"node": "5142_0049"
}
}
],
"customerName": "DefaultCustomerName",
"routeMeta": {
"originator": "BP2"
},
"structure": "P2P",
"type": "FDFR"
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2018-06-26T17:25:44.280Z",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 462
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"createdAt": "2018-06-26T17:25:44.280Z",
"autoClean": false
}

Note the service ID returned as the first line in the response. You can use that ID to retrieve the created
service using the following API call:

GET {{MCP_SERVER}}/bpocore/market/api/v1/resources/{{SVC_RSC_ID}}

This will result in a response resembling the following.

Sample response

{
"id": "5b327718-e9fb-49bf-8abe-f7c8a75f6724",
"resourceTypeId": "ifd.v5.resourceTypes.L2ServiceIntentFacade",
"productId": "5b326fdb-94a0-4811-9deb-b44d6316847c",
"tenantId": "6c64eec6-79db-4dfa-80e8-17df1eeeb8b8",
"shared": false,
"properties": {
"serviceType": "EVPL",
"serverTrailList": [],
"name": "EVPLCustomCoS",
"endpoints": [
{
"settings": {
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "1"
},
"filter": {
"outerVlanId": [
781
]
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]
}
],
"node": "3938_0032"
}
},
{
"settings": {
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 463
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"location": {
"port": "19"
},
"filter": {
"outerVlanId": [
781
]
},
"ingressCosSetting": {
"ingressCosMapName": "CustomCoSMap",
"ingressCosPolicy": "custom"
}
}
]
}
],
"node": "5142_0049"
}
}
],
"customerName": "DefaultCustomerName",
"routeMeta": {
"originator": "BP2"
},
"structure": "P2P",
"type": "FDFR"
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {
"templateResources": {}
},
"updatedAt": "2018-06-26T17:26:16.043Z",
"createdAt": "2018-06-26T17:25:44.280Z",
"autoClean": false
}

Provision 2-Endpoint ELINE pseudowire protection (QinQ spurs)

To provision a 2-point ELINE service, use the Market API.

Sample request

POST {{MCP_SERVER}}/bpocore/market/api/v1/resources

Specify the attributes for the 2 endpoints, as applicable (A-end, Z-end), for example:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 464
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

• in the properties section: "protectedPseudowire": true

• in the settings section:
◦ "linearOnly": false
◦ "allowQinQSpur": true

{
"productId": "{{L2_SVC_FACADE_PRODUCT_ID}}",
"properties": {
"serverTrailList": [],
"serviceType": "EVPL",
"name": "EVPL_PPW_node3_node8",
"type": "FDFR",
"structure": "P2P",
"customerName": "DefaultCustomerName",
"routeMeta": {
"originator": "BP2"
},
"protectedPseudowire": true,
"endpoints": [
{
"settings": {
"node": "87_5783n3",
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
1785
]
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
},
"location": {
"slot": "1",
"port": "5"
}

}
]
}
]
}
},
{
"settings": {
"node": "87_5783n8",
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"filter": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 465
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"outerVlanId": [
1785
]
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
},
"location": {
"slot": "1",
"port": "1"
}

}
]
}
]
}
}
],
"linearOnly": false,
"allowQinQSpur": true,
"transportProtection": "UNPROTECTED_BEST_EFFORT"
}
}

Sample response

{
"id": "59289241-554c-49e0-bf90-801725a99ffc",
"resourceTypeId": "ifd.v2.resourceTypes.L2ServiceIntentFacade",
"productId": "5926fd2e-40a7-40fc-a67a-753ff87a8216",
"tenantId": "00067aa3-335d-45e8-8fd8-eff7bd16a92f",
"shared": false,
"properties": {
"serviceType": "EVPL",
"serverTrailList": [],
"name": "EVPL_PPW_node3_node8",
"allowQinQSpur": true,
"endpoints": [
{
"settings": {
"node": "87_5783n3",
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
1785
]
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
},
"location": {
"slot": "1",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 466
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"port": "5"
}
}
]
}
]
}
},
{
"settings": {
"node": "87_5783n8",
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
1785
]
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
},
"location": {
"slot": "1",
"port": "1"
}
}
]
}
]
}
}
],
"customerName": "DefaultCustomerName",
"protectedPseudowire": true,
"transportProtection": "UNPROTECTED_BEST_EFFORT",
"routeMeta": {
"originator": "BP2"
},
"structure": "P2P",
"type": "FDFR",
"serviceState": "OUT_OF_SERVICE",
"lastTransition": "TRANSITION_NONE",
"linearOnly": false
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-05-26T20:38:25.419Z",
"createdAt": "2017-05-26T20:38:25.419Z",
"autoClean": false
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 467
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Note: To retrieve information, use the NSI getTPE/getFRE REST API (see Using the Service Inventory with
Packet services management. )

Provision a three-point E-Line service with pseudowire

protection
You can use the MCP REST API to provision an E-Line service with Pseudowire protection (for both single-
segment and multi-segment Pseudowires), and select one or more specific LSP tunnels to carry the A-Z,
A-Z', and Z-Z' routes.

This capability is also supported in cases where the LSP path includes linear Q-in-Q spurs.

Note: The example below show the configuration of a three-point protected E-Line service; but with minor
variations the same API call can be used to provision a conventional two-point E-Line service instead.

Sample request:

POST {{BP_SERVER}}/bpocore/market/api/v1/resources

As part of the call, you must specify the LSP Tunnel Selection block, extracted below:

"primaryPathConstraints": {
"includeRouteObjects": [
{
"constraintType": "HARD",
"value": [
"87_5775n4",
"IFDAutomation2"
],
"objectType": "LSP_NAME"
}
]
},

Sample request:

{
"productId": "{{L2_SVC_FACADE_PRODUCT_ID}}",
"properties": {
"serverTrailList": [

],
"serviceType": "EVPL",
"ccmPriority": 2,
"name": "3pt_PPW",
"ccmInterval": "10sec",
"type": "FDFR",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 468
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"transportProtection": "UNPROTECTED_ONLY",
"lastTransition": "TRANSITION_NONE",
"interactive_mode": "false",
"maName": "3ptMa",
"routeMeta": {
"originator": "BP2"
},
"oamEnabled": true,
"endpoints": [
{
"settings": {
"node": "87_5783n2",
"dmmEnabled": false,
"slmEnabled": false,
"ccmTransmitEnabled": true,
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
3410
]
},
"controlFrameTunneling": "disabled",
"location": {
"slot": "1",
"port": "10"
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]
}
],
"oamEnabled": true
}
},
{
"settings": {
"node": "87_5783n4",
"dmmEnabled": false,
"slmEnabled": false,
"ccmTransmitEnabled": true,
"role": "Z_ENNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
3490
]
},
"controlFrameTunneling": "disabled",
"location": {
"slot": "1",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 469
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"port": "7"
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]
}
],
"oamEnabled": true
}
},
{
"settings": {
"node": "87_5783n5",
"dmmEnabled": false,
"slmEnabled": false,
"ccmTransmitEnabled": true,
"role": "Z_PRIME_ENNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
3490
]
},
"controlFrameTunneling": "disabled",
"location": {
"slot": "1",
"port": "8"
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]
}
],
"oamEnabled": true
}
}
],
"primaryPathConstraints": {
"includeRouteObjects": [
{
"constraintType": "HARD",
"value": [
"87_5775n4",
"IFDAutomation2"
],
"objectType": "LSP_NAME"
}
]
},
"structure": "P2P",
"customerName": "DefaultCustomerName"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 470
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Sample response

{
"id": "59284859-6f4b-400f-822d-dcf9c82e4e88",
"resourceTypeId": "ifd.v2.resourceTypes.L2ServiceIntentFacade",
"productId": "5926fd2e-40a7-40fc-a67a-753ff87a8216",
"tenantId": "00067aa3-335d-45e8-8fd8-eff7bd16a92f",
"shared": false,
"properties": {
"serviceType": "EVPL",
"serverTrailList": [

],
"name": "3pt_PPW",
"oamEnabled": true,
"backupPathConstraints": {
"includeRouteObjects": [
{
"constraintType": "HARD",
"value": [
"87_5783n3"
],
"objectType": "NODE_NAME"
}
]
},
"maName": "3ptMa",
"endpoints": [
{
"settings": {
"node": "87_5783n2",
"dmmEnabled": false,
"slmEnabled": false,
"ccmTransmitEnabled": true,
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
3410
]
},
"controlFrameTunneling": "disabled",
"location": {
"slot": "1",
"port": "10"
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]
}
],
"oamEnabled": true

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 471
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

}
},
{
"settings": {
"node": "87_5783n4",
"dmmEnabled": false,
"slmEnabled": false,
"ccmTransmitEnabled": true,
"role": "Z_ENNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
3490
]
},
"controlFrameTunneling": "disabled",
"location": {
"slot": "1",
"port": "7"
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]
}
],
"oamEnabled": true
}
},
{
"settings": {
"node": "87_5783n5",
"dmmEnabled": false,
"slmEnabled": false,
"ccmTransmitEnabled": true,
"role": "Z_PRIME_ENNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
3490
]
},
"controlFrameTunneling": "disabled",
"location": {
"slot": "1",
"port": "8"
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 472
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

}
],
"oamEnabled": true
}
}
],
"customerName": "DefaultCustomerName",
"transportProtection": "UNPROTECTED_ONLY",
"ccmInterval": "10sec",
"routeMeta": {
"originator": "BP2"
},
"structure": "P2P",
"interactive_mode": "false",
"ccmPriority": 2,
"type": "FDFR",
"serviceState": "OUT_OF_SERVICE",
"lastTransition": "TRANSITION_NONE",

},
"discovered": false,
"differences": [

],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {

},
"providerData": {

},
"updatedAt": "2017-05-26T15:23:05.725Z",
"createdAt": "2017-05-26T15:23:05.725Z",
"autoClean": false
}

Provision per-EVC policing option

To provision the per-EVC policing option, use Market API.

Sample request

POST {{MCP_SERVER}}/bpocore/market/api/v1/resources

Specify the following attributes:

• cir
• eir

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 473
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

• cbs
• ebs

{
"productId": "{{L2T_PRODUCT_ID}}",
"label": "L2 EVPL Layer Termination A",
"discovered": false,
"properties":
{
"layerRate": "ETHERNET",
"evcPortType": "MAPPED",
"interfaceType": "UNI",
"signalIndex": {
"mappingTable": [
{ "label": "402" }
]
},
"ingressCosSetting": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 5
},
"ingressPolicer": {
"cir": 1000,
"eir": 500,
"cbs": 200,
"ebs": 100
},
"controlFrameTunneling": "enabled"
}

Sample response

No textual response except the HTTP status code

Note: To retrieve information, use the NSI getTPE/getFRE REST API (see Using the Service Inventory with
Packet services management. )

Provision constraints — QinQ only

To provision constraints, use the Market API.

Sample request

POST {{MCP_SERVER}}/bpocore/market/api/v1/resources

Specify the attributes, as required.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 474
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"productId": "{{L2_SVC_FACADE_PRODUCT_ID}}",
"properties":{
"serviceType": "EPL",
"ccmPriority": 3,
"name": "qinqEpl",
"ccmInterval": "10sec",
"protectedPseudowire": false,
"lastTransition": "TRANSITION_NONE",
"interactive_mode": "false",
"maName": "qinqEplMa",
"linearOnly": true,
"routeMeta": {
"originator": "BP2"
},
"oamEnabled": true,
"allowQinQSpur": false,
"type": "FDFR",
"structure": "P2P",
"customerName": "DefaultCustomerName",
"primaryPathConstraints": {
"includeRouteObjects": [
{
"constraintType": "HARD",
"value": [
"87_5783n2"
],
"objectType": "NODE_NAME"
}
]
},
"endpoints": [
{
"settings": {
"node": "87_5783n3",
"slmPriority": 6,
"dmmEnabled": true,
"slmEnabled": true,
"dmmInterval": "1min",
"ccmTransmitEnabled": true,
"dmmPriority": 5,
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"ingressPolicer": {
"cir": 1,
"eir": 1
},
}
],
"controlFrameTunneling": "enabled",
"filter": {},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
},
"location": {
"slot": "1",
"port": "9"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 475
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

}
}
]
}
],
"oamEnabled": true,
"slmInterval": "10min"
}
},
{
"settings": {
"node": "87_5783n5",
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"filter": {},
"location": {
"slot": "1",
"port": "10"
},
"controlFrameTunneling": "enabled",
}
],
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]
}
]
}
}
]
}
}

Sample response

{
"id": "59283dec-ceb4-4207-bbc0-3e8bbdecf56c",
"resourceTypeId": "ifd.v2.resourceTypes.L2ServiceIntentFacade",
"productId": "5926fd2e-40a7-40fc-a67a-753ff87a8216",
"tenantId": "00067aa3-335d-45e8-8fd8-eff7bd16a92f",
"shared": false,
"properties": {
"serviceType": "EPL",
"name": "qinqEpl",
"oamEnabled": true,
"allowQinQSpur": false,
"maName": "qinqEplMa",
"endpoints": [
{
"settings": {
"node": "87_5783n3",
"slmPriority": 6,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 476
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"dmmEnabled": true,
"slmEnabled": true,
"dmmInterval": "1min",
"ccmTransmitEnabled": true,
"dmmPriority": 5,
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"ingressPolicer": {
"cir": 1,
"eir": 1
},
}
],
"controlFrameTunneling": "enabled",
"filter": {},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
},
"location": {
"slot": "1",
"port": "9"
}
}
]
}
],
"oamEnabled": true,
"slmInterval": "10min"
}
},
{
"settings": {
"node": "87_5783n5",
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"filter": {},
"location": {
"slot": "1",
"port": "10"
},
"controlFrameTunneling": "enabled",
}
],
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]
}
]
}
}
],

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 477
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"customerName": "DefaultCustomerName",
"protectedPseudowire": false,
"ccmInterval": "10sec",
"routeMeta": {
"originator": "BP2"
},
"structure": "P2P",
"interactive_mode": "false",
"primaryPathConstraints": {
"includeRouteObjects": [
{
"constraintType": "HARD",
"value": [
"87_5783n2"
],
"objectType": "NODE_NAME"
}
]
},
"ccmPriority": 3,
"type": "FDFR",
"serviceState": "OUT_OF_SERVICE",
"lastTransition": "TRANSITION_NONE",
"linearOnly": true,
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-05-26T14:38:36.774Z",
"createdAt": "2017-05-26T14:38:36.774Z",
"autoClean": false
}

Provision constraints — transport protection

To provision the transport protection constraint, use the Market API.

Sample request

POST {{MCP_SERVER}}/bpocore/market/api/v1/resources

The transportProtection attribute specifies the underlying transport for the service. Values related to the
transportProtection attribute follow.

TRANSPORTPROTECTION VALUE DESCRIPTION

PROTECTED_ONLY Find a path which uses only protected transport.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 478
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

TRANSPORTPROTECTION VALUE DESCRIPTION

UNPROTECTED_ONLY Find a path which uses only unprotected transport.

PROTECTED_BEST_EFFORT Find a path which gives priority to protected transport but, if

that’s not possible, allows other transport types to be used.

UNPROTECTED_BEST_EFFORT Find a path which gives priority to unprotected transport but,

if that’s not possible, allows other transport types to be used.

<not specified> Find a path based on least number of hops.

Note: The attribute "linearOnly": true constrains the service to be linear only, regardless of the
transportProtection.

{
"productId": "{{L2_SVC_FACADE_PRODUCT_ID}}",
"properties": {
"serverTrailList": [],
"serviceType": "EVPL",
"allowQinQSpur": false,
"name": "unpUniEnni",
"protectedPseudowire": false,
"transportProtection": "PROTECTED_ONLY",
"lastTransition": "TRANSITION_NONE",
"interactive_mode": "false",
"linearOnly": false,
"routeMeta": {
"originator": "BP2"
},
"oamEnabled": false,
"endpoints": [
{
"settings": {
"node": "87c_0008",
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
3512
]
},
"controlFrameTunneling": "disabled",
"location": {
"slot": "2",
"port": "16"
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]
}
]

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 479
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

}
},
{
"settings": {
"node": "87c_0009",
"role": "Z_ENNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVLANEthertype": "8100",
"outerVlanId": [
3522
]
},
"controlFrameTunneling": "disabled",
"location": {
"slot": "3",
"port": "18"
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]
}
]
}
}
],
"type": "FDFR",
"structure": "P2P",
"customerName": "DefaultCustomerName"
}
}

Sample response

{
"id": "59286a29-4bbf-4a50-b733-6cd5111395b7",
"resourceTypeId": "ifd.v2.resourceTypes.L2ServiceIntentFacade",
"productId": "5926fd2e-40a7-40fc-a67a-753ff87a8216",
"tenantId": "00067aa3-335d-45e8-8fd8-eff7bd16a92f",
"shared": false,
"properties": {
"serviceType": "EVPL",
"serverTrailList": [],
"name": "unpUniEnni",
"oamEnabled": false,
"allowQinQSpur": false,
"endpoints": [
{
"settings": {
"node": "87c_0008",
"role": "A_UNI",
"details": [

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 480
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"flowSettings": [
{
"filter": {
"outerVlanId": [
3512
]
},
"controlFrameTunneling": "disabled",
"location": {
"slot": "2"
"port": "16"
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]
}
]
}
},
{
"settings": {
"node": "87c_0009",
"role": "Z_ENNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVLANEthertype": "8100",
"outerVlanId": [
3522
]
},
"controlFrameTunneling": "disabled",
"location": {
"slot": "3"
"port": "18"
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]
}
]
}
}
],
"customerName": "DefaultCustomerName",
"protectedPseudowire": false,
"transportProtection": "PROTECTED_ONLY",
"routeMeta": {
"originator": "BP2"
},
"structure": "P2P",
"interactive_mode": "false",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 481
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"type": "FDFR",
"serviceState": "OUT_OF_SERVICE",
"lastTransition": "TRANSITION_NONE",
"linearOnly": false,
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-05-26T17:47:21.556Z",
"createdAt": "2017-05-26T17:47:21.556Z",
"autoClean": false
}

Provision constraints — allow QinQ segments

To provision constraints to allow QinQ segments, use the Market API.

Sample request

POST {{MCP_SERVER}}/bpocore/market/api/v1/resources

Specify the following attribute:

• "allowQinQSpur": true

{
"productId": "{{L2_SVC_FACADE_PRODUCT_ID}}",
"properties": {
"serverTrailList": [],
"serviceType": "EVPL",
"allowQinQSpur": true,
"name": "unpPwSpur",
"protectedPseudowire": false,
"lastTransition": "TRANSITION_NONE",
"interactive_mode": "false",
"linearOnly": false,
"routeMeta": {
"originator": "BP2"
},
"oamEnabled": false,
"endpoints": [
{
"settings": {
"node": "3938_0032",
"role": "A_UNI",
"details": [
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 482
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"flowSettings": [
{
"filter": {
"outerVlanId": [
3209
]
},
"controlFrameTunneling": "disabled",
"location": {
"port": "1"
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]
}
]
}
},
{
"settings": {
"node": "5142_0043",
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
3209
]
},
"controlFrameTunneling": "disabled",
"location": {
"port": "16"
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]
}
]
}
}
],
"type": "FDFR",
"structure": "P2P",
"customerName": "DefaultCustomerName"
}
}

Sample response

{
"id": "59287b9f-0ddd-440e-ab3f-bc3ceed36ae9",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 483
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"resourceTypeId": "ifd.v2.resourceTypes.L2ServiceIntentFacade",
"productId": "5926fd2e-40a7-40fc-a67a-753ff87a8216",
"tenantId": "00067aa3-335d-45e8-8fd8-eff7bd16a92f",
"shared": false,
"properties": {
"serviceType": "EVPL",
"serverTrailList": [],
"name": "unpPwSpur",
"oamEnabled": false,
"allowQinQSpur": true,
"endpoints": [
{
"settings": {
"node": "3938_0032",
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
3209
]
},
"controlFrameTunneling": "disabled",
"location": {
"port": "1"
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]
}
]
}
},
{
"settings": {
"node": "5142_0043",
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
3209
]
},
"controlFrameTunneling": "disabled",
"location": {
"port": "14"
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 484
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

}
]
}
}
],
"customerName": "DefaultCustomerName",
"protectedPseudowire": false,
"routeMeta": {
"originator": "BP2"
},
"structure": "P2P",
"interactive_mode": "false",
"type": "FDFR",
"serviceState": "OUT_OF_SERVICE",
"lastTransition": "TRANSITION_NONE",
"linearOnly": false,
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-05-26T19:01:51.211Z",
"createdAt": "2017-05-26T19:01:51.211Z",
"autoClean": false
}

Create a packet service with Control Frame Tunneling (CFT)

You can use the MCP REST API to provision a packet service that uses a custom Layer 2 Control Frame
Tunneling (L2CFT) map, thereby allowing you to control which protocols are allowed to tunnel through
each service. You can specify a custom L2CFT map on each endpoint of a packet service.

You can also use the API to add a CFT-enabled endpoint with a particular CFT proile name to an existing
service.

This assumes that the custom L2CFT maps have previously been created on the device on which the
endpoint resides. If you add a new L2CFT map to an NE you can manually resynchronize MCP and the
node to immediately update MCP’s view of the available L2CFT maps on a given NE.

The API call below shows a service being provisoined that has CFT enabled on one enpoint, and CFT
disabled on the other endpoint.

POST MCP_SERVER/bpocore/market/api/v1/resources

Sample request

{
"productId": "5b2bf96e-1c5d-4b78-b604-009b3d87f717",
"properties": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 485
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"serverTrailList": [],
"serviceType": "EVPL",
"name": "rm-cft",
"routeMeta": {
"originator": "BP2"
},
"endpoints": [
{
"settings": {
"node": "87_5783n2",
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
333
]
},
"ingressCosSetting": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 3
},
"location": {
"slot": "1",
"port": "1"
},
"controlFrameTunneling": "enabled",
"controlFrameTunnelingProfileName": "profile-
name"
}
]
}
]
}
},
{
"settings": {
"node": "87_5783n4",
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
333
]
},
"ingressCosSetting": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 3
},
"location": {
"slot": "1",
"port": "1"
},
"controlFrameTunneling": "disabled"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 486
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

}
]
}
]
}
}
]
}
}

Sample response

{
"id": "5b2bfbe9-5c69-45d1-98ed-6995cd385f82",
"resourceTypeId": "ifd.v5.resourceTypes.L2ServiceIntentFacade",
"productId": "5b2bf96e-1c5d-4b78-b604-009b3d87f717",
"tenantId": "f7b6ab85-a784-4593-8022-48467a2c57f3",
"shared": false,
"properties": {
"serviceType": "EVPL",
"serverTrailList": [],
"name": "rm-cft",
"endpoints": [
{
"settings": {
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "1",
"slot": "1"
},
"controlFrameTunneling": "enabled",
"filter": {
"outerVlanId": [
333
]
},
"ingressCosSetting": {
"ingressCosPbit": 3,
"ingressCosPolicy": "fixed"
},
"controlFrameTunnelingProfileName": "profile-
name"
}
]
}
],
"node": "87_5783n2"
}
},
{
"settings": {
"role": "Z_UNI",
"details": [

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 487
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"flowSettings": [
{
"location": {
"port": "1",
"slot": "1"
},
"filter": {
"outerVlanId": [
333
]
},
"ingressCosSetting": {
"ingressCosPbit": 3,
"ingressCosPolicy": "fixed"
}
}
]
}
],
"node": "87_5783n4"
}
}
],
"routeMeta": {
"originator": "BP2"
}
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2018-06-21T19:26:33.591Z",
"createdAt": "2018-06-21T19:26:33.591Z",
"autoClean": false
}

The API call below adds a CFT-enabled endpoint to an existing service.

POST MCP_SERVER/bpocore/market/api/v1/resources/{resourceId}/operations

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 488
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"interface": "modify",
"inputs": {
"resource_properties_jsonpatch": [
{
"op": "add",
"path": "/properties/endpoints/-",
"value": {
"settings": {
"node": "87_5783n5",
"role": "UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
876
]
},
"controlFrameTunneling": "enabled",
"controlFrameTunnelingProfileName":
"profile-name",
"location": {
"slot": "1",
"port": "10"
}
}
]
}
]
}
}
}
]
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 489
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "5b2c0b13-bc05-475a-bd6b-7b7a96ac2604",
"resourceId": "5b2c09fe-0afa-4399-9289-8433911d25be",
"interface": "modify",
"inputs": {
"resource_properties_jsonpatch": [
{
"op": "add",
"path": "/properties/endpoints/-",
"value": {
"settings": {
"node": "87_5783n5",
"role": "UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
876
]
},
"controlFrameTunneling": "enabled",
"controlFrameTunnelingProfileName":
"profile-name",
"location": {
"slot": "1",
"port": "10"
}
}
]
}
]
}
}
}
]
},
"outputs": {},
"state": "requested",
"reason": "",
"progress": [],
"providerData": {},
"createdAt": "2018-06-21T20:31:15.427Z",
"updatedAt": "2018-06-21T20:31:15.427Z",
"resourceStateConstraints": {},
"executionGroup": "lifecycle"
}

Provision service OAM configuration (802.1ag and Y.1731)

To provision service OAM configuration (802ag and Y.1731), use the Market API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 490
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Sample request

POST {{MCP_SERVER}}/bpocore/market/api/v1/resources

Specify the following attributes in both settings sections of the endpoints in the request body, for
example:

• "oamEnabled": true,
• "ccmTransmitEnabled": true,
• "dmmEnabled": true,
• "dmmInterval": "10sec",
• "dmmPriority": 5,
• "slmEnabled": true,
• "slmInterval": "10sec",
• "slmPriority": 1,

{
"productId": "{{L2_SVC_FACADE_PRODUCT_ID}}",
"properties": {
"serviceType": "EVPL",
"name": "EvplCfmWbTest1",
"routeMeta": {
"originator": "BP2"
},
"interactive_mode": "true",
"oamEnabled": true,
"maName": "EvplCfmWbTest1",
"ccmInterval": "10sec",
"ccmPriority": 1,
"endpoints": [
{
"settings": {
"node": "3904_0011",
"role": "A_UNI",
"oamEnabled": true,
"ccmTransmitEnabled": true,
"dmmEnabled": true,
"dmmInterval": "10sec",
"dmmPriority": 5,
"slmEnabled": true,
"slmInterval": "10sec",
"slmPriority": 1,
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
1001
]
},
"location": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 491
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"port": "2"
}
}
]
}
]
}
},
{
"settings": {
"node": "3938_0032",
"role": "Z_UNI",
"oamEnabled": true,
"ccmTransmitEnabled": true,
"dmmEnabled": true,
"dmmInterval": "10sec",
"dmmPriority": 5,
"slmEnabled": true,
"slmInterval": "10sec",
"slmPriority": 1,
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
1001
]
},
"location": {
"port": "2"
}
}
]
}
]
}
}
],
"type": "FDFR",
"structure": "P2P",
"customerName": "DefaultCustomerName",
"linearOnly":true
}
}
}

Sample response

No textual response except the HTTP status code

Note: To retrieve information, use the NSI getTPE/getFRE REST API (see Using the Service Inventory with
Packet services management. )

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 492
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Set the default DSCP CoS mapping

To set the default DSCP CoS, use the Market API.

The ingress class of service (CoS) policy is one parameter that the user needs to explicitly set — per
endpoint — on the fiber of the network side, during service provisioning. The CoS mapping applies to the
frame on the ingress device.

The following ingress CoS policies are supported: fixed, L2PcpCos, and L3DscpCos. The following are
samples of L3DscpCos.

Sample request

POST {{MCP_SERVER}}/bpocore/market/api/v1/resources

Specify the following attribute in the endpoint settings section of the request body:

• ingressCosSetting
◦ ingressCosPolicy

{
"productId": "{{L2_SVC_FACADE_PRODUCT_ID}}",
"properties": {
"serverTrailList": [],
"serviceType": "EVPL",
"name": "EVPL_Facade_postman",
"type": "FDFR",
"structure": "P2P",
"customerName": "DefaultCustomerName",
"routeMeta": {
"originator": "BP2"
},
"endpoints": [
{
"settings": {
"node": "87_5783n7",
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
781
]
},
"ingressCosSetting": {
"ingressCosPolicy": "L3DscpCos"
},
"location": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 493
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"slot": "1",
"port": "11"
}
}
]
}
]
}
},
{
"settings": {
"node": "87_5783n8",
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
781
]
},
"ingressCosSetting": {
"ingressCosPolicy": "L3DscpCos"
},
"location": {
"slot": "1",
"port": "1"
}
}
]
}
]
}
}
]
}
}

Sample response

No textual response except HTTP status code

Note: To retrieve information, use the NSI getTPE/getFRE REST API (see Using the Service Inventory with
Packet services management.

Retrieve an ELINE service provisioning intent

To retrieve an ELINE or E-Access service provisioning intentuse the Market API.

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 494
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

GET{{MCP Server}}/bpocore/market/api/v1/resources

Specify the ID of the previously provisioned service.

https://<mcp_server>/bpocore/market/api/v1/resources/58cae7f0-434c-40e2-b6e4-417108f47cc3

Sample response

{
"id": "58cae7f0-434c-40e2-b6e4-417108f47cc3",
"label": "Facade EVPL_over_MPLS_created_from_postman",
"resourceTypeId": "ifd.v1.resourceTypes.L2ServiceIntentFacade",
"productId": "58cabe48-3594-485c-8135-62ba563afe94",
"tenantId": "dd9744f5-38e1-45f6-b203-f6ee975941e7",
"shared": false,
"properties": {
"serviceType": "EVPL",
"serverTrailList": [],
"name": "TestEvplMpls_1",
"endpoints": [
{
"settings": {
"node": "5160_0051",
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
878
]
},
"ingressCosMapping": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 5
},
"location": {
"port": "9"
}
}
]
}
]
}
]
}
},
{
"settings": {
"node": "3931_0018",
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"filter": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 495
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"outerVlanId": [
878
]
},
"ingressCosMapping": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 5
},
"location": {
"port": "2"
}
}
]
}
]
}
]
}
}
],
"customerName": "Customer Name",
"routeMeta": {
"originator": "BP2"
},
"linearOnly":false
},
"structure": "P2P",
"type": "FDFR",
"serviceState": "OUT_OF_SERVICE",
"lastTransition": "TRANSITION_NONE"
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-03-16T19:31:50.457Z",
"createdAt": "2017-03-16T19:30:57.090Z",
"autoClean": false
}

Delete an ELINE service by provisioning intent

Note: You can also use this API call to delete an E-LAN service and an E-Tree service.

Considerations

1. Best effort cleanup of configuration during undeploy/delete (failure in deletion of 1 NE or config will
not prevent deletion of config on the rest of the NEs).
2. If a service deployment has failed (it is in INCOMPLETE_DEPLOYMENT state), then trying delete will
do the following:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 496
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

◦ Best effort cleanup of all devices will be attempted, including partial configs on NEs for which
deployment failed.
◦ All resources (facade, intent, expectations) will be deleted even if there are failures during
undeploy.
3. If service was deployed properly, attempting delete will do the following:
◦ Best effort cleanup of all devices will be attempted.
◦ If delete fails on a device then the resources (façade, intent, expectations) will NOT be deleted. The
user will still see a Service in “INCOMPLETE_UNDEPLOYMENT state.

To delete a provisioned ELINE or E-Access service, use the Market API.

Sample request

DELETE {{MCP Server}}/bpocore/market/api/v1/resources

Specify the ID of the previously provisioned service as part of the URL.

https://<mcp_server>/bpocore/market/api/v1/resources/58cae7f0-434c-40e2-b6e4-417108f47cc3

Sample response

No response body. HTTP status code 204

Modify BPO-IFD properties

Blue Planet MCP uses a set of properties, shared in common with Blue Planet Orchestrate (BPO), to
customize some aspects of MCP’s behavior. These properties can be modified using the REST API.

Viewing the current list of list of current properties

To view the current set of BPO-IFD properties, use the Market API.

Issue a GET call with the following syntax:

BP_SERVER/bpocore/market/api/v1/resources?exactTypeId=ifd.resourceTypes.IfdConfig

The response will resemble the following:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 497
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"items": [
{
"id": "58a5fc80-e348-46a1-aa65-c05d4bdbfe0a",
"label": "ifd_properties",
"resourceTypeId": "ifd.resourceTypes.IfdConfig",
"productId": "58a5c8f2-42e1-418b-a83b-b546476197b2",
"tenantId": "a8fe33bc-bb0e-4cb8-9371-5dca8ffe0ad2",
"shared": false,
"properties": {
"configurationProperties": {
"ifd.l2.managementVlans": {
"default": "127",
"value": "918"
},
"ifd.l0.setExplicitFrequency": {
"default": "true",
"value": "true"
},
"ifd.l2.truncateSubportName": {
"default": "True",
"value": "False"
},
"ifd.l2.maximumTransmissionUnit": {
"default": "2000",
"value": "2000"
},
"ifd.l2.statusTlv": {
"default": "on",
"value": "on"
}
}
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-02-16T19:35:58.179Z",
"createdAt": "2017-02-16T19:24:49.103Z",
"autoClean": false
}
],
"total": 1,
"offset": 0,
"limit": 1000
}

Note the Resource ID returned at the start of this reponse. This is the ID of the active IFD configuration.

Modifying properties

To modify a BPO-IFD property, issue an API call with the following syntax:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 498
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

BP_SERVER/bpocore/market/api/v1/resources/{{RESOURCE_ID}}

where the RESOURCE_ID is the resource ID of the active IFD configuration, which you can obtain by
viewing the current configuration as described above.

The body of the request must contain:

• the name of the property you want to change, included as the key in the configurationProperties object
• the value to which the property should be set, included as the "value" key of the named property

For example:

{
"properties": {
"configurationProperties": {
"ifd.l0.setExplicitFrequency": {
"value": "false"
}
}
}
}

Specific properties affecting MCP Packet service management

One of the BPO-IFD properties that can be modified in this way is the following property that governs the
E-Line service types for which VLLI can be enabled:

ifd.l2.elineEvplVlli

Normally, VLLI can be enabled only for EPL E-Line services. To enable VLLI for EVPL E-Line services as
well, set this property to "true". For example:

{
"properties": {
"configurationProperties": {
"ifd.l2.elineEvplVlli": {
"value": "true"
}
}
}
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 499
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

API calls for managing E-LAN services

This section describes the API calls used to retrieve, provision, edit, and delete an E-LAN service.

• Provision an E-LAN service

• Add an endpoint to an existing E-LAN service
• Edit service and endpoint attributes: You can use the same API to edit service and endpoint attributes
for an E-Tree, E-LAN, or E-Line service. See Edit service and endpoint attributes.
• Delete a single endpoint from an existing E-LAN service
• Delete an E-Tree service: You can use the same API to delete an E-Tree, E-LAN, or E-Line service. See
Delete an ELINE service by provisioning intent.

Provision an E-LAN service

To provision an E-LAN service, use the Market API.

Sample request

POST {{MCP Server}}/bpocore/market/api/v1/resources

Specify the serviceType as required: EVPLAN or EPLAN

• Note the following:

◦ An ELAN service can only be created with two endpoints (min and max).
◦ Set allowQinQSpur to “true” if you wish the ELAN service to support spur (mix of linear/QinQ and
PW paths). Set it to “false” (as in above example) if you only want the ELAN with MPLS PW.

This setting cannot be changed with the add endpoint. The ELAN service will remain with the same
constraint settings.

Also, select the attributes and values, as applicable.

{
"resourceTypeId": "ifd.v3.resourceTypes.L2ServiceIntentFacade",
"properties": {
"serviceType": "EVPLAN",
"ccmPriority": 3,
"name": "evplanDemo",
"transportProtection": "MPLS_ONLY",
"allowQinQSpur": "false",
"ccmInterval": "1sec",
"profiles": [],
"userLabel": "Show an EVPLAN",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 500
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"routeMeta": {
"originator": "BP2"
},
"oamEnabled": true,
"endpoints": [
{
"settings": {
"ccmTransmitEnabled": true,
"node": "87_5783n4",
"oamEnabled": true,
"role": "UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
543
]
},
"ingressCosSetting": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 5
},
"location": {
"slot": "1",
"port": "10"
},
"profiles": [],
"controlFrameTunneling": "disabled"
}
]
}
]
}
},
{
"settings": {
"ccmTransmitEnabled": true,
"node": "87_5783n5",
"oamEnabled": true,
"role": "UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
543
]
},
"ingressCosSetting": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 5
},
"location": {
"slot": "1",
"port": "10"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 501
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"profiles": [],
"controlFrameTunneling": "disabled"
}
]
}
]
}
}
],
"type": "FDFR",
"structure": "P2P",
"customerName": "Untel"
},
"productId": "5a1dc4d4-99e0-4d69-8e95-d1d713fcfef6"
}

Sample response

{
"orchState": "activating",
"desiredOrchState": "active",
"resourceTypeId": "ifd.v3.resourceTypes.L2ServiceIntentFacade",
"tags": {},
"differences": [],
"autoClean": false,
"tenantId": "9b2efdf9-9c03-493a-bd28-f4b62d3643e3",
"discovered": false,
"reason": "",
"providerData": {
"templateResources": {}
},
"updatedAt": "2017-11-29T14:50:22.780Z",
"id": "5a1ec92e-11a0-404c-bd13-fb64696839ff",
"shared": false,
"properties": {
"serverTrailList": [],
"serviceType": "EVPLAN",
"ccmPriority": 3,
"name": "evplanDemo",
"transportProtection": "MPLS_ONLY",
"allowQinQSpur": "false",
"ccmInterval": "1sec",
"profiles": [],
"userLabel": "Show an EVPLAN",
"interactive_mode": "true",
"routeMeta": {
"originator": "BP2"
},
"oamEnabled": true,
"endpoints": [
{
"settings": {
"ccmTransmitEnabled": true,
"node": "87_5783n4",
"oamEnabled": true,
"role": "UNI",
"details": [

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 502
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"flowSettings": [
{
"filter": {
"outerVlanId": [
543
]
},
"ingressCosSetting": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 5
},
"location": {
"slot": "1",
"port": "10"
},
"profiles": [],
"controlFrameTunneling": "disabled"
}
]
}
]
}
},
{
"settings": {
"ccmTransmitEnabled": true,
"node": "87_5783n5",
"oamEnabled": true,
"role": "UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
543
]
},
"ingressCosSetting": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 5
},
"location": {
"slot": "1",
"port": "10"
},
"profiles": [],
"controlFrameTunneling": "disabled"
}
]
}
]
}
}
],
"type": "FDFR",
"structure": "P2P",
"customerName": "Untel"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 503
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

},
"createdAt": "2017-11-29T14:50:22.543Z",
"productId": "5a1dc4d4-99e0-4d69-8e95-d1d713fcfef6"
}

Add an endpoint to an existing E-LAN service

To add an endpoint to an existing E-LAN service, use the Market API.

Sample request

POST {{MCP_SERVER}}/bpocore/market/api/v1/resources/{(FACADE_RESOURCE_ID)}/operations

Specify the following attributes:

• FACADE_RESOURCE_ID

The FACADE_RESOURCE_ID is the resource ID that was returned when the service was created. (For
an example, see the id in the Sample response for Provision an E-LAN service. )

If you did not capture the FACADE_RESOURCE_ID when you provisioned the ELAN service, you can
retrieve it using: Query by name (management name) for any given L2 facade resources:

◦ GET
{{MCP_SERVER}}/bpocore/market/api/v1/resources?q=properties.name%3A{{MANAGEMENT_NA
ME}}&resourceTypeId=ifd.v3.resourceTypes.L2ServiceIntentFacade*

The modify custom operation includes the "resource_properties_jsonpatch" array of objects that are
jsonpatch compliant (https://tools.ietf.org/html/rfc6902). The “Add endpoint” use case includes:

• Add operation; “op”: “add”

• Add to the end of the ifd.v3.resourceTypes.L2ServiceIntentFacade resource endpoints array:
"/properties/endpoints/-” (dash character means adding the value to the end of the array identified by
the path).
• The new endpoint value (same attributes as for the create request).

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 504
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"interface": "modify",
"inputs": {
"resource_properties_jsonpatch": [
{
"op": "add",
"path": "/properties/endpoints/-",
"value": {
"settings": {
"node": "87_5783n4",
"role": "UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
111
]
},
"location": {
"slot": "1",
"port": "9"
},
"ingressCosSetting": {
"ingressCosPbit": 7,
"ingressCosPolicy": "fixed"
}
}
]
}
]
}
}
}
]
}
}

Sample response

Note the following:

• As with all Orchestrate custom operations, “state” provides the server processing status of the custom
operation.
• To monitor the outcome of this custom operation you can use the Market REST API:

GET/resources/{resourceId}/operations/{operationId} Get details of a specific operation for a given

resource

• {resourceId} is the same as {{L2_SVC_FACADE_PRODUCT_ID}}

• {operationId} is found in the custom operation response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 505
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

• The response is similar to the initial response of the custom operation. The “state” may now reflect
the new status of this custom operation. Refer to Orchestrate custom operation documentation for
more details.

{
"id": "5a0c63de-e89a-4610-9689-4973c24b355a",
"resourceId": "5a0c62cd-657f-45d0-8d01-9511cacf0ca8",
"interface": "modify",
"inputs": {
"resource_properties_jsonpatch": [
{
"op": "add",
"path": "/properties/endpoints/-",
"value": {
"settings": {
"node": "87_5783n2",
"role": "UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
111
]
},
"location": {
"slot": "1",
"port": "10"
},
"ingressCosSetting": {
"ingressCosPbit": 7,
"ingressCosPolicy": "fixed"
}
}
]
}
]
}
}
}
]
},
"outputs": {},
"state": "requested",
"reason": "",
"progress": [],
"providerData": {},
"createdAt": "2017-11-15T15:57:18.530Z",
"updatedAt": "2017-11-15T15:57:18.530Z",
"resourceStateConstraints": {},
"executionGroup": "lifecycle"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 506
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Configuring endpoint properties: custom CoS mapping

You can specify a customized CoS mapping to use when adding a new endpoint to an E-LAN service.

You might want to use a customized CoS mapping to rearrange adjacent service provider CoS, or to
merge together existing CoS mappings. (For example, on a SAOS 6x platform a PBit of 0 and DEI of 0 are
transparently mapped to an internal CoS of 0 and color of 0 in the default map. You might want to use a
customized mapping to group both PBit 0 and PBit 1, and map them to an internal CoS of 1)

The CoS maps you refer to using this API call must have already been created on the node on which the
endpoint resides.

Use the following Market API call to add an endpoint to an E-LAN service that uses a customized CoS
mapping:

POST {{MCP_SERVER}}/bpocore/market/api/v1/resources/{{SVC_RSC_ID}}/operations

For this call, SVC_RSC_ID is the Facade resource ID of the Layer-2 service.

Note in particular the following CoS parameters in the sample call provided below:

"ingressCosSetting": { "ingressCosPolicy": "custom", "ingressCosMapName": "CustomCosMap"

Sample request:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 507
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"interface": "modify",
"inputs": {
"resource_properties_jsonpatch": [
{
"op": "add",
"path": "/properties/endpoints/-",
"value": {
"settings": {
"node": "87_5783n3",
"role": "UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
1115
]
},
"location": {
"slot": "1",
"port": "11"
},
"ingressCosSetting": {
"ingressCosPolicy": "custom",
"ingressCosMapName": "CosMap2"
}
}
]
}
]
}
}
}
]
}
}

This will produce a response resembling the following.

Sample response:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 508
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "5b327718-e9fb-49bf-8abe-f7c8a75f6724",
"resourceId": "5b327a3e-807e-4aa8-bb39-c34ee13993ea",
"interface": "modify",
"inputs": {
"resource_properties_jsonpatch": [
{
"op": "add",
"path": "/properties/endpoints/-",
"value": {
"settings": {
"node": "87_5783n3",
"role": "UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
1115
]
},
"location": {
"slot": "1",
"port": "11"
},
"ingressCosSetting": {
"ingressCosPolicy": "custom",
"ingressCosMapName": "CosMap2"
}
}
]
}
]
}
}
}
]
},
"outputs": {},
"state": "requested",
"reason": "",
"progress": [],
"providerData": {},
"createdAt": "2018-06-26T17:42:11.354Z",
"updatedAt": "2018-06-26T17:42:11.354Z",
"resourceStateConstraints": {},
"executionGroup": "lifecycle"
}

Delete a single endpoint from an existing E-LAN service

Note: You can also use this API call to delete a leaf endpoint from an E-Tree service.

To delete a single endpoint from an existing E-LAN service, use the Market API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 509
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Sample request

POST {{BP_SERVER}}/bpocore/market/api/v1/resources/{(FACADE_RESOURCE_ID)}/operations

Specify the following attributes:

• FACADE_RESOURCE_ID

The FACADE_RESOURCE_ID is the resource ID that was returned when the service was created. (For
an example, see the id in the Sample response for Provision an E-LAN service. )

If you did not capture the FACADE_RESOURCE_ID when you provisioned the ELAN service, you can
retrieve it using: Query by name (management name) for any given L2 facade resources:

◦ GET
{{BP_SERVER}}/bpocore/market/api/v1/resources?q=properties.name%3A{{MANAGEMENT_NAM
E}}&resourceTypeId=ifd.v5.resourceTypes.L2ServiceIntentFacade*

This API call involves the same modify custom operation as in the “Add endpoint”. For this “Delete
endpoint” use case the following is used:

• Remove operation; “op”: “remove”

• The path is used to identify by Index the endpoint object to be removed in the
ifd.v5.resourceTypes.L2ServiceIntentFacade resource endpoints array. In the sample request, 0
means to remove the first endpoint object in the existing “/properties/endpoints“ array

{
"interface": "modify",
"inputs": {
"resource_properties_jsonpatch": [
{
"op": "remove",
"path": "/properties/endpoints/0"
}
]
}
}

Sample response

Note the following:

• As with all Orchestrate custom operations, “state” provides the server processing status of the custom
operation.
• To monitor the outcome of this custom operation you can use the Market REST API:

GET/resources/{resourceId}/operations/{operationId} Get details of a specific operation for a given

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 510
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

resource

• {resourceId} is the same as {{L2_SVC_FACADE_PRODUCT_ID}}

• {operationId} is found in the custom operation response
• The response is similar to the initial response of the custom operation. The “state” may now reflect
the new status of this custom operation. Refer to Orchestrate custom operation documentation for
more details.

{
"id": "5a0c63de-e89a-4610-9689-4973c24b355a",
"resourceId": "5a0c62cd-657f-45d0-8d01-9511cacf0ca8",
"interface": "modify",
"inputs": {
"resource_properties_jsonpatch": [{
"op": "remove",
"path": "/properties/endpoints/0",
}
]
},
"outputs": {},
"state": "requested",
"reason": "",
"progress": [],
"providerData": {},
"createdAt": "2017-11-15T15:57:18.530Z",
"updatedAt": "2017-11-15T15:57:18.530Z",
"resourceStateConstraints": {},
"executionGroup": "lifecycle"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 511
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

API calls for managing E-TREE services

This section describes the API calls used retrieve, provision, edit, and delete an E-TREE service.

• Provision an E-Tree service

• Add a leaf endpoint to an existing E-Tree service

• Edit service and endpoint attributes: You can use the same API to edit service and endpoint attributes
for an E-Tree, E-LAN, or E-Line service. See Edit service and endpoint attributes.

• Delete an E-Tree service: You can use the same API to delete an E-Tree, E-LAN, or E-Line service. See
Delete an ELINE service by provisioning intent.

E-Tree provisionining — 6200 device support

6200 devices support E-Tree provisioning in the same way as other supported devices with the following
exceptions:

• MCP supports 6200 devices running software version 2.0 or 2.1, with the following requirements:

CFM is not supported on devices running any version of software 2.0 including:

◦ creating an E-Tree Packet service with CFM configured, and

◦ editing or adding CFM to an existing E-Tree Packet service
• 6200 devices do not support the following use cases in MCP:
◦ Creating an E-Tree Packet service with a 6200 device as a root node.

6200 devices cannot be configured as a root node in an E-Tree Packet service; they can only be
provisioned as a leaf node.

◦ Adding CFM to an existing Packet service created without CFM.

If a Packet service is created without CFM, editing that E-Tree Packet service by adding CFM to it
will fail on 6200 devices. This is due to limitations in the MCP architecture.

◦ Each E-Tree Packet service may only include a single leaf on each 6200 device.

If an E-Tree Packet service is created with 6200 devices as leaves, then you cannot add an
additional leaf to those same devices already in that service.

Provision an E-Tree service

To provision an E-Tree service, use the Market API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 512
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

This section includes the following topics for creating an E-Tree service over static MPLS transport with
SS-PW / MS-PW:

• Provision a single-root E-Tree service

• Provision a dual-root E-Tree service

Note: The dual-root E-Tree service is on the same node.

The E-Tree service is supported on the following devices:

• 6.x (leaf or root)

• 8700 (leaf or root)
• 6500 Packet Fabric (leaf or root)
• 6200 (leaf)

Note: An E-Tree service can only be created for a single root with a leaf or a dual root with a leaf. After you
have created an E-Tree service, you can add a leaf endpoint to the E-Tree service. See "Add an endpoint to
an existing E-Tree service".

Provision a single-root E-Tree service

Sample request

POST {{MCP Server}}/bpocore/market/api/v1/resources

Specify the endpointRole "ROOT" or endpointRole "LEAF" for a single-root E-Tree service.

Also, select the attributes and values, as applicable.

Note: The following is an example of an E-Tree service with a single root and a single leaf on 8700 on a
single tunnel (SS-PW). The same API applies to both single tunnel (SS-PW) and multiple tunnels (MS-PW).

{
"productId": "{{L2_SVC_FACADE_PRODUCT_ID}}",
"properties": {
"serviceType": "EVPTREE",
"name": "etree_1R_1L",
"userLabel": "ETree_1Root_1Leaf",
"routeMeta": {
"originator": "BP2"
},
"endpoints": [
{
"settings": {
"node": "87_5783n7",
"role": "UNI",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 513
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"endpointRole": "ROOT",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
762
]
},
"location": {
"slot": "1",
"port": "8"
}
}
]
}
]
}
},
{
"settings": {
"node": "87_5783n8",
"role": "UNI",
"endpointRole": "LEAF",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
762
]
},
"location": {
"slot": "1",
"port": "1"
}
}
]
}
]
}
}
],
"transportProtection": "UNPROTECTED_ONLY"
}
}

Sample response

{
"id": "5b22b7bf-78d9-4c1e-9e6c-a231c25aa668",
"resourceTypeId": "ifd.v5.resourceTypes.L2ServiceIntentFacade",
"productId": "5b1eb960-ff93-4cc1-b10f-60a92d01ac09",
"tenantId": "1da6d5b9-5d45-4181-a415-8ba3c43c11ff",
"shared": false,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 514
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"properties": {
"serviceType": "EVPTREE",
"name": "etree_1R_1L",
"endpoints": [
{
"settings": {
"endpointRole": "ROOT",
"role": "UNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "8",
"slot": "1"
},
"filter": {
"outerVlanId": [
762
]
}
}
]
}
],
"node": "87_5783n7"
}
},
{
"settings": {
"endpointRole": "LEAF",
"role": "UNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "1",
"slot": "1"
},
"filter": {
"outerVlanId": [
762
]
}
}
]
}
],
"node": "87_5783n8"
}
}
],
"transportProtection": "UNPROTECTED_ONLY",
"routeMeta": {
"originator": "BP2"
},
"userLabel": "ETree_1Root_1Leaf"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 515
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2018-06-14T18:45:20.057Z",
"createdAt": "2018-06-14T18:45:20.057Z",
"autoClean": false
}

Retrieve the single-root E-Tree service

Sample request

GET {{BP_SERVER}}/bpocore/market/api/v1/resources/{{SVC_RSC_ID}}

Specify the SVC_RSC_ID, which is the "id" you can find in the Sample response of the POST API call (see
above).

Sample response

{
"id": "5b22b7bf-78d9-4c1e-9e6c-a231c25aa668",
"resourceTypeId": "ifd.v5.resourceTypes.L2ServiceIntentFacade",
"productId": "5b1eb960-ff93-4cc1-b10f-60a92d01ac09",
"tenantId": "1da6d5b9-5d45-4181-a415-8ba3c43c11ff",
"shared": false,
"properties": {
"serviceType": "EVPTREE",
"name": "etree_1R_1L",
"endpoints": [
{
"settings": {
"endpointRole": "ROOT",
"role": "UNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "8",
"slot": "1"
},
"filter": {
"outerVlanId": [
762
]
}
}
]
}
],
"node": "87_5783n7"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 516
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

}
},
{
"settings": {
"endpointRole": "LEAF",
"role": "UNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "1",
"slot": "1"
},
"filter": {
"outerVlanId": [
762
]
}
}
]
}
],
"node": "87_5783n8"
}
}
],
"transportProtection": "UNPROTECTED_ONLY",
"routeMeta": {
"originator": "BP2"
},
"userLabel": "ETree_1Root_1Leaf"
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {
"templateResources": {}
},
"updatedAt": "2018-06-14T18:45:44.118Z",
"createdAt": "2018-06-14T18:45:20.057Z",
"autoClean": false
}

Provision a dual-root E-Tree service

Sample request

POST {{MCP Server}}/bpocore/market/api/v1/resources

Specify the endpointRole "ROOT" or endpointRole "LEAF" for a dual-root E-Tree service.

For a dual-root E-Tree service, you must specify two endpointRole "ROOT". Both roots must be on the

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 517
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

same node but on a different port.

Also, select the attributes and values, as applicable.

Note: The following is an example of an E-Tree service with dual roots and a single leaf on 8700 on a
single tunnel (SS-PW). The same API applies to both single tunnel (SS-PW) and multiple tunnels (MS-PW).

{
"productId": "{{L2_SVC_FACADE_PRODUCT_ID}}",
"properties": {
"serviceType": "EVPTREE",
"name": "Etree_2R_1L",
"userLabel": "ETree_2Root_1Leaf",
"routeMeta": {
"originator": "BP2"
},
"endpoints": [
{
"settings": {
"node": "87_5783n7",
"role": "UNI",
"endpointRole": "ROOT",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
921
]
},
"location": {
"slot": "1",
"port": "8"
}
}
]
}
]
}
},
{
"settings": {
"node": "87_5783n7",
"role": "UNI",
"endpointRole": "ROOT",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
921
]
},
"location": {
"slot": "1",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 518
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"port": "9"
}
}
]
}
]
}
},
{
"settings": {
"node": "87_5783n8",
"role": "UNI",
"endpointRole": "LEAF",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
921
]
},
"location": {
"slot": "1",
"port": "1"
}
}
]
}
]
}
}
],
"transportProtection": "UNPROTECTED_ONLY"
}
}

Sample response

{
"id": "5b22c061-fc8a-4df0-a81a-af34e9bf4b1e",
"resourceTypeId": "ifd.v5.resourceTypes.L2ServiceIntentFacade",
"productId": "5b1eb960-ff93-4cc1-b10f-60a92d01ac09",
"tenantId": "1da6d5b9-5d45-4181-a415-8ba3c43c11ff",
"shared": false,
"properties": {
"serviceType": "EVPTREE",
"name": "Etree_2R_1L",
"endpoints": [
{
"settings": {
"endpointRole": "ROOT",
"role": "UNI",
"details": [
{
"flowSettings": [
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 519
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"location": {
"port": "8",
"slot": "1"
},
"filter": {
"outerVlanId": [
921
]
}
}
]
}
],
"node": "87_5783n7"
}
},
{
"settings": {
"endpointRole": "ROOT",
"role": "UNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "9",
"slot": "1"
},
"filter": {
"outerVlanId": [
921
]
}
}
]
}
],
"node": "87_5783n7"
}
},
{
"settings": {
"endpointRole": "LEAF",
"role": "UNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "1",
"slot": "1"
},
"filter": {
"outerVlanId": [
921
]
}
}
]

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 520
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

}
],
"node": "87_5783n8"
}
}
],
"transportProtection": "UNPROTECTED_ONLY",
"routeMeta": {
"originator": "BP2"
},
"userLabel": "ETree_2Root_1Leaf"
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2018-06-14T19:22:09.379Z",
"createdAt": "2018-06-14T19:22:09.379Z",
"autoClean": false
}

Retrieve the dual-root E-Tree service

Sample request

GET {{BP_SERVER}}/bpocore/market/api/v1/resources/{{SVC_RSC_ID}}

Specify the SVC_RSC_ID, which is the "id" you can find in the Sample response of the POST API call (see
above).

Sample response

{
"id": "5b22c061-fc8a-4df0-a81a-af34e9bf4b1e",
"resourceTypeId": "ifd.v5.resourceTypes.L2ServiceIntentFacade",
"productId": "5b1eb960-ff93-4cc1-b10f-60a92d01ac09",
"tenantId": "1da6d5b9-5d45-4181-a415-8ba3c43c11ff",
"shared": false,
"properties": {
"serviceType": "EVPTREE",
"name": "Etree_2R_1L",
"endpoints": [
{
"settings": {
"endpointRole": "ROOT",
"role": "UNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "8",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 521
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"slot": "1"
},
"filter": {
"outerVlanId": [
921
]
}
}
]
}
],
"node": "87_5783n7"
}
},
{
"settings": {
"endpointRole": "ROOT",
"role": "UNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "9",
"slot": "1"
},
"filter": {
"outerVlanId": [
921
]
}
}
]
}
],
"node": "87_5783n7"
}
},
{
"settings": {
"endpointRole": "LEAF",
"role": "UNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "1",
"slot": "1"
},
"filter": {
"outerVlanId": [
921
]
}
}
]
}
],

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 522
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"node": "87_5783n8"
}
}
],
"transportProtection": "UNPROTECTED_ONLY",
"routeMeta": {
"originator": "BP2"
},
"userLabel": "ETree_2Root_1Leaf"
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {
"templateResources": {}
},
"updatedAt": "2018-06-14T19:22:33.686Z",
"createdAt": "2018-06-14T19:22:09.379Z",
"autoClean": false
}

Add a leaf endpoint to an existing E-Tree service

This section includes the following topics:

• Add a leaf endpoint with a node exclusion constraint, which includes the following samples: Facade
request and response, and an Intent request and response
• Add a leaf endpoint with a tunnel inclusion constraint, which includes the following samples: Facade
request and response, and an Intent request and response

To add a leaf endpoint to an existing E-Tree service, use the Market API.

Sample request

POST {{MCP_SERVER}}/bpocore/market/api/v1/resources/{(FACADE_RESOURCE_ID)}/operations

Specify the following attributes:

• FACADE_RESOURCE_ID

The FACADE_RESOURCE_ID is the resource ID that was returned when the service was created. (For
an example, see the id in the Sample response for Provision an E-Tree service. )

If you did not capture the FACADE_RESOURCE_ID when you provisioned the E-Tree service, you can
retrieve it using: Query by name (management name) for any given L2 facade resources:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 523
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

◦ GET
{{MCP_SERVER}}/bpocore/market/api/v1/resources?q=properties.name%3A{{MANAGEMENT_NA
ME}}&resourceTypeId=ifd.v5.resourceTypes.L2ServiceIntentFacade*

The modify custom operation includes the "resource_properties_jsonpatch" array of objects that are
jsonpatch compliant (https://tools.ietf.org/html/rfc6902). The “Add leaf endpoint” use case includes:

• Add operation; “op”: “add”

• Add to the end of the ifd.v5.resourceTypes.L2ServiceIntentFacade resource endpoints array:
"/properties/endpoints/-” (dash character means adding the value to the end of the array identified by
the path).
• The new endpoint value (same attributes as for the provision E-Tree request).

Note the following:

• endpointRole attribute in inputs.resource_properties_jsonpatch[0].value.settings with LEAF value

• routingConstraints attribute in inputs.resource_properties_jsonpatch[0]
◦ To allow routing constraint by explicit inclusion or exclusion of LSP (tunnel) name for the new E-
TREE path between the existing root(s) and the added LEAF endpoint.
◦ To allow routing constraint by explicit inclusion or exclusion of node (NE) name for the new E-TREE
path between the existing root(s) and the added LEAF endpoint.

Add a leaf endpoint with a node exclusion constraint

Sample request — Facade

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 524
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"interface": "modify",
"inputs": {
"resource_properties_jsonpatch": [{
"op": "add",
"path": "/properties/endpoints/-",
"value": {
"settings": {
"node": "87_5783n3",
"endpointRole": "LEAF",
"role": "UNI",
"details": [{
"flowSettings": [{
"filter": {
"outerVlanId": [
600
]
},
"location": {
"slot": "1",
"port": "9"
},
"controlFrameTunneling": "disabled"
}
]
}
]
}
}
}
],
"routingConstraints": {
"excludeRouteObjects": [{
"constraintType": "HARD",
"locations": [{
"nodeName": "87_5783n3"
}
],
"objectType": "NODE_NAME"
}
]
}
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 525
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "5a0c63de-e89a-4610-9689-4973c24b355a",
"resourceId": "5a0c62cd-657f-45d0-8d01-9511cacf0ca8",
"interface": "modify",
"inputs": {
"resource_properties_jsonpatch": [{
"op": "add",
"path": "/properties/endpoints/-",
"value": {
"settings": {
"node": "87_5783n3",
"endpointRole": "LEAF",
"role": "UNI",
"details": [{
"flowSettings": [{
"filter": {
"outerVlanId": [
600
]
},
"location": {
"slot": "1",
"port": "9"
},
"controlFrameTunneling": "disabled"
}
]
}
]
}
}
}
],
"routingConstraints": {
"excludeRouteObjects": [{
"constraintType": "HARD",
"locations": [{
"nodeName": "87_5783n3"
}
],
"objectType": "NODE_NAME"
}
]
}
},
"outputs": {},
"state": "requested",
"reason": "",
"progress": [],
"providerData": {},
"createdAt": "2017-11-15T15:57:18.530Z",
"updatedAt": "2017-11-15T15:57:18.530Z",
"resourceStateConstraints": {},
"executionGroup": "lifecycle"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 526
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Add a leaf endpoint with a tunnel inclusion constraint

Sample request — Facade

{
"interface": "modify",
"inputs": {
"resource_properties_jsonpatch": [{
"op": "add",
"path": "/properties/endpoints/-",
"value": {
"settings": {
"node": "87_5783n3",
"endpointRole": "LEAF",
"role": "UNI",
"details": [{
"flowSettings": [{
"filter": {
"outerVlanId": [
600
]
},
"location": {
"slot": "1",
"port": "9"
},
"controlFrameTunneling": "disabled"
}
]
}
]
}
}
}
],
"routingConstraints": {
"includeRouteObjects": [{
"constraintType": "HARD",
"locations": [{
"lspName": "jmLspn3n5",
"nodeName": "87_5783n3"
}
],
"objectType": "LSP_NAME"
}
]
}
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 527
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "5a0c63de-e89a-4610-9689-4973c24b355a",
"resourceId": "5a0c62cd-657f-45d0-8d01-9511cacf0ca8",
"interface": "modify",
"inputs": {
"resource_properties_jsonpatch": [{
"op": "add",
"path": "/properties/endpoints/-",
"value": {
"settings": {
"node": "87_5783n3",
"endpointRole": "LEAF",
"role": "UNI",
"details": [{
"flowSettings": [{
"filter": {
"outerVlanId": [
600
]
},
"location": {
"slot": "1",
"port": "9"
},
"controlFrameTunneling": "disabled"
}
]
}
]
}
}
}
],
"routingConstraints": {
"includeRouteObjects": [{
"constraintType": "HARD",
"locations": [{
"lspName": "jmLspn3n5",
"nodeName": "87_5783n3"
}
],
"objectType": "LSP_NAME"
}
]
}
},
"outputs": {},
"state": "requested",
"reason": "",
"progress": [],
"providerData": {},
"createdAt": "2017-11-15T15:57:18.530Z",
"updatedAt": "2017-11-15T15:57:18.530Z",
"resourceStateConstraints": {},
"executionGroup": "lifecycle"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 528
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Note the following:

• As with all Orchestrate custom operations, “state” provides the server processing status of the custom
operation.
• To monitor the outcome of this custom operation you can use the Market REST API:

GET/resources/{resourceId}/operations/{operationId} Get details of a specific operation for a given

resource

• {resourceId} is the same as {{L2_SVC_FACADE_PRODUCT_ID}}

• {operationId} is found in the custom operation response
• The response is similar to the initial response of the custom operation. The “state” may now reflect
the new status of this custom operation. Refer to Orchestrate custom operation documentation for
more details.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 529
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

API calls for provisioning E-Access and E-Transit

services
This section describes the API calls used to provision E-Access and E-Transit services:

• Provision unprot E-ACCESS EVPL COS MPLS prot/unprot tunnels with/wout QinQ spurs
• Provision unprot E-ACCESS EPL COS MPLS prot/unprot tunnels with/wout QinQ spurs
• Provision E-ACCESS E-Line services
• Provision E-Transit E-Line services

Provision unprot E-ACCESS EVPL COS MPLS prot/unprot tunnels

with/wout QinQ spurs
To provision an E-ACCESS EVPL service over MPLS transport between 2 8700 nodes and default CoS
Policy mapping with UNI CVID of 780 and ENNI SVID of 2794 (no CVID swapping supported) and
ETHERTYPE = 88A8, use the Market API.

Note: For the related Sample request and Sample response bodies, see Provision E-ACCESS ELINE
services.

Provision unprot E-ACCESS EPL COS MPLS prot/unprot tunnels

with/wout QinQ spurs
To provision an E-ACCESS EPL service over MPLS transport between 2 8700 nodes and default CoS
Policy mapping with ENNI SVID of 2794 and ETHERTYPE = 88A8, use the Market API.

Sample request

POST {{MCP Server}}/bpocore/market/api/v1/resources

{
"productId": "{{L2_SVC_FACADE_PRODUCT_ID}}",
"properties": {
"serviceType": "EPL",
"name": "unpEpl3",
"oamEnabled": false,
"allowQinQSpur": false,
"endpoints": [
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 530
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"settings": {
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"filter": {},
"location": {
"port": "3"
},
"ingressCosSetting": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 5
},
"profiles": [],
"controlFrameTunneling": "disabled"
}
]
}
],
"node": "5142_0017"
}
},
{
"settings": {
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"filter": {},
"location": {
"port": "3"
},
"ingressCosSetting": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 5
},
"profiles": [],
"controlFrameTunneling": "disabled"
}
]
}
],
"node": "5142_0043"
}
}
],
"customerName": "DefaultCustomerName",
"protectedPseudowire": false,
"transportProtection": "PROTECTED_BEST_EFFORT",
"routeMeta": {
"originator": "BP2"
},
"structure": "P2P",
"interactive_mode": "false",
"type": "FDFR",
"linearOnly": false,
"profiles": []

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 531
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

}
}

Sample response

{
"id": "594c12e3-486f-40bd-a5dd-58d59d4e76bd",
"resourceTypeId": "ifd.v2.resourceTypes.L2ServiceIntentFacade",
"productId": "59499ab1-f3e3-4999-94a5-45845654978d",
"tenantId": "70115554-0399-4879-894d-6329c957f9df",
"shared": false,
"properties": {
"serviceType": "EPL",
"name": "unpEpl3",
"oamEnabled": false,
"allowQinQSpur": false,
"endpoints": [
{
"settings": {
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"filter": {},
"location": {
"port": "3"
},
"ingressCosSetting": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 5
},
"profiles": [],
"controlFrameTunneling": "disabled"
}
]
}
],
"node": "5142_0017"
}
},
{
"settings": {
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"filter": {},
"location": {
"port": "3"
},
"ingressCosSetting": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 5
},
"profiles": [],

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 532
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"controlFrameTunneling": "disabled"
}
]
}
],
"node": "5142_0043"
}
}
],
"customerName": "DefaultCustomerName",
"protectedPseudowire": false,
"transportProtection": "PROTECTED_BEST_EFFORT",
"routeMeta": {
"originator": "BP2"
},
"structure": "P2P",
"interactive_mode": "false",
"type": "FDFR",
"serviceState": "OUT_OF_SERVICE",
"lastTransition": "TRANSITION_NONE",
"linearOnly": false,
"profiles": []
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-06-22T18:56:35.630Z",
"createdAt": "2017-06-22T18:56:35.630Z",
"autoClean": false
}

Provision E-ACCESS ELINE services

To provision E-ACCESS ELINE services, use the Market API.

Sample request

POST {{MCP_SERVER}}/bpocore/market/api/v1/resources

You must specify the following attributes:

• under "endpoints" in the first "settings" section, include: "role": "A_UNI"

• under "endpoints" in the second "settings" section, include: "role": "Z_ENNI"

Note: A_UNI and Z_ENNI are keywords used specifically for E-Access services

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 533
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Below is an example of configuring an E-Access EVPL service using linear QinQ transport.

{
"productId": "{{L2_SVC_FACADE_PRODUCT_ID}}",
"properties": {
"serverTrailList": [],
"serviceType": "EVPL",
"allowQinQSpur": false,
"name": "unpUniEnni",
"protectedPseudowire": false,
"transportProtection": "PROTECTED_ONLY",
"lastTransition": "TRANSITION_NONE",
"interactive_mode": "false",
"linearOnly": false,
"routeMeta": {
"originator": "BP2"
},
"oamEnabled": false,
"endpoints": [
{
"settings": {
"node": "87c_0008",
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
3512
]
},
"controlFrameTunneling": "disabled",
"location": {
"slot": "2",
"port": "16"
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]
}
]
}
},
{
"settings": {
"node": "87c_0009",
"role": "Z_ENNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVLANEthertype": "8100",
"outerVlanId": [
3522

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 534
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

]
},
"controlFrameTunneling": "disabled",
"location": {
"slot": "3",
"port": "18"
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]
}
]
}
}
],
"type": "FDFR",
"structure": "P2P",
"customerName": "DefaultCustomerName"
}
}

Sample response

{
"id": "59286a29-4bbf-4a50-b733-6cd5111395b7",
"resourceTypeId": "ifd.v2.resourceTypes.L2ServiceIntentFacade",
"productId": "5926fd2e-40a7-40fc-a67a-753ff87a8216",
"tenantId": "00067aa3-335d-45e8-8fd8-eff7bd16a92f",
"shared": false,
"properties": {
"serviceType": "EVPL",
"serverTrailList": [],
"name": "unpUniEnni",
"oamEnabled": false,
"allowQinQSpur": false,
"endpoints": [
{
"settings": {
"node": "87c_0008",
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
3512
]
},
"controlFrameTunneling": "disabled",
"location": {
"slot": "2"
"port": "16"
},
"ingressCosSetting": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 535
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"ingressCosPolicy": "L2PcpCos"
}
}
]
}
]
}
},
{
"settings": {
"node": "87c_0009",
"role": "Z_ENNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVLANEthertype": "8100",
"outerVlanId": [
3522
]
},
"controlFrameTunneling": "disabled",
"location": {
"slot": "3",
"port": "18"
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]
}
]
}
}
],
"customerName": "DefaultCustomerName",
"protectedPseudowire": false,
"transportProtection": "PROTECTED_ONLY",
"routeMeta": {
"originator": "BP2"
},
"structure": "P2P",
"interactive_mode": "false",
"type": "FDFR",
"serviceState": "OUT_OF_SERVICE",
"lastTransition": "TRANSITION_NONE",
"linearOnly": false,
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-05-26T17:47:21.556Z",
"createdAt": "2017-05-26T17:47:21.556Z",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 536
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"autoClean": false
}

Below is an example of configuring an E-Access EVPL service on an 8700 node using MPLS transport.

You must specify the role attributes in the endpoints section:

• under "endpoints" in the first "settings" section, include: "role": "A_UNI"

• under "endpoints" in the second "settings" section, include: "role": "Z_ENNI"

Sample request

POST {{MCP_SERVER}}/bpocore/market/api/v1/resources

{
"productId": "{{L2_SVC_FACADE_PRODUCT_ID}}",
"properties": {
"serverTrailList": [],
"serviceType": "EVPL",
"allowQinQSpur": false,
"name": "unpUniEnni",
"protectedPseudowire": false,
"transportProtection": "PROTECTED_ONLY",
"lastTransition": "TRANSITION_NONE",
"interactive_mode": "false",
"linearOnly": false,
"routeMeta": {
"originator": "BP2"
},
"oamEnabled": false,
"endpoints": [
{
"settings": {
"node": "87c_0008",
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
3512
]
},
"controlFrameTunneling": "disabled",
"location": {
"slot": "2"
"port": "16"
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 537
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

]
}
},
{
"settings": {
"node": "87c_0009",
"role": "Z_ENNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVLANEthertype": "8100",
"outerVlanId": [
3522
]
},
"controlFrameTunneling": "disabled",
"location": {
"slot": "3",
"port": "18"
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]
}
]
}
}
],
"type": "FDFR",
"structure": "P2P",
"customerName": "DefaultCustomerName"
}
}

Sample response

{
"id": "59286a29-4bbf-4a50-b733-6cd5111395b7",
"resourceTypeId": "ifd.v2.resourceTypes.L2ServiceIntentFacade",
"productId": "5926fd2e-40a7-40fc-a67a-753ff87a8216",
"tenantId": "00067aa3-335d-45e8-8fd8-eff7bd16a92f",
"shared": false,
"properties": {
"serviceType": "EVPL",
"serverTrailList": [],
"name": "unpUniEnni",
"oamEnabled": false,
"allowQinQSpur": false,
"endpoints": [
{
"settings": {
"node": "87c_0008",
"role": "A_UNI",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 538
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
3512
]
},
"controlFrameTunneling": "disabled",
"location": {
"slot": "2
"port": "16"
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]
}
]
}
},
{
"settings": {
"node": "87c_0009",
"role": "Z_ENNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVLANEthertype": "8100",
"outerVlanId": [
3522
]
},
"controlFrameTunneling": "disabled",
"location": {
"slot": "3", "port":
"18"
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
}
}
]
}
]
}
}
],
"customerName": "DefaultCustomerName",
"protectedPseudowire": false,
"transportProtection": "PROTECTED_ONLY",
"routeMeta": {
"originator": "BP2"
},
"structure": "P2P",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 539
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"interactive_mode": "false",
"type": "FDFR",
"serviceState": "OUT_OF_SERVICE",
"lastTransition": "TRANSITION_NONE",
"linearOnly": false,
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-05-26T17:47:21.556Z",
"createdAt": "2017-05-26T17:47:21.556Z",
"autoClean": false
}

Note: To retrieve information, use the NSI getTPE/getFRE REST API (see Using the Service Inventory with
Packet services management.

Provision E-Transit E-Line services

To provision E-Transit E-Line services, use the Market API.

POST {{BP_SERVER}}/bpocore/market/api/v1/resources

Below is an example of configuring an E-Transit service for a SAOS 6.x EVPL service with only QinQ
transport.

You must specify the following attributes:

• under "endpoints" in the first "settings" section, include "role": "A_ENNI"

• under "endpoints" in the second "settings" section, include: "role": "Z_ENNI"
• to limit the supporting infrastructure to QinQ only: "linearOnly:true"

Note: A_ENNI and Z_ENNI are keywords used specifically for E-Transit services

Sample request

POST {{BP_SERVER}}/bpocore/market/api/v1/resources

{
"productId": "{{L2_SVC_FACADE_PRODUCT_ID}}",
"properties": {
"serverTrailList": [],
"serviceType": "EVPL",
"name": "ET_6xQinQ",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 540
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"type": "FDFR",
"structure": "P2P",
"customerName": "DefaultCustomerName",
"routeMeta": {
"originator": "BP2"
},
"endpoints": [
{
"settings": {
"node": "3930_0022",
"role": "A_ENNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
601
]
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
},
"location": {
"port": "21"
},
"profiles": []
}
]
}
]
}
},
{
"settings": {
"node": "3942_0003",
"role": "Z_ENNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
1601
]
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
},
"location": {
"port": "21"
},
"profiles": []
}
]
}
]
}
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 541
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

],
"linearOnly": true
}
}

Sample response

{
"id": "5a0c9ad9-5a94-4c0b-9a85-ca9c8e3caae6",
"resourceTypeId": "ifd.v3.resourceTypes.L2ServiceIntentFacade",
"productId": "5a0c9570-6537-472d-8225-094dbf3d850b",
"tenantId": "42264637-9d69-413c-9daf-a0052b73c77b",
"shared": false,
"properties": {
"serviceType": "EVPL",
"serverTrailList": [],
"name": "ET_6xQinQ",
"endpoints": [
{
"settings": {
"role": "A_ENNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "21"
},
"filter": {
"outerVlanId": [
601
]
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
},
"profiles": []
}
]
}
],
"node": "3930_0022"
}
},
{
"settings": {
"role": "Z_ENNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "21"
},
"filter": {
"outerVlanId": [
1601

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 542
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

]
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
},
"profiles": []
}
]
}
],
"node": "3942_0003"
}
}
],
"customerName": "DefaultCustomerName",
"routeMeta": {
"originator": "BP2"
},
"structure": "P2P",
"type": "FDFR",
"linearOnly": true
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-11-15T19:51:53.993Z",
"createdAt": "2017-11-15T19:51:53.993Z",
"autoClean": false
}

Below is an example of configuring an E-TRANSIT service for a SAOS 8.x EVPL service with MPLS
transport.

You must specify the following attributes:

• under "endpoints" in the first "settings" section, include "role": "A_ENNI"

• under "endpoints" in the second "settings" section, include: "role": "Z_ENNI"
• to specify an unprotected MPLS infrastructure: "transportProtection": "UNPROTECTED_ONLY"

Sample request

POST {{BP_SERVER}}/bpocore/market/api/v1/resources

{
"productId": "{{L2_SVC_FACADE_PRODUCT_ID}}",
"properties": {
"serverTrailList": [],
"serviceType": "EVPL",
"name": "ET_8xMpls",
"type": "FDFR",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 543
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"structure": "P2P",
"customerName": "DefaultCustomerName",
"routeMeta": {
"originator": "BP2"
},
"endpoints": [
{
"settings": {
"node": "87_5783n3",
"role": "A_ENNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
533
]
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
},
"location": {
"slot": "1",
"port": "8"
},
"profiles": []
}
]
}
]
}
},
{
"settings": {
"node": "87_5783n7",
"role": "Z_ENNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
1233
]
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
},
"location": {
"slot": "1",
"port": "11"
},
"profiles": []
}
]
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 544
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

}
],
"transportProtection": "UNPROTECTED_ONLY"
}
}

Sample response

{
"id": "5a0c9e52-0f16-4327-ae35-0fcf813fea81",
"resourceTypeId": "ifd.v3.resourceTypes.L2ServiceIntentFacade",
"productId": "5a0c9570-6537-472d-8225-094dbf3d850b",
"tenantId": "42264637-9d69-413c-9daf-a0052b73c77b",
"shared": false,
"properties": {
"serviceType": "EVPL",
"serverTrailList": [],
"name": "ET_8xMpls",
"endpoints": [
{
"settings": {
"role": "A_ENNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "8",
"slot": "1"
},
"filter": {
"outerVlanId": [
533
]
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
},
"profiles": []
}
]
}
],
"node": "87_5783n3"
}
},
{
"settings": {
"role": "Z_ENNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "11",
"slot": "1"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 545
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"filter": {
"outerVlanId": [
1233
]
},
"ingressCosSetting": {
"ingressCosPolicy": "L2PcpCos"
},
"profiles": []
}
]
}
],
"node": "87_5783n7"
}
}
],
"customerName": "DefaultCustomerName",
"transportProtection": "UNPROTECTED_ONLY",
"routeMeta": {
"originator": "BP2"
},
"structure": "P2P",
"type": "FDFR"
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-11-15T20:06:42.706Z",
"createdAt": "2017-11-15T20:06:42.706Z",
"autoClean": false
}

Note: To retrieve information, use the NSI getTPE/getFRE REST API (see Using the Service Inventory with
Packet services management.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 546
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

API calls for managing TDM packet services

This section describes the API calls used manage TDM services using packet transport:

• Retrieve unprotected E1 TDM CEM service over static MPLS (6200 endpoints)
• Retrieve unprotected E1 TDM CEM over static MPLS (CES endpoints)
• Retrieve unprotected E1 TDM CEM over static MPLS (CES and 6200 endpoints)
• Retrieve unprotected unchannelized E1 PDH CEM service over static MPLS (3932)
• Retrieve unprotected STS-1 TDM CEM over static MPLS (6500 PTS endpoints)
• Retrieve a DS1 TDM endpoint (6500 PTS endpoints)
• Create/delete unprotected E1 TDM CEM service over static MPLS (6200 endpoints)
• Create/delete unprotected E1 TDM CEM service over static MPLS (CES endpoints)
• Create/delete unprotected E1 TDM CEM service over static MPLS (CES and 6200 endpoints)
• Create/delete unprotected unchannelized E1 PDH CEM over static MPLS

Retrieve unprotected E1 TDM CEM service over static MPLS

(6200 endpoints)
As a provisioning user, you want to discover and inventory an STM-1 channelized E1 TDM CEM service
(with 6200 endpoints) using MEF8 over Static MPLS. This allows you to packetize your PDH traffic and
realize the benefits of using a packet based network.

To discover and inventory the E1 TDM CEM service, use the Services inventory (FREs) API.

Sample request

GET {{BP_SERVER}}/nsi/api/fres

Specify the layerRate as E1 and include TPES in the request:

https://<mcphostname>/nsi/api/fres?layerRate=E1&type=service&include=tpes

Sample response (TDM inventory)

{
"meta": {
"total": 48,
"aggregations": [

]
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 547
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"links": {
"next": "https:\/\/ptop.only.wip.la:443\/https\/mcp-
qa1.cyanoptics.com\/nsi\/api\/fres?layerRate=E1&type=service&include=tpes&offset=30
&limit=30"
},
"data": [
{
"id": "095c1159-29e6-36e3-bd00-a6d9cfcd11d2::FRE_testt2_8_24_TDM",
"type": "fres",
"attributes": {
"operationState": "fully operating",
"deploymentState": "discovered",
"identifiers": [
{
"networkConstructId": "095c1159-29e6-36e3-bd00-a6d9cfcd11d2",
"nodalId": "095c1159-29e6-36e3-bd00-a6d9cfcd11d2::FRE_testt2_8_24_TDM"
}
],
"derivedAttributes": {
"intentLifeCyclePhase": "adopting discovered",
"intentDeploymentState": "waiting to adopt"
},
"displayData": {
"intentLifeCyclePhaseString": "Discovered"
},
"resourceState": "discovered",
"serviceClass": "TDM",
"mgmtName": "testt2",
"layerRate": "E1",
"multiHighestStackLayerRate": "E1",
"networkRole": "IFRE",
"directionality": "bidirectional",
"topologySources": [
"discovered"
],
"signalContentType": "TDM",
"active": true,
"additionalAttributes": {
"isActual": "true"
}
},
"relationships": {
"freDiscovered": {
"data": {
"type": "freDiscovered",
"id": "095c1159-29e6-36e3-bd00-a6d9cfcd11d2::FRE_testt2_8_24_TDM"
}
},
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "095c1159-29e6-36e3-bd00-
a6d9cfcd11d2::FRE_testt2_8_24_TDM::EP0"
},
{
"type": "endPoints",
"id": "095c1159-29e6-36e3-bd00-
a6d9cfcd11d2::FRE_testt2_8_24_TDM::EP1"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 548
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

}
]
},
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "095c1159-29e6-36e3-bd00-a6d9cfcd11d2"
}
}
}
},
...
],
"included": [
{
"id": "095c1159-29e6-36e3-bd00-a6d9cfcd11d2::FRE_testt2_8_24_TDM::EP0",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "095c1159-29e6-36e3-bd00-
a6d9cfcd11d2::TPE_testt2_8_24_PTP_E1_CTP"
}
],
"meta": {
"partiallyPopulated": true
}
}
}
},
{
"id": "095c1159-29e6-36e3-bd00-a6d9cfcd11d2::FRE_testt2_8_24_TDM::EP1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "095c1159-29e6-36e3-bd00-
a6d9cfcd11d2::TPE_testt2_8_24_PTP_E1_FTP"
}
],
"meta": {
"partiallyPopulated": true
}
}
}
},
...

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 549
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

]
}

Retrieve unprotected E1 TDM CEM over static MPLS (CES

endpoints)
As a provisioning user, you want to discover and inventory an STM-1 channelized E1 TDM CEM service
(with CES devices as endpoints employing AimValley CSoP Smart SFPs) using MEF8 over Static MPLS.
This allows you to packetize your PDH traffic and realize the benefits of using a packet based network.

To discover and inventory the E1 TDM CEM service, use the Services inventory (FREs) API.

Sample request

GET {{BP_SERVER}}/nsi/api/fres

Specify the layerRate as E1 and include TPES in the request:

https://<mcphostname>/nsi/api/fres?layerRate=E1&type=service&include=tpes

Sample response (TDM inventory)

{
"meta": {
"total": 48,
"aggregations": [

]
},
"links": {
"next": "https:\/\/ptop.only.wip.la:443\/https\/mcp-
qa1.cyanoptics.com\/nsi\/api\/fres?layerRate=E1&type=service&include=tpes&offset=30
&limit=30"
},
"data": [
{
"id": "095c1159-29e6-36e3-bd00-a6d9cfcd11d2::FRE_testt2_8_24_TDM",
"type": "fres",
"attributes": {
"operationState": "fully operating",
"deploymentState": "discovered",
"identifiers": [
{
"networkConstructId": "095c1159-29e6-36e3-bd00-a6d9cfcd11d2",
"nodalId": "095c1159-29e6-36e3-bd00-a6d9cfcd11d2::FRE_testt2_8_24_TDM"
}
],
"derivedAttributes": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 550
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"intentLifeCyclePhase": "adopting discovered",

"intentDeploymentState": "waiting to adopt"
},
"displayData": {
"intentLifeCyclePhaseString": "Discovered"
},
"resourceState": "discovered",
"serviceClass": "TDM",
"mgmtName": "testt2",
"layerRate": "E1",
"multiHighestStackLayerRate": "E1",
"networkRole": "IFRE",
"directionality": "bidirectional",
"topologySources": [
"discovered"
],
"signalContentType": "TDM",
"active": true,
"additionalAttributes": {
"isActual": "true"
}
},
"relationships": {
"freDiscovered": {
"data": {
"type": "freDiscovered",
"id": "095c1159-29e6-36e3-bd00-a6d9cfcd11d2::FRE_testt2_8_24_TDM"
}
},
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "095c1159-29e6-36e3-bd00-
a6d9cfcd11d2::FRE_testt2_8_24_TDM::EP0"
},
{
"type": "endPoints",
"id": "095c1159-29e6-36e3-bd00-
a6d9cfcd11d2::FRE_testt2_8_24_TDM::EP1"
}
]
},
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "095c1159-29e6-36e3-bd00-a6d9cfcd11d2"
}
}
}
},
...
],
"included": [
{
"id": "095c1159-29e6-36e3-bd00-a6d9cfcd11d2::FRE_testt2_8_24_TDM::EP0",
"type": "endPoints",
"attributes": {
"role": "symmetric",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 551
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "095c1159-29e6-36e3-bd00-
a6d9cfcd11d2::TPE_testt2_8_24_PTP_E1_CTP"
}
],
"meta": {
"partiallyPopulated": true
}
}
}
},
{
"id": "095c1159-29e6-36e3-bd00-a6d9cfcd11d2::FRE_testt2_8_24_TDM::EP1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "095c1159-29e6-36e3-bd00-
a6d9cfcd11d2::TPE_testt2_8_24_PTP_E1_FTP"
}
],
"meta": {
"partiallyPopulated": true
}
}
}
},
...
]
}

Retrieve unprotected E1 TDM CEM over static MPLS (CES and

6200 endpoints)
As a provisioning user, you want to discover and inventory an STM-1 channelized E1 TDM CEM service
(with CES endpoint employing AimValley CSoP Smart SFP and 6200 endpoint) using MEF8 over Static
MPLS. This allows you to packetize your PDH traffic and realize the benefits of using a packet based
network.

To discover and inventory the E1 TDM CEM service, use the Services inventory (FREs) API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 552
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Sample request

GET {{BP_SERVER}}/nsi/api/fres

Specify the layerRate as E1 and include TPES in the request:

https://<mcphostname>/nsi/api/fres?layerRate=E1&type=service&include=tpes

Sample response (TDM inventory)

{
"meta": {
"total": 48,
"aggregations": [

]
},
"links": {
"next": "https:\/\/ptop.only.wip.la:443\/https\/mcp-
qa1.cyanoptics.com\/nsi\/api\/fres?layerRate=E1&type=service&include=tpes&offset=30
&limit=30"
},
"data": [
{
"id": "095c1159-29e6-36e3-bd00-a6d9cfcd11d2::FRE_testt2_8_24_TDM",
"type": "fres",
"attributes": {
"operationState": "fully operating",
"deploymentState": "discovered",
"identifiers": [
{
"networkConstructId": "095c1159-29e6-36e3-bd00-a6d9cfcd11d2",
"nodalId": "095c1159-29e6-36e3-bd00-a6d9cfcd11d2::FRE_testt2_8_24_TDM"
}
],
"derivedAttributes": {
"intentLifeCyclePhase": "adopting discovered",
"intentDeploymentState": "waiting to adopt"
},
"displayData": {
"intentLifeCyclePhaseString": "Discovered"
},
"resourceState": "discovered",
"serviceClass": "TDM",
"mgmtName": "testt2",
"layerRate": "E1",
"multiHighestStackLayerRate": "E1",
"networkRole": "IFRE",
"directionality": "bidirectional",
"topologySources": [
"discovered"
],
"signalContentType": "TDM",
"active": true,
"additionalAttributes": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 553
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"isActual": "true"
}
},
"relationships": {
"freDiscovered": {
"data": {
"type": "freDiscovered",
"id": "095c1159-29e6-36e3-bd00-a6d9cfcd11d2::FRE_testt2_8_24_TDM"
}
},
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "095c1159-29e6-36e3-bd00-
a6d9cfcd11d2::FRE_testt2_8_24_TDM::EP0"
},
{
"type": "endPoints",
"id": "095c1159-29e6-36e3-bd00-
a6d9cfcd11d2::FRE_testt2_8_24_TDM::EP1"
}
]
},
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "095c1159-29e6-36e3-bd00-a6d9cfcd11d2"
}
}
}
},
...
],
"included": [
{
"id": "095c1159-29e6-36e3-bd00-a6d9cfcd11d2::FRE_testt2_8_24_TDM::EP0",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "095c1159-29e6-36e3-bd00-
a6d9cfcd11d2::TPE_testt2_8_24_PTP_E1_CTP"
}
],
"meta": {
"partiallyPopulated": true
}
}
}
},
{
"id": "095c1159-29e6-36e3-bd00-a6d9cfcd11d2::FRE_testt2_8_24_TDM::EP1",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 554
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "095c1159-29e6-36e3-bd00-
a6d9cfcd11d2::TPE_testt2_8_24_PTP_E1_FTP"
}
],
"meta": {
"partiallyPopulated": true
}
}
}
},
...
]
}

Retrieve unprotected unchannelized E1 PDH CEM service over

static MPLS (3932)
As a provisioning user, you want to discover and inventory an unprotected, unchannelized E1 PDH CEM
service (with CES endpoints) using MEF8 over Static MPLS bi-directional, co-routed LSP. This allows you
to packetize your PDH traffic and realize the benefits of using a packet based network.

To discover and inventory the E1 PDH CEM service, use the Services inventory (FREs) API.

Sample request

GET {{BP_SERVER}}/nsi/api/fres

Specify the layerRate as E1 and include TPES in the request:

https://<mcphostname>/nsi/api/fres?layerRate=E1&type=service&include=tpes

Sample response (TDM inventory)

{
"meta": {
"total": 48,
"aggregations": [

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 555
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

]
},
"links": {
"next": "https:\/\/ptop.only.wip.la:443\/https\/mcp-
qa1.cyanoptics.com\/nsi\/api\/fres?layerRate=E1&type=service&include=tpes&offset=30
&limit=30"
},
"data": [
{
"id": "095c1159-29e6-36e3-bd00-a6d9cfcd11d2::FRE_testt2_8_24_TDM",
"type": "fres",
"attributes": {
"operationState": "fully operating",
"deploymentState": "discovered",
"identifiers": [
{
"networkConstructId": "095c1159-29e6-36e3-bd00-a6d9cfcd11d2",
"nodalId": "095c1159-29e6-36e3-bd00-a6d9cfcd11d2::FRE_testt2_8_24_TDM"
}
],
"derivedAttributes": {
"intentLifeCyclePhase": "adopting discovered",
"intentDeploymentState": "waiting to adopt"
},
"displayData": {
"intentLifeCyclePhaseString": "Discovered"
},
"resourceState": "discovered",
"serviceClass": "TDM",
"mgmtName": "testt2",
"layerRate": "E1",
"multiHighestStackLayerRate": "E1",
"networkRole": "IFRE",
"directionality": "bidirectional",
"topologySources": [
"discovered"
],
"signalContentType": "TDM",
"active": true,
"additionalAttributes": {
"isActual": "true"
}
},
"relationships": {
"freDiscovered": {
"data": {
"type": "freDiscovered",
"id": "095c1159-29e6-36e3-bd00-a6d9cfcd11d2::FRE_testt2_8_24_TDM"
}
},
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "095c1159-29e6-36e3-bd00-
a6d9cfcd11d2::FRE_testt2_8_24_TDM::EP0"
},
{
"type": "endPoints",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 556
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"id": "095c1159-29e6-36e3-bd00-
a6d9cfcd11d2::FRE_testt2_8_24_TDM::EP1"
}
]
},
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "095c1159-29e6-36e3-bd00-a6d9cfcd11d2"
}
}
}
},
...
],
"included": [
{
"id": "095c1159-29e6-36e3-bd00-a6d9cfcd11d2::FRE_testt2_8_24_TDM::EP0",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "095c1159-29e6-36e3-bd00-
a6d9cfcd11d2::TPE_testt2_8_24_PTP_E1_CTP"
}
],
"meta": {
"partiallyPopulated": true
}
}
}
},
{
"id": "095c1159-29e6-36e3-bd00-a6d9cfcd11d2::FRE_testt2_8_24_TDM::EP1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "095c1159-29e6-36e3-bd00-
a6d9cfcd11d2::TPE_testt2_8_24_PTP_E1_FTP"
}
],
"meta": {
"partiallyPopulated": true
}
}
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 557
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

},
...
]
}

Retrieve unprotected STS-1 TDM CEM over static MPLS (6500

PTS endpoints)
As a provisioning user, you want to discover and inventory an OC-N channelized STS-1 TDM CEM service
(with 6500 PTS) using CEP over Static MPLS. This allows you to packetize your TDM traffic and realize
the benefits of using a packet-based network.

To discover and inventory the STS-1 TDM CEM service, use the Services inventory (FREs) API.

Sample request

GET {{BP_SERVER}}/nsi/api/fres

Specify the layerRate as STS-1 and include TPES in the request:

https://<mcphostname>/nsi/api/v4/fres?layerRate=STS1&type=service&include=tpes

Sample response (TDM inventory)

{
"meta": {
"total": 3,
"aggregations": [
]
},
"data": [
{
"id": "1380852671881973023",
"type": "fres",
"attributes": {
"operationState": "In Service",
"deploymentState": "discovered",
"derivedAttributes": {
"intentLifeCyclePhase": "adopting discovered",
"intentDeploymentState": "waiting to adopt"
},
"displayData": {
"intentLifeCyclePhaseString": "Discovered",
"operationState": "Up",
"adminState": "Enabled"
},
"resourceState": "discovered",
"policies": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 558
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"defaultAttributeSourcePolicy": "discoveredOverPlanned",
"overrides": [
{
"attributeName": "attributes.userLabel",
"policies": [
"plannedOverDiscovered"
]
}
]
},
"serviceClass": "TDM",
"tags": [
"CEP"
],
"userLabel": "tdmvc_srv901",
"mgmtName": "tdmvc_srv901",
"nativeName": "",
"layerRate": "STS1",
"networkRole": "IFRE",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"adminState": "In Service",
"signalContentType": "TDM",
"usedBandwidth": [
{
"layer": "ETHERNET",
"capacity": 1,
"capacitySize": {
"size": [
"1.0"
],
"pattern": {
"type": "POOL",
"format": "number"
},
"unit": "mbps"
}
}
],
"active": true,
"additionalAttributes": {
"isActual": "true"
},
"reliability": "manual"
},
"relationships": {
"freDiscovered": {
"data": {
"type": "freDiscovered",
"id": "1380852671881973023"
}
},
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "1380852671881973023:1"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 559
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

},
{
"type": "endPoints",
"id": "1380852671881973023:2"
}
]
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "-2673296440621120110"
},
{
"type": "fres",
"id": "35cb8585-d5a5-396f-a4f0-edb4b0e6b51b::FRE_tdmvc_srv901_1-2-
9_S1P1_TDM"
},
{
"type": "fres",
"id": "267de837-45d6-3fe9-9528-e19a6765b481::FRE_tdmvc_srv901_1-2-
9_S1P1_TDM"
}
]
}
}
},
{
"id": "267de837-45d6-3fe9-9528-e19a6765b481::FRE_tdmvc_srv901_1-2-
9_S1P1_TDM",
"type": "fres",
"attributes": {
"operationState": "fully operating",
"deploymentState": "discovered",
"identifiers": [
{
"networkConstructId": "267de837-45d6-3fe9-9528-e19a6765b481",
"nodalId": "267de837-45d6-3fe9-9528-e19a6765b481::FRE_tdmvc_srv901_1-2-
9_S1P1_TDM"
}
],
"derivedAttributes": {
"intentLifeCyclePhase": "adopting discovered",
"intentDeploymentState": "waiting to adopt"
},
"displayData": {
"intentLifeCyclePhaseString": "Discovered",
"operationState": "Up"
},
"resourceState": "discovered",
"policies": {
"defaultAttributeSourcePolicy": "discoveredOverPlanned",
"overrides": [
{
"attributeName": "attributes.userLabel",
"policies": [
"plannedOverDiscovered"
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 560
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

]
},
"userLabel": "tdmvc_srv901",
"mgmtName": "tdmvc_srv901",
"layerRate": "STS1",
"multiHighestStackLayerRate": "STS1",
"networkRole": "IFRE",
"directionality": "bidirectional",
"topologySources": [
"discovered"
],
"signalContentType": "TDM",
"active": true,
"additionalAttributes": {
"isActual": "true"
}
},
"relationships": {
"freDiscovered": {
"data": {
"type": "freDiscovered",
"id": "267de837-45d6-3fe9-9528-e19a6765b481::FRE_tdmvc_srv901_1-2-
9_S1P1_TDM"
}
},
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "267de837-45d6-3fe9-9528-e19a6765b481::FRE_tdmvc_srv901_1-2-
9_S1P1_TDM::EP0"
},
{
"type": "endPoints",
"id": "267de837-45d6-3fe9-9528-e19a6765b481::FRE_tdmvc_srv901_1-2-
9_S1P1_TDM::EP1"
}
]
},
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "267de837-45d6-3fe9-9528-e19a6765b481"
}
}
}
},
{
"id": "35cb8585-d5a5-396f-a4f0-edb4b0e6b51b::FRE_tdmvc_srv901_1-2-
9_S1P1_TDM",
"type": "fres",
"attributes": {
"operationState": "fully operating",
"deploymentState": "discovered",
"identifiers": [
{
"networkConstructId": "35cb8585-d5a5-396f-a4f0-edb4b0e6b51b",
"nodalId": "35cb8585-d5a5-396f-a4f0-edb4b0e6b51b::FRE_tdmvc_srv901_1-2-
9_S1P1_TDM"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 561
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

}
],
"derivedAttributes": {
"intentLifeCyclePhase": "adopting discovered",
"intentDeploymentState": "waiting to adopt"
},
"displayData": {
"intentLifeCyclePhaseString": "Discovered",
"operationState": "Up"
},
"resourceState": "discovered",
"policies": {
"defaultAttributeSourcePolicy": "discoveredOverPlanned",
"overrides": [
{
"attributeName": "attributes.userLabel",
"policies": [
"plannedOverDiscovered"
]
}
]
},
"userLabel": "tdmvc_srv901",
"mgmtName": "tdmvc_srv901",
"layerRate": "STS1",
"multiHighestStackLayerRate": "STS1",
"networkRole": "IFRE",
"directionality": "bidirectional",
"topologySources": [
"discovered"
],
"signalContentType": "TDM",
"active": true,
"additionalAttributes": {
"isActual": "true"
}
},
"relationships": {
"freDiscovered": {
"data": {
"type": "freDiscovered",
"id": "35cb8585-d5a5-396f-a4f0-edb4b0e6b51b::FRE_tdmvc_srv901_1-2-
9_S1P1_TDM"
}
},
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "35cb8585-d5a5-396f-a4f0-edb4b0e6b51b::FRE_tdmvc_srv901_1-2-
9_S1P1_TDM::EP0"
},
{
"type": "endPoints",
"id": "35cb8585-d5a5-396f-a4f0-edb4b0e6b51b::FRE_tdmvc_srv901_1-2-
9_S1P1_TDM::EP1"
}
]
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 562
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "35cb8585-d5a5-396f-a4f0-edb4b0e6b51b"
}
}
}
}
],
"included": [
{
"id": "1380852671881973023:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "267de837-45d6-3fe9-9528-e19a6765b481::TPE_1-2-
9_S1P1_PTP_STS1_CTPServerToClient"
}
],
"meta": {
"partiallyPopulated": true
}
}
}
},
{
"id": "1380852671881973023:2",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "35cb8585-d5a5-396f-a4f0-edb4b0e6b51b::TPE_1-2-
9_S1P1_PTP_STS1_CTPServerToClient"
}
],
"meta": {
"partiallyPopulated": true
}
}
}
},
{
"id": "267de837-45d6-3fe9-9528-e19a6765b481::FRE_tdmvc_srv901_1-2-
9_S1P1_TDM::EP0",
"type": "endPoints",
"attributes": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 563
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "267de837-45d6-3fe9-9528-e19a6765b481::TPE_1-2-
9_S1P1_PTP_STS1_CTPServerToClient"
}
],
"meta": {
"partiallyPopulated": true
}
}
}
},
{
"id": "267de837-45d6-3fe9-9528-e19a6765b481::FRE_tdmvc_srv901_1-2-
9_S1P1_TDM::EP1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "267de837-45d6-3fe9-9528-e19a6765b481::TPE_tdmvc_srv901_1-2-
9_S1P1_PTP_CES_IWF_FTP"
}
],
"meta": {
"partiallyPopulated": true
}
}
}
},
{
"id": "35cb8585-d5a5-396f-a4f0-edb4b0e6b51b::FRE_tdmvc_srv901_1-2-
9_S1P1_TDM::EP0",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "35cb8585-d5a5-396f-a4f0-edb4b0e6b51b::TPE_1-2-
9_S1P1_PTP_STS1_CTPServerToClient"
}
],
"meta": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 564
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"partiallyPopulated": true
}
}
}
},
{
"id": "35cb8585-d5a5-396f-a4f0-edb4b0e6b51b::FRE_tdmvc_srv901_1-2-
9_S1P1_TDM::EP1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "35cb8585-d5a5-396f-a4f0-edb4b0e6b51b::TPE_tdmvc_srv901_1-2-
9_S1P1_PTP_CES_IWF_FTP"
}
],
"meta": {
"partiallyPopulated": true
}
}
}
},
{
"id": "267de837-45d6-3fe9-9528-e19a6765b481::TPE_1-2-
9_S1P1_PTP_STS1_CTPServerToClient",
"type": "tpes",
"attributes": {
"structureType": "CTPServerToClient",
"locations": [
{
"managementType": "tl1",
"shelf": "1",
"slot": "2",
"port": "9",
"channel": "S1P1"
}
]
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "267de837-45d6-3fe9-9528-e19a6765b481"
}
},
"equipment": {
"data": {
"type": "equipment",
"id": "267de837-45d6-3fe9-9528-e19a6765b481::EQPT_1_2"
}
}
}
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 565
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "35cb8585-d5a5-396f-a4f0-edb4b0e6b51b::TPE_1-2-
9_S1P1_PTP_STS1_CTPServerToClient",
"type": "tpes",
"attributes": {
"structureType": "CTPServerToClient",
"locations": [
{
"managementType": "tl1",
"shelf": "1",
"slot": "2",
"port": "9",
"channel": "S1P1"
}
]
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "35cb8585-d5a5-396f-a4f0-edb4b0e6b51b"
}
},
"equipment": {
"data": {
"type": "equipment",
"id": "35cb8585-d5a5-396f-a4f0-edb4b0e6b51b::EQPT_1_2"
}
}
}
},
{
"id": "267de837-45d6-3fe9-9528-e19a6765b481::TPE_1-2-
9_S1P1_PTP_STS1_CTPServerToClient",
"type": "tpes",
"attributes": {
"structureType": "CTPServerToClient",
"locations": [
{
"managementType": "tl1",
"shelf": "1",
"slot": "2",
"port": "9",
"channel": "S1P1"
}
]
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "267de837-45d6-3fe9-9528-e19a6765b481"
}
},
"equipment": {
"data": {
"type": "equipment",
"id": "267de837-45d6-3fe9-9528-e19a6765b481::EQPT_1_2"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 566
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

}
}
},
{
"id": "267de837-45d6-3fe9-9528-e19a6765b481::TPE_tdmvc_srv901_1-2-
9_S1P1_PTP_CES_IWF_FTP",
"type": "tpes",
"attributes": {
"structureType": "FTP",
"locations": [
{
"managementType": "saos",
"shelf": "1",
"slot": "2",
"port": "9"
}
]
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "267de837-45d6-3fe9-9528-e19a6765b481"
}
}
}
},
{
"id": "35cb8585-d5a5-396f-a4f0-edb4b0e6b51b::TPE_1-2-
9_S1P1_PTP_STS1_CTPServerToClient",
"type": "tpes",
"attributes": {
"structureType": "CTPServerToClient",
"locations": [
{
"managementType": "tl1",
"shelf": "1",
"slot": "2",
"port": "9",
"channel": "S1P1"
}
]
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "35cb8585-d5a5-396f-a4f0-edb4b0e6b51b"
}
},
"equipment": {
"data": {
"type": "equipment",
"id": "35cb8585-d5a5-396f-a4f0-edb4b0e6b51b::EQPT_1_2"
}
}
}
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 567
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"id": "35cb8585-d5a5-396f-a4f0-edb4b0e6b51b::TPE_tdmvc_srv901_1-2-
9_S1P1_PTP_CES_IWF_FTP",
"type": "tpes",
"attributes": {
"structureType": "FTP",
"locations": [
{
"managementType": "saos",
"shelf": "1",
"slot": "2",
"port": "9"
}
]
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "35cb8585-d5a5-396f-a4f0-edb4b0e6b51b"
}
}
}
}
]
}

Retrieve a DS1 TDM endpoint (6500 PTS endpoints)

As a user, you want to discover and inventory a DS1 TDM endpoint on 6500 PTS, which allows you to
packetize TDM traffic and realize the benefits of using a packet-based network.

To query a discovered and inventoried DS1 TDM endpoint, use the Port inventory (TPEs) API.

Sample request

GET {{MCP_SERVER}}/nsi/api/tpes

https://<mcphostname>/nsi/api/v5/tpes?id=267de837-45d6-3fe9-9528-
e19a6765b481::TPE_1-1S1-1_D1P1_PTP_DS1_CTPServerToClient

Query all TPEs, or specify the ID of a TPE that may have been included in the response to a service FRE
query:

https://<mcphostname>/nsi/api/tpes

Sample response (TDM inventory)

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 568
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": [
{
"id": "267de837-45d6-3fe9-9528-e19a6765b481::TPE_1-1S1-
1_D1P1_PTP_DS1_CTPServerToClient",
"type": "tpes",
"attributes": {
"identifiers": [
{
"networkConstructId": "267de837-45d6-3fe9-9528-e19a6765b481",
"nodalId": "267de837-45d6-3fe9-9528-e19a6765b481::TPE_1-1S1-
1_D1P1_PTP_DS1_CTPServerToClient"
}
],
"resourceState": "discovered",
"structureType": "CTPServerToClient",
"locations": [
{
"managementType": "tl1",
"shelf": "1",
"slot": "1",
"subslot": "1",
"port": "1",
"channel": "D1P1"
}
],
"layerTerminations": [
{
"layerRate": "DS1",
"structureType": "exposed lone cp",
"terminationState": "layer termination permanently terminated",
"active": true,
"additionalAttributes": {
"rtpSetting": "On",
"signalContentType": "TDM"
}
}
],
"stackDirection": "bidirectional",
"displayAlias": "CTP-1-1-1D1P1",
"cardType": "PTSIF",
"active": true,
"additionalAttributes": {
"tdmChannel": "D1P1",
"pkt:MAPPING": "SATOP",
"pkt:TXMON": "NO",
"clockRecoveryMode": "DCR",
"pktiwf": "PKTIWF-1-1S1-101",
"pkt:CAS": "OFF",
"jitterBuffer": "4"
}
},
"relationships": {
"tpeDiscovered": {
"data": {
"type": "tpeDiscovered",
"id": "267de837-45d6-3fe9-9528-e19a6765b481::TPE_1-1S1-
1_D1P1_PTP_DS1_CTPServerToClient"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 569
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

},
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "267de837-45d6-3fe9-9528-e19a6765b481"
},
"meta": {
"partiallyPopulated": true
}
},
"equipment": {
"data": {
"type": "equipment",
"id": "267de837-45d6-3fe9-9528-e19a6765b481::EQPT_1_1"
}
},
"owningServerTpe": {
"data": {
"type": "tpes",
"id": "267de837-45d6-3fe9-9528-e19a6765b481::TPE_1-1S1-1_PTP"
}
}
}
}
]
}

Create/delete unprotected E1 TDM CEM service over static

MPLS (6200 endpoints)
As a provisioning user, you want to create (and delete) an unprotected E1 TDM CEM service over Static
MPLS (unprotected PW and 2-endpoint protected PW) using 6200s as endpoint nodes. You can aggregate
TDM CEM E1s at an aggregation node and hand off individual E1s or an STM-1, to be able to packetize
your TDM/PDH traffic and realize the benefits of using a packet based network.

To create (and delete) the E1 TDM CEM service, use the Market API.

POST {{BP_SERVER}}/bpocore/market/api/v1/resources

Note the following TDM specific parameters used in the sample request below:

Path: properties/tdm/layerRate
Value: “E1”

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 570
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Path: properties/tdm/endpoints
Subpath: networkElement/Name
Value: <Node Name>
Subpath: port
Value: <port name>
Subpath: shelf
Value: <shelf name>
Subpath: slot
Value <slot name>
Subpath: signalIndex
Value: <signal index on SFP>

Path: properties/endpoints/settings/details/flowSettings/filter/outerVlanId
Value: Int range(1-4094)

Path: properties/endpoints/settings/details/flowSettings/location/port
Value: “FTP”

Sample request

{
"productId": "5a2e7dcf-bdcc-444d-bdb0-329b6c1e9a28",
"desiredOrchState": "active",
"label": "TDM_PW_20_",
"discovered": false,
"properties": {
"tdm": {
"layerRate": "E1",
"endPoints": [
{
"networkElement": {
"name": "SJ_6200_171"
},
"port": "36",
"shelf": "1",
"slot": "5",
"signalIndex": "20"
},
{
"networkElement": {
"name": "SJ_6200_220"
},
"port": "36",
"shelf": "1",
"slot": "5",
"signalIndex": "20"
}
]
},
"endpoints": [
{
"settings": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 571
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"node": "SJ_6200_171",
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "FTP"
},
"profiles": [
{
"profileType": "filter",
"profileName": "VLAN"
}
],
"filter": {
"outerVlanId": [
595
]
}
}
]
}
]
}
},
{
"settings": {
"node": "SJ_6200_220",
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "FTP"
},
"profiles": [
{
"profileType": "filter",
"profileName": "VLAN"
}
],
"filter": {
"outerVlanId": [
595
]
}
}
]
}
]
}
}
],
"routeMeta": {
"originator": "BP2"
},
"name": "TDM_PW_20_",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 572
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"customerName": "Ciena SE",

"serviceType": "EVPL",
"serverTrailList": [],
"structure": "P2P",
"type": "FDFR"
}
}

Sample response

{
"id": "5a2e9184-a77a-450c-911e-df74a5be9ba2",
"label": "TDM_PW_20_",
"resourceTypeId": "ifd.v3.resourceTypes.TDMServiceIntentFacade",
"productId": "5a2e7dcf-bdcc-444d-bdb0-329b6c1e9a28",
"tenantId": "714ee434-51b5-4036-b583-bf7dace0db8f",
"shared": false,
"properties": {
"serviceType": "EVPL",
"serverTrailList": [

],
"name": "TDM_PW_20_",
"tdm": {
"endPoints": [
{
"signalIndex": "20",
"shelf": "1",
"networkElement": {
"name": "SJ_6200_171"
},
"port": "36",
"slot": "5"
},
{
"signalIndex": "20",
"shelf": "1",
"networkElement": {
"name": "SJ_6200_220"
},
"port": "36",
"slot": "5"
}
],
"layerRate": "E1"
},
"endpoints": [
{
"settings": {
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "FTP"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 573
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"filter": {
"outerVlanId": [
595
]
},
"profiles": [
{
"profileName": "VLAN",
"profileType": "filter"
}
]
}
]
}
],
"node": "SJ_6200_171"
}
},
{
"settings": {
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "FTP"
},
"filter": {
"outerVlanId": [
595
]
},
"profiles": [
{
"profileName": "VLAN",
"profileType": "filter"
}
]
}
]
}
],
"node": "SJ_6200_220"
}
}
],
"customerName": "Ciena SE",
"reuseExistingPseudowire": false,
"routeMeta": {
"originator": "BP2"
},
"structure": "P2P",
"type": "FDFR"
},
"discovered": false,
"differences": [

],

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 574
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {

},
"providerData": {

},
"updatedAt": "2017-12-11T14:09:08.476Z",
"createdAt": "2017-12-11T14:09:08.476Z",
"autoClean": false
}

Create/delete unprotected E1 TDM CEM service over static

MPLS (CES endpoints)
As a provisioning user, you want to create (and delete) an unprotected E1 TDM CEM service over Static
MPLS (unprotected PW and 2-endpoint protected PW) using CES devices as endpoint nodes employing
AimValley CSoP Smart SFPs. You can aggregate TDM CEM E1s at an aggregation node and hand off
individual E1s or an STM-1, to be able to packetize your TDM/PDH traffic and realize the benefits of using
a packet based network.

To create (and delete) the E1 TDM CEM service, use the Market API.

POST {{BP_SERVER}}/bpocore/market/api/v1/resources

Note the following TDM specific parameters used in the sample request below:

Path: properties/tdm/layerRate
Value: “E1”

Path: properties/tdm/endpoints
Subpath: networkElement/Name
Value: <Node Name>
Subpath: port
Value: <port name>
Subpath: signalIndex
Value: <signal index on SFP>

Path: properties/endpoints/settings/details/flowSettings/filter/outerVlanId
Value: Int range(1-4094)

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 575
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Path: properties/endpoints/settings/details/flowSettings/location/port
Value: “FTP”

Sample request

{
"productId": "5a2e7dcf-bdcc-444d-bdb0-329b6c1e9a28",
"desiredOrchState": "active",
"label": "TDM_PW_20SR6_reuse",
"discovered": false,
"properties": {
"tdm": {
"layerRate": "E1",
"endPoints": [
{
"networkElement": {
"name": "5160_0054"
},
"port": "7",
"signalIndex": "36"
},
{
"networkElement": {
"name": "3932_0023"
},
"port": "7",
"signalIndex": "36"
}
]
},
"endpoints": [
{
"settings": {
"node": "5160_0054",
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "FTP"
},
"profiles": [
{
"profileType": "filter",
"profileName": "VLAN"
}
],
"filter": {
"outerVlanId": [
625
]
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 576
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

]
}
},
{
"settings": {
"node": "3932_0023",
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "FTP"
},
"profiles": [
{
"profileType": "bandwidth",
"profileName": "custom"
},
{
"profileType": "filter",
"profileName": "VLAN"
}
],
"filter": {
"outerVlanId": [
625
]
}
}
]
}
]
}
}
],
"routeMeta": {
"originator": "BP2"
},
"name": "TDM_PW_20SR6_reuse",
"customerName": "Ciena SE",
"serviceType": "EVPL",
"serverTrailList": [

],
"structure": "P2P",
"type": "FDFR"
}
}

Sample response

{
"id": "5a2e95e2-f92b-450c-b1f1-6e725a65a717",
"label": "TDM_PW_20SR6_reuse",
"resourceTypeId": "ifd.v3.resourceTypes.TDMServiceIntentFacade",
"productId": "5a2e7dcf-bdcc-444d-bdb0-329b6c1e9a28",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 577
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"tenantId": "714ee434-51b5-4036-b583-bf7dace0db8f",
"shared": false,
"properties": {
"serviceType": "EVPL",
"serverTrailList": [

],
"name": "TDM_PW_20SR6_reuse",
"tdm": {
"endPoints": [
{
"signalIndex": "36",
"networkElement": {
"name": "5160_0054"
},
"port": "7"
},
{
"signalIndex": "36",
"networkElement": {
"name": "3932_0023"
},
"port": "7"
}
],
"layerRate": "E1"
},
"endpoints": [
{
"settings": {
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "FTP"
},
"filter": {
"outerVlanId": [
625
]
},
"profiles": [
{
"profileName": "Gold",
"profileType": "bandwidth"
},
{
"profileName": "VLAN",
"profileType": "filter"
}
]
}
]
}
],
"node": "5160_0054"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 578
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

},
{
"settings": {
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "FTP"
},
"filter": {
"outerVlanId": [
625
]
},
"profiles": [
{
"profileName": "custom",
"profileType": "bandwidth"
},
{
"profileName": "VLAN",
"profileType": "filter"
}
]
}
]
}
],
"node": "3932_0023"
}
}
],
"customerName": "Ciena SE",
"reuseExistingPseudowire": false,
"routeMeta": {
"originator": "BP2"
},
"structure": "P2P",
"type": "FDFR"
},
"discovered": false,
"differences": [

],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {

},
"providerData": {

},
"updatedAt": "2017-12-11T14:27:47.012Z",
"createdAt": "2017-12-11T14:27:47.012Z",
"autoClean": false
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 579
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Create/delete unprotected E1 TDM CEM service over static

MPLS (CES and 6200 endpoints)
As a provisioning user, you want to create (and delete) an unprotected E1 TDM CEM service over Static
MPLS (unprotected PW and 2-endpoint protected PW) using a CES device with an AimValley CSoP Smart
SFP and a 6200 as service endpoints. You can aggregate TDM CEM E1s at an aggregation node and hand
off individual E1s or an STM-1, to be able to packetize your TDM/PDH traffic and realize the benefits of
using a packet based network.

To create (and delete) the E1 TDM CEM service, use the Market API.

POST {{BP_SERVER}}/bpocore/market/api/v1/resources

Note the following TDM specific parameters used in the sample request below:

Path: properties/tdm/layerRate
Value: “E1”

CES (AIMValley SFP)

Path: properties/tdm/endpoints
Subpath: networkElement/Name
Value: <Node Name>
Subpath: port
Value: <port name>
Subpath: signalIndex
Value: <signal index on SFP>

6200
Path: properties/tdm/endpoints
Subpath: networkElement/Name
Value: <Node Name>
Subpath: port
Value: <port name>
Subpath: shelf
Value: <shelf name>
Subpath: slot
Value: <slot name>
Subpath: signalIndex
Value: <signal index on SFP>

Path: properties/endpoints/settings/details/flowSettings/filter/outerVlanId
Value: Int range(1-4094)

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 580
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Path: properties/endpoints/settings/details/flowSettings/location/port
Value: “FTP”

Sample request

{
"productId": "5a2e7dcf-bdcc-444d-bdb0-329b6c1e9a28",
"desiredOrchState": "active",
"label": "TDM_PW_20SR6",
"discovered": false,
"properties": {
"tdm": {
"layerRate": "E1",
"endPoints": [
{
"networkElement": {
"name": "5160_0054"
},
"port": "7",
"signalIndex": "36"
},
{
"networkElement": {
"name": "SJ_6200_220"
},
"shelf": "1",
"slot": "5",
"port": "7",
"signalIndex": "36"
}
]
},
"endpoints": [
{
"settings": {
"node": "5160_0054",
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "FTP"
},
"profiles": [
{
"profileType": "bandwidth",
"profileName": "Gold"
},
{
"profileType": "filter",
"profileName": "VLAN"
}
],
"filter": {
"outerVlanId": [

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 581
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

625
]
}
}
]
}
]
}
},
{
"settings": {
"node": "3932_0023",
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "FTP"
},
"profiles": [
{
"profileType": "bandwidth",
"profileName": "custom"
},
{
"profileType": "filter",
"profileName": "VLAN"
}
],
"filter": {
"outerVlanId": [
625
]
}
}
]
}
]
}
}
],
"routeMeta": {
"originator": "BP2"
},
"name": "TDM_PW_20SR6_reuse",
"customerName": "Ciena SE",
"serviceType": "EVPL",
"serverTrailList": [

],
"structure": "P2P",
"type": "FDFR"
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 582
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "5a2fc123-9912-43ca-9c28-b348f0d982f1",
"label": "TDM_PW_20SR6",
"resourceTypeId": "ifd.v3.resourceTypes.TDMServiceIntentFacade",
"productId": "5a2e7dcf-bdcc-444d-bdb0-329b6c1e9a28",
"tenantId": "714ee434-51b5-4036-b583-bf7dace0db8f",
"shared": false,
"properties": {
"serviceType": "EVPL",
"serverTrailList": [

],
"name": "TDM_PW_20SR6_reuse",
"tdm": {
"endPoints": [
{
"signalIndex": "36",
"networkElement": {
"name": "5160_0054"
},
"port": "7"
},
{
"signalIndex": "36",
"shelf": "1",
"networkElement": {
"name": "SJ_6200_220"
},
"port": "7",
"slot": "5"
}
],
"layerRate": "E1"
},
"endpoints": [
{
"settings": {
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "FTP"
},
"filter": {
"outerVlanId": [
625
]
},
"profiles": [
{
"profileName": "Gold",
"profileType": "bandwidth"
},
{
"profileName": "VLAN",
"profileType": "filter"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 583
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

]
}
]
}
],
"node": "5160_0054"
}
},
{
"settings": {
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "FTP"
},
"filter": {
"outerVlanId": [
625
]
},
"profiles": [
{
"profileName": "custom",
"profileType": "bandwidth"
},
{
"profileName": "VLAN",
"profileType": "filter"
}
]
}
]
}
],
"node": "3932_0023"
}
}
],
"customerName": "Ciena SE",
"reuseExistingPseudowire": false,
"routeMeta": {
"originator": "BP2"
},
"structure": "P2P",
"type": "FDFR"
},
"discovered": false,
"differences": [

],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {

},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 584
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"providerData": {

},
"updatedAt": "2017-12-12T11:44:36.084Z",
"createdAt": "2017-12-12T11:44:36.084Z",
"autoClean": false
}

Create/delete unprotected unchannelized E1 PDH CEM over

static MPLS
You can use the MCP REST API to create an unprotected, unchannelized E1 PDH CEM service (with CES
endpoints) using MEF8 over Static MPLS bi-directional, co-routed CAC based LSP. This allows you to
packetize your PDH traffic and realize the benefits of using a packet based network.

Note: You can use the same methos described here to create and delete TDM CEM E1 (using MEF8)
services features with endpoints on 3926 nodes that are running SAOS 6.17.

To create (and delete) the E1 PDH CEM service, use the Market API.

POST {{BP_SERVER}}/bpocore/market/api/v1/resources

Note the following TDM specific parameters used in the sample request below:

• Path: properties/tdm/layerRate
◦ Value: “E1”
• Path: properties/tdm/endpoints
◦ Subpath: networkElement/Name
• Value: <Node Name>
◦ Subpath: port
◦ Value: <port name>
• Path: properties/endpoints/settings/details/flowSettings/filter/outerVlanId
• Value: Int range(1-4094)
• Path: properties/endpoints/settings/details/flowSettings/location/port
• Value: “FTP”
• reuseExistingPseudowire
◦ Supported values: True|False
• tdmCosSettings: pcp
◦ Supported values: INT(0:7)
• rtpSetting

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 585
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

◦ Supported values: ON|OFF

• clockRecoveryMode
◦ Supported values: INTERNAL|ADAPTIVE|DIFFERENTIAL|RECOVERED
• jitterBuffer
◦ Supported values: INT(2:32)
• syncFreqProtGroup

◦ Supported values: This parameter should either be included, not included, or set to the name of an
existing "port tdm sync frequency protection-group" entry on the device. The "group_name" value
can be any string. It must correspond to a protection-group configured on the device.
Note: If required, consult the CES device documentation for help creating the protection group.

Sample request

{
"productId": "{{TDM_FACADE_PID}}",
"desiredOrchState": "active",
"label": "TDM_PW_CLOCKRECOVERY3",
"discovered": false,
"properties": {
"interactive_mode": "false",
"tdm": {
"layerRate": "E1",
"endPoints": [{
"networkElement": {
"name": "5160_0054"
},
"port": "7",
"signalIndex": "56"
},
{
"networkElement": {
"name": "3932_0023"
},
"port": "7",
"signalIndex": "56",
"clockRecoveryMode": "ADAPTIVE",
"jitterBuffer": 55,
"syncFreqProtGroup": "group_name",
"rtpSetting": "ON",
"tdmCosSettings": {
"pcp": 4
}
}
]
},
"endpoints": [{
"settings": {
"node": "5160_0054",
"role": "A_UNI",
"details": [{
"flowSettings": [{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 586
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"location": {
"port": "FTP"
},
"profiles": [{
"profileType": "filter",
"profileName": "VLAN"
}],
"filter": {
"outerVlanId": [1182]
}
}]
}]
}
},
{
"settings": {
"node": "3932_0023",
"role": "Z_UNI",
"details": [{
"flowSettings": [{
"location": {
"port": "FTP"
},
"profiles": [{
"profileType": "filter",
"profileName": "VLAN"
}],
"filter": {
"outerVlanId": [1182]
}
}]
}]
}
}
],
"reuseExistingPseudowire": false,
"routeMeta": {
"originator": "BP2"
},
"name": "TDM_PW_CLOCKRECOVERY3",
"customerName": "Ciena SE",
"serviceType": "EVPL",
"serverTrailList": [],
"structure": "P2P",
"type": "FDFR"
}
}

Sample response

{
"id": "5ac331b6-029d-4f41-8735-0273e336fd01",
"label": "TDM_PW_CLOCKRECOVERY3",
"resourceTypeId": "ifd.v4.resourceTypes.TDMServiceIntentFacade",
"productId": "5abbfc99-ed41-4f59-9b52-71c49e0e9098",
"tenantId": "66e9be79-4e3f-4497-b4c3-a7bb381bcf2b",
"shared": false,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 587
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"properties": {
"serviceType": "EVPL",
"serverTrailList": [],
"name": "TDM_PW_CLOCKRECOVERY3",
"tdm": {
"endPoints": [
{
"signalIndex": "56",
"networkElement": {
"name": "5160_0054"
},
"port": "7"
},
{
"jitterBuffer": 55,
"synchFreqProtGroup": "group_name",
"rtpSetting": "ON",
"signalIndex": "56",
"clockRecoveryMode": "ADAPTIVE",
"tdmCosSettings": {
"pcp": 4
},
"networkElement": {
"name": "3932_0023"
},
"port": "7"
}
],
"layerRate": "E1"
},
"endpoints": [
{
"settings": {
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "FTP"
},
"filter": {
"outerVlanId": [
1182
]
},
"profiles": [
{
"profileName": "VLAN",
"profileType": "filter"
}
]
}
]
}
],
"node": "5160_0054"
}
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 588
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"settings": {
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"location": {
"port": "FTP"
},
"filter": {
"outerVlanId": [
1182
]
},
"profiles": [
{
"profileName": "VLAN",
"profileType": "filter"
}
]
}
]
}
],
"node": "3932_0023"
}
}
],
"customerName": "Ciena SE",
"reuseExistingPseudowire": false,
"routeMeta": {
"originator": "BP2"
},
"structure": "P2P",
"interactive_mode": "false",
"type": "FDFR"
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2018-04-03T07:48:06.206Z",
"createdAt": "2018-04-03T07:48:06.206Z",
"autoClean": false
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 589
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

API calls for managing Drop-and-continue services

This section describes the API calls used to retrieve, provision, edit, and delete a Multicast Drop-and-
continue service.

• Create a Drop-and-continue service

• Add a service endpoint to a Drop-and-continue service
• Delete a service endpoint from a Drop-and-continue service
• Delete a Drop-and-continue service

Create a Drop-and-continue service

You can use the REST API to create a Drop-and-continue service (either an EPDC or EVPD).

The API calls described below allow you to create an initial drop-and-continue service consisting of a
single Source port and a single Drop port. You can then add further endpoints to the service using
additional API calls.

MCP supports the creation of drop-and-continue services with endpoints on the following devices:

• SAOS 6.x
• 8700
• 6200 (only as a Drop endpoint)

Use the Market API to create a Drop-and-continue service. The body of the call is similar to other services
supported in MCP.

For the "serviceType" parameter, use either "EVPDC" or "EPDC".

{{BP_SERVER}}/bpocore/market/api/v1/resources

Sample service-create body

{
"productId": "{{L2_SVC_FACADE_PRODUCT_ID}}",
"properties": {
"serverTrailList": [],
"serviceType": "EVPDC",
"name": "NRMCEVC3",
"routeMeta": {
"originator": "BP2"
},
"endpoints": [
{
"settings": {
"node": "3930-25",
"role": "A_UNI",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 590
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
2092
]
},
"ingressCosSetting": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 3
},
"ingressPolicer": {
"cir": 1000,
"eir": 100,
"ebs": 128,
"cbs": 128
},
"location": {
"port": "6"
}
}
]
}
]
}
},
{
"settings": {
"node": "8700-4",
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
2092
]
},
"ingressCosSetting": {
"ingressCosPolicy": "fixed",
"ingressCosPbit": 3
},
"ingressPolicer": {
"cir": 1000,
"eir": 100,
"ebs": 128,
"cbs": 128
},
"location": {
"slot": "2",
"port": "10"
}
}
]
}
]

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 591
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

}
}
],
"primaryPathConstraints": {
"includeRouteObjects": [{
"constraintType": "HARD",
"locations": [{
"lspName": "2535-UNP",
"nodeName": "3930-25"
}
],
"objectType": "LSP_NAME"
}
]
},
"transportProtection": "MPLS_ONLY"
}
}

Add a service endpoint to a Drop-and-continue service

You can use the REST API to add an endpoint to a Drop-and-continue service.

MCP supports the creation of drop-and-continue endpoints on the following devices:

• SAOS 6.x
• 8700
• 6200 (only as a Drop endpoint)

Use the Market API POST request to add an endpoint to a Drop-and-continue service.

The attachmentSource is a node that is already a member of the Drop-and-continue service, and from
which this new endpoint will receive the service traffic.

For a protected Drop-and-continue service, you can include a second attachmentSource on another node
that is participating in the Drop-and-continue service.

{{BP_SERVER}}/bpocore/market/api/v1/resources/{{SVC_RSC_ID}}/operations

Sample add-drop-point body

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 592
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"interface": "modify",
"inputs": {
"resource_properties_jsonpatch": [
{
"op": "add",
"path": "/properties/endpoints/-",
"value": {
"settings": {
"node": "5142-19",
"role": "A_UNI",
"attachmentSource" : {
"primary" : {
"networkElement" : {
"name" : "8700-4"
}
}
},
"details": [
{
"flowSettings": [
{
"filter": {
"outerVlanId": [
561
]
},
"location": {
"port": "1"
}
}
]
}
]
}
}
}
]
}
}

Delete a service endpoint from a Drop-and-continue service

You can use the REST API to remove an endpoint from a Drop-and-continue service.

Use the Market API POST request to remove an endpoint from the service.

The attachmentSource is a node that is already a member of the Drop-and-continue service, and from
which this new endpoint will receive the service traffic.

{{BP_SERVER}}/bpocore/market/api/v1/resources/{{SVC_RSC_ID}}/operations

The path/properties/endpoints/<number> parameter in this call identifies the endpoint you want to

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 593
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

remove from the service.

For example:

"path": "/properties/endpoints/2" =⇒ The endpoint number, "2" in this case, will be removed by this
operation.

Note: This endpoint numbering is zero-indexed. If a service includes three endpoints, to remove the third
end point you should identify it as "2", not "3".

Sample remove-drop-point body

{
"interface": "modify",
"inputs": {
"resource_properties_jsonpatch": [
{
"op": "remove",
"path": "/properties/endpoints/2"
}
],
"modifySubOperation" : "REMOVE_UNI"
}
}

Delete a Drop-and-continue service

You can use the REST API to delete a Drop-and-continue service.

Use the Market API to delete a Drop-and-continue service. The body of the call is similar to other services
supported in MCP.

For the "serviceType" parameter, use either "EVPDC" or "EPDC".

{{BP_SERVER}}/bpocore/market/api/v1/resources/{{SVC_RSC_ID}}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 594
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

API calls for managing packet service profiles

This section describes the API calls used manage the service profiles used to provision packet services:

• Provision Layer 2 default profile types

• Edit a profile
• Delete a profile
• Retrieve a profile (inventory and details) by ID or filter
• Provision a Packet Service (EPL) using a profile

Provision Layer 2 default profile types

This section includes the following topic:

• Provision endpoint-level profiles

• Provision service-level profiles

Provision endpoint-level profiles

To provision endpoint-level profiles, use the Market API.

Sample request 1

POST {{MCP_SERVER}}/bpocore/market/api/v1/resources

Specify the following attributes. The following is an example of one type of profile: ingress Policer.

{
"productId": "{{PROFILE_PRODUCT_ID}}",
"resourceTypeId": "ifd.v2.resourceTypes.ServiceFacadeProfile",
"label": "Gold bandwidth EP profile",
"properties": {
"name": "eth_flow::gold_bandwidth",
"description": "A profile that defines gold bandwidth (ingress) policers",
"data": {
"ingressPolicer": {
"cir": 20000,
"eir": 5000,
"cbs": 10000,
"ebs": 500
}
}
}
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 595
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Sample response 1

{
"id": "590a3421-210d-433f-8fb4-4ae253ecfa57",
"label": "Gold bandwidth profile",
"resourceTypeId": "ifd.v2.resourceTypes.ServiceFacadeProfile",
"productId": "590a1374-ac79-4195-82a2-0fd64ed5051a",
"tenantId": "db19ef22-58b3-4cdf-90b1-dacaa656be33",
"shared": false,
"properties": {
"data": {
"ingressPolicer": {
"cir": 20000,
"eir": 5000,
"cbs": 10000,
"ebs": 500
}
},
"description": "A profile that defines gold bandwidth (ingress) policers",
"name": "eth_flow::gold_bandwidth"
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-05-03T19:48:49.207Z",
"createdAt": "2017-05-03T19:48:49.207Z",
"autoClean": false
}

Sample request 2

POST {{MCP_SERVER}}/bpocore/market/api/v1/resources

Specify the following attributes. The following is an example with a CFM setting.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 596
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"productId": "{{PROFILE_PRODUCT_ID}}",
"resourceTypeId": "ifd.v2.resourceTypes.ServiceFacadeProfile",
"label": "Custom Full profile",
"properties": {
"name": "eth_ep::custom_cfm5",
"description": "A profile that defines all service
profiles",
"data": {
"ccmTransmitEnabled": true,
"oamEnabled": true,
"slmPriority": 1,
"dmmEnabled": true,
"slmEnabled": true,
"dmmInterval": "10sec",
"dmmPriority": 5,
"slmInterval": "10sec"
}
}
}

Sample response 2

{
"id": "595cfdf4-9df1-4ef4-89c2-2a9076ecd38a",
"label": "Custom Full profile",
"resourceTypeId": "ifd.v2.resourceTypes.ServiceFacadeProfile",
"productId": "5955c1f2-63dc-4253-a5d9-cf4a5946bcae",
"tenantId": "e142ff27-1262-4f02-be6f-202d1a719e49",
"shared": false,
"properties": {
"data": {
"ccmTransmitEnabled": true,
"oamEnabled": true,
"slmPriority": 1,
"dmmEnabled": true,
"slmEnabled": true,
"dmmInterval": "10sec",
"dmmPriority": 5,
"slmInterval": "10sec"
},
"description": "A profile that defines all service profiles",
"name": "eth_ep::custom_cfm5"
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-07-05T14:55:48.648Z",
"createdAt": "2017-07-05T14:55:48.648Z",
"autoClean": false
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 597
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Provision service-level profiles

To provision service-level profiles, use the Market API.

Sample request

POST {{MCP_SERVER}}/bpocore/market/api/v1/resources

Specify the following attributes. The following is an example of one type of profile: ingress Policer.

{
"productId": "{{PROFILE_PRODUCT_ID}}",
"resourceTypeId": "ifd.v2.resourceTypes.ServiceFacadeProfile",
"label": "Gold bandwidth EVPL profile",
"properties": {
"name": "eth::gold_bandwidth",
"description": "An EVPL profile with gold bandwidth policers",
"data": {
"serviceType": "EVPL",
"profiles": [
{
"profileName": "eth_flow::gold_bandwidth",
"profileType": "ifd.v2.resourceTypes.ServiceFacadeProfile"
}
]
}
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 598
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "590a41f6-fd67-42e4-a0b0-ef89e2f8ccfe",
"label": "Gold bandwidth EVPL profile",
"resourceTypeId": "ifd.v2.resourceTypes.ServiceFacadeProfile",
"productId": "590a1374-ac79-4195-82a2-0fd64ed5051a",
"tenantId": "db19ef22-58b3-4cdf-90b1-dacaa656be33",
"shared": false,
"properties": {
"data": {
"serviceType": "EVPL",
"profiles": [
{
"profileName": "eth_flow::gold_bandwidth",
"profileType": "ifd.v2.resourceTypes.ServiceFacadeProfile"
}
]
},
"description": "An EVPL profile with gold bandwidth policers",
"name": "eth_flow::gold_bandwidth"
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-05-03T20:47:50.828Z",
"createdAt": "2017-05-03T20:47:50.828Z",
"autoClean": false
}

Edit a profile
To edit a profile, use the Market API.

You can edit a profile either by using the PUT or the PATCH call.

Using the PUT call

Sample request

PUT {{MCP_SERVER}}/bpocore/market/api/v1/resources/{{SVC_RSC_ID}}

Specify the following attribute: SVC_RSC_ID.

Note 1: The SVC_RSC_ID is the resource ID you get when creating a new service. It is available in the
response message (first top-level attribute “id”).

Note 2: You can also retrieve the SVC_RSC_ID with the following query (which is an example). In the query

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 599
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

make sure that you match resourceTypes and properties.name attribute values.

GET
{{MCP_SERVER}}/bpocore/market/api/v1/resources?resourceTypeId=ifd.v2.resourceTypes.L2ServiceIn
tentFacade&q=properties.name:jmEvpln2n5

{
"id": "590a3421-210d-433f-8fb4-4ae253ecfa57",
"label": "Gold bandwidth profile",
"resourceTypeId": "ifd.v2.resourceTypes.ServiceFacadeProfile",
"productId": "590a1374-ac79-4195-82a2-0fd64ed5051a",
"tenantId": "db19ef22-58b3-4cdf-90b1-dacaa656be33",
"shared": false,
"properties": {
"data": {
"ingressPolicer": {
"cir": 20000,
"eir": 4000,
"cbs": 10000,
"ebs": 500
}
},
"description": "A profile that defines gold bandwidth (ingress) policers",
"name": "eth_flow::gold_bandwidth"
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-05-03T19:48:49.207Z",
"createdAt": "2017-05-03T19:48:49.207Z",
"autoClean": false
}

Sample response

No textual response except HTTP status code

Using the Patch call

Sample request

PATCH {{MCP_SERVER}}/bpocore/market/api/v1/resources/{{SVC_RSC_ID}}

Specify the following attribute: SVC_RSC_ID.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 600
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"properties": {
"data": {
"ingressPolicer": {
"eir": 4000
}
}
}
}

Sample response

No textual response except HTTP status code

Delete a profile
To delete a profile, use the Market API.

Sample request

DELETE {{MCP_SERVER}}/bpocore/market/api/v1/resources/{{SVC_RSC_ID}}

Specify the following attribute: SVC_RSC_ID.

Note 1: The SVC_RSC_ID is the resource ID you get when creating a new service. It is available in the
response message (first top-level attribute “id”).

Note 2: You can also retrieve the SVC_RSC_ID with the following query (which is an example). In the query
make sure that you match resourceTypes and properties.name attribute values.

Sample response

No textual response except HTTP status code

Retrieve a profile (inventory and details) by ID or filter

You can retrieve a profile by ID or by filter.

Get by ID

To retrieve a profile by ID, use the Market API.

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 601
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

GET {{MCP_SERVER}}/bpocore/market/api/v1/resources/{{SVC_RSC_ID}}

Specify the following attribute: SVC_RSC_ID.

Note 1: The SVC_RSC_ID is the resource ID you get when creating a new service. It is available in the
response message (first top-level attribute “id”).

Note 2: You can also retrieve the SVC_RSC_ID with the following query (which is an example). In the query
make sure that you match resourceTypes and properties.name attribute values.

GET
{{MCP_SERVER}}/bpocore/market/api/v1/resources?resourceTypeId=ifd.v2.resourceTypes.L2ServiceIn
tentFacade&q=properties.name:jmEvpln2n5

Sample response

{
"id": "590a41f6-fd67-42e4-a0b0-ef89e2f8ccfe",
"label": "Gold bandwidth EVPL profile",
"resourceTypeId": "ifd.v2.resourceTypes.ServiceFacadeProfile",
"productId": "590a1374-ac79-4195-82a2-0fd64ed5051a",
"tenantId": "db19ef22-58b3-4cdf-90b1-dacaa656be33",
"shared": false,
"properties": {
"data": {
"serviceType": "EVPL",
"profiles": [
{
"profileName": "eth_flow::gold_bandwidth",
"profileType": "ifd.v2.resourceTypes.ServiceFacadeProfile"
}
]
},
"description": "An EVPL profile with gold bandwidth policers",
"name": "eth::evpl_gold_bandwidth"
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-05-03T20:47:50.828Z",
"createdAt": "2017-05-03T20:47:50.828Z",
"autoClean": false
}

Get by filter

To retrieve a profile by filter, use the Market API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 602
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Sample request

GET
{{MCP_SERVER}}/bpocore/market/api/v1/resources?resourceTypeId=ifd.v2.resourceTypes.ServiceFaca
deProfile&tags=$tag_name:$tag_value

Specify the following attributes, as applicable, to get by filter:

• profile_resource - the tag key to identify the associated resource the ServiceProfile is to apply to.

Expected values are:

◦ eth for l2ServiceIntentFacade

• profile_location - the tag key to identify the location in the resource where the ServiceProfile data is to
apply to.

Expected values are:

◦ service - apply at service-level

◦ endpoint - apply at endpoint-level (settings)
◦ flowSetting - apply at endpoint-level (flow settings)
• profile_topic - the tag key to identify the ServiceProfile topic as more granular level of scoping the
intended data schema coverage.

Expected values for L2 (eth) flow settings and endpoint are:

◦ cos - for FlowSetting.ingressCosSetting

◦ policer - for FlowSetting.ingressPolicer
◦ bandwidth - for FlowSetting.filter
◦ in_vlan_ops - for FlowSetting.vlanOperations.ingress
◦ e_vlan_ops - for FlowSetting.vlanOperations.egress
◦ cfm - for:
▪ settings.oamEnabled
▪ settings.mepId
▪ settings.ccmTransmitEnabled
▪ settings.dmmEnabled
▪ settings.dmmInterval
▪ settings.dmmPriority
▪ settings.slmEnabled
▪ settings.slmInterval

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 603
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

▪ settings.slmPriority

Sample response

{
"id": "590a41f6-fd67-42e4-a0b0-ef89e2f8ccfe",
"label": "Gold bandwidth EVPL profile",
"resourceTypeId": "ifd.v2.resourceTypes.ServiceFacadeProfile",
"productId": "590a1374-ac79-4195-82a2-0fd64ed5051a",
"tenantId": "db19ef22-58b3-4cdf-90b1-dacaa656be33",
"shared": false,
"properties": {
"data": {
"serviceType": "EVPL",
"profiles": [
{
"profileName": "eth_flow::gold_bandwidth",
"profileType": "ifd.v2.resourceTypes.ServiceFacadeProfile"
}
]
},
"description": "An EVPL profile with gold bandwidth policers",
"name": "eth::evpl_gold_bandwidth"
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-05-03T20:47:50.828Z",
"createdAt": "2017-05-03T20:47:50.828Z",
"autoClean": false
}

Provision a Packet Service (EPL) using a profile

To provision a Packet Service (EPL) using a profile, use the Market API.

Sample request

POST {{MCP_SERVER}}/bpocore/market/api/v1/resources

Specify the attributes, as required. The following sample shows how to create an EPL with a profile:
eth::fixed_1.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 604
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"productId": "{{L2_SVC_FACADE_PRODUCT_ID}}",
"label": "L2 Sample EPL with COS Service Profile",
"properties": {
"turnUpDateTime": "2020-11-11T00:00:00.000",
"name": "EPL_COS_FIXED_1",
"routeMeta": {
"originator": "BP2"
},
"serviceType": "EPL",
"profiles": [
{
"profileName": "eth::fixed_1",
"profileType": "ifd.v2.resourceTypes.ServiceFacadeProfile"
}
],
"endpoints": [
{
"settings": {
"node": "87_5783n2",
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"location": {
"slot": "1",
"port": "20"
}
}
]
}
]
}
},
{
"settings": {
"node": "87_5783n4",
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"location": {
"slot": "1",
"port": "9"
}
}
]
}
]
}
}
]
}
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 605
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Sample response

{
"id": "5909f530-8fe6-4299-a409-74fac7cfc275",
"label": "L2 Sample EPL with COS Service Profile",
"resourceTypeId": "ifd.v2.resourceTypes.L2ServiceIntentFacade",
"productId": "59034762-ad0f-47dc-85d9-e4a8747c6247",
"tenantId": "8b2aa32f-3253-4009-827f-3f582588b7a9",
"shared": false,
"properties": {
"name": "EPL_COS_FIXED_1",
"turnUpDateTime": "2020-11-11T00:00:00.000",
"endpoints": [
{
"settings": {
"node": "87_5783n2",
"role": "A_UNI",
"details": [
{
"flowSettings": [
{
"location": {
"slot": "1",
"port": "20"
}
}
]
}
]
}
},
{
"settings": {
"node": "87_5783n4",
"role": "Z_UNI",
"details": [
{
"flowSettings": [
{
"location": {
"slot": "1",
"port": "9"
}
}
]
}
]
}
}
],
"routeMeta": {
"originator": "BP2"
},
"serviceType": "EPL",
"serviceState": "OUT_OF_SERVICE",
"lastTransition": "TRANSITION_NONE",
"profiles": [
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 606
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"profileName": "eth::fixed_1",
"profileType": "ifd.v2.resourceTypes.ServiceFacadeProfile"
}
]
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-05-03T15:20:16.448Z",
"createdAt": "2017-05-03T15:20:16.448Z",
"autoClean": false
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 607
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

API calls for editing packet services

This section describes the API calls used edit packet services:

• Edit service and endpoint attributes

• Edit the service description
• Edit the ENNI endpoints of a service
• Edit ELINE service endpoint policers with bandwidth management
• Update management VLAN configurable properties

Edit service and endpoint attributes

To edit service or endpoint attributes, use the Market API.

Note: You can also use this API call for all types of Ethernet services (E-LINE, E-LAN, and E-Tree).

Sample request — Example 1

POST {{MCP_SERVER}}//bpocore/market/api/v1/resources/{{SVC_RSC_ID}}/operations

Specify the following attribute: SVC_RSC_ID.

Note 1: The SVC_RSC_ID is the resource ID you get when creating a new service. It is available in the
response message (first top-level attribute “id”).

Note 2: You can also retrieve the SVC_RSC_ID with the following query (which is an example). In the query
make sure that you match resourceTypes and properties.name attribute values.

GET
{{MCP_SERVER}}/bpocore/market/api/v1/resources?resourceTypeId=ifd.v5.resourceTypes.L2ServiceIn
tentFacade&q=properties.name:jmEvpln2n5

CVID (using the POST call)

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 608
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"interface": "modify",
"inputs": {
"resource_properties_jsonpatch": [
{
"op": "replace",
"path":
"/properties/endpoints/0/settings/details/0/flowSettings/0/filter/outerVlanId",
"value": [600, 601]
},
{
"op": "replace",
"path":
"/properties/endpoints/1/settings/details/0/flowSettings/0/filter/outerVlanId",
"value": [600, 601]
}
]
}
}

Sample response

No textual response except HTTP status code

Sample request — Example 2

POST {{MCP_SERVER}}//bpocore/market/api/v1/resources/{{SVC_RSC_ID}}/operations

Specify the following attribute: SVC_RSC_ID.

For details about the SVC_RSC_ID, see Note 1 and Note 2 (above).

CFM (add)

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 609
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"interface": "modify",
"inputs": {
"resource_properties_jsonpatch": [
{
"op": "add",
"path": "/properties/oamEnabled",
"value": true
},
{
"op": "add",
"path": "/properties/ccmInterval",
"value": "100ms"
},
{
"op": "add",
"path": "/properties/ccmPriority",
"value": 1
}
]
}
}

Sample response

No textual response except HTTP status code

Note: To retrieve information, use the NSI getTPE/getFRE REST API (see Using the Service Inventory with
Packet services management. )

Edit the service description

To edit the service description, use the Market API.

Sample request

POST {{MCP_SERVER}}/bpocore/market/api/v1/resources/{SVC_RSC_ID}/operations

where {SVC_RSC_ID} is Resource ID of the L2ServiceIntentFacade resource being modified. Example:

"5a9461a6-9eba-4f43-b105-c94fc9ec12dc"

Specify the following attribute:

• the value (the Modified Service Label)

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 610
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"interface": "modify",
"inputs": {
"resource_properties_jsonpatch": [
{
"op": "replace",
"path": "/properties/userLabel",
"value": "Modified Service Label"
}
]
}
}

Sample response

{
"id": "5a947baf-3af9-4dc7-93cb-593c55a666f6",
"resourceId": "5a9461a6-9eba-4f43-b105-c94fc9ec12dc",
"interface": "modify",
"inputs": {
"resource_properties_jsonpatch": [
{
"op": "replace",
"path": "/properties/userLabel",
"value": "Modified Service Label"
}
]
},
"outputs": {},
"state": "requested",
"reason": "",
"progress": [],
"providerData": {},
"createdAt": "2018-02-26T21:27:11.260Z",
"updatedAt": "2018-02-26T21:27:11.260Z",
"resourceStateConstraints": {},
"executionGroup": "lifecycle"
}

Using the Operation Id ("id") from the Sample response, (for example, "5a947baf-3af9-4dc7-93cb-
593c55a666f6"), you can then issue a GET REST API operation to check the final result, which will show
"state": "successful" or an error message, if there was a problem in the modify operation.

GET {{MCP_SERVER}}/bpocore/market/api/v1/resources/SVC_RSC_ID/operations/OPERATION_ID

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 611
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "5a947baf-3af9-4dc7-93cb-593c55a666f6",
"resourceId": "5a9461a6-9eba-4f43-b105-c94fc9ec12dc",
"interface": "modify",
"inputs": {
"resource_properties_jsonpatch": [
{
"op": "replace",
"path": "/properties/userLabel",
"value": "Modified Service Label"
}
]
},
"outputs": {},
"state": "successful",
"reason": "",
"progress": [],
"providerData": {},
"createdAt": "2018-02-26T21:27:11.260Z",
"updatedAt": "2018-02-26T21:27:20.340Z",
"resourceStateConstraints": {},
"executionGroup": "lifecycle"
}

Edit the ENNI endpoints of a service

To edit the ENNI endpoints of a service, use the Market API.

Sample request

POST {{MCP_SERVER}}/bpocore/market/api/v1/resources/{SVC_RSC_ID}/operations

where {SVC_RSC_ID} is Resource ID of the L2ServiceIntentFacade resource being modified. Example:

"5a9461a6-9eba-4f43-b105-c94fc9ec12dc"

Specify the following attribute:

• the values as follows:

◦ VLAN ID: 1 - 4094
◦ Ethernet type: 8100, 88a8, or 9100

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 612
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"interface": "modify",
"inputs": {
"resource_properties_jsonpatch": [
{
"op": "replace",
"path":
"/properties/endpoints/0/settings/details/0/flowSettings/0/filter/outerVlanId",
"value": [901]
},
{
"op": "replace",
"path":
"/properties/endpoints/0/settings/details/0/flowSettings/0/filter/outerVLANEthertyp
e",
"value": "88a8"
}
]
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 613
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{{
"id": "5a947571-9a34-4b4b-ace7-a664c9816284",
"resourceId": "5a9461a6-9eba-4f43-b105-c94fc9ec12dc",
"interface": "modify",
"inputs": {
"resource_properties_jsonpatch": [
{
"op": "replace",
"path":
"/properties/endpoints/0/settings/details/0/flowSettings/0/filter/outerVlanId",
"value": [
901
]
},
{
"op": "replace",
"path":
"/properties/endpoints/0/settings/details/0/flowSettings/0/filter/outerVLANEthertyp
e",
"value": "88a8"
}
]
},
"outputs": {},
"state": "requested",
"reason": "",
"progress": [],
"providerData": {},
"createdAt": "2018-02-26T21:00:33.040Z",
"updatedAt": "2018-02-26T21:00:33.040Z",
"resourceStateConstraints": {},
"executionGroup": "lifecycle"
}

Using the Operation Id ("id") from the Sample response, (for example, "5a947571-9a34-4b4b-ace7-
a664c9816284"), you can then issue a GET REST API operation to check the final result, which will show
"state": "successful" or an error message, if there was a problem in the modify operation.

GET {{MCP_SERVER}}/bpocore/market/api/v1/resources/SVC_RSC_ID/operations/OPERATION_ID

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 614
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "5a947571-9a34-4b4b-ace7-a664c9816284",
"resourceId": "5a9461a6-9eba-4f43-b105-c94fc9ec12dc",
"interface": "modify",
"inputs": {
"resource_properties_jsonpatch": [
{
"op": "replace",
"path":
"/properties/endpoints/0/settings/details/0/flowSettings/0/filter/outerVlanId",
"value": [
901
]
},
{
"op": "replace",
"path":
"/properties/endpoints/0/settings/details/0/flowSettings/0/filter/outerVLANEthertyp
e",
"value": "88a8"
}
]
},
"outputs": {},
"state": "successful",
"reason": "",
"progress": [],
"providerData": {},
"createdAt": "2018-02-26T21:00:33.040Z",
"updatedAt": "2018-02-26T21:00:41.350Z",
"resourceStateConstraints": {},
"executionGroup": "lifecycle"
}

Edit ELINE service endpoint policers with bandwidth

management
To edit ELINE service endpoint policers with bandwidth management, use the Market API.

Sample request

POST {{MCP_SERVER}}/ /bpocore/market/api/v1/resources/{{SVC_RSC_ID}}/operations

Specify the following attribute: SVC_RSC_ID.

Note 1: The SVC_RSC_ID is the resource ID you get when creating a new service. It is available in the
response message (first top-level attribute “id”).

Note 2: You can also retrieve the SVC_RSC_ID with the following query (which is an example). In the query

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 615
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

make sure that you match resourceTypes and properties.name attribute values.

GET
{{MCP_SERVER}}/bpocore/market/api/v1/resources?resourceTypeId=ifd.v2.resourceTypes.L2ServiceIn
tentFacade&q=properties.name:jmEvpln2n5

Note 1: You can also use the following API call to add or remove individual policing attributes. To add
specify "add" as the "op"; to remove specify "remove" as the "op". The following example shows examples
or replacing individual policing attributes.

Note 2: The "1" and "0" following the "/properties/endpoints" in the "path" in the sample request (as
follows) represent the endpoints. "0" represents the first endpoint in the "endpoints" list on the resource,
and "1" represents the second endpoint.

{
"interface": "modify",
"inputs": {
"resource_properties_jsonpatch": [
{
"op": "replace",
"path":
"/properties/endpoints/0/settings/details/0/flowSettings/0/ingressPolicer/cir",
"value": 20000
},
{
"op": "replace",
"path":
"/properties/endpoints/0/settings/details/0/flowSettings/0/ingressPolicer/eir",
"value": 5000
},
{
"op": "replace",
"path":
"/properties/endpoints/1/settings/details/0/flowSettings/0/ingressPolicer/cir",
"value": 20000
},
{
"op": "replace",
"path":
"/properties/endpoints/1/settings/details/0/flowSettings/0/ingressPolicer/eir",
"value": 5000
}
]
}
}

Sample response

No textual response except HTTP status code

Note: To retrieve information, use the NSI getTPE/getFRE REST API (see Using the Service Inventory with
Packet services management.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 616
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Update management VLAN configurable properties

To update management VLAN configuration properties, use the Market API.

Sample request

PATCH {{MCP_SERVER}}/bpocore/market/api/v1/resources/{resourceId}

Specify the IFD_CONFIG_RESOURCE_ID (which you obtain from the Response of Retrieve configuration
resources. )

Sample request

{
"properties": {
"configurationProperties": {
"ifd.l2.managementVlans": {
"value": "127,918"
}
}
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 617
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "58b4407b-e3b4-4627-a6be-c19bcd4f1ed3",
"label": "Ifd Config Label",
"resourceTypeId": "ifd.v1.resourceTypes.IfdConfig",
"productId": "58b43dc6-749e-44fa-9bdb-cea4887ba820",
"tenantId": "e1e0516f-cfc8-4832-871f-ed46ad3b27b8",
"shared": false,
"properties": {
"configurationProperties": {
"ifd.l2.statusTlv": {
"default": "on",
"supportedValues": "on, off",
"value": "on"
},
"ifd.l0.setExplicitFrequency": {
"default": "true",
"supportedValues": "true, false",
"value": "true"
},
"ifd.l2.truncateSubportName": {
"default": "true",
"supportedValues": "true, false",
"value": "true"
},
"ifd.l2.maximumTransmissionUnit": {
"default": "2000",
"supportedValues": "1-9200",
"value": "2000"
},
"ifd.l2.managementVlans": {
"default": "127",
"supportedValues": "1-4094",
"value": "127,918"
}
}
},
"discovered": false,
"differences": [
{
"op": "replace",
"path": "/properties/configurationProperties/ifd.l2.managementVlans/value",
"value": "127"
}
],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-02-27T15:15:53.701Z",
"createdAt": "2017-02-27T15:06:35.647Z",
"autoClean": false
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 618
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

API calls for testing packet services

This section describes the API calls used test packet services:

• Retrieve MPLS-TP LSP status, LSP ping, and LSP traceroute

• Retrieve operational status of pseudowire ping
• Retrieve service — 802.1ag CFM & PW Ping
• Perform an 802.1ag linktrace
• Perform 802.1ag (CFM) loopback on a selected service
• Perform PW ping on a selected service
• Perform PW ping on a MS-PW based service from any T-PE or S-PE to any other T-PE or S-PE
• Perform PW ping for a MS-PW based service from either direction
• Perform PW ping on a MS-PW based service that is all MPLS
• Perform PW ping on a MS-PW based service that is MPLS with QiQ spur(s)
• Perform pseudowire traceroute and retrieve test results
• Perform LSP ping on a selected tunnel and retrieve its results
• Perform LSP traceroute on tunnel retrieve results between two E-LAN endpoints
• Perform port level facility loopback on a CES AimValley CSoP Smart SFP and retrieve its results
• Perform channel level fac loopback CES AimValley CSoP Smart SFP retrieve results
• Perform port level terminal loopback on a CES AimValley CSoP Smart SFP
• Perform channel level terminal loopback on a CES AimValley CSoP Smart SFP
• Perform channel level facility loopback on a 6200 2.5G MRO i/f card and retrieve its results
• Perform port level terminal loopback on a 6200 2.5G MRO i/f card and retrieve its results
• Perform channel level terminal loopback on a 6200 2.5G MRO i/f card and retrieve its results
• Perform terminal loopback on a 6200 - 63xDS1/E1 i/f card and retrieve its results
• Perform RFC2544 tests (latency, frame loss, throughput) retrieve results cancel

Retrieve MPLS-TP LSP status, LSP ping, and LSP traceroute

To retrieve the MPLS-TP LSP status, use the Test and diagnostics API.

Sample request

GET {{MCP_SERVER}}/tdc/api/v1/operationalStatus?freId=<FREID>&osTypeString=lspStatus

Specify the following attributes: freID and osTypeString=lspStatus.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 619
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Note: Use the NSI getTPE/getFRE REST API (see Using the Service Inventory with Packet services
management. )

Sample response

{
"data": {
"id": "eb206566-271c-488a-8a99-a055f76cbf1b",
"type": "operationalStatus",
"attributes": {
"lspSummaryStatus": {
"adminState": "enabled",
"operationalState": "enabled",
"tunnelSummary": [
{
"bfdSessionAdminState": "up",
"bfdSessionOperationalState": "up",
"adminState": "enabled",
"protectionState": "active",
"lspName": "tdcIT_LSP1",
"aisMonitor": "disabled",
"bfdMonitor": "enabled",
"operationalState": "enabled"
}
]
}
},
"relationships": {
"osData": {
"data": [
{
"type": "lspStatus",
"id": "8926364553760176957:2::LSPSTATUS"
},
{
"type": "lspStatus",
"id": "8926364553760176957:1::LSPSTATUS"
}
]
},
"fres": {
"data": [
{
"type": "fres",
"id": "695522132290624831"
}
]
}
}
},
"included": [
{
"id": "8926364553760176957:2::LSPSTATUS",
"type": "lspStatus",
"attributes": {
"bfdSessionName": "LBFS_10_07_tdcIT_LSP1_E",
"bfdSessionAdminState": "Up",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 620
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"bfdSessionOperationalState": "Up",
"adminState": "Enabled",
"protectionState": "Active",
"aisMonitor": "Disabled",
"bfdMonitor": "Enabled",
"bfdProfileName": "Active-LSP",
"operationalState": "Enabled"
},
"relationships": {
"tpes": {
"data": {
"type": "tpes",
"id": "d21aa513-c314-3d37-acbc-
bcec6326f412::TPE_1_CTPServerToClient_EQPTGRP_9_LSP_tdcIT_LSP1_headEnd"
}
}
}
},
{
"id": "8926364553760176957:1::LSPSTATUS",
"type": "lspStatus",
"attributes": {
"bfdSessionName": "LBFS_12_06_tdcIT_LSP1_E",
"bfdSessionAdminState": "Up",
"bfdSessionOperationalState": "Up",
"adminState": "Enabled",
"protectionState": "Active",
"aisMonitor": "Disabled",
"bfdMonitor": "Enabled",
"bfdProfileName": "Passive-LSP",
"operationalState": "Enabled"
},
"relationships": {
"tpes": {
"data": {
"type": "tpes",
"id": "2b484e8c-50ef-3b80-bbab-
b973594e0a37::TPE_CTPServerToClient_LSP_tdcIT_LSP1_tailEnd"
}
}
}
}
],
"requestIds": "695522132290624831",
"resultsCode": "202"
}

Retrieve operational status of pseudowire

To retrieve the operational status of a pseudowire, use the Test and diagnostics API.

Operational status

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 621
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Sample request

GET {{MCP_SERVER}}/tdc/api/v1/operationalStatus?freId=<FRE ID>&osTypeString=pwStatus

Specify the following attributes:

• fre ID
• osTypeString=pwStatus

Sample response

{
"data": {
"id": "1b622dc1-4e05-49ac-b4cf-338bbd2f89de",
"type": "operationalStatus",
"attributes": {
"pseudowireSummaryStatus": {
"segmentSummary": [
{
"segmentPseudowireName": "pwName3960->5142-2",
"adminState": "enabled",
"fault": "true",
"operationalState": "down"
}
],
"adminState": "enabled",
"fault": "true",
"operationalState": "down"
}
},
"relationships": {
"osData": {
"data": [
{
"type": "pwStatus",
"id": "MockNc3960::TPE_CTPServerToClient_PW_pwName3960->5142-
2::PWSTATUS"
},
{
"type": "pwStatus",
"id": "MockNc5142-2::TPE_CTPServerToClient_PW_pwName3960->5142-
2::PWSTATUS"
}
]
},
"fres": {
"data": [
{
"type": "fres",
"id": "MockPwFre"
}
]
}
}
},
"included": [

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 622
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "MockNc3960::TPE_CTPServerToClient_PW_pwName3960->5142-2::PWSTATUS",
"type": "pwStatus",
"attributes": {
"remoteFault": "not forwarding",
"faultToNextHop": "not forwarding",
"adminState": "enabled",
"operationalState": "up",
"localFault": "none",
"faultToNextHopLocation": {
"localNetworkConstructName": "3960_0010",
"pseudowireId": "37",
"remoteNetworkConstructName": "5142_0042-2",
"fault": "not forwarding",
"localIpAddress": "10.125.253.32",
"pseudowireName": "pwName3960->5142-2",
"remoteIpAddress": "16.24.0.3"
},
"pseudowireName": "pwName3960->5142-2",
"remoteFaultLocation": {
"localNetworkConstructName": "3960_0010",
"pseudowireId": "37",
"remoteNetworkConstructName": "5142_0042-2",
"localIpAddress": "2.2.2.2",
"pseudowireName": "pwName3960->5142-2",
"remoteIpAddress": "16.24.0.3"
}
},
"relationships": {
"tpes": {
"data": {
"type": "tpes",
"id": "MockNc3960::TPE_CTPServerToClient_PW_pwName3960->5142-2"
}
}
}
},
{
"id": "MockNc5142-2::TPE_CTPServerToClient_PW_pwName3960->5142-2::PWSTATUS",
"type": "pwStatus",
"attributes": {
"remoteFault": "not forwarding",
"faultToNextHop": "not forwarding",
"adminState": "enabled",
"operationalState": "down",
"localFault": "none",
"faultToNextHopLocation": {
"localNetworkConstructName": "5142_0042-2",
"pseudowireId": "37",
"remoteNetworkConstructName": "3960_0010",
"fault": "not forwarding",
"localIpAddress": "16.24.0.3",
"pseudowireName": "pwName3960->5142-2",
"remoteIpAddress": "10.125.253.32"
},
"pseudowireName": "pwName3960->5142-2",
"remoteFaultLocation": {
"localNetworkConstructName": "5142_0042-2",
"pseudowireId": "37",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 623
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"remoteNetworkConstructName": "3960_0010",
"localIpAddress": "16.24.0.3",
"pseudowireName": "pwName3960->5142-2",
"remoteIpAddress": "2.2.2.2"
}
},
"relationships": {
"tpes": {
"data": {
"type": "tpes",
"id": "MockNc5142-2::TPE_CTPServerToClient_PW_pwName3960->5142-2"
}
}
}
}
],
"requestIds": "MockPwFre",
"resultsCode": "202"
}

Retrieve service — 802.1ag CFM & PW Ping

To retrieve the 802.1ag CFM and PW ping, use the Test and diagnostics API.

Note: You can also use this API call to retrieve 802.1ag CCM status for an E-LAN service.

Sample request

GET {{MCP_SERVER}}/tdc/api/v1/operationalStatus?freId=<FRE ID> &osTypeString=ccStatus

Specify the following attributes: freID and osTypeString=ccStatus.

Sample response

{
"data": {
"id": "392c959e-7d87-43ce-91f6-be82f7a09062",
"type": "operationalStatus",
"attributes": {
"continuityCheckSummaryStatus": "up"
},
"relationships": {
"osData": {
"data": [
{
"type": "ccStatus",
"id": "-6826425710477788335:1::CCSTATUS"
},
{
"type": "ccStatus",
"id": "-6826425710477788335:2::CCSTATUS"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 624
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

}
]
},
"fres": {
"data": [
{
"type": "fres",
"id": "MockCfmEplFre"
}
]
}
}
},
"included": [
{
"id": "-6826425710477788335:1::CCSTATUS",
"type": "ccStatus",
"attributes": {
"continuityCheckSummaryStatus": "up",
"ccmState": "on",
"cfmMaId": "md4mcpCfmTest",
"cfmServiceName": "mcpEplCfmTest",
"cfmMaFormat": "Character String",
"ccmInterval": "1",
"cfmAdminStatus": "enabled",
"remoteMepIds": [
"2"
],
"cfmMdLevel": "4",
"cfmMdName": "md4",
"continuityCheckStatus": {
"2": "up"
},
"localMepOperationalState": "en",
"ccmPriority": "7",
"ccmIntervalUnit": "sec",
"localMepId": "1",
"cfmMdFormat": "Character String",
"cfmMaName": "mcpCfmTest"
},
"relationships": {
"tpes": {
"data": {
"type": "tpes",
"id": "MockNc3932::TPE_11_CTPServerToClient_VCE_al_tdc_cfm_up"
}
}
}
},
{
"id": "-6826425710477788335:2::CCSTATUS",
"type": "ccStatus",
"attributes": {
"continuityCheckSummaryStatus": "up",
"ccmState": "on",
"cfmMaId": "md4mcpCfmTest",
"cfmServiceName": "mcpEplCfmTest",
"cfmMaFormat": "Character String",
"ccmInterval": "1",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 625
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"cfmAdminStatus": "enabled",
"remoteMepIds": [
"1"
],
"cfmMdLevel": "4",
"cfmMdName": "md4",
"continuityCheckStatus": {
"1": "up"
},
"localMepOperationalState": "en",
"ccmPriority": "7",
"ccmIntervalUnit": "sec",
"localMepId": "2",
"cfmMdFormat": "Character String",
"cfmMaName": "mcpCfmTest"
},
"relationships": {
"tpes": {
"data": {
"type": "tpes",
"id": "MockNc3960::TPE_9_CTPServerToClient_VCE_al_tdc_cfm_up"
}
}
}
}
],
"requestIds": "MockCfmEplFre",
"resultsCode": "202"
}

Perform an 802.1ag linktrace

This section includes the following topic:

• Perform an 802.1ag linktrace

• Retrieve the test results

Note: You can use this API call for a 802.1ag linktrace between two E-LAN services endpoints.

Perform an 802.1ag linktrace

To perform an 802.1ag linktrace, use the Test and diagnostics API.

Sample request

POST {{MCP_SERVER}}/tdc/api/v1/tests/cfmOperations

Note: For an E-Tree service, you can only run a test from root-to-leaf or leaf-to-root. You cannot run a test
from leaf-to-leaf or root-to-root.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 626
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"type": "linktrace",
"localTpeId": "MockCfmCtp1",
"remotePoint": {
"idType": "macAddress",
"id": ":1:2:3:4"
},
"testParameters": {
"ttl" : "20",
"priority" : "5"},
"userAnnotation": "2016.12.19 example collection"
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 627
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"id": "ede2bc4e-0258-4512-82b2-f3dd662f08fb",
"type": "testResults",
"attributes": {
"testResults": [],
"testType": "cfm_linktrace",
"testStatus": "Started",
"localTpeId": "MockCfmCtp1",
"remotePoints": [],
"localNcId": "MockNc3932",
"remoteNcs": [],
"startTime": 1482170019561,
"lastUpdateTime": 1482170019561,
"testParameters": {
"priority": "5",
"ttl": "20"
},
"localMepId": "2",
"userAnnotation": "2016.12.19 example collection",
"remoteMepMacAddress": ":1:2:3:4",
"cfmServiceName": "mcpEplCfmTest"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "MockCfmCtp1"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "MockNc3932"
}
]
}
}
},
"resultsCode": "202"
}

Retrieve the test results

To retrieve the 802.1ag linktrace test results, use the Test and diagnostics API.

*Sample request

GET {{MCP_SERVER}}/tdc/api/tests/<TestRecord ID>

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 628
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Specify the Test Record ID, which is the “id” (for example, de2bc4e-0258-4512-82b2-f3dd662f08fb) of the
response (when you Perform an 802.1ag linktrace).

https://<mcp_server>/tdc/api/tests/fc6aba0a-19a9-4915-9262-1a8927c4846f

Sample response

{
"data": {
"id": "ede2bc4e-0258-4512-82b2-f3dd662f08fb",
"type": "testResults",
"attributes": {
"testResults": [
{
"transitId": "1",
"messageType": "LTM",
"dataType": "ltmResult",
"localMepId": "1",
"rxLtr": "availableFrom8.x",
"txLtm": "availableFrom8.x",
"remoteMacAddress": "2c:39:c1:48:a8:10",
"ttl": "existFor6.x"
},
{
"ingressPort": "2/14",
"transitId": "existFor6.x",
"ingressMacAddress": "2c:39:c1:48:d0:7d",
"messageType": "LTR",
"dataType": "ltrResult",
"ingressAction": "Ok",
"localMepId": "1",
"remoteMacAddress": "2c:39:c1:48:d0:7d",
"ttl": "63",
"relayAction": "FDB"
},
{
"transitId": "existFor6.x",
"egressPort": "3/1",
"ingressMacAddress": "2c:39:c1:48:a8:10",
"messageType": "LTR",
"dataType": "ltrResult",
"localMepId": "1",
"remoteMacAddress": "2c:39:c1:48:a8:10-a",
"egressAction": "Blocked",
"ttl": "62",
"relayAction": "HIT"
},
{
"operationalStatus": "failure",
"errorMessage": "Auto refresh test result aborted due to time out (120
seconds). Test status is set to completed with test operational status (for refresh
test) is failure and test results as failed",
"testResultsStatus": "failed",
"dataType": "summary"
}
],

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 629
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"testType": "cfm_linktrace",
"testStatus": "Completed",
"localTpeId": "MockCfmCtp1",
"remotePoints": [],
"localNcId": "MockNc3932",
"remoteNcs": [],
"startTime": 1482170019561,
"lastUpdateTime": 1482170139675,
"testParameters": {
"priority": "5",
"ttl": "64"
},
"localMepId": "2",
"userAnnotation": "2016.12.19 example collection",
"remoteMepMacAddress": ":1:2:3:4",
"cfmServiceName": "mcpEplCfmTest"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "MockCfmCtp1"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "MockNc3932"
}
]
}
}
},
"resultsCode": 200,
"requestIds": "ede2bc4e-0258-4512-82b2-f3dd662f08fb"
}

Perform 802.1ag (CFM) loopback on a selected service

This section includes the following topic:

• Perform an 802.1ag loopback on a selected service

• Retrieve the test results of an 802.1ag loopback on a selected tunnel

Note: You can also use this API call for an 802.1ag loopback between two E-LAN endpoints.

Perform an 802.1ag loopback on a selected service

To perform an 802.1ag loopback on a selected service, use the Test and Diagnostics API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 630
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Sample request

POST {{MCP_SERVER}}/tdc/api/v1/tests/cfmOperations

Note: For an E-Tree service, you can only run a test from root-to-leaf or leaf-to-root. You cannot run a test
from leaf-to-leaf or root-to-root.

Specify loopback as the type.

{
"data": {
"type": "loopback",
"localTpeId": "MockCfmCtp1",
"remotePoint": {
"idType": "tpes",
"id": "MockCfmCtp2"
},
"testParameters": {
"priority":"3",
"interval":"10",
"timeout":"2000"
},
"userAnnotation": "Mock CFM loopback result 2016.12.9"
}
}

Sample response

{
"data": {
"id": "0b819030-7758-4434-b497-9f5193c8cf1a",
"type": "testResults",
"attributes": {
"testResults": [],
"testType": "cfm_loopback",
"testStatus": "Started",
"localTpeId": "MockCfmCtp1",
"remotePoints": [
"MockCfmCtp2"
],
"localNcId": "MockNc3932",
"remoteNcs": [
"6f2f54e9-5786-3cbc-96e9-75536b68696c"
],
"startTime": 1481298982614,
"lastUpdateTime": 1481298982614,
"testParameters": {
"interval": "10",
"priority": "3",
"timeout": "2000"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 631
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"localMepId": "2",
"userAnnotation": "Mock CFM loopback result 2016.12.9",
"remoteMepId": "1",
"remoteMepMacAddress": "00:23:8A:A2:42:AA",
"cfmServiceName": "mcpEplCfmTest"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "MockCfmCtp1"
},
{
"type": "tpes",
"id": "MockCfmCtp2"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "MockNc3932"
},
{
"type": "networkConstructs",
"id": "6f2f54e9-5786-3cbc-96e9-75536b68696c"
}
]
},
"adjacencyFres": {
"data": []
}
}
},
"resultsCode": "202"
}

Retrieve the test results of an 802.1ag loopback on a selected tunnel

To retrieve the test results, use the Test and diagnostics API.

Sample request

GET {{MCP_SERVER}}/tdc/api/tests/<TestRecord ID>

Specify the Test Record ID, which is the “id” (for example, 0b819030-7758-4434-b497-9f5193c8cf1a) of
the response (when you Perform an 802.1ag loopback on a selected service.

https://<mcp_server>/tdc/api/tests/fc6aba0a-19a9-4915-9262-1a8927c4846f

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 632
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Sample response

{
"data": {
"id": "0b819030-7758-4434-b497-9f5193c8cf1a",
"type": "testResults",
"attributes": {
"testResults": [
{
"operationalStatus": "success",
"testResultsStatus": "failed",
"dataType": "summary"
},
{
"lbmToBeTransmitted": "0",
"dataType": "loopbackResults",
"lbmTransmitted": "5",
"lbrInOrderCount": "4",
"lbrContentMismatchedCount": "0",
"lbrOutOfOrderCount": "1"
}
],
"testType": "cfm_loopback",
"testStatus": "Completed",
"localTpeId": "MockCfmCtp1",
"remotePoints": [
"MockCfmCtp2"
],
"localNcId": "MockNc3932",
"remoteNcs": [
"6f2f54e9-5786-3cbc-96e9-75536b68696c"
],
"startTime": 1481298982614,
"lastUpdateTime": 1481298985015,
"testParameters": {
"localMepId": "1",
"count": "5",
"interval": "20",
"priority": "6",
"timeout": "2000"
},
"localMepId": "2",
"userAnnotation": "Mock CFM loopback result 2016.12.9",
"remoteMepId": "1",
"remoteMepMacAddress": "00:23:8A:A2:42:AA",
"cfmServiceName": "mcpEplCfmTest"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "MockCfmCtp1"
},
{
"type": "tpes",
"id": "MockCfmCtp2"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 633
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "MockNc3932"
},
{
"type": "networkConstructs",
"id": "6f2f54e9-5786-3cbc-96e9-75536b68696c"
}
]
},
"adjacencyFres": {
"data": []
}
}
},
"resultsCode": 200,
"requestIds": "0b819030-7758-4434-b497-9f5193c8cf1a"
}

Perform PW ping on a selected service

This section includes the following topics:

• Perform a pseudowire (PW) ping on a MS-PW service

• Retrieve the test results

Perform a pseudowire (PW) ping on a MS-PW service

To perform a PW ping on a selected service, use the Test and diagnostics API.

Note: You can also use this API call for a PW on an E-LAN service.

Sample request

POST {{MCP_SERVER}}/tdc/api/tests/pwOperations

Note: For an E-Tree service, you can only run a test from root-to-leaf or leaf-to-root. You cannot run a test
from leaf-to-leaf or root-to-root.

Specify the required service.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 634
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"type": "ping",
"localTpeId": "MockPwCtp",
"testParameters": {
"count": "5",
"packetSize": "114",
"replyMode": "ipv4",
"timeout": "500"
},
"userAnnotation": "2016.12.19 for example collection"
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 635
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"id": "059dc392-e465-4f17-8874-eecbb84b30fa",
"type": "testResults",
"attributes": {
"testResults": [],
"testType": "pw_ping",
"testStatus": "Started",
"localTpeId": "MockPwCtp",
"remotePoints": [],
"localNcId": "MockNc6500Mpls",
"remoteNcs": [],
"startTime": 1483555500917,
"lastUpdateTime": 1483555500917,
"testParameters": {
"count": "5",
"packetSize": "114",
"replyMode": "ipv4",
"timeout": "500"
},
"userAnnotation": "2016.12.19 for example collection",
"equipmentGroupId": "9",
"pseudowireName": "apMcpMpls_PW_1",
"shelf": "12"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "MockPwCtp"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "MockNc6500Mpls"
}
]
}
}
},
"resultsCode": "202"
}

Retrieve the test results

To retrieve the test results, use the Test and diagnostics API.

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 636
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

GET {{MCP_SERVER}}/tdc/api/tests/<Test Record ID>

Specify the Test Record ID, which is the “id” (for example, 059dc392-e465-4f17-8874-eecbb84b30fa) of
the response (when you Perform a pseudowire (PW) ping on a MS-PW service).

https://<mcp_server>/tdc/api/tests/fc6aba0a-19a9-4915-9262-1a8927c4846f

Sample response

{
"data": {
"id": "059dc392-e465-4f17-8874-eecbb84b30fa",
"type": "testResults",
"attributes": {
"testResults": [
{
"operationalStatus": "success",
"testResultsStatus": "passed",
"dataType": "summary"
},
{
"dataType": "pingResults"
},
{
"dataType": "rawData",
"rawData": "MPLS Ping with count (5) timeout (1000 ms) size (138 bytes)
encap (ip/udp) reply-mode (lsp)\nLegend:'!' - Success, 'X' - Error\n! Seq: 1
Latency: 3 ms\n! Seq: 2 Latency: 3 ms\n! Seq: 3 Latency: 3 ms\n! Seq: 4 Latency: 4
ms\n! Seq: 5 Latency: 2 ms\n\n--------------- Statistics ---------------\n5 packets
transmitted, 5 packets received\nround-trip (ms) min/avg/max = 2/3/4"
}
],
"testType": "pw_ping",
"testStatus": "Completed",
"localTpeId": "MockPwCtp",
"remotePoints": [],
"localNcId": "MockNc6500Mpls",
"remoteNcs": [],
"startTime": 1483555500917,
"lastUpdateTime": 1483555501978,
"testParameters": {
"count": "5",
"packetSize": "114",
"replyMode": "ipv4",
"timeout": "500"
},
"userAnnotation": "2016.12.19 for example collection",
"equipmentGroupId": "9",
"pseudowireName": "apMcpMpls_PW_1",
"shelf": "12"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 637
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"id": "MockPwCtp"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "MockNc6500Mpls"
}
]
}
}
},
"resultsCode": 200,
"requestIds": "059dc392-e465-4f17-8874-eecbb84b30fa"
}

Perform PW ping on a MS-PW based service from any T-PE or S-

PE to any other T-PE or S-PE
See Perform PW ping on a selected service.

Perform the PW ping, specifying the required parameters. Then retrieve the test results.

Perform PW ping for a MS-PW based service from either

direction
See Perform PW ping on a selected service.

Perform the PW ping, specifying the required parameters. Then retrieve the test results.

Perform PW ping on a MS-PW based service that is all MPLS

See Perform PW ping on a selected service.

Perform the PW ping, specifying the required parameters. Then retrieve the test results.

Perform PW ping on a MS-PW based service that is MPLS with

QiQ spur(s)
See Perform PW ping on a selected service.

Perform the PW ping, specifying the required parameters. Then retrieve the test results.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 638
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Perform pseudowire traceroute and retrieve test results

This section includes the following topic:

• Perform a pseudowire traceroute

• Retrieve pseudowire traceroute results

Note: You can use this API call for an MS-PW traceroute on an E-LAN service.

Perform a pseudowire traceroute

To perform a pseudowire traceroute, use the Testing and diagnostics API.

Sample request

POST {{MCP_SERVER}}/tdc/api/v1/tests/pwOperations

Note: For an E-Tree service, you can only run a test from root-to-leaf or leaf-to-root. You cannot run a test
from leaf-to-leaf or root-to-root.

Specify the following attribute: type as traceroute. Also, select values for testParameters, as required.

{
"data": {
"type": "traceroute",
"localTpeId": "MockPwCtp3",
"testParameters": {
"count": "5",
"packetSize": "114",
"replyMode": "ipv4",
"timeout": "500"
},
"userAnnotation": "2016.12.19 for example collection"
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 639
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"id": "49a9f671-4e48-460e-8eb5-91fe39266737",
"type": "testResults",
"attributes": {
"testResults": [],
"testType": "pw_ping",
"testStatus": "Started",
"localTpeId": "f240cfdf-bd82-32ea-9040-
1cd2fcfc29e7::TPE_CTPServerToClient_PW_apMcpMpls6_PW_1",
"remotePoints": [],
"localNcId": "f240cfdf-bd82-32ea-9040-1cd2fcfc29e7",
"remoteNcs": [],
"startTime": 1484599280949,
"lastUpdateTime": 1484599280949,
"testParameters": {},
"pseudowireName": "apMcpMpls6_PW_1",
"userAnnotation": "string"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "f240cfdf-bd82-32ea-9040-
1cd2fcfc29e7::TPE_CTPServerToClient_PW_apMcpMpls6_PW_1"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "f240cfdf-bd82-32ea-9040-1cd2fcfc29e7"
}
]
}
}
},
"resultsCode": "202"
}

Retrieve pseudowire traceroute results

Sample request GET {{MCP_SERVER}}/tdc/api/v1/tests/<TEST ID>

Specify TEST ID, which is generated from the POST call when you performed the pseudowire traceroute
test.

Sample response

{
"data": {
"id": "5a49ebcc-b7f6-4d70-a4ec-be2a2336aafd",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 640
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"type": "testResults",
"attributes": {
"testResults": [
{
"mtuUnit": "bytes",
"networkConstructName": "5160_0017",
"messageType": "Loc",
"dataType": "locResult",
"hop": "0",
"nextHopIp": "16.24.0.1",
"nextHopLabel": "8214",
"mtu": "1500"
},
{
"errorMessage": "Request Timed Out",
"hop": "1",
"dataType": "Result",
"status": "failure"
},
{
"errorMessage": "Request Timed Out",
"hop": "2",
"dataType": "Result",
"status": "failure"
},
{
"errorMessage": "Request Timed Out",
"hop": "3",
"dataType": "Result",
"status": "failure"
},
{
"errorMessage": "Request Timed Out",
"hop": "4",
"dataType": "Result",
"status": "failure"
},
{
"errorMessage": "Request Timed Out",
"hop": "5",
"dataType": "Result",
"status": "failure"
},
{
"errorMessage": "Request Timed Out",
"hop": "6",
"dataType": "Result",
"status": "failure"
},
{
"errorMessage": "Request Timed Out",
"hop": "7",
"dataType": "Result",
"status": "failure"
},
{
"errorMessage": "Request Timed Out",
"hop": "8",
"dataType": "Result",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 641
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"status": "failure"
},
{
"errorMessage": "Request Timed Out",
"hop": "9",
"dataType": "Result",
"status": "failure"
},
{
"errorMessage": "Request Timed Out",
"hop": "10",
"dataType": "Result",
"status": "failure"
},
{
"errorMessage": "Request Timed Out",
"hop": "11",
"dataType": "Result",
"status": "failure"
},
{
"errorMessage": "Request Timed Out",
"hop": "12",
"dataType": "Result",
"status": "failure"
},
{
"errorMessage": "Request Timed Out",
"hop": "13",
"dataType": "Result",
"status": "failure"
},
{
"errorMessage": "Request Timed Out",
"hop": "14",
"dataType": "Result",
"status": "failure"
},
{
"errorMessage": "Request Timed Out",
"hop": "15",
"dataType": "Result",
"status": "failure"
},
{
"errorMessage": "Request Timed Out",
"hop": "16",
"dataType": "Result",
"status": "failure"
},
{
"errorMessage": "Request Timed Out",
"hop": "17",
"dataType": "Result",
"status": "failure"
},
{
"errorMessage": "Request Timed Out",
"hop": "18",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 642
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"dataType": "Result",
"status": "failure"
},
{
"errorMessage": "Request Timed Out",
"hop": "19",
"dataType": "Result",
"status": "failure"
},
{
"networkConstructName": "5142_0017",
"latencyUnit": "ms",
"messageType": "Egr",
"dataType": "egrResult",
"latency": "255",
"hop": "20"
},
{
"operationalStatus": "success",
"testResultsStatus": "passed",
"dataType": "summary"
},
{
"dataType": "rawData",
"rawData": "MPLS traceroute with ttl (30) timeout (1000 ms) encap
(ip/udp) reply-mode (lsp)\nLegend:'!' - Success, 'X' - Error\n! Loc Hop: 0 Next
Hop: ip 16.24.0.1 Label: 8214 MTU: 1500 bytes\nX TTL: 1 Request Timed Out\nX TTL: 2
Request Timed Out\nX TTL: 3 Request Timed Out\nX TTL: 4 Request Timed Out\nX TTL: 5
Request Timed Out\nX TTL: 6 Request Timed Out\nX TTL: 7 Request Timed Out\nX TTL: 8
Request Timed Out\nX TTL: 9 Request Timed Out\nX TTL: 10 Request Timed Out\nX TTL:
11 Request Timed Out\nX TTL: 12 Request Timed Out\nX TTL: 13 Request Timed Out\nX
TTL: 14 Request Timed Out\nX TTL: 15 Request Timed Out\nX TTL: 16 Request Timed
Out\nX TTL: 17 Request Timed Out\nX TTL: 18 Request Timed Out\nX TTL: 19 Request
Timed Out\n! Egr Hop: 20 Latency: 255 ms"
}
],
"testType": "pwTraceroute",
"testStatus": "Completed",
"localTpeId": "91521701-41c0-3892-a008-
8114e6f46175::TPE_CTPServerToClient_PW_apMcpMpls2_PW_1",
"remotePoints": [],
"localNcId": "91521701-41c0-3892-a008-8114e6f46175",
"remoteNcs": [
"f240cfdf-bd82-32ea-9040-1cd2fcfc29e7"
],
"startTime": 1492789374403,
"lastUpdateTime": 1492789395823,
"testParameters": {
"encapType": "ip/udp",
"timeoutUnit": "ms",
"ttl": "30",
"timeout": "1000",
"replyMode": "lsp"
},
"pseudowireName": "apMcpMpls2_PW_1",
"userAnnotation": "string"
},
"relationships": {
"tpes": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 643
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"data": [
{
"type": "tpes",
"id": "91521701-41c0-3892-a008-
8114e6f46175::TPE_CTPServerToClient_PW_apMcpMpls2_PW_1"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "91521701-41c0-3892-a008-8114e6f46175"
},
{
"type": "networkConstructs",
"id": "f240cfdf-bd82-32ea-9040-1cd2fcfc29e7"
}
]
},
"adjacencyFres": {
"data": [
{
"type": "fres",
"id": "-1996657695693970062"
}
]
},
"ipDataFres": {
"data": [
{
"type": "fres",
"id": "7108030853852057371"
}
]
}
}
},
"resultsCode": 200,
"requestIds": "5a49ebcc-b7f6-4d70-a4ec-be2a2336aafd"
}

Perform LSP ping on a selected tunnel and retrieve its results

This section includes the following topic:

• Perform an LSP ping test on a selected tunnel

• Retrieve the test results of an LSP ping on a selected tunnel

Note: LSP Ping is supported for both static and dynamic tunnels.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 644
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Perform an LSP ping test on a selected tunnel

To start an LSP ping test, use the Test and diagnostics API.

Sample request

POST {{MCP_SERVER}}/tdc/api/tests/lspOperations

Note: For an E-Tree service, you can only run a test from root-to-leaf or leaf-to-root. You cannot run a test
from leaf-to-leaf or root-to-root.

{
"data": {
"type": "ping",
"localTpeId": "MockLspCtp6x",
"testParameters": {
"count": "5",
"packetSize": "98",
"encapType": "ip/udp",
"replyMode": "lsp",
"timeout": "500",
"ttl": "3"
},
"userAnnotation": "2016.12.8 The testParameters can be left empty."
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 645
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"id": "fc6aba0a-19a9-4915-9262-1a8927c4846f",
"type": "testResults",
"attributes": {
"testResults": [],
"testType": "lsp_ping",
"testStatus": "Started",
"localTpeId": "MockLspCtp6x",
"remotePoints": [],
"localNcId": "MockNc5142",
"remoteNcs": [],
"startTime": 1483551682852,
"lastUpdateTime": 1483551682852,
"testParameters": {
"encapType": "ip/udp",
"count": "5",
"packetSize": "98",
"ttl": "3",
"replyMode": "lsp",
"timeout": "500"
},
"lspName": "apMcpLsp6x3",
"userAnnotation": "2016.12.8 The testParameters can be left empty.",
"tunnelType": "egress-corouted-static"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "MockLspCtp6x"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "MockNc5142"
}
]
}
}
},
"resultsCode": "202"
}

Retrieve the test results of an LSP ping on a selected tunnel

To retrieve the test results, use the Test and diagnostics API.

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 646
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

GET {{MCP_SERVER}}/tdc/api/tests/<Test Record ID>

Specify the Test Record ID, which is the “id” (for example, fc6aba0a-19a9-4915-9262-1a8927c4846f) of
the response (when you Perform an LSP ping test on a selected tunnel).

https://<mcp_server>/tdc/api/tests/fc6aba0a-19a9-4915-9262-1a8927c4846f

Sample response

{
"data": {
"id": "fc6aba0a-19a9-4915-9262-1a8927c4846f",
"type": "testResults",
"attributes": {
"testResults": [
{
"operationalStatus": "success",
"testResultsStatus": "passed",
"dataType": "summary"
},
{
"rxPackets": "10",
"roundTripMax": "6",
"latencyUnit": "ms",
"dataType": "pingResults",
"txPackets": "10",
"type": "statistics",
"roundTripMin": "3",
"roundTripAvg": "3"
},
{
"dataType": "rawData",
"rawData": "MPLS Ping with count (10) ttl (200) timeout (500 ms) size
(126 bytes) encap (ip/udp) reply-mode (ipv4)\nLegend:'!' - Success, 'X' - Error\n!
Seq: 1 Latency: 5 ms\n! Seq: 2 Latency: 3 ms\n! Seq: 3 Latency: 3 ms\n! Seq: 4
Latency: 3 ms\n! Seq: 5 Latency: 3 ms\n! Seq: 6 Latency: 3 ms\n! Seq: 7 Latency: 6
ms\n! Seq: 8 Latency: 3 ms\n! Seq: 9 Latency: 3 ms\n! Seq: 10 Latency: 3
ms\n\n--------------- Statistics ---------------\n10 packets transmitted, 10
packets received\nround-trip (ms) min/avg/max = 3/3/6"
}
],
"testType": "lsp_ping",
"testStatus": "Completed",
"localTpeId": "MockLspCtp6x",
"remotePoints": [],
"localNcId": "MockNc5142",
"remoteNcs": [],
"startTime": 1483551682852,
"lastUpdateTime": 1483551686242,
"testParameters": {
"encapType": "ip/udp",
"packetSizeUnit": "bytes",
"timeoutUnit": "ms",
"count": "10",
"packetSize": "126",
"ttl": "200",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 647
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"replyMode": "ipv4",
"timeout": "500"
},
"lspName": "apMcpLsp6x3",
"userAnnotation": "2016.12.8 The testParameters can be left empty.",
"tunnelType": "egress-corouted-static"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "MockLspCtp6x"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "MockNc5142"
}
]
}
}
},
"resultsCode": 200,
"requestIds": "fc6aba0a-19a9-4915-9262-1a8927c4846f"
}

Perform LSP traceroute on tunnel retrieve results between two

E-LAN endpoints
This section includes the following topics:

• Perform an LSP traceroute on a selected tunnel

• Retrieve the test results of an LSP ping on a selected tunnel

Note: LSP Traceroute is supported for both static and dynamic tunnels.

Perform an LSP traceroute on a selected tunnel

To perform an LSP traceroute test on a selected tunnel, use the Test and diagnostics API.

Sample request

POST {{MCP_SERVER}}/tdc/api/tests/lspOperations

Note: For an E-Tree service, you can only run a test from root-to-leaf or leaf-to-root. You cannot run a test

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 648
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

from leaf-to-leaf or root-to-root.

{
"data": {
"type": "traceroute",
"localTpeId": "MockLspCtp",
"testParameters": {
"encapType": "non-ip/udp",
"replyMode": "ipv4",
"timeout": "10000",
"ttl": "30"
},
"userAnnotation": "2016.12.9 The testParameters can be left empty."
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 649
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"id": "c2666233-3bc5-4129-acf5-0d85c2e41e7e",
"type": "testResults",
"attributes": {
"testResults": [],
"testType": "lsp_traceroute",
"testStatus": "Started",
"localTpeId": "MockLspCtp",
"remotePoints": [],
"localNcId": "MockNc6500Mpls",
"remoteNcs": [],
"startTime": 1483554806632,
"lastUpdateTime": 1483554806632,
"testParameters": {
"encapType": "non-ip/udp",
"ttl": "30",
"replyMode": "ipv4",
"timeout": "10000"
},
"lspName": "mcpLspPrimary",
"userAnnotation": "2016.12.9 The testParameters can be left empty.",
"tunnelType": "ingress-corouted-static",
"equipmentGroupId": "9",
"shelf": "1"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "MockLspCtp"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "MockNc6500Mpls"
}
]
}
}
},
"resultsCode": "202"
}

Retrieve the test results

To retrieve the test results, use the Test and diagnostics API.

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 650
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

GET {{MCP_SERVER}}/tdc/api/tests/<TestRecord ID>

Specify the Test Record ID, which is the “id” (for example, c2666233-3bc5-4129-acf5-0d85c2e41e7e) of
the response (when you Perform an LSP traceroute on a selected tunnel).

https://<mcp_server>/tdc/api/tests/c2666233-3bc5-4129-acf5-0d85c2e41e7e

Sample response

{
"data": {
"id": "c2666233-3bc5-4129-acf5-0d85c2e41e7e",
"type": "testResults",
"attributes": {
"testResults": [
{
"mtuUnit": "bytes",
"networkConstructName": "65sd_2071",
"sourceIp": "16.24.0.1",
"messageType": "Loc",
"dataType": "locResult",
"hop": "0",
"nextHopIfNum": "0",
"nextHopLabel": "16",
"mtu": "1500"
},

...,
{
"operationalStatus": "success",
"testResultsStatus": "passed",
"dataType": "summary"
},
{
"dataType": "rawData",
"rawData": "MPLS traceroute with ttl (30) timeout (1000 ms) encap (non-
ip/udp) reply-mode (lsp)\nLegend:'!' - Success, 'X' - Error\n! Loc Node: 0 Id
16.24.0.3 Next Hop: ingress ifNum 0 Label 19 MTU 1500\n! Egr Node: 1 Id
20.226.84.144 Latency: 3 ms"
}
],
"testType": "lsp_traceroute",
"testStatus": "Completed",
"localTpeId": "MockLspCtp",
"remotePoints": [],
"localNcId": "MockNc6500Mpls",
"remoteNcs": [
"MockNc5142",
"MockNc6500"
],
"startTime": 1483554806632,
"lastUpdateTime": 1483554809837,
"testParameters": {
"encapType": "non-ip/udp",
"ttl": "30",
"replyMode": "ipv4",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 651
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"timeout": "10000"
},
"lspName": "mcpLspPrimary",
"userAnnotation": "2016.12.9 The testParameters can be left empty.",
"tunnelType": "ingress-corouted-static",
"equipmentGroupId": "9",
"shelf": "1"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "MockLspCtp"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "MockNc5142"
},
{
"type": "networkConstructs",
"id": "MockNc6500"
},
{
"type": "networkConstructs",
"id": "MockNc6500Mpls"
}
]
},
"adjacencyFres": {
"data": [
{
"type": "fres",
"id": "adjacencyFre_MockNc5142_MockNc6500"
},
{
"type": "fres",
"id": "adjacencyFre_MockNc6500Mpls_MockNc5142"
}
]
},
"ipDataFres": {
"data": [
{
"type": "fres",
"id": "ipDataFreAp_MockNc5142_MockNc6500"
},
{
"type": "fres",
"id": "ipDataFreAp_MockNc6500Mpls_MockNc5142"
}
]
}
}
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 652
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"resultsCode": 200,
"requestIds": "c2666233-3bc5-4129-acf5-0d85c2e41e7e"
}

Perform port fac loopback CES AimValley CSoP Smart SFP

retrieve results
As a TDM CEM troubleshooting user, you want to be able to set/enable a port level Facility Loopback on a
CES AimValley CSoP Smart SFP endpoint of a selected TDM CEM service or a selected TDM STM-1 port
and also be able to retrieve Loopback configuration details so you can have information to help diagnose
TDM CEM service problems.

This troubleshooting flow includes the following topics:

• Enable the test

• Retrieve the test results
• Disable the test

Enable the test

To set/enable the port level facility loopback test, use the Test and diagnostics API.

Sample request

POST {{MCP_SERVER}}/tdc/api/v1/tests/tdmOperations

Specify the local TPE ID, operation, mode, and type.

{
"data": {
"type": "tdmLoopback",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"testParameters": {
"operation": "enable",
"mode": "facility",
"type":"port",
"channel":"36"
},
"userAnnotation": "string"
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 653
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"id": "14e53a07-bf70-4af6-824a-5973dcfbda64",
"type": "testResults",
"attributes": {
"testResults": [],
"testType": "tdmLoopback",
"testStatus": "Started",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"remotePoints": [],
"localNcId": "c5efbaca-8783-3471-8576-3e2145d9b5db",
"remoteNcs": [],
"startTime": 1510767934824,
"lastUpdateTime": 1510767934824,
"testParameters": {
"mode": "facility",
"channel": "36",
"type": "port",
"operation": "enable"
},
"portType": "csopStm1",
"userAnnotation": "string",
"portName": "TDMSFP_P7"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "c5efbaca-8783-3471-8576-3e2145d9b5db"
}
]
}
}
},
"resultsCode": "202"
}

Retrieve the test results

To retrieve the test results, use the Test and diagnostics API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 654
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Sample request

GET {{MCP_SERVER}}/tdc/api/v1/operationalStatus?freId=<FRE_ID>&osTypeString=tdmStatus

Specify the FRE ID of the service the test is running against and “tdmStatus” for the “osTypeString”.

The body is empty.

Sample response

{
"data": {
"id": "6ade74a7-2c47-43f0-b384-b2f382158fb6",
"type": "operationalStatus",
"attributes": {},
"relationships": {
"osData": {
"data": [
{
"type": "tdmStatus",
"id": "-7901343478415674956:1::TDMSTATUS"
},
{
"type": "tdmStatus",
"id": "-7901343478415674956:2::TDMSTATUS"
}
]
},
"fres": {
"data": [
{
"type": "fres",
"id": "-7901343478415674956"
}
]
}
}
},
"included": [
{
"id": "-7901343478415674956:1::TDMSTATUS",
"type": "tdmStatus",
"attributes": {
"mode": "terminal",
"channel": "36",
"type": "ds1-e1",
"enabled": false
},
"relationships": {
"tpes": {
"data": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 655
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"type": "tpes",
"id": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP"
}
}
}
},
{
"id": "-7901343478415674956:2::TDMSTATUS",
"type": "tdmStatus",
"attributes": {
"mode": "terminal",
"channel": "36",
"type": "port",
"enabled": false
},
"relationships": {
"tpes": {
"data": {
"type": "tpes",
"id": "d4b218da-c1e3-3fd8-8f6c-
69e8a465c6c9::TPE_chTdm1_7_36_PTP_E1_CTP"
}
}
}
}
],
"requestIds": "-7901343478415674956",
"resultsCode": "202"
}

Disable the test

To disable the test, use the Test and diagnostics API.

Sample request

POST {{MCP_SERVER}}/tdc/api/v1/tests/tdmOperations

Specify the local TPE ID, operation, mode, and type.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 656
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"type": "tdmLoopback",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"testParameters": {
"operation": "disable",
"mode": "facility",
"type":"port",
"channel":"36"
},
"userAnnotation": "string"
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 657
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"id": "14e53a07-bf70-4af6-824a-5973dcfbda64",
"type": "testResults",
"attributes": {
"testResults": [],
"testType": "tdmLoopback",
"testStatus": "Started",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"remotePoints": [],
"localNcId": "c5efbaca-8783-3471-8576-3e2145d9b5db",
"remoteNcs": [],
"startTime": 1510767934824,
"lastUpdateTime": 1510767934824,
"testParameters": {
"mode": "facility",
"channel": "36",
"type": "port",
"operation": "disable"
},
"portType": "csopStm1",
"userAnnotation": "string",
"portName": "TDMSFP_P7"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "c5efbaca-8783-3471-8576-3e2145d9b5db"
}
]
}
}
},
"resultsCode": "202"
}

Perform channel level fac loopback CES AimValley CSoP Smart

SFP retrieve results
As a TDM CEM troubleshooting user, you want to be able to set/enable an E1 channel level Facility
Loopback on a CES AimValley CSoP Smart SFP endpoint of a selected TDM CEM service or a selected
TDM STM-1 port and E1 channel and also be able to retrieve Loopback configuration details so you can

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 658
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

have information to help diagnose TDM CEM service problems.

This troubleshooting flow includes the following topics:

• Enable the test

• Retrieve the test results
• Disable the test

Enable the test

To set/enable the channel level facility loopback test, use the Test and diagnostics API.

Sample request

POST {{MCP_SERVER}}/tdc/api/v1/tests/tdmOperations

Specify the local TPE ID, operation, mode, type, and channel.

{
"data": {
"type": "tdmLoopback",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"testParameters": {
"operation": "enable",
"mode": "facility",
"type":"ds1-e1",
"channel":"36"
},
"userAnnotation": "string"
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 659
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"id": "866362f6-4d1c-48c8-94c3-23848a99dbb6",
"type": "testResults",
"attributes": {
"testResults": [],
"testType": "tdmLoopback",
"testStatus": "Started",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"remotePoints": [],
"localNcId": "c5efbaca-8783-3471-8576-3e2145d9b5db",
"remoteNcs": [],
"startTime": 1510767830375,
"lastUpdateTime": 1510767830375,
"testParameters": {
"mode": "facility",
"channel": "36",
"type": "ds1-e1",
"operation": "enable"
},
"portType": "csopStm1",
"userAnnotation": "string",
"portName": "TDMSFP_P7"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "c5efbaca-8783-3471-8576-3e2145d9b5db"
}
]
}
}
},
"resultsCode": "202"
}

Retrieve the test results

To retrieve the test results, use the Test and diagnostics API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 660
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Sample request

GET {{MCP_SERVER}}/tdc/api/v1/operationalStatus?freId=<FRE_ID>&osTypeString=tdmStatus

Specify the FRE ID of the service the test is running against and “tdmStatus” for the “osTypeString”.

The body is empty.

Sample response

{
"data": {
"id": "6ade74a7-2c47-43f0-b384-b2f382158fb6",
"type": "operationalStatus",
"attributes": {},
"relationships": {
"osData": {
"data": [
{
"type": "tdmStatus",
"id": "-7901343478415674956:1::TDMSTATUS"
},
{
"type": "tdmStatus",
"id": "-7901343478415674956:2::TDMSTATUS"
}
]
},
"fres": {
"data": [
{
"type": "fres",
"id": "-7901343478415674956"
}
]
}
}
},
"included": [
{
"id": "-7901343478415674956:1::TDMSTATUS",
"type": "tdmStatus",
"attributes": {
"mode": "facility",
"channel": "36",
"type": "ds1-e1",
"enabled": false
},
"relationships": {
"tpes": {
"data": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 661
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"type": "tpes",
"id": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP"
}
}
}
},
{
"id": "-7901343478415674956:2::TDMSTATUS",
"type": "tdmStatus",
"attributes": {
"mode": "terminal",
"channel": "36",
"type": "port",
"enabled": false
},
"relationships": {
"tpes": {
"data": {
"type": "tpes",
"id": "d4b218da-c1e3-3fd8-8f6c-
69e8a465c6c9::TPE_chTdm1_7_36_PTP_E1_CTP"
}
}
}
}
],
"requestIds": "-7901343478415674956",
"resultsCode": "202"
}

Disable the test

To disable the test, use the Test and diagnostics API.

Sample request

POST {{MCP_SERVER}}/tdc/api/v1/tests/tdmOperations

Specify the local TPE ID, operation, mode, type, and channel.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 662
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"type": "tdmLoopback",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"testParameters": {
"operation": "disable",
"mode": "facility",
"type":"ds1-e1",
"channel":"36"
},
"userAnnotation": "string"
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 663
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"id": "0c74c557-7775-4168-910c-43a420dc3520",
"type": "testResults",
"attributes": {
"testResults": [],
"testType": "tdmLoopback",
"testStatus": "Started",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"remotePoints": [],
"localNcId": "c5efbaca-8783-3471-8576-3e2145d9b5db",
"remoteNcs": [],
"startTime": 1510767895278,
"lastUpdateTime": 1510767895278,
"testParameters": {
"mode": "facility",
"channel": "36",
"type": "ds1-e1",
"operation": "disable"
},
"portType": "csopStm1",
"userAnnotation": "string",
"portName": "TDMSFP_P7"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "c5efbaca-8783-3471-8576-3e2145d9b5db"
}
]
}
}
},
"resultsCode": "202"
}

Perform port level terminal loopback on a CES AimValley CSoP

Smart SFP
As a TDM CEM troubleshooting user, you want to be able to set/enable a port level Terminal Loopback on
a CES AimValley CSoP Smart SFP endpoint of a selected TDM CEM service or a selected TDM STM-1 port
and also be able to retrieve Loopback configuration details so you can have information to help diagnose

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 664
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

TDM CEM service problems.

This troubleshooting flow includes the following topics:

• Enable the test

• Retrieve the test results
• Disable the test

Enable the test

To set/enable the port level terminal loopback test, use the Test and diagnostics API.

Sample request

POST {{MCP_SERVER}}/tdc/api/v1/tests/tdmOperations

Specify the local TPE ID, operation, mode, and type.

{
"data": {
"type": "tdmLoopback",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"testParameters": {
"operation": "enable",
"mode": "terminal",
"type":"port",
"channel":"36"
},
"userAnnotation": "string"
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 665
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"id": "5fb72c0a-459f-4fce-9f92-c6ba580a419c",
"type": "testResults",
"attributes": {
"testResults": [],
"testType": "tdmLoopback",
"testStatus": "Started",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"remotePoints": [],
"localNcId": "c5efbaca-8783-3471-8576-3e2145d9b5db",
"remoteNcs": [],
"startTime": 1510767979010,
"lastUpdateTime": 1510767979010,
"testParameters": {
"mode": "terminal",
"channel": "36",
"type": "port",
"operation": "enable"
},
"portType": "csopStm1",
"userAnnotation": "string",
"portName": "TDMSFP_P7"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "c5efbaca-8783-3471-8576-3e2145d9b5db"
}
]
}
}
},
"resultsCode": "202"
}

Retrieve the test results

To retrieve the test results, use the Test and diagnostics API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 666
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Sample request

GET {{MCP_SERVER}}/tdc/api/v1/operationalStatus?freId=<FRE_ID>&osTypeString=tdmStatus

Specify the FRE ID of the service the test is running against and “tdmStatus” for the “osTypeString”.

The body is empty.

Sample response

{
"data": {
"id": "6ade74a7-2c47-43f0-b384-b2f382158fb6",
"type": "operationalStatus",
"attributes": {},
"relationships": {
"osData": {
"data": [
{
"type": "tdmStatus",
"id": "-7901343478415674956:1::TDMSTATUS"
},
{
"type": "tdmStatus",
"id": "-7901343478415674956:2::TDMSTATUS"
}
]
},
"fres": {
"data": [
{
"type": "fres",
"id": "-7901343478415674956"
}
]
}
}
},
"included": [
{
"id": "-7901343478415674956:1::TDMSTATUS",
"type": "tdmStatus",
"attributes": {
"mode": "terminal",
"channel": "36",
"type": "ds1-e1",
"enabled": false
},
"relationships": {
"tpes": {
"data": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 667
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"type": "tpes",
"id": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP"
}
}
}
},
{
"id": "-7901343478415674956:2::TDMSTATUS",
"type": "tdmStatus",
"attributes": {
"mode": "terminal",
"channel": "36",
"type": "port",
"enabled": false
},
"relationships": {
"tpes": {
"data": {
"type": "tpes",
"id": "d4b218da-c1e3-3fd8-8f6c-
69e8a465c6c9::TPE_chTdm1_7_36_PTP_E1_CTP"
}
}
}
}
],
"requestIds": "-7901343478415674956",
"resultsCode": "202"
}

Disable the test

To disable the test, use the Test and diagnostics API.

Sample request

POST {{MCP_SERVER}}/tdc/api/v1/tests/tdmOperations

Specify the local TPE ID, operation, mode, and type.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 668
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"type": "tdmLoopback",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"testParameters": {
"operation": "disable",
"mode": "terminal",
"type":"port",
"channel":"36"
},
"userAnnotation": "string"
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 669
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"id": "5fb72c0a-459f-4fce-9f92-c6ba580a419c",
"type": "testResults",
"attributes": {
"testResults": [],
"testType": "tdmLoopback",
"testStatus": "Started",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"remotePoints": [],
"localNcId": "c5efbaca-8783-3471-8576-3e2145d9b5db",
"remoteNcs": [],
"startTime": 1510767979010,
"lastUpdateTime": 1510767979010,
"testParameters": {
"mode": "terminal",
"channel": "36",
"type": "port",
"operation": "disable"
},
"portType": "csopStm1",
"userAnnotation": "string",
"portName": "TDMSFP_P7"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "c5efbaca-8783-3471-8576-3e2145d9b5db"
}
]
}
}
},
"resultsCode": "202"
}

Perform channel level terminal loopback on a CES AimValley

CSoP Smart SFP
As a TDM CEM troubleshooting user, you want to be able to set/enable an E1 channel level Terminal
Loopback on a CES AimValley CSoP Smart SFP endpoint of a selected TDM CEM service or a selected
TDM STM-1 port and E1 channel and also be able to retrieve Loopback configuration details so you can

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 670
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

have information to help diagnose TDM CEM service problems.

This troubleshooting flow includes the following topics:

• Enable the test

• Retrieve the test results
• Disable the test

Enable the test

To set/enable the channel level terminal loopback test, use the Test and diagnostics API.

Sample request

POST {{MCP_SERVER}}/tdc/api/v1/tests/tdmOperations

Specify the local TPE ID, operation, mode, type, and channel.

{
"data": {
"type": "tdmLoopback",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"testParameters": {
"operation": "enable",
"mode": "terminal",
"type":"ds1-e1",
"channel":"36"
},
"userAnnotation": "string"
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 671
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"id": "1ae14878-b3e3-48df-b57f-49a6ccb35719",
"type": "testResults",
"attributes": {
"testResults": [],
"testType": "tdmLoopback",
"testStatus": "Started",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"remotePoints": [],
"localNcId": "c5efbaca-8783-3471-8576-3e2145d9b5db",
"remoteNcs": [],
"startTime": 1510768145023,
"lastUpdateTime": 1510768145023,
"testParameters": {
"mode": "terminal",
"channel": "36",
"type": "ds1-e1",
"operation": "enable"
},
"portType": "csopStm1",
"userAnnotation": "string",
"portName": "TDMSFP_P7"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "c5efbaca-8783-3471-8576-3e2145d9b5db"
}
]
}
}
},
"resultsCode": "202"
}

Retrieve the test results

To retrieve the test results, use the Test and diagnostics API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 672
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Sample request

GET {{MCP_SERVER}}/tdc/api/v1/operationalStatus?freId=<FRE_ID>&osTypeString=tdmStatus

Specify the FRE ID of the service the test is running against and “tdmStatus” for the “osTypeString”.

The body is empty.

Sample response

{
"data": {
"id": "6ade74a7-2c47-43f0-b384-b2f382158fb6",
"type": "operationalStatus",
"attributes": {},
"relationships": {
"osData": {
"data": [
{
"type": "tdmStatus",
"id": "-7901343478415674956:1::TDMSTATUS"
},
{
"type": "tdmStatus",
"id": "-7901343478415674956:2::TDMSTATUS"
}
]
},
"fres": {
"data": [
{
"type": "fres",
"id": "-7901343478415674956"
}
]
}
}
},
"included": [
{
"id": "-7901343478415674956:1::TDMSTATUS",
"type": "tdmStatus",
"attributes": {
"mode": "terminal",
"channel": "36",
"type": "ds1-e1",
"enabled": false
},
"relationships": {
"tpes": {
"data": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 673
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"type": "tpes",
"id": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP"
}
}
}
},
{
"id": "-7901343478415674956:2::TDMSTATUS",
"type": "tdmStatus",
"attributes": {
"mode": "terminal",
"channel": "36",
"type": "port",
"enabled": false
},
"relationships": {
"tpes": {
"data": {
"type": "tpes",
"id": "d4b218da-c1e3-3fd8-8f6c-
69e8a465c6c9::TPE_chTdm1_7_36_PTP_E1_CTP"
}
}
}
}
],
"requestIds": "-7901343478415674956",
"resultsCode": "202"
}

Disable the test

To disable the test, use the Test and diagnostics API.

Sample request

POST {{MCP_SERVER}}/tdc/api/v1/tests/tdmOperations

Specify the local TPE ID, operation, mode, type, and channel.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 674
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"type": "tdmLoopback",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"testParameters": {
"operation": "disable",
"mode": "terminal",
"type":"ds1-e1",
"channel":"36"
},
"userAnnotation": "string"
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 675
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"id": "1ae14878-b3e3-48df-b57f-49a6ccb35719",
"type": "testResults",
"attributes": {
"testResults": [],
"testType": "tdmLoopback",
"testStatus": "Started",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"remotePoints": [],
"localNcId": "c5efbaca-8783-3471-8576-3e2145d9b5db",
"remoteNcs": [],
"startTime": 1510768145023,
"lastUpdateTime": 1510768145023,
"testParameters": {
"mode": "terminal",
"channel": "36",
"type": "ds1-e1",
"operation": "disable"
},
"portType": "csopStm1",
"userAnnotation": "string",
"portName": "TDMSFP_P7"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "c5efbaca-8783-3471-8576-3e2145d9b5db"
}
]
}
}
},
"resultsCode": "202"
}

Perform channel level facility loopback on a 6200 2.5G MRO i/f

card and retrieve its results
As a TDM CEM troubleshooting user, you want to be able to set/enable a channel level Facility Loopback
on a 6200 2.5 MRO i/f card endpoint of a selected TDM CEM service or a selected TDM STM-1 port and
channel and also be able to retrieve Loopback configuration details so you can have information to help

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 676
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

diagnose TDM CEM service problems.

This troubleshooting flow includes the following topics:

• Enable the test

• Retrieve the test results
• Disable the test

Enable the test

To set/enable the channel level facility loopback test, use the Test and diagnostics API.

Sample request

POST {{MCP_SERVER}}/tdc/api/v1/tests/tdmOperations

Specify the local TPE ID, operation, mode, type, and channel.

{
"data": {
"type": "tdmLoopback",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"testParameters": {
"operation": "enable",
"mode": "facility",
"type":"ds1-e1",
"channel":"36"
},
"userAnnotation": "string"
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 677
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"id": "866362f6-4d1c-48c8-94c3-23848a99dbb6",
"type": "testResults",
"attributes": {
"testResults": [],
"testType": "tdmLoopback",
"testStatus": "Started",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"remotePoints": [],
"localNcId": "c5efbaca-8783-3471-8576-3e2145d9b5db",
"remoteNcs": [],
"startTime": 1510767830375,
"lastUpdateTime": 1510767830375,
"testParameters": {
"mode": "facility",
"channel": "36",
"type": "ds1-e1",
"operation": "enable"
},
"portType": "csopStm1",
"userAnnotation": "string",
"portName": "TDMSFP_P7"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "c5efbaca-8783-3471-8576-3e2145d9b5db"
}
]
}
}
},
"resultsCode": "202"
}

Retrieve the test results

To retrieve the test results, use the Test and diagnostics API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 678
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Sample request

GET {{MCP_SERVER}}/tdc/api/v1/operationalStatus?freId=<FRE_ID>&osTypeString=tdmStatus

Specify the FRE ID of the service the test is running against and “tdmStatus” for the “osTypeString”.

The body is empty.

Sample response

{
"data": {
"id": "6ade74a7-2c47-43f0-b384-b2f382158fb6",
"type": "operationalStatus",
"attributes": {},
"relationships": {
"osData": {
"data": [
{
"type": "tdmStatus",
"id": "-7901343478415674956:1::TDMSTATUS"
},
{
"type": "tdmStatus",
"id": "-7901343478415674956:2::TDMSTATUS"
}
]
},
"fres": {
"data": [
{
"type": "fres",
"id": "-7901343478415674956"
}
]
}
}
},
"included": [
{
"id": "-7901343478415674956:1::TDMSTATUS",
"type": "tdmStatus",
"attributes": {
"mode": "facility",
"channel": "36",
"type": "ds1-e1",
"enabled": false
},
"relationships": {
"tpes": {
"data": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 679
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"type": "tpes",
"id": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP"
}
}
}
},
{
"id": "-7901343478415674956:2::TDMSTATUS",
"type": "tdmStatus",
"attributes": {
"mode": "terminal",
"channel": "36",
"type": "port",
"enabled": false
},
"relationships": {
"tpes": {
"data": {
"type": "tpes",
"id": "d4b218da-c1e3-3fd8-8f6c-
69e8a465c6c9::TPE_chTdm1_7_36_PTP_E1_CTP"
}
}
}
}
],
"requestIds": "-7901343478415674956",
"resultsCode": "202"
}

Disable the test

To disable the test, use the Test and diagnostics API.

Sample request

POST {{MCP_SERVER}}/tdc/api/v1/tests/tdmOperations

Specify the local TPE ID, operation, mode, type, and channel.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 680
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"type": "tdmLoopback",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"testParameters": {
"operation": "disable",
"mode": "facility",
"type":"ds1-e1",
"channel":"36"
},
"userAnnotation": "string"
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 681
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"id": "0c74c557-7775-4168-910c-43a420dc3520",
"type": "testResults",
"attributes": {
"testResults": [],
"testType": "tdmLoopback",
"testStatus": "Started",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"remotePoints": [],
"localNcId": "c5efbaca-8783-3471-8576-3e2145d9b5db",
"remoteNcs": [],
"startTime": 1510767895278,
"lastUpdateTime": 1510767895278,
"testParameters": {
"mode": "facility",
"channel": "36",
"type": "ds1-e1",
"operation": "disable"
},
"portType": "csopStm1",
"userAnnotation": "string",
"portName": "TDMSFP_P7"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "c5efbaca-8783-3471-8576-3e2145d9b5db"
}
]
}
}
},
"resultsCode": "202"
}

Perform port level terminal loopback on a 6200 2.5G MRO i/f

card and retrieve its results
As a TDM CEM troubleshooting user, you want to be able to set/enable a port level Terminal Loopback on
a 6200 2.5 MRO i/f card endpoint of a selected TDM CEM service or a selected TDM STM-1 port and also
be able to retrieve Loopback configuration details so you can have information to help diagnose TDM

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 682
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

CEM service problems.

This troubleshooting flow includes the following topics:

• Enable the test

• Retrieve the test results
• Disable the test

Enable the test

To set/enable the port level terminal loopback test, use the Test and diagnostics API.

Sample request

POST {{MCP_SERVER}}/tdc/api/v1/tests/tdmOperations

Specify the local TPE ID, operation, mode, and type.

{
"data": {
"type": "tdmLoopback",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"testParameters": {
"operation": "enable",
"mode": "terminal",
"type":"port",
"channel":"36"
},
"userAnnotation": "string"
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 683
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"id": "5fb72c0a-459f-4fce-9f92-c6ba580a419c",
"type": "testResults",
"attributes": {
"testResults": [],
"testType": "tdmLoopback",
"testStatus": "Started",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"remotePoints": [],
"localNcId": "c5efbaca-8783-3471-8576-3e2145d9b5db",
"remoteNcs": [],
"startTime": 1510767979010,
"lastUpdateTime": 1510767979010,
"testParameters": {
"mode": "terminal",
"channel": "36",
"type": "port",
"operation": "enable"
},
"portType": "csopStm1",
"userAnnotation": "string",
"portName": "TDMSFP_P7"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "c5efbaca-8783-3471-8576-3e2145d9b5db"
}
]
}
}
},
"resultsCode": "202"
}

Retrieve the test results

To retrieve the test results, use the Test and diagnostics API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 684
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Sample request

GET {{MCP_SERVER}}/tdc/api/v1/operationalStatus?freId=<FRE_ID>&osTypeString=tdmStatus

Specify the FRE ID of the service the test is running against and “tdmStatus” for the “osTypeString”.

The body is empty.

Sample response

{
"data": {
"id": "6ade74a7-2c47-43f0-b384-b2f382158fb6",
"type": "operationalStatus",
"attributes": {},
"relationships": {
"osData": {
"data": [
{
"type": "tdmStatus",
"id": "-7901343478415674956:1::TDMSTATUS"
},
{
"type": "tdmStatus",
"id": "-7901343478415674956:2::TDMSTATUS"
}
]
},
"fres": {
"data": [
{
"type": "fres",
"id": "-7901343478415674956"
}
]
}
}
},
"included": [
{
"id": "-7901343478415674956:1::TDMSTATUS",
"type": "tdmStatus",
"attributes": {
"mode": "terminal",
"channel": "36",
"type": "ds1-e1",
"enabled": false
},
"relationships": {
"tpes": {
"data": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 685
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"type": "tpes",
"id": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP"
}
}
}
},
{
"id": "-7901343478415674956:2::TDMSTATUS",
"type": "tdmStatus",
"attributes": {
"mode": "terminal",
"channel": "36",
"type": "port",
"enabled": false
},
"relationships": {
"tpes": {
"data": {
"type": "tpes",
"id": "d4b218da-c1e3-3fd8-8f6c-
69e8a465c6c9::TPE_chTdm1_7_36_PTP_E1_CTP"
}
}
}
}
],
"requestIds": "-7901343478415674956",
"resultsCode": "202"
}

Disable the test

To disable the test, use the Test and diagnostics API.

Sample request

POST {{MCP_SERVER}}/tdc/api/v1/tests/tdmOperations

Specify the local TPE ID, operation, mode, and type.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 686
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"type": "tdmLoopback",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"testParameters": {
"operation": "disable",
"mode": "terminal",
"type":"port",
"channel":"36"
},
"userAnnotation": "string"
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 687
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"id": "5fb72c0a-459f-4fce-9f92-c6ba580a419c",
"type": "testResults",
"attributes": {
"testResults": [],
"testType": "tdmLoopback",
"testStatus": "Started",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"remotePoints": [],
"localNcId": "c5efbaca-8783-3471-8576-3e2145d9b5db",
"remoteNcs": [],
"startTime": 1510767979010,
"lastUpdateTime": 1510767979010,
"testParameters": {
"mode": "terminal",
"channel": "36",
"type": "port",
"operation": "disable"
},
"portType": "csopStm1",
"userAnnotation": "string",
"portName": "TDMSFP_P7"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "c5efbaca-8783-3471-8576-3e2145d9b5db"
}
]
}
}
},
"resultsCode": "202"
}

Perform channel level terminal loopback on a 6200 2.5G MRO i/f

card and retrieve its results
As a TDM CEM troubleshooting user, you want to be able to set/enable a channel level Terminal
Loopback on a 6200 2.5 MRO i/f card endpoint of a selected TDM CEM service or a selected TDM STM-1
port and channel and also be able to retrieve Loopback configuration details so you can have information

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 688
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

to help diagnose TDM CEM service problems.

This troubleshooting flow includes the following topics:

• Enable the test

• Retrieve the test results
• Disable the test

Enable the test

To set/enable the channel level terminal loopback test, use the Test and diagnostics API.

Sample request

POST {{MCP_SERVER}}/tdc/api/v1/tests/tdmOperations

Specify the local TPE ID, operation, mode, type, and channel.

{
"data": {
"type": "tdmLoopback",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"testParameters": {
"operation": "enable",
"mode": "terminal",
"type":"ds1-e1",
"channel":"36"
},
"userAnnotation": "string"
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 689
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"id": "1ae14878-b3e3-48df-b57f-49a6ccb35719",
"type": "testResults",
"attributes": {
"testResults": [],
"testType": "tdmLoopback",
"testStatus": "Started",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"remotePoints": [],
"localNcId": "c5efbaca-8783-3471-8576-3e2145d9b5db",
"remoteNcs": [],
"startTime": 1510768145023,
"lastUpdateTime": 1510768145023,
"testParameters": {
"mode": "terminal",
"channel": "36",
"type": "ds1-e1",
"operation": "enable"
},
"portType": "csopStm1",
"userAnnotation": "string",
"portName": "TDMSFP_P7"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "c5efbaca-8783-3471-8576-3e2145d9b5db"
}
]
}
}
},
"resultsCode": "202"
}

Retrieve the test results

To retrieve the test results, use the Test and diagnostics API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 690
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Sample request

GET {{MCP_SERVER}}/tdc/api/v1/operationalStatus?freId=<FRE_ID>&osTypeString=tdmStatus

Specify the FRE ID of the service the test is running against and “tdmStatus” for the “osTypeString”.

The body is empty.

Sample response

{
"data": {
"id": "6ade74a7-2c47-43f0-b384-b2f382158fb6",
"type": "operationalStatus",
"attributes": {},
"relationships": {
"osData": {
"data": [
{
"type": "tdmStatus",
"id": "-7901343478415674956:1::TDMSTATUS"
},
{
"type": "tdmStatus",
"id": "-7901343478415674956:2::TDMSTATUS"
}
]
},
"fres": {
"data": [
{
"type": "fres",
"id": "-7901343478415674956"
}
]
}
}
},
"included": [
{
"id": "-7901343478415674956:1::TDMSTATUS",
"type": "tdmStatus",
"attributes": {
"mode": "terminal",
"channel": "36",
"type": "ds1-e1",
"enabled": false
},
"relationships": {
"tpes": {
"data": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 691
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"type": "tpes",
"id": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP"
}
}
}
},
{
"id": "-7901343478415674956:2::TDMSTATUS",
"type": "tdmStatus",
"attributes": {
"mode": "terminal",
"channel": "36",
"type": "port",
"enabled": false
},
"relationships": {
"tpes": {
"data": {
"type": "tpes",
"id": "d4b218da-c1e3-3fd8-8f6c-
69e8a465c6c9::TPE_chTdm1_7_36_PTP_E1_CTP"
}
}
}
}
],
"requestIds": "-7901343478415674956",
"resultsCode": "202"
}

Disable the test

To disable the test, use the Test and diagnostics API.

Sample request

POST {{MCP_SERVER}}/tdc/api/v1/tests/tdmOperations

Specify the local TPE ID, operation, mode, type, and channel.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 692
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"type": "tdmLoopback",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"testParameters": {
"operation": "disable",
"mode": "terminal",
"type":"ds1-e1",
"channel":"36"
},
"userAnnotation": "string"
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 693
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"id": "1ae14878-b3e3-48df-b57f-49a6ccb35719",
"type": "testResults",
"attributes": {
"testResults": [],
"testType": "tdmLoopback",
"testStatus": "Started",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"remotePoints": [],
"localNcId": "c5efbaca-8783-3471-8576-3e2145d9b5db",
"remoteNcs": [],
"startTime": 1510768145023,
"lastUpdateTime": 1510768145023,
"testParameters": {
"mode": "terminal",
"channel": "36",
"type": "ds1-e1",
"operation": "disable"
},
"portType": "csopStm1",
"userAnnotation": "string",
"portName": "TDMSFP_P7"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "c5efbaca-8783-3471-8576-3e2145d9b5db"
}
]
}
}
},
"resultsCode": "202"
}

Perform terminal loopback on a 6200 - 63xDS1/E1 i/f card and

retrieve its results
As a TDM CEM troubleshooting user, you want to be able to set/enable a Terminal Loopback on a 6200
63xDS1/E1 i/f card endpoint of a selected TDM CEM service or a selected TDM E1 port and also be able
to retrieve Loopback configuration details so you can have information to help diagnose TDM CEM

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 694
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

service problems.

This troubleshooting flow includes the following topics:

• Enable the test

• Retrieve the test results
• Disable the test

Enable the test

To set/enable the terminal loopback test, use the Test and diagnostics API.

Sample request

POST {{MCP_SERVER}}/tdc/api/v1/tests/tdmOperations

Specify the local TPE ID, operation, mode, and type.

{
"data": {
"type": "tdmLoopback",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"testParameters": {
"operation": "enable",
"mode": "terminal",
"type":"port",
"channel":"36"
},
"userAnnotation": "string"
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 695
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"id": "5fb72c0a-459f-4fce-9f92-c6ba580a419c",
"type": "testResults",
"attributes": {
"testResults": [],
"testType": "tdmLoopback",
"testStatus": "Started",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"remotePoints": [],
"localNcId": "c5efbaca-8783-3471-8576-3e2145d9b5db",
"remoteNcs": [],
"startTime": 1510767979010,
"lastUpdateTime": 1510767979010,
"testParameters": {
"mode": "terminal",
"channel": "36",
"type": "port",
"operation": "enable"
},
"portType": "csopStm1",
"userAnnotation": "string",
"portName": "TDMSFP_P7"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "c5efbaca-8783-3471-8576-3e2145d9b5db"
}
]
}
}
},
"resultsCode": "202"
}

Retrieve the test results

To retrieve the test results, use the Test and diagnostics API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 696
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Sample request

GET {{MCP_SERVER}}/tdc/api/v1/operationalStatus?freId=<FRE_ID>&osTypeString=tdmStatus

Specify the FRE ID of the service the test is running against and “tdmStatus” for the “osTypeString”.

The body is empty.

Sample response

{
"data": {
"id": "6ade74a7-2c47-43f0-b384-b2f382158fb6",
"type": "operationalStatus",
"attributes": {},
"relationships": {
"osData": {
"data": [
{
"type": "tdmStatus",
"id": "-7901343478415674956:1::TDMSTATUS"
},
{
"type": "tdmStatus",
"id": "-7901343478415674956:2::TDMSTATUS"
}
]
},
"fres": {
"data": [
{
"type": "fres",
"id": "-7901343478415674956"
}
]
}
}
},
"included": [
{
"id": "-7901343478415674956:1::TDMSTATUS",
"type": "tdmStatus",
"attributes": {
"mode": "terminal",
"channel": "36",
"type": "ds1-e1",
"enabled": false
},
"relationships": {
"tpes": {
"data": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 697
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"type": "tpes",
"id": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP"
}
}
}
},
{
"id": "-7901343478415674956:2::TDMSTATUS",
"type": "tdmStatus",
"attributes": {
"mode": "terminal",
"channel": "36",
"type": "port",
"enabled": false
},
"relationships": {
"tpes": {
"data": {
"type": "tpes",
"id": "d4b218da-c1e3-3fd8-8f6c-
69e8a465c6c9::TPE_chTdm1_7_36_PTP_E1_CTP"
}
}
}
}
],
"requestIds": "-7901343478415674956",
"resultsCode": "202"
}

Disable the test

To disable the test, use the Test and diagnostics API.

Sample request

POST {{MCP_SERVER}}/tdc/api/v1/tests/tdmOperations

Specify the local TPE ID, operation, mode, and type.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 698
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"type": "tdmLoopback",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"testParameters": {
"operation": "disable",
"mode": "terminal",
"type":"port",
"channel":"36"
},
"userAnnotation": "string"
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 699
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"id": "5fb72c0a-459f-4fce-9f92-c6ba580a419c",
"type": "testResults",
"attributes": {
"testResults": [],
"testType": "tdmLoopback",
"testStatus": "Started",
"localTpeId": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP",
"remotePoints": [],
"localNcId": "c5efbaca-8783-3471-8576-3e2145d9b5db",
"remoteNcs": [],
"startTime": 1510767979010,
"lastUpdateTime": 1510767979010,
"testParameters": {
"mode": "terminal",
"channel": "36",
"type": "port",
"operation": "disable"
},
"portType": "csopStm1",
"userAnnotation": "string",
"portName": "TDMSFP_P7"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "c5efbaca-8783-3471-8576-
3e2145d9b5db::TPE_chTdm1_7_36_PTP_E1_CTP"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "c5efbaca-8783-3471-8576-3e2145d9b5db"
}
]
}
}
},
"resultsCode": "202"
}

Perform RFC2544 tests (latency, frame loss, throughput) retrieve

results cancel
This section includes the following topics:

• Perform an RFC2544 test

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 700
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

• Retrieve the RFC2544 test results

• Cancel the RFC2544 test

Note: You can also use this API call for an RFC2544 test between two E-LAN services endpoints.

Perform an RFC2544 test

To perform an RFC2544 test, use the Test and diagnostics API.

Sample request

POST {{MCP_SERVER}}/tdc/api/v1/tests/benchmarkOperations

Note: For an E-Tree service, you can only run a test from root-to-leaf or leaf-to-root. You cannot run a test
from leaf-to-leaf or root-to-root.

Specify one or more of the following tests, as required: latency, frame loss, or throughput. Also specify the
required test parameters.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 701
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data" : {
"type" : "benchmark",
"generatorId" : "46682de1-0871-3f17-9a4c-
34a02cf97074::TPE_5_1_CTPServerToClient_SUBPORT_5_1_tdc8xTest_1",
"testParameters" : {
"kpiProfile" : "test",
"reflectorType": "UNI",
"tests": [
"latency",
"frameloss",
"throughput"
],
"testMode": "in-service",
"interval": "completion",
"duration": "15min",
"maxSamples": 3,
"maxSearches": 3,
"frameSizes": [
"64",
"256"
],
"pduType": "ip",
"pcp": [ "0", "1", "2", "6", "7" ],
"tagProtocolIdentifier": "0x8100",
"customPayload": "custompayloadasdasdasdasdasd",
"ipDifferentiatedServiceCodePoint": "22",
"pcpValidation": "on",
"excessBandwidth": "50",
"samplingInterval": 3,
"framelossStartBandwidth": "profile-bandwidth",
"vidValidation": "on",
"vlanEncapType": "dot1q",
"testConnectivity": true,
"colourValidation": "on",
"reflectorId" : "1dc5fc42-4d80-360c-8621-
3244fb221cfa::TPE_2_1_CTPServerToClient_SUBPORT_2_1_tdc8xTest_1"
}
}
}

Sample response (immediately after starting the test)

Note: In the Sample response, the …, stands for the list of all test parameters that were used to run the
test.

{
"data": {
"id": "208cc81d-8e7b-4789-b67d-0c1c5ef00af6",
"type": "testResults",
"attributes": {
"testResults": [],
"testType": "benchmark",
"testStatus": "Started",
"localTpeId": "46682de1-0871-3f17-9a4c-

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 702
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

34a02cf97074::TPE_5_1_CTPServerToClient_SUBPORT_5_1_tdc8xTest_1",
"remotePoints": [
"1dc5fc42-4d80-360c-8621-
3244fb221cfa::TPE_2_1_CTPServerToClient_SUBPORT_2_1_tdc8xTest_1"
],
"localNcId": "46682de1-0871-3f17-9a4c-34a02cf97074",
"remoteNcs": [
"1dc5fc42-4d80-360c-8621-3244fb221cfa"
],
"startTime": 1519659865987,
"lastUpdateTime": 1519659865987,
"testParameters": {

...,

},
"generatorSlot": "5",
"reflectorSubPort": "2_1_tdc8xTest_1",
"birthCertificate": "false",
"generatorPort": "1",
"reflectorPort": "1",
"reflectorSlot": "2",
"generatorCvid": "2001",
"serviceName": "tdc8xTest",
"startTestRequest": "{\n \"data\" : {\n \"type\" : \"benchmark\",\n
\"generatorId\" : \"46682de1-0871-3f17-9a4c-
34a02cf97074::TPE_5_1_CTPServerToClient_SUBPORT_5_1_tdc8xTest_1\",\n
\"testParameters\" : {\n \"kpiProfile\" : \"test\",\n \"maxSearches\" :
3,\n \"vlanEncapType\" : \"dot1q\",\n \"maxSamples\" : 3,\n
\"colourValidation\" : \"on\",\n \"reflectorId\" : \"1dc5fc42-4d80-360c-8621-
3244fb221cfa::TPE_2_1_CTPServerToClient_SUBPORT_2_1_tdc8xTest_1\",\n
\"pduType\" : \"ip\",\n \"duration\" : \"15min\",\n
\"ipDifferentiatedServiceCodePoint\" : \"22\",\n \"samplingInterval\" : 3,\n
\"testConnectivity\" : true,\n \"reflectorType\" : \"UNI\",\n \"tests\" :
[ \"latency\", \"frameloss\", \"throughput\" ],\n \"tagProtocolIdentifier\" :
\"0x8100\",\n \"framelossStartBandwidth\" : \"profile-bandwidth\",\n
\"excessBandwidth\" : \"50\",\n \"testMode\" : \"in-service\",\n
\"frameSizes\" : [ \"64\", \"256\" ],\n \"interval\" : \"completion\",\n
\"vidValidation\" : \"on\",\n \"pcpValidation\" : \"on\",\n \"pcp\" : [
\"0\", \"1\", \"2\", \"6\", \"7\" ],\n \"customPayload\" :
\"custompayloadasdasdasdasdasd\"\n }\n }\n}",
"generatorSubPort": "5_1_tdc8xTest_1",
"reflectorCvid": "2001"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "1dc5fc42-4d80-360c-8621-
3244fb221cfa::TPE_2_1_CTPServerToClient_SUBPORT_2_1_tdc8xTest_1"
},
{
"type": "tpes",
"id": "46682de1-0871-3f17-9a4c-
34a02cf97074::TPE_5_1_CTPServerToClient_SUBPORT_5_1_tdc8xTest_1"
}
]
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 703
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "46682de1-0871-3f17-9a4c-34a02cf97074"
},
{
"type": "networkConstructs",
"id": "1dc5fc42-4d80-360c-8621-3244fb221cfa"
}
]
}
}
},
"resultsCode": "202"
}

Retrieve the RFC2544 test results

To retrieve the RFC2544 test results, use the Test and diagnostics API.

Sample request — Retrieve

GET {{MCP_SERVER}}/tdc/api/v1/tests/<testId>

Specify the testId, which is the “id” (for example, 208cc81d-8e7b-4789-b67d-0c1c5ef00af6) of the
response (when you Perform an RFC2544 test).

https://<mcp_server>/tdc/api/tests/208cc81d-8e7b-4789-b67d-0c1c5ef00af6

Sample response — Retrieve

Note: In the Sample response, the …, stands for the same information as in the initial test response.

{
"data": {
"id": "208cc81d-8e7b-4789-b67d-0c1c5ef00af6",
"type": "testResults",
"attributes": {
"testResults": [
{
"operationalStatus": "success",
"dataType": "summary"
},
{
"dataType": "rawData",
"rawData": <output as seen from the device>
},
{
"dataType": "latencySummary",
"status": "idle"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 704
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

},
{
"frameSizeUnit": "bytes",
"average": "22",
"samplePackets": "202002",
"colour": "green",
"unit": "usec",
"frameSize": "64",
"min": "18",
"max": "47",
"dataType": "latencyResult",
"pcp": "0"
},
<all other latency result rows from the test>,
{
"dataType": "throughputSummary",
"status": "waitingForPackets"
},
{
"frameSizeUnit": "bytes",
"average": "114.29",
"colour": "green",
"unit": "Mbps",
"frameSize": "64",
"min": "114.29",
"max": "114.29",
"dataType": "throughputResult",
"iteration": "2",
"pcp": "0"
},
<all other throughput result rows from the test> ,
{
"dataType": "framelossSummary",
"status": "idle"
},
{
"frameSizeUnit": "bytes",
"unit": "%",
"frameSize": "64",
"firstCycle": "20.34",
"bandwidth": "200",
"rate": "100",
"dataType": "framelossResult",
"secondCycle": "",
"pcp": "0",
"bandwidthUnit": "Mbps"
},
<all other frame loss test result rows form the test>
],
"testType": "benchmark",
"testStatus": "In progress",
"localTpeId": "46682de1-0871-3f17-9a4c-
34a02cf97074::TPE_5_1_CTPServerToClient_SUBPORT_5_1_tdc8xTest_1",
"remotePoints": [
"1dc5fc42-4d80-360c-8621-
3244fb221cfa::TPE_2_1_CTPServerToClient_SUBPORT_2_1_tdc8xTest_1"
],
"localNcId": "46682de1-0871-3f17-9a4c-34a02cf97074",
"remoteNcs": [

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 705
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"1dc5fc42-4d80-360c-8621-3244fb221cfa"
],

...,

"resultsCode": 200,
"requestIds": "208cc81d-8e7b-4789-b67d-0c1c5ef00af6"
}

Sample error response

Note: In the Sample error response, the …, stands for the same fields as in a non-error response.

{
"data": {
"id": "acc678ca-5c80-44c8-8744-d25280b3055d",
"type": "testResults",
"attributes": {
"testResults": [
{
"operationalStatus": "failure",
"errorMessage": "Port under test does not have enough bandwidth to start
the selected test instances; Failed start test due to errorCode[Internal Server
Error] details[INTERNAL_SERVER_FAILURE : Test failed to start]",
"dataType": "summary"
},
{
"dataType": "rawData",
"rawData": "ERROR: Port under test does not have enough bandwidth to
start the selected test instances"
}
],
"testType": "benchmark",
"testStatus": "Failed",
"localTpeId": "1dc5fc42-4d80-360c-8621-
3244fb221cfa::TPE_2_16_CTPServerToClient_SUBPORT_1_2_16_tdc8xTest_1",
"remotePoints": [
"46682de1-0871-3f17-9a4c-
34a02cf97074::TPE_6_17_CTPServerToClient_SUBPORT_1_6_17_tdc8xTest_1"
],

...,

,
"resultsCode": 200,
"requestIds": "acc678ca-5c80-44c8-8744-d25280b3055d"
}

Cancel the RFC2544 test

To cancel an RFC2544 test, use the Test and diagnostics API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 706
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

DELETE {{MCP_SERVER}}/tdc/api/v1/tests/<testId>/cancel

Specify the testId, which is the “id” (for example, 208cc81d-8e7b-4789-b67d-0c1c5ef00af6) of the
response (when you Perform an RFC2544 test).

https://<mcp_server>/tdc/api/v1/tests/208cc81d-8e7b-4789-b67d-0c1c5ef00af6/cancel

Sample response — Cancel a test

Note: In the Sample response, the first instance of …, stands for the results of the benchmark test. The
second instance of …, stands for the same fields as a completed benchmark test.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 707
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"id": "26ceea87-4596-4f7f-80bc-bdc80dc0a602",
"type": "testResults",
"attributes": {
"testResults": [
{
"operationalStatus": "success",
"dataType": "summary"
},
{
"dataType": "rawData",
"rawData": "<device output is here>"
},
{
"dataType": "latencySummary",
"status": "idle"
},
{
"frameSizeUnit": "bytes",
"average": "",
"samplePackets": "0",
"colour": "green",
"unit": "usec",
"frameSize": "256",
"min": "",
"max": "",
"dataType": "latencyResult",
"pcp": "0"
},

...,

],
"testType": "benchmark",
"testStatus": "Cancelling",
"localTpeId": "46682de1-0871-3f17-9a4c-
34a02cf97074::TPE_5_1_CTPServerToClient_SUBPORT_5_1_tdc8xTest_1",
"remotePoints": [
"1dc5fc42-4d80-360c-8621-
3244fb221cfa::TPE_2_1_CTPServerToClient_SUBPORT_2_1_tdc8xTest_1"
],
"localNcId": "46682de1-0871-3f17-9a4c-34a02cf97074",
"remoteNcs": [
"1dc5fc42-4d80-360c-8621-3244fb221cfa"
],
"startTime": 1519659693367,
"lastUpdateTime": 1519659748660,

...,

},
"resultsCode": 200,
"requestIds": "26ceea87-4596-4f7f-80bc-bdc80dc0a602"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 708
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

API calls for managing packet infrastructure

MCP supports tunnel discovery, visualization, provisioning, and troubleshooting on the following Ciena
devices:

• 8700 nodes: SAOS 8.4 or higher

Note: MCP Release 18.02 adds static and dynamic tunnel support for 8700 nodes equipped with the
8700HD card and running SAOS 8.6+.

• 5170 nodes running SAOS 8.6.1 (for static tunnels only)

• SAOS 6.x devices with MPLS support: 6.16 or higher

Note: MCP Release 18.02 adds static tunnel support for 3926 and 3928 nodes running SAOS 6.17+.

• 6200 nodes: release 2.0 or 2.1

• 6500 nodes equipped with packet fabric card: release 12.1

This section describes the API calls used retrieve, provision, and manage packet infrastructure including
stand and dynamic MPLS tunnels, LSPs, and pseudowires:

• Retrieve discovered / planned static MPLS-TP LSP tunnels (protected and unprotected)
• Retrieve all discovered / planned MPLS-TP LSP tunnels
• Retrieve the set of discovered / planned L2 services that traverse a specific LSP tunnel
• Refreshing properties for links and tunnels
• Retrieve IP links
• LAG show
• Perform static MPLS commissioning
• Create a static MPLS-TP tunnel
• Delete a static MPLS-TP LSP tunnel (protected and unprotected) by provisioning intent
• Retrieve a dynamic MPLS-TP tunnel
• Create a dynamic MPLS-TP tunnel
• Modify a dynamic MPLS co-routed tunnel
• Delete a dynamic MPLS-TP tunnel
• Unidirectional tunnels
• Retrieve an inventory of unidirectional TE tunnel
• Create a unidirectional FRR tunnel
• Manage a unidirectional tunnel
• Retrieve / view LLDP link bandwidth properties
• Edit link bandwidth properties

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 709
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

• Modify static MPLS-TP co-routed LSP tunnels

• Add a backup tunnel to an MPLS-TP co-routed tunnel
• Modify MPLS-TP LSP tunnel bandwidth call admission control (CAC)
• Promote discovered LSP tunnels / EVCs to modify or delete - Manual
• Perform tunnel group protection switch
• Perform LSP protection switch on link
• Perform LSP protection restore on link
• Perform LSP correction on node insertion
• Perform LSP correction on node deletion
• Retrieve the latest information about an MPLS tunnel
• Perform LSP resize for a dynamic MPLS tunnel
• Managing Fast Rerouting (FRR) profiles

Retrieve discovered / planned static MPLS-TP LSP tunnels

(protected and unprotected)
To retrieve and view the inventory of static MPLS-TP LSP tunnels, use the Services Inventory (FREs) API.

Sample request

{{MCP_SERVER}}/nsi/api/fres

Specify the type as link and the layer rate as MPLS_PROTECTION. (For unprotected, specify the layer rate
as MPLS.)

Sample response

Note: To locate each primary and backup tunnel, look for “partitionFres” in the response.

{
"links": {},
"data": [
{
"id": "-4821002836492640520",
"type": "fres",
"attributes": {
"userLabel": "I_ConPr6",
"layerRate": "MPLS_PROTECTION",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 710
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"additionalAttributes": {
"isActual": "false"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "-4821002836492640520:1"
},
{
"type": "endPoints",
"id": "-4821002836492640520:2"
}
]
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "09948e01-25b9-3366-9bb1-ecef1afd344b::FRE_MPLS-
PROTECTION_ConPr6_headEnd"
},
{
"type": "fres",
"id": "3269857543184725293"
},
{
"type": "fres",
"id": "efc2f602-f8a5-3287-a357-c0a2ab4b1119::FRE_MPLS-
PROTECTION_ConPr6_headEnd"
}
]
},
"freExpectations": {
"data": [
{
"type": "freExpectations",
"id": "-4821002836492640520::58b8c556-ef0d-46e0-aa5a-b73845d097de"
}
]
}
}
},
{
"id": "-765751368598326882",
"type": "fres",
"attributes": {
"userLabel": "{{I_TUNNEL_NAME}}",
"layerRate": "MPLS_PROTECTION",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"additionalAttributes": {
"isActual": "false"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 711
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "-765751368598326882:1"
},
{
"type": "endPoints",
"id": "-765751368598326882:2"
}
]
},
"decomposedFres": {
"data": [
{
"type": "fres",
"id": "3976594783991191338"
},
{
"type": "fres",
"id": "8885498097352337343"
}
]
},
"freExpectations": {
"data": [
{
"type": "freExpectations",
"id": "-765751368598326882::58b8c472-1109-4521-bd15-391de06d4d46"
}
]
}
}
},
{
"id": "-8200747149170661928",
"type": "fres",
"attributes": {
"userLabel": "I_ConPr5",
"layerRate": "MPLS_PROTECTION",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"additionalAttributes": {
"isActual": "false"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "-8200747149170661928:1"
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 712
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"type": "endPoints",
"id": "-8200747149170661928:2"
}
]
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "09948e01-25b9-3366-9bb1-ecef1afd344b::FRE_MPLS-
PROTECTION_ConPr5_headEnd"
},
{
"type": "fres",
"id": "3329084730944217730"
},
{
"type": "fres",
"id": "efc2f602-f8a5-3287-a357-c0a2ab4b1119::FRE_MPLS-
PROTECTION_ConPr5_headEnd"
}
]
},
"freExpectations": {
"data": [
{
"type": "freExpectations",
"id": "-8200747149170661928::58b8c51c-0916-4389-bcbe-a23e1646a899"
}
]
}
}
},
{
"id": "1260418069308107397",
"type": "fres",
"attributes": {
"userLabel": "I_ConPr7",
"layerRate": "MPLS_PROTECTION",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"additionalAttributes": {
"isActual": "false"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "1260418069308107397:1"
},
{
"type": "endPoints",
"id": "1260418069308107397:2"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 713
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

]
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "09948e01-25b9-3366-9bb1-ecef1afd344b::FRE_MPLS-
PROTECTION_ConPr7_headEnd"
},
{
"type": "fres",
"id": "-929227714982548042"
},
{
"type": "fres",
"id": "bb9eaed8-98f1-39e3-9de2-7845762ef4b4::FRE_MPLS-
PROTECTION_ConPr7_tailEnd"
}
]
},
"freExpectations": {
"data": [
{
"type": "freExpectations",
"id": "1260418069308107397::58b8c655-c8e3-4821-a312-69b621ff0bb0"
}
]
}
}
},
{
"id": "2048873746030648184",
"type": "fres",
"attributes": {
"userLabel": "I_ConPr6",
"layerRate": "MPLS_PROTECTION",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"additionalAttributes": {
"isActual": "false"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "2048873746030648184:1"
},
{
"type": "endPoints",
"id": "2048873746030648184:2"
}
]
},
"partitionFres": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 714
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"data": [
{
"type": "fres",
"id": "09948e01-25b9-3366-9bb1-ecef1afd344b::FRE_MPLS-
PROTECTION_ConPr6_headEnd"
},
{
"type": "fres",
"id": "4883138164493328492"
},
{
"type": "fres",
"id": "efc2f602-f8a5-3287-a357-c0a2ab4b1119::FRE_MPLS-
PROTECTION_ConPr6_headEnd"
}
]
},
"freExpectations": {
"data": [
{
"type": "freExpectations",
"id": "2048873746030648184::58b8c556-ef0d-46e0-aa5a-b73845d097de"
}
]
}
}
},
{
"id": "3976594783991191338",
"type": "fres",
"attributes": {
"userLabel": "{{I_TUNNEL_NAME}}",
"layerRate": "MPLS_PROTECTION",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"additionalAttributes": {
"isActual": "false"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "3976594783991191338:1"
},
{
"type": "endPoints",
"id": "3976594783991191338:2"
}
]
},
"partitionFres": {
"data": [
{
"type": "fres",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 715
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"id": "09948e01-25b9-3366-9bb1-ecef1afd344b::FRE_MPLS-
PROTECTION_ConPr4_headEnd"
},
{
"type": "fres",
"id": "-7383227529204334810"
},
{
"type": "fres",
"id": "efc2f602-f8a5-3287-a357-c0a2ab4b1119::FRE_MPLS-
PROTECTION_ConPr4_headEnd"
}
]
},
"freExpectations": {
"data": [
{
"type": "freExpectations",
"id": "3976594783991191338::58b8c472-1109-4521-bd15-391de06d4d46"
}
]
}
}
},
{
"id": "5830726521198591188",
"type": "fres",
"attributes": {
"userLabel": "I_ConPr7",
"layerRate": "MPLS_PROTECTION",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"additionalAttributes": {
"isActual": "false"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "5830726521198591188:1"
},
{
"type": "endPoints",
"id": "5830726521198591188:2"
}
]
},
"decomposedFres": {
"data": [
{
"type": "fres",
"id": "1260418069308107397"
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 716
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"type": "fres",
"id": "7093209962898911937"
}
]
},
"freExpectations": {
"data": [
{
"type": "freExpectations",
"id": "5830726521198591188::58b8c655-c8e3-4821-a312-69b621ff0bb0"
}
]
}
}
},
{
"id": "6332861249949002341",
"type": "fres",
"attributes": {
"userLabel": "I_ConPr5",
"layerRate": "MPLS_PROTECTION",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"additionalAttributes": {
"isActual": "false"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "6332861249949002341:1"
},
{
"type": "endPoints",
"id": "6332861249949002341:2"
}
]
},
"decomposedFres": {
"data": [
{
"type": "fres",
"id": "7757991393500060713"
},
{
"type": "fres",
"id": "-8200747149170661928"
}
]
},
"freExpectations": {
"data": [
{
"type": "freExpectations",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 717
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"id": "6332861249949002341::58b8c51c-0916-4389-bcbe-a23e1646a899"
}
]
}
}
},
{
"id": "7093209962898911937",
"type": "fres",
"attributes": {
"userLabel": "I_ConPr7",
"layerRate": "MPLS_PROTECTION",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"additionalAttributes": {
"isActual": "false"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "7093209962898911937:1"
},
{
"type": "endPoints",
"id": "7093209962898911937:2"
}
]
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "09948e01-25b9-3366-9bb1-ecef1afd344b::FRE_MPLS-
PROTECTION_ConPr7_headEnd"
},
{
"type": "fres",
"id": "-5446095221080533054"
},
{
"type": "fres",
"id": "bb9eaed8-98f1-39e3-9de2-7845762ef4b4::FRE_MPLS-
PROTECTION_ConPr7_tailEnd"
}
]
},
"freExpectations": {
"data": [
{
"type": "freExpectations",
"id": "7093209962898911937::58b8c655-c8e3-4821-a312-69b621ff0bb0"
}
]

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 718
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

}
}
},
{
"id": "7757991393500060713",
"type": "fres",
"attributes": {
"userLabel": "I_ConPr5",
"layerRate": "MPLS_PROTECTION",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"additionalAttributes": {
"isActual": "false"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "7757991393500060713:1"
},
{
"type": "endPoints",
"id": "7757991393500060713:2"
}
]
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "09948e01-25b9-3366-9bb1-ecef1afd344b::FRE_MPLS-
PROTECTION_ConPr5_headEnd"
},
{
"type": "fres",
"id": "4886637522206158761"
},
{
"type": "fres",
"id": "efc2f602-f8a5-3287-a357-c0a2ab4b1119::FRE_MPLS-
PROTECTION_ConPr5_headEnd"
}
]
},
"freExpectations": {
"data": [
{
"type": "freExpectations",
"id": "7757991393500060713::58b8c51c-0916-4389-bcbe-a23e1646a899"
}
]
}
}
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 719
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "8885498097352337343",
"type": "fres",
"attributes": {
"userLabel": "{{I_TUNNEL_NAME}}",
"layerRate": "MPLS_PROTECTION",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"additionalAttributes": {
"isActual": "false"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "8885498097352337343:1"
},
{
"type": "endPoints",
"id": "8885498097352337343:2"
}
]
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "09948e01-25b9-3366-9bb1-ecef1afd344b::FRE_MPLS-
PROTECTION_ConPr4_headEnd"
},
{
"type": "fres",
"id": "3299469387451167834"
},
{
"type": "fres",
"id": "efc2f602-f8a5-3287-a357-c0a2ab4b1119::FRE_MPLS-
PROTECTION_ConPr4_headEnd"
}
]
},
"freExpectations": {
"data": [
{
"type": "freExpectations",
"id": "8885498097352337343::58b8c472-1109-4521-bd15-391de06d4d46"
}
]
}
}
},
{
"id": "9061927206982571728",
"type": "fres",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 720
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"attributes": {
"userLabel": "I_ConPr6",
"layerRate": "MPLS_PROTECTION",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"additionalAttributes": {
"isActual": "false"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "9061927206982571728:1"
},
{
"type": "endPoints",
"id": "9061927206982571728:2"
}
]
},
"decomposedFres": {
"data": [
{
"type": "fres",
"id": "-4821002836492640520"
},
{
"type": "fres",
"id": "2048873746030648184"
}
]
},
"freExpectations": {
"data": [
{
"type": "freExpectations",
"id": "9061927206982571728::58b8c556-ef0d-46e0-aa5a-b73845d097de"
}
]
}
}
}
],
"included": [
{
"id": "-4821002836492640520:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 721
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"type": "tpes",
"id": "09948e01-25b9-3366-9bb1-ecef1afd344b::TPE_FTP_MPLS-
PROTECTION_ConPr6_headEnd"
}
]
}
}
},
{
"id": "-4821002836492640520:2",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "efc2f602-f8a5-3287-a357-c0a2ab4b1119::TPE_FTP_MPLS-
PROTECTION_ConPr6_headEnd"
}
]
}
}
},
{
"id": "-765751368598326882:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "09948e01-25b9-3366-9bb1-ecef1afd344b::TPE_FTP_MPLS-
PROTECTION_ConPr4_headEnd"
}
]
}
}
},
{
"id": "-765751368598326882:2",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 722
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"id": "efc2f602-f8a5-3287-a357-c0a2ab4b1119::TPE_FTP_MPLS-
PROTECTION_ConPr4_headEnd"
}
]
}
}
},
{
"id": "-8200747149170661928:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "09948e01-25b9-3366-9bb1-ecef1afd344b::TPE_FTP_MPLS-
PROTECTION_ConPr5_headEnd"
}
]
}
}
},
{
"id": "-8200747149170661928:2",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "efc2f602-f8a5-3287-a357-c0a2ab4b1119::TPE_FTP_MPLS-
PROTECTION_ConPr5_headEnd"
}
]
}
}
},
{
"id": "1260418069308107397:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "09948e01-25b9-3366-9bb1-ecef1afd344b::TPE_FTP_MPLS-
PROTECTION_ConPr7_headEnd"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 723
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

}
]
}
}
},
{
"id": "1260418069308107397:2",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "bb9eaed8-98f1-39e3-9de2-7845762ef4b4::TPE_FTP_MPLS-
PROTECTION_ConPr7_tailEnd"
}
]
}
}
},
{
"id": "2048873746030648184:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "09948e01-25b9-3366-9bb1-ecef1afd344b::TPE_FTP_MPLS-
PROTECTION_ConPr6_headEnd"
}
]
}
}
},
{
"id": "2048873746030648184:2",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "efc2f602-f8a5-3287-a357-c0a2ab4b1119::TPE_FTP_MPLS-
PROTECTION_ConPr6_headEnd"
}
]

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 724
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

}
}
},
{
"id": "3976594783991191338:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "09948e01-25b9-3366-9bb1-ecef1afd344b::TPE_FTP_MPLS-
PROTECTION_ConPr4_headEnd"
}
]
}
}
},
{
"id": "3976594783991191338:2",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "efc2f602-f8a5-3287-a357-c0a2ab4b1119::TPE_FTP_MPLS-
PROTECTION_ConPr4_headEnd"
}
]
}
}
},
{
"id": "5830726521198591188:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "09948e01-25b9-3366-9bb1-ecef1afd344b::TPE_FTP_MPLS-
PROTECTION_ConPr7_headEnd"
}
]
}
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 725
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

},
{
"id": "5830726521198591188:2",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "bb9eaed8-98f1-39e3-9de2-7845762ef4b4::TPE_FTP_MPLS-
PROTECTION_ConPr7_tailEnd"
}
]
}
}
},
{
"id": "6332861249949002341:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "09948e01-25b9-3366-9bb1-ecef1afd344b::TPE_FTP_MPLS-
PROTECTION_ConPr5_headEnd"
}
]
}
}
},
{
"id": "6332861249949002341:2",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "efc2f602-f8a5-3287-a357-c0a2ab4b1119::TPE_FTP_MPLS-
PROTECTION_ConPr5_headEnd"
}
]
}
}
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 726
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"id": "7093209962898911937:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "09948e01-25b9-3366-9bb1-ecef1afd344b::TPE_FTP_MPLS-
PROTECTION_ConPr7_headEnd"
}
]
}
}
},
{
"id": "7093209962898911937:2",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "bb9eaed8-98f1-39e3-9de2-7845762ef4b4::TPE_FTP_MPLS-
PROTECTION_ConPr7_tailEnd"
}
]
}
}
},
{
"id": "7757991393500060713:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "09948e01-25b9-3366-9bb1-ecef1afd344b::TPE_FTP_MPLS-
PROTECTION_ConPr5_headEnd"
}
]
}
}
},
{
"id": "7757991393500060713:2",
"type": "endPoints",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 727
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "efc2f602-f8a5-3287-a357-c0a2ab4b1119::TPE_FTP_MPLS-
PROTECTION_ConPr5_headEnd"
}
]
}
}
},
{
"id": "8885498097352337343:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "09948e01-25b9-3366-9bb1-ecef1afd344b::TPE_FTP_MPLS-
PROTECTION_ConPr4_headEnd"
}
]
}
}
},
{
"id": "8885498097352337343:2",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "efc2f602-f8a5-3287-a357-c0a2ab4b1119::TPE_FTP_MPLS-
PROTECTION_ConPr4_headEnd"
}
]
}
}
},
{
"id": "9061927206982571728:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 728
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "09948e01-25b9-3366-9bb1-ecef1afd344b::TPE_FTP_MPLS-
PROTECTION_ConPr6_headEnd"
}
]
}
}
},
{
"id": "9061927206982571728:2",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "efc2f602-f8a5-3287-a357-c0a2ab4b1119::TPE_FTP_MPLS-
PROTECTION_ConPr6_headEnd"
}
]
}
}
}
]
}

Retrieve the set of discovered / planned L2 services that traverse

a specific LSP tunnel
This section provides examples of retrieving a set of L2 services that traverse a specific LSP tunnel,
including

• Retrieve tunnels associated with a specific LLDP link

• Retrieve all the services with layer rate ETHERNET associated with a specific LLDP link
• Retrieve all parent FREs of a given child FRE for specific layer rate and signal content type

Retrieve tunnels associated with a specific LLDP link

To retrieve the tunnels associated with a specific LLDP link, use the Services Inventory (FREs) API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 729
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Sample request

GET {{MCP_SERVER}}/nsi/api/fres

Specify the childFreId and signalContentType.

https://<mcp_server>/nsi/api/fres?childFreId=-1996657695693970062&signalContentType=LSP.

For details, see the following table.

Table 14. LayerRate and signalContentType by Layer

LAYER LAYERRATE SIGNALCONTENTTYPE

physical ETHERNET mac_transport

IP Data ETHERNET IP

Tunnel MPLS LSP

MPLS Protection MPLS_PROTECTION none

Pseudowire MPLS PW

TOP Service ETHERNET VCE (VLAN)

Sample response

{
"links": {},
"data": [
{
"id": "-6040704339084783820",
"type": "fres",
"attributes": {
"userLabel": "RA-LSP-1",
"mgmtName": "",
"nativeName": "",
"layerRate": "MPLS",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"signalContentType": "LSP",
"maxReservableBandwidth": [
{
"layer": "MPLS",
"capacity": 1,
"capacitySize": {
"size": [
"1000"
],
"pattern": {
"type": "POOL",
"format": "number"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 730
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

},
"unit": "mbps"
}
}
],
"additionalAttributes": {
"isActual": "true"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "-6040704339084783820:1"
},
{
"type": "endPoints",
"id": "-6040704339084783820:2"
}
]
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "7108030853852057371"
}
]
}
}
}
],
"included": [
{
"id": "-6040704339084783820:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "91521701-41c0-3892-a008-
8114e6f46175::TPE_CTPServerToClient_LSP_RA-LSP-1_headEnd"
}
]
}
}
},
{
"id": "-6040704339084783820:2",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 731
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "f240cfdf-bd82-32ea-9040-
1cd2fcfc29e7::TPE_CTPServerToClient_LSP_RA-LSP-1_tailEnd"
}
]
}
}
}
]
}

Retrieve all the services with layer rate ETHERNET associated with a specific LLDP link

To retrieve all the services with layer rate ETHERNET associated with a specific LLDP link, use the
Services Inventory (FREs) API.

Sample request

GET {{MCP_SERVER}}/nsi/api/fres

Specify the layerRate Ethernet and childFREId (which you can obtain by querying using getFRE API and
finding the FRE ID of the LLDP link of interest).

https://<mcp_server>/nsi/api/fres?layerRate=ETHERNET&childFreId=-1996657695693970062

Sample response

{
"links": {},
"data": [
{
"id": "3987563055145718878",
"type": "fres",
"attributes": {
"userLabel": "nsiEVPL3nodes51",
"mgmtName": "nsiEVPL3nodes51",
"nativeName": "",
"layerRate": "ETHERNET",
"networkRole": "IFRE",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"signalContentType": "VCE,VLAN",
"additionalAttributes": {
"isActual": "true"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 732
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "3987563055145718878:1"
},
{
"type": "endPoints",
"id": "3987563055145718878:2"
}
]
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "91521701-41c0-3892-a008-8114e6f46175::FRE_VLAN_5"
},
{
"type": "fres",
"id": "-1996657695693970062"
},
{
"type": "fres",
"id": "f240cfdf-bd82-32ea-9040-1cd2fcfc29e7::FRE_EVC_nsiEVPL3nodes51"
}
]
}
}
},

...,

"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "7108030853852057371:1"
},
{
"type": "endPoints",
"id": "7108030853852057371:2"
}
]
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "91521701-41c0-3892-a008-8114e6f46175::FRE_IP_if19_204"
},
{
"type": "fres",
"id": "-1996657695693970062"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 733
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"type": "fres",
"id": "f240cfdf-bd82-32ea-9040-1cd2fcfc29e7::FRE_IP_if19_204"
}
]
}
}
}
],
"included": [
{
"id": "3987563055145718878:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "91521701-41c0-3892-a008-
8114e6f46175::TPE_18_CTPServerToClient_VLAN_5"
}
]
}
}
},

...,

]
}

Retrieve all parent FREs of a given child FRE for specific layer rate and signal content
type

To retrieve all the services with layer rate ETHERNET associated with a specific LLDP link, use the
Services Inventory (FREs) API.

Sample request

GET {{MCP_SERVER}}/nsi/api/fres

Specify the layerRate ETHERNET and childFREId (which you can obtain by querying using getFRE API and
finding the FRE ID of the LLDP link of interest) and signalContentType=VCE.

https://<mcp_server>/nsi/api/fres?layerRate=ETHERNET&childFreId=-1154537279236972192&
signalContentType=VCE

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 734
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Sample response

{
"links": {},
"data": [
{
"id": "4880289591882536894",
"type": "fres",
"attributes": {
"userLabel": "",
"mgmtName": "apMcpMpls",
"nativeName": "",
"layerRate": "ETHERNET",
"networkRole": "IFRE",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"signalContentType": "VCE",
"cfmPackages": [
{
"cfmServiceName": "apMcpMpls",
"ccmPriority": "7",
"ccmInterval": "1",
"ccmIntervalUnit": "sec",
"cfmAdminState": "enabled",
"maName": "apMcpMpls",
"mdName": "md4",
"mdLevel": "4",
"megId": "md4apMcpMpls"
}
],
"additionalAttributes": {
"isActual": "true"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "4880289591882536894:1"
},
{
"type": "endPoints",
"id": "4880289591882536894:2"
}
]
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "2c06ee34-6e8f-30a8-9f1b-4be2828ad966::FRE_EVC_apMcpMpls"
},
{
"type": "fres",
"id": "-4223216837303838843"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 735
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

},
{
"type": "fres",
"id": "f240cfdf-bd82-32ea-9040-1cd2fcfc29e7::FRE_EVC_apMcpMpls"
}
]
}
}
}
],

...,

]
}

Retrieve all discovered / planned MPLS-TP LSP tunnels

To retrieve all tunnels, use the Services Inventory (FREs) API.

Sample request

GET {{MCP_SERVER}}/nsi/api/fres

https://<mcp_server>/nsi/api/fres?layerRate=MPLS_PROTECTION&type=link&include=tpes

Sample response

{
"links": {},
"data": [
{
"id": "-1154537279236972192",
"type": "fres",
"attributes": {
"userLabel": "",
"mgmtName": "apMcpLsp",
"nativeName": "",
"layerRate": "MPLS_PROTECTION",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"additionalAttributes": {
"protectionRole": "All",
"signaled": "false",
"isActual": "true",
"lspName": "apMcpLsp",
"resiliency": "Normal",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 736
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"subType": "TP",
"coRouted": "true"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "-1154537279236972192:1"
},
{
"type": "endPoints",
"id": "-1154537279236972192:2"
}
]
},
"decomposedFres": {
"data": [
{
"type": "fres",
"id": "8366750368065437314"
}
]
}
}
},
{
"id": "-1923914014353522308",
"type": "fres",
"attributes": {
"userLabel": "",
"mgmtName": "scLsp_P",
"nativeName": "",
"layerRate": "MPLS_PROTECTION",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"additionalAttributes": {
"protectionRole": "primary",
"isActual": "true"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "-1923914014353522308:1"
},
{
"type": "endPoints",
"id": "-1923914014353522308:2"
}
]
},
"partitionFres": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 737
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"data": [
{
"type": "fres",
"id": "2c06ee34-6e8f-30a8-9f1b-4be2828ad966::FRE_MPLS-
PROTECTION_scLsp_P_tailEnd"
},
{
"type": "fres",
"id": "-4589545612692847640"
},
{
"type": "fres",
"id": "f240cfdf-bd82-32ea-9040-1cd2fcfc29e7::FRE_MPLS-
PROTECTION_scLsp_P_headEnd"
}
]
}
}
},
{
"id": "-2336418390970056249",
"type": "fres",
"attributes": {
"userLabel": "",
"mgmtName": "RA-LSP-1",
"nativeName": "",
"layerRate": "MPLS_PROTECTION",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"additionalAttributes": {
"protectionRole": "All",
"signaled": "false",
"isActual": "true",
"lspName": "RA-LSP-1",
"resiliency": "Normal",
"subType": "TP",
"coRouted": "true"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "-2336418390970056249:1"
},
{
"type": "endPoints",
"id": "-2336418390970056249:2"
}
]
},
"decomposedFres": {
"data": [
{
"type": "fres",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 738
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"id": "-3568928065528446517"
}
]
}
}
}
],
"included": [
{
"id": "-1154537279236972192:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "2c06ee34-6e8f-30a8-9f1b-4be2828ad966::TPE_FTP_MPLS-
PROTECTION_apMcpLsp_tailEnd"
}
]
}
}
},
{
"id": "-1154537279236972192:2",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "f240cfdf-bd82-32ea-9040-1cd2fcfc29e7::TPE_FTP_MPLS-
PROTECTION_apMcpLsp_headEnd"
}
]
}
}
},
{
"id": "-1923914014353522308:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "2c06ee34-6e8f-30a8-9f1b-4be2828ad966::TPE_FTP_MPLS-

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 739
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

PROTECTION_scLsp_P_tailEnd"
}
]
}
}
},
{
"id": "-1923914014353522308:2",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "f240cfdf-bd82-32ea-9040-1cd2fcfc29e7::TPE_FTP_MPLS-
PROTECTION_scLsp_P_headEnd"
}
]
}
}
}
]
}

Refreshing properties for links and tunnels

You can use the REST API to update MCP with the latest data about an IP link or a tunnel from the
network.

There are three steps to this process:

1. Retrieve a container resource and select one of the resource IDs

2. Execute the refresh refresh with a tunnel or IP interface by top FRE ID
3. Retrieve the result to confirm the operation

Retrieving a resource ID

Retrieve the container resource and select one of the resource IDs. For example, in the case below, the
resource ID, RID is 58991626-9a79-45e6-97df-53ecdad53ce2

Use the Market API to retrieve resource IDs.

Sample call:
{{BP_SERVER}}/bpocore/market/api/v1/resources?exactTypeId=ifd.v4.resourceTypes.MplsOperationCon

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 740
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

tainer

Sample response:

{
"items": [
{
"id": "58991626-9a79-45e6-97df-53ecdad53ce2",
"label": "product for MplsOperationContainer",
"resourceTypeId": "ifd.v4.resourceTypes.MplsOperationContainer",
"productId": "58991625-0026-4481-9a68-31bff1eff90c",
"tenantId": "7c7da24e-d2af-35c7-8f6d-d8d16c7f0738",
"shared": false,
"properties": {},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-02-07T00:34:46.786Z",
"createdAt": "2017-02-07T00:34:46.300Z",
"autoClean": false
},
{
"id": "5a593761-2ac7-48b6-b148-d142518ecbca",
"label": "Resource for ifd.v4.resourceTypes.MplsOperationContainer",
"resourceTypeId": "ifd.v4.resourceTypes.MplsOperationContainer",
"productId": "5a593742-18de-415d-b85a-fd584b1fcdac",
"tenantId": "7e2374c5-6d48-4f28-a07b-de165b20b8f0",
"shared": false,
"properties": {},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {
"templateResources": {}
},
"updatedAt": "2018-01-12T22:32:01.986Z",
"createdAt": "2018-01-12T22:32:01.861Z",
"autoClean": false
},
{...}
],
"total": 5,
"offset": 0,
"limit": 1000
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 741
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Refreshing data for one resource

Execute custom operation: refresh with a tunnel or IP interface by top FRE ID

Use the Market API to submit the resync request.

Sample request

POST {{BP_SERVER}}/bpocore/market/api/v1/resources/{{RID}}/operations

Body of resync request:

{
"interface": "resync",
"inputs": {
"freId": "8044123183179859606"
}
}

Sample response:

{
"id": "5a605348-d39b-492f-be70-9763b68cea18",
"resourceId": "5a593763-c966-490b-8b8e-46503a5d22de",
"interface": "refresh",
"inputs": {
"freId": "8044123183179859606"
},
"outputs": {},
"state": "requested",
"reason": "",
"progress": [],
"providerData": {},
"createdAt": "2018-01-18T07:56:56.547Z",
"updatedAt": "2018-01-18T07:56:56.547Z",
"resourceStateConstraints": {},
"executionGroup": "lifecycle"
}

Retrieve the result to confirm the refresh operation

A loop is needed at the caller side to keep checking result state == successful

Use the Market API to retrieve the operation status.

Sample request GET {{BP_SERVER}}/bpocore/market/api/v1/resources/{{RID}}/operations/{{OID}}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 742
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Sample response:

{
"id": "5a605210-2f07-4e7c-92f9-edeb438d2970",
"resourceId": "5a593763-c966-490b-8b8e-46503a5d22de",
"interface": "refresh",
"inputs": {
"freId": "8044123183179859606"
},
"outputs": {
"resyncedNetworkElements": [
{
"ipAddress": "10.111.50.203",
"name": "MCP-5142-203"
},
{
"ipAddress": "10.111.50.200",
"name": "MCP-5142-200"
},
{
"ipAddress": "10.111.50.202",
"name": "MCP-5142-202"
}
]
},
"state": "successful",
"reason": "",
"progress": [],
"providerData": {},
"createdAt": "2018-01-18T07:51:44.108Z",
"updatedAt": "2018-01-18T07:51:52.892Z",
"resourceStateConstraints": {},
"executionGroup": "lifecycle"
}

Retrieve IP links
You can use the REST API retrieve a list of IP links, which function as part of the infrastructure supporting
packet services.

Sample request

The following request retrieves a list of IP links:

GET {{MCP_SERVER}}/nsi/api/fres?serviceClass=IP

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 743
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": [
{
"id": "d5b25d0b-e3bb-3442-978f-82483acf3ba6::FRE_2_EQPTGRP_7_IP_vs231",
"type": "fres",
"attributes": {
"operationState": "fully operating",
"deploymentState": "discovered",
"identifiers": [
{
"networkConstructId": "d5b25d0b-e3bb-3442-978f-82483acf3ba6",
"nodalId": "d5b25d0b-e3bb-3442-978f-
82483acf3ba6::FRE_2_EQPTGRP_7_IP_vs231"
}
],
"derivedAttributes": {
"intentLifeCyclePhase": "adopting discovered",
"intentDeploymentState": "waiting to adopt"
},
"displayData": {
"intentLifeCyclePhaseString": "Discovered"
},
"resourceState": "discovered",
"serviceClass": "IP",
"mgmtName": "vs231",
"layerRate": "ETHERNET",
"multiHighestStackLayerRate": "ETHERNET",
"networkRole": "IFRE",
"directionality": "bidirectional",
"topologySources": [
"discovered"
],
"signalContentType": "IP",
"active": true,
"additionalAttributes": {
"isActual": "true"
}
},
...

LAG show
Lag show retrieves LAG information of all lags.

Use JOB POST REST API of Network Element Configuration in MCP to invoke requests:

/configmgmt/api/v1/jobs

Attributes:

"scriptName": "lagShow"

Sample format of request payload:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 744
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Request payload

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "lagShow",
"inputs": [
{
"data": [
{
"type":"networkConstructs"
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

Response payload

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 745
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

[
{
"actorSystemPriority": "0x8000",
"addedTotalPorts": [
"7/9"
],
"agg": "Aggregate",
"aggAdminKey": "0x4001",
"aggAdminState": "Up",
"aggCollMaxDelay": 0,
"aggId": "0x4001(16385)",
"aggIndex": "0x4001",
"aggMinLinkAggregation": "off",
"aggMinLinkThreshold": 1,
"aggMode": "LACP",
"aggName": "AGG_D",
"aggOperKey": "0x2001",
"aggOperState": "Up",
"aggPortMac": "80:17:7D:E8:AC:EB",
"aggProtectionMode": "proprietary",
"aggReadyWaiting": "None",
"aggRevertDelay": 5000,
"aggRevertProtection": "off",
"aggSystemId": "80:17:7D:E8:AC:EB",
"lagPortDescription": "cienaaa",
"markerRespAllRcvdCount": 0,
"markerTimeout": 0,
"partnerCollMaxDelay": 0,
"partnerOperKey": "0x1802",
"partnerSystemId": "00:23:8A:8F:13:80",
"partnerSystemPriority": "0x8000",
"primaryPorts": [
"7/9"
],
"protectionPorts": [],
"selectedPorts": [
"7/9"
],
"timeOutCount": 0
}
]

Perform static MPLS commissioning

Commissioning is performed to support configuration of basic MPLS based settings so that the node is
ready for actual MPLS tunnel creation.

This section includes the following topics:

• Perform AIS global config

• Perform AIS profile config
• Perform AIS profile show

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 746
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

• Perform BFD H/W acceleration and global config

• Perform BFD profile config
• Perform IP-BFD/BFD session config
• Perform IP-interface/loopback interface config
• Perform MPLS label ranges

To perform static MPLS commissioning, use the Network element configuration (configmgmt) API.

Sample request

POST {{MCP_SERVER}}/configmgmt/api/v1/jobs

Perform AIS global config

The aisGlobalConfig Config Manager script allows a user to apply ais-global config commissioning
configuration to any Ciena CES or 6500 PF device that has a session established with MCP. The script will
execute the RA command to communicate with the device.

The aisGlobalConfig script allows the user to execute update ais-global config attributes. The schema
provides the user with an input attribute named "action". This action attribute is enumerable with option:
"update".

• The "update" action allows the user to update the ais-global config attribute.

A use case example is provided below.

NOTE: The "scriptName" attribute must contain the value "aisGlobalconfig" to execute the ais-global-
configuration script.

NOTE: "id" (contained twice in the example below) is the network construct ID given by MCP for the NE,
and "ipAddress" is the IP of the NE.

AIS global config update

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 747
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "aisGlobalConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "update",
"globalConfig": "enable"
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a"
}
]
}
}
},
"included": [
{
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"type": "networkElement",
"attributes": {
"ncId": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"neName": "87c_0009",
"ipAddress": "10.182.130.100",
"neType": "8700"
}
}
]
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 748
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"jobId": "6f057d9f-c912-435b-8f0b-47cab0f540b2",
"status": "COMPLETED",
"input": {
"data": {
"type": "jobs"
}
},
"output": {
"data": {
"type": "jobResults",
"attributes": {
"scriptResults": [
{
"scriptName": "aisGlobalConfig",
"status": "COMPLETED",
"commandResults": [
{
"command": "set-ais-global-configuration.json",
"result": {
"result": {
"data": "",
"result": "success"
}
}
}
]
}
]
}
}
}
}

Perform AIS profile config

AIS profiles on nodes that allow profiling (SAOS based nodes), so they can be used by the MPLS tunnels
BFD session or IP interface BFD session. The AIS profile would notably specify the RDI state, the refresh
timer and tlv-mode.

The aisProfileConfig Config Manager script allows a user to apply ais-profile commissioning
configuration to any Ciena CES or 6500 PF device that has a session established with MCP. The script will
execute the RA command to communicate with the device.

The aisProfileConfig script allows the user to execute create and delete profile, set and reset of profile
attributes and set ais global config within the same script. The schema provides the user with an input
attribute named "action". This action attribute is enumerable with options: "create", "delete", "update",
"unset".

• The "create" action allows the user to create ais-profile with attributes and set ais-global config
attribute.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 749
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

• The "delete" action allows the user to remove ais-profile.

• The "set" action allows the user to set ais-profile attributes and set ais-global config attribute.
• The "unset" action allows the user to reset ais-profile attributes.

Use case examples are provided below.

Note: The "scriptName" attribute must contain the value "aisProfileConfig " to execute the ais-profile
configuration script.

Note:"id" (contained twice in each example below) is the network construct ID given by MCP for the NE,
and "ipAddress" is the IP of the NE.

AIS profile creation

Sample request

POST {{MCP_SERVER}}/configmgmt/api/v1/jobs

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 750
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "aisProfileConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "create",
"profileName":"test",
"refreshTimer": 12,
"rdi": "disable"
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a"
}
]
}
}
},
"included": [
{
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"type": "networkElement",
"attributes": {
"ncId": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"neName": "87c_0009",
"ipAddress": "10.182.130.100",
"neType": "8700"
}
}
]
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 751
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"jobId": "6f057d9f-c912-435b-8f0b-47cab0f540b2",
"status": "COMPLETED",
"input": {
"data": {
"type": "jobs"
}
},
"output": {
"data": {
"type": "jobResults",
"attributes": {
"scriptResults": [
{
"scriptName": "aisProfileConfig",
"status": "COMPLETED",
"commandResults": [
{
"command": "set-ais-profile.json",
"result": {
"result": {
"data": "",
"result": "success"
}
}
}
]
}
]
}
}
}
}

AIS profile deletion

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 752
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "aisProfileConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "delete",
"profileName":"test"
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a"
}
]
}
}
},
"included": [
{
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"type": "networkElement",
"attributes": {
"ncId": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"neName": "87c_0009",
"ipAddress": "10.182.130.100",
"neType": "8700"
}
}
]
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 753
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"jobId": "6f057d9f-c912-435b-8f0b-47cab0f540b2",
"status": "COMPLETED",
"input": {
"data": {
"type": "jobs"
}
},
"output": {
"data": {
"type": "jobResults",
"attributes": {
"scriptResults": [
{
"scriptName": "aisProfileConfig",
"status": "COMPLETED",
"commandResults": [
{
"command": "set-ais-profile.json",
"result": {
"result": {
"data": "",
"result": "success"
}
}
}
]
}
]
}
}
}
}

AIS profile update

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 754
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "aisProfileConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "update",
"profileName":"test",
"refreshTimer": 12,
"rdi": "disable"
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a"
}
]
}
}
},
"included": [
{
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"type": "networkElement",
"attributes": {
"ncId": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"neName": "87c_0009",
"ipAddress": "10.182.130.100",
"neType": "8700"
}
}
]
}

AIS profile unset

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 755
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "aisProfileConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "unset",
"profileName":"test",
"refreshTimer": null,
"rdi": null
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a"
}
]
}
}
},
"included": [
{
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"type": "networkElement",
"attributes": {
"ncId": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"neName": "87c_0009",
"ipAddress": "10.182.130.100",
"neType": "8700"
}
}
]
}

Perform AIS profile show

The aisProfileShow Config Manager script allows a user to display ais-profile configuration to any Ciena
CES or 6500 PF device that has a session established with MCP. The script will execute the RA command

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 756
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

to communicate with the device.

A use case example is provided below.

NOTE: The "scriptName" attribute must contain the value "aisProfileShow " to execute the ais-profile
configuration script.

NOTE: "id" (contained twice in the example below) is the network construct ID given by MCP for the NE,
and "ipAddress" is the IP of the NE.

View AIS profile

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 757
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-03-23T14:54:06.000+0000",
"scripts": [
{
"scriptName":"aisProfileShow",
"inputs": [
{
"data": [
{
"type":"networkConstructs"

}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "ffa40e1e-4bd8-4686-acb4-92edb787311a"
}
]
}
}
},
"included": [
{
"id": "ffa40e1e-4bd8-4686-acb4-92edb787311a",
"type": "networkElement",
"attributes": {
"ncId": "ffa40e1e-4bd8-4686-acb4-92edb787311a",
"neName": "8700",
"ipAddress": "10.182.130.100",
"neType": "8700"
}
}
]
}

Sample response

{
"jobId": "f3c052e9-3423-4b10-8c9f-505031b252a3",
"status": "COMPLETED",
"input": {
"data": {
"type": "jobs",
"attributes": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 758
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"maxConnections": "10",
"scheduleTime": "2017-03-23T14:54:06.000+0000",
"scripts": [
{
"scriptName": "aisProfileShow"
}
]
}
}
},
"output": {
"data": {
"type": "jobResults",
"attributes": {
"scriptResults": [
{
"scriptName": "aisProfileShow",
"status": "COMPLETED",
"commandResults": [
{
"command": "get-ais-profile.json",
"result": {
"result": [
{
"degradeSupport": "disable",
"lspNo": "1",
"profileName": "Default",
"rdi": "enable",
"refreshTimer": 10,
"mode": "single-byte"
},
{
"degradeSupport": "disable",
"lspNo": "2",
"profileName": "MCP_AIS_s01",
"rdi": "enable",
"refreshTimer": 1,
"mode": "single-byte"
},
{
"degradeSupport": "disable",
"lspNo": "0",
"profileName": "MCP_AIS_s05",
"rdi": "enable",
"refreshTimer": 5,
"mode": "single-byte"
},
{
"degradeSupport": "disable",
"lspNo": "6",
"profileName": "MCP_AIS_s10",
"rdi": "enable",
"refreshTimer": 10,
"mode": "single-byte"
},
{
"degradeSupport": "disable",
"lspNo": "0",
"profileName": "MCP_AIS_s15",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 759
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"rdi": "enable",
"refreshTimer": 15,
"mode": "single-byte"
},
{
"degradeSupport": "disable",
"lspNo": "0",
"profileName": "MCP_AIS_s20",
"rdi": "enable",
"refreshTimer": 20,
"mode": "single-byte"
}
],
"parameters": {
"data": [
{
"type": "networkConstructs"
}
]
},
"command": "get-ais-profile.json"
}
}
]
}
]
}
}
}
}

Perform BFD H/W acceleration and global config

The bfdHwAccelerationGlobalConfig Config Manager script allows a user to apply bfd-h/w acceleration
and bfd global config commissioning configuration to any Ciena CES or 6500 PF device that has a
session established with MCP. The script will execute the RA command to communicate with the device.

The bfdHwAccelerationGlobalConfig script allows the user to execute update, set and unset

bfd-h/w acceleration and bfd global config attributes. The schema provides the user with an input
attribute named "action". This action attribute is enumerable with options: "update", "set", "unset".

• The "update" action allows the user to update bfd global config attribute.
• The "set" action allows the user to set bfd global h/w acceleration attribute.
• The "unset" action allows the user to reset bfd global h/w acceleration attribute.

Use case examples are provided below.

NOTE: The "scriptName" attribute must contain the value "bfdHwAccelerationGlobalConfig" to execute
the bfd-global-configuration script.

NOTE: "id" (contained twice in the examples below) is the network construct ID given by MCP for the NE,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 760
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

and "ipAddress" is the IP of the NE.

BFD global config update

Sample request

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "bfdHwAccelerationGlobalConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "update",
"globalConfig": "enable"
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a"
}
]
}
}
},
"included": [
{
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"type": "networkElement",
"attributes": {
"ncId": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"neName": "87c_0009",
"ipAddress": "10.182.130.100",
"neType": "8700"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 761
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

BFD H/W acceleration set

Sample request

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "bfdHwAccelerationGlobalConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "set",
"hwAcceleration": "on"

}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a"
}
]
}
}
},
"included": [
{
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"type": "networkElement",
"attributes": {
"ncId": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"neName": "87c_0009",
"ipAddress": "10.182.130.100",
"neType": "8700"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 762
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

BFD H/W acceleration unset

Sample request

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "bfdHwAccelerationGlobalConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "unset",
"hwAcceleration": null
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a"
}
]
}
}
},
"included": [
{
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"type": "networkElement",
"attributes": {
"ncId": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"neName": "87c_0009",
"ipAddress": "10.182.130.100",
"neType": "8700"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 763
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Perform BFD profile config

The bfdProfileConfig Config Manager script allows a user to apply bfd-profile commissioning
configuration to any Ciena CES or 6500 PF device that has a session established with MCP. The script will
execute the RA command to communicate with the device.

The bfdProfileConfig script allows the user to execute create and delete profile, set and reset of profile
attributes. The schema provides the user with an input attribute named "action". This action attribute is
enumerable with options: "create", "delete", "update", "unset".

• The "create" action allows the user to create bfd-profile with attributes.
• The "delete" action allows the user to remove bfd-profile.
• The "set" action allows the user to set bfd-profile attributes.
• The "unset" action allows the user to reset bfd-profile attributes.

Use case examples are provided below.

NOTE: The "scriptName" attribute must contain the value "bfdProfileConfig" to execute the bfd-profile
configuration script.

NOTE: "id" (contained twice in each example below) is the network construct ID given by MCP for the NE,
and "ipAddress" is the IP of the NE.

BFD profile creation

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 764
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "bfdProfileConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "create",
"profileName":"test",
"transmitInterval": "3.3msec",
"receiveInterval": "10msec",
"role": "passive",
"lspGachtype": "7"
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a"
}
]
}
}
},
"included": [
{
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"type": "networkElement",
"attributes": {
"ncId": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"neName": "87c_0009",
"ipAddress": "10.182.130.100",
"neType": "8700"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 765
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

BFD profile deletion

Sample request

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "bfdProfileConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "delete",
"profileName":"test"

}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a"
}
]
}
}
},
"included": [
{
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"type": "networkElement",
"attributes": {
"ncId": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"neName": "87c_0009",
"ipAddress": "10.182.130.100",
"neType": "8700"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 766
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

BFD profile update

Sample request

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "bfdProfileConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "update",
"profileName":"test",
"transmitInterval": "10msec",
"receiveInterval": "10msec",
"role": "active",
"lspGachtype":"7"
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a"
}
]
}
}
},
"included": [
{
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"type": "networkElement",
"attributes": {
"ncId": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"neName": "87c_0009",
"ipAddress": "10.182.130.100",
"neType": "8700"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 767
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

BFD profile unset

Sample request

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "bfdProfileConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "unset",
"profileName":"test",
"transmitInterval": null,
"receiveInterval": null,
"lspGachtype": null
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a"
}
]
}
}
},
"included": [
{
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"type": "networkElement",
"attributes": {
"ncId": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"neName": "87c_0009",
"ipAddress": "10.182.130.100",
"neType": "8700"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 768
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Perform IP-BFD/BFD session config

The bfdSessionConfig Config Manager script allows a user to apply bfd-session commissioning
configuration to any Ciena CES or 6500 PF device that has a session established with MCP. The script will
execute the RA command to communicate with the device.

The bfdSessionConfig script allows the user to execute create and delete bfd session attributes. The
schema provides the user with an input attribute named "action". This action attribute is enumerable with
options: "create" and "delete".

• The "create" action allows the user to create bfd-session.

• The "delete" action allows the user to remove bfd-session.

Use case examples are provided below.

NOTE: The "scriptName" attribute must contain the value "bfdSessionConfig" to execute the bfd-session
configuration script.

NOTE: "id" (contained twice in each example below) is the network construct ID given by MCP for the NE,
and "ipAddress" is the IP of the NE.

BFD session creation

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 769
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "bfdSessionConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "create",
"bfdSessionName": "testing",
"bfdProfileName": "test12",
"neighbourIpAddr": "1.1.1.1"
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a"
}
]
}
}
},
"included": [
{
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"type": "networkElement",
"attributes": {
"ncId": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"neName": "87c_0009",
"ipAddress": "10.182.130.100",
"neType": "8700"
}
}
]
}

BFD session deletion

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 770
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "bfdSessionConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "delete",
"bfdSessionName": "testing",
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a"
}
]
}
}
},
"included": [
{
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"type": "networkElement",
"attributes": {
"ncId": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"neName": "87c_0009",
"ipAddress": "10.182.130.100",
"neType": "8700"
}
}
]
}

Perform IP-interface/loopback interface config

The ipInterfacesConfig Config Manager script allows a user to apply ip-interface commissioning
configuration to any Ciena CES or 6500 PF device that has a session established with MCP. The script will
execute the RA command to communicate with the device.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 771
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

The ipInterfacesConfig script allows the user to execute create, delete, set, unset interface, add, and
remove ip. The schema provides the user with an input attribute named "action". This action attribute is
enumerable with options: "create", "delete", "update", "unset", "add", "remove".

• The "create" action allows the user to create ip-interface with attributes.
• The "delete" action allows the user to remove ip-interface.
• The "update" action allows the user to set ip-interface attributes.
• The "unset" action allows the user to reset ip-interface attributes.
• The "add" action allows the user to add ip address.
• The "remove" action allows the user to remove ip address.

Use case examples are provided below.

NOTE: The "scriptName" attribute must contain the value "ipInterfacesShow" to execute the ip-interface
configuration script.

NOTE: "id" (contained twice in each example below) is the network construct ID given by MCP for the NE,
and "ipAddress" is the IP of the NE.

IP-Interface show

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 772
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-03-23T14:54:06.000+0000",
"scripts": [
{
"scriptName":"ipInterfcaeShow",
"inputs": [
{
"data": [
{
"type":"networkConstructs"

}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "f57de3f9-eb12-40c7-936c-c76339ef79c9"
}
]
}
}
},
"included": [
{
"id": "f57de3f9-eb12-40c7-936c-c76339ef79c9",
"type": "networkElement",
"attributes": {
"ncId": "f57de3f9-eb12-40c7-936c-c76339ef79c9",
"neName": "65sd_2070",
"ipAddress": "10.182.129.173",
"neType": "6500"
}
}
]
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 773
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"interfaceVlanId": 0,
"interfaceL2VpnDependency": "false",
"interfaceOspfEnable": "false",
"interfaceType": "loopback",
"interfaceStaticArpDestinationIp": "0.0.0.0",
"interfaceStaticArpEnable": "false",
"interfaceLdpEnable": "false",
"interfaceOperState": "disabled",
"interfaceUnnumbered": "false",
"interfaceCvlanPriority": 0,
"interfaceRole": "none",
"interfaceAdminState": "disabled",
"interfaceSvlanPriority": 0,
"interfaceMask": 0,
"interfaceIfNum": 0,
"interfaceVccvDependency": "false",
"interfaceIpAddr": "0.0.0.0",
"interfaceIsisEnable": "false",
"interfaceTunnelDependency": "false",
"interfaceIfMt": 1500,
"interfaceStaticArpDestinationMac": "0x000000000000",
"interfaceIfIndex": 21,
"interfaceIngressAclProfId": 0,
"interfaceName": "lb0",
"interfacePtpEnable": "false",
"interfaceRowStatus": "active",
"interfaceRsvpEnable": "false",
"interfaceIpForwarding": "off",
"interfaceCvid": 0,
"interfaceMac": "0x000318d01f81"
}

IP-Interface creation

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 774
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "ipInterfacesConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "create",
"interfaceName":"if0",
"interfaceType":"point-to-point",
"interfaceVlanId": 10,
"interfaceSvlanPriority":3,
"interfaceIfNum":10,
"interfaceIfMtu":2000,
"interfaceIpForwarding": "on",
"interfaceServiceMac": "local-mgmt",
"interfaceIpAddr":"100.0.0.5",
"interfaceMask":31
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a"
}
]
}
}
},
"included": [
{
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"type": "networkElement",
"attributes": {
"ncId": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"neName": "51_0009",
"ipAddress": "10.182.130.100",
"neType": "51xx"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 775
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Loopback IP-Interface creation

Sample request

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "ipInterfacesConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "create",
"interfaceName":"lb0",
"interfaceType":"loopback",
"interfaceIpAddr":"100.0.0.5"
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a"
}
]
}
}
},
"included": [
{
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"type": "networkElement",
"attributes": {
"ncId": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"neName": "51_0009",
"ipAddress": "10.182.130.100",
"neType": "51xx"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 776
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

IP-Interface deletion

Sample request

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "ipInterfacesConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "delete",
"interfaceName":"if0"
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a"
}
]
}
}
},
"included": [
{
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"type": "networkElement",
"attributes": {
"ncId": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"neName": "51_0009",
"ipAddress": "10.182.130.100",
"neType": "51xx"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 777
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Add ipAddress with ipInterface

Sample request

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "ipInterfacesConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "add",
"interfaceName":"if0",
"interfaceIpAddr":"2620:11b:d03d:f104:203:18ff:fee4:1aff",
"interfaceMask":64
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a"
}
]
}
}
},
"included": [
{
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"type": "networkElement",
"attributes": {
"ncId": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"neName": "51_0009",
"ipAddress": "10.182.130.100",
"neType": "51xx"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 778
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Remove ipAddress from ipInterface

Sample request

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "ipInterfacesConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "remove",
"interfaceName":"if0",
"interfaceIpAddr":"2620:11b:d03d:f104:203:18ff:fee4:1aff",
"interfaceMask":64
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a"
}
]
}
}
},
"included": [
{
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"type": "networkElement",
"attributes": {
"ncId": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"neName": "51_0009",
"ipAddress": "10.182.130.100",
"neType": "51xx"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 779
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

IP-Interface update

Sample request

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "ipInterfacesConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "update",
"interfaceName":"if0",
"interfaceIfMtu":2000,
"interfaceIfNum": 10,
"interfaceIpForwarding": "off",
"interfaceSvlanPriority":4
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a"
}
]
}
}
},
"included": [
{
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"type": "networkElement",
"attributes": {
"ncId": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"neName": "51_0009",
"ipAddress": "10.182.130.100",
"neType": "51xx"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 780
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

IP-Interface unset

Sample request

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "ipInterfacesConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "unset",
"interfaceName":"lb0",
"interfaceIpAddr":null
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a"
}
]
}
}
},
"included": [
{
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"type": "networkElement",
"attributes": {
"ncId": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"neName": "51_0009",
"ipAddress": "10.182.130.100",
"neType": "51xx"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 781
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Perform MPLS label ranges

The mplsLabelRangesConfig Config Manager script allows a user to apply mpls-label-range

commissioning configuration to any Ciena CES or 6500 PF device that has a session established with
MCP. The script will execute the RA command to communicate with the device.

The mplsLabelRangesConfig script allows the user to execute update and unset mpls label ranges. The
schema provides the user with an input attribute named "action". This action attribute is enumerable with
options: "update", "unset".

• The "update" action allows the user to set mpls-label ranges attributes.
• The "unset" action allows the user to reset mpls-label ranges attributes.

Use case examples are provided below.

NOTE: The "scriptName" attribute must contain the value "mplsLabelRangesConfig" to execute the mpls-
label-ranges configuration script.

NOTE: "id" (contained twice in each example below) is the network construct ID given by MCP for the NE,
and "ipAddress" is the IP of the NE.

MPLS label ranges update

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 782
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "mplsLabelRangesConfig ",
"inputs": [
{
"data": [
{
"attributes": {
"action": "update",
"staticAdminTunnelLabelRangeEnd": 29,
"staticAdminTunnelLabelRangeStart": 20,
"staticAdminVcLabelRangeEnd": 5000,
"staticAdminVcLabelRangeStart": 30
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a"
}
]
}
}
},
"included": [
{
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"type": "networkElement",
"attributes": {
"ncId": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"neName": "87c_0009",
"ipAddress": "10.182.130.100",
"neType": "8700"
}
}
]
}

MPLS label ranges unset

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 783
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "mplsLabelRangesConfig ",
"inputs": [
{
"data": [
{
"attributes": {
"action": "unset",
"staticAdminTunnelLabelRangeEnd": null,
"staticAdminTunnelLabelRangeStart": null,
"staticAdminVcLabelRangeEnd": null,
"staticAdminVcLabelRangeStart": null
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a"
}
]
}
}
},
"included": [
{
"id": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"type": "networkElement",
"attributes": {
"ncId": "f0a27af2-40a7-4618-bb9e-35084a87577a",
"neName": "87c_0009",
"ipAddress": "10.182.130.100",
"neType": "8700"
}
}
]
}

Create static MPLS-TP tunnel

This section includes the following topics:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 784
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

• Retrieve an MPLS tunnel facade product ID

• Create an MPLS tunnel facade
• Retrieve the status of an MPLS tunnel creation
• LAG support
• Adding constraints

Retrieve an MPLS tunnel facade product ID

To retrieve an MPLS tunnel facade product ID, use the Market API.

Sample request

GET {{MCP_SERVER}}/bpocore/market/api/v1/products

Sample response

For a sample response, see Retrieve L2 service intent facade product ID.

In the response, note the “ifd.v1.resourceTypes.MplsTunnelIntentFacade”. Use this ID as the “product Id”
in Create an MPLS tunnel facade.

Create an MPLS tunnel facade

To create an MPLS tunnel facade, use the Market API.

Request = POST {{MCP_SERVER}}/bpocore/market/api/v1/resources

Specify the productId, which you obtain from the response when you Retrieve an MPLS tunnel facade
product ID.

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 785
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"productId": "58cb1ddd-564e-4c6a-afb4-bd3a70449e13",
"label": "Tunnel SJ to SF",
"properties": {
"name": "Tunnel-P2”,
"turnUpDateTime": "2017-11-19T11:37:29.739",
"turnDownDateTime": "2017-12-19T11:37:29.739",
"protectionType": "PROTECTED",
"bfdInterval": "100msec",
"aisRefreshTimer": "10sec",
"autoReversionPossible": true,
"waitToRevertDelay": 300,
"reversionTimeUnit": "seconds",
"endPointA": {
"networkElement": {
"name": "MCP-5142-200"
},
"primary": {
"port": "3"
},
"backup": {
"port": "4"
}
},
"endPointZ": {
"networkElement": {
"name": "MCP-5142-201"
},
"primary": {
"port": "3"
},
"backup": {
"port": "4"
}
}
}
}

A list of parameters and related descriptions follows.

Table 15. Parameters and description

Parameter Description

productId The id from the API.

label The label of the tunnel stored in MCP db only.

name The name for the tunnel on the NE.

Note: The "name" field is optional; if not provided the tunnel name will be
auto-generated.

turnUpDateTime The time when the tunnel has to be deployed. The values can be
empty,“NOW” or any time. If empty, then tunnel is deployed immediately.

turnDownDateTime The time the tunnel has to be deleted.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 786
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

protectionType Can be “PROTECTED or “UNPROTECTED”. Indicates whether both

primary and backup tunnel has to be created.

autoReversionPossible true/false. Indicates whether tunnel reversion should be enabled.

endPointA/Z The endpoint-related info.

networkElement The NE name.

primary-port Optional. The I-NNI port to be used for primary tunnel.

For 8700/6500-Packet Fabric, the port info should also have shelf, slot as
in the following example:

"primary": {

“shelf” : "{{SHELF_NUM}}",

“slot”: “{{SLOT_NUM}}”,

"port": "{{TUNNEL_AEND_PORT}}"

Note: When built on LAG, instead of shelf/slot/port, lagName must be

provided. For 6500 Packet Fabric, in addition to shelf, eqptGrp must be
provided. See also: LAG show.

backup-port Optional. The I-NNI port to be used for backup tunnel.

For 8700/6500-PacketFabric, the port info should also have shelf, slot (as
in the example for the parameter <primary-port, primary port> in this
table.

Note: The other parameter values and roles are the same as in the BP MCP GUI.

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 787
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "58cb239a-2770-466e-af62-ce66cb1b7981",
"label": "Tunnel SJ to SF",
"resourceTypeId": "ifd.resourceTypes.MplsTunnelIntentFacade",
"productId": "58cb1ddd-564e-4c6a-afb4-bd3a70449e13",
"tenantId": "2f0a1fae-05c0-448d-96eb-84b989b2f89a",
"shared": false,
"properties": {
"name": "Tunnel-P2",
"autoReversionPossible": true,
"protectionType": "PROTECTED",
"reversionTimeUnit": "seconds",
"waitToRevertDelay": 300,
"endPointA": {
"networkElement": {
"name": "MCP-5142-200"
},
"primary": {
"port": "3"
},
"backup": {
"port": "4"
}
},
"bfdInterval": "100msec",
"endPointZ": {
"networkElement": {
"name": "MCP-5142-201"
},
"primary": {
"port": "3"
},
"backup": {
"port": "4"
}
},
"aisRefreshTimer": "10sec"
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-03-16T23:45:30.424Z",
"createdAt": "2017-03-16T23:45:30.424Z",
"autoClean": false
}

Note the “id” in the response (above) is the “id” of the MPLS Tunnel Facade created (using the API in
Create an MPLS tunnel facade).

Use this id to:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 788
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

• retrieve the status of an MPLS tunnel creation (see Retrieve the status of an MPLS tunnel creation),
and
• to delete a tunnel (see Delete a static MPLS-TP LSP tunnel (protected and unprotected) by
provisioning intent)

Retrieve the status of an MPLS tunnel creation

To retrieve the status of an MPLS tunnel creation, use the Market API.

Sample request

GET {{MCP_SERVER}}/bpocore/market/api/v1/resources/{resourceId}

Specify the id, which you obtain from the response when you Create an MPLS tunnel facade.

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 789
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "58cb239a-2770-466e-af62-ce66cb1b7981",
"label": "Tunnel SJ to SF",
"resourceTypeId": "ifd.resourceTypes.MplsTunnelIntentFacade",
"productId": "58cb1ddd-564e-4c6a-afb4-bd3a70449e13",
"tenantId": "2f0a1fae-05c0-448d-96eb-84b989b2f89a",
"shared": false,
"properties": {
"name": "Tunnel-P2",
"autoReversionPossible": true,
"protectionType": "PROTECTED",
"reversionTimeUnit": "seconds",
"waitToRevertDelay": 300,
"endPointA": {
"networkElement": {
"name": "MCP-5142-200"
},
"primary": {
"port": "3"
},
"backup": {
"port": "4"
}
},
"bfdInterval": "100msec",
"endPointZ": {
"networkElement": {
"name": "MCP-5142-201"
},
"primary": {
"port": "3"
},
"backup": {
"port": "4"
}
},
"aisRefreshTimer": "10sec"
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-03-16T23:46:46.847Z",
"createdAt": "2017-03-16T23:45:30.424Z",
"autoClean": false
}

In the response (above) check the “orchState” and “reason” for the result of the provisioning (creation). If
provisioning failed, these fields contain the details (for example, device errors or smoother error).

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 790
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

LAG support

You can use the API to create a tunnel with LAG endpoints as shown below.

Request: POST {{BP_SERVER}}/bpocore/market/api/v1/resources

{
"productId": "{{TUNNEL_FACADE_PID}}",
"label": "{{TUNNEL_NAME}}",
"properties": {
"name": "{{TUNNEL_NAME}}",
"protectionType": "UNPROTECTED",
"bfdInterval": "",
"aisRefreshTimer": "",
"endPointA": {
"networkElement": {
"name": "3930_0064"
},
"primary": {
"lagName": "AGG-64-22"
}
},
"endPointZ": {
"networkElement": {
"name": "3932_0022"
},
"primary": {
"lagName": "AGG-64-22"
}
}
}
}

Adding constraints

During MPLS tunnel provisioning, you can specify constraints that will apply when calculating valid tunnel
paths. These constraints can specify a list of nodes the tunnel should, or should not traverse. The list can
be a partial or full list of ordered nodes or ports.

• You can specify a list of nodes/ports to be included or excluded from the tunnel path.
• These constraints are in addition to the INNI ports that can be specified at the endpoints.
• You can specify separate constraints for the primary and backup paths.
• You can specify diversity constraints for protected tunnels, to limit the nodes or links they share in
common.
• You can LAG and TIDc objects as part of these constraints using their equipment group ID
• MCP will validate the constraints and return a path if available; otherwise no path will be returned.

The examples below show various constraint configurations which can be included in the provisioning
call.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 791
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Unprotected tunnel with one constraint

"protectionType": "UNPROTECTED",
"endPointA": {},
"endPointZ": {},
"routingConstraints": [
{
"includeRouteObjects": [
{
"objectType": "NODE_NAME",
"value": ["A", "B"]
},
{
"objectType": "NODE_NAME",
"value": ["C", "D"]
}
]
}
]

Protected tunnel with one Constraint

Here constraints are provided for only one tunnel in the protected pair.

"protectionType": "PROTECTED",
"endPointA": {},
"endPointZ": {},
"routingConstraints": [
{
"includeRouteObjects": [
{
"objectType": "NODE_NAME",
"value": ["A", "B"]
},
{
"objectType": "NODE_NAME",
"value": ["C", "D"]
}
]
},
{}
]

Protected tunnel with two Constraints

Here constraints are provided for both the primary and backup tunnel.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 792
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"protectionType": "PROTECTED",
"endPointA": {},
"endPointZ": {},
"routingConstraints": [
{
"includeRouteObjects": [
{
"objectType": "NODE_NAME",
"value": ["A", "B"]
},
{
"objectType": "NODE_NAME",
"value": ["C", "D"]
}
]
},
{
"includeRouteObjects": [
{
"objectType": "NODE_NAME",
"value": ["X"]
}
]
}
]

Port-based constraints

In addition to constraints that specify the inclusion or exclusion of individual nodes, you can configure
constraints for the inclusion or exclusion fo specific ports.

You can specify routing constraint the inclusin or exclusion of Ethernet LLDP links by specifying the
Ethernet LLDP link’s endpoint ports for inclusion or exlcusion.

Port constraints take the following form:

objectType: END_POINT locations: a list of following location objects. Among locations, they are OR
relationship:

• nodeName
• Other attributes:
◦ port = 4 (6x)
◦ slot = 3, port = 4 (8700)
◦ shelf = 1, slot = 3, port = 4 (6200)

Note: due to the list format limitation, only one set of the port value can be supported. There can currently
be no OR relationship to specify multiple ports.

Unprotected tunnel with port-based constraints

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 793
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Here constraints are configured for the inclusion of specific ports.

"protectionType": "UNPROTECTED",
"endPointA": {},
"endPointZ": {},
"routingConstraints": [
{
"includeRouteObjects": [
{
"objectType": "END_POINT",
"locations": [
{
"nodeName": "MCP-5142-200",
"port": "4"
}
]
},
{
"objectType": "END_POINT",
"locations": [
{
"nodeName": "MCP-8700-206",
"slot": "3",
"port": "5"
}
]
},
{
"objectType": "END_POINT",
"locations": [
{
"nodeName": "SJ_6200_171",
"shelf": "1",
"slot": "3",
"port": "5"
}
]
}
]
}
]

Unprotected tunnel with LAG-based constraints

Similar to a physical port-based constraint, you can specify a LAG port in the constraint. You can
configure the inclusin or inclusion of LAG links by specifying the LAG link’s endpoint LAG port.

These constraints take the following form:

objectType: LAG_END_POINT

locations: a list of the following:

• nodeName

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 794
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

• lagName = MyAggPort1 (for CES 6x, 8x)

• lagName = MyAggPort1, eqptGrp = 8 (for 6500 Packet Fabric)

"protectionType": "UNPROTECTED",
"endPointA": {},
"endPointZ": {},
"routingConstraints": [
{
"includeRouteObjects": [
{
"objectType": "LAG_END_POINT",
"locations": [
{
"nodeName": "MCP-5142-200",
"lagName": "MyAggName1"
}
]
},
{
"objectType": "LAG_END_POINT",
"locations": [
{
"nodeName": "6500-200",
"shelf": "31",
"eqptGrp": "8",
"lagName": "MyAggName1"
}
]
}
]
}
]

Unprotected tunnel with IP Interface Name and Address constraints

Similarly, routing constraint for tunnels using IP links can be implemented by specifying the IP link’s
endpoint IP interface name or IP interface address. These constraints take the following form:

objectType: IP_INTERFACE_NAME and IP_INTERFACE_ADDR locations: a list of the followings:

• nodeName
• When objectType is IP_INTERFACE_NAME, interfaceName = ipCtrl_3_6
• When objectType is IP_INTERFACE_ADDR, interfaceAddress = 9.4.1.1
◦ For 6200 interoperation, the IP interface address on the 6200 will be a MAC address.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 795
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"protectionType": "UNPROTECTED",
"endPointA": {},
"endPointZ": {},
"routingConstraints": [
{
"includeRouteObjects": [
{
"objectType": "IP_INTERFACE_NAME",
"locations": [
{
"nodeName": "MCP-5142-200",
"interfaceName": "ipCtrl_3"
}
]
}
]
}
]

Node and link diversity constraints

Node and link diversity constraints only apply to the primary and backup path of a protected tunnel.

• Diversity Level: Indicate whether to use link or node diversity using the API enums NODE_DIVERSE or
LINK_DEVERSE. if not specified, the default is LINK_DEVERSE.
• Diversity Selection Criteria: Indicate whether the diversity if mandatory or best effort using the API
enums MANDATORY or BEST_EFFORT. If not specified, the default is MANDATORY.

By default, without specifying any diversity constraints, a protected tunnel will be configured with link
diversity (LINK_DEVERSE) and mandatory (MANDATORY) enabled.

Diversity constraints can be applied to new tunnel creation, and also when adding a backup path to an
existing tunnel.

Sample: node diversity constraints

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 796
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"productId": "{{TUNNEL_FACADE_PID}}",
"label": "{{TUNNEL_NAME}}",
"properties": {
"turnUpDateTime": "2117-11-19T11:37:29.739",
"turnDownDateTime": "2117-12-19T11:37:29.739",
"name": "{{TUNNEL_NAME}}",
"protectionType": "PROTECTED",
"bfdInterval": "10msec",
"aisRefreshTimer": "10sec",
"endPointA": {
"networkElement": {
"name": "MCP-5142-200"
}
},
"endPointZ": {
"networkElement": {
"name": "MCP-5142-201"
}
},
"globalDiversity": {
"diversityLevel": "NODE_DIVERSE",
"selectionCriteria": "BEST_EFFORT"
}
}
}

Sample: link diversity constraints

{
"productId": "{{TUNNEL_FACADE_PID}}",
"label": "{{TUNNEL_NAME}}",
"properties": {
"turnUpDateTime": "2117-11-19T11:37:29.739",
"turnDownDateTime": "2117-12-19T11:37:29.739",
"name": "{{TUNNEL_NAME}}",
"protectionType": "PROTECTED",
"bfdInterval": "10msec",
"aisRefreshTimer": "10sec",
"endPointA": {
"networkElement": {
"name": "MCP-5142-200"
}
},
"endPointZ": {
"networkElement": {
"name": "MCP-5142-201"
}
},
"globalDiversity": {
"diversityLevel": "LINK_DIVERSE",
"selectionCriteria": "BEST_EFFORT"
}
}
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 797
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Delete a static MPLS-TP LSP tunnel (protected and unprotected)

by provisioning intent
Considerations

1. Best effort cleanup of configuration during undeploy/delete (failure in deletion of 1 NE or config will
not prevent deletion of config on the rest of the NEs).
2. If a service deployment has failed (it is in INCOMPLETE_DEPLOYMENT state), then trying delete will
do the following:
◦ Best effort cleanup of all devices will be attempted, including partial configs on NEs for which
deployment failed.
◦ All resources (facade, intent, expectations) will be deleted even if there are failures during
undeploy.
3. If service was deployed properly, attempting delete will do the following:
◦ Best effort cleanup of all devices will be attempted.
◦ If delete fails on a device then the resources (façade, intent, expectations) will NOT be deleted. The
user will still see a Service in “INCOMPLETE_UNDEPLOYMENT state.

To delete a static MPLS-TP tunnel, use the Market API.

Sample request

DELETE {{MCP_SERVER}}/bpocore/market/api/v1/resources/{resourceId}

Specify the resourceId (which you obtain from the request Create static MPLS-TP tunnel.

The tunnel is deleted from the NEs and MCP.

Retrieve dynamic MPLS-TP tunnels

This topic describes how to use the MCP REST API to retrieve:

• Retrieving a list of all tunnels

• Retrieving a single dynamic MPLS-TP tunnel

Retrieving a list of all tunnels

To retrieve all tunnels, includng dynamic tunnels, use the Services Inventory (FREs) API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 798
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Note: This call will also return any tunnel fragments that cannot be matched to a full, end-to-end tunnel.
Such tunnel fragments will start and end on the same endpoint.

Sample request

GET {{MCP_SERVER}}/nsi/api/fres

Ading particular filters after the "?" will restrict the returned list to tunnels, or a subset of tunnels. For
example:

• To view only MPLS tunnels:

GET {{MCP_SERVER}}/nsi/api/fres?layerRate=MPLS&type=link&include=tpes

• To view only MPLS protected tunnels:

GET {{MCP_SERVER}}/nsi/api/fres?layerRate=MPLS_PROTECTION&type=link&include=tpes

• To view only unidirectional MPLS tunnels (either FRR or FB):

GET {{BP_SERVER}}/nsi/api//v4/fres?serviceClass=Tunnel&directionality=unidirectional

In the returned list of TPEs, any tunnel for which the "signaled" attribute is set to "true" is a dynamic MPLS
tunnel. An example is shown below.

Sample response

{
"id": "-5998416297783219381",
"type": "fres",
"attributes": {
"operationState": "In Service",
"deploymentState": "discovered",
"derivedAttributes":
{ "intentLifeCyclePhase": "adopting discovered",
"intentDeploymentState": "waiting to adopt" }
,
"displayData":
{ "intentLifeCyclePhaseString": "Discovered" }
,
"resourceState": "discovered",
"bookingData":
{ "bandwidthLockout": false }
,
"userLabel": "",
"mgmtName": "VidyaOptDy8x",
"nativeName": "",
"layerRate": "MPLS_PROTECTION",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 799
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

],
"adminState": "In Service",
"maxReservableBandwidth": [
{
"layer": "ETHERNET",
"capacity": 1,
"capacitySize": {
"size": [
"0.01"
],
"pattern":
{ "type": "POOL", "format": "number" }
,
"unit": "mbps"
}
}
],
"active": true,
"additionalAttributes":
{ "BwAutoSizeIntervalMinutes": "5", "protectionRole": "All",
"BwUsedKbps": "0", "isActual": "true", "resiliency": "Normal", "BwMode": "cac",
"BwAutoSizeFailureAction": "alarm", "coRouted": "true", "signaled": "true",
"BwIncrKbps": "1", "lspName": "VidyaOptDy8x", "BwMinKbps": "10", "subType": "TP",
"BwAutoSize": "disable", "BwMaxKbps": "1000", "BwKbps": "10" }
,
"reliability": "manual"
},
"relationships": {
"endPoints": {
"data": [
{ "type": "endPoints", "id": "-5998416297783219381:1" }
,
{ "type": "endPoints", "id": "-5998416297783219381:2" }
]
},
"decomposedFres": {
"data": [
{ "type": "fres", "id": "-6609684594671338200" }
]
}
}
}

Retrieving a single dynamic MPLS-TP tunnel

To retrieve information regarding a specific dynamic MPLS tunnel, use the same Services Inventory
(FREs) API.

Sample request

GET {{BP_SERVER}}/nsi/api//v4/fres/<FRE_ID>

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 800
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"data": {
"id": "171631175079455910",
"type": "fres",
"attributes": {
"operationState": "In Service",
"deploymentState": "discovered",
"derivedAttributes": {
"intentLifeCyclePhase": "adopting discovered",
"intentDeploymentState": "waiting to adopt"
},
"displayData": {
"intentLifeCyclePhaseString": "Discovered",
"operationState": "Up",
"adminState": "Enabled"
},
"resourceState": "discovered",
"bookingData": {
"bandwidthLockout": false
},
"policies": {
"defaultAttributeSourcePolicy": "discoveredOverPlanned",
"overrides": [
{
"attributeName": "attributes.userLabel",
"policies": [
"plannedOverDiscovered"
]
}
]
},
"serviceClass": "Tunnel",
"userLabel": "",
"mgmtName": "dcrWconstrs1",
"nativeName": "",
"layerRate": "MPLS_PROTECTION",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"adminState": "In Service",
"mplsPackage": {
"lspName": "dcrWconstrs1",
"coRouted": true,
"signaled": true,
"subType": "TP",
"direction": "bidirectional",
"tunnelType": "rsvp-ingress-corout",
"ctrlPlaneId": "3.3.3.3_4.4.4.4_dcrWconstrs1",
"srcIp": "3.3.3.3",
"destIp": "4.4.4.4",
"nextHopIp": "13.101.2.1",
"RxTag": "32773",
"TxTag": "32805",
"tunnelRole": "headEnd",
"bw": {
"unit": "kbps",
"used": "0",
"minimum": "10",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 801
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"maximum": "100",
"increment": "1",
"requested": "10",
"operational": "10",
"autoSize": "enable",
"autoSizingMode": "cac",
"autoSizeFailureAction": "alarm",
"autoSizeIntervalMinutes": "5",
"autoSizeLastResizeState": "success"
},
"autoBackup": "off",
"diversityResource": "srlg",
"diversityLevel": "strict",
"bfd": {
"configured": true,
"profileName": "Active-LSP",
"adminState": "up",
"operationalState": "up",
"role": "active",
"transmitInterval": "100",
"receiveInterval": "100"
},
"explicitTunnel": {
"pathName": "MCP_RSVP_TE_PATH_3",
"hops": [
{
"hopAddress": "13.101.2.1",
"hopType": "loose"
},
{
"hopAddress": "24.101.7.2",
"hopType": "loose"
},
{
"hopAddress": "12.101.4.2",
"hopType": "strict"
}
]
},
"fixedTtl": "255",
"setupPriority": "0",
"holdPriority": "0",
"optimization": "off"
},

Create a dynamic MPLS-TP tunnel

This section includes the following topics:

• Retrieve an MPLS tunnel facade product ID

• Create a dynamic MPLS tunnel
• Create a dynamic MPLS tunnel with optimization enabled
• Creating a dynamic tunnel with routing constraints

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 802
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Blue Planet MCP Supports the provisioning of dynamic MPLS tunnels with the following devices acting as
Label Edge Routers (LERs) or Label Switched Routers (LSRs):

• SAOS 6.16.1+ nodes, including:

◦ 3938
◦ 3942
◦ 5142
◦ 5150
◦ 5160
◦ 5170 when MPLS capable
• SAOS 8.6+ nodes, including:
◦ 8700
◦ 8700 HD
• 6500 13.0+ nodes with Packet Fabric cards:
◦ 6500-T release 13.0 both in TIDC and non-TIDc configurations
◦ 6500 PTS release 13.0 in non-TIDc configuration

For information about MCP’s support for LAG endpoints and configuring constraints, see <<create-static-
mpls-tp-tunnel, Create static MPLS-TP tunnel>.

Retrieve an MPLS tunnel facade product ID

Begin by retrieving an MPLS tunnel facade product ID, using the Market API.

Sample request

GET {{MCP_SERVER}}/bpocore/market/api/v1/products

Sample response

For a sample response, see Retrieve L2 service intent facade product ID.

In the response, note the “ifd.v1.resourceTypes.MplsTunnelIntentFacade”. Use this ID as the “product Id”
in Create an MPLS tunnel facade.

Create a dynamic MPLS tunnel

To create an MPLS tunnel facade, use the Market API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 803
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

POST {{BP_SERVER}}/bpocore/market/api/v1/resources

Specify the productId, which you obtain from the response when you retrieved the MPLS tunnel facade
product ID.

The request is similar to that used to create a static tunnel, but supports a different set of parameters.
Note the following parameters used in the sample request below:

Table 16. Parameters used in the following example API call

PARAMETER ASSIGNED VALUE (OR SUPPORTED DESCRIPTION

VALUES)

signaledTunnel true Indicates that this is a dynamic

tunnel; if this parameters is false
or omitted then the request is for
a static tunnel.

protectionType UNPROTECTED This indicates that this will be an

unprotected tunnel.

Bandwidth parameters

The following bandwidth parameters are used in the "bandwidth" section.

When you create a dynamic tunnel, you do not configure a single, specific bandwidth. Instead, the NE
creates the tunnel with the minimum bandwidth value and will increment that bandwidth as required by
the services that are placed on it, up to the maximum bandwidth value. The parameters described
below configure this dynamic bandwidth.

dynamicTunnelMinBandwidth 2 The minimum bandwidth for the

tunnel.

dynamicTunnelMinBandwidthUni mbps The units for minimum

t bandwidth: kbps, mbps, or gbps.

assignedBandwidth 11 The maximum bandwidth for the

tunnel.

assignedBandwidthUnit mbps The units for maximum

bandwidth: kbps, mbps, or gbps.

dynamicTunnelBandwidthIncrem 15 The increment by which the

ents bandwidth can be adujsted.

dynamicTunnelBandwidthIncrem kbps the units for bandwidth

ents increment: kbps, mbps, or gbps.

dynamicTunnelBwAutoSize enable/disable Allow tunnel bw automatically

resized.

Auto-sizing bandwidth parameters

If dynamicTunnelBwAutoSize is enabled, then the following parameters can be also be configured:

dynamicTunnelBandwidthMode cac/utilization the bandwidth auto-resize mode

dynamicTunnelBwAutoSizeInterv 5-60 the tunnel bandwidth auto-resize

al interval

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 804
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

PARAMETER ASSIGNED VALUE (OR SUPPORTED DESCRIPTION

VALUES)

dynamicTunnelBwAutoSizeInterv minutes The tunnel bandwidth auto-

alUnits resize interval units; currently
only minutes is supported

dynamicTunnelBwAutoSizeFailur alarm or MBB (make before whether to generate an alarm or

eAction: alarm/MBB (make break) perform "make before break" if
before break) the auto-size attempt fails

Optimization parameters

For details and example of usage, see Create a dynamic MPLS tunnel with optimization enabled.

dynamicTunnelReOptimization DISABLE, MANUAL, PERIODIC DISABLE: do not allow manual

optimization or automatic
optimization by NE Control Plane

MANUAL: allow only manual

optimization (on demand by
user) through Immediate LSP
Optimization on co-routed
Dynamic Tunnels. Automatic
optimization by NE Control plane
will be disabled, In this case,
dynamicTunnelReOptimizationIn
terval is set to 0.

PERIODIC: Allow manual (on-

demand by user) and automatic
optimization by the NE Control
Plane. The
"dynamicTunnelReOptimizationI
nterval" parameter sets how
often the tunnel has to be
optimized by the NE Control
Plane.

dynamicTunnelReOptimizationIn 0 (if optimization is disabled), or Applicable when the

terval 5 to 60 "dynamicTunnelReOptimization"
parameter is set to "PERIODIC".

If optimization is disabled, the

only valid value is 0. When
optimization is enabled, possible
values are 5 to 60.

Note: The units these values

refer to are set by the
"dynamicTunnelReOptimizationI
ntervalUnit" property, which
currently supports only a value of
"minutes".

dynamicTunnelReOptimizationIn minutes The time unit for

tervalUnit dynamicTunnelReOptimizationIn
terval. The only valid value is
"minutes".

Routing constraint parameters

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 805
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

PARAMETER ASSIGNED VALUE (OR SUPPORTED DESCRIPTION

VALUES)

For information about these parameters and an example of usage, see Creating a dynamic tunnel with
routing constraints.

Note 1: the above parameters which have the prefix "dynamic" are supported only for dynamic tunnels)

Note 2: Bidirectional Forwarding Detection (BFD) must be enabled for all dynamic tunnels manage by
MCP. An attempt to create a tunnel with BFD disbled will be rejected.

POST : {{BP_SERVER}}/bpocore/market/api/v1/resources

Sample rquest:

{
"productId": "{{TUNNEL_FACADE_PID}}",
"label": "{{TUNNEL_NAME}}",
"properties": {
"turnDownDateTime": "2117-12-19T11:37:29.739",
"name": "{{TUNNEL_NAME}}",
"protectionType": "UNPROTECTED",
"signaledTunnel": true,
"bfdInterval": "100msec",
"bandwidth": {
"assignedBandwidth": 11,
"assignedBandwidthUnit": "mbps",
"dynamicTunnelMinBandwidth": 2,
"dynamicTunnelMinBandwidthUnit": "mbps",
"dynamicTunnelBandwidthIncrements": 15,
"dynamicTunnelBandwidthIncrementUnit": "kbps",
"dynamicTunnelBandwidthMode" : "cac",
"dynamicTunnelBwAutoSize" : "enable",
"dynamicTunnelBwAutoSizeInterval" : 5,
"dynamicTunnelBwAutoSizeIntervalUnits": "minutes",
"dynamicTunnelBwAutoSizeFailureAction": "alarm"
},
"endPointA": {
"networkElement": {
"name": "3930_SJ_20"
}
},
"endPointZ": {
"networkElement": {
"name": "3930_SJ_21"
}
}
}
}

Sample response:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 806
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "5a14b529-ae5e-4c45-87c7-fc7aa07d4df4",
"label": "DemoProtected14-55",
"resourceTypeId": "ifd.v3.resourceTypes.MplsTunnelIntentFacade",
"productId": "5a149209-f376-4a97-abc0-6d1a2ac40a05",
"tenantId": "8350352e-4b7f-45f9-b8e7-a471dac2e618",
"shared": false,
"properties": {
"name": "DemoProtected14-55",
"protectionType": "UNPROTECTED",
"bandwidth": {
"assignedBandwidth": 11,
"dynamicTunnelBandwidthMode": "cac",
"dynamicTunnelMinBandwidth": 2,
"dynamicTunnelBwAutoSize": "enable",
"dynamicTunnelBandwidthIncrements": 15,
"dynamicTunnelBandwidthIncrementUnit": "kbps",
"dynamicTunnelMinBandwidthUnit": "mbps",
"assignedBandwidthUnit": "mbps",
"dynamicTunnelBwAutoSizeFailureAction": "alarm",
"dynamicTunnelBwAutoSizeInterval": 5,
"dynamicTunnelBwAutoSizeIntervalUnits": "minutes"
},
"endPointA": {
"networkElement": {
"name": "3930_SJ_20"
}
},
"bfdInterval": "100msec",
"signaledTunnel": true,
"turnDownDateTime": "2117-12-19T11:37:29.739",
"endPointZ": {
"networkElement": {
"name": "3930_SJ_21"
}
}
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-11-21T23:22:18.235Z",
"createdAt": "2017-11-21T23:22:18.235Z",
"autoClean": false
}

Creating a dynamic tunnel with optimization enabled

Dynamic tunnel paths can be optimized after the tunnel has been created to make use of a new or
modified topology (whether new links, new NEs, or increased capacity). Tunnel re-optimization can be
triggered either manually, or automatically by the NE Control Plane.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 807
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

To enable optimization for a tunnel, configure the following parameters during tunnel provisioning.

PARAMETER DESCRIPTION

dynamicTunnelReOptimization DISABLE: do not allow manual optimization or

automatic optimization by NE Control Plane

MANUAL: allow only manual optimization (on

demand by user) through Immediate LSP
Optimization on co-routed Dynamic Tunnels.
Automatic optimization by NE Control plane will be
disabled, In this case,
dynamicTunnelReOptimizationInterval is set to 0.

PERIODIC: Allow manual (on-demand by user) and

automatic optimization by the NE Control Plane.
The "dynamicTunnelReOptimizationInterval"
parameter sets how often the tunnel has to be
optimized by the NE Control Plane.

dynamicTunnelReOptimizationInterval Applicable when the

"dynamicTunnelReOptimization" parameter is set
to "PERIODIC".

If optimization is disabled, the only valid value is 0.

When optimization is enabled, possible values are

5 to 60.

Note: The units these values refer to are set by the

"dynamicTunnelReOptimizationIntervalUnit"
property, which currently supports only a value of
"minutes".

dynamicTunnelReOptimizationIntervalUnit The time unit for

dynamicTunnelReOptimizationInterval. The only
valid value is "minutes".

The API call for provisioning a tunnel is described above. An example of an API call that includes the
optimization parameters is shown below.

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 808
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"aliasNames": [
{
"aliasType": "MANAGEMENT_NAME",
"name": "MyDynTn08"
}
],
"label": "myDynTn08",
"turnUpDateTime": "2117-11-19T11:37:29.739",
"layerRate": "MPLS_PROTECTION",
"protectionType": "UNPROTECTED",
"signaledTunnel": "true",
"bfdInterval": "100msec",
"bandwidth": {
"bookingFactor": 1,
"bandwidthLockout": false,
"assignedBandwidth": 10,
"assignedBandwidthUnit": "mbps",
"dynamicTunnelMinBandwidth": 1,
"dynamicTunnelMinBandwidthUnit": "mbps",
"dynamicTunnelBandwidthIncrements": 10,
"dynamicTunnelBandwidthIncrementUnit": "kbps",
"dynamicTunnelBandwidthMode" : "cac",
"dynamicTunnelBwAutoSize" : "enable",
"dynamicTunnelBwAutoSizeInterval" : 5,
"dynamicTunnelBwAutoSizeIntervalUnits": "minutes",
"dynamicTunnelBwAutoSizeFailureAction": "alarm"
},
"dynamicTunnelPathConstraints":{
"explicitTunnelPath": [
{
"hopAddress": "7.6.1.2",
"hopType": "MANDATORY"
},
{
"hopAddress": "7.7.2.1",
"hopType": "BEST_EFFORT"
}
],
"includeAllResourcesColorGroup": "colorGrpGreen",
"includeAnyResourcesColorGroup": "colorGrpRed",
"excludeAnyResourcesColorGroup": "colorGrpY"
},
"endPoints": [
{
"networkElement": {
"name": "8700-65"
}
},
{
"networkElement": {
"name": "MCP-8700-206"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 809
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Creating a dynamic tunnel with routing constraints

The MCP REST API supports several types of constraints that can shape the set of valid paths the Control
Plane can consider for the tunnel. These constraints can be defined when provisioning the tunnel.

Explicit routing constraints

You can specify a set of rsvp-te paths (as IP interfaces) that must be included in any tunnel path. This
constraint can be qualified as either mandatory or best-effort.

These paths can be a partial set of IPs or a full set of IPs and can be pre-created on the NE as part of
commissioning.

• This constraint can be specified for only the primary tunnels

• The hop-type can be either MANDATORY (strict) or BEST_EFFORT (loose).
◦ If hop-type is MANDATORY then the IP has to be a Interface IP
◦ If hop-type is BEST_EFFORT then the IP can be a loopback IP or Interface IP

Traffic Engineering constraints You can also specify Traffic Engineering parameters to shape valid tunnel
paths, in the form of an affinity (color-group) constraint. Tunnel paths must then include, or exclude, links
that support certain color groups. These color groups must be predefined on all nodes within the path.

When creating a dynamic tunnel, three types of Traffic Engineering constraint can be specified:

• include-all: constrains the path to links that contain all colors specified in the color group
• exclude-any: constrains the path to links that do not contain the colors specified in color group
• include-any: constrains the path to links that contains at a minimum one of color specified in color
group

All three of these constraints can be included for a single tunnel.

Constraint Details:

• The constraints can be specified for primary tunnel only, for backup tunnel "Diversity" options can be
used.
• The affinity (colors and color-groups) have to be pre-created and applied to the IP links (IP interface
level) as part of comissioning. The color-groups and colors have to be created uniformly across all
NEs. It is not sufficient to simply use the same grop names; the color group’s bitmask and each color’s
bit id must also match.
• During the tunnel creation, you must specifiy these color groups by their correct names.

The sample below shows part of an API request that includes both explicity IP routing and affinity
constraints.

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 810
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"aliasNames": [
{
"aliasType": "MANAGEMENT_NAME",
"name": "MyDynTn08"
}
],
"label": "myDynTn08",
"turnUpDateTime": "2117-11-19T11:37:29.739",
"layerRate": "MPLS_PROTECTION",
"protectionType": "UNPROTECTED",
"signaledTunnel": "true",
"bfdInterval": "100msec",
"bandwidth": {
"bookingFactor": 1,
"bandwidthLockout": false,
"assignedBandwidth": 10,
"assignedBandwidthUnit": "mbps",
"dynamicTunnelMinBandwidth": 1,
"dynamicTunnelMinBandwidthUnit": "mbps",
"dynamicTunnelBandwidthIncrements": 10,
"dynamicTunnelBandwidthIncrementUnit": "kbps",
"dynamicTunnelBandwidthMode" : "cac",
"dynamicTunnelBwAutoSize" : "enable",
"dynamicTunnelBwAutoSizeInterval" : 5,
"dynamicTunnelBwAutoSizeIntervalUnits": "minutes",
"dynamicTunnelBwAutoSizeFailureAction": "alarm"
},
"dynamicTunnelPathConstraints":{
"explicitTunnelPath": [
{
"hopAddress": "7.6.1.2",
"hopType": "MANDATORY"
},
{
"hopAddress": "7.7.2.1",
"hopType": "BEST_EFFORT"
}
],
"includeAllResourcesColorGroup": "colorGrpGreen",
"includeAnyResourcesColorGroup": "colorGrpRed",
"excludeAnyResourcesColorGroup": "colorGrpY"
},
"endPoints": [
{
"networkElement": {
"name": "8700-65"
}
},
{
"networkElement": {
"name": "MCP-8700-206"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 811
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Modify a dynamic MPLS co-routed tunnel

You can use the MCP REST API to modify various attributes of a dynamic MPLS co-routed tunnel,
including:

• Bandwidth properties
• auto-size properties:
• auto size Type ( CAC vs utilization is not editable )
• affinity constraints
• administrative state (enable/disable)
• setup/hold priorities

Note: Some properties cannot be modified unless the tunnel has first been disabled.

In the sample API calls below:

• BP_SERVER is the MCP server host name or IP address

• FACADE_ID is the tunnel facade ID

Edit Bandwidth

Use the Market API to edit a tunnel’s bandwidth.

POST {{BP_SERVER}}/bpocore/market/api/v1/resources/{{FACADE_ID}}/operations

Sample POST body

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 812
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"interface": "modify",
"inputs": {
"differences": [
{
"op": "add",
"path": "/properties/bandwidth/assignedBandwidth",
"value": 6
},
{
"op": "add",
"path": "/properties/bandwidth/assignedBandwidthUnit",
"value": "mbps"
},
{
"op": "add",
"path": "/properties/bandwidth/dynamicTunnelMinBandwidth",
"value": 6
},
{
"op": "add",
"path": "/properties/bandwidth/dynamicTunnelMinBandwidthUnit",
"value": "kbps"
},
{
"op": "add",
"path": "/properties/bandwidth/dynamicTunnelBandwidthIncrements",
"value": 6
},
{
"op": "add",
"path": "/properties/bandwidth/dynamicTunnelBandwidthIncrementUnit",
"value": "kbps"
},
{
"op": "add",
"path": "/properties/bandwidth/dynamicTunnelBwAutoSize",
"value": "enable"
},
{
"op": "add",
"path": "/properties/bandwidth/dynamicTunnelBwAutoSizeInterval",
"value": 6
},
{
"op": "add",
"path": "/properties/bandwidth/dynamicTunnelBwAutoSizeFailureAction",
"value": "mbb"
}
]
}
}

Parse the Operation OID, and use that value to retrieve the operation result. In the above sample, the OID
is: 5b28973e-71bf-4f3e-ac3c-863dbf1b04e5.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 813
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Sample POST result

{
"id": "5b28973e-71bf-4f3e-ac3c-863dbf1b04e5",
"resourceId": "5b270243-4930-4815-8767-0b20f74c0d7f",
"interface": "modify",
"inputs": {
"differences": [
{
"op": "add",
"path": "/properties/bandwidth/assignedBandwidth",
"value": 6
},
{
"op": "add",
"path": "/properties/bandwidth/assignedBandwidthUnit",
"value": "mbps"
},
{
"op": "add",
"path": "/properties/bandwidth/dynamicTunnelMinBandwidth",
"value": 6
},
{
"op": "add",
"path": "/properties/bandwidth/dynamicTunnelMinBandwidthUnit",
"value": "kbps"
},
{
"op": "add",
"path": "/properties/bandwidth/dynamicTunnelBandwidthIncrements",
"value": 6
},
{
"op": "add",
"path":
"/properties/bandwidth/dynamicTunnelBandwidthIncrementUnit",
"value": "kbps"
},
{
"op": "add",
"path": "/properties/bandwidth/dynamicTunnelBwAutoSize",
"value": "enable"
},
{
"op": "add",
"path": "/properties/bandwidth/dynamicTunnelBwAutoSizeInterval",
"value": 6
},
{
"op": "add",
"path":
"/properties/bandwidth/dynamicTunnelBwAutoSizeFailureAction",
"value": "mbb"
}
]
},
"outputs": {},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 814
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"state": "requested",
"reason": "",
"progress": [],
"providerData": {},
"createdAt": "2018-06-19T05:40:14.434Z",
"updatedAt": "2018-06-19T05:40:14.434Z",
"resourceStateConstraints": {},
"executionGroup": "lifecycle"
}

To see whether the operation has succeeded or failed, use the OID to retrieve the operation result:

POST {{BP_SERVER}}/bpocore/market/api/v1/resources/{{FACADE_ID}}/operations/{{OID}}

Edit setupPriority, holdPriority and softPreemption

Use the Market API to edit these parameters.

POST {{BP_SERVER}}/bpocore/market/api/v1/resources/{{FACADE_ID}}/operations

Sample POST body

{
"interface": "modify",
"inputs": {
"differences": [
{
"op": "add",
"path": "/properties/dynamicMplsTunnelAdditionalProperties/setupPriority",
"value": 5
},
{
"op": "add",
"path": "/properties/dynamicMplsTunnelAdditionalProperties/holdPriority",
"value": 5
},
{
"op": "add",
"path": "/properties/dynamicMplsTunnelAdditionalProperties/softPreemption",
"value": "disable"
}
]
}
}

Parse the Operation ID (OID) and use this value to retrieve the operation result. In the sample above, the
OID is: 5b289786-01a6-49d6-9b4d-c75486888d84.

Sample POST result

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 815
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "5b289786-01a6-49d6-9b4d-c75486888d84",
"resourceId": "5b270243-4930-4815-8767-0b20f74c0d7f",
"interface": "modify",
"inputs": {
"differences": [
{
"op": "add",
"path":
"/properties/dynamicMplsTunnelAdditionalProperties/setupPriority",
"value": 5
},
{
"op": "add",
"path":
"/properties/dynamicMplsTunnelAdditionalProperties/holdPriority",
"value": 5
},
{
"op": "add",
"path":
"/properties/dynamicMplsTunnelAdditionalProperties/softPreemption",
"value": "disable"
}
]
},
"outputs": {},
"state": "requested",
"reason": "",
"progress": [],
"providerData": {},
"createdAt": "2018-06-19T05:41:26.945Z",
"updatedAt": "2018-06-19T05:41:26.945Z",
"resourceStateConstraints": {},
"executionGroup": "lifecycle"
}

To see whether the operation has succeeded or failed, use the OID to retrieve the operation result:

POST {{BP_SERVER}}/bpocore/market/api/v1/resources/{{FACADE_ID}}/operations/{{OID}}

Edit Affinity

Use the Market API to edit a tunnel’s Affinity setting. Two samples using different affinity settings are
shown below.

POST {{BP_SERVER}}/bpocore/market/api/v1/resources/{{FACADE_ID}}/operations

POST Body Option 1

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 816
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"interface": "modify",
"inputs": {
"differences": [
{
"op": "add",
"path": "/properties/dynamicTunnelPathConstraints",
"value": {
"includeAllResourcesColorGroup": "cg-indigo",
"includeAnyResourcesColorGroup": "cg-indigo",
"excludeAnyResourcesColorGroup": "cg-red"
}
}
]
}
}

POST Body Option 2

{
"interface": "modify",
"inputs": {
"differences": [
{
"op": "add",
"path":
"/properties/dynamicTunnelPathConstraints/includeAllResourcesColorGroup",
"value": "cg-green"
},
{
"op": "add",
"path":
"/properties/dynamicTunnelPathConstraints/includeAnyResourcesColorGroup",
"value": "cg-green"
},
{
"op": "add",
"path":
"/properties/dynamicTunnelPathConstraints/excludeAnyResourcesColorGroup",
"value": "cg-red"
}
]
}
}

POST Result for option 1

Parse the Operation OID, and use that value to retrieve the operation result. In the above sample, the OID
is: 5b2896c9-6d3a-461a-83e8-4226d6aecb22

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 817
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "5b2896c9-6d3a-461a-83e8-4226d6aecb22",
"resourceId": "5b270243-4930-4815-8767-0b20f74c0d7f",
"interface": "modify",
"inputs": {
"differences": [
{
"op": "add",
"path": "/properties/dynamicTunnelPathConstraints",
"value": {
"includeAllResourcesColorGroup": "cg-indigo",
"includeAnyResourcesColorGroup": "cg-indigo",
"excludeAnyResourcesColorGroup": "cg-red"
}
}
]
},
"outputs": {},
"state": "requested",
"reason": "",
"progress": [],
"providerData": {},
"createdAt": "2018-06-19T05:38:17.558Z",
"updatedAt": "2018-06-19T05:38:17.558Z",
"resourceStateConstraints": {},
"executionGroup": "lifecycle"
}

To see whether the operation has succeeded or failed, use the OID to retrieve the operation result:

POST {{BP_SERVER}}/bpocore/market/api/v1/resources/{{FACADE_ID}}/operations/{{OID}}

Edit Optimization

Use the Market API to edit a tunnel’s Optimization settings.

POST {{BP_SERVER}}/bpocore/market/api/v1/resources/{{FACADE_ID}}/operations

Sample POST Body

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 818
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"interface": "modify",
"inputs": {
"differences": [
{
"op": "add",
"path": "/properties/dynamicTunnelReOptimizationInterval",
"value": 6
},
{
"op": "add",
"path": "/properties/dynamicTunnelReOptimization",
"value": "PERIODIC"
}
]
}
}

Sample POST Result

Parse the Operation OID, and use that value to retrieve the operation result. In the above sample, the OID
is: 5b28999c-8202-4e3d-82ac-462a10a1c81a

{
"id": "5b28999c-8202-4e3d-82ac-462a10a1c81a",
"resourceId": "5b270243-4930-4815-8767-0b20f74c0d7f",
"interface": "modify",
"inputs": {
"differences": [
{
"op": "add",
"path": "/properties/dynamicTunnelReOptimizationInterval",
"value": 6
},
{
"op": "add",
"path": "/properties/dynamicTunnelReOptimization",
"value": "PERIODIC"
}
]
},
"outputs": {},
"state": "requested",
"reason": "",
"progress": [],
"providerData": {},
"createdAt": "2018-06-19T05:50:20.997Z",
"updatedAt": "2018-06-19T05:50:20.997Z",
"resourceStateConstraints": {},
"executionGroup": "lifecycle"
}

To see whether the operation has succeeded or failed, use the OID to retrieve the operation result:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 819
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

POST {{BP_SERVER}}/bpocore/market/api/v1/resources/{{FACADE_ID}}/operations/{{OID}}

AdminState Enable/Disable

Editing a tunnel’s Administrative State (AdminState) uses the resource MplsOperationContainer. So, first
obtain an MplsOperationContainer resource ID.

GET
{{BP_SERVER}}/bpocore/market/api/v1/resources?exactTypeId=ifd.v5.resourceTypes.MplsOperationCon
tainer

Sample request

{
"items": [
{
"id": "5b326569-cf08-48ee-88cb-3ce419fb4fa1",
"label": "Resource for ifd.v5.resourceTypes.MplsOperationContainer",
"resourceTypeId": "ifd.v5.resourceTypes.MplsOperationContainer",
"productId": "5b32654e-82c9-48aa-9685-3ba76353dddd",
"tenantId": "024755a8-4872-4db4-b29f-7b210564ce66",
"shared": false,
"properties": {},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {
"templateResources": {}
},
"updatedAt": "2018-06-26T16:10:17.970Z",
"createdAt": "2018-06-26T16:10:17.705Z",
"autoClean": false
},

Parse the RID from the response. In this case: 5b326569-cf08-48ee-88cb-3ce419fb4fa1.

POST {{BP_SERVER}}/bpocore/market/api/v1/resources/{{RID}}/operations

Sample POST Body for Enable

The below API call includes the following parameters:

• freId: Tunnel top FRE ID.

• operation: enable or disable

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 820
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"interface": "modifyAdminState",
"inputs": {
"freId": "109^2E109^2E109^2E109_108^2E108^2E108^2E108_Demo13-5_TE",
"operation": "enable"
}
}

POST Result

Parse the Operation OID, and use that value to retrieve the operation result. In the above sample, the OID
is: 5b2897ef-e637-4f21-aa52-118c3ac05a5d.

{
"id": "5b2897ef-e637-4f21-aa52-118c3ac05a5d",
"resourceId": "5b1f09fc-89a7-4265-8b7b-1ae7488b47ef",
"interface": "modifyAdminState",
"inputs": {
"freId": "109^2E109^2E109^2E109_108^2E108^2E108^2E108_Demo13-5_TE",
"operation": "enable"
},
"outputs": {},
"state": "requested",
"reason": "",
"progress": [],
"providerData": {},
"createdAt": "2018-06-19T05:43:11.488Z",
"updatedAt": "2018-06-19T05:43:11.488Z",
"resourceStateConstraints": {},
"executionGroup": "lifecycle"
}

To see whether the operation has succeeded or failed, use the OID to retrieve the operation result:

POST {{BP_SERVER}}/bpocore/market/api/v1/resources/{{FACADE_ID}}/operations/{{OID}}

Delete a dynamic MPLS-TP tunnel

Considerations

1. MCP will perform a best-effort cleanup of the tunnel configuration during undeploy/delete. A failure to
delete the tunnel configuration on one NE will not prevent deletion of the same tunnel configuration on
the rest of the NEs).
2. If a tunnel deployment has failed (it is in an INCOMPLETE_DEPLOYMENT state), then trying delete the
tunnel will do the following:
◦ A best-effort cleanup of all devices will be attempted, including partial configurations on NEs for
which deployment failed.
◦ All resources (facade, intent, expectations) will be deleted even if there are failures during

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 821
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

undeploy.
3. If the tunnel was deployed properly, attempting delete will do the following:
◦ A best-effort cleanup of all devices will be attempted.
◦ If the deletion fails on a device then the resources (façade, intent, expectations) will NOT be
deleted. You will still see a tunnel in an “INCOMPLETE_UNDEPLOYMENT state.

To delete a dynamic MPLS-TP tunnel, begin by obtaining a Managed Container resource:

GET
{{BP_SERVER}}/bpocore/market/api/v1/resources?exactTypeId=ifd.v5.resourceTypes.ManagedServices
Container

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 822
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"items": [
{
"id": "5b4e39e2-f5b8-4ba9-b16e-e9ea1ce122b2",
"label": "Resource for ifd.v5.resourceTypes.ManagedServicesContainer",
"resourceTypeId": "ifd.v5.resourceTypes.ManagedServicesContainer",
"productId": "5b4e39d3-0dd2-40c8-9eaf-a516f61c29e4",
"tenantId": "729b91fd-a571-4538-85ad-4980a868647b",
"shared": false,
"properties": {},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {
"templateResources": {}
},
"updatedAt": "2018-07-17T18:48:02.264Z",
"createdAt": "2018-07-17T18:48:02.059Z",
"autoClean": false
},
{
"id": "5b4e39e3-1109-4ba2-ac70-81c144d42a07",
"label": "Resource for ifd.v5.resourceTypes.ManagedServicesContainer",
"resourceTypeId": "ifd.v5.resourceTypes.ManagedServicesContainer",
"productId": "5b4e39d3-0dd2-40c8-9eaf-a516f61c29e4",
"tenantId": "729b91fd-a571-4538-85ad-4980a868647b",
"shared": false,
"properties": {},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {
"templateResources": {}
},
"updatedAt": "2018-07-17T18:48:03.647Z",
"createdAt": "2018-07-17T18:48:03.250Z",
"autoClean": false
},

Multiple instances of the ManagedServicesContainer resources will be returned. For the Delete operation,
select one resource instance; for example, the first one, as the RID for the next step: 5b4e39e2-f5b8-4ba9-
b16e-e9ea1ce122b2

Next, delete the tunnel using an FRE ID:

POST {{BP_SERVER}}/bpocore/market/api/v1/resources/{{RID}}/operations

Sample body:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 823
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"interface": "manageService",
"inputs": {
"service": {
"managedOperation": "Delete",
"freId": "-4964036073725228033"
}
}
}

Retain the operation ID, since the custom operation is an ASYNC operation. In the example above, the
operation ID (OID) is: 589928bc-180a-45a9-aa57-58d9e5ea317a.

To check whether the operation was successful, use the OID to retrieve the operation result with a call
resembling the following:

GET {{BP_SERVER}}/bpocore/market/api/v1/resources/{{RID}}/operations/{{OID}}

The response will indicate whether the Delete operation was successful, or failed.

When successful, the tunnel is deleted from the supporting NEs and from the MCP database.

Unidirectional tunnels
The Blue Planet MCP REST API supports the discovery, inventory, provisioning, and management of
dynamic unidirectional MPLS TE tunnels.

Much like the dynamic co-routed tunnels that are also supported by MCP, dynamic TE tunnels are directly
provisioned only on the two tunnel endpoints. The tunnel routing between those endpoints is then
configured by the node-driven Control Plane and updats dynamically over time; this route is maintained as
a list of IP links that constitute the current tunnel path. The sizing and bandwidth properties and routing
constraints that are already used with dynamic co-routed tunnels also apply to unidirectional tunnels.

Protection for unidirectional tunnels is provided by Fast Rerouting (FRR) to a Facilty Bypass (FB) tunnel,
which provides an alternative path to replace a single failed link. Each unidirectional tunnel should have
access to an FRR profile, a list that is maintained on participating nodes of the protecting FB tunnels that
can be used in the place of failed links along the tunnel path.

FB tunnels are provsioned individually, and function themselves much like the unidirectional tunnels they
support; howver they are not intended to carry services normally. They serve exclusively as protective
entities for the unidirectional tunnels they support. However an FB tunnel is cleary identified during
provisioning as a protecting entity, and unlike conventional unidirectional tunnels they do not support
bandwidth properties or auto-sizing. Also, FB tunnels are not themselves protected.

Note: FB tunnels can also be automatically provisioned by nodes when required by unidirectional tunnels
that encounter a link failure.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 824
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Retrieve an inventory of unidirectional TE tunnels

You can use the MCP REST API to retrieve a list of all unidirectional TE tunnels in the managed network.

Use the NSI API to retreive the tunnel inventory. In the API call, include the following filters:

• serviceClass=Tunnel
• directionality=unidirectional

This results in an API call formatted like the following:

GET {{BP_SERVER}}/nsi/api//v4/fres?serviceClass=Tunnel&directionality=unidirectional

The response to this call will include all unidirectional TE and Faciilty Bypass (FB) tunnels.

Sample response:

{
"meta": {
"total": 68
},
"links": {
"next": "https://onc-bwen-
01.ciena.com/nsi/api/v4/fres?serviceClass=Tunnel&directionality=unidirectional&offs
et=30&limit=30",
"current": "https://onc-bwen-
01.ciena.com/nsi/api/v4/fres?serviceClass=Tunnel&directionality=unidirectional"
},
"data": [
{
"id": "107^2E107^2E107^2E107_108^2E108^2E108^2E108_APr11-50_TE",
"type": "fres",
"attributes": {
"operationState": "In Service",
"deploymentState": "discovered",
"identifiers": [
{
"networkConstructId": "e9410082-4a91-33ae-83a7-
d50b51fd7517",
"nodalId":
"107^2E107^2E107^2E107_108^2E108^2E108^2E108_APr11-50_TE"
}
],
"derivedAttributes": {
"intentLifeCyclePhase": "adopting discovered",
"intentDeploymentState": "waiting to adopt"
},
"displayData": {
"intentLifeCyclePhaseString": "Discovered",
"operationState": "Up",
"adminState": "Enabled"
},
"resourceState": "discovered",
"bookingData": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 825
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"bandwidthLockout": false
},
"policies": {
"defaultAttributeSourcePolicy": "discoveredOverPlanned",
"overrides": [
{
"attributeName": "attributes.userLabel",
"policies": [
"plannedOverDiscovered"
]
}
]
},
"serviceClass": "Tunnel",
"userLabel": "APr11-50",
"mgmtName": "APr11-50",
"layerRate": "MPLS",
"networkRole": "FREAP",
"directionality": "unidirectional",
"topologySources": [
"discovered",
"stitched"
],
"adminState": "In Service",
"signalContentType": "LSP",
"mplsPackage": {
"lspName": "APr11-50",
"coRouted": false,
"signaled": true,
"subType": "TE",
"direction": "unidirectional",
"ctrlPlaneId": "107.107.107.107_108.108.108.108_APr11-50",
"srcIp": "107.107.107.107",
"destIp": "108.108.108.108",
"bw": {
"unit": "kbps",
"used": "0",
"minimum": "1000",
"maximum": "3000",
"increment": "15",
"requested": "1000",
"operational": "1000",
"autoSize": "enable",
"autoSizingMode": "cac",
"autoSizeFailureAction": "alarm",
"autoSizeIntervalMinutes": "5"
},
"explicitRouteObject": [
"100.100.2.1",
"100.100.2.2"
],
"facilityBypass": false,
"frr": {
"frrProtected": true
}
},
"maxReservableBandwidth": [
{
"layer": "ETHERNET",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 826
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"capacity": 1,
"capacitySize": {
"size": [
"3.0"
],
"pattern": {
"type": "POOL",
"format": "number"
},
"unit": "mbps"
}
}
],
"active": true,
"additionalAttributes": {
"protectionRole": "primary",
"signalingState": "up",
"isActual": "true"
},
"domainTypes": [
"FRR"
],
"resilienceLevel": "protected"
},
"relationships": {
"freDiscovered": {
"data": {
"type": "freDiscovered",
"id": "107^2E107^2E107^2E107_108^2E108^2E108^2E108_APr11-
50_TE"
}
},
"endPoints": {
"data": [
{
"type": "endPoints",
"id":
"107^2E107^2E107^2E107_108^2E108^2E108^2E108_APr11-50_TE::EP0"
},
{
"type": "endPoints",
"id":
"107^2E107^2E107^2E107_108^2E108^2E108^2E108_APr11-50_TE::EP1"
}
]
},
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "e9410082-4a91-33ae-83a7-d50b51fd7517"
}
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "-5115278723235723991"
}
]

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 827
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

}
}
},
{
"id": "107^2E107^2E107^2E107_108^2E108^2E108^2E108_Auto_facility-6-
2001_TE",
"type": "fres",
"attributes": {
"operationState": "In Service",
"deploymentState": "discovered",
"identifiers": [
{
"networkConstructId": "e9410082-4a91-33ae-83a7-
d50b51fd7517",
"nodalId":
"107^2E107^2E107^2E107_108^2E108^2E108^2E108_Auto_facility-6-2001_TE"
}
],
"derivedAttributes": {
"intentLifeCyclePhase": "adopting discovered",
"intentDeploymentState": "waiting to adopt"
},
"displayData": {
"intentLifeCyclePhaseString": "Discovered",
"operationState": "Up",
"adminState": "Enabled"
},
"resourceState": "discovered",
"bookingData": {
"bandwidthLockout": false
},
"policies": {
"defaultAttributeSourcePolicy": "discoveredOverPlanned",
"overrides": [
{
"attributeName": "attributes.userLabel",
"policies": [
"plannedOverDiscovered"
]
}
]
},
"serviceClass": "Tunnel",
"userLabel": "Auto_facility-6-2001",
"mgmtName": "Auto_facility-6-2001",
"layerRate": "MPLS",
"networkRole": "FREAP",
"directionality": "unidirectional",
"topologySources": [
"discovered",
"stitched"
],
"adminState": "In Service",
"signalContentType": "LSP",
"mplsPackage": {
"lspName": "Auto_facility-6-2001",
"coRouted": false,
"signaled": true,
"subType": "TE",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 828
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"direction": "unidirectional",
"ctrlPlaneId": "107.107.107.107_108.108.108.108_Auto_facility-
6-2001",
"srcIp": "107.107.107.107",
"destIp": "108.108.108.108",
"bw": {
"unit": "kbps",
"used": "0",
"minimum": "0",
"maximum": "0",
"increment": "0",
"requested": "0",
"operational": "0",
"autoSize": "disable",
"autoSizingMode": "cac",
"autoSizeFailureAction": "alarm",
"autoSizeIntervalMinutes": "0"
},
"explicitRouteObject": [
"100.100.3.2"
],
"facilityBypass": true
},

You can also use the REST API to retrieve the list of FRR tunnels that are being protected by a given FB
tunnel.

Use the Market API for this call:

POST {{BP_SERVER}}/bpocore/market/api/v1/resources

With this call you can provide the FRE ID of an FB tunnel, and the call will return a list of FRR tunnels
supported by that FB tunnel. This requires two steps:

1. Create an asynchronous task (AsyncTask) that will retrieve the list

2. Retrieve the result of the AsyncTask.

Sample call body to create task

{
"productId": "{{PID}}",
"label": "getFbProtectedTunnels956",
"properties": {
"operationName": "getFbProtectedTunnels",
"objectId": "4.4.4.4_6.6.6.6_Auto_facility-2-2001_TE",
"input": {
}
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 829
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "5b10356b-9110-45a9-89d0-77febabad4ec",
"label": "getFbProtectedTunnels956",
"resourceTypeId": "ifd.v5.resourceTypes.AsyncTask",
"productId": "5b0efc15-a4f4-4df3-a2d8-078f80e2433e",
"tenantId": "ec5d7efe-9e19-4503-8402-b0fc8b78ba8c",
"shared": false,
"properties": {
"objectId": "4.4.4.4_6.6.6.6_Auto_facility-2-2001_TE",
"operationName": "getFbProtectedTunnels",
"input": {}
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2018-05-31T17:48:27.618Z",
"createdAt": "2018-05-31T17:48:27.618Z",
"autoClean": false
}

Retrieve the AsyncTask execution result using the following API call:

GET {{BP_SERVER}}/bpocore/market/api/v1/resources/5b1028cf-b3c7-4d6e-a4dd-de9199bfb0d9

Sample response

{
"items": [
{
"id": "5b103ae6-983b-4673-a6fa-40bf68d9d060",
"label": "getFbProtectedTunnels956",
"resourceTypeId": "ifd.v5.resourceTypes.AsyncTask",
"productId": "5b06566a-5e7f-40ec-b9c2-463c5ae83156",
"tenantId": "89a13712-c857-4364-b7e8-ec30d37861af",
"shared": false,
"properties": {
"startTime": "2018-05-31T18:11:51.488273+0000",
"state": "completed",
"stateData": {
"state": "completed",
"freId": "1.1.1.1_4.4.4.4_Auto_facility-47-2008_TE",
"startTime": "2018-05-31 18:11:51.491552+00:00"
},
"endTime": "2018-05-31T18:12:35.603145+0000",
"objectId": "1.1.1.1_4.4.4.4_Auto_facility-47-2008_TE",
"maximumTime": 30,
"output": {
"data": [
{
"relationships": {
"freDiscovered": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 830
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"data": {
"type": "freDiscovered",
"id": "1.1.1.1_6.6.6.6_K1-Ucons-lpbk_TE"
}
},
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "1.1.1.1_6.6.6.6_K1-Ucons-
lpbk_TE::EP0"
},
{
"type": "endPoints",
"id": "1.1.1.1_6.6.6.6_K1-Ucons-
lpbk_TE::EP1"
}
]
},
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "2d5b56cf-6f2e-3436-a1bf-
776ceaec245b"
}
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "67a42211-14f0-34ad-96f1-
1b6158782303::FRE_1_EQPTGRP_41_MPLS_K1-Ucons-lpbk_transit_32779_32826_1.1.1.1"
},
{
"type": "fres",
"id": "6009473649510034634"
},
{
"type": "fres",
"id": "de94fa9a-060c-33f6-b852-
6c94d06308f2::FRE_1_EQPTGRP_41_MPLS_K1-Ucons-lpbk_transit_32826_32786_1.1.1.1"
},
{
"type": "fres",
"id": "6236978574003829479"
},
{
"type": "fres",
"id": "-406428413080187401"
}
]
}
},
"attributes": {
"additionalAttributes": {
"resiliency": "Protected",
"isActual": "true"
},
"userLabel": "K1-Ucons-lpbk",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 831
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"signalContentType": "LSP",
"serviceClass": "Tunnel",
"topologySources": [
"discovered"
],
"deploymentState": "discovered",
"derivedAttributes": {
"intentDeploymentState": "waiting to adopt",
"intentLifeCyclePhase": "adopting discovered"
},
"directionality": "unidirectional",
"identifiers": [
{
"nodalId": "1.1.1.1_6.6.6.6_K1-Ucons-
lpbk_TE",
"networkConstructId": "2d5b56cf-6f2e-3436-
a1bf-776ceaec245b"
}
],
"maxReservableBandwidth": [
{
"layer": "ETHERNET",
"capacitySize": {
"pattern": {
"type": "POOL",
"format": "number"
},
"unit": "mbps",
"size": [
"2.0"
]
},
"capacity": 1
}
],
"resourceState": "discovered",
"operationState": "In Service",
"displayData": {
"operationState": "Up",
"adminState": "Enabled",
"intentLifeCyclePhaseString": "Discovered"
},
"adminState": "In Service",
"mplsPackage": {
"direction": "unidirectional",
"destIp": "6.6.6.6",
"facilityBypass": false,
"signaled": true,
"subType": "TE",
"lspName": "K1-Ucons-lpbk",
"bw": {
"bwMinKbps": "2000",
"bwIncrKbps": "2",
"bwUsedKbps": "0",
"bwAutoSizeIntervalMinutes": "8",
"bwMaxKbps": "2000",
"bwMode": "cac",
"bwAutoSize": "enable",
"bwAutoSizeFailureAction": "alarm"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 832
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

},
"srcIp": "1.1.1.1",
"explicitRouteObject": [
"13.101.2.1",
"13.101.2.2",
"34.101.10.2",
"46.101.11.2"
],
"coRouted": false,
"ctrlPlaneId": "1.1.1.1_6.6.6.6_K1-Ucons-lpbk"
},
"layerRate": "MPLS",
"mgmtName": "K1-Ucons-lpbk",
"policies": {
"defaultAttributeSourcePolicy":
"discoveredOverPlanned",
"overrides": [
{
"attributeName":
"attributes.userLabel",
"policies": [
"plannedOverDiscovered"
]
}
]
},
"networkRole": "FREAP",
"active": true,
"bookingData": {
"bandwidthLockout": false
}
},
"type": "fres",
"id": "1.1.1.1_6.6.6.6_K1-Ucons-lpbk_TE"
}
]
},
"operationName": "getFbProtectedTunnels",
"input": {}
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {
"templateResources": {}
},
"updatedAt": "2018-05-31T18:12:35.661Z",
"createdAt": "2018-05-31T18:11:51.001Z",
"autoClean": false
}
],
"total": 1,
"offset": 0,
"limit": 1000
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 833
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Similarly, you can use the API to retrieve the set of protecting FB tunnels associated with an FRR tunnel.

By providing the top FRR ID of a unidirectional protected tunnel, you can retrieve:

• data
◦ id: MPLS top FREAP ID
◦ type: frrProtections
◦ attributes:
▪ frrProtection:
▪ primaryPath: IP link FREAPs of the primary path
▪ activePath: FREAPs of IP links and FB tunnels
▪ protections: a list of nodal protection
▪ NetworkContruct
▪ ip
▪ protectionAvailable: true/false
▪ protectionType: link-protect, node-protect, none
▪ protectionInUse: true/false
▪ protectionFbName: FB tunnel name
▪ protectionFb
• included:
◦ A list of referred IP link FREAPs, FB Tunnel FREAPs and NetworkConstructs

First, obtain an AsynTask’s product ID:

POST {{BP_SERVER}}/bpocore/market/api/v1/resources

Sample body

{
"productId": "{{PID}}",
"label": "getUnidirTunnelProtectionInfo1109",
"properties": {
"operationName": "getUnidirTunnelProtectionInfo",
"objectId": "1.1.1.1_6.6.6.6_anUni5to6_TE",
"input": {
}
}
}

Sample output

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 834
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "5b1028cf-b3c7-4d6e-a4dd-de9199bfb0d9",
"label": "getUnidirTunnelProtectionInfo1109",
"resourceTypeId": "ifd.v5.resourceTypes.AsyncTask",
"productId": "5b0efc15-a4f4-4df3-a2d8-078f80e2433e",
"tenantId": "ec5d7efe-9e19-4503-8402-b0fc8b78ba8c",
"shared": false,
"properties": {
"objectId": "1.1.1.1_6.6.6.6_anUni5to6_TE",
"operationName": "getUnidirTunnelProtectionInfo",
"input": {}
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2018-05-31T16:54:40.004Z",
"createdAt": "2018-05-31T16:54:40.004Z",
"autoClean": false
}

Retrieve the AsyncTask execution result using a call resembling the following:

GET {{BP_SERVER}}/bpocore/market/api/v1/resources/5b1028cf-b3c7-4d6e-a4dd-de9199bfb0d9

Incomplete tunnels in the inventory

An incomplete tunnel is a set of tunnel segments that do not yet constitute a full, end-to-end path because
either the head endpoint, tail endpoint, or both are not yet defined or discovered.

When you retrieve the data for a complete tunnel, there are two indications that the tunnel is complete:

• the topologySources: ["discovered", "stitched"]

• the FRE’s endpoint with role z has a populated relationships; the tailEnd exists and so the tailEnd
reference link is a hard link that points to the tailEnd TPE.

When you retrieve a partial tunnel’s data using the API, there are two inidcations in the response that
indicate that the tunnel is incomplete:

• topologySources: ["discovered"]
• The FRE’s endpoint with role z has empty relationships; the tailEnd does not exist, and so the tailEnd
reference link is a soft link.

For example, the following is an incomplete tunnel:

{
"data": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 835
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"id": "1^2E1^2E1^2E1_2^2E2^2E2^2E2_DYNAMIC-UNIDIR-1-1_TE",
"type": "fres",
"attributes": {
"operationState": "In Service",
"deploymentState": "discovered",
"identifiers": [
{
"networkConstructId": "2d5b56cf-6f2e-3436-a1bf-776ceaec245b",
"nodalId": "1^2E1^2E1^2E1_2^2E2^2E2^2E2_DYNAMIC-UNIDIR-1-1_TE"
}
],
"derivedAttributes": {
"intentLifeCyclePhase": "adopting discovered",
"intentDeploymentState": "waiting to adopt"
},
"displayData": {
"intentLifeCyclePhaseString": "Discovered",
"operationState": "Up",
"adminState": "Enabled"
},
"resourceState": "discovered",
"bookingData": {
"bandwidthLockout": false
},
"policies": {
"defaultAttributeSourcePolicy": "discoveredOverPlanned",
"overrides": [
{
"attributeName": "attributes.userLabel",
"policies": [
"plannedOverDiscovered"
]
}
]
},
"serviceClass": "Tunnel",
"userLabel": "DYNAMIC-UNIDIR-1-1",
"mgmtName": "DYNAMIC-UNIDIR-1-1",
"layerRate": "MPLS",
"networkRole": "FREAP",
"directionality": "unidirectional",
"topologySources": [
"discovered"
],
"adminState": "In Service",
"signalContentType": "LSP",
"mplsPackage": {
"lspName": "DYNAMIC-UNIDIR-1-1",
"coRouted": false,
"signaled": true,
"subType": "TE",
"direction": "unidirectional",
"ctrlPlaneId": "1.1.1.1_2.2.2.2_DYNAMIC-UNIDIR-1-1",
"srcIp": "1.1.1.1",
"destIp": "2.2.2.2",
"bw": {
"unit": "kbps",
"used": "0",
"minimum": "0",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 836
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"maximum": "1000000000",
"increment": "0",
"requested": "0",
"autoSize": "enable",
"autoSizingMode": "cac",
"autoSizeFailureAction": "alarm",
"autoSizeIntervalMinutes": "0"
},
"facilityBypass": false,
"frr": {
"frrProtected": false
}
},
"maxReservableBandwidth": [
{
"layer": "ETHERNET",
"capacity": 1,
"capacitySize": {
"size": [
"1000000.0"
],
"pattern": {
"type": "POOL",
"format": "number"
},
"unit": "mbps"
}
}
],
"active": true,
"additionalAttributes": {
"signalingState": "down",
"isActual": "true",
"resiliency": "Normal"
},
"resilienceLevel": "unprotected"
},
"relationships": {
"freDiscovered": {
"data": {
"type": "freDiscovered",
"id": "1^2E1^2E1^2E1_2^2E2^2E2^2E2_DYNAMIC-UNIDIR-1-1_TE"
}
},
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "1^2E1^2E1^2E1_2^2E2^2E2^2E2_DYNAMIC-UNIDIR-1-
1_TE::EP0"
},
{
"type": "endPoints",
"id": "1^2E1^2E1^2E1_2^2E2^2E2^2E2_DYNAMIC-UNIDIR-1-
1_TE::EP1"
}
]
},
"networkConstruct": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 837
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"data": {
"type": "networkConstructs",
"id": "2d5b56cf-6f2e-3436-a1bf-776ceaec245b"
}
}
}
},
"included": [
{
"id": "1^2E1^2E1^2E1_2^2E2^2E2^2E2_DYNAMIC-UNIDIR-1-1_TE::EP0",
"type": "endPoints",
"attributes": {
"role": "z",
"directionality": "transmit egress",
"associations": [
{
"relationship": "tpes",
"identifier": {
"logicalId": "1^2E1^2E1^2E1_2^2E2^2E2^2E2_DYNAMIC-
UNIDIR-1-1_TE"
}
}
]
},
"relationships": {}
},
{
"id": "1^2E1^2E1^2E1_2^2E2^2E2^2E2_DYNAMIC-UNIDIR-1-1_TE::EP1",
"type": "endPoints",
"attributes": {
"role": "a",
"directionality": "receive ingress"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "2d5b56cf-6f2e-3436-a1bf-
776ceaec245b::TPE_1_CTPServerToClient_EQPTGRP_41_LSP_DYNAMIC-UNIDIR-1-
1_headEnd_1^2E1^2E1^2E1"
}
]
}
}
}
]
}

This is the return for the same tunnel once it is complete:

{
"data": {
"id": "2^2E2^2E2^2E2_1^2E1^2E1^2E1_DYNAMIC-UNIDIR-1-1_TE",
"type": "fres",
"attributes": {
"operationState": "In Service",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 838
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"deploymentState": "discovered",
"identifiers": [
{
"networkConstructId": "6c66c638-7a81-31c2-8a47-a6a0c480a7b7",
"nodalId": "2^2E2^2E2^2E2_1^2E1^2E1^2E1_DYNAMIC-UNIDIR-1-1_TE"
}
],
"derivedAttributes": {
"intentLifeCyclePhase": "adopting discovered",
"intentDeploymentState": "waiting to adopt"
},
"displayData": {
"intentLifeCyclePhaseString": "Discovered",
"operationState": "Up",
"adminState": "Enabled"
},
"resourceState": "discovered",
"bookingData": {
"bandwidthLockout": false
},
"policies": {
"defaultAttributeSourcePolicy": "discoveredOverPlanned",
"overrides": [
{
"attributeName": "attributes.userLabel",
"policies": [
"plannedOverDiscovered"
]
}
]
},
"serviceClass": "Tunnel",
"userLabel": "DYNAMIC-UNIDIR-1-1",
"mgmtName": "DYNAMIC-UNIDIR-1-1",
"layerRate": "MPLS",
"networkRole": "FREAP",
"directionality": "unidirectional",
"topologySources": [
"discovered",
"stitched"
],
"adminState": "In Service",
"signalContentType": "LSP",
"mplsPackage": {
"lspName": "DYNAMIC-UNIDIR-1-1",
"coRouted": false,
"signaled": true,
"subType": "TE",
"direction": "unidirectional",
"ctrlPlaneId": "2.2.2.2_1.1.1.1_DYNAMIC-UNIDIR-1-1",
"srcIp": "2.2.2.2",
"destIp": "1.1.1.1",
"bw": {
"unit": "kbps",
"used": "0",
"minimum": "0",
"maximum": "1000000000",
"increment": "0",
"requested": "0",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 839
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"operational": "0",
"autoSize": "disable",
"autoSizingMode": "cac",
"autoSizeFailureAction": "alarm",
"autoSizeIntervalMinutes": "0"
},
"explicitRouteObject": [
"12.101.5.1"
],
"facilityBypass": false,
"frr": {
"frrProtected": false
}
},
"maxReservableBandwidth": [
{
"layer": "ETHERNET",
"capacity": 1,
"capacitySize": {
"size": [
"0.0"
],
"pattern": {
"type": "POOL",
"format": "number"
},
"unit": "mbps"
}
}
],
"active": true,
"additionalAttributes": {
"signalingState": "up",
"isActual": "true",
"resiliency": "Normal"
},
"resilienceLevel": "unprotected"
},
"relationships": {
"freDiscovered": {
"data": {
"type": "freDiscovered",
"id": "2^2E2^2E2^2E2_1^2E1^2E1^2E1_DYNAMIC-UNIDIR-1-1_TE"
}
},
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "2^2E2^2E2^2E2_1^2E1^2E1^2E1_DYNAMIC-UNIDIR-1-
1_TE::EP0"
},
{
"type": "endPoints",
"id": "2^2E2^2E2^2E2_1^2E1^2E1^2E1_DYNAMIC-UNIDIR-1-
1_TE::EP1"
}
]
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 840
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "6c66c638-7a81-31c2-8a47-a6a0c480a7b7"
}
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "-3937143407364792189"
}
]
}
}
},
"included": [
{
"id": "2^2E2^2E2^2E2_1^2E1^2E1^2E1_DYNAMIC-UNIDIR-1-1_TE::EP0",
"type": "endPoints",
"attributes": {
"role": "z",
"directionality": "transmit egress",
"associations": [
{
"relationship": "tpes",
"identifier": {
"logicalId": "2^2E2^2E2^2E2_1^2E1^2E1^2E1_DYNAMIC-
UNIDIR-1-1_TE"
}
}
]
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "2d5b56cf-6f2e-3436-a1bf-
776ceaec245b::TPE_1_CTPServerToClient_EQPTGRP_41_LSP_DYNAMIC-UNIDIR-1-
1_tailEnd_2^2E2^2E2^2E2"
}
]
}
}
},
{
"id": "2^2E2^2E2^2E2_1^2E1^2E1^2E1_DYNAMIC-UNIDIR-1-1_TE::EP1",
"type": "endPoints",
"attributes": {
"role": "a",
"directionality": "receive ingress"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "6c66c638-7a81-31c2-8a47-

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 841
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

a6a0c480a7b7::TPE_1_CTPServerToClient_EQPTGRP_41_LSP_DYNAMIC-UNIDIR-1-
1_headEnd_2^2E2^2E2^2E2"
}
]
}
}
}
]
}

Create a unidirectional FRR tunnel

Blue Planet MCP supports the provisioning of MPLS-TE unidirectional tunnels with Fast Reroute (FRR)
protection with endpoints on 6500 13.0 Packet Fabric cards.

MCP supports the provisioning of dynamic MPLS unidirectional tunnels using the following devices as
LER or LSRs:

• 6500-T release 13.0 both in TIDc and non-TIDc configurations

• 6500 PTS release 13.0 in non-TIDc configuration
• 5170, when MPLS capable

This topic includes the following sections:

• Obtaining a tunnel product ID

• Provisioning a unidirectional FRR tunnel
• Optional parameters during tunnel provisioning
• Provisioning a unidirectional FB tunnel
• Editing tunnel properties

Restrictions

The auto-fb-profile (for auto generated fb tunnel) and FRR profiles (tunnel-frr-profile) must already have
been created on the participating nodes (usually as part of commissioning)

Bidirectional Forwarding Detection (BFD) must be enabled for all dynamic tunnels manage by MCP. An
attempt to create a tunnel with BFD disbled will be rejected.

Unidirectional FRR tunnels do not support LSP-BFD; they support only IP-BFD. An IP-BFD profile should be
set up on the endpoint nodes (usually as part of commissioning).

The primary tunnel name cannot end with "_facility" or start with "Auto_facility", as these are reserved for
Facility Bypass (FB) tunnels

Prerequisites

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 842
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

• Loopback IPs, all required Interface IPs should be configured

• Configure and enable protocols - rsvp-te, LDP, ISIS or OSPF and IP-interfaces
• Set dynamic MPLS tunnel label ranges uniformly
◦ > mpls dynamic-label-range set …
• Create IP-BFD for the Ip-interfaces needed
◦ > bfd session create session bfd_ip_56 neighbor 56.56.56.1 profile MCP_BFD_Active_ms100
• Enable PLR:
◦ > mpls frr set plr-support enable
• To auto-generate facility bypass (FB) tunnels use following CLI commands
◦ > mpls frr set facility-bypass-autogeneration enable
◦ > mpls frr set auto-fb-cleanup-hold-time <NUMBER: 0..3600>
• If needed, create an auto-fb profile:
◦ > mpls tunnel-auto-fb-profile create …
◦ > mpls tunnel-auto-fb-profile show
• If needed, create an FRR profile:
◦ > mpls tunnel-auto-fb-profile create
◦ > mpls tunnel-auto-fb-profile show

Provisioning the unidirectional tunnel has two steps:

1. Obtain a tunnel Product ID.

2. Use this ID to create the tunnel.

Obtaining a tunnel product ID

Use the Market API to obtain a tunnel product ID:

GET {{BP_SERVER}}/bpocore/market/api/v1/products

sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 843
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"items": [
{
"id": "5b4e39d3-5dd3-4a1b-95e0-d6144d7c8408",
"resourceTypeId": "ifd.v5.resourceTypes.MplsTunnelIntentFacade",
"title": "product for ifd.v5.resourceTypes.MplsTunnelIntentFacade",
"active": true,
"domainId": "built-in",
"constraints": {},
"providerData": {
"template": "ifd.v5.serviceTemplates.MplsTunnelIntentFacade"
}
}
],
"total": 126,
"offset": 0,
"limit": 1000
}

Extract the Product ID by matching the resourceTypeId to "ifd.v5.resourceTypes.MplsTunnelIntentFacade"

Provisioning a unidirectional FRR tunnel

Once you have the tunnel Product ID, use the following API all to create the unidirectional FRR protected
tunnel:

POST {{BP_SERVER}}/bpocore/market/api/v1/resources

Sample body

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 844
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"productId": "{{TUNNEL_FACADE_PID}}",
"label": "{{TUNNEL_NAME}}",
"properties": {
"turnDownDateTime": "2117-12-19T11:37:29.739",
"name": "{{TUNNEL_NAME}}",
"protectionType": "UNPROTECTED",
"signaledTunnel": true,
"directionality": "unidirectional",
"dynamicMplsTunnelFrr": {
"frrProtected": true,
"frrProfile": "DefaultFrrProfile"
},
"dynamicMplsTunnelAdditionalProperties": {
"setupPriority" : 3,
"holdPriority" : 4,
"softPreemption" : "enable"
},
"dynamicTunnelPathConstraints":{
"explicitTunnelPath": [
{
"hopAddress": "14.101.3.2",
"hopType": "BEST_EFFORT"
},
{
"hopAddress": "46.101.11.2",
"hopType": "BEST_EFFORT"
}
]
},
"bandwidth": {
"bookingFactor": 1,
"bandwidthLockout": false,
"assignedBandwidth": 11,
"assignedBandwidthUnit": "mbps",
"dynamicTunnelMinBandwidth": 2,
"dynamicTunnelMinBandwidthUnit": "mbps",
"dynamicTunnelBandwidthIncrements": 15,
"dynamicTunnelBandwidthIncrementUnit": "kbps",
"dynamicTunnelBandwidthMode" : "cac",
"dynamicTunnelBwAutoSize" : "enable",
"dynamicTunnelBwAutoSizeInterval" : 5,
"dynamicTunnelBwAutoSizeIntervalUnits": "minutes",
"dynamicTunnelBwAutoSizeFailureAction": "alarm"
},
"endPointA": {
"networkElement": {
"name": "SIM1"
}
},
"endPointZ": {
"networkElement": {
"name": "SIM6"
}
}
}
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 845
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Optional parameters during tunnel provisioning

You can include soft or hard pre-emption parameters in the call, resembling the following:

"dynamicMplsTunnelAdditionalProperties": {
"setupPriority" : 3,
"holdPriority" : 4,
"softPreemption" : "enable"
},

Affinity constraints resemble the following:

"dynamicTunnelPathConstraints": {
"includeAllResourcesColorGroup": "cg-indigo",
"includeAnyResourcesColorGroup": "cg-indigo",
"excludeAnyResourcesColorGroup": "cg-red"
},

Explicit path constraints resemble the following:

"dynamicTunnelPathConstraints":{
"explicitTunnelPath": [
{
"hopAddress": "14.101.3.2",
"hopType": "BEST_EFFORT"
},
{
"hopAddress": "46.101.11.2",
"hopType": "BEST_EFFORT"
}
]
},

Provisioning a unidirectional FB tunnel

The API call used to provision an FB tunnel resembles that used to provision a conventional unidirectional
tunnel, but uses the following attribute values to distinguish the FB tunnel as a purely protective entity:

• facilityBypassTunnel is set to true

• dynamicMplsTunnelFb is used to specify the FB tunnel related configuration

Sample body

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 846
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"productId": "{{TUNNEL_FACADE_PID}}",
"label": "{{TUNNEL_NAME}}",
"properties": {
"turnDownDateTime": "2117-12-19T11:37:29.739",
"name": "{{TUNNEL_NAME}}",
"protectionType": "UNPROTECTED",
"signaledTunnel": true,
"directionality": "unidirectional",
"facilityBypassTunnel": true,
"dynamicMplsTunnelFb": {
"protectedInterface": "IP-PORT106",
"excludeIp": "12.101.5.2"
},
"dynamicMplsTunnelAdditionalProperties": {
"setupPriority" : 3,
"holdPriority" : 4,
"softPreemption" : "enable"
},
"bandwidth": {
"bookingFactor": 1,
"bandwidthLockout": false,
"assignedBandwidth": 11,
"assignedBandwidthUnit": "mbps",
"dynamicTunnelMinBandwidth": 2,
"dynamicTunnelMinBandwidthUnit": "mbps",
"dynamicTunnelBandwidthIncrements": 15,
"dynamicTunnelBandwidthIncrementUnit": "kbps"
},

"endPointA": {
"networkElement": {
"name": "SIM1"
}
},
"endPointZ": {
"networkElement": {
"name": "SIM2"
}
}
}
}

Note the following parameters that can be used within the API call to configure additinal unidirectional
tunnel properties:

Configure a setup priority value for a unidirectional Fast Reroute (FRR) tunnel:

"ifd.lsp.dynamicUniFrrTunnelSetupPriority":{
"default": "5",
"supportedValues": "0-7",
"description": "The setup priority value to be used for creating Dynamic
Unidirectional FRR Tunnel"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 847
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Configure a hold priority value for a unidirectional Fast Reroute (FRR) tunnel

"ifd.lsp.dynamicUniFrrTunnelHoldPriority":{
"default": "5",
"supportedValues": "0-7",
"description": "The hold priority value to be used for creating Dynamic
Unidirectional FRR Tunnel"
},

Enable or disable soft pre-emption for a unidirectional Fast Reroute (FRR) tunnel

"ifd.lsp.dynamicUniFrrTunnelEnableSoftPreemption":{
"default": "true",
"supportedValues": "true, false",
"description": "Enabled/Disable soft-preemption during creation of Dynamic
Unidirectional FRR Tunnel"
},

Configure a setup priority value for a Facility Bypass (FB) tunnel:

"ifd.lsp.dynamicUniFbTunnelSetupPriority":{
"default": "7",
"supportedValues": "0-7",
"description": "The setup priority value to be used for creating Dynamic
Unidirectional FB Tunnel"
},

Configure a hold priority value for a Facility Bypass (FB) tunnel:

"ifd.lsp.dynamicUniFbTunnelHoldPriority":{
"default": "2",
"supportedValues": "0-7",
"description": "The hold priority value to be used for creating Dynamic
Unidirectional FB Tunnel"
},

"ifd.lsp.dynamicUniFbTunnelEnableSoftPreemption":{
"default": "true",
"supportedValues": "true, false",
"description": "Enabled/Disable soft-preemption during creation of Dynamic
Unidirectional FB Tunnel"
}

Editing tunnel properties

To edit any of the tunnel’s properties, use the fllowing GET and PATCH calls.

First issue a GET call to retrieve the necessary ID:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 848
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

GET {{BP_SERVER}}/bpocore/market/api/v1/resources?exactTypeId=ifd.v5.resourceTypes.IfdConfig

Note the "ID" value in the response to the above call, and use it in a PATCH request to edit the
configuration property as shown below below.

PATCH BP_SERVER/bpocore/market/api/v1/resources/RESOURCE_ID_V5_IFD_CONFIG

{
"properties": {
"configurationProperties": {
"ifd.lsp.dynamicUniFrrTunnelSetupPriority":{ "value": "3" }

}
}
}

Manage a unidirectional tunnel

You can use the MCP API to perform the following management operations on a unidirectional tunnel.

Refresh states

You can use the REST API to refresh tunnel state data in MCP. The method is the same for unidirectional
tunnels as for other dynamic tunnels.

For the procedure to refresh state and other data for an MPLS tunnel, see Refreshing properties for links
and tunnels.

Immediately optimize the tunnel

You can use the REST API to immediately optimize a dynamic FRR or FB tunnel so that it makes the best
use of current network resources.

For the procedure to immediately optimize an MPLS tunnel, see Manually invoke an immediate
optimization for a unidirectional tunnel

Retrieve the path of a tunnel

You can use the REST API to retrieve the latest information about FRR and FB tunnels. For an FRR tunnel,
this includes the set of FB tunnels that are supporting it. For an FB tunnel, this includes the list of FRR
tunnels that it supports.

For the procedure to retrieve the latest path data for a tunnel, see Manually invoke an immediate
optimization for a unidirectional tunnel

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 849
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Resize the LSP

You can use the REST API to resize an LSP, including a unidirectional FRR or FB tunnel. "Re-sizing" a
dynamic tunnel increases or decreases the associated LSP bandwidth to reflect the committed service
load. Although a tunnel configured to auto-resize will perform this operation automatically given time, you
can use this procedure to trigger the resize operation immediately.

The steps to resize a unidirectional tunnel using the API follows the same sequence as for any dynamic
MPLS tunnel. For the procedure to resize an LSP, see Perform LSP resize for a dynamic MPLS tunnel.

Retrieve / view LLDP link bandwidth properties

To retrieve and view bandwidth properties, use the Services Inventory (FREs) API.

Sample request

GET {{MCP_SERVER}}/nsi/api/fres

Sample response

{
"data": {
"id": "-3372689638961213769",
"type": "fres",
"attributes": {
"userLabel": "",
"mgmtName": "",
"nativeName": "",
"layerRate": "ETHERNET",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"adjacency"
],
"signalContentType": "mac_transport",
"userData": {
"bandwidthBookingFactor": "1",
"bandwidthBookingLockout": "false"
},
"maxReservableBandwidth": [
{
"layer": "ETHERNET",
"capacity": 1,
"capacitySize": {
"size": [
"1000"
],
"pattern": {
"type": "POOL",
"format": "number"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 850
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

},
"unit": "mbps"
}
}
],
"usedBandwidth": [
{
"layer": "ETHERNET",
"capacity": 1,
"capacitySize": {
"size": [
"1000"
],
"pattern": {
"type": "POOL",
"format": "number"
},
"unit": "mbps"
}
}
],
"additionalAttributes": {
"isActual": "true"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "-3372689638961213769:1"
},
{
"type": "endPoints",
"id": "-3372689638961213769:2"
}
]
}
}
},
"included": [
{
"id": "-3372689638961213769:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "56ce5ae8-5ac3-34eb-b28b-05e89385aed6::TPE_8_PTP"
}
]
}
}
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 851
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

...,

}
}
]
}

For details, see the section “maxReservableBandwidth” and “usedBandwidth” in the Sample response.

Edit link bandwidth properties

To edit link bandwidth properties, use the Services inventory (FREs) API.

Sample request

PUT {{MCP_SERVER}}/nsi/api/fres/<freID>/bookingData/<bookingDataKey>

Specify the new attribute value, as applicable. The attributes that can be modified are as follows:

• "assignedBandwidth"
• "assignedBandwidthUnit"
• "bandwidthLockout" (for example, true or false)
• "bookingFactor"

Note: The <bookingDataKey> in the PUT URL relates to the attributes listed above.

Sample response

No textual response except HTTP status code

Modify static MPLS-TP co-routed LSP tunnels

To modify the attributes of a static MPLS-TP co-routed tunnel, use the Market API.

To modify the tunnel, use following POST API call described below.

POST {{MCP_SERVER}}/bpocore/market/api/v1/resources/{{TUNNEL_FACADE_ID}}/operations

You can use this call to make the following modifications to an existing tunnel (identified by
{{TUNNEL_FACADE_ID}})

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 852
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

• modify AIS timer

• modify BFD interval
• disable AIS
• disable BFD
• modify reversion properties
• modify protection path
• add a backup tunnel path (optionally with a constraint or with explicit routing)

You can also modify bandwidth and call admission control (CAC) properties (including assigned
bandwidth, booking factor, and bandwidth lockout); these are described separately in Modify MPLS-TP
LSP tunnel bandwidth call admission control (CAC).

Requirements You must know the following values before issuing this call:

• TUNNEL_FACADE_ID: the tunnel’s facade ID

• OID (where indicated): the operation ID from a previous POST operation.

Viewing results of modification Due to the asynchronous nature of custom operations, you should use a
GET call to retrieve the operation result.

The original operation to modify the tunnel will return the tunnel OID. Use that value to retrieve details for
the modified tunnel:

GET {{BP_SERVER}}/bpocore/market/api/v1/resources/{{TUNNEL_FACADE_ID}}/operations/{{OID}}

Sample requests

Sample request: update AIS timer and BFD interval

{
"interface": "modify",
"inputs": {
"differences": [
{
"op": "add",
"path": "/properties/aisRefreshTimer",
"value": "20sec"
},
{
"op": "add",
"path": "/properties/bfdInterval",
"value": "1sec"
}
]
}
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 853
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Sample request: disable AIS timer and BFD interval

{
"interface": "modify",
"inputs": {
"differences": [
{
"op": "add",
"path": "/properties/aisRefreshTimer",
"value": ""
},
{
"op": "add",
"path": "/properties/bfdInterval",
"value": ""
}
]
}
}

Sample request: update tunnel reversion

{
"interface": "modify",
"inputs": {
"differences": [
{
"op": "add",
"path": "/properties/autoReversionPossible",
"value": true
},
{
"op": "add",
"path": "/properties/waitToRevertDelay",
"value": 180
},
{
"op": "add",
"path": "/properties/reversionTimeUnit",
"value": "seconds"
}
]
}
}

Sample request: add a backup tunnel path

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 854
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"interface": "modify",
"inputs": {
"differences": [
{
"op": "replace",
"path": "/properties/protectionType",
"value": "PROTECTED"
}
]
}
}

Sample request: add a backup tunnel path with constraint

{
"interface": "modify",
"inputs": {
"differences": [
{
"op": "replace",
"path": "/properties/protectionType",
"value": "PROTECTED"
},
{
"op": "add",
"path": "/properties/routingConstraints/1",
"value": {
"includeRouteObjects": [
{
"objectType": "NODE_NAME",
"value": ["MCP-8700-206"]
}
]
}
}
]
}
}

Add a backup tunnel to an MPLS-TP co-routed tunnel

To modify the attributes of a static MPLS-TP co-routed tunnel, use the Market API.

To modify the tunnel, use following POST API call described below.

POST {{MCP_SERVER}}/bpocore/market/api/v1/resources/{{TUNNEL_FACADE_ID}}/operations

You can use this call to add a backup tunnel to an existing, unprotected tunnel. You identify the

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 855
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

unprotected tunnel within the call by its {{TUNNEL_FACADE_ID}}.

This topic shows example requests to add a backup tunnel:

• without specifying ports

• with explicit ports
• without routing constraints
• with routing constraints
• with explicit routing constraints
• specifying a backup tunnel name

Requirements You must know the following values before issuing this call:

• TUNNEL_FACADE_ID: the tunnel’s facade ID

Viewing results of modification Due to the asynchronous nature of custom operations, you should use a
GET call to retrieve the operation result.

The original operation to modify the tunnel will return the tunnel OID. Use that value to retrieve details for
the modified tunnel:

GET
{{BP_SERVER}}/bpocore/market/api/v1/resources/{{TUNNEL_FACADE_ID}}/operations/
{{OID}}

Sample requests

Sample request: adding a backup tunnel without explicit ports

{ "interface": "modify",
"inputs": {
"differences": [
{
"op": "replace",
"path": "/properties/protectionType",
"value": "PROTECTED"
}
]
}
}

Sample request: adding a backup tunnel with explicit ports

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 856
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{ "interface": "modify",
"inputs": {
"differences": [
{
"op": "replace",
"path": "/properties/protectionType",
"value": "PROTECTED"
},
{
"op": "add",
"path": "/properties/endPointA/backup",
"value": {
"port": "8"
}
},
{
"op": "add",
"path": "/properties/endPointZ/backup",
"value": {
"port": "9"
}
}
]
}
}

Sample request: adding a backup tunnel with routing constraints

In this example, the original, unprotected tunnel was created without routing constraints.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 857
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{ "interface": "modify",
"inputs": {
"differences": [
{
"op": "replace",
"path": "/properties/protectionType",
"value": "PROTECTED"
},
{
"op": "add",
"path": "/properties/routingConstraints",
"value": [
{},
{
"includeRouteObjects": [
{
"objectType": "NODE_NAME",
"value": [
"A",
"B"
]
},
{
"objectType": "NODE_NAME",
"value": [
"C",
"D"
]
}
]
}
]
}
]
}
}

In this example, the original, unprotected tunnel was created with routing constraints.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 858
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"interface": "modify",
"inputs": {
"differences": [
{
"op": "replace",
"path": "/properties/protectionType",
"value": "PROTECTED"
},
{
"op": "add",
"path": "/properties/routingConstraints/1",
"value": {
"includeRouteObjects": [
{
"objectType": "NODE_NAME",
"value": ["MCP-8700-206"]
}
]
}
}
]
}
}

Sample request: adding a backup tunnel with explicit constraints

{
"interface": "modify",
"inputs": {
"differences": [
{
"op": "replace",
"path": "/properties/protectionType",
"value": "PROTECTED"
},
{
"op": "add",
"path": "/properties/routingConstraints/1",
"value": {
"excludeRouteObjects": [
{
"objectType": "NODE_NAME",
"value": ["MCP-8700-206"]
}
]
}
}
]
}
}

Sample request: adding a backup tunnel and specifying a tunnel name

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 859
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"interface": "modify",
"inputs": {
"differences": [
{
"op": "replace",
"path": "/properties/protectionType",
"value": "PROTECTED"
},
{
"op": "add",
"path": "/properties/backupPathName",
"value": "Backup-sankar-9"
}
]
}
}

Modify MPLS-TP LSP tunnel bandwidth call admission control

(CAC)
To modify the bandwidth CAC properties for an MPLS-TP tunnel, use the Market API.

*PATCH {{BP_SERVER}}/bpocore/market/api/v1/resources/{{config_resource_id}}

When the tunnel bandwidth CAC is off, no bandwidth CAC will be performed during tunnel creation or
tunnel bandwidth modification.

When the tunnel bandwidth CAC is on, bandwidth CAC will be applied to tunnel creation and tunnel
bandwidth modification.

When bandwidth CAC is on, the tunnel creation with bandwidth will be validated by PCE path finding. The
PCE path will be selected only if (assignedBW x bookingFactor) is less than or equal to the minimal link
available BW along the path.

When editing a tunnel’s assigned bandwidth, the booking factor and lockout can be modified, subject to
the following restrictions:

• When decreasing bandwidth, if (new assignedBW x bookingFactor) is greather than or equal to the
current usedBW, then the decrease is allowed; otherwise, it is disallowed.
• When increasing bandwidth, if the increased bandwidth amount is less than or equal to the minimal
link available bandwidth along the path, the increase is allowed.
• When increasing bandwidth, if the increased bandwidth amount is greater than the minimal link
available bandwidth along the path, but (new assignedBW x bookingFactor) is less than or equal to the
current usedBW, then the increase is allowed; otherwise, it is disallowed.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 860
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Retrieving an IfdConfig ID and modifying tunnel CAC configuration

To modify a tunnel, first use the the GET API call described below to obtain the ifdConfig resource ID for
the service you plan to alter. The following GET call should retrieve one IfdConfig resource:

GET {{BP_SERVER}}/bpocore/market/api/v1/resources?exactTypeId=ifd.v2.resourceTypes.IfdConfig

Extract the resource ID from the result and use the resource ID for the subsequent PATCH request. In the
sample response below, the IfdConfig resource ID is 592e633d-1d00-481e-a019-3b2d9d83d4de

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 861
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"items": [
{
"id": "592e633d-1d00-481e-a019-3b2d9d83d4de",
"label": "Resource for ifd.v2.resourceTypes.IfdConfig",
"resourceTypeId": "ifd.v2.resourceTypes.IfdConfig",
"productId": "592e6328-1451-4ea4-995b-63f4e31309ba",
"tenantId": "697827c1-cdf6-4433-9d0f-2c565ba05be8",
"shared": false,
"properties": {
"configurationProperties": {
"ifd.l2.autoReversionPossible": {
"default": "true",
"supportedValues": "true, false",
"description": "Whether Auto Reversion is Possible for Protected
Pseudowire.",
"value": "true"
},
"ifd.l2.cac": {
"default": "on",
"supportedValues": "on, off",
"description": "Flag to turn on L2 service bandwidth CAC.",
"value": "on"
},
"ifd.lsp.cac": {
"default": "on",
"supportedValues": "on, off",
"description": "Flag to turn on MPLS tunnel bandwidth CAC.",
"value": "on"
},
"ifd.l2.protectionScheme": {
"default": "ONE_PLUS_ONE",
"supportedValues": "ONE_FOR_ONE, ONE_PLUS_ONE",
"description": "Protection scheme for Protected Pseudowire.",
"value": "ONE_PLUS_ONE"
}
}
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-05-31T06:31:29.658Z",
"createdAt": "2017-05-31T06:31:25.704Z",
"autoClean": false
}
],
"total": 1,
"offset": 0,
"limit": 1000
}

Then issue the following PATCH call to modify the CAC settings for the tunnel.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 862
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

PATCH {{BP_SERVER}}/bpocore/market/api/v1/resources/{{config_resource_id}}

For example, the following call will disable CAC for the tunnel:

Sample request: disable CAC

{
"properties": {
"configurationProperties": {
"ifd.lsp.cac": {
"value": "off"
}
}
}
}

Viewing results of modification Due to the asynchronous nature of custom operations, you should use a
GET call to retrieve the operation result.

The original operation to modify the tunnel will return the tunnel OID. Use that value to retrieve details for
the modified tunnel:

GET {{BP_SERVER}}/bpocore/market/api/v1/resources/{{TUNNEL_FACADE_ID}}/operations/{{OID}}

Adding and modifying tunnel bandwidth properties

Sample request: add bandwidth properties Use this call to add bandwidth properties to a tunnel for which
they are not currently defined. These properties include:

• assigned bandwidth
• assigned bandwidth unit
• booking factor
• bandwidth lockout

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 863
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"interface": "modify",
"inputs": {
"differences": [
{
"op": "add",
"path": "/properties/bandwidth",
"value": {
"assignedBandwidth": 300,
"assignedBandwidthUnit": "mbps",
"bookingFactor": 1,
"bandwidthLockout": true
}
}
]
}
}

Sample request: modify tunnel bandwidth Provided bandwidth properties are already defined for a tunnel,
you can use a call like the one shown below to modify these properties.

If the bandwidth properties are not yet defined, use the Add Tunnel Bandwidth call described above to
define them first.

{
"interface": "modify",
"inputs": {
"differences": [
{
"op": "add",
"path": "/properties/bandwidth/assignedBandwidth",
"value": 399
},
{
"op": "add",
"path": "/properties/bandwidth/assignedBandwidthUnit",
"value": "mbps"
},
{
"op": "add",
"path": "/properties/bandwidth/bookingFactor",
"value": 3.99
},
{
"op": "add",
"path": "/properties/bandwidth/bandwidthLockout",
"value": true
}
]
}

Sample response (for a failed operation)

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 864
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "592316b5-a071-4312-8a57-fe5198a0022e",
"resourceId": "59231685-623c-49fc-be28-5d0f167ad917",
"interface": "modify",
"inputs": {...},
"outputs": {},
"state": "failed",
"reason": "Failed task(s): (1) modify: Failed plan 'modify' (exit code:
42):\n:\n'NoneType' object has no attribute '__getitem__'",
"createdAt": "2017-05-22T16:49:57.420Z",
"updatedAt": "2017-05-22T16:49:58.606Z",
"resourceStateConstraints": {}
}

Sample response (for a successful operation)

{
"id": "592316b5-a071-4312-8a57-fe5198a0022e",
"resourceId": "59231685-623c-49fc-be28-5d0f167ad917",
"interface": "modify",
"inputs": {...},
"outputs": {},
"state": "successful",
"reason": "",
"createdAt": "2017-05-22T18:32:15.694Z",
"updatedAt": "2017-05-22T18:32:21.538Z",
"resourceStateConstraints": {}
}

Promote discovered LSP tunnels / EVCs to modify or delete -

Manual
Discovered MCP services are not manageable by MCP and cannot be deleted or modified. Service
promotion is designed to make discovered services manageable by MCP. After the promotion, these
services will behave just like the ones created via MCP.

As a user, you want the ability to modify and delete 'discovered' LSP tunnels and EVCs (i.e. discovered
'services' with no intent) so you can properly manage your L2 network. This includes:

• Ability to manually promote a discovered LSP tunnel which does not have an intent and have intent
generated for the LSP tunnel
• Ability to manually promote a discovered EVC service which does not have an intent and have intent
generated for the EVC
• Promoted tunnels and EVCs can be modified or deleted in the same way as can MCP created tunnels
and EVCs

Note: Service is a general term used here that represents MPLS tunnels (transport services) and L2/L0
services.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 865
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

This section includes the following topics:

• Promote an MPLS tunnel/LSP

• Promote an L2 service

Promote an MPLS tunnel/LSP

To promote an MPLS tunnel/LSP, use the Market API.

Request = POST {{MCP_SERVER}}/bpocore/market/api/v1/resources/{{RID}}/operations

The following apply:

• FRE ID provided must be an MPLS Tunnel top FRE AP ID.

• "settings" with bandwidth information is optional.
• Tunnel bandwidth info can be always updated later.

Sample request

{
"interface": "promoteService",
"inputs": {
"service": {
"freId": "5713422440907523218"
},
"settings": {
"lsp": {
"bandwidth": {
"assignedBandwidth": 180,
"assignedBandwidthUnit": "mbps",
"bookingFactor": 1.8,
"bandwidthLockout": false
}
}
}
}
}

Promotion is an asynchronous operation. The immediate return of a promotion is as follows:

• id is the operation ID and needs to be extracted for later result query as OID.
• state could be in one of the following: executing, pending, requested

Sample immediate promote tunnel response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 866
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "58ffb8bc-777f-462c-8858-3d536cf82ed1",
"resourceId": "58fd866d-5436-4dd1-b6e2-edfb19b592b6",
"interface": "promoteService",
"inputs": {...},
"outputs": {},
"state": "requested",
"reason": "",
"createdAt": "2017-04-25T20:59:40.773Z",
"updatedAt": "2017-04-25T20:59:40.773Z",
"resourceStateConstraints": {}
}

To retrieve the final promotion result, use the following GET:

Request = GET {{MCP_SERVER}}/bpocore/market/api/v1/resources/{{RID}}/operations/{{OID}}

state should be:

• successful (for success case)

• failed (for failed case)

Sample final promote tunnel response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 867
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"inputs": {
"service": {
"serviceType": "LSP",
"deploymentState": "discovered",
"managementName": "Bo_202-203_UP_11-50",
"userLabel": "",
"freId": "-8171524784057169337",
"details": {}
}
},
"resourceId": "58fd866c-a124-4dde-95c1-7275281ef9ec",
"updatedAt": "2017-04-24T07:15:23.728Z",
"reason": "",
"resourceStateConstraints": {},
"state": "successful",
"outputs": {
"result": {
"status": "succeeded",
"serviceType": "LSP",
"deploymentState": "discovered",
"managementName": "Bo_202-203_UP_11-50",
"userLabel": "",
"intentFacadeId": "58fda5fb-3dca-43fe-8147-98ad1b1bbb56",
"freId": "-8171524784057169337",
"details": {},
"intentIds": [
"58fda5fe-f9e3-4d33-b778-65474ef09b60"
],
"message": ""
}
},
"interface": "promoteService",
"id": "58fda5e8-3ba8-42b1-b3c5-a99929c48840",
"createdAt": "2017-04-24T07:14:48.128Z"
}

Promote an L2 service

To promote an L2 service, use the Market API.

Request = POST {{MCP_SERVER}}/bpocore/market/api/v1/resources/{{RID}}/operations

The following apply:

• FRE ID provided must be an L2 service top iFRE ID.

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 868
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"interface": "promoteService",
"inputs": {
"service": {
"freId": "{{FRE_ID}}"
}
}
}

The rest of the steps are the same as for tunnel promotion: getting the immediate response and getting
the final promotion result.

Perform tunnel group protection switch

You can move traffic away from the currently active LSP to allow the performance of disruptive
maintenance on the path currently carrying traffic. This operation is supported on both static and dynamic
tunnels.

As part of this switch operation:

• The user can switch traffic without specifying the desired outcome, in which case MCP will switch
traffic away from the currently active LSP.
• The user can specify the desire to switch and the newly designated active tunnel, in which case MCP
will ensure that the switch operation is performed if required.

Note: Through API it is possible to specify the desired outcome; i.e you can specify whether the primary
or backup should be active as part of the switch operation.

This section includes the following topics:

• Retrieve the MplsOperationContainer resource ID

• Execute the tunnel group protection switch
• Retrieve the status of the tunnel group protection switch

Retrieve the MplsOperationContainer resource ID

To retrieve the MplsOperationContainer resource ID, use the Market API.

Sample request

GET
{{MCP_SERVER}}/bpocore/market/api/v1/resources?exactTypeId=ifd.v2.resourceTypes.MplsOperation

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 869
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Container

Sample response

{
"items": [
{
"id": "5955a92c-a8fa-4337-9036-875eafe449c2",
"label": "Resource for ifd.v2.resourceTypes.MplsOperationContainer",
"resourceTypeId": "ifd.v2.resourceTypes.MplsOperationContainer",
"productId": "5955a910-5b13-4c6f-b8bc-32a5b80662ae",
"tenantId": "748d7633-80b7-4d1a-98e5-aa27e38ccdb3",
"shared": false,
"properties": {},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-06-30T01:28:13.249Z",
"createdAt": "2017-06-30T01:28:12.558Z",
"autoClean": false
},
{
"id": "5955a92d-1f6a-4b41-aa36-8019be2dfd84",
"label": "Resource for ifd.v2.resourceTypes.MplsOperationContainer",
"resourceTypeId": "ifd.v2.resourceTypes.MplsOperationContainer",
"productId": "5955a910-5b13-4c6f-b8bc-32a5b80662ae",
"tenantId": "748d7633-80b7-4d1a-98e5-aa27e38ccdb3",
"shared": false,
"properties": {},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-06-30T01:28:15.786Z",
"createdAt": "2017-06-30T01:28:14.392Z",
"autoClean": false
},
{
"id": "5955a92f-219f-440b-8be1-a1507bda8e83",
"label": "Resource for ifd.v2.resourceTypes.MplsOperationContainer",
"resourceTypeId": "ifd.v2.resourceTypes.MplsOperationContainer",
"productId": "5955a910-5b13-4c6f-b8bc-32a5b80662ae",
"tenantId": "748d7633-80b7-4d1a-98e5-aa27e38ccdb3",
"shared": false,
"properties": {},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 870
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"tags": {},
"providerData": {},
"updatedAt": "2017-06-30T01:28:17.995Z",
"createdAt": "2017-06-30T01:28:16.443Z",
"autoClean": false
},
{
"id": "5955a933-0811-4e98-9676-1b243e3b5c59",
"label": "Resource for ifd.v2.resourceTypes.MplsOperationContainer",
"resourceTypeId": "ifd.v2.resourceTypes.MplsOperationContainer",
"productId": "5955a910-5b13-4c6f-b8bc-32a5b80662ae",
"tenantId": "748d7633-80b7-4d1a-98e5-aa27e38ccdb3",
"shared": false,
"properties": {},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-06-30T01:28:21.620Z",
"createdAt": "2017-06-30T01:28:19.593Z",
"autoClean": false
},
{
"id": "5955a936-cfe0-4c4d-9a03-bdbde2ecaf09",
"label": "Resource for ifd.v2.resourceTypes.MplsOperationContainer",
"resourceTypeId": "ifd.v2.resourceTypes.MplsOperationContainer",
"productId": "5955a910-5b13-4c6f-b8bc-32a5b80662ae",
"tenantId": "748d7633-80b7-4d1a-98e5-aa27e38ccdb3",
"shared": false,
"properties": {},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-06-30T01:28:23.742Z",
"createdAt": "2017-06-30T01:28:22.469Z",
"autoClean": false
}
],
"total": 5,
"offset": 0,
"limit": 1000
}

In the response, you can find the list of MplsOperationContainer resources.

• Every resource in the response will have an attribute named "id".

• You can pick one resource from the returned list of resources and use the value of id property to
execute the tunnel group protection switch.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 871
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Execute the tunnel group protection switch

To execute the tunnel group protection switch, use the Market API.

Request = POST {{MCP_SERVER}}/bpocore/market/api/v1/resources/{{RID}}/operations

Sample request

{
"interface": "protectionSwitch",
"inputs": {
"freId": "-3770626729195966017",
"switchToTunnelRole" : "primary"
}
}

A list of parameters and related descriptions follows.

Table 17. Parameters and description

PARAMETER DESCRIPTION

interface protectionSwitch as the default value for this

operation.

inputs Input data for the protection switch operation.

freId Tunnel group fre ID.

switchToTunnelRole This is the attribute which the user can use to

specify the desired outcome.

Possible values:

• primary (MCP will convert primary tunnel to be

active).
• backup (MCP will convert backup tunnel to be
active).

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 872
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "5956d1d6-d0e1-45d7-a636-587815eb9736",
"resourceId": "5955a92d-1f6a-4b41-aa36-8019be2dfd84",
"interface": "protectionSwitch",
"inputs": {
"freId": "-3770626729195966017",
"switchToTunnelRole": "primary"
},
"outputs": {},
"state": "requested",
"reason": "",
"createdAt": "2017-06-30T22:33:58.889Z",
"updatedAt": "2017-06-30T22:33:58.889Z",
"resourceStateConstraints": {}
}

Note: The “id” in the response (above) is the protection switch operation id.

Use this id to:

• Retrieve the status of the tunnel group protection switch operation.

Retrieve the status of the tunnel group protection switch

Note: The following apply:

• RID is the MplsOperationContainer resource ID used as part of executing the protection switch
operation.
• OID is the operation ID generated as part of tunnel group protection switch operation.

To retrieve the status of the tunnel group protection switch, use the Market API.

Sample request

GET {{MCP_SERVER}}/bpocore/market/api/v1/resources/{{NIWF_ID}}/operations/{{OID}}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 873
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "5956d1d6-d0e1-45d7-a636-587815eb9736",
"resourceId": "5955a92d-1f6a-4b41-aa36-8019be2dfd84",
"interface": "protectionSwitch",
"inputs": {
"freId": "-3770626729195966017",
"switchToTunnelRole": "primary"
},
"outputs": {},
"state": "successful",
"reason": "",
"createdAt": "2017-06-30T22:33:58.889Z",
"updatedAt": "2017-06-30T22:34:04.846Z",
"resourceStateConstraints": {}
}

A list of parameters and related descriptions follows.

Table 18. Parameters and description

PARAMETER DESCRIPTION

id Protection switch operation ID.

state Values can be:

• successful
• failed
• aborted

Perform LSP protection switch on link

From an API perspective, the user can define whether this operation is the best effort or not.

• In the case of best effort, the LSP switch would still proceed and the user is given the list of tunnels
that could not be switched.
• If the operation is not best effort, the operation should fail if some LSPs cannot be switched away.

This section includes the following topics:

• Retrieve the NodeInsertionWorkflow product ID

• Create the NodeInsertionWorkflow resource
• Execute the ProtectionSwitch operation
• Get the status of ProtectionSwitch operation

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 874
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Retrieve the NodeInsertionWorkflow product ID

To retrieve the NodeInsertionWorkflow product ID, use the Market API.

Sample request

GET {{MCP_SERVER}}/bpocore/market/api/v1/products

Sample response

{
"items": [
{
"id": "5953f3f2-f72c-4f07-95e9-a3fb21d0cbd9",
"resourceTypeId": "ifd.v2.resourceTypes.NodeInsertionWorkflow",
"title": "product for ifd.v2.resourceTypes.NodeInsertionWorkflow",
"active": true,
"domainId": "built-in",
"constraints": {},
"providerData": {
"template": "ifd.v2.serviceTemplates.NodeInsertionWorkflow"
}
},
{
"id": "5953f3f3-e8c1-4e12-a950-b7e76bead5f3",
"resourceTypeId": "ifd.v2.resourceTypes.NodeDeletionWorkflow",
"title": "product for ifd.v2.resourceTypes.NodeDeletionWorkflow",
"active": true,
"domainId": "built-in",
"constraints": {},
"providerData": {
"template": "ifd.v2.serviceTemplates.NodeDeletionWorkflow"
}
},

],
"total": 2,
"offset": 0,
"limit": 1000
}

Create the NodeInsertionWorkflow resource

Note: Use the link that is going to be under maintenance.

To create the NodeInsertionWorkflow resource, use the Market API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 875
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Request = POST {{MCP_SERVER}}/bpocore/market/api/v1/resources

Sample request

{
"productId": "{{NIWF_PRODUCT_ID}}",
"label": "Node Insertion Workflow {{NIWF_NAME}}",
"properties": {
"name": "Node Insertion Workflow {{NIWF_NAME}}",
"endPointA": {
"networkElement": {
"name": "3930_MCP_4"
},
"port": "5"
},
"endPointB": {
"networkElement": {
"name": "3930_MCP_7"
},
"port": "6"
}
}
}

A list of parameters and related descriptions follows.

Table 19. Parameters and description

PARAMETER DESCRIPTION

productId The id from the API.

label The label of the NodeInsertionWorkflow resource.

name The name for the NodeInsertionWorkflow

resource.

endPointA/Z The endpoint-related info.

networkElement The NE name.

port For 8700/6500-Packet Fabric, the port info should

also have a shelf, slot as in the following example:

"primary": {

“shelf” : "{{SHELF_NUM}}",

“slot”: “{{SLOT_NUM}}”,

"port": "{{TUNNEL_AEND_PORT}}"}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 876
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "5956be60-bb3e-4e81-94e3-4c68d7378981",
"label": "Node Insertion Workflow NI-14-10",
"resourceTypeId": "ifd.v2.resourceTypes.NodeInsertionWorkflow",
"productId": "5955a910-314b-4123-89e8-5249d77e51ac",
"tenantId": "748d7633-80b7-4d1a-98e5-aa27e38ccdb3",
"shared": false,
"properties": {
"name": "Node Insertion Workflow NI-14-10",
"endPointA": {
"networkElement": {
"name": "3930_MCP_4"
},
"port": "5"
},
"endPointB": {
"networkElement": {
"name": "3930_MCP_7"
},
"port": "6"
}
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-06-30T21:10:56.218Z",
"createdAt": "2017-06-30T21:10:56.218Z",
"autoClean": false
}

Note: The “id” in the response (above) is the “id” of the NodeInsertionWorfklow created.

Use this id to:

• Retrieve the NodeInsertionWorkflow resource.

• Execute the ProtectionSwitch (step 3).

Execute protection switch

Note: Use the ID of the NodeInsertionWorkflow resource created in the previous step.

To execute the protection switch, use the Market API.

Request = POST {{MCP_SERVER}}/bpocore/market/api/v1/resources/{{NIWF_ID}}/operations

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 877
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"interface": "protectionSwitch",
"inputs" : {
"bestEffort" : false
}
}

A list of parameters and related descriptions follows.

Table 20. Parameters and description

PARAMETER DESCRIPTION

interface protectionSwitch will be the default value for this

operation.

bestEffort Value can be either true or false.

* If true, the LSP switch would still proceed and the

user is given the list of tunnels that could not be
switched.

* If false, the operation should fail if some LSPs

cannot be switched away.

Sample response

{
"id": "5956bf8e-0a0d-4041-a1cd-531b75963edd",
"resourceId": "5956be60-bb3e-4e81-94e3-4c68d7378981",
"interface": "protectionSwitch",
"inputs": {
"bestEffort": false
},
"outputs": {},
"state": "requested",
"reason": "",
"createdAt": "2017-06-30T21:15:58.208Z",
"updatedAt": "2017-06-30T21:15:58.208Z",
"resourceStateConstraints": {}
}

Note: The “id” in the response (above) is the protection switch operation “id”.

Use this id to:

• Retrieve the status of the Protection switch operation (step 4).

Retrieve the status of protection switch

Note: The following apply:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 878
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

• NIWF_ID is the NodeInsertionWorkflow resource ID generated as part of creating the

NodeInsertionWorkflow resource (step 2).
• OID is the operation ID generated as part of executing Protection switch (step 3).

To retrieve the status of the protection switch, use the Market API.

Sample request

GET {{MCP_SERVER}}/bpocore/market/api/v1/resources/{{NIWF_ID}}/operations/{{OID}}

A list of parameters and related descriptions follows.

Table 21. Parameters and description

PARAMETER DESCRIPTION

id Protection switch operation ID

state Values can be:

* COMPLETED

* IN_PROGRESS

* FAILED

* ABORTED

affectedServices Details about all the LSPs that are corrected.

Sample response

{
"id": "5956c7ac-f084-4b28-a60c-748f7569e8fc",
"resourceId": "5956c7a2-a164-43bf-94c2-24a80894bd2c",
"interface": "protectionSwitch",
"inputs": {
"bestEffort": true
},
"outputs": {
"affectedServices": [
{
"userLabel": "17-15-2",
"operationStatuses": [
{
"status": "FAILED",
"operation": "protectionSwitch",
"message": " Found an unprotected FRE with name 17-15-2 and ID
6263444378437617250. Switch will not be executed on active LSPs "
}
],
"freId": "6263444378437617250",
"layerRate": "MPLS_PROTECTION",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 879
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"managementName": "17-15-2"
},
{
"userLabel": "sankar-17-4",
"operationStatuses": [
{
"status": "FAILED",
"operation": "protectionSwitch",
"message": " Found an unprotected FRE with name sankar-17-4 and ID
7472456680727832158. Switch will not be executed on active LSPs "
}
],
"freId": "7472456680727832158",
"layerRate": "MPLS_PROTECTION",
"managementName": "sankar-17-4"
},
{
"userLabel": "pce-issue-4",
"operationStatuses": [
{
"status": "FAILED",
"operation": "protectionSwitch",
"message": " Found an unprotected FRE with name pce-issue-4 and ID
-7284860917466852734. Switch will not be executed on active LSPs "
}
],
"freId": "-7284860917466852734",
"layerRate": "MPLS_PROTECTION",
"managementName": "pce-issue-4"
},
{
"userLabel": "sankar-2",
"operationStatuses": [
{
"status": "FAILED",
"operation": "protectionSwitch",
"message": " Found an unprotected FRE with name sankar-2 and ID
6761413956652697696. Switch will not be executed on active LSPs "
}
],
"freId": "6761413956652697696",
"layerRate": "MPLS_PROTECTION",
"managementName": "sankar-2"
},
{
"userLabel": "pce-issue",
"operationStatuses": [
{
"status": "FAILED",
"operation": "protectionSwitch",
"message": " Found an unprotected FRE with name pce-issue and ID
-4950113752260381898. Switch will not be executed on active LSPs "
}
],
"freId": "-4950113752260381898",
"layerRate": "MPLS_PROTECTION",
"managementName": "pce-issue"
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 880
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"userLabel": "4-7-6",
"operationStatuses": [
{
"status": "SUCCEEDED",
"operation": "protectionSwitch",
"message": " Protection switch operation completed on LSP 4-7-6 "
}
],
"freId": "6919222813551950071",
"layerRate": "MPLS_PROTECTION",
"managementName": "4-7-6"
},
{
"userLabel": "4-7-6-prot",
"operationStatuses": [
{
"status": "SUCCEEDED",
"operation": "protectionSwitch",
"message": " Protection switch operation completed on LSP 4-7-6-prot "
}
],
"freId": "6662969006268401008",
"layerRate": "MPLS_PROTECTION",
"managementName": "4-7-6-prot"
}
]
},
"state": "successful",
"reason": "",
"createdAt": "2017-06-30T21:50:36.628Z",
"updatedAt": "2017-06-30T21:50:56.985Z",
"resourceStateConstraints": {}
}

Perform LSP protection restore on link

As a user who has bulk-switched LSPs away from a link, you want to be able to select that link and revert
the traffic back to that link so that the traffic is on its home link.

• Any operationally up but inactive primary LSP configured over this link should be reverted back to it.
• Any backup LSP configured over this link may be left alone.

This section includes the following topics:

• Retrieve the NodeInsertionWorkflow product ID

• Create the NodeInsertionWorkflow resource
• Execute the ProtectionRestore operation
• Get the status of ProtectionRestore operation

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 881
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Retrieve the NodeInsertionWorkflow product ID

To retrieve the NodeInsertionWorkflow product ID, use the Market API.

Sample request

GET {{MCP_SERVER}}/bpocore/market/api/v1/products

Sample response

{
"items": [
{
"id": "5953f3f2-f72c-4f07-95e9-a3fb21d0cbd9",
"resourceTypeId": "ifd.v2.resourceTypes.NodeInsertionWorkflow",
"title": "product for ifd.v2.resourceTypes.NodeInsertionWorkflow",
"active": true,
"domainId": "built-in",
"constraints": {},
"providerData": {
"template": "ifd.v2.serviceTemplates.NodeInsertionWorkflow"
}
},
{
"id": "5953f3f3-e8c1-4e12-a950-b7e76bead5f3",
"resourceTypeId": "ifd.v2.resourceTypes.NodeDeletionWorkflow",
"title": "product for ifd.v2.resourceTypes.NodeDeletionWorkflow",
"active": true,
"domainId": "built-in",
"constraints": {},
"providerData": {
"template": "ifd.v2.serviceTemplates.NodeDeletionWorkflow"
}
},

],
"total": 2,
"offset": 0,
"limit": 1000
}

Create the NodeInsertionWorkflow resource

To create the NodeInsertionWorkflow resource, use the Market API.

Request = POST {{MCP_SERVER}}/bpocore/market/api/v1/resources

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 882
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Sample request

{
"productId": "{{NIWF_PRODUCT_ID}}",
"label": "Node Insertion Workflow {{NIWF_NAME}}",
"properties": {
"name": "Node Insertion Workflow {{NIWF_NAME}}",
"endPointA": {
"networkElement": {
"name": "3930_MCP_4"
},
"port": "5"
},
"endPointB": {
"networkElement": {
"name": "3930_MCP_7"
},
"port": "6"
}
}
}

A list of parameters and related descriptions follows.

Table 22. Parameters and description

PARAMETER DESCRIPTION

productId The id from the API.

label The label of the NodeInsertionWorkflow resource.

name The name for the NodeInsertionWorkflow

resource.

endPointA/Z The endpoint-related info.

networkElement The NE name.

port For 8700/6500-Packet Fabric, the port info should

also have a shelf, slot as in the following example:

"primary": {

“shelf” : "{{SHELF_NUM}}",

“slot”: “{{SLOT_NUM}}”,

"port": "{{TUNNEL_AEND_PORT}}"}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 883
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"id": "5956c6a6-2d95-4cec-8fdd-c3e6adcab1d8",
"label": "Node Insertion Workflow NI-14-10",
"resourceTypeId": "ifd.v2.resourceTypes.NodeInsertionWorkflow",
"productId": "5955a910-314b-4123-89e8-5249d77e51ac",
"tenantId": "748d7633-80b7-4d1a-98e5-aa27e38ccdb3",
"shared": false,
"properties": {
"name": "Node Insertion Workflow NI-14-10",
"endPointA": {
"networkElement": {
"name": "3930_MCP_4"
},
"port": "5"
},
"endPointB": {
"networkElement": {
"name": "3930_MCP_7"
},
"port": "6"
}
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-06-30T21:46:14.335Z",
"createdAt": "2017-06-30T21:46:14.335Z",
"autoClean": false
}

Note: The “id” in the response (above) is the “id” of the NodeInsertionWorfklow created.

Use this id to:

• Retrieve the NodeInsertionWorkflow resource.

• Execute the ProtectionRestore (step 3).

Execute protection restore

Note: Use the ID of the NodeInsertionWorkflow resource created in the previous step.

To execute the protection restore, use the Market API.

Request = POST {{MCP_SERVER}}/bpocore/market/api/v1/resources/{{NIWF_ID}}/operations

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 884
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"interface": "protectionRestore"
}

Sample response

{
"id": "5956c6d4-90b8-4d10-b5b0-f2273d2f66aa",
"resourceId": "5956c6a6-2d95-4cec-8fdd-c3e6adcab1d8",
"interface": "protectionRestore",
"inputs": {},
"outputs": {},
"state": "requested",
"reason": "",
"createdAt": "2017-06-30T21:47:00.235Z",
"updatedAt": "2017-06-30T21:47:00.235Z",
"resourceStateConstraints": {}
}

Note: The “id” in the response (above) is the protection restore operation “id”.

Use this id to:

• Retrieve the status of the Protection restore operation (step 4).

Retrieve the status of protection restore

Note: The following apply:

• NIWF_ID is the NodeInsertionWorkflow resource ID generated as part of creating the

NodeInsertionWorkflow resource (step 2).
• OID is the operation ID generated as part of executing Protection restore (step 3).

To retrieve the status of the protection restore, use the Market API.

Sample request

GET {{MCP_SERVER}}/bpocore/market/api/v1/resources/{{NIWF_ID}}/operations/{{OID}}

A list of parameters and related descriptions follows.

Table 23. Parameters and description

PARAMETER DESCRIPTION

id Protection switch operation ID

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 885
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

PARAMETER DESCRIPTION

state Values can be:

* COMPLETED

* IN_PROGRESS

* FAILED

* ABORTED

affectedServices Details about all the LSPs that are corrected.

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 886
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "5956c6d4-90b8-4d10-b5b0-f2273d2f66aa",
"resourceId": "5956c6a6-2d95-4cec-8fdd-c3e6adcab1d8",
"interface": "protectionRestore",
"inputs": {},
"outputs": {
"affectedServices": [
{
"userLabel": "4-7-6_B",
"operationStatuses": [
{
"status": "SUCCEEDED",
"operation": "protectionRestore",
"message": " Protection switch operation completed on LSP 4-7-6_B "
}
],
"freId": "-622834540878803332",
"layerRate": "MPLS_PROTECTION",
"managementName": "4-7-6"
},
{
"userLabel": "4-7-6-prot_B",
"operationStatuses": [
{
"status": "SUCCEEDED",
"operation": "protectionRestore",
"message": " Protection switch operation completed on LSP 4-7-6-prot_B
"
}
],
"freId": "5175356512573164481",
"layerRate": "MPLS_PROTECTION",
"managementName": "4-7-6-prot"
}
]
},
"state": "successful",
"reason": "",
"createdAt": "2017-06-30T21:47:00.235Z",
"updatedAt": "2017-06-30T21:47:12.285Z",
"resourceStateConstraints": {}
}

Perform LSP correction on node insertion

Use this procedure to correct a static MPLS co-routed bidirectional LSP tunnel group. A tunnel group can
be protected or unprotected.

• An unprotected tunnel group consists of a single LSP between two LER nodes with or without
intermediate transit nodes (LSRs).
• A protected tunnel group consists of two such LSPs, one being the primary and the other being the
backup. Only one LSP (primary or backup) is active at a given time.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 887
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Requirements

Perform the following:

1. Physically disconnect the nodes and insert the new node.

2. Pre-provision the following on the devices:
◦ loopback IP and interface IP addresses (for IP links)
◦ AIS profiles
◦ BFD profiles
3. Pre-assign a loopback IP address to each node in the tunnel path (including LER and LSR nodes)
4. Provision interface IP addresses and VLANs for every port on CES devices over which a tunnel could
be routed.
5. Configure IFNUM for all ports connected to 6200 devices.
6. Enable static ARP on ports facing the 6200 devices.
7. Rediscover the affected nodes.

As part of commissioning the new IP interfaces, the user should not change or delete the existing
interface.

This section includes the following topics:

• Retrieve the NodeInsertionWorkflow product ID

• Create the NodeInsertionWorkflow resource
• Execute the LSP correction
• Get the status of LSP correction operation
• Retrieve the workflow resource

Retrieve the NodeInsertionWorkflow product ID

To retrieve the NodeInsertionWorkflow product ID, use the Market API.

Sample request

GET {{MCP_SERVER}}/bpocore/market/api/v1/products

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 888
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"items": [
{
"id": "5953f3f2-f72c-4f07-95e9-a3fb21d0cbd9",
"resourceTypeId": "ifd.v2.resourceTypes.NodeInsertionWorkflow",
"title": "product for ifd.v2.resourceTypes.NodeInsertionWorkflow",
"active": true,
"domainId": "built-in",
"constraints": {},
"providerData": {
"template": "ifd.v2.serviceTemplates.NodeInsertionWorkflow"
}
},
{
"id": "5953f3f3-e8c1-4e12-a950-b7e76bead5f3",
"resourceTypeId": "ifd.v2.resourceTypes.NodeDeletionWorkflow",
"title": "product for ifd.v2.resourceTypes.NodeDeletionWorkflow",
"active": true,
"domainId": "built-in",
"constraints": {},
"providerData": {
"template": "ifd.v2.serviceTemplates.NodeDeletionWorkflow"
}
},

],
"total": 2,
"offset": 0,
"limit": 1000
}

In the response, note the “ifd.v2.resourceTypes.NodeInsertionWorkflow”. Use this ID as the “product Id” in
Create the NodeInsertionWorkflow resource (step 2).

Create the NodeInsertionWorkflow resource

Note: Use the original link that was removed and provide that as part of endpoints while creating the
NodeInsertionWorkflow resource.

Assumption: If X is the new node that is inserted between A-B, use the port from A (connected to X) and
port from B (connected to X) to create the workflow resource.

To create the NodeInsertionWorkflow resource, use the Market API.

Request = POST {{MCP_SERVER}}/bpocore/market/api/v1/resources

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 889
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"productId": "{{NIWF_PRODUCT_ID}}",
"label": "Node Insertion Workflow {{NIWF_NAME}}",
"properties": {
"name": "Node Insertion Workflow {{NIWF_NAME}}",
"endPointA": {
"networkElement": {
"name": "3930_MCP_4"
},
"port": "3"
},
"endPointB": {
"networkElement": {
"name": "3930_MCP_6"
},
"port": "8"
}
}
}

A list of parameters and related descriptions follows.

Table 24. Parameters and description

PARAMETER DESCRIPTION

productId The id from the API.

label The label of the NodeInsertionWorkflow resource.

name The name for the NodeInsertionWorkflow

resource.

endPointA/Z The endpoint-related info.

networkElement The NE name.

port For 8700/6500-Packet Fabric, the port info should

also have a shelf, slot as in the following example:

"primary": {

"shelf" : "{{SHELF_NUM}}",

"slot": "{{SLOT_NUM}}",

"port": "{{TUNNEL_AEND_PORT}}"}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 890
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "59540dc6-6112-4577-aa76-fad0eb0cf2fa",
"label": "Node Insertion Workflow NI-19-37",
"resourceTypeId": "ifd.v2.resourceTypes.NodeInsertionWorkflow",
"productId": "5953f3f2-f72c-4f07-95e9-a3fb21d0cbd9",
"tenantId": "b050c434-46cd-4c15-95b2-b33c22586d43",
"shared": false,
"properties": {
"name": "Node Insertion Workflow NI-19-37",
"endPointA": {
"networkElement": {
"name": "3930_MCP_4"
},
"port": "3"
},
"endPointB": {
"networkElement": {
"name": "3930_MCP_6"
},
"port": "8"
}
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-06-28T20:12:55.082Z",
"createdAt": "2017-06-28T20:12:55.082Z",
"autoClean": false
}

Note: The “id” in the response (above) is the “id” of the NodeInsertionWorkflow created.

Use this id to:

• Retrieve the NodeInsertionWorkflow resource.

• Execute the LSP correction (step 3).

Execute LSP correction

Note: Use the ID of the NodeInsertionWorkflow resource created in the previous step.

To execute the LSP correction, use the Market API.

Request = POST {{MCP_SERVER}}/bpocore/market/api/v1/resources/{{NIWF_ID}}/operations

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 891
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"interface": "serviceCorrect"
}

Sample response

{
"id": "595411e5-b669-4e82-9cc1-1e62b556ac32",
"resourceId": "59540dc6-6112-4577-aa76-fad0eb0cf2fa",
"interface": "serviceCorrect",
"inputs": {},
"outputs": {},
"state": "requested",
"reason": "",
"createdAt": "2017-06-28T20:30:29.274Z",
"updatedAt": "2017-06-28T20:30:29.274Z",
"resourceStateConstraints": {}
}

Note: The “id” in the response (above) is the LSP correction operation “id”.

Use this id to:

• Retrieve the status of the LSP correction operation (step 4).

Retrieve the status of LSP correction

Note: The following apply:

• NIWF_ID is the NodeInsertionWorkflow resource ID generated as part of creating the

NodeInsertionWorkflow resource (step 2).
• OID is the operation ID generated as part of executing LSP correction (step 3).

To retrieve the status of the LSP correction, use the Market API.

Sample request

GET {{MCP_SERVER}}/bpocore/market/api/v1/resources/{{NIWF_ID}}/operations/{{OID}}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 892
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"items": [
{
"id": "58a22de7-bd0a-43c0-91aa-dc96a30014da",
"resourceId": "58a22d2c-94e6-401d-8905-13dd0695bc48",
"interface": "serviceCorrect",
"inputs": {},
"outputs": {},
"state": "successful",
"reason": "",
"createdAt": "2017-02-13T22:06:31.946Z",
"updatedAt": "2017-02-13T22:06:38.027Z",
"resourceStateConstraints": {}
}
],
"total": 1,
"offset": 0,
"limit": 1000
}

A list of parameters and related descriptions follows.

Table 25. Parameters and description

PARAMETER DESCRIPTION

id LSP correction Operation ID.

state Values can be:

• successful
• failed
• aborted

Retrieve the workflow resource

To retrieve the workflow resource (to know the details of the corrected LSPs), use the Market API.

Sample request

GET {{MCP_SERVER}}/bpocore/market/api/v1/resources/{{NIWF_ID}}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 893
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "59540dc6-6112-4577-aa76-fad0eb0cf2fa",
"label": "Node Insertion Workflow NI-19-37",
"resourceTypeId": "ifd.resourceTypes.NodeInsertionWorkflow",
"productId": "5953f3f2-f72c-4f07-95e9-a3fb21d0cbd9",
"tenantId": "b050c434-46cd-4c15-95b2-b33c22586d43",
"shared": false,
"properties": {
"stage": {
"state": "COMPLETED",
"id": "SERVICE_CORRECT"
},
"name": "Node Insertion Workflow NI-13-59",
"affectedServices": [
{
"userLabel": "Demo-13-38",
"operationStatuses": [
{
"status": "SUCCEEDED",
"operation": "serviceCorrect",
"message": "LSP Correction finished for the FRE 2522365656947898119 "
}
],
"freId": "2522365656947898119",
"layerRate": "MPLS_PROTECTION",
"managementName": ""
}
],
"endPointA": {
"networkElement": {
"name": "3930_MCP_4"
},
"port": "3"
},
"endPointB": {
"networkElement": {
"name": "3930_MCP_6"
},
"port": "8"
}
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-06-28T20:12:59.082Z",
"createdAt": "2017-06-28T20:12:59.082Z",
"autoClean": false
}

A list of parameters and related descriptions follows.

Table 26. Parameters and description

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 894
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

PARAMETER DESCRIPTION

Id NodeInsertionWorkflow resource ID.

stage Values can be:

* INIT

* SERVICE_CORRECT

state Values can be:

* COMPLETED

* IN_PROGRESS

* FAILED

* ABORTED

affectedServices Details about all the LSPs that are corrected.

Perform LSP correction on node deletion

Use this procedure to correct a static MPLS co-routed bidirectional LSP tunnel group on Node deletion. A
tunnel group can be protected or unprotected.

• Considering the connections as A-X-B.

• X is physically disconnected from A and B.
• A and B are directly connected.

LSP correction on node deletion will correct the LSPs terminating on A or B and LSPs transiting through
nodes A or B.

Requirements

Perform the following:

1. Physically disconnect the nodes and connect the two nodes A & B.
2. Pre-provision the following on the devices:
◦ loopback IP and interface IP addresses (for IP links)
3. Pre-assign a loopback IP address to each node in the tunnel path (including LER and LSR nodes)
4. Provision interface IP addresses and VLANs for every port on CES devices over which a tunnel could
be routed.
5. Configure IFNUM for all ports connected to 6200 devices.
6. Enable static ARP on ports facing the 6200 devices.
7. Rediscover the affected nodes. (two nodes)

As part of commissioning the new IP interfaces, the user should not change or delete the existing

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 895
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

interface.

This section includes the following topics:

• Retrieve the NodeDeletionWorkflow product ID

• Create the NodeDeletionWorkflow resource
• Execute the LSP correction
• Retrieve the status of the LSP correction operation
• Retrieve the workflow resource

Retrieve the NodeDeletionWorkflow product ID

To retrieve the NodeDeletionWorkflow product ID, use the Market API.

Sample request

GET {{MCP_SERVER}}/bpocore/market/api/v1/products

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 896
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"items": [
{
"id": "5953f3f2-f72c-4f07-95e9-a3fb21d0cbd9",
"resourceTypeId": "ifd.v2.resourceTypes.NodeInsertionWorkflow",
"title": "product for ifd.v2.resourceTypes.NodeInsertionWorkflow",
"active": true,
"domainId": "built-in",
"constraints": {},
"providerData": {
"template": "ifd.v2.serviceTemplates.NodeInsertionWorkflow"
}
},
{
"id": "5953f3f3-e8c1-4e12-a950-b7e76bead5f3",
"resourceTypeId": "ifd.v2.resourceTypes.NodeDeletionWorkflow",
"title": "product for ifd.v2.resourceTypes.NodeDeletionWorkflow",
"active": true,
"domainId": "built-in",
"constraints": {},
"providerData": {
"template": "ifd.v2.serviceTemplates.NodeDeletionWorkflow"
}
},

],
"total": 2,
"offset": 0,
"limit": 1000
}

In the response, note the “ifd.v2.resourceTypes.NodeDeletionWorkflow”. Use this ID as the “product Id” in
Create the NodeInsertionWorkflow resource (step 2).

Create the NodeInsertionWorkflow resource

Note: Use the original link that was removed and provide that as part of endpoints while creating the
NodeDeletionWorkflow resource.

Assumption: If X is the new node that is deleted between A-B, use the port from A (connected to B) and
port from B (connected to A) to create the node deletion workflow resource.

To create the NodeDeletionWorkflow resource, use the Market API.

Request = POST {{MCP_SERVER}}/bpocore/market/api/v1/resources

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 897
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"productId": "{{NDWF_PRODUCT_ID}}",
"label": "Node Deletion Workflow {{NDWF_NAME}}",
"properties": {
"name": "Node Deletion Workflow {{NDWF_NAME}}",
"endPointA": {
"networkElement": {
"name": "3930_MCP_4"
},
"port": "3"
},
"endPointB": {
"networkElement": {
"name": "3930_MCP_15"
},
"port": "7"
}
}
}

A list of parameters and related descriptions follows.

Table 27. Parameters and description

PARAMETER DESCRIPTION

productId The id from the API.

label The label of the NodeDeletionWorkflow resource.

name The name for the NodeDeletionWorkflow resource.

endPointA/Z The endpoint-related info.

networkElement The NE name.

port For 8700/6500-Packet Fabric, the port info should

also have a shelf, slot as in the following example:

"primary": {

"shelf" : "{{SHELF_NUM}}",

"slot": "{{SLOT_NUM}}",

"port": "{{TUNNEL_AEND_PORT}}"}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 898
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "595423f8-138f-4ffe-ba6e-aa5a819ed37a",
"label": "Node Deletion Workflow ND-15-43",
"resourceTypeId": "ifd.v2.resourceTypes.NodeDeletionWorkflow",
"productId": "5953f3f3-e8c1-4e12-a950-b7e76bead5f3",
"tenantId": "b050c434-46cd-4c15-95b2-b33c22586d43",
"shared": false,
"properties": {
"name": "Node Deletion Workflow ND-15-43",
"endPointA": {
"networkElement": {
"name": "3930_MCP_4"
},
"port": "3"
},
"endPointB": {
"networkElement": {
"name": "3930_MCP_15"
},
"port": "7"
}
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-06-28T21:47:36.726Z",
"createdAt": "2017-06-28T21:47:36.726Z",
"autoClean": false
}

Note: The “id” in the response (above) is the “id” of the NodeDeletionWorkflow resource created.

Use this id to:

• Retrieve the NodeDeletionWorkflow resource.

• Execute the LSP correction (step 3).

Execute LSP correction

Note: Use the ID of the NodeDeletionWorkflow resource created in the previous step.

To execute the LSP correction, use the Market API.

Request = POST {{MCP_SERVER}}/bpocore/market/api/v1/resources/{{NIWF_ID}}/operations

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 899
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"interface": "serviceCorrect"
}

Sample response

{
"id": "595411e5-b669-4e82-9cc1-1e62b556ac32",
"resourceId": "59540dc6-6112-4577-aa76-fad0eb0cf2fa",
"interface": "serviceCorrect",
"inputs": {},
"outputs": {},
"state": "requested",
"reason": "",
"createdAt": "2017-06-28T20:30:29.274Z",
"updatedAt": "2017-06-28T20:30:29.274Z",
"resourceStateConstraints": {}
}

Note: The “id” in the response (above) is the LSP correction operation “id”.

Use this id to:

• Retrieve the status of the LSP correction operation (step 4).

Retrieve the status of LSP correction

Note: The following apply:

• NIWF_ID is the NodeInsertionWorkflow resource ID generated as part of creating the

NodeDeletionWorkflow resource (step 2).
• OID is the operation ID generated as part of executing LSP correction (step 3).

To retrieve the status of the LSP correction, use the Market API.

Sample request

GET {{MCP_SERVER}}/bpocore/market/api/v1/resources/{{NIWF_ID}}/operations/{{OID}}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 900
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"items": [
{
"id": "58a22de7-bd0a-43c0-91aa-dc96a30014da",
"resourceId": "58a22d2c-94e6-401d-8905-13dd0695bc48",
"interface": "serviceCorrect",
"inputs": {},
"outputs": {},
"state": "successful",
"reason": "",
"createdAt": "2017-02-13T22:06:31.946Z",
"updatedAt": "2017-02-13T22:06:38.027Z",
"resourceStateConstraints": {}
}
],
"total": 1,
"offset": 0,
"limit": 1000
}

A list of parameters and related descriptions follows.

Table 28. Parameters and description

PARAMETER DESCRIPTION

id LSP correction Operation ID.

state Values can be:

• successful
• failed
• aborted

Retrieve the workflow resource

To retrieve the workflow resource (to know the details of the corrected LSPs), use the Market API.

Sample request

GET {{MCP_SERVER}}/bpocore/market/api/v1/resources/{{NIWF_ID}}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 901
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"id": "595423f8-138f-4ffe-ba6e-aa5a819ed37a",
"label": "Node Deletion Workflow ND-15-43",
"resourceTypeId": "ifd.v2.resourceTypes.NodeDeletionWorkflow",
"productId": "5953f3f3-e8c1-4e12-a950-b7e76bead5f3",
"tenantId": "b050c434-46cd-4c15-95b2-b33c22586d43",
"shared": false,
"properties": {
"stage": {
"state": "COMPLETED",
"id": "SERVICE_CORRECT"
},
"name": "Node Deletion Workflow NI-13-59",
"affectedServices": [
{
"userLabel": "Demo-13-38",
"operationStatuses": [
{
"status": "SUCCEEDED",
"operation": "serviceCorrect",
"message": "LSP Correction finished for the FRE 2522365656947898119 "
}
],
"freId": "2522365656947898119",
"layerRate": "MPLS_PROTECTION",
"managementName": ""
}
],
"endPointA": {
"networkElement": {
"name": "3930_MCP_4"
},
"port": "3"
},
"endPointB": {
"networkElement": {
"name": "3930_MCP_6"
},
"port": "8"
}
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-06-28T21:47:52.726Z",
"createdAt": "2017-06-28T21:47:52.726Z",
"autoClean": false
}

A list of parameters and related descriptions follows.

Table 29. Parameters and description

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 902
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

PARAMETER DESCRIPTION

id NodeDeletionWorkflow resource ID.

stage Values can be:

* INIT

* SERVICE_CORRECT

state Values can be:

* COMPLETED

* IN_PROGRESS

* FAILED

* ABORTED

affectedServices Details about all the LSPs that are corrected.

Perform LSP resize for a dynamic MPLS tunnel

Use this procedure to manually trigger the immediate re-sizing of a dynamic tunnel for which auto-
resizing has been enabled.

"Re-sizing" a dynamic tunnel increases or decreases the associated LSP bandwidth to reflect the
committed service load. Although a tunnel configured to auto-resize will perform this operation
automatically given time, you can use this procedure to trigger the resize operation immediately.

When you trigger the re-size operation, MCP will send the auto-resize trigger command to the supporting
device. This operation will only trigger the auto-resize insruction to the NE; whether the tunnel is atually
auto-resized or not is controlled by NE.

Resizing a tunnel, and verifying success, involves the following steps:

1. Retrieve a MplsOperationContainer resource ID

2. Execute the tunnel group resize (using the resource ID you obtained in step 1)
3. Get the status of resize operation (using the operation ID you obtained in step 2)

Retrieving the MplsOperationContainer resource ID

Use the Market API GET operation to obtain the tunnel’s resource ID.

Sample request:

GET
{{BP_SERVER}}/bpocore/market/api/v1/resources?exactTypeId=ifd.v2.resourceTypes.MplsOperationCo

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 903
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

ntainer

Sample response:

{
"items": [
{
"id": "5955a92c-a8fa-4337-9036-875eafe449c2",
"label": "Resource for ifd.v2.resourceTypes.MplsOperationContainer",
"resourceTypeId": "ifd.v2.resourceTypes.MplsOperationContainer",
"productId": "5955a910-5b13-4c6f-b8bc-32a5b80662ae",
"tenantId": "748d7633-80b7-4d1a-98e5-aa27e38ccdb3",
"shared": false,
"properties": {},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2018-01-30T01:28:13.249Z",
"createdAt": "2018-01-30T01:28:12.558Z",
"autoClean": false
},
{
"id": "5955a92d-1f6a-4b41-aa36-8019be2dfd84",
"label": "Resource for ifd.v2.resourceTypes.MplsOperationContainer",
"resourceTypeId": "ifd.v2.resourceTypes.MplsOperationContainer",
"productId": "5955a910-5b13-4c6f-b8bc-32a5b80662ae",
"tenantId": "748d7633-80b7-4d1a-98e5-aa27e38ccdb3",
"shared": false,
"properties": {},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2018-01-30T01:28:15.786Z",
"createdAt": "2018-01-30T01:28:14.392Z",
"autoClean": false
},
{
"id": "5955a92f-219f-440b-8be1-a1507bda8e83",
"label": "Resource for ifd.v2.resourceTypes.MplsOperationContainer",
"resourceTypeId": "ifd.v2.resourceTypes.MplsOperationContainer",
"productId": "5955a910-5b13-4c6f-b8bc-32a5b80662ae",
"tenantId": "748d7633-80b7-4d1a-98e5-aa27e38ccdb3",
"shared": false,
"properties": {},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 904
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"tags": {},
"providerData": {},
"updatedAt": "2018-01-30T01:28:17.995Z",
"createdAt": "2018-01-30T01:28:16.443Z",
"autoClean": false
},
{
"id": "5955a933-0811-4e98-9676-1b243e3b5c59",
"label": "Resource for ifd.v2.resourceTypes.MplsOperationContainer",
"resourceTypeId": "ifd.v2.resourceTypes.MplsOperationContainer",
"productId": "5955a910-5b13-4c6f-b8bc-32a5b80662ae",
"tenantId": "748d7633-80b7-4d1a-98e5-aa27e38ccdb3",
"shared": false,
"properties": {},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2018-01-30T01:28:21.620Z",
"createdAt": "2018-01-30T01:28:19.593Z",
"autoClean": false
},
{
"id": "5955a936-cfe0-4c4d-9a03-bdbde2ecaf09",
"label": "Resource for ifd.v2.resourceTypes.MplsOperationContainer",
"resourceTypeId": "ifd.v2.resourceTypes.MplsOperationContainer",
"productId": "5955a910-5b13-4c6f-b8bc-32a5b80662ae",
"tenantId": "748d7633-80b7-4d1a-98e5-aa27e38ccdb3",
"shared": false,
"properties": {},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2018-01-30T01:28:23.742Z",
"createdAt": "2018-01-30T01:28:22.469Z",
"autoClean": false
}
],
"total": 5,
"offset": 0,
"limit": 1000
}

The response includes the list of MplsOperationContainer resources; and every resource in the response
will have an attribute named "id".

Select one resource from the returned list of resources, and use the value of id property to execute the
tunnel group Resize.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 905
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Executing tunnel group resize

Use the Market API POST operation to reize the tunnel group.

Sample request:

POST {{BP_SERVER}}/bpocore/market/api/v1/resources/{{RID}}/operations

Request data :

PARAMETER DESCRIPTION

interface Resize as the default value for this operation

inputs input data for the resize operation

field tunnel group FRE ID

{
"interface": "resize",
"inputs": {
"freId": "6515318274086203180"
}
}

Sample response:

{
"id": "5956d1d6-d0e1-45d7-a636-587815eb9736",
"resourceId": "5955a92d-1f6a-4b41-aa36-8019be2dfd84",
"interface": "resize",
"inputs": {
"freId": "6515318274086203180"
},
"outputs": {},
"state": "requested",
"reason": "",
"createdAt": "2018-01-30T22:33:58.889Z",
"updatedAt": "2018-01-30T22:33:58.889Z",
"resourceStateConstraints": {}
}

Note: The “id” in the response (above) is the unique id number that assigned to the resize operation.

You can use this id to:

• Retrieve the status of the tunnel group resize operation.

• Retrieve the status of tunnel group resize operation.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 906
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Note:

• RID is the MplsOperationContainer resource ID used as part of executing the resize operation.
• OID is the operation ID generated as part of tunnel group resize operation (Step 3)
{{BP_SERVER}}/bpocore/market/api/v1/resources/{{RID}}/operations/{{OID}}

Retrieving the status of the resize operation

Using the resize operation ID, you can obtain the status of the operation to verify its successful execution.

Use the Market API GET operation to obtain this status.

Sample Request

GET {{BP_SERVER}}/bpocore/market/api/v1/resources/{{RID}}/operations/{{OID}}

Sample Response

PARAMETER DESCRIPTION

id The resize operation ID

state The state of the resize operation.

Possible values are:

• successful
• failed
• aborted

{
"id": "5956d1d6-d0e1-45d7-a636-587815eb9736",
"resourceId": "5955a92d-1f6a-4b41-aa36-8019be2dfd84",
"interface": "resize",
"inputs": {
"freId": "-3770626729195966017"
},
"outputs": {},
"state": "successful",
"reason": "",
"createdAt": "2018-01-30T22:33:58.889Z",
"updatedAt": "2018-01-30T22:34:04.846Z",
"resourceStateConstraints": {}
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 907
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Retrieve the latest information about an MPLS tunnel

You can use the MCP API to retrieve the latest information about an MPLS tunnel. You do this by
resynchronizing the tunnel, which will cause MCP to load the latest information aobut that tunnel from the
supporting node.

The tunnel resynchronization process is an asynchronous process, and the latest tunnel information is
available only after the resynchronization is completed.

The steps to retrieve the latest tunnel information are:

1. Resync the tunnel

2. Wait for the resync completion
3. Get the latest information

MCP now uses an easy-to-use REST API call, the AsyncTask, to wrap all three steps together.

This topic includes the following sections:

• Retrieving an AsyncTask product ID

• Retrieving information for a unidirectional FRR tunnel
• Retrieving information for a unidirectional FB tunnel

Retrieving an AsyncTask product ID

To create an AsyncTask, we first need to get its product ID. This is a common step that is frequently used
to begin a chain of related API calls.

GET {BP_SERVER}/bpocore/market/api/v1/products

An example of the output in response to this call:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 908
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"items": [
{
"id": "5b0efc15-a4f4-4df3-a2d8-078f80e2433e",
"resourceTypeId": "ifd.v5.resourceTypes.AsyncTask",
"title": "product for ifd.v5.resourceTypes.AsyncTask",
"active": true,
"domainId": "built-in",
"constraints": {},
"providerData": {
"template": "ifd.v5.serviceTemplates.AsyncTask"
}
}
],
"total": 125,
"offset": 0,
"limit": 1000
}

From this response, parse the product ID of AsyncTask:

5b0efc15-a4f4-4df3-a2d8-078f80e2433e

Retrieving information for a unidirectional FRR tunnel

For a unidirectional Fast Reroute (FRR) protected tunnel, you retrieve the set of protecting FB tunnels and
the tunnel’s current active paty.

Input for this call consists of:

• the unidirectional FRR protected tunnel’s top FRE ID

Output returned by this call will include:

• data
◦ id: MPLS top FREAP ID
◦ type: frrProtections
◦ attributes:
◦ frrProtection:
◦ primaryPath: IP link FREAPs of the primary path
◦ activePath: FREAPs of IP links and FB tunnels
◦ protections: a list of nodal protection
▪ NetworkContruct
▪ ip
▪ protectionAvailable: true/false
▪ protectionType: link-protect, node-protect, none

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 909
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

▪ protectionInUse: true/false
▪ protectionFbName: FB tunnel name
▪ protectionFb
• included
◦ a list of referred IP link FREAPs, FB Tunnel FREAPs and NetworkConstructs

First, retrieve an AsyncTask product ID as described at the beginning of this topic.

Then, create an AsyncTask:

POST {BP_SERVER}/bpocore/market/api/v1/resources

Sample request body

{
"productId": "{PID}",
"label": "getUnidirTunnelProtectionInfo1109",
"properties": {
"operationName": "getUnidirTunnelProtectionInfo",
"objectId": "1.1.1.1_6.6.6.6_anUni5to6_TE",
"input": {
}
}
}

Sample response

{
"id": "5b1028cf-b3c7-4d6e-a4dd-de9199bfb0d9",
"label": "getUnidirTunnelProtectionInfo1109",
"resourceTypeId": "ifd.v5.resourceTypes.AsyncTask",
"productId": "5b0efc15-a4f4-4df3-a2d8-078f80e2433e",
"tenantId": "ec5d7efe-9e19-4503-8402-b0fc8b78ba8c",
"shared": false,
"properties": {
"objectId": "1.1.1.1_6.6.6.6_anUni5to6_TE",
"operationName": "getUnidirTunnelProtectionInfo",
"input": {}
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2018-05-31T16:54:40.004Z",
"createdAt": "2018-05-31T16:54:40.004Z",
"autoClean": false
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 910
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Next, retrieve the AsyncTask execution result using an API call like the following:

GET {BP_SERVER}/bpocore/market/api/v1/resources/5b1028cf-b3c7-4d6e-a4dd-de9199bfb0d9

Sample output while the AsyncTask is still running

{
"id": "5b1033b6-64b8-4b79-8fc9-70869ceff6b5",
"label": "getUnidirTunnelProtectionInfo1109",
"resourceTypeId": "ifd.v5.resourceTypes.AsyncTask",
"productId": "5b0efc15-a4f4-4df3-a2d8-078f80e2433e",
"tenantId": "ec5d7efe-9e19-4503-8402-b0fc8b78ba8c",
"shared": false,
"properties": {
"startTime": "2018-05-31T17:41:12.202638+0000",
"state": "executing",
"key": "getUnidirTunnelProtectionInfo",
"stateData": {
"state": "started",
"freId": "1.1.1.1_6.6.6.6_anUni5to6_TE",
"startTime": "2018-05-31 17:41:12.210000+00:00"
},
"objectId": "1.1.1.1_6.6.6.6_anUni5to6_TE",
"maximumTime": 30,
"operationName": "getUnidirTunnelProtectionInfo",
"schedulerCallbackId": "0x000000020002-d2bc8cc5-50f5-4ed3-8990-c4e3b827eaf4",
"input": {}
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "activating",
"reason": "",
"tags": {},
"providerData": {
"templateResources": {}
},
"updatedAt": "2018-05-31T17:41:33.566Z",
"createdAt": "2018-05-31T17:41:11.013Z",
"autoClean": false
}

Sample output when the AsyncTask is complete

{
"items": [
{
"id": "5b1033b6-64b8-4b79-8fc9-70869ceff6b5",
"label": "getUnidirTunnelProtectionInfo1109",
"resourceTypeId": "ifd.v5.resourceTypes.AsyncTask",
"productId": "5b0efc15-a4f4-4df3-a2d8-078f80e2433e",
"tenantId": "ec5d7efe-9e19-4503-8402-b0fc8b78ba8c",
"shared": false,
"properties": {
"startTime": "2018-05-31T17:41:12.202638+0000",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 911
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"state": "completed",
"stateData": {
"state": "completed",
"freId": "1.1.1.1_6.6.6.6_anUni5to6_TE",
"startTime": "2018-05-31 17:41:12.210000+00:00"
},
"endTime": "2018-05-31T17:42:10.436755+0000",
"objectId": "1.1.1.1_6.6.6.6_anUni5to6_TE",
"maximumTime": 30,
"output": {
"included": [
{
"relationships": {
"freDiscovered": {
"data": {
"type": "freDiscovered",
"id": "-4592148412769551661"
}
},
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "-4592148412769551661:1"
},
{
"type": "endPoints",
"id": "-4592148412769551661:2"
}
]
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "2d5b56cf-6f2e-3436-a1bf-
776ceaec245b::FRE_1_EQPTGRP_41_IP_MPLS-VS-PORT104"
},
{
"type": "fres",
"id": "-1031751064053921088"
},
{
"type": "fres",
"id": "de94fa9a-060c-33f6-b852-
6c94d06308f2::FRE_1_EQPTGRP_41_IP_MPLS-VS-PORT104"
}
]
}
},
"attributes": {
"additionalAttributes": {
"isActual": "true"
},
"userLabel": "",
"signalContentType": "IP",
"topologySources": [
"stitched"
],

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 912
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"deploymentState": "discovered",
"derivedAttributes": {
"intentDeploymentState": "waiting to adopt",
"intentLifeCyclePhase": "adopting discovered"
},
"directionality": "bidirectional",
"serviceClass": "IP",
"maxReservableBandwidth": [
{
"layer": "ETHERNET",
"capacitySize": {
"pattern": {
"type": "POOL",
"format": "number"
},
"unit": "mbps",
"size": [
"10000.0"
]
},
"capacity": 1
}
],
"resourceState": "discovered",
"operationState": "In Service",
"displayData": {
"operationState": "Up",
"adminState": "Enabled",
"intentLifeCyclePhaseString": "Discovered"
},
"adminState": "In Service",
"reliability": "manual",
"layerRate": "ETHERNET",
"mgmtName": "MPLS-VS-PORT104",
"policies": {
"defaultAttributeSourcePolicy":
"discoveredOverPlanned",
"overrides": [
{
"attributeName":
"attributes.userLabel",
"policies": [
"plannedOverDiscovered"
]
}
]
},
"networkRole": "FREAP",
"active": true,
"bookingData": {
"bookingFactor": "1",
"bandwidthLockout": false
},
"nativeName": ""
},
"type": "fres",
"id": "-4592148412769551661"
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 913
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"relationships": {
"freDiscovered": {
"data": {
"type": "freDiscovered",
"id": "6009473649510034634"
}
},
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "6009473649510034634:1"
},
{
"type": "endPoints",
"id": "6009473649510034634:2"
}
]
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "267de837-45d6-3fe9-9528-
e19a6765b481::FRE_1_EQPTGRP_7_IP_MPLS-VS-PORT113"
},
{
"type": "fres",
"id": "-6006188797243146606"
},
{
"type": "fres",
"id": "de94fa9a-060c-33f6-b852-
6c94d06308f2::FRE_1_EQPTGRP_41_IP_MPLS-VS-PORT113"
}
]
}
},
"attributes": {
"additionalAttributes": {
"isActual": "true"
},
"userLabel": "",
"signalContentType": "IP",
"topologySources": [
"stitched"
],
"deploymentState": "discovered",
"derivedAttributes": {
"intentDeploymentState": "waiting to adopt",
"intentLifeCyclePhase": "adopting discovered"
},
"directionality": "bidirectional",
"serviceClass": "IP",
"maxReservableBandwidth": [
{
"layer": "ETHERNET",
"capacitySize": {
"pattern": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 914
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"type": "POOL",
"format": "number"
},
"unit": "mbps",
"size": [
"10000.0"
]
},
"capacity": 1
}
],
"resourceState": "discovered",
"operationState": "In Service",
"displayData": {
"operationState": "Up",
"adminState": "Enabled",
"intentLifeCyclePhaseString": "Discovered"
},
"adminState": "In Service",
"reliability": "manual",
"layerRate": "ETHERNET",
"mgmtName": "MPLS-VS-PORT113",
"policies": {
"defaultAttributeSourcePolicy":
"discoveredOverPlanned",
"overrides": [
{
"attributeName":
"attributes.userLabel",
"policies": [
"plannedOverDiscovered"
]
}
]
},
"networkRole": "FREAP",
"active": true,
"bookingData": {
"bookingFactor": "1",
"bandwidthLockout": false
},
"nativeName": ""
},
"type": "fres",
"id": "6009473649510034634"
},
{
"relationships": {
"managementSession": {
"data": {
"type": "managementSessions",
"id": "11584ea8-f6c3-437a-9157-
36129eb1b64b"
}
}
},
"attributes": {
"l2Data": [
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 915
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"loopbackAddresses": [
"1.1.1.1"
],
"shelf": "1",
"dynamicLabelRange": {
"maxValue": 1044479,
"minValue": 32768
},
"benchmarkMacs": [
"00:20:d8:01:35:0a"
],
"staticVcLabelRange": {
"maxValue": 32767,
"minValue": 16384
},
"eqptGrp": "41",
"staticTunnelLabelRange": {
"maxValue": 16383,
"minValue": 16
}
}
],
"macAddress": "00:01:02:03:33:00",
"softwareType": "POTS",
"resourceState": "discovered",
"displayData": {
"displayMACAddress": "00:01:02:03:33:00",
"displaySyncState": "synchronized",
"displayName": "SIM1",
"displayIpAddress": "10.182.244.1"
},
"softwareImage": "",
"longName": "SIM1",
"accessIdentifier": "SHELF-1",
"numberOfShelves": 1,
"typeGroup": "Ciena6500",
"deviceType": "6500-T12 Packet-Optical Shelf
Assembly",
"networkConstructType": "networkElement",
"capabilitySpecRef": "6500.json",
"syncState": {
"state": "synchronized",
"additionalText": "Sync completed 2018-05-
31T16:47:14.048Z"
},
"userData": {
"latitudeLongitudeString": "39.14390396497397,-
55.3715818199921",
"SHELF-1-SUBNETNAME": ""
},
"associationState": "GOA",
"additionalAttributes": {
"slte": "false",
"eqptGroups": "EQPTGRP-1-41",
"subtending_passive": "false",
"repeaterSystem": "",
"tidc": "disabled",
"isFlexCapable": "true"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 916
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"name": "SIM1",
"resourceType": "6500",
"serialNumber": "NNTMSIMQ0001",
"softwareVersion": "13.0.0",
"subnetName": "",
"ipAddress": "10.182.244.1",
"deviceVersion": "6500-T12 PACKET-OPTICAL"
},
"type": "networkConstructs",
"id": "2d5b56cf-6f2e-3436-a1bf-776ceaec245b"
},
{
"relationships": {
"managementSession": {
"data": {
"type": "managementSessions",
"id": "e7bd878a-371b-43f4-ab54-
ed3c36004a1e"
}
}
},
"attributes": {
"l2Data": [
{
"loopbackAddresses": [
"4.4.4.4"
],
"shelf": "1",
"dynamicLabelRange": {
"maxValue": 1044479,
"minValue": 32768
},
"benchmarkMacs": [
"00:20:d8:04:35:0a"
],
"staticVcLabelRange": {
"maxValue": 32767,
"minValue": 16384
},
"eqptGrp": "41",
"staticTunnelLabelRange": {
"maxValue": 16383,
"minValue": 16
}
}
],
"macAddress": "00:01:02:03:3F:00",
"softwareType": "POTS",
"resourceState": "discovered",
"displayData": {
"displayMACAddress": "00:01:02:03:3F:00",
"displaySyncState": "synchronized",
"displayName": "SIM4",
"displayIpAddress": "10.182.244.4"
},
"softwareImage": "",
"longName": "SIM4",
"accessIdentifier": "SHELF-1",
"numberOfShelves": 1,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 917
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"typeGroup": "Ciena6500",
"deviceType": "6500-T12 Packet-Optical Shelf
Assembly",
"networkConstructType": "networkElement",
"capabilitySpecRef": "6500.json",
"syncState": {
"state": "synchronized",
"additionalText": "Sync completed 2018-05-
30T20:27:38.406Z"
},
"userData": {
"latitudeLongitudeString": "16.44752511559136,-
26.017972180478214",
"SHELF-1-SUBNETNAME": ""
},
"associationState": "GOA",
"additionalAttributes": {
"slte": "false",
"eqptGroups": "EQPTGRP-1-41",
"subtending_passive": "false",
"repeaterSystem": "",
"tidc": "disabled",
"isFlexCapable": "true"
},
"name": "SIM4",
"resourceType": "6500",
"serialNumber": "NNTMSIMQ0001",
"softwareVersion": "13.0.0",
"subnetName": "",
"ipAddress": "10.182.244.4",
"deviceVersion": "6500-T12 PACKET-OPTICAL"
},
"type": "networkConstructs",
"id": "de94fa9a-060c-33f6-b852-6c94d06308f2"
},
{
"relationships": {
"managementSession": {
"data": {
"type": "managementSessions",
"id": "2374773f-d7a1-4df4-8dde-
6c01606eb885"
}
}
},
"attributes": {
"l2Data": [
{
"loopbackAddresses": [
"6.6.6.6"
],
"shelf": "1",
"dynamicLabelRange": {
"maxValue": 984479,
"minValue": 32768
},
"benchmarkMacs": [
"00:20:d8:06:35:0a"
],

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 918
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"staticVcLabelRange": {
"maxValue": 32767,
"minValue": 16384
},
"eqptGrp": "7",
"staticTunnelLabelRange": {
"maxValue": 16383,
"minValue": 2016
}
}
],
"macAddress": "00:01:02:03:47:00",
"softwareType": "OCP",
"resourceState": "discovered",
"displayData": {
"displayMACAddress": "00:01:02:03:47:00",
"displaySyncState": "synchronized",
"displayName": "SIM6",
"displayIpAddress": "10.182.244.6"
},
"softwareImage": "",
"longName": "SIM6",
"accessIdentifier": "SHELF-1",
"numberOfShelves": 1,
"typeGroup": "Ciena6500",
"deviceType": "6500 14-Slot Packet-Optical Shelf
Assembly",
"networkConstructType": "networkElement",
"capabilitySpecRef": "6500.json",
"syncState": {
"state": "synchronized",
"additionalText": "Sync completed 2018-05-
30T20:30:22.657Z"
},
"userData": {
"latitudeLongitudeString":
"30.227748642153202,-10.006912377107005",
"SHELF-1-SUBNETNAME": ""
},
"associationState": "GOA",
"additionalAttributes": {
"slte": "false",
"eqptGroups": "EQPTGRP-1-7",
"subtending_passive": "false",
"repeaterSystem": "",
"tidc": "disabled",
"isFlexCapable": "true"
},
"name": "SIM6",
"resourceType": "6500",
"serialNumber": "NNTMSIMP0001",
"softwareVersion": "13.0.0",
"subnetName": "",
"ipAddress": "10.182.244.6",
"deviceVersion": "6500 OPTICAL"
},
"type": "networkConstructs",
"id": "267de837-45d6-3fe9-9528-e19a6765b481"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 919
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"relationships": {
"freDiscovered": {
"data": {
"type": "freDiscovered",
"id": "1.1.1.1_6.6.6.6_Auto_facility-2-
2002_TE"
}
},
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "1.1.1.1_6.6.6.6_Auto_facility-2-
2002_TE::EP0"
},
{
"type": "endPoints",
"id": "1.1.1.1_6.6.6.6_Auto_facility-2-
2002_TE::EP1"
}
]
},
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "2d5b56cf-6f2e-3436-a1bf-
776ceaec245b"
}
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "5420039198703853488"
},
{
"type": "fres",
"id": "-3937143407364792189"
},
{
"type": "fres",
"id": "6c66c638-7a81-31c2-8a47-
a6a0c480a7b7::FRE_1_EQPTGRP_41_MPLS_Auto_facility-2-
2002_transit_32775_32772_1.1.1.1"
}
]
}
},
"attributes": {
"additionalAttributes": {
"resiliency": "Normal",
"isActual": "true"
},
"userLabel": "Auto_facility-2-2002",
"signalContentType": "LSP",
"serviceClass": "Tunnel",
"topologySources": [
"discovered"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 920
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

],
"deploymentState": "discovered",
"derivedAttributes": {
"intentDeploymentState": "waiting to adopt",
"intentLifeCyclePhase": "adopting discovered"
},
"directionality": "unidirectional",
"identifiers": [
{
"nodalId": "1.1.1.1_6.6.6.6_Auto_facility-
2-2002_TE",
"networkConstructId": "2d5b56cf-6f2e-3436-
a1bf-776ceaec245b"
}
],
"maxReservableBandwidth": [
{
"layer": "ETHERNET",
"capacitySize": {
"pattern": {
"type": "POOL",
"format": "number"
},
"unit": "mbps",
"size": [
"0.0"
]
},
"capacity": 1
}
],
"resourceState": "discovered",
"operationState": "In Service",
"displayData": {
"operationState": "Up",
"adminState": "Enabled",
"intentLifeCyclePhaseString": "Discovered"
},
"adminState": "In Service",
"mplsPackage": {
"direction": "unidirectional",
"destIp": "6.6.6.6",
"facilityBypass": true,
"signaled": true,
"subType": "TE",
"lspName": "Auto_facility-2-2002",
"bw": {
"bwMinKbps": "0",
"bwIncrKbps": "0",
"bwUsedKbps": "0",
"bwAutoSizeIntervalMinutes": "0",
"bwMaxKbps": "0",
"bwMode": "cac",
"bwAutoSize": "disable",
"bwAutoSizeFailureAction": "alarm"
},
"srcIp": "1.1.1.1",
"explicitRouteObject": [
"12.101.5.2",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 921
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"26.101.8.2"
],
"coRouted": false,
"ctrlPlaneId": "1.1.1.1_6.6.6.6_Auto_facility-
2-2002"
},
"layerRate": "MPLS",
"mgmtName": "Auto_facility-2-2002",
"policies": {
"defaultAttributeSourcePolicy":
"discoveredOverPlanned",
"overrides": [
{
"attributeName":
"attributes.userLabel",
"policies": [
"plannedOverDiscovered"
]
}
]
},
"networkRole": "FREAP",
"active": true,
"bookingData": {
"bandwidthLockout": false
}
},
"type": "fres",
"id": "1.1.1.1_6.6.6.6_Auto_facility-2-2002_TE"
},
{
"relationships": {
"freDiscovered": {
"data": {
"type": "freDiscovered",
"id": "4.4.4.4_6.6.6.6_Auto_facility-2-
2001_TE"
}
},
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "4.4.4.4_6.6.6.6_Auto_facility-2-
2001_TE::EP0"
},
{
"type": "endPoints",
"id": "4.4.4.4_6.6.6.6_Auto_facility-2-
2001_TE::EP1"
}
]
},
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "de94fa9a-060c-33f6-b852-
6c94d06308f2"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 922
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "-7398221656540929317"
},
{
"type": "fres",
"id": "5420039198703853488"
}
]
}
},
"attributes": {
"additionalAttributes": {
"resiliency": "Normal",
"isActual": "true"
},
"userLabel": "Auto_facility-2-2001",
"signalContentType": "LSP",
"serviceClass": "Tunnel",
"topologySources": [
"discovered"
],
"deploymentState": "discovered",
"derivedAttributes": {
"intentDeploymentState": "waiting to adopt",
"intentLifeCyclePhase": "adopting discovered"
},
"directionality": "unidirectional",
"identifiers": [
{
"nodalId": "4.4.4.4_6.6.6.6_Auto_facility-
2-2001_TE",
"networkConstructId": "de94fa9a-060c-33f6-
b852-6c94d06308f2"
}
],
"maxReservableBandwidth": [
{
"layer": "ETHERNET",
"capacitySize": {
"pattern": {
"type": "POOL",
"format": "number"
},
"unit": "mbps",
"size": [
"0.0"
]
},
"capacity": 1
}
],
"resourceState": "discovered",
"operationState": "In Service",
"displayData": {
"operationState": "Up",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 923
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"adminState": "Enabled",
"intentLifeCyclePhaseString": "Discovered"
},
"adminState": "In Service",
"mplsPackage": {
"direction": "unidirectional",
"destIp": "6.6.6.6",
"facilityBypass": true,
"signaled": true,
"subType": "TE",
"lspName": "Auto_facility-2-2001",
"bw": {
"bwMinKbps": "0",
"bwIncrKbps": "0",
"bwUsedKbps": "0",
"bwAutoSizeIntervalMinutes": "0",
"bwMaxKbps": "0",
"bwMode": "cac",
"bwAutoSize": "disable",
"bwAutoSizeFailureAction": "alarm"
},
"srcIp": "4.4.4.4",
"explicitRouteObject": [
"24.101.7.1",
"26.101.8.2"
],
"coRouted": false,
"ctrlPlaneId": "4.4.4.4_6.6.6.6_Auto_facility-
2-2001"
},
"layerRate": "MPLS",
"mgmtName": "Auto_facility-2-2001",
"policies": {
"defaultAttributeSourcePolicy":
"discoveredOverPlanned",
"overrides": [
{
"attributeName":
"attributes.userLabel",
"policies": [
"plannedOverDiscovered"
]
}
]
},
"networkRole": "FREAP",
"active": true,
"bookingData": {
"bandwidthLockout": false
}
},
"type": "fres",
"id": "4.4.4.4_6.6.6.6_Auto_facility-2-2001_TE"
}
],
"data": {
"relationships": {
"freDiscovered": {
"data": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 924
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"type": "freDiscovered",
"id": "1.1.1.1_6.6.6.6_anUni5to6_TE"
}
},
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "1.1.1.1_6.6.6.6_anUni5to6_TE::EP0"
},
{
"type": "endPoints",
"id": "1.1.1.1_6.6.6.6_anUni5to6_TE::EP1"
}
]
},
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "2d5b56cf-6f2e-3436-a1bf-776ceaec245b"
}
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "-4592148412769551661"
},
{
"type": "fres",
"id": "6009473649510034634"
},
{
"type": "fres",
"id": "de94fa9a-060c-33f6-b852-
6c94d06308f2::FRE_1_EQPTGRP_41_MPLS_anUni5to6_transit_32773_32776_1.1.1.1"
}
]
}
},
"attributes": {
"resourceState": "discovered",
"displayData": {
"operationState": "Up",
"adminState": "Enabled",
"intentLifeCyclePhaseString": "Discovered"
},
"maxReservableBandwidth": [
{
"layer": "ETHERNET",
"capacitySize": {
"pattern": {
"type": "POOL",
"format": "number"
},
"unit": "mbps",
"size": [
"0.1"
]

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 925
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

},
"capacity": 1
}
],
"mplsPackage": {
"direction": "unidirectional",
"destIp": "6.6.6.6",
"facilityBypass": false,
"signaled": true,
"subType": "TE",
"lspName": "anUni5to6",
"bw": {
"bwMinKbps": "10",
"bwIncrKbps": "10",
"bwUsedKbps": "0",
"bwAutoSizeIntervalMinutes": "0",
"bwMaxKbps": "100",
"bwMode": "cac",
"bwAutoSize": "enable",
"bwAutoSizeFailureAction": "alarm"
},
"srcIp": "1.1.1.1",
"explicitRouteObject": [
"14.101.3.1",
"14.101.3.2",
"46.101.11.2"
],
"coRouted": false,
"ctrlPlaneId": "1.1.1.1_6.6.6.6_anUni5to6"
},
"topologySources": [
"discovered"
],
"deploymentState": "discovered",
"userLabel": "anUni5to6",
"adminState": "In Service",
"bookingData": {
"bandwidthLockout": false
},
"derivedAttributes": {
"intentDeploymentState": "waiting to adopt",
"intentLifeCyclePhase": "adopting discovered"
},
"frrProtection": {
"activePath": [
{
"type": "fres",
"id": "-4592148412769551661"
},
{
"type": "fres",
"id": "6009473649510034634"
}
],
"protections": [
{
"networkConstruct": {
"type": "networkConstructs",
"id": "2d5b56cf-6f2e-3436-a1bf-

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 926
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

776ceaec245b"
},
"ip": "14.101.3.1",
"bwProtected": false,
"protectionFbName": "Auto_facility-2-2002",
"protectionInUse": false,
"protectionFb": {
"type": "fres",
"id": "1.1.1.1_6.6.6.6_Auto_facility-2-
2002_TE"
},
"protectionAvailable": true,
"protectionType": "node-protect"
},
{
"networkConstruct": {
"type": "networkConstructs",
"id": "de94fa9a-060c-33f6-b852-
6c94d06308f2"
},
"ip": "14.101.3.2",
"bwProtected": false,
"protectionFbName": "Auto_facility-2-2001",
"protectionInUse": false,
"protectionFb": {
"type": "fres",
"id": "4.4.4.4_6.6.6.6_Auto_facility-2-
2001_TE"
},
"protectionAvailable": true,
"protectionType": "link-protect"
},
{
"ip": "46.101.11.2",
"bwProtected": false,
"networkConstruct": {
"type": "networkConstructs",
"id": "267de837-45d6-3fe9-9528-
e19a6765b481"
},
"protectionInUse": false,
"protectionType": "none"
}
],
"primaryPath": [
{
"type": "fres",
"id": "-4592148412769551661"
},
{
"type": "fres",
"id": "6009473649510034634"
}
]
},
"serviceClass": "Tunnel",
"mgmtName": "anUni5to6",
"layerRate": "MPLS",
"active": true,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 927
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"additionalAttributes": {
"resiliency": "Protected",
"isActual": "true"
},
"signalContentType": "LSP",
"identifiers": [
{
"nodalId": "1.1.1.1_6.6.6.6_anUni5to6_TE",
"networkConstructId": "2d5b56cf-6f2e-3436-a1bf-
776ceaec245b"
}
],
"directionality": "unidirectional",
"operationState": "In Service",
"networkRole": "FREAP",
"policies": {
"defaultAttributeSourcePolicy":
"discoveredOverPlanned",
"overrides": [
{
"attributeName": "attributes.userLabel",
"policies": [
"plannedOverDiscovered"
]
}
]
}
},
"type": "frrProtections",
"id": "1.1.1.1_6.6.6.6_anUni5to6_TE"
}
},
"operationName": "getUnidirTunnelProtectionInfo",
"input": {}
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {
"templateResources": {}
},
"updatedAt": "2018-05-31T17:42:10.762Z",
"createdAt": "2018-05-31T17:41:11.013Z",
"autoClean": false
}
],
"total": 1,
"offset": 0,
"limit": 1000
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 928
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Retrieving information for a unidirectional FB tunnel

Similarly, you can use an AsyncTask to retrieve the set of FRR tunnels that are being protected by a given
FB tunnel.

Input:

• the FB tunnel’s top FRE ID

Output:

• data
◦ A list of protected unidirectional FRR tunnel FREs

First, retrieve an AsyncTask product ID as described at the beginning of this topic.

Then, create an AsyncTask:

POST {BP_SERVER}/bpocore/market/api/v1/resources

sample body

{ "productId": "{PID}", "label": "getFbProtectedTunnels956", "properties": { "operationName":

"getFbProtectedTunnels", "objectId": "4.4.4.4_6.6.6.6_Auto_facility-2-2001_TE", "input": { } } }

Sample reponse

{
"id": "5b10356b-9110-45a9-89d0-77febabad4ec",
"label": "getFbProtectedTunnels956",
"resourceTypeId": "ifd.v5.resourceTypes.AsyncTask",
"productId": "5b0efc15-a4f4-4df3-a2d8-078f80e2433e",
"tenantId": "ec5d7efe-9e19-4503-8402-b0fc8b78ba8c",
"shared": false,
"properties": {
"objectId": "4.4.4.4_6.6.6.6_Auto_facility-2-2001_TE",
"operationName": "getFbProtectedTunnels",
"input": {}
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "requested",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2018-05-31T17:48:27.618Z",
"createdAt": "2018-05-31T17:48:27.618Z",
"autoClean": false

You can retrieve the AsyncTask execution result with the following call:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 929
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

GET {BP_SERVER}/bpocore/market/api/v1/resources/5b1028cf-b3c7-4d6e-a4dd-de9199bfb0d9

Sample response

{
"items": [
{
"id": "5b103ae6-983b-4673-a6fa-40bf68d9d060",
"label": "getFbProtectedTunnels956",
"resourceTypeId": "ifd.v5.resourceTypes.AsyncTask",
"productId": "5b06566a-5e7f-40ec-b9c2-463c5ae83156",
"tenantId": "89a13712-c857-4364-b7e8-ec30d37861af",
"shared": false,
"properties": {
"startTime": "2018-05-31T18:11:51.488273+0000",
"state": "completed",
"stateData": {
"state": "completed",
"freId": "1.1.1.1_4.4.4.4_Auto_facility-47-2008_TE",
"startTime": "2018-05-31 18:11:51.491552+00:00"
},
"endTime": "2018-05-31T18:12:35.603145+0000",
"objectId": "1.1.1.1_4.4.4.4_Auto_facility-47-2008_TE",
"maximumTime": 30,
"output": {
"data": [
{
"relationships": {
"freDiscovered": {
"data": {
"type": "freDiscovered",
"id": "1.1.1.1_6.6.6.6_K1-Ucons-lpbk_TE"
}
},
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "1.1.1.1_6.6.6.6_K1-Ucons-
lpbk_TE::EP0"
},
{
"type": "endPoints",
"id": "1.1.1.1_6.6.6.6_K1-Ucons-
lpbk_TE::EP1"
}
]
},
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "2d5b56cf-6f2e-3436-a1bf-
776ceaec245b"
}
},
"partitionFres": {
"data": [

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 930
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"type": "fres",
"id": "67a42211-14f0-34ad-96f1-
1b6158782303::FRE_1_EQPTGRP_41_MPLS_K1-Ucons-lpbk_transit_32779_32826_1.1.1.1"
},
{
"type": "fres",
"id": "6009473649510034634"
},
{
"type": "fres",
"id": "de94fa9a-060c-33f6-b852-
6c94d06308f2::FRE_1_EQPTGRP_41_MPLS_K1-Ucons-lpbk_transit_32826_32786_1.1.1.1"
},
{
"type": "fres",
"id": "6236978574003829479"
},
{
"type": "fres",
"id": "-406428413080187401"
}
]
}
},
"attributes": {
"additionalAttributes": {
"resiliency": "Protected",
"isActual": "true"
},
"userLabel": "K1-Ucons-lpbk",
"signalContentType": "LSP",
"serviceClass": "Tunnel",
"topologySources": [
"discovered"
],
"deploymentState": "discovered",
"derivedAttributes": {
"intentDeploymentState": "waiting to adopt",
"intentLifeCyclePhase": "adopting discovered"
},
"directionality": "unidirectional",
"identifiers": [
{
"nodalId": "1.1.1.1_6.6.6.6_K1-Ucons-
lpbk_TE",
"networkConstructId": "2d5b56cf-6f2e-3436-
a1bf-776ceaec245b"
}
],
"maxReservableBandwidth": [
{
"layer": "ETHERNET",
"capacitySize": {
"pattern": {
"type": "POOL",
"format": "number"
},
"unit": "mbps",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 931
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"size": [
"2.0"
]
},
"capacity": 1
}
],
"resourceState": "discovered",
"operationState": "In Service",
"displayData": {
"operationState": "Up",
"adminState": "Enabled",
"intentLifeCyclePhaseString": "Discovered"
},
"adminState": "In Service",
"mplsPackage": {
"direction": "unidirectional",
"destIp": "6.6.6.6",
"facilityBypass": false,
"signaled": true,
"subType": "TE",
"lspName": "K1-Ucons-lpbk",
"bw": {
"bwMinKbps": "2000",
"bwIncrKbps": "2",
"bwUsedKbps": "0",
"bwAutoSizeIntervalMinutes": "8",
"bwMaxKbps": "2000",
"bwMode": "cac",
"bwAutoSize": "enable",
"bwAutoSizeFailureAction": "alarm"
},
"srcIp": "1.1.1.1",
"explicitRouteObject": [
"13.101.2.1",
"13.101.2.2",
"34.101.10.2",
"46.101.11.2"
],
"coRouted": false,
"ctrlPlaneId": "1.1.1.1_6.6.6.6_K1-Ucons-lpbk"
},
"layerRate": "MPLS",
"mgmtName": "K1-Ucons-lpbk",
"policies": {
"defaultAttributeSourcePolicy":
"discoveredOverPlanned",
"overrides": [
{
"attributeName":
"attributes.userLabel",
"policies": [
"plannedOverDiscovered"
]
}
]
},
"networkRole": "FREAP",
"active": true,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 932
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"bookingData": {
"bandwidthLockout": false
}
},
"type": "fres",
"id": "1.1.1.1_6.6.6.6_K1-Ucons-lpbk_TE"
}
]
},
"operationName": "getFbProtectedTunnels",
"input": {}
},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {
"templateResources": {}
},
"updatedAt": "2018-05-31T18:12:35.661Z",
"createdAt": "2018-05-31T18:11:51.001Z",
"autoClean": false
}
],
"total": 1,
"offset": 0,
"limit": 1000
}

Manually invoke an immediate optimization for a unidirectional

tunnel
If you see that an MPLS LSP (either unidirectinal or co-routed/bidirectional) could be more efficiently
routed, you can use the REST API to have MCP immediately move the LSP to a more optimal route based
on the current topology so that it uses a minimum of resources.

Note: This operation will fail if executed on an LSP that has been configured as "Never optimize".

Performing an immediate optimization consists of three steps:

1. Retrieve the MplsOperationContainer resource ID.

2. Execute the tunnel group reoptimize.
3. Verify the status of reoptimize operation.

Retrieve the resource ID

Retrieve the MplsOperationContainer resource ID using the following API call:

GET

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 933
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{{BP_SERVER}}/bpocore/market/api/v1/resources?exactTypeId=ifd.v2.resourceTypes.MplsOperationCon
tainer

Sample request

GET
{{BP_SERVER}}/bpocore/market/api/v1/resources?exactTypeId=ifd.v2.resourceTypes.MplsOperationCon
tainer

Sample response

{
"items": [
{
"id": "5955a92c-a8fa-4337-9036-875eafe449c2",
"label": "Resource for ifd.v2.resourceTypes.MplsOperationContainer",
"resourceTypeId": "ifd.v2.resourceTypes.MplsOperationContainer",
"productId": "5955a910-5b13-4c6f-b8bc-32a5b80662ae",
"tenantId": "748d7633-80b7-4d1a-98e5-aa27e38ccdb3",
"shared": false,
"properties": {},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2018-01-30T01:28:13.249Z",
"createdAt": "2018-01-30T01:28:12.558Z",
"autoClean": false
},
{
"id": "5955a92d-1f6a-4b41-aa36-8019be2dfd84",
"label": "Resource for ifd.v2.resourceTypes.MplsOperationContainer",
"resourceTypeId": "ifd.v2.resourceTypes.MplsOperationContainer",
"productId": "5955a910-5b13-4c6f-b8bc-32a5b80662ae",
"tenantId": "748d7633-80b7-4d1a-98e5-aa27e38ccdb3",
"shared": false,
"properties": {},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2018-01-30T01:28:15.786Z",
"createdAt": "2018-01-30T01:28:14.392Z",
"autoClean": false
},
{
"id": "5955a92f-219f-440b-8be1-a1507bda8e83",
"label": "Resource for ifd.v2.resourceTypes.MplsOperationContainer",
"resourceTypeId": "ifd.v2.resourceTypes.MplsOperationContainer",
"productId": "5955a910-5b13-4c6f-b8bc-32a5b80662ae",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 934
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

"tenantId": "748d7633-80b7-4d1a-98e5-aa27e38ccdb3",
"shared": false,
"properties": {},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2018-01-30T01:28:17.995Z",
"createdAt": "2018-01-30T01:28:16.443Z",
"autoClean": false
},
{
"id": "5955a933-0811-4e98-9676-1b243e3b5c59",
"label": "Resource for ifd.v2.resourceTypes.MplsOperationContainer",
"resourceTypeId": "ifd.v2.resourceTypes.MplsOperationContainer",
"productId": "5955a910-5b13-4c6f-b8bc-32a5b80662ae",
"tenantId": "748d7633-80b7-4d1a-98e5-aa27e38ccdb3",
"shared": false,
"properties": {},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2018-01-30T01:28:21.620Z",
"createdAt": "2018-01-30T01:28:19.593Z",
"autoClean": false
},
{
"id": "5955a936-cfe0-4c4d-9a03-bdbde2ecaf09",
"label": "Resource for ifd.v2.resourceTypes.MplsOperationContainer",
"resourceTypeId": "ifd.v2.resourceTypes.MplsOperationContainer",
"productId": "5955a910-5b13-4c6f-b8bc-32a5b80662ae",
"tenantId": "748d7633-80b7-4d1a-98e5-aa27e38ccdb3",
"shared": false,
"properties": {},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2018-01-30T01:28:23.742Z",
"createdAt": "2018-01-30T01:28:22.469Z",
"autoClean": false
}
],
"total": 5,
"offset": 0,
"limit": 1000
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 935
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

In the response, note the list of MplsOperationContainer resources. Every resource in the response has an
attribute named "id".

You can choose one resource from the returned list, and use the value of the id property to execute the
tunnel reoptimization.

Execute the tunnel reoptimization

Perform the optimization using the following API call:

POST {{BP_SERVER}}/bpocore/market/api/v1/resources/{{RID}}/operations

Sample request

POST {{BP_SERVER}}/bpocore/market/api/v1/resources/{{RID}}/operations

{
"interface": "reoptimize",
"inputs": {
"freId": "6515318274086203180"
}
}

Parameter Description

Interface Reoptimize as the default value for this operation..

Inputs Input data for the reoptimize operation.

freId Tunnel group fre ID

Sample response

{
"id": "5956d1d6-d0e1-45d7-a636-587815eb9736",
"resourceId": "5955a92d-1f6a-4b41-aa36-8019be2dfd84",
"interface": "reoptimize",
"inputs": {
"freId": "6515318274086203180"
},
"outputs": {},
"state": "requested",
"reason": "",
"createdAt": "2018-01-30T22:33:58.889Z",
"updatedAt": "2018-01-30T22:33:58.889Z",
"resourceStateConstraints": {}
}

Note: The “id” in the response (above) is the reoptimize operation id.

Use this id to retreive:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 936
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

• Retrieve the status of the tunnel group reoptimize operation.

• Retrieve the status of tunnel group reoptimize operation.

Retrieve the status of the operation

Retrieve the status of the optimization using the following API call:

{{BP_SERVER}}/bpocore/market/api/v1/resources/{{RID}}/operations/{{OID}}

• RID is the MplsOperationContainer resource ID used as part of executing the reoptimize operation.
• OID is the operation ID generated as part of tunnel group reoptimize operation.

Sample Request

GET {{BP_SERVER}}/bpocore/market/api/v1/resources/{{RID}}/operations/{{OID}}

Sample Response

{
"id": "5956d1d6-d0e1-45d7-a636-587815eb9736",
"resourceId": "5955a92d-1f6a-4b41-aa36-8019be2dfd84",
"interface": "reoptimize",
"inputs": {
"freId": "-3770626729195966017"
},
"outputs": {},
"state": "successful",
"reason": "",
"createdAt": "2018-01-30T22:33:58.889Z",
"updatedAt": "2018-01-30T22:34:04.846Z",
"resourceStateConstraints": {}
}

Managing Fast Rerouting (FRR) profiles

An MPLS Fast Reroute (FRR) profile supports the local repair of a dynamic, unidirectional LSP following a
failure in the LSP’s active path. Fast Reroute mechanisms enable the rapid re-direction of traffic from the
failed active path onto a backup path.

MCP supports the creation, editing, and deletion of FRR profiles on SAOS 6.x and 8700 devices using the
REST API.

This topic describes using the REST API to:

• create an FRR profile

• edit an FRR profile
• delete an FRR profile

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 937
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Creating an FRR profile

To create an FRR profile, use the Configuration Management (configmgmt) API. As part of the API call to
create the profile, provide the values described in the table below.

ATTRIBUTE DATA TYPE SUPPORTED VALUES

frrProfileName string The FRR Profile name can

consist of 1 to 31 characters,
excluding the following: !%,?*

setupPriority integer A value from 0 to 7

holdPriority integer A value from 0 to 7

hopLimit integer A value from 0 to 255

bandwidth integer A value from 1000 to 1000000

bwProtection string "yes" or "no"

nodeProtection string "yes" or "no"

protectionMethod string "detour" or "facility"

colourGroupIncludeAny integer A value from 0 to 31

colourGroupIncludeAll integer A value from 0 to 31

colourGroupExcludeAny integer A value from 0 to 31

Sample request

POST {{BP_SERVER}}/configmgmt/api/v1/jobs

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 938
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "frrProfileConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "create",
"frrProfileName": "fr_test1",
"setupPriority": 3,
"holdPriority": 4,
"hopLimit": 100,
"bandwidth": 1000,
"bwProtection": "yes",
"nodeProtection": "yes",
"protectionMethod": "detour",
"colourGroupIncludeAny": 10,
"colourGroupIncludeAll": 11,
"colourGroupExcludeAny": 12
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 939
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Editing an FRR profile

Edit an FRR profile using the Configuration Management (configmgmt) API.

The action in this case is "update", and you must provide the values to configure the FRR profile including
the new values you are setting.

Sample request

POST {{BP_SERVER}}/configmgmt/api/v1/jobs

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 940
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "frrProfileConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "update",
"frrProfileName": "fr_test1",
"setupPriority": 3,
"holdPriority": 4,
"hopLimit": 100,
"bandwidth": 1000,
"bwProtection": "yes",
"nodeProtection": "yes",
"protectionMethod": "detour",
"colourGroupIncludeAny": 10,
"colourGroupIncludeAll": 11,
"colourGroupExcludeAny": 12
}
}
]
}
]
}
]
},
"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 941
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

Deleting an FRR profile

Delete an FRR profile using the Configuration Management (configmgmt) API.

The action in this case is "delete", and you must provide the name of the FRR profile you are deleting.

Sample request

POST {{BP_SERVER}}/configmgmt/api/v1/jobs

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 942
Blue Planet MCP API Reference Guide, Release 18.06 Packet service management

{
"data": {
"type": "jobs",
"attributes": {
"maxConnections": "10",
"scheduleTime": "2017-05-13T04:31:28.211+0000",
"scripts": [
{
"scriptName": "frrProfileConfig",
"inputs": [
{
"data": [
{
"attributes": {
"action": "delete",
"frrProfileName": "fr_test1"
}
}
]
}
]
}
]
},

"relationships": {
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "{{MANAGEMENT_SESSION_ID}}"
}
]
}
}
},
"included": [
{
"id": "{{MANAGEMENT_SESSION_ID}}",
"type": "networkElement",
"attributes": {
"ncId": "{{MANAGEMENT_SESSION_ID}}",
"neName": "{{NE_NAME}}",
"ipAddress": "{{NE_IP_ADDRESS}}",
"neType": "{{NE_TYPE}}"
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 943
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

Transport service management

This section describes some of the transport service management tasks that you can perform using MCP
REST APIs.

Note: The IFD API version numbers (for example, “v2” in “ifd.v2.resourceTypes”) that appear in this
chapter do not necessarily reflect the IFD API version numbers associated with this current Blue Planet
MCP release. They are provided only as an example. IFD API version numbers may be higher than those
shown in this chapter. For a list of supported releases and their related version numbers, see the
"Versioning" section in the MCP REST API overview chapter.

This section includes the following topics:

• Visualize optical power

• Create an OTU4 service intent
• Create a 100G service intent
• Create a 10G service intent
• Create an OTU4 service intent over planned equipment
• Retrieve a feasible route
• Undeploy a service intent
• Retrieve spectral allocation
• Perform loopback test for connection validation
• Retrieve results for a loopback test on transponder line ports
• Manage bandwidth lockout for an OMS link section
• Delete a discovered Layer 0 service
• Channel margins
• Retrieve co-routed FREs
• Add, update, or delete the customerName and note attributes for a planned or discovered service
• Add or update the userLabel attribute for a planned service
• Add or update the userLabel attribute for a discovered service

Visualize optical power

This section provides examples of retrieving optical power data for a transport service, including:

• Obtain the FRE(s) to report

• Channel power
• Total power
• Spectrum power

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 944
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

Obtain the FRE(s) to report

To retrieve the FRE(s) with which to retrieve optical power, use the Service Inventory (FREs) API.

Requirements

Before you start, make sure that you

• have the required parameter. In your request, you must specify at least one of the following
parameters:
◦ tpeId
◦ networkConstruct.id
◦ ncId (Deprecated)
◦ group
◦ freExpectations.serviceIntent.id
◦ freExpectations.equipmentIntent.id
◦ childFreId
◦ endpoint.tpe.concrete
◦ identifiers
• identify one, or more FREs for which to retrieve optical power data, for example,
-8032246870464230076.

Sample request

GET {{MCP_SERVER}}/nsi/api/fres

Sample response

{
"meta": {
"total": 7,
"aggregations": []
},
"links": {},
"data": [
{
"id": "-8562028732694322491",
"type": "fres",
"attributes": {
"userLabel": "",
"mgmtName": "",
"nativeName": "",
"layerRate": "OTU4",
"networkRole": "FREAP",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 945
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"directionality": "bidirectional",
"userData": {
"ossLabel": "line_0210"
},
"identifiers": [
{
"ossLabel": "line_0210"
}
],
"additionalAttributes": {
"isActual": "true"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "-8562028732694322491:1"
},
{
"type": "endPoints",
"id": "-8562028732694322491:2"
}
]
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "-5579483252134356916"
}
]
}
}
},
{
"id": "-8032246870464230076",
"type": "fres",
"attributes": {
"userLabel": "",
"mgmtName": "",
"nativeName": "",
"layerRate": "OTU4",
"networkRole": "FREAP",
"directionality": "bidirectional",
"additionalAttributes": {
"isActual": "true"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "8032246870464230076:1"
},
{
"type": "endPoints",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 946
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"id": "8032246870464230076:2"
}
]
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "2953964013045314283"
}
]
}
}
},
{
"id": "8437235193544607970",
"type": "fres",
"attributes": {
"userLabel": "",
"mgmtName": "",
"nativeName": "",
"layerRate": "OTU4",
"networkRole": "FREAP",
"directionality": "bidirectional",
"additionalAttributes": {
"isActual": "true"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "8437235193544607970:1"
},
{
"type": "endPoints",
"id": "8437235193544607970:2"
}
]
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "-4431525917090832543"
}
]
}
}
},
{
"id": "3539955230191161553",
"type": "fres",
"attributes": {
"userLabel": "",
"mgmtName": "",
"nativeName": "",
"layerRate": "OTU4",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 947
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"networkRole": "FREAP",
"directionality": "bidirectional",
"additionalAttributes": {
"isActual": "true"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "3539955230191161553:1"
},
{
"type": "endPoints",
"id": "3539955230191161553:2"
}
]
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "4816616886895359187"
}
]
}
}
},
{
"id": "3c27dfba-1bf5-4af5-a9ee-aa2443c3a8e5",
"type": "fres",
"attributes": {
"userLabel": "1026",
"nativeName": "SNC0-15-1026",
"layerRate": "OTSi",
"networkRole": "IFRE",
"directionality": "bidirectional",
"operationState": "fully operating",
"controlActivityState": "activating",
"modelType": "controlPlane",
"identifiers": [
{
"incarnation": "1",
"circuitId": "PV0210FGA_SNC0-11-2"
},
{
"networkConstructId": "a2c36396-1c5f-3108-84b6-ed97c1fc52b7",
"nodalId": "OSRP0-15-1::SNC0-15-1026"
}
],
"freType": "snc",
"additionalAttributes": {
"isActual": "true"
}
},
"relationships": {
"endPoints": {
"data": [

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 948
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

{
"type": "endPoints",
"id": "PV0210FGD::SNC0-15-1026:local"
},
{
"type": "endPoints",
"id": "PV0210FGA::SNC0-15-1026:remote"
}
]
},
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "c02d80b3-a793-4fc8-8c5d-04ed4e2259f3"
}
}
}
},
{
"id": "64247e32-edb9-459e-be87-f5cc44360d71",
"type": "fres",
"attributes": {
"userLabel": "1025",
"nativeName": "SNC0-15-1025",
"layerRate": "OTSi",
"networkRole": "IFRE",
"directionality": "bidirectional",
"operationState": "fully operating",
"controlActivityState": "activating",
"modelType": "controlPlane",
"identifiers": [
{
"incarnation": "1",
"circuitId": "PV0210FGA_SNC0-11-1"
},
{
"networkConstructId": "a2c36396-1c5f-3108-84b6-ed97c1fc52b7",
"nodalId": "OSRP0-15-1::SNC0-15-1025"
}
],
"freType": "snc",
"additionalAttributes": {
"isActual": "true"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "PV0210FGD::SNC0-15-1025:local"
},
{
"type": "endPoints",
"id": "PV0210FGA::SNC0-15-1025:remote"
}
]
},
"networkConstruct": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 949
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"data": {
"type": "networkConstructs",
"id": "c02d80b3-a793-4fc8-8c5d-04ed4e2259f3"
}
}
}
},
{
"id": "-1884506336637256749",
"type": "fres",
"attributes": {
"userLabel": "",
"mgmtName": "",
"nativeName": "",
"layerRate": "DSR_ETHERNET",
"networkRole": "IFRE",
"directionality": "bidirectional",
"additionalAttributes": {
"isActual": "true"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "-1884506336637256749:1"
},
{
"type": "endPoints",
"id": "-1884506336637256749:2"
}
]
},
"partitionFres": {
"data": [
{
"type": "fres",
"id": "-1747614666174387782"
}
]
}
}
}
],
"included": [
{
"id": "-8562028732694322491:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "16ccf074-3620-3f70-904c-fb72e5bb54fa::TPE_16ccf074-3620-3f70-

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 950
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

904c-fb72e5bb54fa::EQPT_11_37-1-PTP"
}
]
}
}
},
{
"id": "-8562028732694322491:2",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "a2c36396-1c5f-3108-84b6-ed97c1fc52b7::TPE_a2c36396-1c5f-3108-
84b6-ed97c1fc52b7::EQPT_15_36-1-PTP"
}
]
}
}
},
{
"id": "-7607509881844076435:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "153879ff-2c37-3d17-9d5c-c5f02e25fd6b::TPE_153879ff-2c37-3d17-
9d5c-c5f02e25fd6b::EQPT_15_18-1-PTP"
}
]
}
}
},
{
"id": "-7607509881844076435:2",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "aa5580f5-aa3c-36b5-8172-dcaf0fbcf2e5::TPE_aa5580f5-aa3c-36b5-
8172-dcaf0fbcf2e5::EQPT_11_18-1-PTP"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 951
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

]
}
}
},
{
"id": "8437235193544607970:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "16ccf074-3620-3f70-904c-fb72e5bb54fa::TPE_16ccf074-3620-3f70-
904c-fb72e5bb54fa::EQPT_11_21-1-PTP"
}
]
}
}
},
{
"id": "8437235193544607970:2",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "a2c36396-1c5f-3108-84b6-ed97c1fc52b7::TPE_a2c36396-1c5f-3108-
84b6-ed97c1fc52b7::EQPT_15_11-1-PTP"
}
]
}
}
},
{
"id": "3539955230191161553:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "153879ff-2c37-3d17-9d5c-c5f02e25fd6b::TPE_153879ff-2c37-3d17-
9d5c-c5f02e25fd6b::EQPT_15_11-1-PTP"
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 952
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

}
},
{
"id": "3539955230191161553:2",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "aa5580f5-aa3c-36b5-8172-dcaf0fbcf2e5::TPE_aa5580f5-aa3c-36b5-
8172-dcaf0fbcf2e5::EQPT_11_21-1-PTP"
}
]
}
}
},
{
"id": "PV0210FGD::SNC0-15-1026:local",
"type": "endPoints",
"attributes": {
"role": "a"
},
"relationships": {}
},
{
"id": "PV0210FGA::SNC0-15-1026:remote",
"type": "endPoints",
"attributes": {
"role": "z"
},
"relationships": {}
},
{
"id": "PV0210FGD::SNC0-15-1025:local",
"type": "endPoints",
"attributes": {
"role": "a"
},
"relationships": {}
},
{
"id": "PV0210FGA::SNC0-15-1025:remote",
"type": "endPoints",
"attributes": {
"role": "z"
},
"relationships": {}
},
{
"id": "-1884506336637256749:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 953
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "153879ff-2c37-3d17-9d5c-c5f02e25fd6b::TPE_153879ff-2c37-3d17-
9d5c-c5f02e25fd6b::EQPT_15_12_1-PTP"
}
]
}
}
},
{
"id": "-1884506336637256749:2",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "aa5580f5-aa3c-36b5-8172-dcaf0fbcf2e5::TPE_aa5580f5-aa3c-36b5-
8172-dcaf0fbcf2e5::EQPT_11_22_1-PTP"
}
]
}
}
},
{
"id": "16ccf074-3620-3f70-904c-fb72e5bb54fa::TPE_16ccf074-3620-3f70-904c-
fb72e5bb54fa::EQPT_11_37-1-PTP",
"type": "tpes",
"attributes": {
"structureType": "PTP",
"locations": [
{
"managementType": "tl1",
"shelf": "11",
"slot": "37",
"port": "1"
}
]
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "16ccf074-3620-3f70-904c-fb72e5bb54fa"
}
},
"equipment": {
"data": {
"type": "equipment",
"id": "16ccf074-3620-3f70-904c-fb72e5bb54fa::EQPT_11_37"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 954
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

}
}
},
{
"id": "a2c36396-1c5f-3108-84b6-ed97c1fc52b7::TPE_a2c36396-1c5f-3108-84b6-
ed97c1fc52b7::EQPT_15_36-1-PTP",
"type": "tpes",
"attributes": {
"structureType": "PTP",
"locations": [
{
"managementType": "tl1",
"shelf": "15",
"slot": "36",
"port": "1"
}
]
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "a2c36396-1c5f-3108-84b6-ed97c1fc52b7"
}
},
"equipment": {
"data": {
"type": "equipment",
"id": "a2c36396-1c5f-3108-84b6-ed97c1fc52b7::EQPT_15_36"
}
}
}
},
{
"id": "153879ff-2c37-3d17-9d5c-c5f02e25fd6b::TPE_153879ff-2c37-3d17-9d5c-
c5f02e25fd6b::EQPT_15_18-1-PTP",
"type": "tpes",
"attributes": {
"structureType": "PTP",
"locations": [
{
"managementType": "tl1",
"shelf": "15",
"slot": "18",
"port": "1"
}
]
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "153879ff-2c37-3d17-9d5c-c5f02e25fd6b"
}
},
"equipment": {
"data": {
"type": "equipment",
"id": "153879ff-2c37-3d17-9d5c-c5f02e25fd6b::EQPT_15_18"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 955
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

}
}
}
},
{
"id": "aa5580f5-aa3c-36b5-8172-dcaf0fbcf2e5::TPE_aa5580f5-aa3c-36b5-8172-
dcaf0fbcf2e5::EQPT_11_18-1-PTP",
"type": "tpes",
"attributes": {
"structureType": "PTP",
"locations": [
{
"managementType": "tl1",
"shelf": "11",
"slot": "18",
"port": "1"
}
]
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "aa5580f5-aa3c-36b5-8172-dcaf0fbcf2e5"
}
},
"equipment": {
"data": {
"type": "equipment",
"id": "aa5580f5-aa3c-36b5-8172-dcaf0fbcf2e5::EQPT_11_18"
}
}
}
},
{
"id": "16ccf074-3620-3f70-904c-fb72e5bb54fa::TPE_16ccf074-3620-3f70-904c-
fb72e5bb54fa::EQPT_11_21-1-PTP",
"type": "tpes",
"attributes": {
"structureType": "PTP",
"locations": [
{
"managementType": "tl1",
"shelf": "11",
"slot": "21",
"port": "1"
}
]
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "16ccf074-3620-3f70-904c-fb72e5bb54fa"
}
},
"equipment": {
"data": {
"type": "equipment",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 956
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"id": "16ccf074-3620-3f70-904c-fb72e5bb54fa::EQPT_11_21"
}
}
}
},
{
"id": "a2c36396-1c5f-3108-84b6-ed97c1fc52b7::TPE_a2c36396-1c5f-3108-84b6-
ed97c1fc52b7::EQPT_15_11-1-PTP",
"type": "tpes",
"attributes": {
"structureType": "PTP",
"locations": [
{
"managementType": "tl1",
"shelf": "15",
"slot": "11",
"port": "1"
}
]
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "a2c36396-1c5f-3108-84b6-ed97c1fc52b7"
}
},
"equipment": {
"data": {
"type": "equipment",
"id": "a2c36396-1c5f-3108-84b6-ed97c1fc52b7::EQPT_15_11"
}
}
}
},
{
"id": "153879ff-2c37-3d17-9d5c-c5f02e25fd6b::TPE_153879ff-2c37-3d17-9d5c-
c5f02e25fd6b::EQPT_15_11-1-PTP",
"type": "tpes",
"attributes": {
"structureType": "PTP",
"locations": [
{
"managementType": "tl1",
"shelf": "15",
"slot": "11",
"port": "1"
}
]
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "153879ff-2c37-3d17-9d5c-c5f02e25fd6b"
}
},
"equipment": {
"data": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 957
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"type": "equipment",
"id": "153879ff-2c37-3d17-9d5c-c5f02e25fd6b::EQPT_15_11"
}
}
}
},
{
"id": "aa5580f5-aa3c-36b5-8172-dcaf0fbcf2e5::TPE_aa5580f5-aa3c-36b5-8172-
dcaf0fbcf2e5::EQPT_11_21-1-PTP",
"type": "tpes",
"attributes": {
"structureType": "PTP",
"locations": [
{
"managementType": "tl1",
"shelf": "11",
"slot": "21",
"port": "1"
}
]
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "aa5580f5-aa3c-36b5-8172-dcaf0fbcf2e5"
}
},
"equipment": {
"data": {
"type": "equipment",
"id": "aa5580f5-aa3c-36b5-8172-dcaf0fbcf2e5::EQPT_11_21"
}
}
}
},
{
"id": "153879ff-2c37-3d17-9d5c-c5f02e25fd6b::TPE_153879ff-2c37-3d17-9d5c-
c5f02e25fd6b::EQPT_15_12_1-PTP",
"type": "tpes",
"attributes": {
"structureType": "PTP",
"locations": [
{
"managementType": "tl1",
"shelf": "15",
"slot": "12",
"port": "1"
}
]
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "153879ff-2c37-3d17-9d5c-c5f02e25fd6b"
}
},
"equipment": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 958
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"data": {
"type": "equipment",
"id": "153879ff-2c37-3d17-9d5c-c5f02e25fd6b::EQPT_15_12_1"
}
}
}
},
{
"id": "aa5580f5-aa3c-36b5-8172-dcaf0fbcf2e5::TPE_aa5580f5-aa3c-36b5-8172-
dcaf0fbcf2e5::EQPT_11_22_1-PTP",
"type": "tpes",
"attributes": {
"structureType": "PTP",
"locations": [
{
"managementType": "tl1",
"shelf": "11",
"slot": "22",
"port": "1"
}
]
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "aa5580f5-aa3c-36b5-8172-dcaf0fbcf2e5"
}
},
"equipment": {
"data": {
"type": "equipment",
"id": "aa5580f5-aa3c-36b5-8172-dcaf0fbcf2e5::EQPT_11_22_1"
}
}
}
}
]
}

Channel power
To retrieve real-time optical power (Channel) from all power reporting endpoints in the service path, use
the Test and diagnostics API.

Requirements

Before you start, you must have identified one, or more FREs for which to retrieve optical power data, for
example, -8032246870464230076.

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 959
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

POST {{MCP_SERVER}}/tdc/api/vi/diag/powers

{
"data": {
"freIds": [
"-8032246870464230076"

],
"pmType": "CHANNEL_POWER",
"synchronous": true,
"pollInterval": 0
}

Sample response

{
"data": {
"id": "1beeb3ac-0bb9-4973-8347-4b2619c25879" ,
"type": "pmDiagnostics" ,
"attributes": {
"timeStamp": "2017-02-23T20:56:54.397Z" ,
"pmType": "CHANNEL_POWER" ,
"pmTpes": [
{
"tpeId": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_11_36-1-PTP" ,
"isReporting": g true ,
"reportingFacility": "OTM4-11-36-1" ,
"pmReadings": [
{
"binType": "24_HOUR" ,
"parameter": "RX_CHANNEL_POWER_AVG" ,
"parameterNative": "OPRAVG-OCH" ,
"value": "0" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "24_HOUR" ,
"parameter": "RX_CHANNEL_POWER_MAX" ,
"parameterNative": "OPRMAX-OCH" ,
"value": "0" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "24_HOUR" ,
"parameter": "RX_CHANNEL_POWER_MIN" ,
"parameterNative": "OPRMIN-OCH" ,
"value": "0" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "24_HOUR" ,
"parameter": "TX_CHANNEL_POWER_AVG" ,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 960
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"parameterNative": "OPTAVG-OCH" ,
"value": "0" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "24_HOUR" ,
"parameter": "TX_CHANNEL_POWER_MAX" ,
"parameterNative": "OPTMAX-OCH" ,
"value": "0" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "24_HOUR" ,
"parameter": "TX_CHANNEL_POWER_MIN" ,
"parameterNative": "OPTMIN-OCH" ,
"value": "0" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "UNTIMED" ,
"parameter": "RX_CHANNEL_POWER" ,
"parameterNative": "OPR-OCH" ,
"value": "-10.7" ,
"time": "2017-02-23T20:56-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "UNTIMED" ,
"parameter": "TX_CHANNEL_POWER" ,
"parameterNative": "OPT-OCH" ,
"value": "-14.1" ,
"time": "2017-02-23T20:56-00:00" ,
"binState": "PARTIAL"
}
]
},
{
"tpeId": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_12_1-6-PTP" ,
"pmReadings": [],
"relationships": {
"measurementpointTpes": {
"data": {
"type": "tpes" ,
"id": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-
37c7-a8cb-6d71cf89e81e::EQPT_12_1-6-CTPServerToClient-193.700000"
}
}
}
},
{
"tpeId": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-
a8e5-ac0432fcddb2::EQPT_15_1-7-PTP" ,
"isReporting": g true ,
"reportingFacility": "NMCMON-15-1-7-193700000" ,
"pmReadings": [

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 961
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

{
"binType": "24_HOUR" ,
"parameter": "TX_CHANNEL_POWER_AVG" ,
"parameterNative": "OPTAVG-OCH" ,
"value": "OOR" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "ADJUSTED"
},
{
"binType": "24_HOUR" ,
"parameter": "TX_CHANNEL_POWER_MAX" ,
"parameterNative": "OPTMAX-OCH" ,
"value": "OOR" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "ADJUSTED"
},
{
"binType": "24_HOUR" ,
"parameter": "TX_CHANNEL_POWER_MIN" ,
"parameterNative": "OPTMIN-OCH" ,
"value": "OOR" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "ADJUSTED"
},
{
"binType": "UNTIMED" ,
"parameter": "TX_CHANNEL_POWER" ,
"parameterNative": "OPT-OCH" ,
"value": "0" ,
"time": "2017-02-09T16:37-00:00" ,
"binState": "NOT AVAILABLE"
}
],
"relationships": {
"measurementpointTpes": {
"data": {
"type": "tpes" ,
"id": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-
318e-a8e5-ac0432fcddb2::EQPT_15_1-7-CTPServerToClient-193.700000"
}
}
}
},
{
"tpeId": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_12_2-7-PTP" ,
"pmReadings": [],
"relationships": {
"measurementpointTpes": {
"data": {
"type": "tpes" ,
"id": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-
37c7-a8cb-6d71cf89e81e::EQPT_12_2-7-7-CTPServerToClient-193.700000"
}
}
}
},
{
"tpeId": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 962
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

a8e5-ac0432fcddb2::EQPT_15_2-7-PTP" ,
"pmReadings": [],
"relationships": {
"measurementpointTpes": {
"data": {
"type": "tpes" ,
"id": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-
318e-a8e5-ac0432fcddb2::EQPT_15_2-7-7-CTPServerToClient-193.700000"
}
}
}
},
{
"tpeId": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-
a8e5-ac0432fcddb2::EQPT_15_4-26-PTP" ,
"pmReadings": [],
"relationships": {
"measurementpointTpes": {
"data": {
"type": "tpes" ,
"id": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-
318e-a8e5-ac0432fcddb2::EQPT_15_4-26-1-CTPServerToClient-193.700000"
}
}
}
},
{
"tpeId": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_12_4-25-PTP" ,
"pmReadings": [],
"relationships": {
"measurementpointTpes": {
"data": {
"type": "tpes" ,
"id": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-
37c7-a8cb-6d71cf89e81e::EQPT_12_4-25-1-CTPServerToClient-193.700000"
}
}
}
},
{
"tpeId": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_12_2-9-PTP" ,
"pmReadings": [],
"relationships": {
"measurementpointTpes": {
"data": {
"type": "tpes" ,
"id": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-
37c7-a8cb-6d71cf89e81e::EQPT_12_2-9-CTPServerToClient-193.700000"
}
}
}
},
{
"tpeId": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-
a8e5-ac0432fcddb2::EQPT_15_4-1-PTP" ,
"isReporting": g true ,
"reportingFacility": "OPTMON-15-4-1" ,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 963
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"pmReadings": [
{
"binType": "24_HOUR" ,
"parameter": "RX_OPTICAL_POWER_AVG" ,
"parameterNative": "OPRAVG-OTS" ,
"value": "-7.6" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "24_HOUR" ,
"parameter": "RX_OPTICAL_POWER_MAX" ,
"parameterNative": "OPRMAX-OTS" ,
"value": "-5.6" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "24_HOUR" ,
"parameter": "RX_OPTICAL_POWER_MIN" ,
"parameterNative": "OPRMIN-OTS" ,
"value": "-9.6" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "UNTIMED" ,
"parameter": "RX_OPTICAL_POWER" ,
"parameterNative": "OPR-OTS" ,
"value": "-7.6" ,
"time": "2017-02-03T17:11-00:00" ,
"binState": "COMPLETED"
}
],
"relationships": {
"measurementpointTpes": {
"data": {
"type": "tpes" ,
"id": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-
318e-a8e5-ac0432fcddb2::EQPT_15_4-1-CTPServerToClient-193.700000"
}
}
}
},
{
"tpeId": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-
a8e5-ac0432fcddb2::EQPT_15_1-5-PTP" ,
"isReporting": g true ,
"reportingFacility": "NMCMON-15-1-5-193700000" ,
"pmReadings": [
{
"binType": "24_HOUR" ,
"parameter": "TX_CHANNEL_POWER_AVG" ,
"parameterNative": "OPTAVG-OCH" ,
"value": "-37.25" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 964
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"binType": "24_HOUR" ,
"parameter": "TX_CHANNEL_POWER_MAX" ,
"parameterNative": "OPTMAX-OCH" ,
"value": "-34.8" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "24_HOUR" ,
"parameter": "TX_CHANNEL_POWER_MIN" ,
"parameterNative": "OPTMIN-OCH" ,
"value": "-39.7" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "UNTIMED" ,
"parameter": "TX_CHANNEL_POWER" ,
"parameterNative": "OPT-OCH" ,
"value": "-36.6" ,
"time": "2017-02-09T16:37-00:00" ,
"binState": "COMPLETED"
}
],
"relationships": {
"measurementpointTpes": {
"data": {
"type": "tpes" ,
"id": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-
318e-a8e5-ac0432fcddb2::EQPT_15_1-5-CTPServerToClient-193.700000"
}
}
}
},
{
"tpeId": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_12_1-7-PTP" ,
"isReporting": g true ,
"reportingFacility": "NMCMON-12-1-7-193700000" ,
"pmReadings": [
{
"binType": "24_HOUR" ,
"parameter": "TX_CHANNEL_POWER_AVG" ,
"parameterNative": "OPTAVG-OCH" ,
"value": "OOR" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "ADJUSTED"
},
{
"binType": "24_HOUR" ,
"parameter": "TX_CHANNEL_POWER_MAX" ,
"parameterNative": "OPTMAX-OCH" ,
"value": "OOR" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "ADJUSTED"
},
{
"binType": "24_HOUR" ,
"parameter": "TX_CHANNEL_POWER_MIN" ,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 965
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"parameterNative": "OPTMIN-OCH" ,
"value": "OOR" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "ADJUSTED"
},
{
"binType": "UNTIMED" ,
"parameter": "TX_CHANNEL_POWER" ,
"parameterNative": "OPT-OCH" ,
"value": "0" ,
"time": "2017-02-09T16:37-00:00" ,
"binState": "NOT AVAILABLE"
}
],
"relationships": {
"measurementpointTpes": {
"data": {
"type": "tpes" ,
"id": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-
37c7-a8cb-6d71cf89e81e::EQPT_12_1-7-CTPServerToClient-193.700000"
}
}
}
},
{
"tpeId": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_12_1-5-PTP" ,
"isReporting": g true ,
"reportingFacility": "NMCMON-12-1-5-193700000" ,
"pmReadings": [
{
"binType": "24_HOUR" ,
"parameter": "TX_CHANNEL_POWER_AVG" ,
"parameterNative": "OPTAVG-OCH" ,
"value": "-37.25" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "ADJUSTED"
},
{
"binType": "24_HOUR" ,
"parameter": "TX_CHANNEL_POWER_MAX" ,
"parameterNative": "OPTMAX-OCH" ,
"value": "-34.8" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "ADJUSTED"
},
{
"binType": "24_HOUR" ,
"parameter": "TX_CHANNEL_POWER_MIN" ,
"parameterNative": "OPTMIN-OCH" ,
"value": "-39.7" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "ADJUSTED"
},
{
"binType": "UNTIMED" ,
"parameter": "TX_CHANNEL_POWER" ,
"parameterNative": "OPT-OCH" ,
"value": "0" ,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 966
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"time": "2017-02-09T16:37-00:00" ,
"binState": "NOT AVAILABLE"
}
],
"relationships": {
"measurementpointTpes": {
"data": {
"type": "tpes" ,
"id": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-
37c7-a8cb-6d71cf89e81e::EQPT_12_1-5-CTPServerToClient-193.700000"
}
}
}
},
{
"tpeId": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-
a8e5-ac0432fcddb2::EQPT_15_2-9-PTP" ,
"pmReadings": [],
"relationships": {
"measurementpointTpes": {
"data": {
"type": "tpes" ,
"id": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-
318e-a8e5-ac0432fcddb2::EQPT_15_2-9-CTPServerToClient-193.700000"
}
}
}
},
{
"tpeId": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-
a8e5-ac0432fcddb2::EQPT_15_4-25-PTP" ,
"pmReadings": [],
"relationships": {
"measurementpointTpes": {
"data": {
"type": "tpes" ,
"id": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-
318e-a8e5-ac0432fcddb2::EQPT_15_4-25-1-CTPServerToClient-193.700000"
}
}
}
},
{
"tpeId": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_12_4-26-PTP" ,
"pmReadings": [],
"relationships": {
"measurementpointTpes": {
"data": {
"type": "tpes" ,
"id": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-
37c7-a8cb-6d71cf89e81e::EQPT_12_4-26-1-CTPServerToClient-193.700000"
}
}
}
},
{
"tpeId": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-
a8e5-ac0432fcddb2::EQPT_15_1-8-PTP" ,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 967
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"pmReadings": [],
"relationships": {
"measurementpointTpes": {
"data": {
"type": "tpes" ,
"id": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-
318e-a8e5-ac0432fcddb2::EQPT_15_1-8-CTPServerToClient-193.700000"
}
}
}
},
{
"tpeId": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_12_4-1-PTP" ,
"isReporting": g true ,
"reportingFacility": "OPTMON-12-4-1" ,
"pmReadings": [
{
"binType": "24_HOUR" ,
"parameter": "RX_OPTICAL_POWER_AVG" ,
"parameterNative": "OPRAVG-OTS" ,
"value": "-7.6" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "ADJUSTED"
},
{
"binType": "24_HOUR" ,
"parameter": "RX_OPTICAL_POWER_MAX" ,
"parameterNative": "OPRMAX-OTS" ,
"value": "-5.6" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "ADJUSTED"
},
{
"binType": "24_HOUR" ,
"parameter": "RX_OPTICAL_POWER_MIN" ,
"parameterNative": "OPRMIN-OTS" ,
"value": "-9.6" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "ADJUSTED"
},
{
"binType": "UNTIMED" ,
"parameter": "RX_OPTICAL_POWER" ,
"parameterNative": "OPR-OTS" ,
"value": "0" ,
"time": "2017-02-03T17:11-00:00" ,
"binState": "NOT AVAILABLE"
}
],
"relationships": {
"measurementpointTpes": {
"data": {
"type": "tpes" ,
"id": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-
37c7-a8cb-6d71cf89e81e::EQPT_12_4-1-CTPServerToClient-193.700000"
}
}
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 968
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

},
{
"tpeId": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-
a8e5-ac0432fcddb2::EQPT_15_21-1-PTP" ,
"isReporting": g true ,
"reportingFacility": "OTM4-15-21-1" ,
"pmReadings": [
{
"binType": "24_HOUR" ,
"parameter": "RX_CHANNEL_POWER_AVG" ,
"parameterNative": "OPRAVG-OCH" ,
"value": "0" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "24_HOUR" ,
"parameter": "RX_CHANNEL_POWER_MAX" ,
"parameterNative": "OPRMAX-OCH" ,
"value": "0" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "24_HOUR" ,
"parameter": "RX_CHANNEL_POWER_MIN" ,
"parameterNative": "OPRMIN-OCH" ,
"value": "0" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "24_HOUR" ,
"parameter": "TX_CHANNEL_POWER_AVG" ,
"parameterNative": "OPTAVG-OCH" ,
"value": "0" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "24_HOUR" ,
"parameter": "TX_CHANNEL_POWER_MAX" ,
"parameterNative": "OPTMAX-OCH" ,
"value": "0" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "24_HOUR" ,
"parameter": "TX_CHANNEL_POWER_MIN" ,
"parameterNative": "OPTMIN-OCH" ,
"value": "0" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "UNTIMED" ,
"parameter": "RX_CHANNEL_POWER" ,
"parameterNative": "OPR-OCH" ,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 969
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"value": "-15.6" ,
"time": "2017-02-23T20:56-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "UNTIMED" ,
"parameter": "TX_CHANNEL_POWER" ,
"parameterNative": "OPT-OCH" ,
"value": "-11.9" ,
"time": "2017-02-23T20:56-00:00" ,
"binState": "PARTIAL"
}
]
},
{
"tpeId": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_12_4-2-PTP" ,
"pmReadings": [],
"relationships": {
"measurementpointTpes": {
"data": {
"type": "tpes" ,
"id": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-
37c7-a8cb-6d71cf89e81e::EQPT_12_4-2-CTPServerToClient-193.700000"
}
}
}
},
{
"tpeId": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_12_1-8-PTP" ,
"pmReadings": [],
"relationships": {
"measurementpointTpes": {
"data": {
"type": "tpes" ,
"id": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-
37c7-a8cb-6d71cf89e81e::EQPT_12_1-8-CTPServerToClient-193.700000"
}
}
}
},
{
"tpeId": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-
a8e5-ac0432fcddb2::EQPT_15_4-2-PTP" ,
"pmReadings": [],
"relationships": {
"measurementpointTpes": {
"data": {
"type": "tpes" ,
"id": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-
318e-a8e5-ac0432fcddb2::EQPT_15_4-2-CTPServerToClient-193.700000"
}
}
}
},
{
"tpeId": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_12_2-10-PTP" ,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 970
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"pmReadings": [],
"relationships": {
"measurementpointTpes": {
"data": {
"type": "tpes" ,
"id": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-
37c7-a8cb-6d71cf89e81e::EQPT_12_2-10-CTPServerToClient-193.700000"
}
}
}
},
{
"tpeId": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-
a8e5-ac0432fcddb2::EQPT_15_2-10-PTP" ,
"pmReadings": [],
"relationships": {
"measurementpointTpes": {
"data": {
"type": "tpes" ,
"id": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-
318e-a8e5-ac0432fcddb2::EQPT_15_2-10-CTPServerToClient-193.700000"
}
}
}
},
{
"tpeId": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-
a8e5-ac0432fcddb2::EQPT_15_1-6-PTP" ,
"pmReadings": [],
"relationships": {
"measurementpointTpes": {
"data": {
"type": "tpes" ,
"id": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-
318e-a8e5-ac0432fcddb2::EQPT_15_1-6-CTPServerToClient-193.700000"
}
}
}
}
],
"diagResults": {}
},
"relationships": {
"fres": {
"data": [
{
"type": "fres" ,
"id": "-8032246870464230076"
}
]
},
"tpes": {
"data": [
{
"type": "tpes" ,
"id": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_11_36-1-PTP"
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 971
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"type": "tpes" ,
"id": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_12_1-6-PTP"
},
{
"type": "tpes" ,
"id": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-
a8e5-ac0432fcddb2::EQPT_15_1-7-PTP"
},
{
"type": "tpes" ,
"id": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_12_2-7-PTP"
},
{
"type": "tpes" ,
"id": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-
a8e5-ac0432fcddb2::EQPT_15_2-7-PTP"
},
{
"type": "tpes" ,
"id": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-
a8e5-ac0432fcddb2::EQPT_15_4-26-PTP"
},
{
"type": "tpes" ,
"id": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_12_4-25-PTP"
},
{
"type": "tpes" ,
"id": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_12_2-9-PTP"
},
{
"type": "tpes" ,
"id": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-
a8e5-ac0432fcddb2::EQPT_15_4-1-PTP"
},
{
"type": "tpes" ,
"id": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-
a8e5-ac0432fcddb2::EQPT_15_1-5-PTP"
},
{
"type": "tpes" ,
"id": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_12_1-7-PTP"
},
{
"type": "tpes" ,
"id": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_12_1-5-PTP"
},
{
"type": "tpes" ,
"id": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-
a8e5-ac0432fcddb2::EQPT_15_2-9-PTP"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 972
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

{
"type": "tpes" ,
"id": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-
a8e5-ac0432fcddb2::EQPT_15_4-25-PTP"
},
{
"type": "tpes" ,
"id": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_12_4-26-PTP"
},
{
"type": "tpes" ,
"id": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-
a8e5-ac0432fcddb2::EQPT_15_1-8-PTP"
},
{
"type": "tpes" ,
"id": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_12_4-1-PTP"
},
{
"type": "tpes" ,
"id": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-
a8e5-ac0432fcddb2::EQPT_15_21-1-PTP"
},
{
"type": "tpes" ,
"id": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_12_4-2-PTP"
},
{
"type": "tpes" ,
"id": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_12_1-8-PTP"
},
{
"type": "tpes" ,
"id": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-
a8e5-ac0432fcddb2::EQPT_15_4-2-PTP"
},
{
"type": "tpes" ,
"id": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_12_2-10-PTP"
},
{
"type": "tpes" ,
"id": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-
a8e5-ac0432fcddb2::EQPT_15_2-10-PTP"
},
{
"type": "tpes" ,
"id": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-
a8e5-ac0432fcddb2::EQPT_15_1-6-PTP"
}
]
}
}
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 973
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

}cb1
}

Total power
To retrieve real-time optical power (Total power) from all power reporting endpoints in the service path,
you use the Test and diagnostics API.

Requirements

Before you start, you must have identified one, or more FREs for which to retrieve optical power data, for
example, -8032246870464230076.

Sample request

POST {{MCP_SERVER}}/tdc/api/vi/diag/powers

{
"data": {
"freIds": [
"-8032246870464230076"
],
"pmType": "TOTAL_POWER",
"synchronous": true,
"pollInterval": 0
}

Sample response

{
"data": {
"id": "210ab8af-ae4f-43cf-8aee-7b1b48713764" ,
"type": "pmDiagnostics" ,
"attributes": {
"timeStamp": "2017-02-23T21:06:15.499Z" ,
"pmType": "TOTAL_POWER" ,
"pmTpes": [
{
"tpeId": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_11_36-1-PTP" ,
"pmReadings": []
},
{
"tpeId": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_12_4-2-PTP" ,
"pmReadings": []
},
{
"tpeId": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 974
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

a8e5-ac0432fcddb2::EQPT_15_1-6-PTP" ,
"isReporting": g true ,
"reportingFacility": "AMP-15-1-6" ,
"pmReadings": [
{
"binType": "UNTIMED" ,
"parameter": "OPTICAL_RETURN_LOSS" ,
"parameterNative": "ORL-OTS" ,
"value": "48" ,
"time": "2017-02-03T17:11-00:00" ,
"threshold": "22" ,
"binState": "COMPLETED" ,
"alert": "false"
},
{
"binType": "UNTIMED" ,
"parameter": "RX_OPTICAL_POWER" ,
"parameterNative": "OPIN-OTS" ,
"value": "OOR" ,
"time": "2017-02-03T17:11-00:00" ,
"threshold": "6" ,
"binState": "COMPLETED" ,
"alert": "true"
},
{
"binType": "UNTIMED" ,
"parameter": "TX_OPTICAL_POWER" ,
"parameterNative": "OPOUT-OTS" ,
"value": "OOR" ,
"time": "2017-02-03T17:11-00:00" ,
"threshold": "6" ,
"binState": "COMPLETED" ,
"alert": "true"
},
{
"binType": "BASELINE" ,
"parameter": "OPTICAL_RETURN_LOSS" ,
"parameterNative": "ORL-OTS" ,
"value": "0" ,
"time": "2017-01-01T00:00-00:00" ,
"binState": "NOT AVAILABLE"
},
{
"binType": "BASELINE" ,
"parameter": "RX_OPTICAL_POWER" ,
"parameterNative": "OPIN-OTS" ,
"value": "0" ,
"time": "2017-01-01T00:00-00:00" ,
"binState": "NOT AVAILABLE"
},
{
"binType": "BASELINE" ,
"parameter": "TX_OPTICAL_POWER" ,
"parameterNative": "OPOUT-OTS" ,
"value": "0" ,
"time": "2017-01-01T00:00-00:00" ,
"binState": "NOT AVAILABLE"
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 975
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"binType": "24_HOUR" ,
"parameter": "TX_OPTICAL_POWER_AVG" ,
"parameterNative": "OPOUTAVG-OTS" ,
"value": "-50" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "24_HOUR" ,
"parameter": "TX_OPTICAL_POWER_MIN" ,
"parameterNative": "OPOUTMIN-OTS" ,
"value": "OOR" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "24_HOUR" ,
"parameter": "OPTICAL_RETURN_LOSS_MAX" ,
"parameterNative": "ORLMAX-OTS" ,
"value": "48" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "24_HOUR" ,
"parameter": "RX_OPTICAL_POWER_AVG" ,
"parameterNative": "OPINAVG-OTS" ,
"value": "-64" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "24_HOUR" ,
"parameter": "OPTICAL_RETURN_LOSS_AVG" ,
"parameterNative": "ORLAVG-OTS" ,
"value": "48" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "24_HOUR" ,
"parameter": "OPTICAL_RETURN_LOSS_MIN" ,
"parameterNative": "ORLMIN-OTS" ,
"value": "48" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "24_HOUR" ,
"parameter": "RX_OPTICAL_POWER_MIN" ,
"parameterNative": "OPINMIN-OTS" ,
"value": "OOR" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "24_HOUR" ,
"parameter": "RX_OPTICAL_POWER_MAX" ,
"parameterNative": "OPINMAX-OTS" ,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 976
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"value": "-50" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "24_HOUR" ,
"parameter": "TX_OPTICAL_POWER_MAX" ,
"parameterNative": "OPOUTMAX-OTS" ,
"value": "-50" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
}
]
},
{
"tpeId": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_12_4-25-PTP" ,
"isReporting": g true ,
"reportingFacility": "AMP-12-4-25" ,
"pmReadings": [
{
"binType": "UNTIMED" ,
"parameter": "RX_OPTICAL_POWER" ,
"parameterNative": "OPIN-OTS" ,
"value": "0" ,
"time": "2017-02-03T17:10-00:00" ,
"threshold": "6" ,
"binState": "NOT AVAILABLE" ,
"alert": "false"
},
{
"binType": "UNTIMED" ,
"parameter": "TX_OPTICAL_POWER" ,
"parameterNative": "OPOUT-OTS" ,
"value": "0" ,
"time": "2017-02-03T17:10-00:00" ,
"threshold": "6" ,
"binState": "NOT AVAILABLE" ,
"alert": "false"
},
{
"binType": "BASELINE" ,
"parameter": "RX_OPTICAL_POWER" ,
"parameterNative": "OPIN-OTS" ,
"value": "0" ,
"time": "2017-01-01T00:00-00:00" ,
"binState": "NOT AVAILABLE"
},
{
"binType": "BASELINE" ,
"parameter": "TX_OPTICAL_POWER" ,
"parameterNative": "OPOUT-OTS" ,
"value": "0" ,
"time": "2017-01-01T00:00-00:00" ,
"binState": "NOT AVAILABLE"
},
{
"binType": "24_HOUR" ,
"parameter": "TX_OPTICAL_POWER_AVG" ,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 977
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"parameterNative": "OPOUTAVG-OTS" ,
"value": "-50" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "ADJUSTED"
},
{
"binType": "24_HOUR" ,
"parameter": "TX_OPTICAL_POWER_MIN" ,
"parameterNative": "OPOUTMIN-OTS" ,
"value": "OOR" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "ADJUSTED"
},
{
"binType": "24_HOUR" ,
"parameter": "RX_OPTICAL_POWER_AVG" ,
"parameterNative": "OPINAVG-OTS" ,
"value": "-64" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "ADJUSTED"
},
{
"binType": "24_HOUR" ,
"parameter": "RX_OPTICAL_POWER_MIN" ,
"parameterNative": "OPINMIN-OTS" ,
"value": "OOR" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "ADJUSTED"
},
{
"binType": "24_HOUR" ,
"parameter": "RX_OPTICAL_POWER_MAX" ,
"parameterNative": "OPINMAX-OTS" ,
"value": "OOR" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "ADJUSTED"
},
{
"binType": "24_HOUR" ,
"parameter": "TX_OPTICAL_POWER_MAX" ,
"parameterNative": "OPOUTMAX-OTS" ,
"value": "OOR" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "ADJUSTED"
}
]
},
{
"tpeId": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-
a8e5-ac0432fcddb2::EQPT_15_4-25-PTP" ,
"isReporting": g true ,
"reportingFacility": "AMP-15-4-25" ,
"pmReadings": [
{
"binType": "UNTIMED" ,
"parameter": "RX_OPTICAL_POWER" ,
"parameterNative": "OPIN-OTS" ,
"value": "OOR" ,
"time": "2017-02-03T17:11-00:00" ,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 978
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"threshold": "6" ,
"binState": "COMPLETED" ,
"alert": "true"
},
{
"binType": "UNTIMED" ,
"parameter": "TX_OPTICAL_POWER" ,
"parameterNative": "OPOUT-OTS" ,
"value": "OOR" ,
"time": "2017-02-03T17:11-00:00" ,
"threshold": "6" ,
"binState": "COMPLETED" ,
"alert": "true"
},
{
"binType": "BASELINE" ,
"parameter": "RX_OPTICAL_POWER" ,
"parameterNative": "OPIN-OTS" ,
"value": "0" ,
"time": "2017-01-01T00:00-00:00" ,
"binState": "NOT AVAILABLE"
},
{
"binType": "BASELINE" ,
"parameter": "TX_OPTICAL_POWER" ,
"parameterNative": "OPOUT-OTS" ,
"value": "0" ,
"time": "2017-01-01T00:00-00:00" ,
"binState": "NOT AVAILABLE"
},
{
"binType": "24_HOUR" ,
"parameter": "TX_OPTICAL_POWER_AVG" ,
"parameterNative": "OPOUTAVG-OTS" ,
"value": "-50" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "24_HOUR" ,
"parameter": "TX_OPTICAL_POWER_MIN" ,
"parameterNative": "OPOUTMIN-OTS" ,
"value": "OOR" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "24_HOUR" ,
"parameter": "RX_OPTICAL_POWER_AVG" ,
"parameterNative": "OPINAVG-OTS" ,
"value": "-64" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "24_HOUR" ,
"parameter": "RX_OPTICAL_POWER_MIN" ,
"parameterNative": "OPINMIN-OTS" ,
"value": "OOR" ,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 979
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "24_HOUR" ,
"parameter": "RX_OPTICAL_POWER_MAX" ,
"parameterNative": "OPINMAX-OTS" ,
"value": "OOR" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
},
{
"binType": "24_HOUR" ,
"parameter": "TX_OPTICAL_POWER_MAX" ,
"parameterNative": "OPOUTMAX-OTS" ,
"value": "OOR" ,
"time": "2017-02-23T00:00-00:00" ,
"binState": "PARTIAL"
}
]
},
{
"tpeId": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-
a8e5-ac0432fcddb2::EQPT_15_21-1-PTP" ,
"pmReadings": []
}
],
"diagResults": {}
},
"relationships": {
"fres": {
"data": [
{
"type": "fres" ,
"id": "-8032246870464230076"
}
]
},
"tpes": {
"data": [
{
"type": "tpes" ,
"id": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_11_36-1-PTP"
},
{
"type": "tpes" ,
"id": "436911e8-da9a-37c7-a8cb-6d71cf89e81e::TPE_436911e8-da9a-37c7-
a8cb-6d71cf89e81e::EQPT_12_4-2-PTP"
},

...

{
"type": "tpes" ,
"id": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-
a8e5-ac0432fcddb2::EQPT_15_4-25-PTP"
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 980
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"type": "tpes" ,
"id": "1e72e083-3ac9-318e-a8e5-ac0432fcddb2::TPE_1e72e083-3ac9-318e-
a8e5-ac0432fcddb2::EQPT_15_21-1-PTP"
}
]
}
}
}
}

Spectrum power
To retrieve real-time optical power (Spectrum power) of the network, you use the Test and diagnostics
API.

Spectrum power includes NMCMON and SDMON for a selected ROADM-line.

Requirements

Before you start, you must have identified an FRE (ROADM-line) for which to retrieve optical power data,
for example, -7311240502812995208-ROADMLINE_-8573074959516302103-ROADMLINE_.

Sample request

POST {MCP_HOST}/tdc/api/vi/diag/powers

{
"data": {
"freIds": [
"7311240502812995208-ROADMLINE_-8573074959516302103-
ROADMLINE"
],
"pmType": "SPECTRUM",
"synchronous": true,
"pollInterval": 0
}
}

Sample response

{
"data": {
"id": "5746bd94-d64a-49a0-93f1-b77960c586a0",
"type": "pmDiagnostics",
"attributes": {
"timeStamp": "2017-02-22T19:36:05.237Z",
"pmType": "SPECTRUM",
"pmTpes": [
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 981
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"tpeId": "0fe32a05-e45a-3248-96e9-d0924d0d2eb3::TPE_0fe32a05-e45a-3248-
96e9-d0924d0d2eb3::EQPT_1_7-8-PTP",
"portDir": "IN",
"isReporting": true,
"pmReadings": [
{
"reportingFacility": "SDMON-1-7-7-19132500",
"facilityType": "SDMON",
"frequency": "19132500",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-28.8",
"time": "2017-02-22T19:35-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-7-7-19133125",
"facilityType": "SDMON",
"frequency": "19133125",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-28.8",
"time": "2017-02-22T19:35-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-7-7-19133750",
"facilityType": "SDMON",
"frequency": "19133750",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-28.8",
"time": "2017-02-22T19:35-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-7-7-19134375",
"facilityType": "SDMON",
"frequency": "19134375",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-28.8",
"time": "2017-02-22T19:35-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-7-7-19135000",
"facilityType": "SDMON",
"frequency": "19135000",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-28.8",
"time": "2017-02-22T19:35-00:00",
"binState": "COMPLETED"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 982
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

},
{
"reportingFacility": "SDMON-1-7-7-19135625",
"facilityType": "SDMON",
"frequency": "19135625",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-28.7",
"time": "2017-02-22T19:35-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-7-7-19136250",
"facilityType": "SDMON",
"frequency": "19136250",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-28.7",
"time": "2017-02-22T19:35-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-7-7-19136875",
"facilityType": "SDMON",
"frequency": "19136875",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-28.7",
"time": "2017-02-22T19:35-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-7-7-19137500",
"facilityType": "SDMON",
"frequency": "19137500",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-28.8",
"time": "2017-02-22T19:35-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-7-7-19138125",
"facilityType": "SDMON",
"frequency": "19138125",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-28.8",
"time": "2017-02-22T19:35-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-7-7-19138750",
"facilityType": "SDMON",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 983
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"frequency": "19138750",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-28.7",
"time": "2017-02-22T19:35-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-7-7-19139375",
"facilityType": "SDMON",
"frequency": "19139375",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-28.7",
"time": "2017-02-22T19:35-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-7-7-19140000",
"facilityType": "SDMON",
"frequency": "19140000",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-28.7",
"time": "2017-02-22T19:35-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-7-7-19140625",
"facilityType": "SDMON",
"frequency": "19140625",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-28.7",
"time": "2017-02-22T19:35-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-7-7-19141250",
"facilityType": "SDMON",
"frequency": "19141250",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-28.7",
"time": "2017-02-22T19:35-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-7-7-19141875",
"facilityType": "SDMON",
"frequency": "19141875",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 984
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"value": "-28.7",
"time": "2017-02-22T19:35-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-7-7-19142500",
"facilityType": "SDMON",
"frequency": "19142500",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-28.8",
"time": "2017-02-22T19:35-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-7-7-19143125",
"facilityType": "SDMON",
"frequency": "19143125",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-28.8",
"time": "2017-02-22T19:35-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-7-7-19143750",
"facilityType": "SDMON",
"frequency": "19143750",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-28.8",
"time": "2017-02-22T19:35-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-7-7-19144375",
"facilityType": "SDMON",
"frequency": "19144375",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-28.8",
"time": "2017-02-22T19:35-00:00",
"binState": "COMPLETED"
},
.
.
.
.
.
.
.
.
.
.
.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 985
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

.
{
"reportingFacility": "SDMON-1-2-7-19600000",
"facilityType": "SDMON",
"frequency": "19600000",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-29.8",
"time": "2017-02-22T19:36-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-2-7-19600625",
"facilityType": "SDMON",
"frequency": "19600625",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-29.8",
"time": "2017-02-22T19:36-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-2-7-19601250",
"facilityType": "SDMON",
"frequency": "19601250",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-29.8",
"time": "2017-02-22T19:36-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-2-7-19601875",
"facilityType": "SDMON",
"frequency": "19601875",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-29.7",
"time": "2017-02-22T19:36-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-2-7-19602500",
"facilityType": "SDMON",
"frequency": "19602500",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-29.8",
"time": "2017-02-22T19:36-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-2-7-19603125",
"facilityType": "SDMON",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 986
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"frequency": "19603125",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-29.8",
"time": "2017-02-22T19:36-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-2-7-19603750",
"facilityType": "SDMON",
"frequency": "19603750",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-29.8",
"time": "2017-02-22T19:36-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-2-7-19604375",
"facilityType": "SDMON",
"frequency": "19604375",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-29.8",
"time": "2017-02-22T19:36-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-2-7-19605000",
"facilityType": "SDMON",
"frequency": "19605000",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-29.8",
"time": "2017-02-22T19:36-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-2-7-19605625",
"facilityType": "SDMON",
"frequency": "19605625",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-29.7",
"time": "2017-02-22T19:36-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-2-7-19606250",
"facilityType": "SDMON",
"frequency": "19606250",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 987
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"value": "-29.8",
"time": "2017-02-22T19:36-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-2-7-19606875",
"facilityType": "SDMON",
"frequency": "19606875",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-29.8",
"time": "2017-02-22T19:36-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-2-7-19607500",
"facilityType": "SDMON",
"frequency": "19607500",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-29.8",
"time": "2017-02-22T19:36-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-2-7-19608125",
"facilityType": "SDMON",
"frequency": "19608125",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-29.8",
"time": "2017-02-22T19:36-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-2-7-19608750",
"facilityType": "SDMON",
"frequency": "19608750",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-29.8",
"time": "2017-02-22T19:36-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-2-7-19609375",
"facilityType": "SDMON",
"frequency": "19609375",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-29.9",
"time": "2017-02-22T19:36-00:00",
"binState": "COMPLETED"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 988
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

{
"reportingFacility": "SDMON-1-2-7-19610000",
"facilityType": "SDMON",
"frequency": "19610000",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-29.9",
"time": "2017-02-22T19:36-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-2-7-19610625",
"facilityType": "SDMON",
"frequency": "19610625",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-29.9",
"time": "2017-02-22T19:36-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-2-7-19611250",
"facilityType": "SDMON",
"frequency": "19611250",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-29.9",
"time": "2017-02-22T19:36-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-2-7-19611875",
"facilityType": "SDMON",
"frequency": "19611875",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-29.9",
"time": "2017-02-22T19:36-00:00",
"binState": "COMPLETED"
},
{
"reportingFacility": "SDMON-1-2-7-19612500",
"facilityType": "SDMON",
"frequency": "19612500",
"binType": "UNTIMED",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "OPT-OTS",
"value": "-30",
"time": "2017-02-22T19:36-00:00",
"binState": "COMPLETED"
}
]
}
],
"diagResults": {}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 989
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

},
"relationships": {
"fres": {
"data": [
{
"type": "fres",
"id": "7311240502812995208-ROADMLINE_-8573074959516302103-ROADMLINE"
}
]
},
"tpes": {
"data": [
{
"type": "tpes",
"id": "0fe32a05-e45a-3248-96e9-d0924d0d2eb3::TPE_0fe32a05-e45a-3248-
96e9-d0924d0d2eb3::EQPT_1_7-8-PTP"
},
{
"type": "tpes",
"id": "d4abd144-1db9-3c26-b1d6-d0312e7e4510::TPE_d4abd144-1db9-3c26-
b1d6-d0312e7e4510::EQPT_1_1-5-PTP"
},
{
"type": "tpes",
"id": "0fe32a05-e45a-3248-96e9-d0924d0d2eb3::TPE_0fe32a05-e45a-3248-
96e9-d0924d0d2eb3::EQPT_1_7-5-PTP"
},
{
"type": "tpes",
"id": "d4abd144-1db9-3c26-b1d6-d0312e7e4510::TPE_d4abd144-1db9-3c26-
b1d6-d0312e7e4510::EQPT_1_1-8-PTP"
}
]
}
}
}
}

Create an OTU4 service intent

This section provides examples of the creation of an OTU4 service intent between existing OCLD cards.

In this section you create a service intent between OCLDs on two nodes. You can request a pre-FEC BER
test and add an inclusion constraint to specify which ROADM line the service should use.

You can also use this section to create an OTU4 service over an OCLD regen (back-to-back OCLD cards).

To create the service intent, use the Service Intent (CD fixed) API.

Requirements

You must ensure the following:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 990
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

• The equipment (including pluggables) required by the service is installed in the network.
• If you are provisioning an OTU4 service over a regen, you must enable viability (see Plan equipment).
• You have an API token (see Obtain a token).
• You have enrolled ROADMs for both ends of the link (see the Blue Planet MCP User Guide, 450-3709-
301, for how to enroll a single network element). You have the TIDs and NCIDs for the enrolled
ROADMs.
• A suitable link with no OTU4 services exists.
• In the request:
◦ Specify the TID and location of the OCLDs for the A and Z ends.
• For an example of a basic intent request, see Sample request — basic intent.
• For an example of a basic intent request for a pre-FEC BER test, see Sample request — basic intent
request for a pre-FEC BER test.
• To explicitly specify an inclusion constraint, include a constraint object in the intent document. For an
example of an intent document that includes a constraint object, see Sample request — basic intent
with a constraint object. This example specifies the ROADM line on shelf 21.

For a full list of current constraints, see Layer 0 infrastructure service constraints.

Sample request — basic intent

POST {{MCP_SERVER}}/ifd/api/v1/serviceIntents

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 991
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

{
"data":{
"attributes": {
"label": "OTU4_11_31",
"directionality": "bidirectional",
"layerRate": "OTU4",
"endPoints": [
{
"networkElement": {
"name": "PV0270RPTB"
},
"shelf": "11",
"slot": "31",
"port": "1"
},
{
"networkElement": {
"name": "PV0270RPTC"
},
"shelf": "11",
"slot": "31",
"port": "1"
}
]
}
}
}

Sample request — basic intent request for a pre-FEC BER test

POST {{MCP_SERVER}}/ifd/api/v1/serviceIntents

To specify an optional pre-FEC BER test (OTU4/infrastructure services, only), add a section similar to this
in your basic intent, for example:

{
"postActivationTests":
{
"diagnostics": [
{ "diagnosticType": "PM_TEST", "pmType": "PREFEC_BER",
"degradeThreshold": "1.0e-3", "failThreshold": "10.0e-3" }
]
}
}
}
}

The test runs after the service intent is deployed to the network. The low and high thresholds are optional,
in which case the system defaults are used. See a sample response to this request as follows.

Sample request — basic intent with a constraint object

POST {{MCP_SERVER}}/ifd/api/v1/serviceIntents

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 992
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

To explicitly specify an inclusion constraint, include a constraint object in the intent document. This
example specifies the ROADM line on shelf 21.

{
"constraints": {
"includeRouteObjects": [
{
"routeObjectType": "ROADM_LINE_NAME",
"roadmLineName": "{{NC_ID1}}::TPE_{{NC_ID1}}::EQPT_21_1-5-
PTP"
}
]
},
"userLabel": "100G Test Service",
...

Sample response — to the pre-FEC BER test request

"postActivationTests": {
"diagnostics": [
{ "diagnosticType": "PM_TEST", "pmType": "PREFEC_BER",
"degradeThreshold": 0.001, "failThreshold": 0.01 }
]
}
}
},
"discovered": false,
"postActivationTestStatus": {
"diagnosticStatuses": [
{ "diagnosticType": "PM_TEST", "pmType": "PREFEC_BER", "state":
"WAITING_FOR_SERVICE_ACTIVATED" }
]

Create a 100G service intent

This section provides an example of the creation of an OTU4 service intent between existing OTR cards.

In this section you create a service intent between OTR on two nodes.

You can also use this section to create a 100G service over an OCLD regen (back-to-back OCLD cards).

To create the service intent, use the Service Intent (CD fixed) API.

Requirements

You must ensure the following:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 993
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

• Set the OTR Equipment Profile2 attribute to None.

• The equipment (including pluggables) required by the service is installed in the network.
• If you are provisioning a 100G service over a regen, you must enable viability (see Plan equipment).
• You have an API token (see Obtain a token).
• You have enrolled ROADMs for both ends of the link (see the Blue Planet MCP User Guide, 450-3709-
301, for how to enroll a single network element). You have the TIDs and NCIDs for the enrolled
ROADMs.
• A suitable link with no OTU4 services exists.
• In the request:
◦ Specify the TID and location of the OCLDs for the A and Z ends.

Sample request — basic intent

POST {{MCP_SERVER}}/ifd/api/v1/serviceIntents

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 994
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

{
"data":{
"attributes": {
"label": "config100GE_1",
"directionality": "bidirectional",
"layerRate": "DSR_ETHERNET",
"endPoints": [
{
"networkElement": {
"name": "PV0032RPTB"
},
"shelf": "11",
"slot": "26",
"port": "1",
"layerTerminations": [
{
"layerRate": "DSR_ETHERNET",
"additionalAttributes": {
"PROTOCOL": "ETH100G",
"MAPPING": "GMP"
}
}
]
},
{
"networkElement": {
"name": "PV0032RPTC"
},
"shelf": "11",
"slot": "26",
"port": "1",
"layerTerminations": [
{
"layerRate": "DSR_ETHERNET",
"additionalAttributes": {
"PROTOCOL": "ETH100G",
"MAPPING": "GMP"
}
}
]
}
]
}
}
}

Sample response

A response code of 201 indicates successful creation of a service intent.

Create a 10G service intent

This section provides an example of the creation of an ETH10G service intent using MUX and OCLD
equipment.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 995
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

In this section you create a service intent between MUX client facilities on two nodes.

You can also use this section to create a 10G service over an OCLD regen (back-to-back OCLD cards).

To create the service intent, use the Service Intent (CD fixed) API.

Requirements

You must ensure the following:

• the equipment (including pluggables) required by the service is installed in the network.
• If you are provisioning a 10G service over a regen, you must enable viability (see Plan equipment).
• You have an API token (see Obtain a token).
• You have enrolled ROADMs for both ends of the link (see the Blue Planet MCP User Guide, 450-3709-
301, for how to enroll a single network element). You have the TIDs and NCIDs for the enrolled
ROADMs.
• An OTU4 service exists or is planned between the OCLDs (see Create an OTU4 service intent).
• in the request:
◦ Specify the TID and location of the MUX client facilities for the A and Z ends.
◦ Specify a turnUpDateTime (activation time) and, optionally, a turnDownDateTime (deactivation
time).

Sample request — basic intent

POST {{MCP_SERVER}}/ifd/api/v1/serviceIntents

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 996
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"data":{
"attributes": {
"turnUpDateTime": "2016-11-19T11:37:29.739-0500",
"label": "config10GE_1",
"directionality": "bidirectional",
"layerRate": "DSR_ETHERNET",
"endPoints": [
{
"networkElement": {
"name": "PV0027A"
},
"shelf": "12",
"slot": "3",
"port": "5",
"layerTerminations": [
{
"layerRate": "DSR_ETHERNET",
"additionalAttributes": {
"PROTOCOL": "ETH10G",
"MAPPING": "PROP237"
}
}
]
},
{
"networkElement": {
"name": "PV0027B"
},
"shelf": "12",
"slot": "3",
"port": "5",
"layerTerminations": [
{
"layerRate": "DSR_ETHERNET",
"additionalAttributes": {
"PROTOCOL": "ETH10G",
"MAPPING": "PROP237"
}
}
]
}
]
}
}
}

Sample response

A response code of 201 indicates successful creation of a service intent.

Create an OTU4 service intent over planned equipment

This section provides an example of the creation of an OTU4 service intent over planned equipment.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 997
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

Blue Planet MCP supports the ability to create planned services over planned equipment for deployment
at a future date. While this is possible for all supported equipment and service types, this section
describes the specific example of provisioning an OTU4 service over a planned fiber route and planned
transponders.

Requirements

You must ensure the following:

• There are three unused projects.

• You should now have a planned service over planned equipment.
◦ Plan a fiber route.

To add a new ROADM route to the network (new ROADMs) while omitting System line up and
testing (SLAT) and all subsequent steps

◦ Plan equipment
◦ Create an OTU4 service intent

Create a service intent

To create a service intent, use the Service Intent (CD fixed) API.

Sample request

POST {{MCP_SERVER}}/ifd/api/v1/serviceIntents

Sample response

A response code of 201 indicates successful creation of a service intent.

Deploy a service intent

To deploy a service intent, use the Service Intent (CD fixed) API.

Sample request

Obtain a service identifier to deploy.

POST {{MCP_SERVER}}/ifd/api/v1/serviceIntents/{id}/deploy

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 998
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

A response code of 200 indicates successful deployment of a service intent.

Retrieve a feasible route

Use the service feasibility API to determine if a service can be planned for a specific point in time (now or
future) and what that service looks like.

The API returns back the full path (in Revell format) of what the full end-to-end service looks like. Client-
client and line-line services are supported (including regens).

All checks that are normally done during service intent creation (not service intent deploy) are done also
in the service feasibility API.

The service feasibility API does not save any information on the server, that is, no service intent.

To retrieve a feasible route, access the Service provisioning (CD fixed) API.

Sample request

POST {{MCP_SERVER}}/ifd/api/v1/serviceIntentss/getFeasibleRoute

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 999
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

{
"data": {
"attributes": {
"turnUpDateTime": "2020-10-11T11:32:29.000+0000",
"label": "LINE_OTU4_NEW",
"directionality": "bidirectional",
"layerRate": "OTU4",
"endPoints": [{
"networkElement": {
"name": "{{SITEA}}"
},
"shelf": "12",
"slot": "1",
"port": "1"

},
{
"networkElement": {
"name": "{{SITEC}}"
},
"shelf": "22",
"slot": "1",
"port": "1"

}
]
}
}

Sample response

{
"data": {
"attributes": {
"cfmPackages": [],
"directionality": "bidirectional",
"identifiers": [],
"layerRate": "OTU4",
"maxReservableBandwidth": [],
"mgmtName": "service_1",
"networkRole": "FREAP",
"srlg": [],
"syncScopes": [],
"topologySources": [
"stitched"
],
"trails": [{
"protectionRole": "",
"rxDirection": [{
"id": "e227a74e-b7a4-3ccb-98a6-49d5ece1cbfb",
"type": "networkConstruct"
},
{
"id": "e227a74e-b7a4-3ccb-98a6-49d5ece1cbfb::EQPT_12_1",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1000
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"type": "equipment"
},
{
"id": "e227a74e-b7a4-3ccb-98a6-49d5ece1cbfb::TPE_e227a74e-
b7a4-3ccb-98a6-49d5ece1cbfb::EQPT_12_1-1-PTP",
"type": "tpes"
},
{
"id": "185842469282238163",
"type": "fres"
},
{
"id": "e227a74e-b7a4-3ccb-98a6-49d5ece1cbfb::TPE_e227a74e-
b7a4-3ccb-98a6-49d5ece1cbfb::EQPT_11_21-2-PTP",
"type": "tpes"
},
. . .
{
"id": "9bb2deea-e24a-3ed1-80e4-86f631e3aa85::TPE_9bb2deea-
e24a-3ed1-80e4-86f631e3aa85::EQPT_22_1-1-PTP",
"type": "tpes"
},
{
"id": "9bb2deea-e24a-3ed1-80e4-86f631e3aa85::EQPT_22_1",
"type": "equipment"
}
],
"txDirection": [{
"id": "e227a74e-b7a4-3ccb-98a6-49d5ece1cbfb",
"type": "networkConstruct"
},
{
"id": "e227a74e-b7a4-3ccb-98a6-49d5ece1cbfb::EQPT_12_1",
"type": "equipment"
},
{
"id": "e227a74e-b7a4-3ccb-98a6-49d5ece1cbfb::TPE_e227a74e-
b7a4-3ccb-98a6-49d5ece1cbfb::EQPT_12_1-1-PTP",
"type": "tpes"
},
. . .
{
"id": "9bb2deea-e24a-3ed1-80e4-86f631e3aa85::TPE_9bb2deea-
e24a-3ed1-80e4-86f631e3aa85::EQPT_22_1-1-PTP",
"type": "tpes"
},
{
"id": "9bb2deea-e24a-3ed1-80e4-86f631e3aa85::EQPT_22_1",
"type": "equipment"
}
]
}],
"usedBandwidth": [],
"userLabel": "x_viabilityOTU4_REGEN"
},
"id": "-4345358789047334452",
"relationships": {
"endPoints": {
"data": [{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1001
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"id": "-4345358789047334452:1",
"type": "endPoints"
},
{
"id": "-4345358789047334452:2",
"type": "endPoints"
}
]
},
"partitionFres": {
"data": [{
"id": "8647848284423065670",
"type": "fres"
}]
}
},
"type": "serviceTrails"
},
"included": [{
"attributes": {
"directionality": "bidirectional",
"role": "symmetric"
},
"id": "-4345358789047334452:1",
"relationships": {
"tpes": {
"data": [{
"id": "e227a74e-b7a4-3ccb-98a6-
49d5ece1cbfb::TPE_e227a74e-b7a4-3ccb-98a6-49d5ece1cbfb::EQPT_12_1-1-PTP",
"type": "tpes"
}]
}
},
"type": "endPoints"
},
. . .

Undeploy a service intent

This section provides an example of the undeployment of a service intent.

Undeploy (or remove/delete from the network) a service created by an intent that is deployed to the
network. Examples of service intents that can be undeployed (removed/deleted) are as follows: OTU4,
10G, or 100G.

To undeploy a service intent, use the Service Intent (CD fixed) API.

Note: This API does not delete the service intent.

There are two ways to specify when a service should be undeployed:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1002
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

1. When you create the service intent, you can specify an optional “turnDownDateTime”. If specified, the
system will attempt to undeploy the service at the specified time.
2. At any point, assuming the service intent is “DEPLOYED” in the network, you can request that service
undeployment be immediate. This example undeploys the service immediately.

Requirements

You must ensure the following:

• You have an API token (see Obtain a token).

• You have enrolled ROADMs for both ends of the link (see the Blue Planet MCP User Guide, 450-3709-
301, for how to enroll a single network element). You have the TIDs and NCIDs for the enrolled
ROADMs.
• You have created a service intent that is deployed in the network.
• You have performed the following validation checks before you attempt to undeploy a service intent:
◦ the intent state for the service is DEPLOYED
◦ underlying equipment for the service must not be in maintenance mode

Sample request

POST {{MCP_SERVER}}/ifd/api/v1/serviceIntents/{id}/undeploy

Note: For OTU4 services, the time required to undeploy the service can be lengthy.

Sample response

A response code of 202 indicates successful undeployment of a service intent.

Retrieve spectral allocation

This section provides an example of retrieving spectral allocation of the network which can be used in
support of troubleshooting the flexgrid deployment. This retrieved spectral data describes the spectral
usage at the OTSi layer along the specified service path.

To retrieve spectral allocation, use the Test and diagnostics API.

Note: This API retrieves spectral data on the path of one service. The spectral data are presented in the
TPE as usedCapacity.

Requirements

You must ensure the following:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1003
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

• You have an API token (see Obtain a token).

• You have available ROADM line(s) in your transport infrastructure and have the service FRE id(s) for
the selected ROADM line.
• in your request:
◦ specify the following parameter: service FRE id(s)

Sample request

GET {MCP_HOST}/tdc/api/v1/diag/spectral?freIds=7311240502812995208-ROADMLINE_-
8573074959516302103-ROADMLINE

Sample response

A partial sample response is provided below. A response code of 202 indicates the request was
accepted.

{
"data": {
"id": "f4fee368-e571-43a3-a799-fb720a65245f",
"type": "spectralResults",
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "0fe32a05-e45a-3248-96e9-d0924d0d2eb3::TPE_0fe32a05-
e45a-3248-96e9-d0924d0d2eb3::EQPT_1_7-5-CTPServerToClient-1"
},
{
"type": "tpes",
"id": "0fe32a05-e45a-3248-96e9-d0924d0d2eb3::TPE_0fe32a05-
e45a-3248-96e9-d0924d0d2eb3::EQPT_1_7-8-CTPServerToClient-1"
},
{
"type": "tpes",
"id": "d4abd144-1db9-3c26-b1d6-d0312e7e4510::TPE_d4abd144-
1db9-3c26-b1d6-d0312e7e4510::EQPT_1_1-5-CTPServerToClient-1"
},
{
"type": "tpes",
"id": "d4abd144-1db9-3c26-b1d6-d0312e7e4510::TPE_d4abd144-
1db9-3c26-b1d6-d0312e7e4510::EQPT_1_1-8-CTPServerToClient-1"
},
{
"type": "tpes",
"id": "0fe32a05-e45a-3248-96e9-d0924d0d2eb3::TPE_0fe32a05-
e45a-3248-96e9-d0924d0d2eb3::EQPT_1_7-5-PTP"
},
{
"type": "tpes",
"id": "0fe32a05-e45a-3248-96e9-d0924d0d2eb3::TPE_0fe32a05-
e45a-3248-96e9-d0924d0d2eb3::EQPT_1_7-8-PTP"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1004
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

{
"type": "tpes",
"id": "d4abd144-1db9-3c26-b1d6-d0312e7e4510::TPE_d4abd144-
1db9-3c26-b1d6-d0312e7e4510::EQPT_1_1-5-PTP"
},
{
"type": "tpes",
"id": "d4abd144-1db9-3c26-b1d6-d0312e7e4510::TPE_d4abd144-
1db9-3c26-b1d6-d0312e7e4510::EQPT_1_1-8-PTP"
}
]
},
"fres": {
"data": [
{
"type": "fres",
"id": "64656d45-57ef-413e-92e6-7c07eb3b3be0"
},
{
"type": "fres",
"id": "c5580fb1-25a2-4d05-b5af-fd9105eea9f4"
},
{
"type": "fres",
"id": "d5020da5-bc91-469b-9470-1dc881c5eee1"
},
{
"type": "fres",
"id": "3e3bdea1-0503-4b12-a445-5ba54a30d123"
}
]
}
},
"resultsCode": "202",
"requestIds": [
"7311240502812995208-ROADMLINE_-8573074959516302103-ROADMLINE"
],
"invalidIds": []
},
"included": [
{
"id": "0fe32a05-e45a-3248-96e9-d0924d0d2eb3::TPE_0fe32a05-e45a-3248-
96e9-d0924d0d2eb3::EQPT_1_7-5-CTPServerToClient-1",
"type": "tpes",
"attributes": {
"structureType": "CTPServerToClient",
"tpeGroupSpecs": [],
"nativeName": "MCTTP-1-7-5-1",
"locations": [
{
"managementType": "tl1",
"shelf": "1",
"slot": "7",
"port": "5",
"mcId": "1"
}
],
"layerTerminations": [
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1005
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"layerRate": "MEDIA",
"structureType": "lone adapter",
"terminationState": "layer termination cannot terminate",
"active": true,
"photonicSpectrumPackage": {
"minFreqDeadBand": "0.000",
"maxFreqDeadBand": "0.000",
"targetMinFreq": "193.675000",
"targetMaxFreq": "193.800000"
},
"cfmPackages": [],
"signalIndex": {
"mappingTable": [],
"minFreq": "193.675000",
"maxFreq": "193.800000"
},
"layerProtocol": {
"termination": {
"connectionRulesInOwnLayer": [
{
"targetLayer": "MEDIA",
"rule": "toServerUsingClientExternalFGRule"
}
]
},
"adaptationPools": [
{
"name": "otsiFlexGrid",
"poolAdapters": [],
"memberAdaptationPools": []
}
],
"layeredAttributes": []
},
"additionalAttributes": {
"DISPLAY_ALIAS": "MCTTP-1-7-5-1",
"forwardingState": "LT_CANNOT_FORWARD_TO_FROM_FRE"
}
}
],
"stackDirection": "client to server",
"displayAlias": "MCTTP-1-7-5-1",
"fgiSpecificationRefList": [],
"totalCapacity": [
{
"layer": "OTSi",
"capacityClass": "continuous",
"capacity": 0,
"capacitySize": {
"size": [
"193.675000:193.800000"
],
"pattern": {
"type": "LIST",
"format": "freqLowerBound:freqUpperBound"
},
"unit": "THz"
}
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1006
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

],
"usedCapacity": [
{
"layer": "OTSi",
"capacityClass": "continuous",
"capacity": 2,
"capacitySize": {
"size": [
"193.681250:193.718750",
"193.756250:193.793750"
],
"pattern": {
"type": "LIST",
"format": "freqLowerBound:freqUpperBound"
},
"unit": "THz"
}
}
],
"capacityReservations": [],
"cardType": "LIM",
"state": "IS",
"syncScopes": [],
"identifiers": [
{
"incarnation": "3",
"circuitId": "C204WEST_SNCG0-1-1"
},
{
"networkConstructId": "0fe32a05-e45a-3248-96e9-
d0924d0d2eb3",
"nodalId": "0fe32a05-e45a-3248-96e9-
d0924d0d2eb3::TPE_0fe32a05-e45a-3248-96e9-d0924d0d2eb3::EQPT_1_7-5-
CTPServerToClient-1"
}
],
"additionalAttributes": {
"mcId": "1",
"SYNCED_AT": "",
"tpeLifeCycleOwnerType": "SERVICEINVENTORY",
"reconcileRule": "sncGroup"
}
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "0fe32a05-e45a-3248-96e9-d0924d0d2eb3"
}
},
"equipment": {
"data": {
"type": "equipment",
"id": "0fe32a05-e45a-3248-96e9-d0924d0d2eb3::EQPT_1_7"
}
},
"owningServerTpe": {
"data": {
"type": "tpes",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1007
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"id": "0fe32a05-e45a-3248-96e9-d0924d0d2eb3::TPE_0fe32a05-
e45a-3248-96e9-d0924d0d2eb3::EQPT_1_7-5-PTP"
}
},
"clientTpes": {
"data": [
{
"type": "tpes",
"id": "0fe32a05-e45a-3248-96e9-
d0924d0d2eb3::TPE_0fe32a05-e45a-3248-96e9-d0924d0d2eb3::EQPT_1_7-5-
CTPServerToClient-193.775000"
},
{
"type": "tpes",
"id": "0fe32a05-e45a-3248-96e9-
d0924d0d2eb3::TPE_0fe32a05-e45a-3248-96e9-d0924d0d2eb3::EQPT_1_7-5-
CTPServerToClient-193.700000"
}
]
}
}
},
{
"id": "0fe32a05-e45a-3248-96e9-d0924d0d2eb3::TPE_0fe32a05-e45a-3248-
96e9-d0924d0d2eb3::EQPT_1_7-5-CTPServerToClient-193.775000",
"type": "tpes",
"attributes": {
"structureType": "CTPServerToClient",
"tpeGroupSpecs": [],
"nativeName": "NMCLNCTP-1-7-5-1-3",
"locations": [
{
"managementType": "tl1",
"shelf": "1",
"slot": "7",
"port": "5",
"frequency": "193.775000",
"mcId": "1"
}
],
"layerTerminations": [
{
"layerRate": "OTSi",
"structureType": "exposed lone cp",
"terminationState": "layer termination cannot terminate",
"active": true,
"cfmPackages": [],
"signalIndex": {
"mappingTable": [],
"frequency": "193.775000",
"width": "37.500"
},
"additionalAttributes": {
"forwardingState": "FORWARDING_TO_LT_FROM_FRE"
}
}
],
"stackDirection": "client to server",
"displayAlias": "NMC-1-7-5-193.775000",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1008
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"fgiSpecificationRefList": [],
"totalCapacity": [
{
"layer": "OTSi",
"capacityClass": "continuous",
"capacity": 0,
"capacitySize": {
"size": [],
"pattern": {
"type": "LIST",
"format": "freqLowerBound:freqUpperBound"
},
"unit": "THz"
}
}
],
"usedCapacity": [
{
"layer": "OTSi",
"capacityClass": "continuous",
"capacity": 0,
"capacitySize": {
"size": [],
"pattern": {
"type": "LIST",
"format": "freqLowerBound:freqUpperBound"
},
"unit": "THz"
}
}
],
"capacityReservations": [],
"cardType": "LIM",
"state": "IS",
"syncScopes": [],
"identifiers": [
{
"networkConstructId": "0fe32a05-e45a-3248-96e9-
d0924d0d2eb3",
"nodalId": "0fe32a05-e45a-3248-96e9-
d0924d0d2eb3::TPE_0fe32a05-e45a-3248-96e9-d0924d0d2eb3::EQPT_1_7-5-
CTPServerToClient-193.775000"
}
],
"additionalAttributes": {
"SYNCED_AT": "",
"tpeLifeCycleOwnerType": "SERVICEINVENTORY",
"nmcId": "3"
}
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "0fe32a05-e45a-3248-96e9-d0924d0d2eb3"
}
},
"equipment": {
"data": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1009
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"type": "equipment",
"id": "0fe32a05-e45a-3248-96e9-d0924d0d2eb3::EQPT_1_7"
}
},
"owningServerTpe": {
"data": {
"type": "tpes",
"id": "0fe32a05-e45a-3248-96e9-d0924d0d2eb3::TPE_0fe32a05-
e45a-3248-96e9-d0924d0d2eb3::EQPT_1_7-5-CTPServerToClient-1"
}
}
}
},
{
"id": "0fe32a05-e45a-3248-96e9-d0924d0d2eb3::TPE_0fe32a05-e45a-3248-
96e9-d0924d0d2eb3::EQPT_1_7-5-CTPServerToClient-193.700000",
"type": "tpes",
"attributes": {
"structureType": "CTPServerToClient",
"tpeGroupSpecs": [],
"nativeName": "NMCLNCTP-1-7-5-1-1",
"locations": [
{
"managementType": "tl1",
"shelf": "1",
"slot": "7",
"port": "5",
"frequency": "193.700000",
"mcId": "1"
}
],
"layerTerminations": [
{
"layerRate": "OTSi",
"structureType": "exposed lone cp",
"terminationState": "layer termination cannot terminate",
"active": true,
"cfmPackages": [],
"signalIndex": {
"mappingTable": [],
"frequency": "193.700000",
"width": "37.500"
},
"additionalAttributes": {
"forwardingState": "FORWARDING_TO_LT_FROM_FRE"
}
}
],
.
.
.
.
.
.
.
.
.
.
.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1010
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

.
{
"layerRate": "OTS",
"structureType": "full layer fixed",
"terminationState": "layer termination permanently
terminated",
"active": true,
"cfmPackages": [],
"nativeName": "ADJ-1-1-5",
"additionalAttributes": {
"USER_LABEL": ""
}
},
{
"layerRate": "PHY",
"structureType": "full layer fixed",
"terminationState": "layer termination permanently
terminated",
"active": true,
"adjacencyPackage": {
"adjacencyType": "LINE",
"localTag": "C204EAST-1-1-5",
"remoteTag": "C204DGE-1-7-8",
"remoteTagFormat": "TID-SH-SL-PRT",
"topologySourceTag": "DISCOVERED"
},
"cfmPackages": [],
"nativeName": "ADJ-1-1-5",
"additionalAttributes": {
"userLabel": "",
"forwardingState": "LT_CANNOT_FORWARD_TO_FROM_FRE"
}
}
],
"stackDirection": "client to server",
"displayAlias": "ADJ-1-1-5",
"fgiSpecificationRefList": [
"6500_CCMD12_Add_OTSi_FG:1:1",
"6500_Must_Not_Connect_OTSi_FG:1:1-1-5-8",
"6500_ROADM_Passthrough_OTSi_FG:1:100"
],
"totalCapacity": [
{
"layer": "MEDIA",
"capacityClass": "continuous",
"capacity": 0,
"capacitySize": {
"size": [
"191.325000:196.125000"
],
"pattern": {
"type": "RANGE",
"format": "freqLowerBound:freqUpperBound"
},
"unit": "THz"
}
}
],
"usedCapacity": [

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1011
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

{
"layer": "MEDIA",
"capacityClass": "continuous",
"capacity": 1,
"capacitySize": {
"size": [
"193.675000:193.800000"
],
"pattern": {
"type": "RANGE",
"format": "freqLowerBound:freqUpperBound"
},
"unit": "THz"
}
}
],
"capacityReservations": [],
"cardType": "SAM",
"roadmLine": "OUT",
"state": "OOS",
"syncScopes": [],
"identifiers": [
{
"nativeName": "ADJ-1-1-5",
"networkConstructId": "d4abd144-1db9-3c26-b1d6-
d0312e7e4510"
},
{
"networkConstructId": "d4abd144-1db9-3c26-b1d6-
d0312e7e4510",
"nodalId": "d4abd144-1db9-3c26-b1d6-
d0312e7e4510::TPE_d4abd144-1db9-3c26-b1d6-d0312e7e4510::EQPT_1_1-5-PTP"
}
],
"additionalAttributes": {
"ROADM_LINE_PAIR_TPE_LOC": "1-1-6",
"ROADM_LINE_NAME": "d4abd144-1db9-3c26-b1d6-
d0312e7e4510::TPE_d4abd144-1db9-3c26-b1d6-d0312e7e4510::EQPT_1_1-5-PTP",
"OTS_TYPE": "CHA",
"SYNCED_AT": "",
"OTS_INSTANCE": "1-1",
"USER_LABEL": "",
"tpeLifeCycleOwnerType": "SERVICEINVENTORY",
"OTS_SUBTYPE": "ROADM"
}
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "d4abd144-1db9-3c26-b1d6-d0312e7e4510"
}
},
"equipment": {
"data": {
"type": "equipment",
"id": "d4abd144-1db9-3c26-b1d6-d0312e7e4510::EQPT_1_1"
}
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1012
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"clientTpes": {
"data": [
{
"type": "tpes",
"id": "d4abd144-1db9-3c26-b1d6-
d0312e7e4510::TPE_d4abd144-1db9-3c26-b1d6-d0312e7e4510::EQPT_1_1-5-
CTPServerToClient-1"
}
]
},
"partnerTpe": {
"data": {
"type": "tpes",
"id": "d4abd144-1db9-3c26-b1d6-d0312e7e4510::TPE_d4abd144-
1db9-3c26-b1d6-d0312e7e4510::EQPT_1_1-8-PTP"
}
}
}
},
{
"id": "d4abd144-1db9-3c26-b1d6-d0312e7e4510::TPE_d4abd144-1db9-3c26-
b1d6-d0312e7e4510::EQPT_1_1-8-PTP",
"type": "tpes",
"attributes": {
"structureType": "PTP",
"tpeGroupSpecs": [],
"nativeName": "",
"locations": [
{
"managementType": "tl1",
"shelf": "1",
"slot": "1",
"port": "8"
}
],
"layerTerminations": [
{
"layerRate": "OMS",
"structureType": "full layer fixed",
"terminationState": "layer termination permanently
terminated",
"active": true,
"cfmPackages": [],
"layerProtocol": {
"termination": {
"connectionRulesInOwnLayer": [
{
"targetLayer": "OMS",
"rule": "mustConnectInternally"
}
]
},
"adaptationPools": [
{
"name": "flexGridCBand",
"poolAdapters": [],
"memberAdaptationPools": []
}
],

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1013
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"layeredAttributes": []
}
},
{
"layerRate": "OTS",
"structureType": "full layer fixed",
"terminationState": "layer termination permanently
terminated",
"active": true,
"cfmPackages": [],
"nativeName": "",
"additionalAttributes": {
"USER_LABEL": ""
}
},
{
"layerRate": "PHY",
"structureType": "full layer fixed",
"terminationState": "layer termination permanently
terminated",
"active": true,
"adjacencyPackage": {
"adjacencyType": "",
"localTag": "C204EAST-1-1-8",
"topologySourceTag": "DISCOVERED"
},
"cfmPackages": [],
"nativeName": "",
"additionalAttributes": {
"userLabel": "",
"forwardingState": "LT_CANNOT_FORWARD_TO_FROM_FRE"
}
}
],
"stackDirection": "server to client",
"displayAlias": "OPTMON-1-1-8",
"fgiSpecificationRefList": [
"6500_CCMD12_Drop_OTSi_FG:1:1",
"6500_Must_Not_Connect_OTSi_FG:1:1-1-5-8",
"6500_ROADM_Passthrough_OTSi_FG:1:100"
],
"totalCapacity": [
{
"layer": "MEDIA",
"capacityClass": "continuous",
"capacity": 0,
"capacitySize": {
"size": [
"191.325000:196.125000"
],
"pattern": {
"type": "RANGE",
"format": "freqLowerBound:freqUpperBound"
},
"unit": "THz"
}
}
],
"usedCapacity": [

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1014
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

{
"layer": "MEDIA",
"capacityClass": "continuous",
"capacity": 1,
"capacitySize": {
"size": [
"193.675000:193.800000"
],
"pattern": {
"type": "RANGE",
"format": "freqLowerBound:freqUpperBound"
},
"unit": "THz"
}
}
],
"capacityReservations": [],
"cardType": "SAM",
"roadmLine": "IN",
"state": "IS",
"syncScopes": [],
"identifiers": [
{
"networkConstructId": "d4abd144-1db9-3c26-b1d6-
d0312e7e4510",
"nodalId": "d4abd144-1db9-3c26-b1d6-
d0312e7e4510::TPE_d4abd144-1db9-3c26-b1d6-d0312e7e4510::EQPT_1_1-8-PTP"
}
],
"additionalAttributes": {
"ROADM_LINE_PAIR_TPE_LOC": "1-1-7",
"ROADM_LINE_NAME": "d4abd144-1db9-3c26-b1d6-
d0312e7e4510::TPE_d4abd144-1db9-3c26-b1d6-d0312e7e4510::EQPT_1_1-8-PTP",
"OTS_TYPE": "CHA",
"SYNCED_AT": "",
"OTS_INSTANCE": "1-1",
"USER_LABEL": "",
"tpeLifeCycleOwnerType": "EQUIPMENT",
"OTS_SUBTYPE": "ROADM"
}
},
"relationships": {
"networkConstruct": {
"data": {
"type": "networkConstructs",
"id": "d4abd144-1db9-3c26-b1d6-d0312e7e4510"
}
},
"equipment": {
"data": {
"type": "equipment",
"id": "d4abd144-1db9-3c26-b1d6-d0312e7e4510::EQPT_1_1"
}
},
"clientTpes": {
"data": [
{
"type": "tpes",
"id": "d4abd144-1db9-3c26-b1d6-

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1015
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

d0312e7e4510::TPE_d4abd144-1db9-3c26-b1d6-d0312e7e4510::EQPT_1_1-8-
CTPServerToClient-1"
}
]
},
"partnerTpe": {
"data": {
"type": "tpes",
"id": "d4abd144-1db9-3c26-b1d6-d0312e7e4510::TPE_d4abd144-
1db9-3c26-b1d6-d0312e7e4510::EQPT_1_1-5-PTP"
}
}
}
}
]
}

Perform loopback test for connection validation

This section provides an example of performing a connection validation loopback test on transponder line
ports that are connected to add/drop banks to ensure that they are cabled consistently with the
provisioned adjacency.

To perform loopback test, use the Test and diagnostics API.

Requirements

You must ensure the following:

• You have an API token (see Obtain a token).

Note: This sample test should be executed for new transponders (for example, OCLD, OTR line port) once
the transponder exists and the ADJ on the CMD for that transponder has been set. This test is not
required for ports not connected to a CMD.

Sample request

POST {MCP_HOST}/tdc/api/v1/tests/loopbackOperations

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1016
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

{
"data": {
"type": "loopback",
"localTpeId": "771550c5-66d7-4eda-9ca5-25d014d2de49::TPE_771550c5-66d7-4eda-
9ca5-25d014d2de49::EQPT_151_3-1-PTP",
"testParameters": {
"noParameter": "as of 17.02"
},
"userAnnotation": "Beili 2016.12.7 no TPE validation. The testParameters can be
left empty."
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1017
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

{
"data": {
"id": "74e5dab4-0c21-43f2-a99a-9d207297a5f9",
"type": "testResults",
"attributes": {
"testResults": [],
"testType": "loopback",
"testStatus": "Started",
"localTpeId": "MockCcmdPtp1",
"remotePoints": [],
"localNcId": "MockNcPv0034b",
"remoteNcs": [],
"startTime": 1484525289237,
"lastUpdateTime": 1484525289237,
"testParameters": {
"slotBase": "true"
},
"userAnnotation": "string",
"slot": "21",
"port": "1",
"shelf": "11"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "MockCcmdPtp1"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "MockNcPv0034b"
}
]
}
}
},
"resultsCode": "202"
}

Retrieve results for a loopback test on transponder line

ports
This section provides an example of performing a query of test results (for example loopback test).

To retrieve test results, use the Test and diagnostics API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1018
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

Requirements

You must ensure the following:

• You have an API token (see Obtain a token).

• You have performed loopback test of available transponder line ports that are connected to add/drop
banks in your transport infrastructure.
• in your request:
◦ specify the following parameter: test id

Sample request

GET {MCP_SERVER}/tdc/api/v1/tests/{testId}

Note: For retrieving test results, the only parameter required is the test id. Test results can only be
retrieved one record at a time using the retrieve test results API.

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1019
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

{
"data": {
"id": "a7ff42f8-d757-4159-baff-ba4203026d29",
"type": "testResults",
"attributes": {
"testResults": [
{
"operationalStatus": "success",
"errorMessage": "successful create",
"dataType": "summary"
}
],
"testType": "loopback",
"testStatus": "In progress",
"localTpeId": "MockCcmdPtp1",
"remotePoints": [],
"localNcId": "MockNcPv0034b",
"remoteNcs": [],
"startTime": 1484533372246,
"lastUpdateTime": 1484533401794,
"testParameters": {
"slotBase": "true"
},
"userAnnotation": "string",
"limPort": "21-1-2 sh-sl-pt",
"loopbackWavelength": "152877",
"port": "1",
"slot": "21",
"cmdPort": "11-21-1 sh-sl-pt",
"shelf": "11"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "MockCcmdPtp1"
}
]
},
"networkConstructs": {
"data": [
{
"type": "networkConstructs",
"id": "MockNcPv0034b"
}
]
}
}
},
"resultsCode": 200,
"requestIds": "a7ff42f8-d757-4159-baff-ba4203026d29"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1020
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

Manage bandwidth lockout for an OMS link section

As part of network troubleshooting, you may want to implement a bandwidth lockout on a non-control-
plane, internodal OMS link section. This lockout will prevent new services from being routed on that OMS
section, but will still leave the section operational.

While the bandwidth lockouts in effect for an FRE, its associated TPEs (ports) will be locked. MCP will not
include a locked TPE as part of any "deploy now" service route calculation.

However any "deploy in future" service planning will still include currently-locked TPEs as part of a route
calculation, with the expectation that they will be unlocked before the service is implemented.

Possible reasons for implementing a bandwidth lockout on an OMS section include:

• the OMS section was just created, and you want to soak-test it for a while before routing any customer
traffic over it
• maintenance is currently being performed on the OMS section, and you want to make sure new
services are not added to it during the maintenance period
• the OMS section is experiencing quality issues, and while you are troubleshooting you don’t want more
services to be added (since they would immediately be affected by the same issue)

When deploying or re-deploying a partially deployed service, in all cases where service deployment
time=now or future, MCP checks the administrative locks at the time of deployment. If such a lock is
found, the deployment will fail and the service will remain in the previous "planned" or "deploy_failed"
state. An auto deploy service will stay in the planned state it had before. If you attempt to redeploy the
service manually then the error message "admin lock" will be reported. This error is also stored in the log
file.

Note 1: Only inter-nodal OMS link sections can be locked out in this way.

Note 2: Service Feasibility will take the administrative lock into account, but only if time=now/past

Note 3: Re-deploying a service will do the same admin locks check as the initial deploy

You can use the API calls described here to set, and later remove, such a lockout from a specified OMS
link section. You an also use the API call described here to query for links that are currently subject to
bandwidth lockout.

This section describes the API calls used to:

• create a bandwidth lockout on a selected link section

• remove a bandwidth lockout from a selected link section
• query all link sections to identify those that are currently subject to a bandwidth lockout

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1021
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

Obtaining the FRE ID

To either set or clear a bandwidth lockout, begin by obtaining the ID of the link section you will be
managing. Obtain the FRE ID of the link you are interested in using the Service inventory (FREs) API.

Then use this FRE ID to issue the API call shown in either of the following sections:

• create a bandwidth lockout on a selected link section

• remove a bandwidth lockout from a selected link section

Setting a bandwidth lockout

To set a bandwidth lockout, use the following API call:

PUT {{<MCP_HOST>}}/nsi/api/fres/{freID}/bookingData/bandwidthLockout

Sample response:

Request URL: https://<MCP_HOST>/nsi/api/fres/{freID}/bookingData/bandwidthLockout

Response Body:
{
"data": {
"id": "7610319834116549486",
"type": "fres"
}
}

Response code: 200

Clearing a bandwidth lockout

To clear a bandwidth lockout, use the following API call:

DELETE {{MCP_HOST>}}/nsi/api/fres/{freID}/bookingData/bandwidthLockout

Sample response:

Response Body: no content

Response Code: 204

Querying for links subject to a bandwidth lockout

To query for links currently subject to a bandwidth lockout, use the following API call:

GET {{MCP_HOST}}/nsi/api/fres?bookingData.lockout=true

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1022
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

Sample response:

{
"meta": {
"total": 2,
"aggregations": []
},
"data": [
{
"id": "-757759126947706937",
"type": "fres",
"attributes": {
"userLabel": "",
"mgmtName": "RAK-MPLS",
"nativeName": "",
"layerRate": "MPLS_PROTECTION",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"deploymentState": "discovered",
"active": true,
"additionalAttributes": {
"protectionRole": "All",
"isActual": "true"
},
"derivedAttributes": {
"intentLifeCyclePhase": "adopting discovered",
"intentDeploymentState": "waiting to adopt"
},
"displayData": {
"intentLifeCyclePhaseString": "Discovered",
"intentDeploymentStateString": "Not applicable"
},
"resourceState": "discovered",
"bookingData": {
"assignedBandwidth": "200.0",
"assignedBandwidthUnit": "mbps",
"bandwidthLockout": true,
"bookingFactor": "1"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "-757759126947706937:1"
},
{
"type": "endPoints",
"id": "-757759126947706937:2"
}
]
},
"decomposedFres": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1023
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"data": [
{
"type": "fres",
"id": "1481258771465315756"
}
]
}
}
},
{
"id": "7610319834116549486",
"type": "fres",
"attributes": {
"userLabel": "",
"mgmtName": "Anoop-Primary",
"nativeName": "",
"layerRate": "MPLS_PROTECTION",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"deploymentState": "discovered",
"active": true,
"additionalAttributes": {
"protectionRole": "All",
"isActual": "true"
},
"derivedAttributes": {
"intentLifeCyclePhase": "adopting discovered",
"intentDeploymentState": "waiting to adopt"
},
"displayData": {
"intentLifeCyclePhaseString": "Discovered",
"intentDeploymentStateString": "Not applicable"
},
"resourceState": "discovered",
"bookingData": {
"assignedBandwidth": "200.0",
"assignedBandwidthUnit": "mbps",
"bandwidthLockout": true,
"bookingFactor": "1"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "7610319834116549486:1"
},
{
"type": "endPoints",
"id": "7610319834116549486:2"
}
]
},
"decomposedFres": {
"data": [

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1024
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

{
"type": "fres",
"id": "837761269376732920"
},
{
"type": "fres",
"id": "5027972606109232990"
}
]
}
}
}
],
"included": [
{
"id": "-757759126947706937:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "2c06ee34-6e8f-30a8-9f1b-4be2828ad966::TPE_FTP_MPLS-
PROTECTION_RAK-MPLS_headEnd"
}
]
}
}
},
{
"id": "-757759126947706937:2",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "f240cfdf-bd82-32ea-9040-1cd2fcfc29e7::TPE_FTP_MPLS-
PROTECTION_RAK-MPLS_tailEnd"
}
]
}
}
},
{
"id": "7610319834116549486:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1025
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "2c06ee34-6e8f-30a8-9f1b-4be2828ad966::TPE_FTP_MPLS-
PROTECTION_Anoop-Primary_tailEnd"
}
]
}
}
},
{
"id": "7610319834116549486:2",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "f240cfdf-bd82-32ea-9040-1cd2fcfc29e7::TPE_FTP_MPLS-
PROTECTION_Anoop-Primary_headEnd"
}
]
}
}
}
]
}

Response code: 200

Delete a discovered Layer 0 service

Use this procedure to delete a discovered Layer 0 service.

Note 1: MCP only supports the deletion of discovered services in those cases where MCP supports the
provisioning of the service.

Note 2: MCP 18.06 does not support 6500 control plane (CP) in-service takeovers on non-control plane
(NCP) services.

Deleting a discovered Layer 0 service is a multi-step process:

1. Retrieve the thread pools available to process promotion requests

2. Promote the discovered service to the MCP service
3. Delete the service

Promoting the discovered Layer 0 service allows MCP to manage a service that was not created using

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1026
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

MCP.

To promote a discovered service, use these Market resource APIs:

Retrieve the thread pools available to process promotion

requests
Sample request

GET
{{MCP_SERVER}}/bpocore/market/api/v1/resources?exactTypeID=ifd.v2.resourceTypes.ServicePromoti
onContainer

Sample response

{
"items": [{
"id": "595d2de7-8c6b-4219-a608-fa8a1aadccb3",
"label": "Resource for ifd.v2.resourceTypes.ServicePromotionContainer",
"resourceTypeId": "ifd.v2.resourceTypes.ServicePromotionContainer",
"productId": "595d2de5-bae7-493f-bcfd-cc92707ab075",
"tenantId": "536e2d63-f640-4fa1-866f-c2bffa2c3c81",
"shared": false,
"properties": {},
"discovered": false,
"differences": [],
"desiredOrchState": "active",
"orchState": "active",
"reason": "",
"tags": {},
"providerData": {},
"updatedAt": "2017-07-05T18:20:25.071Z",
"createdAt": "2017-07-05T18:20:24.150Z",
"autoClean": false
}, {
...
...
}]
}

Promote the discovered service to the MCP service

Sample request

POST {{MCP_SERVER}}/bpocore/market/api/v1/resources/{{RID}}/operations

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1027
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

{
"interface": "promoteService",
"inputs": {
"service": {
"freId": "<<FRE ID OF Discovered Service>>"
}
}
}

Sample response

{
"id": "595e8834-eab3-4315-849f-c48527f466f0",
"resourceId": "595e7bf2-5c87-4935-b671-630248cfe4e5",
"interface": "promoteService",
"inputs": {
"service": {
"freId": "1305545905537334667"
}
},
"outputs": {},
"state": "requested",
"reason": "",
"createdAt": "2017-07-06T18:57:56.703Z",
"updatedAt": "2017-07-06T18:57:56.703Z",
"resourceStateConstraints": {}
}

Delete the service

In the Blue Planet MCP UI, delete the service as usual (by selecting the service and choosing the Delete
button).

Channel margins
This section includes the following:

• examples of retrieving channel margin data for a transport service

• an example of setting the upgrade safety factor
• an example of retrieving the upgrade safety factor
• an example of setting the channel margin validity factor
• an example of retrieving the channel margin validity factor

Note: Liquid Spectrum applications require the MCP Plus license.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1028
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

Retrieve FRE identifier(s) using the Services inventory (FREs)

API
Note: Margin data is displayed under the user data as part of the API response if the OTSi FRE is a
photonic service (Tx to Tx).

Sample request

GET {{MCP_SERVER}}/nsi/api/fres?group=dwa&limit=3000&layerRate=OTSi

Sample response

"data": [
{
...
"id": "-8562028732694322491",
"type": "fres",
"attributes": {
"deploymentState": "discovered",
"userData": {
"marginData": {
\"minMargin\": 3.40,
\"upgrMargin\": 3.70,
\"sdMargin\": 0.50,
\"valid\": true,
\"status\": \"Good\"
}
...
},
},
},
]

Retrieve SNR margin data using the Performance Gauge API -

example #1
Note: This example retrieves signal-to-noise ration (SNR) magin data for all OTSi FREs (photonic services
from Tx to Tx) in the system for both directions.

Sample request

GET {{MCP_SERVER}}/perfg/api/v1/channelmargin

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1029
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

Sample response

{
"services": [
{
"direction": "Tx",
"freId": "7497479283820796464",
"maxMargin": 9.5,
"meanMargin": 9.4,
"minMargin": 9.4,
"sdMargin": 1,
"status": "Upgrade",
"upgrMargin": 4.5,
"valid": true
},
{
"direction": "Rx",
"freId": "7497479283820796464",
"maxMargin": 4.8,
"meanMargin": 4.8,
"minMargin": 4.8,
"sdMargin": 1,
"status": "Good",
"upgrMargin": 4.5,
"valid": true
}
]
}

where:

• maxMargin = the time series upper bound

• meanMargin = time series mean
• minMargin = time series lower bound
• sdMargin = signal degrade margin
• status = low, good, or upgrade candidate based on lower bound data points
• upgrMargin = the SNR margin required to upgrade to the next capacity level
• valid = validity flag of the current data sets. "false" indicates insufficient data points to make a solid
recommendatation.

Retrieve SNR margin data using the Performance Gauge API -

example #2
Note: You can retrieve channel margin data for a specific OTSi FRE and a specific direction (Tx or Rx). The
response includes the time-series analyzed data (lower bound: minMargin, upper bound: maxMargin, and
the mean: meanMargin). The histogram bin data points (in increments of 0.1 dB from 0 dB to 10 dB of the
SNR margin) based on 7 days of data margin points are also displayed.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1030
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

Additional data points include:

• timeEnd = last time stamp when the performance data was collected
• timeStart = the first time stamp since when the performance data is considered for time-series
analysis
• upgrRate = the next upgradable capacity or line rate
• valid = validity flag of the current data sets. "false" indicates insufficient data points to make a solid
recommendatation.

Sample requests

GET {{MCP_SERVER}}/perfg/api/v1/channelmargin/-2690535841732388624/Tx

GET {{MCP_SERVER}}/perfg/api/v1/channelmargin/-2690535841732388624/Rx

Sample response

{
"services": [
{
"histogram": [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
"intervals": 11,
"maxMargin": 9.1,
"meanMargin": 9.1,
"minMargin": 9,
"sdMargin": 1,
"status": "Upgrade",
"timeEnd": "2017-11-15T16:30:00Z",
"timeStart": "2017-11-15T14:00:00Z",
"upgrMargin": 4.5,
"upgrRate": 150.0G
"valid": false
}
]
}

Set the channel margin upgrade safety factor

Use this API to set how much greater (dB) than the upgrade amount does the minimum margin need to be
for the transport service to be flagged as a bandwidth upgrade candidate.

A default check is performed to determine if a service is upgradable. This default check confirms whether
or not the time-series lower bound margin value will be above the signal degrade margin value after a

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1031
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

bandwidth upgrade. The upgrade safety factor enables you to set additional channel margin thresholds to
be considered before performing an upgrade.

Note: The safety factor can be a value between 0.0 and 10.0.

Sample request

PUT {{MCP_SERVER}}/perfg/api/v1/safety/0.5

Sample response A response code of 200 indicates that MCP was successfully updated.

Retrieve the channel margin upgrade safety factor

Use this API to retrieve the current channel margin upgrade safety factor.

Sample request

GET {{MCP_SERVER}}/perfg/api/v1/safety

Sample response

{
"factor": 0.5
}

Set the channel margin upgrade validity factor

Use this API to set the number of 15-minute PM bins required before a time-series margin calculation is
considered valid. The default is 200 PM bins (approximately 2 days of PM bins).

Note: The validity factor can be a value between 1 and 35040.

Sample request

PUT {{MCP_SERVER}}/perfg/api/v1/validity/96

Note: '96' 15-minute PM bins reduces time-series validation to 1 day of PM bins.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1032
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

Sample response A response code of 200 indicates that MCP was successfully updated.

Retrieve the channel margin upgrade validity factor

Use this API to retrieve the current number of 15-minute PM bins required before a time-series channel
margin calculation is considered valid.

Sample request

GET {{MCP_SERVER}}/perfg/api/v1/safety

Sample response

{
"factor": 96
}

Retrieve co-routed FREs

This section provides an example of retrieving a list of co-routed FREs for a specified FRE. To retrieve a
list of co-routed FREs for a specified FRE, use the Services inventory (FREs) API.

• Use this query before up-shifting a service.

◦ This query enables you to see the performance status (in terms of SNR margins) for all co-
propagating channels.
◦ Perform this query before deciding to upgrade capacity on a channel.
▪ Check the status of other co-propagating channels to determine if any of the channels are
running low on capacity and, if any of the channels is running low on capacity, to further analyze
future impacts. For example, if a photonic service is part of an SNCG (grouped SNCs, such as a
super-channel), you have to upgrade channel capacity for all services within that group and it is
important to know the SNR margin for all of the channels before upgrading the capacities.
• Use this query for performance debugging.
◦ If a channel of interest is running with a low margin, from a debugging point of view you need to
know the status of other co-propagating channels to determine if they are also running low on
capacity. If the other channels are also running low on capacity, that typically implies a problem
with the fiber plant or it indicates a problem with the specific Tx/Rx or its fiber connections.

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1033
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

GET {MCP_SERVER}/nsi/api/fres?coroutedFreId=-48362996977577746

Sample response

{
"meta": {
"total": 6,
"aggregations": []
},
"data": [
{
"id": "3461181939474856342",
"type": "fres",
"attributes": {
"operationState": "In Service",
"deploymentState": "discovered",
"derivedAttributes": {
"intentLifeCyclePhase": "adopting discovered",
"intentDeploymentState": "waiting to adopt"
},
"displayData": {
"intentLifeCyclePhaseString": "Discovered",
"frequency": "193.275000",
"operationState": "Up",
"adminState": "Enabled"
},
"resourceState": "discovered",
"policies": {
"defaultAttributeSourcePolicy": "discoveredOverPlanned",
"overrides": [
{
"attributeName": "attributes.userLabel",
"policies": [
"plannedOverDiscovered"
]
}
]
},
"serviceClass": "Photonic",
"lqsData": {
"status": "upgrade",
"margin": {
"minMargin": 19.6,
"upgrMargin": 4.5,
"sdMargin": 1,
"valid": false,
"viableAtEol": "unknown"
}
},
"userLabel": "",
"mgmtName": "",
"nativeName": "",
"layerRate": "OTSi",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1034
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

Add, update, or delete the customerName and note

attributes for a planned or discovered service
To add, update, or delete the customerName and note attributes for a planned or discovered service, use
the Services Inventory (FREs) API.

Action

1. Create a service from MCP with or without setting any attributes.

2. Add or update the attributes. For a Line service, set the attributes on OTSi FREAP.

Sample payload request to add or update customerNote and note attributes

PATCH {{MCP_SERVER}}/nsi/api/v4/fres/{freid}

{
"operations": [
{
"op": "replace",
"attributes": {
"note": {
"noteMsg": "Your note message here",
"lastUpdatedBy": "Muntader"
},
"customerName": "Ciena"
}
}
]
}

Sample payload request to delete customerNote and note attributes

PATCH {{MCP_SERVER}}/nsi/api/v4/fres/{freid}

{
"operations": [
{
"op": "delete",
"attribute": "note"
},
{
"op": "delete",
"attribute": "customerName"
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1035
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

Add or update the userLabel attribute for a planned

service
To add or update the userLabel attribute for a planned service, use the Services Inventory (FREs) API.

Action

1. Using the MCP UI, select Network > Services > Transport services.
2. Filter the OTSi service and select that service.
3. Click Details.
4. The URL at the top of the page includes the FRE ID. Use that FRE ID for the GET API. As an example,
you would be using -3155207493381222634 as the FRE ID, for a URL such as: https://<mcp-server>/
ui/#/photonics/-3155207493381222634

Sample response for OTSi FREAP (frePlanned)

{
"data": {
"id": "-3155207493381222634",
"type": "frePlanned",
"attributes": {
"userLabel": "service_name_label",
"layerRate": "OTSi",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"active": true,
"additionalAttributes": {
"viabilityStatus": "VIABILITY_UNKNOWN",
"spectralWidthInGHz": "37.5",
"capacityInBps": "100.0"
}
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "a776afea-4c09-347d-be30-9c171718c2d8::TPE_a776afea-4c09-347d-
be30-9c171718c2d8::EQPT_1_27-1-PTP"
},
{
"type": "endPoints",
"id": "f1bcac91-566f-3b04-81ab-c7328c22a858::TPE_f1bcac91-566f-3b04-
81ab-c7328c22a858::EQPT_1_27-1-PTP"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1036
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

]
},
"decomposedFres": {
"data": [
{
"type": "fres",
"id": "-3033361160375705738"
},
{
"type": "fres",
"id": "-121846333005516896"
}
]
}
}
},
"included": [
{
"id": "a776afea-4c09-347d-be30-9c171718c2d8::TPE_a776afea-4c09-347d-be30-
9c171718c2d8::EQPT_1_27-1-PTP",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "a776afea-4c09-347d-be30-9c171718c2d8::TPE_a776afea-4c09-
347d-be30-9c171718c2d8::EQPT_1_27-1-PTP"
}
]
}
}
},
{
"id": "f1bcac91-566f-3b04-81ab-c7328c22a858::TPE_f1bcac91-566f-3b04-81ab-
c7328c22a858::EQPT_1_27-1-PTP",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "f1bcac91-566f-3b04-81ab-c7328c22a858::TPE_f1bcac91-566f-
3b04-81ab-c7328c22a858::EQPT_1_27-1-PTP"
}
]
}
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1037
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

5. Add or update the "userLabel" attribute in the retrieve frePlanned and send a PUT request to NSI to
update it.

Note: The Sample request to add the userLabel attribute shows the newly updated userLabel attribute.
Other attributes should kept unchanged.

Sample request to update the userLabel attribute

PUT {{MCP_SERVER}}/nsi/api/v4/fres/{freid}/frePlanned

"data": {
"id": "-3155207493381222634",
"type": "frePlanned",
"attributes": {
"userLabel": "Updated_userLabel",
....
"additionalAttributes": {...}
},
"relationships": {...}
},
"included": [...]
}

Add or update the userLabel attribute for a discovered

service
To add or update the userLabel attribute for a discovered service, use the Services Inventory (FREs) API.

Action

1. Using the MCP UI, select Network > Services > Transport services.
2. Filter the OTSi service and select that service.
3. Click Details.
4. The URL at the top of the page includes the FRE ID. Use that FRE ID for the GET API. As an example,
you would be using -3155207493381222634 as the FRE ID, for a URL such as: https://<mcp-server>/
ui/#/photonics/-3155207493381222634

Sample response for FRE by id

{
"data": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1038
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"id": "-3155207493381222634",
"type": "fres",
"attributes": {
"deploymentState": "discovered",
"derivedAttributes": {
"intentLifeCyclePhase": "adopting discovered",
"intentDeploymentState": "waiting to adopt"
},
"displayData": {
"intentLifeCyclePhaseString": "Discovered",
"frequency": "193.750000",
"wavelength": "1547.32",
"channel": "CH-44"
},
"resourceState": "plannedAndDiscovered",
"policies": {
"defaultAttributeSourcePolicy": "discoveredOverPlanned",
"overrides": [
{
"attributeName": "userLabel",
"policies": [
"plannedOverDiscovered"
]
},
{
"attributeName": "attributes.userLabel",
"policies": [
"plannedOverDiscovered"
]
}
]
},
"serviceClass": "Photonic",
"userLabel": "philip_userLabel",
"mgmtName": "",
"nativeName": "",
"layerRate": "OTSi",
"layerRateQualifier": "100G",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"active": true,
"additionalAttributes": {
"isActual": "true"
},
"reliability": "manual"
},
"relationships": {
"frePlanned": {
"data": {
"type": "frePlanned",
"id": "-3155207493381222634"
}
},
"freExpectations": {
"data": [
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1039
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"type": "freExpectations",
"id": "-3155207493381222634::1234"
}
]
},
"freDiscovered": {
"data": {
"type": "freDiscovered",
"id": "-3155207493381222634"
}
},
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "-3155207493381222634:1"
},
{
"type": "endPoints",
"id": "-3155207493381222634:2"
}
]
},
"decomposedFres": {
"data": [
{
"type": "fres",
"id": "-121846333005516896"
},
{
"type": "fres",
"id": "-3033361160375705738"
}
]
}
}
},
"included": [
{
"id": "-3155207493381222634:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "a776afea-4c09-347d-be30-
9c171718c2d8::TPE_a776afea-4c09-347d-be30-9c171718c2d8::EQPT_1_27-1-PTP"
}
]
}
}
},
{
"id": "-3155207493381222634:2",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1040
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "f1bcac91-566f-3b04-81ab-
c7328c22a858::TPE_f1bcac91-566f-3b04-81ab-c7328c22a858::EQPT_1_27-1-PTP"
}
]
}
}
}
]
}

5. Create an expectation for this FRE using the POST API by completing the following:
a. Update the "userLabel" attribute to the desired text.
b. In the request for FreExpectation, there is an "id": under "data": - This "id" is composed of two parts:
the "freId" and the ":: 1234". An example of an "id" is "-6343998190547029283::1234". You must
copy the "freId" value from step 4 and use it in this step 5.
c. In step 4, there is an "id" under "relationships": > "endPoints": > "data":. Copy the values of the "id"
and use them in this step 5.
d. Copy the attribute values from the response displayed (in step 4) for your deployment and use
those values to create an expectation for this FRE. You are copying the values for the following
attributes:
▪ "layerRate"
▪ "networkRole"
▪ "directionality"
▪ "active"

Sample request for FreExpectation Payload

POST {{MCP_SERVER}}/nsi/api/v3/fres/{freid}/expectations

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1041
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

{
"data": {
"id": "-6343998190547029283::1234",
"type": "freExpectations",
"attributes": {
"userLabel": "discovered_userLabel_updated",
"layerRate": "OTSi",
"networkRole": "FREAP",
"directionality": "bidirectional",
"active": true
},
"relationships": {
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "-6343998190547029283:1"
},
{
"type": "endPoints",
"id": "-6343998190547029283:2"
}
]
},
"serviceIntent": {
"data": {
"type": "serviceIntents",
"id": "-6343998190547029283"
}
}
}
},
"included": []
}

Sample response for FreExpectation Payload

{
"data": {
"id": "-3155207493381222634",
"type": "fres",
"attributes": {
"deploymentState": "discovered",
"derivedAttributes": {
"intentLifeCyclePhase": "adopting discovered",
"intentDeploymentState": "waiting to adopt"
},
"displayData": {
"intentLifeCyclePhaseString": "Discovered",
"frequency": "193.750000",
"wavelength": "1547.32",
"channel": "CH-44"
},
"resourceState": "plannedAndDiscovered",
"policies": {
"defaultAttributeSourcePolicy": "discoveredOverPlanned",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1042
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"overrides": [
{
"attributeName": "userLabel",
"policies": [
"plannedOverDiscovered"
]
},
{
"attributeName": "attributes.userLabel",
"policies": [
"plannedOverDiscovered"
]
}
]
},
"userLabel": "philip_userLabel",
"mgmtName": "",
"nativeName": "",
"layerRate": "OTSi",
"layerRateQualifier": "100G",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"active": true,
"additionalAttributes": {
"isActual": "true"
},
"reliability": "manual"
},
"relationships": {
"frePlanned": {
"data": {
"type": "frePlanned",
"id": "-3155207493381222634"
}
},
"freExpectations": {
"data": [
{
"type": "freExpectations",
"id": "-3155207493381222634::1234"
}
]
},
"freDiscovered": {
"data": {
"type": "freDiscovered",
"id": "-3155207493381222634"
}
},
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "-3155207493381222634:1"
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1043
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"type": "endPoints",
"id": "-3155207493381222634:2"
}
]
},
"decomposedFres": {
"data": [
{
"type": "fres",
"id": "-121846333005516896"
},
{
"type": "fres",
"id": "-3033361160375705738"
}
]
}
}
},
"included": [
{
"id": "-3155207493381222634:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "a776afea-4c09-347d-be30-
9c171718c2d8::TPE_a776afea-4c09-347d-be30-9c171718c2d8::EQPT_1_27-1-PTP"
}
]
}
}
},
{
"id": "-3155207493381222634:2",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "f1bcac91-566f-3b04-81ab-
c7328c22a858::TPE_f1bcac91-566f-3b04-81ab-c7328c22a858::EQPT_1_27-1-PTP"
}
]
}
}
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1044
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"id": "-3155207493381222634::1234",
"type": "freExpectations",
"attributes": {
"userLabel": "philip_userLaber_changed",
"layerRate": "OTSi",
"networkRole": "FREAP",
"directionality": "bidirectional",
"active": true
},
"relationships": {
"serviceIntent": {
"data": {
"type": "serviceIntents",
"id": "-3155207493381222634"
}
}
}
}
]
}

6. Create the frePlanned FRE using the PUT API:

a. Update the "userLabel" with the same value as the one set in step 5.
b. Update the "id" to match the "freId" value used in step 4.

Sample request for PUT operation

PUT {{MCP_SERVER}}/nsi/api/v4/fres/{freid}/frePlanned

{
"data": {
"id": "-6343998190547029283",
"type": "frePlanned",
"attributes": {
"userLabel": "discovered_userLabel_updated"
}
},
"included": [
{}
]
}

Sample response

A response code of 201 indicates the successful update of the userLabel attribute. The response should
also return the updated FRE.

{
"data": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1045
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"id": "-3155207493381222634",
"type": "fres",
"attributes": {
"deploymentState": "discovered",
"derivedAttributes": {
"intentLifeCyclePhase": "adopting discovered",
"intentDeploymentState": "waiting to adopt"
},
"displayData": {
"intentLifeCyclePhaseString": "Discovered",
"frequency": "193.750000",
"wavelength": "1547.32",
"channel": "CH-44"
},
"resourceState": "plannedAndDiscovered",
"policies": {
"defaultAttributeSourcePolicy": "discoveredOverPlanned",
"overrides": [
{
"attributeName": "userLabel",
"policies": [
"plannedOverDiscovered"
]
},
{
"attributeName": "attributes.userLabel",
"policies": [
"plannedOverDiscovered"
]
}
]
},
"userLabel": "philip_userLabel_changed",
"mgmtName": "",
"nativeName": "",
"layerRate": "OTSi",
"layerRateQualifier": "100G",
"networkRole": "FREAP",
"directionality": "bidirectional",
"topologySources": [
"stitched"
],
"active": true,
"additionalAttributes": {
"isActual": "true"
},
"reliability": "manual"
},
"relationships": {
"frePlanned": {
"data": {
"type": "frePlanned",
"id": "-3155207493381222634"
}
},
"freExpectations": {
"data": [
{
"type": "freExpectations",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1046
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"id": "-3155207493381222634::1234"
}
]
},
"freDiscovered": {
"data": {
"type": "freDiscovered",
"id": "-3155207493381222634"
}
},
"endPoints": {
"data": [
{
"type": "endPoints",
"id": "-3155207493381222634:1"
},
{
"type": "endPoints",
"id": "-3155207493381222634:2"
}
]
},
"decomposedFres": {
"data": [
{
"type": "fres",
"id": "-121846333005516896"
},
{
"type": "fres",
"id": "-3033361160375705738"
}
]
}
}
},
"included": [
{
"id": "-3155207493381222634:1",
"type": "endPoints",
"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "a776afea-4c09-347d-be30-
9c171718c2d8::TPE_a776afea-4c09-347d-be30-9c171718c2d8::EQPT_1_27-1-PTP"
}
]
}
}
},
{
"id": "-3155207493381222634:2",
"type": "endPoints",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1047
Blue Planet MCP API Reference Guide, Release 18.06 Transport service management

"attributes": {
"role": "symmetric",
"directionality": "bidirectional"
},
"relationships": {
"tpes": {
"data": [
{
"type": "tpes",
"id": "f1bcac91-566f-3b04-81ab-
c7328c22a858::TPE_f1bcac91-566f-3b04-81ab-c7328c22a858::EQPT_1_27-1-PTP"
}
]
}
}
},
{
"id": "-3155207493381222634",
"type": "frePlanned",
"attributes": {
"userLabel": "philip_userLabel_changed",
"active": true
},
"relationships": {}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1048
Blue Planet MCP API Reference Guide, Release 18.06 Service port trails

Service port trails

You can perform service port trail tasks using Inventory Overlay REST API. The following topic is covered:

• Retrieve a service port trail

Retrieve a service port trail

To retrieve a report of the port trail of a given service, use the Inventory Overlay API.

Sample request

GET {{MCP_SERVER}}/api/v1/serviceTrails/{freid}

Services are identified using an FRE ID (the identifier of the FRE to be retrieved). Obtain the FRE ID of the
service you are interested in from the Service inventory (FREs) API.

Sample response

{
"data": {
"id": "1",
"type": "serviceTrails",
"attributes": {
"trails": [
{
"rxDirection": [
{
"id": "NC1",
"type": "networkConstruct"
},
{
"id": "EQ1",
"type": "equipment"
},
{
"id": "PTP1",
"type": "tpes"
},
{
"id": "FRE1",
"type": "fres"
},
{
"id": "NC2",
"type": "networkConstruct"
},
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1049
Blue Planet MCP API Reference Guide, Release 18.06 Service port trails

"id": "PTP2",
"type": "tpes"
},
{
"id": "EQ2",
"type": "equipment"
}
],
"txDirection": [
{
"id": "NC2",
"type": "networkConstruct"
},
{
"id": "EQ2",
"type": "equipment"
},
{
"id": "PTP2",
"type": "tpes"
},
{
"id": "FRE1",
"type": "fres"
},
{
"id": "NC1",
"type": "networkConstruct"
},
{
"id": "PTP1",
"type": "tpes"
},
{
"id": "EQ1",
"type": "equipment"
}
]
}
]
}
}

The service trails API reports the port trail of a given service. The information provided includes the
network constructs, equipment supporting FRE and TPEs along the route of the service. The trail provided
is a complete and ordered list of ports, not just at the particular layer (OTU4, for example) of the provided
service.

Note: There is one trail for each direction of the service.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1050
Blue Planet MCP API Reference Guide, Release 18.06 Correlation engine

Correlation engine
This section describes some of the alarm to service correlation tasks that you can perform using MCP
REST APIs.

This section includes the following topic:

• Query Layer 0 alarm to service correlation

• Query Layer 2 alarm to service correlation

Query Layer 0 alarm to service correlation

This section includes the following topics:

• Query services affected by an alarm identifier

• Query the counts of the services affected by alarm identifiers
• Query the correlated alarms for a service

Query services affected by an alarm identifier

To query affected services by alarm identifier, use the Correlator Engine API.

Sample request

GET {{MCP_SERVER}}/events-to-service-correlator/api/v1/affectedServices?alarmId={{alarmId}}

Specify the following attribute: alarmId.

Sample response

For 6500:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1051
Blue Planet MCP API Reference Guide, Release 18.06 Correlation engine

{
"data": [{
"attributes": {
"inventoryType": "fre",
"id": "-5686227573084971313",
"link": "/ui/#/photonics/-5686227573084971313",
"nativeName": "",
"serviceName": "",
"serviceType": "PHY"
},
"id": "-5686227573084971313",
"type": "affectedService"
},
{
"attributes": {
"inventoryType": "fre",
"id": "-3605809751029117228",
"link": "/ui/#/photonics/-3605809751029117228",
"nativeName": "",
"serviceName": "",
"serviceType": "OMS"
},
"id": "-3605809751029117228",
"type": "affectedService"
},
{
"attributes": {
"inventoryType": "fre",
"id": "4837043780625225707",
"link": "/ui/#/photonics/4837043780625225707",
"nativeName": "",
"serviceName": "",
"serviceType": "OTS"
},
"id": "4837043780625225707",
"type": "affectedService"
}
],
"meta": {
"count": "3"
}
}

For Waveserver:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1052
Blue Planet MCP API Reference Guide, Release 18.06 Correlation engine

{
"data": [{
"attributes": {
"inventoryType": "fre",
"id": "-4264534818257075898",
"link": "/ui/#/photonics/-4264534818257075898",
"nativeName": "",
"serviceName": "",
"serviceType": "DSR_ETHERNET"
},
"id": "-4264534818257075898",
"type": "affectedService"
},
{
"attributes": {
"inventoryType": "fre",
"id": "8360887939273810900",
"link": "/ui/#/photonics/8360887939273810900",
"nativeName": "",
"serviceName": "",
"serviceType": "DSR_ETHERNET"
},
"id": "8360887939273810900",
"type": "affectedService"
}
],
"meta": {
"count": "2"
}
}

Query the counts of the services affected by alarm identifiers

To query the counts of the services affected by alarm identifiers, use the Correlator Engine API.

Sample request

GET {{MCP_SERVER}}/events-to-service-
correlator/api/v1/affectedServicesCounts?alarmIds={{alarmId}}

Specify the following attribute: alarmIds.

Note: Provide multiple values (alarmIds) in new lines (at least one required).

Sample response

For 6500 and Waveserver:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1053
Blue Planet MCP API Reference Guide, Release 18.06 Correlation engine

{
"data": {
"attributes": {
"counts": {
"-1208277793752683809": "2",
"4837043780625225707": "0"
}
},
"id": "1",
"type": "affectedServicesCounts"
}
}

Query the correlated alarms for a service

To query the correlated alarms for a service, use the Correlator Engine API.

Sample request

GET {{MCP_SERVER}}/events-to-service-
correlator/api/v1/correlatedAlarmsForService?serviceId={{serviceId}}

Specify the following attribute: serviceId.

Sample response

For 6500 service:

{
"data": [{
"attributes": {
"acknowledge-state": "NOT_ACKNOWLEDGED",
"additional-text": "Adjacency Mismatch",
"affected-inventory-ids": [
"55b304c5-f4fd-3a49-8a2a-7a0840552e4f::TPE_55b304c5-f4fd-3a49-
8a2a-7a0840552e4f::EQPT_1_6-6-PTP"
],
"alarm-id": "6386728913028953514",
"condition-severity": "MINOR",
"device-id": "55b304c5-f4fd-3a49-8a2a-7a0840552e4f",
"device-name": "NE5",
"first-raise-time": "2017-07-09T16:35:22.000Z",
"id": "6386728913028953514",
"ip-address": "10.182.10.105",
"last-raise-time": "2017-07-11T17:45:32.000Z",
"mac-address": "000102030500",
"native-condition-type": "ADJMM_OTS",
"node-id": "27c487f2-c188-4023-bb0e-c61381276268",
"node-type": "6500",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1054
Blue Planet MCP API Reference Guide, Release 18.06 Correlation engine

"number-of-occurrences": 3,
"resource": "ADJ-1-6-6",
"service-affecting": "NON_SERVICE_AFFECTING",
"state": "ACTIVE"
},
"id": "6386728913028953514",
"type": "FilteredAlarm"
},
{
"attributes": {
"acknowledge-state": "NOT_ACKNOWLEDGED",
"additional-text": "Adjacency Mismatch",
"affected-inventory-ids": [
"c465bba4-c689-3bd0-85c9-281b3188b050::TPE_c465bba4-c689-3bd0-
85c9-281b3188b050::EQPT_1_6-6-PTP"
],
"alarm-id": "-3627459417739413197",
"condition-severity": "MINOR",
"device-id": "c465bba4-c689-3bd0-85c9-281b3188b050",
"device-name": "NE1",
"first-raise-time": "2017-07-09T16:35:21.000Z",
"id": "-3627459417739413197",
"ip-address": "10.182.10.101",
"last-raise-time": "2017-07-11T17:45:37.000Z",
"mac-address": "000102030100",
"native-condition-type": "ADJMM_OTS",
"node-id": "698df8b6-17d7-4516-8628-11d149a0cdd0",
"node-type": "6500",
"number-of-occurrences": 3,
"resource": "ADJ-1-6-6",
"service-affecting": "NON_SERVICE_AFFECTING",
"state": "ACTIVE"
},
"id": "-3627459417739413197",
"type": "FilteredAlarm"
},
{
"attributes": {
"acknowledge-state": "NOT_ACKNOWLEDGED",
"additional-text": "Circuit Pack Missing",
"affected-inventory-ids": [
"c465bba4-c689-3bd0-85c9-281b3188b050::EQPT_1_11"
],
"alarm-id": "1409086176913114507",
"condition-severity": "CRITICAL",
"device-id": "c465bba4-c689-3bd0-85c9-281b3188b050",
"device-name": "NE1",
"first-raise-time": "2017-07-09T14:58:16.000Z",
"id": "1409086176913114507",
"ip-address": "10.182.10.101",
"last-raise-time": "2017-07-10T13:56:31.000Z",
"mac-address": "000102030100",
"native-condition-type": "EQPT_MISSING",
"node-id": "698df8b6-17d7-4516-8628-11d149a0cdd0",
"node-type": "6500",
"number-of-occurrences": 2,
"resource": "WSSOPM-1-11",
"service-affecting": "SERVICE_AFFECTING",
"state": "ACTIVE"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1055
Blue Planet MCP API Reference Guide, Release 18.06 Correlation engine

},
"id": "1409086176913114507",
"type": "FilteredAlarm"
},
{
"attributes": {
"acknowledge-state": "NOT_ACKNOWLEDGED",
"additional-text": "Adjacency Mismatch",
"affected-inventory-ids": [
"c465bba4-c689-3bd0-85c9-281b3188b050::TPE_c465bba4-c689-3bd0-
85c9-281b3188b050::EQPT_1_6-5-PTP"
],
"alarm-id": "7039463220315407014",
"condition-severity": "MINOR",
"device-id": "c465bba4-c689-3bd0-85c9-281b3188b050",
"device-name": "NE1",
"first-raise-time": "2017-07-09T16:35:21.000Z",
"id": "7039463220315407014",
"ip-address": "10.182.10.101",
"last-raise-time": "2017-07-11T17:45:37.000Z",
"mac-address": "000102030100",
"native-condition-type": "ADJMM_OTS",
"node-id": "698df8b6-17d7-4516-8628-11d149a0cdd0",
"node-type": "6500",
"number-of-occurrences": 3,
"resource": "ADJ-1-6-5",
"service-affecting": "NON_SERVICE_AFFECTING",
"state": "ACTIVE"
},
"id": "7039463220315407014",
"type": "FilteredAlarm"
},
{
"attributes": {
"acknowledge-state": "NOT_ACKNOWLEDGED",
"additional-text": "Adjacency Mismatch",
"affected-inventory-ids": [
"55b304c5-f4fd-3a49-8a2a-7a0840552e4f::TPE_55b304c5-f4fd-3a49-
8a2a-7a0840552e4f::EQPT_1_6-5-PTP"
],
"alarm-id": "-6008538765992505493",
"condition-severity": "MINOR",
"device-id": "55b304c5-f4fd-3a49-8a2a-7a0840552e4f",
"device-name": "NE5",
"first-raise-time": "2017-07-09T16:35:22.000Z",
"id": "-6008538765992505493",
"ip-address": "10.182.10.105",
"last-raise-time": "2017-07-11T17:45:32.000Z",
"mac-address": "000102030500",
"native-condition-type": "ADJMM_OTS",
"node-id": "27c487f2-c188-4023-bb0e-c61381276268",
"node-type": "6500",
"number-of-occurrences": 3,
"resource": "ADJ-1-6-5",
"service-affecting": "NON_SERVICE_AFFECTING",
"state": "ACTIVE"
},
"id": "-6008538765992505493",
"type": "FilteredAlarm"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1056
Blue Planet MCP API Reference Guide, Release 18.06 Correlation engine

}
],
"meta": {
"count": "5"
}
}

Query Layer 2 alarm to service correlation

This section includes the following topics:

• Query services affected by an alarm identifier

• Query the counts of the services affected by alarm identifiers
• Query the correlated alarms for a service

Query services affected by an alarm identifier

To query affected services by alarm identifier, use the Correlator Engine API.

Sample request

GET {{MCP_SERVER}}/events-to-service-correlator/api/v1/affectedServices?alarmId={{alarmId}}

Specify the following attribute: alarmId.

Sample response

{
"data": [
{
"attributes": {
"inventoryType": "fre",
"id": "d96bca5f-9827-3023-be75-3b6c03cf6eb1::FRE_EVC_scProtPw",
"link": "/ui/#/packet-services/d96bca5f-9827-3023-be75-
3b6c03cf6eb1::FRE_EVC_scProtPw",
"nativeName": "",
"serviceName": "",
"serviceType": "ETHERNET"
},
"id": "d96bca5f-9827-3023-be75-3b6c03cf6eb1::FRE_EVC_scProtPw",
"type": "affectedService"
},
{
"attributes": {
"inventoryType": "fre",
"id": "1268213195689691597",
"link": "/ui/#/packet-services/1268213195689691597",
"nativeName": "",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1057
Blue Planet MCP API Reference Guide, Release 18.06 Correlation engine

"serviceName": "",
"serviceType": "ETHERNET"
},
"id": "1268213195689691597",
"type": "affectedService"
},
{
"attributes": {
"inventoryType": "fre",
"id": "-5518214677590821756",
"link": "/ui/#/packet-services/-5518214677590821756",
"nativeName": "",
"serviceName": "",
"serviceType": "ETHERNET"
},
"id": "-5518214677590821756",
"type": "affectedService"
},
{
"attributes": {
"inventoryType": "fre",
"id": "889845168507751129",
"link": "/ui/#/packet-services/889845168507751129",
"nativeName": "",
"serviceName": "",
"serviceType": "ETHERNET"
},
"id": "889845168507751129",
"type": "affectedService"
},
{
"attributes": {
"inventoryType": "fre",
"id": "d96bca5f-9827-3023-be75-3b6c03cf6eb1::FRE_EVC_JeffTestEvpl_3",
"link": "/ui/#/packet-services/d96bca5f-9827-3023-be75-
3b6c03cf6eb1::FRE_EVC_JeffTestEvpl_3",
"nativeName": "",
"serviceName": "",
"serviceType": "ETHERNET"
},
"id": "d96bca5f-9827-3023-be75-3b6c03cf6eb1::FRE_EVC_JeffTestEvpl_3",
"type": "affectedService"
},
{
"attributes": {
"inventoryType": "fre",
"id": "d96bca5f-9827-3023-be75-3b6c03cf6eb1::FRE_EVC_EVPL_PPW_min",
"link": "/ui/#/packet-services/d96bca5f-9827-3023-be75-
3b6c03cf6eb1::FRE_EVC_EVPL_PPW_min",
"nativeName": "",
"serviceName": "",
"serviceType": "ETHERNET"
},
"id": "d96bca5f-9827-3023-be75-3b6c03cf6eb1::FRE_EVC_EVPL_PPW_min",
"type": "affectedService"
},
{
"attributes": {
"inventoryType": "fre",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1058
Blue Planet MCP API Reference Guide, Release 18.06 Correlation engine

"id": "d96bca5f-9827-3023-be75-3b6c03cf6eb1::FRE_EVC_apMcpMpls",
"link": "/ui/#/packet-services/d96bca5f-9827-3023-be75-
3b6c03cf6eb1::FRE_EVC_apMcpMpls",
"nativeName": "",
"serviceName": "",
"serviceType": "ETHERNET"
},
"id": "d96bca5f-9827-3023-be75-3b6c03cf6eb1::FRE_EVC_apMcpMpls",
"type": "affectedService"
}
],
"meta": {
"count": "7"
}
}

Query the counts of the services affected by alarm identifiers

To query the counts of the services affected by alarm identifiers, use the Correlator Engine API.

Sample request

GET {{MCP_SERVER}}/events-to-service-
correlator/api/v1/affectedServicesCounts?alarmIds={{alarmId}}

Specify the following attribute: alarmIds.

Note: Provide multiple values (alarmIds) in new lines (at least one required).

Sample response

{
"data": {
"attributes": {
"counts": {
"5958100796168664834": "2"
}
},
"id": "1",
"type": "affectedServicesCounts"
}
}

Query the correlated alarms for a service

To query the correlated alarms for a service, use the Correlator Engine API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1059
Blue Planet MCP API Reference Guide, Release 18.06 Correlation engine

Sample request

GET {{MCP_SERVER}}/events-to-service-
correlator/api/v1/correlatedAlarmsForService?serviceId={{serviceId}}

Specify the following attribute: serviceId.

Sample response

{
"data": [
{
"attributes": {
"acknowledge-state": "NOT_ACKNOWLEDGED",
"additional-text": "Link Down",
"affected-inventory-ids": [
"c9da2538-aaef-37ea-ba63-b2692b2bbf9c::TPE_1_7_PTP"
],
"alarm-id": "-3128628658206855348",
"condition-severity": "WARNING",
"device-id": "c9da2538-aaef-37ea-ba63-b2692b2bbf9c",
"device-name": "87_5783n4",
"first-raise-time": "2017-02-02T19:31:32.000Z",
"id": "-3128628658206855348",
"ip-address": "10.182.42.134",
"last-raise-time": "2017-02-02T19:31:32.000Z",
"mac-address": "0x02b62a860000",
"native-condition-type": "Link Down",
"node-id": "05dd039d-b08f-49bf-9398-f3f8dc0a520b",
"node-type": "8700",
"number-of-occurrences": 1,
"resource": "LM1-P7",
"resource-id": "1/7",
"service-affecting": "UNKNOWN",
"state": "ACTIVE"
},
"id": "-3128628658206855348",
"type": "FilteredAlarm"
},
{
"attributes": {
"acknowledge-state": "NOT_ACKNOWLEDGED",
"additional-text": "Link Down",
"affected-inventory-ids": [
"c68a556c-655b-38b4-beee-b0e72a9f8ff7::EQPT_1_10"
],
"alarm-id": "4221738357305526282",
"condition-severity": "WARNING",
"device-id": "c68a556c-655b-38b4-beee-b0e72a9f8ff7",
"device-name": "87_5783n2",
"first-raise-time": "2017-02-02T19:27:38.000Z",
"id": "4221738357305526282",
"ip-address": "10.182.42.132",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1060
Blue Planet MCP API Reference Guide, Release 18.06 Correlation engine

"last-raise-time": "2017-02-02T19:27:38.000Z",
"mac-address": "0x02b62a840000",
"native-condition-type": "Link Down",
"node-id": "8fb511a8-4b4e-4ed9-8efd-44785dbe3332",
"node-type": "8700",
"number-of-occurrences": 1,
"resource": "LM1-P10",
"resource-id": "1/10",
"service-affecting": "UNKNOWN",
"state": "ACTIVE"
},
"id": "4221738357305526282",
"type": "FilteredAlarm"
},
{
"attributes": {
"acknowledge-state": "NOT_ACKNOWLEDGED",
"additional-text": "Link Down",
"affected-inventory-ids": [
"c9da2538-aaef-37ea-ba63-b2692b2bbf9c::EQPT_1_7"
],
"alarm-id": "-3128628658206855348",
"condition-severity": "WARNING",
"device-id": "c9da2538-aaef-37ea-ba63-b2692b2bbf9c",
"device-name": "87_5783n4",
"first-raise-time": "2017-02-02T19:31:32.000Z",
"id": "-3128628658206855348",
"ip-address": "10.182.42.134",
"last-raise-time": "2017-02-02T19:31:32.000Z",
"mac-address": "0x02b62a860000",
"native-condition-type": "Link Down",
"node-id": "05dd039d-b08f-49bf-9398-f3f8dc0a520b",
"node-type": "8700",
"number-of-occurrences": 1,
"resource": "LM1-P7",
"resource-id": "1/7",
"service-affecting": "UNKNOWN",
"state": "ACTIVE"
},
"id": "-3128628658206855348",
"type": "FilteredAlarm"
},
{
"attributes": {
"acknowledge-state": "NOT_ACKNOWLEDGED",
"additional-text": "Link Down",
"affected-inventory-ids": [
"c68a556c-655b-38b4-beee-b0e72a9f8ff7::TPE_1_10_PTP"
],
"alarm-id": "4221738357305526282",
"condition-severity": "WARNING",
"device-id": "c68a556c-655b-38b4-beee-b0e72a9f8ff7",
"device-name": "87_5783n2",
"first-raise-time": "2017-02-02T19:27:38.000Z",
"id": "4221738357305526282",
"ip-address": "10.182.42.132",
"last-raise-time": "2017-02-02T19:27:38.000Z",
"mac-address": "0x02b62a840000",
"native-condition-type": "Link Down",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1061
Blue Planet MCP API Reference Guide, Release 18.06 Correlation engine

"node-id": "8fb511a8-4b4e-4ed9-8efd-44785dbe3332",
"node-type": "8700",
"number-of-occurrences": 1,
"resource": "LM1-P10",
"resource-id": "1/10",
"service-affecting": "UNKNOWN",
"state": "ACTIVE"
},
"id": "4221738357305526282",
"type": "FilteredAlarm"
}
],
"meta": {
"count": "4"
}
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1062
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

Performance monitoring
The Performance Metrics or Performance Monitoring uService orchestrates the collection of metrics from
resources. When resources are added to the system, PM uService detects and determines their
capabilities in respect to collection intervals and available data resolution. A collection schedule for the
resource is created and started. PM uService offers a REST API to change collection schedules for
individual resources or resource types. PM uService is the central (orchestrating) part of the Performance
Monitoring Solution.

Configuration
PM configuration is driven by the Global Configuration Service (GCS). All configuration options, listed
below, can be changed at runtime using the GCS REST API. No PM-uService restart is required, for the
changes to take effect.

The following request will update all PM instances that are active to true.

curl -X PUT "https://10.186.0.150/gcs/api/v1/config" -H "accept: application/json"

-H "Authorization: Bearer f26496bb422d3c120cea" -H "Content-Type: application/json"
-d '[ { "application": "pm", "instance": "-", "partition": "hpm", "name": "active",
"value": "true" }]'

Real-time Performance Metrics (RPM) Configuration

PARTITION NAME DEFAULT DESCRIPTION

rpm requesttimeout 180 Time in seconds, after

which an RPM request
times out

Historical Performance Metrics (HPM) Configuration

PARTITION NAME DEFAULT DESCRIPTION

hpm active true Global toggle for HPM

collections

hpm suppressvalue ZERO_VALID [6500] Suppressing zero

values. Valid values are:
ZERO, ZERO_VALID and
NONE

hpm fetchdelay 45 Delay of HPM

collections in seconds.
Collections are synced
with the clock, (12:00,
12:15, …) the delay is
added

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1063
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

PARTITION NAME DEFAULT DESCRIPTION

hpm watchdoginterval 300 Interval in seconds that

determines the
watchdog execution
interval. Watchdog re-
schedules missed
collections

hpm port 2222 SFTP port that is used

by the RA to send PM
file. Required: Change
HPMRA port

hpm username admin SFTP username that is

used by the RA to send
PM file

hpm password adminpw SFTP password that is

used by the RA to send
PM file

hpm filepath /bp2/data SFTP path that is used

by the RA to store PM
file

hpm protocol sftp Protocol

Change HPMRA port

The HPMRA listens on port 2222 by default. If you desire to change this port you must change the HPM
port configuration above, as well as the port configuration of the HPMRA uService. To do so use the
following curl. (No restart required):

# Change HPMRA port to 2333

curl -X PUT "http://<siteip>/gcs/api/v1/config" -H "accept: application/json" -H
"Content-Type: application/json" -d '[{"application":"hpmra","instance":"-
","partition":"HpmraConfiguration","name":"externalPort","value":"2333","default":"
2222"}]'

REST APIs
You can monitor performance using MCP REST APIs.

When a new supported network element is enrolled, collection of historical performance metrics (PM)
data is automatically initiated. By default, data collection is performed whenever new PM data becomes
available. For example, for a 6500 network element, collection of the 15_MINUTE bins is done every 15
minutes and collection of the 24_HOUR bins is done every 24 hours.

MCP collects the real-time PM data directly from the network elements.

The following topics are covered:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1064
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

• Query real-time PMs

• 54xx specific behavior
• Query historical PMs
• Change historical PM collection configuration
• Change the PM collection interval of an enrolled network element
• Change the PM collection interval of new network elements
• Query operational measurements for a service
• Query operational measurements for a facility
• Non-PM measurement data

The threshold MCP REST APIs allow the user to create thresholds, threshold groups, and resource profiles
in order to receive customizable alarm alerts when a certain performance metric parameter crosses a
threshold.

Three steps are required to set up a threshold alert:

1. Create threshold(s).
2. Create threshold group(s) containing the created threshold(s).
3. Create resource profile(s) containing the created threshold group(s).

Note: All request success response codes are 202 Accepted. Validation is performed immediately and if
valid the request is accepted for processing. Acceptance does not guarantee processing completion. If
the request is not completed within several seconds, processing may have failed due to conflicting with a
simultaneous request.

The following topics are covered:

• Threshold endpoints
• Threshold group endpoints
• Profile endpoints

Query real-time PMs

To query real-time performance metrics (PMs), use the Performance metrics API.

To query historical PMs, see Query historical PMs.

Requirements

You must ensure the following:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1065
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

• You have an API token (see Obtain an API token).

• You have the NE Session ID.
• You have the resourceID (Network Construct identifier), (obtained by querying the TPE using the NCID
[through {{MCP_SERVER}}/nsi/api/vi/tpes?ncid=<NCID>]).
• You have the TIDs and NCIDs for the enrolled ROADMs.
• Populate the resourceObject by applying the various fields from the TPE data. For example,
resourceObject.location can be populated with the data from the TPE attributes.location field.
• Identify the following:
◦ granularity
UNTIMED, 15_MINUTE, 24_HOUR, BASELINE, ALL
◦ binIndex (optional)
This option specifies the bin number of a range of bins: default = 0, format = 0 | 0,1-3,5-7,21 | 0-32 |
1,3,5,7,9.
◦ parameters
This is a list of strings identifying the native PM name (for example, OPR-OTS, OPRMAX-OTS).

Sample request

POST {{MCP_SERVER}}/pm/api/v1/queries

Example body

{
"data" : {
"type": "queries",
"attributes" : {
"criteria" : {
"granularity" :["15_MINUTE"],
"parameters": ["OPR-OTS"]
},
"measurementPoints" : [{
"resourceId": "0e9564a3-ce67-3a5e-ab1f-06137e0648c4::TPE_0e9564a3-
ce67-3a5e-ab1f-06137e0648c4::EQPT_1_11-1-PTP",
"resourceType": "TPE",
"nodeId": "0e9564a3-ce67-3a5e-ab1f-06137e0648c4",
"resourceObject": {
"type": "pmData",
"location": {
"shelf": "1",
"slot": "11",
"port": "1"
}
}
}]
}
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1066
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

{
"data": [
{
"id": "7ef3a4a2-bf98-4d1c-8659-33b558e1fb71",
"type": "results",
"attributes": {
"metrics": [
{

. . .

"tags": {
"resourceId": "19703988-4bcf-4a20-bde8-8e1956656ae1::TPE_19703988-
4bcf-4a20-bde8-8e1956656ae1::EQPT_11_1-6-PTP",
"facilityNameNative": "OPTMON-11-1-6",
"parameterNative": "OPRAVG-OTS",
"unit": "",
"binIndex": "0",
"granularity": "UNTIMED",
"locationNative": "NEND",
"parameter": "RX_OPTICAL_POWER_AVG",
"granularityNative": "1-UNT",
"location": "NEAR_END",
"directionNative": "RCV",
"direction": "RECEIVE"
},
"meta_tags": {
"channelStatusNative": "",
"portmodeNative": "NONE",
"binState": "NOT AVAILABLE",
"binStateNative": "NA",
"channelID": "",
"altAidNative": "OPTMON-1-1-1-6"
},
"samples": [
{
"time": "2016-45-16T22:45-23:398220",
"value": -50
}
]
},

. . .

"errors": [],
"status": "completed"
}
}
]
}

54xx specific behavior

Special PM collection behaviors specific to 54xx include the following:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1067
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

• “bin index” filtration is not supported and 54xx RA will always collect real time PM from current bin
(which is bin index “0”). Any range given ( e.g. 0,1-3,5-7,21 | 0-32 |1,3,5,7,9) will be ignored and only
current bin (which is bin index “0”) will be retrieved and returned.
• "suppress" filtration is not supported as 54xx device does not support to suppress any data.
• “parameter” filtration is not supported.
• "location" based retrieval is not supported and resourceObject in retrieval request should contain valid
"nativePmFacilityName" for a given facility.

Sample request

{
"data": {
"attributes": {
"criteria": {
"binIndex": "0",
"granularity": [
"24_HOUR"
],
"parameters": [],
"suppress": "NONE"
},
"measurementPoints": [
{
"nodeId": "3fa9b9e7-a772-3354-adb0-12c92373cb41",
"resourceId": "3fa9b9e7-a772-3354-adb0-12c92373cb41::TPE_3fa9b9e7-a772-
3354-adb0-12c92373cb41::EQPT_A_7_2-PTP",
"resourceObject": {
"nativePmFacilityName": "PTP-1-A-7-2",
"type": "pmData"
},
"resourceType": "TPE"
}
]
}
}
}

Sample response

{
"data": [
{
"attributes": {
"errors": null,
"lastBatch": true,
"metrics": [
{
"attributes": {
"meta_tags": {
"altAidNative": " ",
"binState": "INVALID",
"binStateNative": "true",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1068
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

"portmodeNative": "NONE"
},
"nativePmFacilityName": "PTP-1-A-7-2",
"resourceId": "3fa9b9e7-a772-3354-adb0-12c92373cb41::TPE_3fa9b9e7-
a772-3354-adb0-12c92373cb41::EQPT_A_7_2-PTP",
"tags": {
"direction": "TRANSMIT",
"directionNative": "TRMT",
"facilityNameNative": "PTP-1-A-7-2",
"granularity": "24_HOUR",
"granularityNative": "24-HOUR",
"location": "ALL",
"locationNative": "ALL",
"parameter": "TX_OPTICAL_POWER_MIN",
"parameterNative": "optLowest",
"unit": "dBm"
},
"values": [
{
"time": "2018-05-21T10:08-00:00",
"value": -11
}
],
"version": "1.4"
},
"type": "metrics"
},
{
"attributes": {
"meta_tags": {
"altAidNative": " ",
"binState": "INVALID",
"binStateNative": "true",
"portmodeNative": "NONE"
},
"nativePmFacilityName": "PTP-1-A-7-2",
"resourceId": "3fa9b9e7-a772-3354-adb0-12c92373cb41::TPE_3fa9b9e7-
a772-3354-adb0-12c92373cb41::EQPT_A_7_2-PTP",
"tags": {
"direction": "TRANSMIT",
"directionNative": "TRMT",
"facilityNameNative": "PTP-1-A-7-2",
"granularity": "24_HOUR",
"granularityNative": "24-HOUR",
"location": "ALL",
"locationNative": "ALL",
"parameter": "TX_OPTICAL_POWER",
"parameterNative": "optActual",
"unit": "dBm"
},
"values": [
{
"time": "2018-05-21T10:08-00:00",
"value": -11
}
],
"version": "1.4"
},
"type": "metrics"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1069
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

},
{
"attributes": {
"meta_tags": {
"altAidNative": " ",
"binState": "INVALID",
"binStateNative": "true",
"portmodeNative": "NONE"
},
"nativePmFacilityName": "PTP-1-A-7-2",
"resourceId": "3fa9b9e7-a772-3354-adb0-12c92373cb41::TPE_3fa9b9e7-
a772-3354-adb0-12c92373cb41::EQPT_A_7_2-PTP",
"tags": {
"direction": "TRANSMIT",
"directionNative": "TRMT",
"facilityNameNative": "PTP-1-A-7-2",
"granularity": "24_HOUR",
"granularityNative": "24-HOUR",
"location": "ALL",
"locationNative": "ALL",
"parameter": "TX_OPTICAL_POWER_HIGH_ACTUAL",
"parameterNative": "optHighActual",
"unit": "dBm"
},
"values": [
{
"time": "2018-05-21T10:08-00:00",
"value": -11
}
],
"version": "1.4"
},
"type": "metrics"
},
{
"attributes": {
"meta_tags": {
"altAidNative": " ",
"binState": "INVALID",
"binStateNative": "true",
"portmodeNative": "NONE"
},
"nativePmFacilityName": "PTP-1-A-7-2",
"resourceId": "3fa9b9e7-a772-3354-adb0-12c92373cb41::TPE_3fa9b9e7-
a772-3354-adb0-12c92373cb41::EQPT_A_7_2-PTP",
"tags": {
"direction": "TRANSMIT",
"directionNative": "TRMT",
"facilityNameNative": "PTP-1-A-7-2",
"granularity": "24_HOUR",
"granularityNative": "24-HOUR",
"location": "ALL",
"locationNative": "ALL",
"parameter": "TX_OPTICAL_POWER_LOW_ACTUAL",
"parameterNative": "optLowActual",
"unit": "dBm"
},
"values": [
{

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1070
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

"time": "2018-05-21T10:08-00:00",
"value": -11
}
],
"version": "1.4"
},
"type": "metrics"
},
{
"attributes": {
"meta_tags": {
"altAidNative": " ",
"binState": "INVALID",
"binStateNative": "true",
"portmodeNative": "NONE"
},
"nativePmFacilityName": "PTP-1-A-7-2",
"resourceId": "3fa9b9e7-a772-3354-adb0-12c92373cb41::TPE_3fa9b9e7-
a772-3354-adb0-12c92373cb41::EQPT_A_7_2-PTP",
"tags": {
"direction": "TRANSMIT",
"directionNative": "TRMT",
"facilityNameNative": "PTP-1-A-7-2",
"granularity": "24_HOUR",
"granularityNative": "24-HOUR",
"location": "ALL",
"locationNative": "ALL",
"parameter": "TX_OPTICAL_POWER_AVG",
"parameterNative": "optAverage",
"unit": ""
},
"values": [
{
"time": "2018-05-21T10:08-00:00",
"value": -99999
}
],
"version": "1.4"
},
"type": "metrics"
},
{
"attributes": {
"meta_tags": {
"altAidNative": " ",
"binState": "INVALID",
"binStateNative": "true",
"portmodeNative": "NONE"
},
"nativePmFacilityName": "PTP-1-A-7-2",
"resourceId": "3fa9b9e7-a772-3354-adb0-12c92373cb41::TPE_3fa9b9e7-
a772-3354-adb0-12c92373cb41::EQPT_A_7_2-PTP",
"tags": {
"direction": "TRANSMIT",
"directionNative": "TRMT",
"facilityNameNative": "PTP-1-A-7-2",
"granularity": "24_HOUR",
"granularityNative": "24-HOUR",
"location": "ALL",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1071
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

"locationNative": "ALL",
"parameter": "TX_OPTICAL_POWER_NORMALIZED",
"parameterNative": "optNormalized",
"unit": ""
},
"values": [
{
"time": "2018-05-21T10:08-00:00",
"value": 3
}
],
"version": "1.4"
},
"type": "metrics"
},
{
"attributes": {
"meta_tags": {
"altAidNative": " ",
"binState": "INVALID",
"binStateNative": "true",
"portmodeNative": "NONE"
},
"nativePmFacilityName": "PTP-1-A-7-2",
"resourceId": "3fa9b9e7-a772-3354-adb0-12c92373cb41::TPE_3fa9b9e7-
a772-3354-adb0-12c92373cb41::EQPT_A_7_2-PTP",
"tags": {
"direction": "TRANSMIT",
"directionNative": "TRMT",
"facilityNameNative": "PTP-1-A-7-2",
"granularity": "24_HOUR",
"granularityNative": "24-HOUR",
"location": "ALL",
"locationNative": "ALL",
"parameter": "TX_OPTICAL_POWER_MAX",
"parameterNative": "optHighest",
"unit": "dBm"
},
"values": [
{
"time": "2018-05-21T10:08-00:00",
"value": -11
}
],
"version": "1.4"
},
"type": "metrics"
},
{
"attributes": {
"meta_tags": {
"altAidNative": " ",
"binState": "INVALID",
"binStateNative": "true",
"portmodeNative": "NONE"
},
"nativePmFacilityName": "PTP-1-A-7-2",
"resourceId": "3fa9b9e7-a772-3354-adb0-12c92373cb41::TPE_3fa9b9e7-
a772-3354-adb0-12c92373cb41::EQPT_A_7_2-PTP",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1072
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

"tags": {
"direction": "NOT APPLICABLE",
"directionNative": "NA",
"facilityNameNative": "PTP-1-A-7-2",
"granularity": "24_HOUR",
"granularityNative": "24-HOUR",
"location": "ALL",
"locationNative": "ALL",
"parameter": "DIFFERENTIAL GROUP DELAY - AVERAGE",
"parameterNative": "dgdAverage",
"unit": ""
},
"values": [
{
"time": "2018-05-21T10:08-00:00",
"value": -99999
}
],
"version": "1.4"
},
"type": "metrics"
},
{
"attributes": {
"meta_tags": {
"altAidNative": " ",
"binState": "INVALID",
"binStateNative": "true",
"portmodeNative": "NONE"
},
"nativePmFacilityName": "PTP-1-A-7-2",
"resourceId": "3fa9b9e7-a772-3354-adb0-12c92373cb41::TPE_3fa9b9e7-
a772-3354-adb0-12c92373cb41::EQPT_A_7_2-PTP",
"tags": {
"direction": "NOT APPLICABLE",
"directionNative": "NA",
"facilityNameNative": "PTP-1-A-7-2",
"granularity": "24_HOUR",
"granularityNative": "24-HOUR",
"location": "ALL",
"locationNative": "ALL",
"parameter": "DIFFERENTIAL GROUP DELAY - HIGHEST",
"parameterNative": "dgdHighest",
"unit": "ps"
},
"values": [
{
"time": "2018-05-21T10:08-00:00",
"value": 0
}
],
"version": "1.4"
},
"type": "metrics"
},
{
"attributes": {
"meta_tags": {
"altAidNative": " ",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1073
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

"binState": "INVALID",
"binStateNative": "true",
"portmodeNative": "NONE"
},
"nativePmFacilityName": "PTP-1-A-7-2",
"resourceId": "3fa9b9e7-a772-3354-adb0-12c92373cb41::TPE_3fa9b9e7-
a772-3354-adb0-12c92373cb41::EQPT_A_7_2-PTP",
"tags": {
"direction": "NOT APPLICABLE",
"directionNative": "NA",
"facilityNameNative": "PTP-1-A-7-2",
"granularity": "24_HOUR",
"granularityNative": "24-HOUR",
"location": "ALL",
"locationNative": "ALL",
"parameter": "DIFFERENTIAL GROUP DELAY - NORMALIZED",
"parameterNative": "dgdNormalized",
"unit": ""
},
"values": [
{
"time": "2018-05-21T10:08-00:00",
"value": -99999
}
],
"version": "1.4"
},
"type": "metrics"
},
{
"attributes": {
"meta_tags": {
"altAidNative": " ",
"binState": "INVALID",
"binStateNative": "true",
"portmodeNative": "NONE"
},
"nativePmFacilityName": "PTP-1-A-7-2",
"resourceId": "3fa9b9e7-a772-3354-adb0-12c92373cb41::TPE_3fa9b9e7-
a772-3354-adb0-12c92373cb41::EQPT_A_7_2-PTP",
"tags": {
"direction": "NOT APPLICABLE",
"directionNative": "NA",
"facilityNameNative": "PTP-1-A-7-2",
"granularity": "24_HOUR",
"granularityNative": "24-HOUR",
"location": "ALL",
"locationNative": "ALL",
"parameter": "DIFFERENTIAL GROUP DELAY - HIGHACTUAL",
"parameterNative": "dgdHighActual",
"unit": "ps"
},
"values": [
{
"time": "2018-05-21T10:08-00:00",
"value": 0
}
],
"version": "1.4"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1074
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

},
"type": "metrics"
},
{
"attributes": {
"meta_tags": {
"altAidNative": " ",
"binState": "INVALID",
"binStateNative": "true",
"portmodeNative": "NONE"
},
"nativePmFacilityName": "PTP-1-A-7-2",
"resourceId": "3fa9b9e7-a772-3354-adb0-12c92373cb41::TPE_3fa9b9e7-
a772-3354-adb0-12c92373cb41::EQPT_A_7_2-PTP",
"tags": {
"direction": "NOT APPLICABLE",
"directionNative": "NA",
"facilityNameNative": "PTP-1-A-7-2",
"granularity": "24_HOUR",
"granularityNative": "24-HOUR",
"location": "ALL",
"locationNative": "ALL",
"parameter": "DIFFERENTIAL GROUP DELAY - LOWEST",
"parameterNative": "dgdLowest",
"unit": "ps"
},
"values": [
{
"time": "2018-05-21T10:08-00:00",
"value": 0
}
],
"version": "1.4"
},
"type": "metrics"
},
{
"attributes": {
"meta_tags": {
"altAidNative": " ",
"binState": "INVALID",
"binStateNative": "true",
"portmodeNative": "NONE"
},
"nativePmFacilityName": "PTP-1-A-7-2",
"resourceId": "3fa9b9e7-a772-3354-adb0-12c92373cb41::TPE_3fa9b9e7-
a772-3354-adb0-12c92373cb41::EQPT_A_7_2-PTP",
"tags": {
"direction": "NOT APPLICABLE",
"directionNative": "NA",
"facilityNameNative": "PTP-1-A-7-2",
"granularity": "24_HOUR",
"granularityNative": "24-HOUR",
"location": "ALL",
"locationNative": "ALL",
"parameter": "DIFFERENTIAL GROUP DELAY - LOWACTUAL",
"parameterNative": "dgdLowActual",
"unit": "ps"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1075
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

"values": [
{
"time": "2018-05-21T10:08-00:00",
"value": 0
}
],
"version": "1.4"
},
"type": "metrics"
},
{
"attributes": {
"meta_tags": {
"altAidNative": " ",
"binState": "INVALID",
"binStateNative": "true",
"portmodeNative": "NONE"
},
"nativePmFacilityName": "PTP-1-A-7-2",
"resourceId": "3fa9b9e7-a772-3354-adb0-12c92373cb41::TPE_3fa9b9e7-
a772-3354-adb0-12c92373cb41::EQPT_A_7_2-PTP",
"tags": {
"direction": "NOT APPLICABLE",
"directionNative": "NA",
"facilityNameNative": "PTP-1-A-7-2",
"granularity": "24_HOUR",
"granularityNative": "24-HOUR",
"location": "ALL",
"locationNative": "ALL",
"parameter": "DIFFERENTIAL GROUP DELAY - ACTUAL",
"parameterNative": "dgdActual",
"unit": "ps"
},
"values": [
{
"time": "2018-05-21T10:08-00:00",
"value": 0
}
],
"version": "1.4"
},
"type": "metrics"
},
{
"attributes": {
"meta_tags": {
"altAidNative": " ",
"binState": "INVALID",
"binStateNative": "true",
"portmodeNative": "NONE"
},
"nativePmFacilityName": "PTP-1-A-7-2",
"resourceId": "3fa9b9e7-a772-3354-adb0-12c92373cb41::TPE_3fa9b9e7-
a772-3354-adb0-12c92373cb41::EQPT_A_7_2-PTP",
"tags": {
"direction": "RECEIVE",
"directionNative": "RCV",
"facilityNameNative": "PTP-1-A-7-2",
"granularity": "24_HOUR",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1076
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

"granularityNative": "24-HOUR",
"location": "ALL",
"locationNative": "ALL",
"parameter": "RX_OPTICAL_POWER_AVG",
"parameterNative": "oprAverage",
"unit": ""
},
"values": [
{
"time": "2018-05-21T10:08-00:00",
"value": -99999
}
],
"version": "1.4"
},
"type": "metrics"
},
{
"attributes": {
"meta_tags": {
"altAidNative": " ",
"binState": "INVALID",
"binStateNative": "true",
"portmodeNative": "NONE"
},
"nativePmFacilityName": "PTP-1-A-7-2",
"resourceId": "3fa9b9e7-a772-3354-adb0-12c92373cb41::TPE_3fa9b9e7-
a772-3354-adb0-12c92373cb41::EQPT_A_7_2-PTP",
"tags": {
"direction": "RECEIVE",
"directionNative": "RCV",
"facilityNameNative": "PTP-1-A-7-2",
"granularity": "24_HOUR",
"granularityNative": "24-HOUR",
"location": "ALL",
"locationNative": "ALL",
"parameter": "RX_OPTICAL_POWER_MAX",
"parameterNative": "oprHighest",
"unit": "dBm"
},
"values": [
{
"time": "2018-05-21T10:08-00:00",
"value": -10.2
}
],
"version": "1.4"
},
"type": "metrics"
},
{
"attributes": {
"meta_tags": {
"altAidNative": " ",
"binState": "INVALID",
"binStateNative": "true",
"portmodeNative": "NONE"
},
"nativePmFacilityName": "PTP-1-A-7-2",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1077
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

"resourceId": "3fa9b9e7-a772-3354-adb0-12c92373cb41::TPE_3fa9b9e7-
a772-3354-adb0-12c92373cb41::EQPT_A_7_2-PTP",
"tags": {
"direction": "RECEIVE",
"directionNative": "RCV",
"facilityNameNative": "PTP-1-A-7-2",
"granularity": "24_HOUR",
"granularityNative": "24-HOUR",
"location": "ALL",
"locationNative": "ALL",
"parameter": "RX_OPTICAL_POWER_NORMALIZED",
"parameterNative": "oprNormalized",
"unit": ""
},
"values": [
{
"time": "2018-05-21T10:08-00:00",
"value": 3
}
],
"version": "1.4"
},
"type": "metrics"
},
{
"attributes": {
"meta_tags": {
"altAidNative": " ",
"binState": "INVALID",
"binStateNative": "true",
"portmodeNative": "NONE"
},
"nativePmFacilityName": "PTP-1-A-7-2",
"resourceId": "3fa9b9e7-a772-3354-adb0-12c92373cb41::TPE_3fa9b9e7-
a772-3354-adb0-12c92373cb41::EQPT_A_7_2-PTP",
"tags": {
"direction": "RECEIVE",
"directionNative": "RCV",
"facilityNameNative": "PTP-1-A-7-2",
"granularity": "24_HOUR",
"granularityNative": "24-HOUR",
"location": "ALL",
"locationNative": "ALL",
"parameter": "RX_OPTICAL_POWER_HIGH_ACTUAL",
"parameterNative": "oprHighActual",
"unit": "dBm"
},
"values": [
{
"time": "2018-05-21T10:08-00:00",
"value": -10.2
}
],
"version": "1.4"
},
"type": "metrics"
},
{
"attributes": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1078
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

"meta_tags": {
"altAidNative": " ",
"binState": "INVALID",
"binStateNative": "true",
"portmodeNative": "NONE"
},
"nativePmFacilityName": "PTP-1-A-7-2",
"resourceId": "3fa9b9e7-a772-3354-adb0-12c92373cb41::TPE_3fa9b9e7-
a772-3354-adb0-12c92373cb41::EQPT_A_7_2-PTP",
"tags": {
"direction": "RECEIVE",
"directionNative": "RCV",
"facilityNameNative": "PTP-1-A-7-2",
"granularity": "24_HOUR",
"granularityNative": "24-HOUR",
"location": "ALL",
"locationNative": "ALL",
"parameter": "RX_OPTICAL_POWER_MIN",
"parameterNative": "oprLowest",
"unit": "dBm"
},
"values": [
{
"time": "2018-05-21T10:08-00:00",
"value": -10.2
}
],
"version": "1.4"
},
"type": "metrics"
},
{
"attributes": {
"meta_tags": {
"altAidNative": " ",
"binState": "INVALID",
"binStateNative": "true",
"portmodeNative": "NONE"
},
"nativePmFacilityName": "PTP-1-A-7-2",
"resourceId": "3fa9b9e7-a772-3354-adb0-12c92373cb41::TPE_3fa9b9e7-
a772-3354-adb0-12c92373cb41::EQPT_A_7_2-PTP",
"tags": {
"direction": "RECEIVE",
"directionNative": "RCV",
"facilityNameNative": "PTP-1-A-7-2",
"granularity": "24_HOUR",
"granularityNative": "24-HOUR",
"location": "ALL",
"locationNative": "ALL",
"parameter": "RX_OPTICAL_POWER_LOW_ACTUAL",
"parameterNative": "oprLowActual",
"unit": "dBm"
},
"values": [
{
"time": "2018-05-21T10:08-00:00",
"value": -10.2
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1079
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

],
"version": "1.4"
},
"type": "metrics"
},
{
"attributes": {
"meta_tags": {
"altAidNative": " ",
"binState": "INVALID",
"binStateNative": "true",
"portmodeNative": "NONE"
},
"nativePmFacilityName": "PTP-1-A-7-2",
"resourceId": "3fa9b9e7-a772-3354-adb0-12c92373cb41::TPE_3fa9b9e7-
a772-3354-adb0-12c92373cb41::EQPT_A_7_2-PTP",
"tags": {
"direction": "RECEIVE",
"directionNative": "RCV",
"facilityNameNative": "PTP-1-A-7-2",
"granularity": "24_HOUR",
"granularityNative": "24-HOUR",
"location": "ALL",
"locationNative": "ALL",
"parameter": "RX_OPTICAL_POWER",
"parameterNative": "oprActual",
"unit": "dBm"
},
"values": [
{
"time": "2018-05-21T10:08-00:00",
"value": -10.2
}
],
"version": "1.4"
},
"type": "metrics"
}
],
"nodeId": "3fa9b9e7-a772-3354-adb0-12c92373cb41",
"requestId": "91b786f0-e0dc-4570-4711-27d9909c2fca"
},
"type": "pmResults"
}
]
}

Query historical PMs

To query historical performance metrics (PMs), use the Performance metrics API.

To query real-time PMs, see Query real-time PMs.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1080
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

Requirements

You must ensure the following:

• You have an API token (see Obtain an API token).

• You have the TIDs and NCIDs for the enrolled ROADMs.
• Identify the following:
Note: The start time and end time must be before the current date and time.
◦ startTime = the date and time of the earliest PMs to be collected in the Coordinated Universal Time
(UTC) format ‘YYYY-MM-ddTHH:mm:ss.SSSZ’.
◦ endTime = the date and time of the latest PMs to be collected in the Coordinated Universal Time
(UTC) format ‘YYYY-MM-ddTHH:mm:ss.SSSZ’.
◦ granularity
UNTIMED, 15_MINUTE, 24_HOUR, BASELINE, ALL
◦ parameters
This is a list of strings identifying the native PM name (for example, OPR-OTS, OPRMAX-OTS).

Sample request

POST {{MCP_SERVER}}/pm/api/v1/query/metrics

Here is a sample request using a time range:

{
"data": {
"type": "queryMetrics",
"attributes": {
"range": {
"type": "absolute",
"unit": "MILLISECONDS",
"value": 0
"startTime": {{startTime}},
"endTime": {{endTime}}
},
"filter": [
"and",
["=", "parameterNative", "OPTMAX-OCH"]
]
}
}
}

Here is a sample request using relative time:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1081
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

{
"data": {
"type": "queryMetrics",
"attributes": {
"range": {
"type": "relative",
"unit": "HOURS",
"value": 3
},
"filter": [
"and",
["=", "parameterNative", "OPTMAX-OCH"]
]
}
}
}

Filters can be defined for any tag as well as the device name:

{
"data": {
"attributes": {
"range": {
"type": "absolute",
"startTime": "2016-10-26T15:50:11.152-04:00",
"endTime": "2016-10-26T15:50:11.152-04:00"
},
"filter": [
"and",
[
"key",
"PV0445A"
],
[
"=",
"facilityNameNative",
"OMS-4-2-1"
]
]
}
}
}

Note: The device name is the key of the time series, and that is why the syntax for filtering on device
name is a bit different from filtering on tags.

For more information on the API, refer to the swagger documentation in the MCP UI.

Change historical PM collection configuration

Configuration Management (CM) provides the ability to determine the data resolution of the collected
Performance Metrics as well as the frequency of collections.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1082
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

When a Network Element (NE) is enrolled, it will get assigned a default configuration based on its type
(i.e: 6500, 8700, …). If no such default configuration yet exists for the Network Element type, the
capabilities of the device are requested from the Resource Adapter (RA). The default configuration is
derived from the device’s capabilities.

Default configuration
To retrieve a list of all devices and their default configurations, use the Performance metrics configs API.

Sample request

GET {{MCP_SERVER}}/pm/api/v1/configs

The default configuration for a device can be changed. A change only applies to subsequently enrolled
Network Elements. Already enrolled NEs are not affected by the change.

To change a default configuration, use the Performance metrics configs API:

Sample request

PUT {{MCP_SERVER}}/pm/api/v1/configs/{id}

Sample response

{
"data": [
{
"attributes": {
"name": "15_MINUTES",
"pollingInterval": {
"unit": "MINUTES",
"value": 15
},
"resolution": {
"unit": "MINUTES",
"value": 15
}
},
"id": "6500 14-Slot Converged Optical Shelf Assembly",
"type": "PmConfigTemplate"
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1083
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

Validation rules

The default configuration update is rejected if any of the following conditions is violated:

• The data resolution is not supported by the device.

• The polling_interval is too large; metrics will be removed from the device before they are retrieved.

Node specific configuration

One can overwrite the default configuration and a node specific configuration. When a node specific
configuration is changed, it is applied right away.

To change a node’s configuration, use the Performance metrics nodes API:

Sample request

PUT {{MCP_SERVER}}/pm/api/v1/nodes/{nodeId}/config

Sample response

{
"data": [
{
"attributes": {
"enabled": true,
"name": "15_MINUTES",
"pollingInterval": {
"unit": "MINUTES",
"value": 15
},
"resolution": {
"unit": "MINUTES",
"value": 15
}
}
}
]
}

Validation rules

The same rules as with global configuration changes apply.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1084
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

Change the PM collection interval of an enrolled network

element
To change the collection interval of performance metrics (PMs) of an enrolled network element, use the
Performance metrics configure network elements API.

This method does not change the PM collection interval of any other network elements; only a single
network element is impacted. To change the default PM collection interval of new network elements, see
Change the PM collection interval of new network elements.

Attention You must carefully consider the upper and lower bounds of PM collection. If the polling
interval of a PM type is set too low, CPU cycles are wasted by the hardware and by the Blue Planet
system. For example, collecting the 24_HOUR bin every hour results in 23 duplicate collections.
Conversely, most network elements only store performance metrics for a limited time and setting
the collection interval too high could result in lost performance metrics. For example, collecting the
15_MINUTE bin every 24 hours results in the loss of 16 hours of metrics every day because the
network element only stores a maximum of 8 hours of 15_MINUTE PMs.

Requirements

Make sure you know the Network Construct Identifier (NCID) of the network element to be configured.

Query request
To query the PM collection intervals for a network element, use the Performance metrics configure
network elements API.

Sample request

GET {{MCP_SERVER}}/pm/api/v1/nodes/{nodeId}/config

Sample reponse

{
"data": [
{
"attributes": {
"enabled": true,
"name": "15_MINUTES",
"pollingInterval": {
"unit": "MINUTES",
"value": 15
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1085
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

"resolution": {
"unit": "MINUTES",
"value": 15
}
},
"id": "616727f1-f655-3b3a-b30a-280e3b3eca52",
"relationships": {
"node": {
"links": {
"self": "/pm/api/v1/nodes/616727f1-f655-3b3a-b30a-280e3b3eca52"
}
},
"template": {
"links": {
"self": "/pm/api/v1/configs/6500 32-Slot Packet-Optical Shelf
Assembly"
}
}
},
"type": "PmNodeConfig"
},
{
"attributes": {
"enabled": true,
"name": "24_HOURS",
"pollingInterval": {
"unit": "HOURS",
"value": 24
},
"resolution": {
"unit": "HOURS",
"value": 24
}
},
"id": "616727f1-f655-3b3a-b30a-280e3b3eca52",
"relationships": {
"node": {
"links": {
"self": "/pm/api/v1/nodes/616727f1-f655-3b3a-b30a-280e3b3eca52"
}
},
"template": {
"links": {
"self": "/pm/api/v1/configs/6500 32-Slot Packet-Optical Shelf
Assembly"
}
}
},
"type": "PmNodeConfig"
}
]
}

Update request
To update the PM collection intervals for a network element, use the Performance metrics configure

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1086
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

network elements API.

Action

1. Populate the nodeId with the NCID of the network element.

2. Populate the body with the returned value from the previous query operation.
3. Update the polling interval(s) according to your requirements.

Sample request

PUT {{MCP_SERVER}}/pm/api/v1/nodes/{nodeId}/config

{
"data": [
{
"id": "46b9f2a2-7f48-3aaf-b9c5-37842e98432f",
"type": "PmNodeConfig",
"attributes": {
"name": "15_MINUTES",
"enabled": true,
"resolution": {
"unit": "MINUTES",
"value": 15
},
"pollingInterval": {
"unit": "HOURS",
"value": 3
}
}
}
]
}

Sample response

A response code of 201 indicates successful application of collection interval value updates.

Change the PM collection interval of new network

elements
To change the collection interval of performance measurements (PMs) of all new network elements of a
specifc device type, use the Performance metrics configure device types API.

This procedure does not impact the PM collection interval of network elements enrolled before this
procedure is performed. To change the PM collection interval of network elements enrolled before this
procedure was performed, see Change the PM collection interval of an enrolled network element.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1087
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

Attention You must carefully consider the upper and lower bounds of PM collection. If the polling
interval of a PM type is set too low, CPU cycles are wasted by the hardware and by the Blue Planet
system. For example, collecting the 24_HOUR bin every hour results in 23 duplicate collections.
Conversely, most network elements only store performance metrics for a limited time and setting
the collection interval too high could result in lost performance metrics. For example, collecting the
15_MINUTE bin every 24 hours results in the loss of 16 hours of metrics every day because the
network element only stores a maximum of 8 hours of 15_MINUTE PMs.

Requirements

You must ensure the following:

• At least one network element of the device type to be changed is enrolled.

• You have obtained the identifier (id) of the device type to be changed, such as 6500 32-Slot Packet-
Optical Shelf Assembly.

Query request
To query the current PM collection intervals for a device type, use the Performance metrics configure
device types API.

Sample request

GET {{MCP_SERVER}}/pm/api/v1/configs/{id}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1088
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

{
"data": [
{
"attributes": {
"name": "15_MINUTES",
"pollingInterval": {
"unit": "MINUTES",
"value": 15
},
"resolution": {
"unit": "MINUTES",
"value": 15
}
},
"id": "6500 32-Slot Packet-Optical Shelf Assembly",
"type": "ConfigTemplate"
},
{
"attributes": {
"name": "24_HOURS",
"pollingInterval": {
"unit": "HOURS",
"value": 24
},
"resolution": {
"unit": "HOURS",
"value": 24
}
},
"id": "6500 32-Slot Packet-Optical Shelf Assembly",
"type": "ConfigTemplate"
}
]
}

Update request
To update the PM collection intervals for a device type, use the Performance metrics configure device
types API.

Action

1. Populate the id with the device type.

2. Populate the body with the returned value from the previous query operation.
3. Update the polling interval(s) according to your requirements.

Sample request

PUT {{MCP_SERVER}}/pm/api/v1/configs/{id}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1089
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

{
"data": [
{
"id": "6500 32-Slot Packet-Optical Shelf Assembly",
"type": "ConfigTemplate",
"attributes": {
"name": "15_MINUTES",
"resolution": {
"unit": "MINUTES",
"value": 15
},
"pollingInterval": {
"unit": "HOURS",
"value": 3
}
}
}
]
}

Sample response

A response code of 201 indicates successful application of collection interval value updates.

Query operational measurements for a service

To query operational measurements for a service, use the Diagnostics (diag) API.

To query operational measurements for a facility, see Query operational measurements for a facility.

Requirements

You must ensure the following:

• You have an API token (see Obtain an API token).

As part of the API call, you will need to specify some of the following:

Note: The start time and end time must be before the current date and time.

• granularity: "24-hour" or "15-minute"

• synchronous: "true" or "false"
• frelds: resource ID(s)

Note: For historical data, granularity will be determined by MCP based on the time range and the
performance factor.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1090
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

Sample request

POST {{MCP_SERVER}}/tdc/api/v1/diag/operMeas

Here is a sample request using a time range:

{
"data": {
"freIds": [
"string"
],
"granularity": "24-hour",
"synchronous": true
}
}

Query operational measurements for a facility

To query operational measurements for a facility, use the Diagnostics API.

To query operational measurements for a service, see Query operational measurements for a service.

Requirements

You must ensure the following:

• You have an API token (see Obtain an API token).

As part of the API call, you will need to specify some of the following:

Note: The start time and end time must be before the current date and time.

• startTime = the date and time of the earliest PMs you wnat to view, in the Coordinated Universal Time
(UTC) format ‘YYYY-MM-ddTHH:mm:ss.SSSZ’.
• endTime = the date and time of the latest PMs you want to view, in the Coordinated Universal Time
(UTC) format ‘YYYY-MM-ddTHH:mm:ss.SSSZ’.
• granularity: "24-hour" or "15-minute"
• range: either "relative" or "absolute"
• units: only applies to the relative time range; "minutes", "days", "weeks", or "months"
• ncName: ID of the network element hosting the facility
• reportingFacility: the ID of the facility from which PM data is drawn

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1091
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

POST {{MCP_SERVER}}/tdc/api/v2/diag/operMeas/facilities

Here is a sample request using a time range:

{
"data": {
"ncName": "string",
"reportingFacility": "string",
"granularity": "24-hour",
"parameterNatives": [
"string"
],
"range": {
"type": "relative",
"unit": "days",
"value": "string",
"startTime": "string",
"endTime": "string"
},
"synchronous": false
}
}

Here is a sample request using relative time:

{
"data": {
"ncName": "PV0394A",
"reportingFacility": "OTM4-12-6-1",
"granularity": "15-minute",
"parameterNatives": [
"ES-OTU",
"SES-OTU"
],
"range": {
"type": "relative",
"unit": "minutes",
"value": "120"
},
"synchronous": true
}
}

Here is a sample request using an absolute time range:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1092
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

{
"data": {
"ncName": "PV0394A",
"reportingFacility": "OTM4-12-7-1",
"granularity": "24-hour",
"parameterNatives": [
"ES-OTU",
"SES-OTU"
],
"range": {
"type": "absolute",
"startTime": "2017-05-02T15:50:11.152-04:00",
"endTime": "2017-05-05T15:50:11.152-04:00"
},
"synchronous": true
}
}

Threshold endpoints
A threshold consists of the following:

• name: any string to use as a human readable identifier

• thresholdType: the type of threshold, either "max", "min", or "deviation"
• value object: the value, if crossed, triggers the action. Must correspond to the thresholdType (see
example below)
• pmParameter: the PM parameter to be monitored
• tags: specific metric tags to be matched upon, all tag values must match for a positive match
◦ Currently only granularityNative is supported in exact match (MCP specific); it is the bin time, if
applicable. E.g. 15-MIN; if not specified PM granularity will be ignored
• action object: the action that is triggered upon crossing
◦ Currently only alarmAlert is supported (see example below) with severity values of
INDETERMINATE, CRITICAL, MAJOR, MINOR, WARNING, INFO, CONFIG, or DEBUG

This section provides examples for the following:

• Create one or more new thresholds

• Update any attributes of an existing threshold
• Update any attributes of one or more existing thresholds
• Delete an existing threshold
• Retrieve an existing threshold
• Retrieve all existing thresholds

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1093
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

Create one or more new thresholds

To create one or more new thresholds, use the PM Processor API.

Sample request

POST {{MCP_SERVER}}/pmprocessor/api/v1/thresholds

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1094
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

{
"data": [
{
"type": "threshold",
"attributes": {
"name": "MyMaxThreshold",
"thresholdType": "max",
"maxValue": {
"value": 100
},
"pmParameter": "DEMO-PM-PARAMETER",
"tags" : {
"granularityNative": "15-MIN",
},
"action": {
"alarmAlert": {
"severity": "CRITICAL"
}
}
}
},
{
"type": "threshold",
"attributes": {
"name": "MyMinThreshold",
"thresholdType": "min",
"minValue": {
"value": 10
},
"pmParameter": "DEMO_PM_PARAMETER",
"action": {
"alarmAlert": {
"severity": "CRITICAL"
}
}
}
},
{
"type": "threshold",
"attributes": {
"name": "MyDeviationThreshold",
"thresholdType": "deviation",
"deviationValue": {
"value": 20,
"BaseValue": 50
},
"pmParameter": "DEMO_PM_PARAMETER",
"action": {
"alarmAlert": {
"severity": "MAJOR"
}
}
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1095
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

Update any attributes of an existing threshold

To update any attributes of an existing threshold, use the PM Processor API.

Sample request

PUT {{MCP_SERVER}}/pmprocessor/api/v1/thresholds/<ID FOR MyMaxThreshold>

Sample response

{
"data": {
"id": "<ID FOR MyMaxThreshold>",
"type": "threshold",
"attributes": {
"name": "MyUpdatedMaxThreshold",
"thresholdType": "max",
"maxValue": {
"value": 110
},
"pmParameter": "DEMO_PM_PARAMETER",
"action": {
"alarmAlert": {
"severity": "CRITICAL"
}
}
}
}
}

Update any attributes of one or more existing thresholds

To update any attributes of one or more existing thresholds, use the PM Processor API.

Sample request

PUT {{MCP_SERVER}}/pmprocessor/api/v1/thresholds

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1096
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

{
"data": [
{
"id": "<ID FOR MyMaxThreshold>",
"type": "threshold",
"attributes": {
"name": "MyMaxThreshold",
"thresholdType": "max",
"maxValue": {
"value": 90
},
"pmParameter": "DEMO_PM_PARAMETER_2",
"action": {
"alarmAlert": {
"severity": "MAJOR"
}
}
}
},
{
"id": "<ID FOR MyMinThreshold>",
"type": "threshold",
"attributes": {
"name": "MyMinThreshold",
"thresholdType": "min",
"minValue": {
"value": 15
},
"pmParameter": "DEMO_PM_PARAMETER",
"action": {
"alarmAlert": {
"severity": "CRITICAL"
}
}
}
},
{
"id": "<ID FOR MyDeviationThreshold>",
"type": "threshold",
"attributes": {
"name": "MyDeviationThreshold",
"thresholdType": "deviation",
"deviationValue": {
"value": 30,
"BaseValue": 50
},
"pmParameter": "DEMO_PM_PARAMETER",
"action": {
"alarmAlert": {
"severity": "CRITICAL"
}
}
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1097
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

Delete an existing threshold

To delete an existing threshold, use the PM Processor API.

Sample request

DELETE {{MCP_SERVER}}/pmprocessor/api/v1/thresholds/<ID FOR MyMaxThreshold>

The threshold will be deleted from all threshold groups, affecting the containing resource profiles. Any
alerts associated with the deleted threshold will be discontinued.

Retrieve an existing threshold

To retrieve an existing threshold, use the PM Processor API.

Sample request

GET {{MCP_SERVER}}/pmprocessor/api/v1/thresholds/<ID FOR MyMaxThreshold>

Retrieve all existing thresholds

To retrieve all existing thresholds, use the PM Processor API.

Sample request

GET {{MCP_SERVER}}/pmprocessor/api/v1/thresholds

Threshold group endpoints

A threshold group consists of the following:

• a user defined ID

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1098
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

• thresholdID: a list of server generated threshold IDs (UUIDs)

This section provides examples for the following:

• Create one or more new threshold groups

• Update an existing threshold group
• Update one or more existing threshold groups
• Delete an existing threshold group
• Retrieve an existing threshold group
• Retrieve all existing threshold groups

Create one or more new threshold groups

To create one or more new threshold groups, use the PM Processor API.

Sample request

POST {{MCP_SERVER}}/pmprocessor/api/v1/threshold_groups

Sample response

{
"data": [
{
"type": "thresholdGroup",
"id": "DEMO_PM_PARAMETER_monitoring",
"attributes": {
"thresholdID": [
"<ID FOR MyMaxThreshold>",
"<ID FOR MyMinThreshold>",
"<ID FOR MyDeviationThreshold>"
]
}
},
{
"type": "thresholdGroup",
"id": "DEMO_PM_PARAMETER_monitoring_no_max",
"attributes": {
"thresholdID": [
"<ID FOR MyMinThreshold>",
"<ID FOR MyDeviationThreshold>"
]
}
}
]
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1099
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

Update an existing threshold group

To update an existing threshold group, use the PM Processor API.

Sample request

PUT {{MCP_SERVER}}/pmprocessor/api/v1/threshold_groups/DEMO_PM_PARAMETER_monitoring

Sample response

{
"data": {
"type": "thresholdGroup",
"id": "DEMO_PM_PARAMETER_monitoring",
"attributes": {
"thresholdID": [
"<ID FOR MyMaxThreshold>",
"<ID FOR MyMinThreshold>",
"<ID FOR MyDeviationThreshold>",
"<ID FOR SomeNewThreshold>"
]
}
}
}

Update one or more existing threshold groups

To update one or more existing threshold groups, use the PM Processor API.

Sample request

PUT {{MCP_SERVER}}/pmprocessor/api/v1/threshold_groups

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1100
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

{
"data": [
{
"type": "thresholdGroup",
"id": "DEMO_PM_PARAMETER_monitoring",
"attributes": {
"thresholdID": [
"<ID FOR MyMaxThreshold>",
"<ID FOR MyMinThreshold>",
"<ID FOR MyDeviationThreshold>"
]
}
},
{
"type": "thresholdGroup",
"id": "DEMO_PM_PARAMETER_monitoring_no_max",
"attributes": {
"thresholdID": [
"<ID FOR MyMinThreshold>",
"<ID FOR MyDeviationThreshold>",
"<ID FOR SomeNewThreshold>"
]
}
}
]
}

Delete an existing threshold group

To delete an existing threshold group, use the PM Processor API.

Sample request

DELETE {{MCP_SERVER}}/pmprocessor/api/v1/threshold_groups/<ID for existing threshold>

Deleted threshold groups are removed from any resource profiles that contained them. Any alerts for
thresholds within the group associated with the profiles from which they were removed are discontinued.

Retrieve an existing threshold group

To retrieve an existing threshold group, use the PM Processor API.

Sample request

GET {{MCP_SERVER}}/pmprocessor/api/v1/threshold_groups/<ID for existing threshold>

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1101
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

Retrieve all existing threshold groups

To retrieve all existing threshold groups, use the PM Processor API.

Sample request

GET {{MCP_SERVER}}/pmprocessor/api/v1/threshold_groups

Profile endpoints
A resource profile consists of the following:

• thresholdGroupId: a list of user defined threshold group IDs

• nodeId: a list of node IDs for specific network elements (NC ID in the context of MCP, or
providerResourceID in the context of MDSO)
• tags: specific metric tags to be regexp matched upon, all tag values must match for a positive match
◦ Currently only facilityNameNative is supported (MCP specific)

This section provides examples for the following:

• Create one or more new resource profiles

• Update an existing resource profile
• Update one or more existing resource profiles
• Delete an existing resource profile
• Retrieve an existing resource profile
• Retrieve all existing resource profiles

Create one or more new resource profiles

To create one or more new resource profiles, use the PM Processor API.

Sample request

POST {{MCP_SERVER}}/pmprocessor/api/v1/resource_profiles

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1102
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

{
"data": [
{
"type": "resourceProfile",
"id": "MyResourceProfile",
"attributes": {
"thresholdGroupID": [
"DEMO_PM_PARAMETER_monitoring"
],
"nodeID": [
"<ID 1>",
"<ID 2>",
],
"tags": [
{
"facilityNameNative" : "OSC-1-2-2"
}
]
}
},
{
"type": "resourceProfile",
"id": "MyOtherResourceProfile",
"attributes": {
"thresholdGroupID": [
"DEMO_PM_PARAMETER_monitoring",
"DEMO_PM_PARAMETER_monitoring_no_max"
],
"nodeID": [
"<ID 3>",
"<ID 4>",
],
"tags": [
{
"facilityNameNative" : "OSC-2-1-1"
},
{
"facilityNameNative" : "OSC-3-1-1"
}
]
}
}
]
}

Update an existing resource profile

To update an existing resource profile, use the PM Processor API.

Sample request

PUT {{MCP_SERVER}}/pmprocessor/api/v1/resource_profiles/MyOtherResourceProfile

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1103
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

Sample response

{
"data" : {
"type": "resourceProfile",
"id": "MyOtherResourceProfile",
"attributes": {
"thresholdGroupID": [
"DEMO_PM_PARAMETER_monitoring",
"DEMO_PM_PARAMETER_monitoring_no_max",
"SomeNewThresholdGroupID"
],
"nodeID": [
"<ID 3>",
"<ID 4>",
"<ID 5>"
],
"tags": [
{
"facilityNameNative" : "OSC-2-1-1"
},
{
"facilityNameNative" : "OSC-4-1-1"
}
]
}
}
}

Update one or more existing resource profiles

To update one or more existing resource profiles, use the PM Processor API.

Sample request

PUT {{MCP_SERVER}}/pmprocessor/api/v1/resource_profiles

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1104
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

{
"data": [
{
"type": "resourceProfile",
"id": "MyResourceProfile",
"attributes": {
"thresholdGroupID": [
"DEMO_PM_PARAMETER_monitoring"
],
"nodeID": [
"<ID 1>",
"<ID 2>",
],
"tags": [
{
"facilityNameNative" : "OSC-1-2-2"
},
{
"facilityNameNative" : "OSC-3-1-1"
}
]
}
},
{
"type": "resourceProfile",
"id": "MyOtherResourceProfile",
"attributes": {
"thresholdGroupID": [
"DEMO_PM_PARAMETER_monitoring",
"DEMO_PM_PARAMETER_monitoring_no_max"
],
"nodeID": [
"<ID 3>",
"<ID 4>",
"<ID 5>"
],
"tags": [
{
"facilityNameNative" : "OSC-2-1-1"
},
{
"facilityNameNative" : "OSC-4-1-1"
}
]
}
}
]
}

Delete an existing resource profile

To delete an existing resource profile, use the PM Processor API.

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1105
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

DELETE {{MCP_SERVER}}/pmprocessor/api/v1/resource_profiles/MyOtherResourceProfile

Any alerts for the deleted resource profile will be discontinued.

Retrieve an existing resource profile

To retrieve an existing resource profile, use the PM Processor API.

Sample request

GET {{MCP_SERVER}}/pmprocessor/api/v1/resource_profiles/MyOtherResourceProfile

Retrieve all existing resource profiles

To retrieve all existing resource profiles, use the PM Processor API.

Sample request

GET {{MCP_SERVER}}/pmprocessor/api/v1/resource_profiles

Non-PM measurement data

The PM micro-service that uses Chronos Scheduler periodically sends to the 6500 Resource Adapter (RA)
a single request for all non-PM measurements. In response, the RA fetches the details from NE and
publishes the metrics as Kafka messages. These periodical non-PM measurements will remain in Heroic.

RTRV-OTM - Non-PM Measurements

The following table lists the Non-PM Measurements for RTRV-OTM.

RTRV-OTM - Non-PM Measurements

NATIVE NAME NORMALIZED NAME UNIT DESCRIPTION

OCHRXACTDISP RX Total Actual Link ps/nm Receiver total actual link

Dispersion (picoseconds dispersion in the far-to-near
per direction
nanometer)

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1106
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

NATIVE NAME NORMALIZED NAME UNIT DESCRIPTION

OCHRXACTPMD Estimated Differential Group pSec Estimated Instance of DGD

Delay (Differential Group Delay)
value Displayed in xx ps

OCHRXACTPWR RX Actual Power dBm RX actual power in dBm (xx.x)

Power ranges are card
specific

OCHUNILATENCY OCH Unidirectional Latency uSec OCH Unidirectional Latency

Displayed in the form of
xxxx.xx us

OCHESTLENGTH Estimated Fiber Length m (meter) Estimated fiber length

Displayed in xxxx meters

RTRV-PTP - Non-PM Measurements

The following table lists the Non-PM Measurements for RTRV-OTM.

RTRV-OTM - Non-PM Measurements

NATIVE NAME NORMALIZED NAME UNIT DESCRIPTION

OCHRXACTDISP RX Total Actual Link ps/nm Receiver total actual link

Dispersion (picoseconds dispersion in the far-to-near
per direction
nanometer)

OCHRXACTPMD Estimated Differential Group pSec Estimated Instance of DGD

Delay (Differential Group Delay)
value Displayed in xx ps

OCHRXACTPWR RX Actual Power dBm RX actual power in dBm (xx.x)

Power ranges are card
specific

OCHUNILATENCY OCH Unidirectional Latency uSec OCH Unidirectional Latency

Displayed in the form of
xxxx.xx us

OCHESTLENGTH Estimated Fiber Length m (meter) Estimated fiber length

Displayed in xxxx meters

RTRV-INVENTORY - Non-PM Measurements

The following table lists the Non-PM Measurements for RTRV-INVENTORY.

RTRV-INVENTORY - Non-PM Measurements

NATIVE NAME NORMALIZED NAME UNIT DESCRIPTION

TCUR Current Temperature Celsius Current Temperature

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1107
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

RTRV-DOC-CH - Non-PM Measurements

The following table lists the Non-PM Measurements for RTRV-DOC-CH.

RTRV-DOC-CH - Non-PM Measurements

NATIVE NAME NORMALIZED NAME UNIT DESCRIPTION

ESTINCROSNR Estimated Incremental OSNR Estimated Incremental OSNR. A

quoted string of up to 6
characters.

COS Channel Condition The channel condition. Some of

the possible values include
Optimized, Inactive:Waiting for
Power, Partially Added:LOS

Sample TL1 Response from NE

RTRV-OTM Sample Response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1108
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

< RTRV-OTM:: ALPHARETTA-6500-32-2:ALL:9:::TTIINFO=YES;

ALPHARETTA-6500-32-2 18-05-04 07:23:46

M 9 COMPLD

"OTM4-1-33-1::CLFI=\"\",AINSTIMELEFT=00-
05,PORTMODE=SDH,OTURATE=112G,TFMODE=OFF,OTURXEXPTTI=\"\",OTUTXTTI=\"ALPHARETTA-
6500-32-2 001-33-
001\",OTUEXSAPI=\"\",OTUTXSAPI=\"\",OTUEXDAPI=\"\",OTUTXDAPI=\"\",OTUTIMEN=OPERATOR
,OSID=\"\",OTUTXFECFRMT=QFEC,OTURXFECFRMT=QFEC,OCHTXACTDISP=\"UNKNOWN\",OCHROTATION
=ENABLED,OCHTXMODE=AUTOMATIC,OCHTXPREDISP=\"UNKNOWN\",OCHRXPOSTDISP=\"UNKNOWN\",OCH
TXDISPPROV=\"30000\",OCHTXDISPMIN=\"-
40000\",OCHTXDISPMAX=\"85000\",OCHRXACTDISP=\"-1\",OCHTXPWR=\"-
11.0\",OCHTXACTPWR=\"OOR-LO\",OCHTXMINPWR=\"-
11.0\",OCHTXMAXPWR=\"4.0\",OCHRXACTPWR=\"-10.1\",OCHRXMINPWR=\"-
22.5\",OCHRXMAXPWR=\"5.5\",OCHLINETYPE=COLOURED,OCHPWRBALOFFSET=\"0\",OCHTXWVLNGTHP
ROV=\"0.00\",OCHTXWVLNGTHMIN=\"1528.77\",OCHTXWVLNGTHMAX=\"1566.72\",OCHTXWVLNGTHSP
ACING=50,TUNINGMODE=NORMAL,OCHOPTIMIZEMODE=OPTIMIZATIONMODE1,OCHTXCHIRP=POSITIVE,OC
HSPECTRALOCCUPANCY=NARROW,OCHRXECHOTRACE=\"\",OCHTXTRACE=\"ALPHARETTA-6500-32-2
001-33-
001\",OCHTXASSOCFARENDRX=\"\",OCHDIFFERENTIALENCODING=NONE,ODUTFMODE=OFF,PREFECSFTH
LEV=\"0.00\",PREFECSFTHBER=\"3.00E-
02\",PREFECSDTHLEV=\"0.50\",PREFECSDTHBER=\"1.75E-
02\",ODUTTITERM=NO,ODUMONITOR=NO,OCHMAXPMD=\"150\",OCHRXACTPMD=\"2\",OCHREACHSPEC=\
"APP-
SPECIFIC\",OCHESTLENGTH=\"14\",OCHRTD=\"UNKNOWN\",OCHUNILATENCY=\"17.44\",OCHFRR=DI
SABLED,OCHFRRCONFIG=MATCHEDCD,OCHFRRPATH1DISP=\"AUTO\",OCHFRRPATH2DISP=\"AUTO\",HOL
DOFF=0,HOLDON=100,OCHTXFREQPROV=\"000.0000\",OCHTXFREQMIN=\"191.3425\",OCHTXFREQMAX
=\"196.1075\",OCHTXFREQRES=\"0.1\",OCHENMPROV=MODE2,OCHRXENM=MODE2,OCHTXENM=MODE2,O
CHCARRIERCENTERINGMODE=MODE2,OCHLASERCENTRANGE=\"2.5\",OCHCCDA=OFF,OCHTXB=OFF,SPLIM
GMT=ON,SPLIMANAGED=NO,OCHRXPWRTHRPROV=OFF,OCHRXPWRLTHR=\"-
22.5\",OCHRXPWRHTHR=\"5.5\",TTOPS=NO,OCHTXSIGBW3DB=\"34.5\",OCHTXSIGBW10DB=\"37.4\"
,OCHTXMINSPECWTH=\"37.5\",LASERFREQTHR=\"1.6\":OOS-AUMA,FLT&DISCD&AINS"

>

RTRV-PTP Sample Response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1109
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

< RTRV-PTP:: ALPHARETTA-6500-32-2:ALL:9:::;

ALPHARETTA-6500-32-2 18-05-04 07:23:46

M 9 COMPLD

"PTP-1-3-
1::LABEL=\"\",SERVICETYPE=OTU4,OCHTXACTDISP=\"2\",OCHTXMODE=OFF,OCHTXPREDISP=\"0\",
OCHRXPOSTDISP=\"-
2\",OCHROTATION=DISABLED,OCHTXDISPPROV=\"0\",OCHTXDISPMIN=\"0\",OCHTXDISPMAX=\"0\",
OCHRXACTDISP=\"-2\",OCHTXPWR=\"-7.0\",OCHTXACTPWR=\"-7.0\",OCHTXMINPWR=\"-
11.0\",OCHTXMAXPWR=\"-5.0\",OCHRXACTPWR=\"-6.7\",OCHRXMINPWR=\"-
22.5\",OCHRXMAXPWR=\"5.5\",OCHTXWVLNGTHPROV=\"1530.33\",OCHTXWVLNGTHMIN=\"1528.77\"
,OCHTXWVLNGTHMAX=\"1566.72\",OCHTXWVLNGTHSPACING=50,OCHLINETYPE=COLOURED,OCHTXSPCTR
LOCCP=NARROW,OCHDIFFERENTIALENCODING=NONE,OCHMAXPMD=\"50\",OCHRXACTPMD=\"0\",OCHREA
CHSPEC=\"300\",OCHESTLENGTH=\"4\",OCHRTD=\"32.44\",OCHUNILATENCY=\"18.32\",OCHTXTRA
CE=\"ALPHARETTA-6500-32-2 001-03-001\",OCHRXECHOTRACE=\"ALPHARETTA-6500-32-2 001-
03-001\",OCHTXASSOCFARENDRX=\"ALPHARETTA-6500-32-1 001-03-
001\",TUNINGMODE=NORMAL,OCHOPTIMIZEMODE=OPTIMIZATIONMODE1,OCHTXCHIRP=POSITIVE,OCHEN
MPROV=MODE2,OCHRXENM=MODE2,OCHTXENM=MODE2,OCHFRR=DISABLED,OCHFRRCONFIG=MATCHEDCD,OC
HFRRPATH1DISP=\"AUTO\",OCHFRRPATH2DISP=\"AUTO\",OCHCCDA=OFF,OCHTXB=OFF,OCHTXFREQPRO
V=\"195.9000\",OCHTXFREQMIN=\"191.3425\",OCHTXFREQMAX=\"196.1075\",OCHTXFREQRES=\"0
.1\",OCHCARRIERCENTERINGMODE=MODE2,OCHLASERCENTRANGE=\"2.5\",SPLIMGMT=ON,SPLIMANAGE
D=NO,TTOPS=NO,RXPWRTHRPROV=OFF,RXPWRLTHR=\"-
22.5\",RXPWRHTHR=\"5.5\",RXCHPWRLTHR=\"-
18.5\",RXCHPWRHTHR=\"7.0\",OCHTXSIGBW3DB=\"34.5\",OCHTXSIGBW10DB=\"37.4\",OCHTXMINS
PECWTH=\"37.5\":IS,DISCD"

RTRV-INVENTORY Sample Response

ALPHARETTA-6500-32-2 18-05-04 10:33:54

M 9 COMPLD

"PKTOTN-1-3::CTYPE=\"PKT/OTN I/F 100G WL3n Basic C-

Band\",SNMPINDEX=537005056,PEC=NTK669AM,REL= 06
,CLEI=WOTRDW6FAA,SER=NNTMRT0H7XEW,MDAT=2016-52,TCUR=65,TAVG=65,CARDPWR=FULL,AGE=00-
199-17-21,ONSC=00-002-10-24"

RTRV-DOC-CH Sample Response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1110
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

< RTRV-DOC-CH:: C203-ROADM:ALL:9:::;

ALPHARETTA-6500-32-2 18-05-04 07:23:46

M 9 COMPLD

"NC-1-72-1-4-155252::COS=\"Optimized\",CFS=\"No
Fault\",EEC=\"Optimized\",INGRESSACTIVEFLAG=\"True\",INGRESS=\"C203-ROADM-1-
4\",EGRESS=\"C203-CDC-1-4\",NETRAIL=\"C203-ROADM-1-4,C203-CDC-1-
4\",NWCTDOCTRAIL=\"C203-ROADM:DOC-1-1\",NWCTDOCTRAILSTATUS=COMPLETE,CKTID=\"SPUD
Source RED 1552.52 CH 57\",Domain Routing=\"Add-
Drop\",ESTINCROSNR=\"32.34\",DOCINST=DOC-1-1,SNRBIAS=0.00,MODCLASS=CUSTOM1"

Sample Metrics as Kafka Message

RTRV-OTM Sample Kafka Messages

{
"header": {
"timestamp": "2018-05-04T07:23:49.015431Z",
"envelopeId": "3697b28d-2d1e-4312-9556-c8623245e59f"
},
"version": 1,
"event": {
"_type": "bp.hpmra.v1.pm",
"object_type": "pm",
"object_data": [
{
"attributes": {
"metrics": [
{
"attributes": {
"resourceId": "ALPHARETTA-6500-32-2",
"version": "1.4",
"values": [
{
"value": "14.0",
"time": "2018-05-04T07:23:00.00Z"
}
],
"tags": {
"facilityNameNative": "OTM4-1-33-1",
"parameterNative": "OCHESTLENGTH",
"parameter": "Estimated Fiber Length",
"unit": "m",
"longName": "ALPHARETTA-6500-32-2-DELHI-MUMBAI-CHENNAI-KOLKATTA-
KASHMIR"
}
},
"type": "metrics"
},
{
"attributes": {
"resourceId": "ALPHARETTA-6500-32-2",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1111
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

"version": "1.4",
"values": [
{
"value": "-1.0",
"time": "2018-05-04T07:23:00.00Z"
}
],
"tags": {
"facilityNameNative": "OTM4-1-33-1",
"parameterNative": "OCHRXACTDISP",
"parameter": "RX Total Actual Link Dispersion",
"unit": "",
"longName": "ALPHARETTA-6500-32-2-DELHI-MUMBAI-CHENNAI-KOLKATTA-
KASHMIR"
}
},
"type": "metrics"
},
{
"attributes": {
"resourceId": "ALPHARETTA-6500-32-2",
"version": "1.4",
"values": [
{
"value": "2.0",
"time": "2018-05-04T07:23:00.00Z"
}
],
"tags": {
"facilityNameNative": "OTM4-1-33-1",
"parameterNative": "OCHRXACTPMD",
"parameter": "Estimated Differential Group Delay",
"unit": "pSec",
"longName": "ALPHARETTA-6500-32-2-DELHI-MUMBAI-CHENNAI-KOLKATTA-
KASHMIR"
}
},
"type": "metrics"
},
{
"attributes": {
"resourceId": "ALPHARETTA-6500-32-2",
"version": "1.4",
"values": [
{
"value": "-10.1",
"time": "2018-05-04T07:23:00.00Z"
}
],
"tags": {
"facilityNameNative": "OTM4-1-33-1",
"parameterNative": "OCHRXACTPWR",
"parameter": "RX Actual Power",
"unit": "dBm",
"longName": "ALPHARETTA-6500-32-2-DELHI-MUMBAI-CHENNAI-KOLKATTA-
KASHMIR"
}
},
"type": "metrics"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1112
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

},
{
"attributes": {
"resourceId": "ALPHARETTA-6500-32-2",
"version": "1.4",
"values": [
{
"value": "17.44",
"time": "2018-05-04T07:23:00.00Z"
}
],
"tags": {
"facilityNameNative": "OTM4-1-33-1",
"parameterNative": "OCHUNILATENCY",
"parameter": "OCH Unidirectional Latency",
"unit": "uSec",
"longName": "ALPHARETTA-6500-32-2-DELHI-MUMBAI-CHENNAI-KOLKATTA-
KASHMIR"
}
},
"type": "metrics"
}
],
"lastBatch": true,
"requestId": "req_1",
"nodeId": "8dade76f-1aee-3465-8972-f7a6951b5271"
},
"type": "pmResults"
}
]
}
}

RTRV-PTP Sample Kafka Messages

{
"header": {
"timestamp": "2018-05-04T07:23:49.015431Z",
"envelopeId": "3697b28d-2d1e-4312-9556-c8623245e59f"
},
"version": 1,
"event": {
"_type": "bp.hpmra.v1.pm",
"object_type": "pm",
"object_data": [
{
"attributes": {
"metrics": [
{
"attributes": {
"resourceId": "ALPHARETTA-6500-32-2",
"version": "1.4",
"values": [
{
"value": "4.0",
"time": "2018-05-04T07:23:00.00Z"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1113
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

],
"tags": {
"facilityNameNative": "PTP-1-3-1",
"parameterNative": "OCHESTLENGTH",
"parameter": "Estimated Fiber Length",
"unit": "m",
"longName": "ALPHARETTA-6500-32-2-DELHI-MUMBAI-CHENNAI-KOLKATTA-
KASHMIR"
}
},
"type": "metrics"
},
{
"attributes": {
"resourceId": "ALPHARETTA-6500-32-2",
"version": "1.4",
"values": [
{
"value": "-2.0",
"time": "2018-05-04T07:23:00.00Z"
}
],
"tags": {
"facilityNameNative": "PTP-1-3-1",
"parameterNative": "OCHRXACTDISP",
"parameter": "RX Total Actual Link Dispersion",
"unit": "",
"longName": "ALPHARETTA-6500-32-2-DELHI-MUMBAI-CHENNAI-KOLKATTA-
KASHMIR"
}
},
"type": "metrics"
},
{
"attributes": {
"resourceId": "ALPHARETTA-6500-32-2",
"version": "1.4",
"values": [
{
"value": "0",
"time": "2018-05-04T07:23:00.00Z"
}
],
"tags": {
"facilityNameNative": "PTP-1-3-1",
"parameterNative": "OCHRXACTPMD",
"parameter": "Estimated Differential Group Delay",
"unit": "pSec",
"longName": "ALPHARETTA-6500-32-2-DELHI-MUMBAI-CHENNAI-KOLKATTA-
KASHMIR"
}
},
"type": "metrics"
},
{
"attributes": {
"resourceId": "ALPHARETTA-6500-32-2",
"version": "1.4",
"values": [

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1114
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

{
"value": "-6.7",
"time": "2018-05-04T07:23:00.00Z"
}
],
"tags": {
"facilityNameNative": "PTP-1-3-1",
"parameterNative": "OCHRXACTPWR",
"parameter": "RX Actual Power",
"unit": "dBm",
"longName": "ALPHARETTA-6500-32-2-DELHI-MUMBAI-CHENNAI-KOLKATTA-
KASHMIR"
}
},
"type": "metrics"
},
{
"attributes": {
"resourceId": "ALPHARETTA-6500-32-2",
"version": "1.4",
"values": [
{
"value": "18.32",
"time": "2018-05-04T07:23:00.00Z"
}
],
"tags": {
"facilityNameNative": "PTP-1-3-1",
"parameterNative": "OCHUNILATENCY",
"parameter": "OCH Unidirectional Latency",
"unit": "uSec",
"longName": "ALPHARETTA-6500-32-2-DELHI-MUMBAI-CHENNAI-KOLKATTA-
KASHMIR"
}
},
"type": "metrics"
}
],
"lastBatch": true,
"requestId": "req_1",
"nodeId": "8dade76f-1aee-3465-8972-f7a6951b5271"
},
"type": "pmResults"
}
]
}
}

RTRV-INVENTORY Sample Kafka Messages

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1115
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

{
"header": {
"timestamp": "2018-05-04T07:23:49.015431Z",
"envelopeId": "3697b28d-2d1e-4312-9556-c8623245e59f"
},
"version": 1,
"event": {
"_type": "bp.hpmra.v1.pm",
"object_type": "pm",
"object_data": [
{
"attributes": {
"metrics": [
{
"attributes": {
"resourceId": "ALPHARETTA-6500-32-2",
"version": "1.4",
"values": [
{
"value": "65",
"time": "2018-05-04T07:23:00.00Z"
}
],
"tags": {
"facilityNameNative": "PKTOTN-1-3",
"parameterNative": "TCUR",
"parameter": "Current Temperature",
"unit": "",
"longName": "ALPHARETTA-6500-32-2-DELHI-MUMBAI-CHENNAI-KOLKATTA-
KASHMIR"
}
},
"type": "metrics"
}
],
"lastBatch": true,
"requestId": "req_1",
"nodeId": "8dade76f-1aee-3465-8972-f7a6951b5271"
},
"type": "pmResults"
}
]
}
}

RTRV-DOC-CH Sample Kafka Messages

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1116
Blue Planet MCP API Reference Guide, Release 18.06 Performance monitoring

{
"header": {
"timestamp": "2018-05-04T07:23:49.015431Z",
"envelopeId": "3697b28d-2d1e-4312-9556-c8623245e59f"
},
"version": 1,
"event": {
"_type": "bp.hpmra.v1.pm",
"object_type": "pm",
"object_data": [
{
"attributes": {
"metrics": [
{
"attributes": {
"resourceId": "ALPHARETTA-6500-32-2",
"version": "1.4",
"values": [
{
"value": "32.34",
"time": "2018-05-04T07:23:00.00Z"
}
],
"tags": {
"facilityNameNative": "NC-1-72-1-4-155252",
"parameterNative": "ESTINCROSNR",
"parameter": "Estimated Incremental OSNR",
"unit": "",
"longName": "ALPHARETTA-6500-32-2-DELHI-MUMBAI-CHENNAI-KOLKATTA-
KASHMIR"
}
},
"type": "metrics"
}
],
"lastBatch": true,
"requestId": "req_1",
"nodeId": "8dade76f-1aee-3465-8972-f7a6951b5271"
},
"type": "pmResults"
}
]
}
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1117
Blue Planet MCP API Reference Guide, Release 18.06 Security management

Security management
You can manage security using MCP REST APIs. The following topics are covered:

RADIUS setup and configuration

• Create a RADIUS profile
• Integrate a RADIUS Server

LDAP setup and configuration

You can set up and configure an LDAP server for Blue Planet MCP by performing the following
procedures. These procedures cover one way of setting up an LDAP directory to authenticate users in
Blue Planet (UAC/tron), and are intended as an example to demonstrate the configuration parameters.

Note: OpenLDAP (used in this example setup) or samba-tool can be used for the LDAP setup. Internal
samba container can also be used to set up the same service as used by Tron by running "setup-Idap".

• install OpenLDAP on host

• Configure LDAP directory
• Creating groups
• Creating users
• Configure Tron
• Assigning roles

Create a RADIUS profile

To create a Remote Authentication Dial-In User Service (RADIUS) profile, use the RADIUS connection
profiles API.

You create a RADIUS profile to define the servers to be included in the device configuration data.

Requirements

Before you start, make sure that you have set the IP address, the name, and the user data.

• In the “name” field (required), enter either:

◦ primary_config
◦ backup_config

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1118
Blue Planet MCP API Reference Guide, Release 18.06 Security management

• In the “serverIp” field (required), specify the IP address of the RADIUS server.
• By default the RADIUS server port is 1812.

Make sure that you create no more than two RADIUS profiles.

Sample request

POST {{MCP_SERVER}}/rbac/api/v1/radiusprofiles

{
"data": {
"type": "radiusConnectionProfile",
"attributes": {
"name": "primary_config",
"profileDescription": "RADIUS Authentication primary server",
"serverIp": "10.10.100.1",
"serverPort": 1812
}
}
}

The response to a POST request includes the full content of the created resource object, including the
server-generated unique resource identifier.

The returned resource ID may be used in subsequent requests where a resource identifier is required (for
example, to GET a specific profile, and in DELETE or PUT operations).

Sample response

{
"data": {
"id": "3e4e290a-92d4-45af-a220-82114bea196d",
"type": "radiusConnectionProfile",
"attributes": {
"name": "primary_config",
"profileDescription": "RADIUS Authentication primary server",
"serverIp": "10.10.100.1",
"serverPort": 1812
}
}
)

Integrate a RADIUS server

To configure a RADIUS server, use the RADIUS configuration API. Then configure RADIUS to allow users
to logon using their RADIUS usernames and passwords.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1119
Blue Planet MCP API Reference Guide, Release 18.06 Security management

Overview of RADIUS support

MCP supports the delegation of authentication and authorization to an external customer-supplied
RADIUS server. For more information about the RADIUS protocol, see https://tools.ietf.org/html/rfc2865.

Support limitations

• RADIUS Accounting (RFC 2866) is not supported.

• A customizable authport is not supported (use 1812).
• Authorization timeout default is 5 seconds.
• If no roles are specified, the following log message is generated: "No Role details found in RADIUS
reply, user will have no Roles."

User details, including passwords, are stored on the MCP host.

MCP performs authentication (checks the user’s password) against the local MCP database. With
RADIUS mode enabled, MCP delegates authentication (password checking) to an external RADIUS server.
MCP creates a local user, but without a password entry. This way the UAC user interface can list users,
but does not allow setting of passwords for RADIUS users.

Local and RADIUS users can both exist in the same UAC instance, but not with the same usernames. UAC
can also optionally accept authorization data from RADIUS. Authorization data is basically a list of roles
assigned to the user. Without the optional RADIUS authorization mode, the UAC administrator can:

• Specify a default set of roles for RADIUS users.

• Assign roles directly to users once the users logs into MCP.

Requirements

• Enable the RADIUS configuration in MCP including the IP address of the RADIUS server.
• Use administrator credentials in the RADIUS configuration API.

Note: A maximum of two RADIUS servers can be configured and must be named primary_config and
backup_config. You must not rename the RADIUS servers. Both RADIUS servers are created by default.

Sample request

Note: Ensure that you replace the uuid, name, serverIp, and serverSecret with the values for your system.

POST {{MCP_SERVER}}/api/v1/radius-configs

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1120
Blue Planet MCP API Reference Guide, Release 18.06 Security management

{
"description": "",
"createdTime": "2017-05-31T16:03:54.250Z",
"modifiedTime": "2017-05-31T16:03:54.250Z",
"uuid": "string",
"name": "string",
"enabled": true,
"serverIp": "string",
"serverSecret": "string",
"tenant": "string",
"authoritativeRoleSource": false
}

Sample response

{
"count": 2,
"previous": null,
"results": [
{
"description": "primary radius config",
"createdTime": "2017-05-31T14:23:46Z",
"modifiedTime": "2017-05-31T14:23:46Z",
"uuid": "a993d458-4087-4b75-921e-ef19f08291cb",
"name": "primary_config",
"enabled": true,
"serverIp": "192.168.1.1",
"serverSecret": "secret",
"tenant": "master",
"authoritativeRoleSource": false
}
. . .

Limitations of RADIUS or LDAP users

In MCP, RADIUS or LDAP users:

• cannot be edited in the UAC user interface (Edit button is disabled)

• cannot change their password in MCP (Change password, Reset password, Forgot password)
• are visible on the Users page, but most fields are blank (first name, last name, email) as we do not
retrieve these attributes from the LDAP database
◦ A new "Account Source" has been added to the Users page to identify users: Local or RADIUS.
• are visible on the Active Sessions page
• can have their sessions terminated just like local users
• must be configured with the "Ciena-Roles" attribute indicating their associated permissions
• must have at least one role assigned

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1121
Blue Planet MCP API Reference Guide, Release 18.06 Security management

Authenticating users
Once RADIUS is configured, you can authenticate in a similar manner to a local user using RADIUS
credentials. You can only configure RADIUS for a single tenant and the tenant must be provided in the
configuration request shown in Sample request. The same tenant name must be used while
authenticating users. If no tenant name is used, or not provided, the tenant name should default to master
tenant.

Sample authentication

curl -k -H "Content-Type:application/json" -d
'{"username":"user1","password":"secretpass"}' https://localhost/tron/api/v1/tokens

Configuring RADIUS as the roles authority

To configure RADIUS as the roles authority, simply change "authoritativeRoleSource" to "true" in your
request (see Sample request).

Roles to authentication

User roles can include both system user roles and customer defined user roles.

For more information about managing user roles, see Managing roles in the Security management chapter
of 450-3709-301, MCP User Guide.

Note: The examples provided in this section are in the format of the FreeRADIUS server implementation.
For more information about the FreeRADIUS server implementation, see https://freeradius.org/radiusd/
man/users.html.

The system users are described as follows:

• Application admin
◦ administration of MCP
◦ application-level security
◦ basic visibility of network elements and services
• Network admin
◦ full control of network elements and services
• Planning admin
◦ full control of planning for the network
• Observer
◦ basic visibility of network elements and services
• UAC sysadmin

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1122
Blue Planet MCP API Reference Guide, Release 18.06 Security management

◦ a Tron role required for security operations

Add the following to your "dictionary" configuration file:

#
# Ciena specific codes
#
VENDOR Ciena 1271
BEGIN-VENDOR Ciena
ATTRIBUTE Ciena_BP_Role 220 string
END-VENDOR Ciena

This is a Multi-Valued attribute for inclusion in Access-Accept messages. If the attribute is present more
than once in the Access-Accept, the roles are added together by Blue Planet.

Acceptable values are comma-separated strings matching (case-sensitively) any roles defined in Blue
Planet (these can be retrieved from the API with 'GET /tron/api/v1/roles/?isInternal=false'). Leading and
trailing whitespace is removed and values that are not mapped to existing roles in Blue Planet are
ignored.

Sample users

user1 Cleartext-Password := "secretpass"

Ciena_BP_Role := "Application admin, sysadmin",
user2 Cleartext-Password := "secretpass2"
Ciena_BP_Role += "Observer, Planning admin",
mcpuser1 Cleartext-Password := "secret1"
Ciena_BP_Role += "Application admin"
mcpuser2 Cleartext-Password := "secret2"
Ciena_BP_Role += "Network admin"
mcpuser3 Cleartext-Password := "secret3"
Ciena_BP_Role += "Planner admin"
mcpuser4 Cleartext-Password := "secret4"
Ciena_BP_Role += "Observer"
mcpuser5 Cleartext-Password := "secret5"
Ciena_BP_Role += "Application admin, Network admin, Planner admin,
Observer"

Note : Role names must match the role names in the roles list or they are ignored. Roles are selected
according to the role.name and the default application with the following exceptions:

• The role.name is "sysadmin" and the application is "UAC". If the role doesn’t exist, the default is used.
• The role.name is "admin" and the application is "UAC". If the role doesn’t exist, the default is used.
• The role.name is "user" and the application is "UAC". If the role doesn’t exist, the default is used.

Limitations or assumptions

1. When RADIUS is enabled, the user is deactivated except users with role UAC:sysadmin, UAC:admin
and internal users.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1123
Blue Planet MCP API Reference Guide, Release 18.06 Security management

2. The RADIUS server-type is not specified in configuration. The best way to ensure UAC-RADIUS
integration is to test with a valid server.
3. The RADIUS configuration name must be either primary_config or backup_config to be effective.

Data synchronization

When a user tries to login with RADIUS enabled, the user object is updated if RADIUS authentication is
successful. UAC only corresponds with RADIUS during password-based authentication. The token created
during user login expires after 24 hours or a configured timeout. The user is able to use the token even he
or she has been disabled by the RADIUS administrator. After the token has expired, the user must login
again.

Note: A password-based login attempt updates a RADIUS user’s enable/disable status if that RADIUS user
account’s control attribute indicates disabled or the user is deleted from the RADIUS server.

Authentication order

When RADIUS is enabled, UAC first tries to authenticate with the RADIUS server. You can specify one
primary RADIUS server and one backup RADIUS server. When both RADIUS servers are enabled, UAC
attempts authentication in order of: primary, secondary, then local.

HMAC authentication

A system administrator is able to create an API key for RADIUS users in the UAC user interface. Users are
then able to perform API requests to UAC using HMAC authentication. UAC does not communicate with
RADIUS for HMAC authentication. If a user is disabled on the RADIUS server, the system administrator is
recommended to disable the user through the UAC interface. Otherwise, API keys associated with the
disabled user remain active.

Use cases

RADIUS enabled

1. RADIUS enabled, login with valid RADIUS credentials:

◦ an application user opens the MCP URL
◦ MCP redirects the user to the UAC login page.
◦ the MCP user provides a valid RADIUS credential
◦ the user redirects back to MCP page
◦ login succeeds
2. RADIUS enabled, login with invalid RADIUS credentials
◦ an application user provides a valid RADIUS username but invalid password
◦ login fails

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1124
Blue Planet MCP API Reference Guide, Release 18.06 Security management

3. RADIUS enabled, login with native sysadmin credentials succeeds.

4. RADIUS enabled, login with internal user credentials succeeds.
5. RADIUS enabled, login with native normal user credentials fails.
6. RADIUS enabled, RADIUS server is down
◦ an application user provides valid RADIUS credentials
◦ login fails
7. RADIUS enabled, RADIUS server is down
◦ a native UAC user without "sysadmin" role attempts to login
◦ login fails

RADIUS disabled

1. RADIUS disabled, application user provides valid RADIUS credentials

◦ login fails
2. RADIUS disabled, application user provides invalid credential
◦ login fails
3. RADIUS disabled, login with native sysadmin credentials succeeds.
4. RADIUS disabled, login with native non-sysadmin credentials succeeds.

Build and deploy RADIUS Server

make start-platform deploy-itest-solution

Get an admin token. Use this to configure RADIUS.

PREFIX=https://localhost/tron
TOKEN=$(curl \
--silent -k \
-H "Content-Type:application/json" \
-d '{"username":"admin","password":"adminpw"}' \
$PREFIX/api/v1/tokens | \
python -c "import sys, json; print
json.load(sys.stdin)['token']")
echo $TOKEN

Display the current state of the RADIUS configuration

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1125
Blue Planet MCP API Reference Guide, Release 18.06 Security management

curl --silent -k -H "Authorization: token $TOKEN" $PREFIX/api/v1/radius-configs

RADIUS_UUID=$(curl \
--silent -k \
-H "Authorization: token $TOKEN" \
$PREFIX/api/v1/radius-configs | \
python -c "import sys, json; print
json.load(sys.stdin)['results'][0]['uuid']")

curl \
--silent -k \
-H "Authorization: token $TOKEN" \
$PREFIX/api/v1/radius-configs/$RADIUS_UUID | \
python -c "import sys, json, pprint; pprint.pprint(json.load(sys.stdin))"

Configure UAC to point to the local RADIUS server in the Docker container

RADIUS_IP=$(docker inspect -f '{{range

.NetworkSettings.Networks}}{{.IPAddress}}{{end}}' freeradius_1.1.0_0)
curl \
--silent -k \
-H "Authorization: token $TOKEN" \
-H "Content-Type:application/json" \
-X PATCH \
-d '{"name": "primary_config", "enabled": true, "authoritative_role_source":
true, "server_secret": "supersecret", "server_ip": "'$RADIUS_IP'", "tenant":
"master", "description": "primary radius config"}' \
$PREFIX/api/v1/radius-configs/$RADIUS_UUID

curl \
--silent -k \
-H "Authorization: token $TOKEN" \
$PREFIX/api/v1/radius-configs/$RADIUS_UUID | \
python -c "import sys, json, pprint; pprint.pprint(json.load(sys.stdin))"

Display the current state of the users

curl -k -H "Content-Type: application/json" -H "Authorization: token $TOKEN"

$PREFIX/api/v1/users | python -m json.tool

Get a token as a RADIUS mastered user

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1126
Blue Planet MCP API Reference Guide, Release 18.06 Security management

curl
-k
-H "Content-Type:application/json"
-d '{"username":"user2","password":"secretpass2"}'
$PREFIX/api/v1/tokens

curl
-k
-H "Content-Type:application/json"
-d '{"username":"user1","password":"secretpass"}'
$PREFIX/api/v1/tokens

Display the new state of the users

curl
-k
-H "Content-Type:application/json"
-H "Authorization: token $TOKEN" $PREFIX/api/v1/users | python -m json.tool
curl
-k
-H "Content-Type:application/json"
-H "Authorization: token $TOKEN" $PREFIX/api/v1/users\?username\=user1 |
python -m json.tool

Install OpenLDAP on host

Use this procedure to install OpenLDAP on the host (Ubuntu).

Steps

1. Run the autoconfiguration by entering:

apt-get install slapd ldap-utils

The autoconfiguration will create an LDAP directory rooted at the host’s FQDN, eg on
myLDAPserver.lonlab.ciena.com. The directory will be created as dc=lonlab,dc=ciena,dc=com.

2. Make note of your directory root and be sure to substitute that in all the procedural steps for LDAP
setup and configuration that follow.
3. Enter the password for the admin user (cn=admin,dc=your,dc=domain) when prompted during
autoconfiguration.

Access to the LDAP configuration is granted through the OS-level root user (-Y external -H ldapi:///).

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1127
Blue Planet MCP API Reference Guide, Release 18.06 Security management

4. The directory will allow anonymous bind and searching, as well as searches of non-sensitive data by
regular users. Consider configuring ACLs for more restrictive access to the user data.

End

Configure LDAP directory

Use this procedure to configure the LDAP directory.

Steps

Tailor the LDAP logging

1. Set the loglevel to suit your needs, eg:

ldapmodify -Q -Y external -H ldapi:/// <<EOF

dn: cn=config
changetype: modify
replace: olcLogLevel
olcLogLevel: config stats none
EOF

The logs are sent to syslog facility local4 by default.

On Redhat, some structures have to be created manually

2. Enter the following:

cd /etc/openldap/schema
ldapadd -Q -Y external -H ldapi:/// -f cosine.ldif
ldapadd -Q -Y external -H ldapi:/// -f inetorgperson.ldif
ldapadd -Q -Y external -H ldapi:/// -f nis.ldif

ldapmodify -QY external -H ldapi:/// <<EOF

dn: olcDatabase={2}hdb,cn=config
changetype: modify
replace: olcSuffix
olcSuffix: dc=lonlab,dc=ciena,dc=com
-
replace: olcRootDN
olcRootDN: cn=admin,dc=lonlab,dc=ciena,dc=com
EOF

3. Check the olcDatabase configuration:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1128
Blue Planet MCP API Reference Guide, Release 18.06 Security management

ldapsearch -QY EXTERNAL -H ldapi:/// -b cn=config

'(objectClass=olcDatabaseConfig)'

4. Take note of the olcRootPW, and update with slappasswd if necessary:

ldapadd -x -D "cn=admin,dc=lonlab,dc=ciena,dc=com" -w ciena123 -H

ldap://localhost $lt;%lt;EOF
dn: dc=lonlab,dc=ciena,dc=com
objectClass: dcObject
objectClass: organization
dc: lonlab
o: Ciena
description: lonlab test LDAP instance

dn: cn=admin,dc=lonlab,dc=ciena,dc=com
objectClass: organizationalRole
cn: admin
description: Directory Manager
EOF

Create an attribute for assigning the Tenant

5. The tenant could also be stored in a pre-defined attribute (eg from the inetorgperson or NIS schemas)
if you want to avoid creating custom schemas. It is more clear to create a dedicated attribute though.

ldapadd -Q -Y external -H ldapi:/// <<EOF

dn: cn=CienaBP,cn=schema,cn=config
objectClass: olcSchemaConfig
cn: CienaBP
olcAttributetypes: {0}( 2.3.6.1.4.1.1271.28533.1794.1
NAME 'BPtenant'
DESC 'Ciena BluePlanet Tenant name'
EQUALITY caseIgnoreMatch
SUBSTR caseIgnoreSubstringsMatch
SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 )
olcObjectClasses: {0}( 1.3.6.1.4.1.1271.28533.1794.128
NAME 'BluePlanetUser'
DESC 'Ciena BluePlanetUser object class'
SUP top
AUXILIARY
MUST ( BPtenant ) )
EOF

◦ The names are arbitrary, feel free to adjust them as desired (but remember to use them
consistently).
◦ The OID values must be unique within the scope of the LDAP instance, it is very strongly advised to
abide by IANA allocation rules. The above example uses "Enterprise"."Ciena", with subdivision
28533 and followed by 1794 to reduce the risk of clashes.
◦ See LDAP schema documentation for further information. The definition above is just an example,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1129
Blue Planet MCP API Reference Guide, Release 18.06 Security management

it is by no means the only way a Blue Planet tenant attribute can be defined.
6. To see the result of your work:

ldapsearch -Q -Y external -H ldapi:/// -b cn=schema,cn=config

"(&(objectClass=olcSchemaConfig)(cn=*CienaBP))"

Note: LDAP adds in a schema index number.

Create the Organizational Units for the users and groups

7. Enter the following:

ldapadd -x -D "cn=admin,dc=lonlab,dc=ciena,dc=com" -W <<EOF

dn: ou=People,dc=lonlab,dc=ciena,dc=com
objectClass: organizationalUnit
ou: People

dn: ou=Group,dc=lonlab,dc=ciena,dc=com
objectClass: organizationalUnit
ou: Group
EOF

◦ The empty line between both records is mandatory, or you can split this into separate ldapadd
operations. You can also use ldapmodify to add objects.

End

Creating groups
Use this procedure for creating groups. An example is shown for creation of a one-to-one mapping for the
factory-default roles in UAC (as names are arbitrary).

Note: Grid numbers must be unique in the scope of the LDAP instance.

Steps

1. Enter the following:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1130
Blue Planet MCP API Reference Guide, Release 18.06 Security management

ldapmodify -x -D "cn=admin,dc=lonlab,dc=ciena,dc=com" -W <<EOF

dn: cn=BP-UAC-Admin,ou=Group,dc=lonlab,dc=ciena,dc=com
changetype: add
objectClass: posixGroup
gidNumber: 32129
cn: BP-UAC-Admin

dn: cn=BP-UAC-User,ou=Group,dc=lonlab,dc=ciena,dc=com
changetype: add
objectClass: posixGroup
gidNumber: 32130
cn: BP-UAC-User

dn: cn=BP-Application-Admin,ou=Group,dc=lonlab,dc=ciena,dc=com
changetype: add
objectClass: posixGroup
gidNumber: 32257
cn: BP-Application-Admin

dn: cn=BP-Application-Observer,ou=Group,dc=lonlab,dc=ciena,dc=com
changetype: add
objectClass: posixGroup
gidNumber: 32258
cn: BP-Application-Observer

dn: cn=BP-Network-admin,ou=Group,dc=lonlab,dc=ciena,dc=com
changetype: add
objectClass: posixGroup
gidNumber: 32259
cn: BP-Network-admin

dn: cn=BP-Planner-Admin,ou=Group,dc=lonlab,dc=ciena,dc=com
changetype: add
objectClass: posixGroup
gidNumber: 32260
cn: BP-Planner-Admin

dn: cn=BP-UAC-sysadmin,ou=Group,dc=lonlab,dc=ciena,dc=com
changetype: add
objectClass: posixGroup
gidNumber: 32261
cn: BP-UAC-sysadmin
EOF

2. If custom groups are defined in Tron, they may also be created in LDAP.

Note: See the procedure for Assigning Roles (assigning multiple roles to a single group).

End

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1131
Blue Planet MCP API Reference Guide, Release 18.06 Security management

Creating users
Use this procedure for creating users. An example is shown below.

Note: uidNumbers must be unique in the scope of the LDAP instance.

Steps

1. Enter the following:

NEWUID=16385
NEWUSER=bpuser1

ldapmodify -x -D "cn=admin,dc=lonlab,dc=ciena,dc=com" -W <<EOF

dn: uid=$NEWUSER,ou=People,dc=lonlab,dc=ciena,dc=com
changetype: add
objectClass: inetOrgPerson
objectClass: posixAccount
objectClass: shadowAccount
objectClass: BluePlanet
uid: $NEWUSER
mail: [email protected]
sn: $NEWUSER
givenName: user
cn: $NEWUSER
displayName: $NEWUSER
uidNumber: $NEWUID
gidNumber: $NEWUID
userPassword: secret
gecos: $NEWUSER
loginShell: /bin/bash
homeDirectory: /home/$NEWUSER
BPtenant: master

dn: cn=BP-Application-Admin,ou=Group,dc=lonlab,dc=ciena,dc=com
changetype: modify
add: memberUid
memberUid: $NEWUSER
EOF

2. The $NEWUSER can be added to multiple groups; just add the memberUid to all the groups that are
needed.

Note: The mail attribute is required by Tron and must be unique. All other fields that are optional for
the posixAccount objectClass can be omitted, although sn and givenName are shown in the BP Web
UI and make for easy identification of user records.

End

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1132
Blue Planet MCP API Reference Guide, Release 18.06 Security management

Configure Tron
Use this procedure to configure Tron. An example is shown below.

Note: Use the swagger UI, or other method (eg ConfigureLDAP.py script) to POST the LDAP configuration
parameters to /tron/api/v1/ldap-configs/{uuid}

Step

1. Enter the following:

{
'description': 'BP LDAP test',
'enabled': True,
'server_ip': 'ldap://10.58.109.64',
'enable_ssl': False,
'base_dn':'dc=lonlab,dc=ciena,dc=com',
'domain_search_user':'',
'domain_search_password':'',
'user_name_attribute': 'uid',
'tenant_attribute': 'BPtenant',
'group_name_attribute': 'cn',
'group_object_filter': '(objectClass=posixGroup)',
'role_map': {
"BP-UAC-Admin": {"uac_role_name":"UAC admin","app_name": "UAC"},
"BP-UAC-User": {"uac_role_name":"UAC user","app_name": "UAC"},
"BP-UAC-sysadmin": {"uac_role_name":"UAC sysadmin","app_name": "UAC"},
"BP-Application-Admin": {"uac_role_name":"Application admin","app_name":
"BluePlanet"},
"BP-Application-Observer": {"uac_role_name":"Observer","app_name":
"BluePlanet"},
"BP-Network-admin": {"uac_role_name":"Network admin","app_name":
"BluePlanet"},
"BP-Planner-Admin": {"uac_role_name":"Planner admin","app_name":
"BluePlanet"}
}
}

Note: This example uses anonymous bind from Tron to LDAP, define the domain_search_user and
_password for authenticated bind. The LDAP server should only accept authenticated binds, typically
with a specific account set up for a "client" application to accommodate auditing. (eg
cn=BPtron,ou=RobotUsers,dc=lonlab,dc=ciena,dc=com)

End

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1133
Blue Planet MCP API Reference Guide, Release 18.06 Security management

Assigning roles
Use this procedure to assign roles.

Steps

Assigning multiple roles with a single LDAP group

1. Since tron 11.0.9, a single LDAP group may be mapped to multiple UAC privileges using a list
structure, eg:

'role_map': {

{"ldap_group": [{"uac_role_name": "non-existent-role111", "app_name": "Planet

Orchestrate"}, {"uac_role_name": "user", "app_name": "Planet Orchestrate"}]}

Undefined roles

2. If the role_map contains uac_role_name values that are not valid roles in Tron, LDAP users who are
assigned these roles will be granted access to BP, but in a read-only (Observer) capacity. The system
does allow mapping of non-existing roles.
3. If LDAP users with assigned undefined roles log in to BP, these roles are created implicitly on the fly,
with no permissions assigned to the role.

UAC roles

4. In Blue Planet MCP releases prior to 18.02, it is not possible to assign UAC roles to LDAP users. This
has been fixed in tron:11.2.8 (BP MCP 18.02).

End

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1134
Blue Planet MCP API Reference Guide, Release 18.06 Administration

Administration
You can perform administration tasks using MCP REST APIs. The following topics are covered:

• Perform an offline backup of the MCP solution data

• Perform an offline restore of the MCP solution data using an offline backup file
• Perform an online backup of the MCP solution data
• Perform an offline restore of the MCP solution data using an online backup file
• Display a list of MCP solution backup files
• Download an MCP solution backup file
• Upload an MCP solution backup file
• Delete an MCP solution backup file
• Retrieve audit/forensic logs
• Changing the storage method for the NE maintenance profile
• Change the time zone setting
• Delete the time zone setting

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1135
Blue Planet MCP API Reference Guide, Release 18.06 Administration

Perform an offline backup of the MCP solution data

Use this procedure to perform an offline backup of the MCP solution data.

The backup operation takes a copy of all of the data under the /opt/ciena/bp2/*/data directories across
all hosts in the cluster where * represents the various applications under the MCP solution.

The backed up data includes but is not limited to:

• planning data
• equipment data
• service data
• user profiles
• alarm data
• performance data

Considerations

The offline backup functionality for the MCP solution has the following considerations:

CAUTION

Risk of disabling geographic redundant configuration

For a GR configuration, make sure that the data backup and restore operations are
both performed on a GR site.

If you try to perform a data restore to a GR site using a backup taken from a non-
GR site, you will disable the GR configuration.

• The data backup and restore operations must be performed for the same MCP release. For example, if
you try to restore data on an MCP 18.06 server using a backup file taken from an MCP 18.02 server,
the data restore will fail.
• The data backup operation saves the backup file on each host in the following default directory:
/opt/ciena/bp2/snapshots. The backup files are identical. The backup operation does not give you an
option to save the backup file in another directory or change the file name. The name of the backup
file includes a .snap extension.

Requirements

Before you perform this procedure, you must be able to log into the host machine using the bpuser user
account.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1136
Blue Planet MCP API Reference Guide, Release 18.06 Administration

Steps

1. Log into one of the hosts as bpuser user.

2. Enter the Solution Manager (solman):

solman

When logging into Host 0, a system output similar to the following displays:

Connecting smcli to solutionmanager_0

3. Verify the state of the MCP solution by entering:

sps

Example of system output:

Note: The system output includes more columns and rows but this example is not showing all of them
because of limited space on the page.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1137
Blue Planet MCP API Reference Guide, Release 18.06 Administration

artifactory.ciena.com.blueplanet.mcp:18.06.00-325

Image Container
State

artifactory.ciena.com/blueplanet/aeprocessorcontainer:2.4.17
aeprocessor_2.4.171_0 Started

artifactory.ciena.com/blueplanet/aeprocessorcontainer:2.4.17
aeprocessor_2.4.171_1 Started

artifactory.ciena.com/blueplanet/crinoid-api:1.4.7 api-
crinoid_1.4.7_0 Started

artifactory.ciena.com/blueplanet/crinoid-api:1.4.7 api-
crinoid_1.4.7_1 Started

artifactory.ciena.com/blueplanet/api-gw:2.9.4 api-gw_2.9.4_0
Started

artifactory.ciena.com/blueplanet/api-gw:2.9.4 api-gw_2.9.4_1
Started

artifactory.ciena.com/blueplanet/bp-nagios:18.06-10.8.7 bp-nagios_18.06-
10.8.7_0 Started

artifactory.ciena.com/blueplanet/bp-nagios:18.06-10.8.7 bp-nagios_18.06-
10.8.7_1 Started

artifactory.ciena.com/blueplanet/bp-nagios:18.06-10.8.7 bp-nagios_18.06-
10.8.7_2 Started

artifactory.ciena.com/blueplanet/bpo-configmgmt:1.2.8 bpo-
configmgmt_1.2.8_0 Started

artifactory.ciena.com/blueplanet/bpo-configmgmt:1.2.8 bpo-
configmgmt_1.2.8_1 Started

4. Select your next step.

If the state of the MCP Then

solution is shown as

Started stop the solution by entering (on a single line):

solution_stop artifactory.ciena.com.blueplanet.mcp:<version>

<version> is the version of the MCP solution.

- Example for a multi-host deployment: 18.06.00-325

- Example for a single-host deployment: 18.06.00-325-single

Stopped go to step 5

ATTENTION

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1138
Blue Planet MCP API Reference Guide, Release 18.06 Administration

The backup of the MCP solution can be a slow process. The system does not display status
updates until the backup process is complete. Be patient.

5. Back up the MCP solution data by entering:

api solutions artifactory.ciena.com.blueplanet.mcp:<version> stoppedbackup put

where

<version> is the version of the MCP solution.

- Example for a multi-host deployment: 18.06.00-325

- Example for a single-host deployment: 18.06.00-325-single

6. The offline backup operation produces a backup file on each host. Those files are identical. Copy one
of the backup files to a safe location.

A backup file is located on each host in the following directory: /opt/ciena/bp2/snapshots

The format of the backup file name is:

artifactory.ciena.com.blueplanet.mcp:<version>_stopped_<timestamp>.snap

Here is an example of a backup file name: artifactory.ciena.com.blueplanet.mcp:18.06.00-

325_stopped_2018-06-02T15:17:31Z.snap

7. Start the MCP solution by entering:

solution_start artifactory.ciena.com.blueplanet.mcp:<version>

where

<version> is the version of the MCP solution.

- Example for a multi-host deployment: 18.06.00-325

- Example for a single-host deployment: 18.06.00-325-single

End

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1139
Blue Planet MCP API Reference Guide, Release 18.06 Administration

Perform an offline restore of the MCP solution data using

an offline backup file
Use this procedure to perform an offline restore of the MCP solution data using the backup file that was
created with the procedure Performing an offline backup of the MCP solution data.

Considerations

The offline restore functionality for the MCP solution has the following considerations:

CAUTION

Risk of disabling geographic redundant configuration

For a GR configuration, make sure that the data backup and restore operations are
both performed on a GR site.

If you try to perform a data restore to a GR site using a backup taken from a non-
GR site, you will disable the GR configuration.

• You must perform a data restore for the same release as the data backup was taken from. For
example, if you try to restore data on an MCP 18.06 server using a backup file taken from an MCP
18.02 server, the data restore will fail.

Requirements

Before you perform this procedure, you must:

• be able to log into the host machine using the bpuser user account
• make sure that the system you are restoring to has a fresh software installation of the MCP solution
(includes no previous data). To force the fresh installation (no data) of the MCP solution, perform the
following steps as bpuser user:
1. Undeploy the current MCP Solution and purge the applications data by entering:

solution_undeploy artifactory.ciena.com.blueplanet.mcp:<version> --purge-host

-vols

2. Redeploy the MCP solution by entering:

solution_deploy artifactory.ciena.com.blueplanet.mcp:<version>

• have transferred the offline backup file to the /opt/ciena/bp2/snapshots directory of each host. The
restore process automatically looks in that directory for the backup file.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1140
Blue Planet MCP API Reference Guide, Release 18.06 Administration

Steps

1. Log into one of the hosts as bpuser user.

2. Enter the Solution Manager (solman):

solman

When logging into Host 0, a system output similar to the following displays:

Connecting smcli to solutionmanager_0

3. Verify the state of the MCP solution by entering:

sps

Example of system output:

Note: The system output includes more columns and rows but this example is not showing all of them
because of limited space on the page.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1141
Blue Planet MCP API Reference Guide, Release 18.06 Administration

artifactory.ciena.com.blueplanet.mcp:18.06.00-325

Image Container
State

artifactory.ciena.com/blueplanet/aeprocessorcontainer:2.4.17
aeprocessor_2.4.171_0 Started

artifactory.ciena.com/blueplanet/aeprocessorcontainer:2.4.17
aeprocessor_2.4.171_1 Started

artifactory.ciena.com/blueplanet/crinoid-api:1.4.7 api-
crinoid_1.4.7_0 Started

artifactory.ciena.com/blueplanet/crinoid-api:1.4.7 api-
crinoid_1.4.7_1 Started

artifactory.ciena.com/blueplanet/api-gw:2.9.4 api-gw_2.9.4_0
Started

artifactory.ciena.com/blueplanet/api-gw:2.9.4 api-gw_2.9.4_1
Started

artifactory.ciena.com/blueplanet/bp-nagios:18.06-10.8.7 bp-nagios_18.06-
10.8.7_0 Started

artifactory.ciena.com/blueplanet/bp-nagios:18.06-10.8.7 bp-nagios_18.06-
10.8.7_1 Started

artifactory.ciena.com/blueplanet/bp-nagios:18.06-10.8.7 bp-nagios_18.06-
10.8.7_2 Started

artifactory.ciena.com/blueplanet/bpo-configmgmt:1.2.8 bpo-
configmgmt_1.2.8_0 Started

artifactory.ciena.com/blueplanet/bpo-configmgmt:1.2.8 bpo-
configmgmt_1.2.8_1 Started

4. Select your next step.

If the state of the MCP Then

solution is shown as

Started stop the solution by entering (on a single line):

solution_stop artifactory.ciena.com.blueplanet.mcp:<version>

<version> is the version of the MCP solution.

- Example for a multi-host deployment: 18.06.00-325

- Example for a single-host deployment: 18.06.00-325-single

Stopped go to step 5

5. Restore the MCP solution data by entering (on a single line):

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1142
Blue Planet MCP API Reference Guide, Release 18.06 Administration

api solutions artifactory.ciena.com.blueplanet.mcp:<version> snapshots

<file_name> stoppedrestore post

where

<version> is the version of the MCP solution.

- Example for a multi-host deployment: 18.06.00-325

- Example for a single-host deployment: 18.06.00-325-single

<file_name> is the name of the backup file, for example,

artifactory.ciena.com.blueplanet.mcp:18.06.00-325 _stopped_2018-06-
02T15:17:31Z

Note: When the system generates a backup file, the name of the file
includes a .snap extension. In the restore command used in this step,
make sure to remove the .snap extension from the file name.

6. Start the MCP solution by entering:

solution_start artifactory.ciena.com.blueplanet.mcp:<version>

where

<version> is the version of the MCP solution.

- Example for a multi-host deployment: 18.06.00-325

- Example for a single-host deployment: 18.06.00-325-single

End

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1143
Blue Planet MCP API Reference Guide, Release 18.06 Administration

Perform an online backup of the MCP solution data

Use this procedure to perform an online backup of the MCP solution data. The online backup is done
without disabling the system.

The online data backup operation backs up the following data:

• planning data (project data, Oracle item number)

• equipment, service and NE inventory
• NE connection profiles
• user profiles
• user security data
• commissioning data
• configuration data

The online data backup operation does not back up the following data:

• historical alarm data

• historical performance monitoring (PM) data
• system logs
• security logs

Considerations

The online backup functionality for the MCP solution has the following considerations:

CAUTION

Risk of disabling geographic redundant configuration

For a GR configuration, make sure that the data backup and restore operations are
both performed on a GR site.

If you try to perform a data restore to a GR site using a backup taken from a non-
GR site, you will disable the GR configuration.

• The data backup and restore operations must be performed for the same MCP release. For example, if
you try to restore data on an MCP 18.06 server using a backup file taken from an MCP 18.02 server,
the data restore will fail.
• The data backup operation saves the backup file on each host in the following default directory:
/opt/ciena/bp2/snapshots. The backup files are identical. The backup operation does not give you an
option to save the backup file in another directory. The name of the backup file includes a .snap
extension. When providing the backup file name as input for a restore, omit the .snap extension.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1144
Blue Planet MCP API Reference Guide, Release 18.06 Administration

Requirements

Before you perform this procedure, you must:

• be able to log into a host machine using the bpuser user account
• be a user with the assigned Network Admin role. This role is required to run REST API calls in an
application such as Postman.
• have access to a REST API application such as Postman

Steps

CAUTION

Risk of a failed data backup

Do not perform a data backup while any of the following operations are in
progress:

• committing a planning project

• planning a service
• deploying a service (manual or scheduled)
• commissioning

1. Select your next step:

If you want to use the Then go to

bpi script step 2

API step 5

2. Log in to Host 0 as bpadmin and navigate to the /home/bpadmin/bpi directory.

3. Start the script by entering:

./bpi --backup

4. When the backup is complete, go to step 10.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1145
Blue Planet MCP API Reference Guide, Release 18.06 Administration

5. As the bpuser user, log into one of the hosts.

ATTENTION

The backup of the MCP solution can be a slow process. The system does not display status
updates until the backup process is complete. Be patient.

6. As a user with the assigned Network Admin role, open a REST API application such as Postman.
7. Create and define the following parameters:

solutionName {{SOLUTION_NAME}}

label {{text}}

where

{{SOLUTION_NAME}} is the MCP solution name and version.

- Example for a multi-host deployment:

artifactory.ciena.com.blueplanet.mcp:18.06.00-325

- Example for a single-host deployment:

artifactory.ciena.com.blueplanet.mcp:18.06.00-325-single

{{text}} is an optional user-defined label to be included in the backup file name. If

you do not provide a label, the system uses unlabeled.

If you want to include a label, this label must not contain a space,
underscore, slash or backslash.

Example of Application/JSON -raw

{"solutionName":"artifactory.ciena.com.blueplanet.mcp:18.06.00-325",
"label":"RestApiBackup"}

Example of equivalent curl command:

curl -X POST \
https://10.92.14.188/backupservice/api/v1/backup \
-H 'Authorization: Bearer 7c1419208814df43dff7' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
-H 'Postman-Token: 4aab647f-b92e-4223-8931-19655d9218fa' \
-d '{"solutionName":"artifactory.ciena.com.blueplanet.mcp:18.06.00-325",
"label":"RestApiBackup"}'

8. Associate the solutionName and label (optional) parameter with the following command and start the
online backup by entering:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1146
Blue Planet MCP API Reference Guide, Release 18.06 Administration

{{MCP_SERVER}}/backupservice/api/v1/backup

where

{{MCP_SERVER}} is the URL of the MCP server that has the backup service running, for
example https://localhost

The type of URL request is POST.

You are sending a URL request to a specific host because this backup
solution is not scaled.

In a multihost environment, a copy of the snapshot will be stored on each

host.

Example of system output:

Note: The system output includes an id. An id remains valid only as long as the backup solution is
running.

{
"solutionName":"artifactory.ciena.com.blueplanet.mcp:18.06.00-325"
}

{
"data": {
"type": "BackupJobRO",
"id": "1004",
"links": {},
"attributes": {
"solutionName": "artifactory.ciena.com.blueplanet.mcp:18.06.00-325",
"state": "Backing up",
"snapshots": []
}
},
"links": {},
"meta": {}
}

9. The backup process has three states: Backing up, Succeeded, and Aborted. You can get an update on
the state of the backup process by entering:

{{MCP_SERVER}}/backupservice/api/v1/backup/{{ID}}

where

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1147
Blue Planet MCP API Reference Guide, Release 18.06 Administration

{{MCP_SERVER}} is the URL of the MCP server that has the backup service running, for
example https://localhost

The type of URL request is GET.

You are sending a URL request to a specific host because this backup
solution is not scaled.

{{ID}} is the ID of the backup process, for example 1004

Note: Both backup and restore jobs use long identifiers. It is technically possible for these ids to
overlap. For example both backup and restore jobs could share the 5000 id. This is not harmful to the
operation of the backup and restore service; GET backup calls will still return the matching backup
jobs and GET restore calls will still return restore jobs.

Example of system output. In this example, the state is Succeeded.

{
"data": {
"type": "BackupJobRO",
"id": "1004",
links": {},
"attributes": {
"solutionName": "artifactory.ciena.com.blueplanet.mcp:18.06.00-325",
"state": "Succeeded",
"snapshots": [
"artifactory.ciena.com.blueplanet.mcp:18.06.00-325_unlabeled_2018-05-
02T19:39:35Z"
]
}
},
"links": {},
"meta": {}
}

10. The online backup operation produces a backup file on each host. Those files are identical. Copy one
of the backup files to a safe location.

A backup file is located on each host in the following directory: /opt/ciena/bp2/snapshots

The format of the backup file name is:

artifactory.ciena.com.blueplanet.mcp:<version>_<label>_<timestamp>.snap

Here is an example of a backup file name: artifactory.ciena.com.blueplanet.mcp:18.06.00-

325_unlabeled_2018-05-02T15:17:31Z.snap

Saving the IFDConfiguration file (if applicable)

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1148
Blue Planet MCP API Reference Guide, Release 18.06 Administration

11. On each host:

a. Determine whether the Intent Fulfillment Designer (IFD) instance exists or not by entering:

docker ps | grep ifd

A system output similar to the following displays.

1db2eb626327 artifactory.ciena.com/blueplanet/ifd: 2.2.20 --------- ifd_2.2.20_0

b. Select your next step:

If the IFD instance Then

exists take note of the IFD instance.

Example: ifd_2.2.20_0

does not exist there is no IFDConfiguration file to copy for that host. You have
completed this procedure for that host.

c. Copy the IFDConfiguration file to the /opt/ciena/bp2/snapshots folder by entering (on a single
line):

cp /opt/ciena/bp2/<ifd_instance>/data/yeti/config/server-
config/IFDConfiguration/opt/ciena/bp2/snapshots

where

<ifd_instance> is for example, ifd_2.2.20_0 (as recorded in step 11 b).

End

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1149
Blue Planet MCP API Reference Guide, Release 18.06 Administration

Perform an offline restore of the MCP solution data using

an online backup file
Use this procedure to perform an offline restore of the MCP solution data using the backup file that was
created with the procedure Performing an online backup of the MCP solution data.

Considerations

The offline restore functionality for the MCP solution has the following considerations:

CAUTION

Risk of disabling geographic redundant configuration

For a GR configuration, make sure that the data backup and restore operations are
both performed on a GR site.

If you try to perform a data restore to a GR site using a backup taken from a non-
GR site, you will disable the GR configuration.

• You must perform a data restore for the same release as the data backup was taken from. For
example, if you try to restore data on an MCP 18.06 server using a backup file taken from an MCP
18.02 server, the data restore will fail.

Requirements

Before you perform this procedure, you must:

• be able to log into the host machine using the bpuser user account
• make sure that the system you are restoring to has a fresh software installation of the MCP solution
(includes no previous data). To force the fresh installation (no data) of the MCP solution, perform the
following steps as bpuser user:
1. Undeploy the current MCP Solution and purge the applications data by entering:

solution_undeploy artifactory.ciena.com.blueplanet.mcp:<version> --purge-host

-vols

2. Redeploy the MCP solution by entering:

solution_deploy artifactory.ciena.com.blueplanet.mcp:<version>

• be a user with the assigned Network Admin role. This role is required to run REST API calls in an
application such as Postman.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1150
Blue Planet MCP API Reference Guide, Release 18.06 Administration

• have access to a REST API application such as Postman

• have transferred the online backup file to the /opt/ciena/bp2/snapshots directory of each host. The
restore process automatically looks in that directory for the backup file.

Steps

1. Select your next step:

If you want to use Then go

a curl command step 2

a REST API application such as Postman step 4

2. Restore the MCP solution data by entering (on a single line):

curl -X POST -H "Content-Type:application/json" -d '{"solutionName":

"artifactory.ciena.com.blueplanet.mcp:<version>",
"solutionSnapshot":"<file_name>"}' localhost/backupservice/api/v1/restore

where

<version> is the version of the MCP solution that you are restoring to.

Examples for 18.06.00:

• single-host: 18.06.00-359-single
• multi-host: 18.06.00-359

<file_name> is the name of the backup file.

3. Go to step 7.
4. As a user with the assigned Network Admin role, open a REST API application such as Postman.
5. Create and define the following parameters:

solutionName {{SOLUTION_NAME}}

solutionSnapshot {{SOLUTION_SNAPSHOT}}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1151
Blue Planet MCP API Reference Guide, Release 18.06 Administration

where

{{SOLUTION_ NAME}} is the MCP solution name and version.

- Example for a multi-host deployment:

artifactory.ciena.com.blueplanet.mcp:18.06.00-325

- Example for a single-host deployment:

artifactory.ciena.com.blueplanet.mcp:18.06.00-325-single

{{SOLUTION_SNAPSHOT}} is the file name of the backup file. Do not include the .snap extension.

• Example for a multi-host deployment:

artifactory.ciena.com.blueplanet.mcp:18.06.00-
325_unlabeled_2018-05-31T20:15:51Z
• Example for a single-host deployment:
artifactory.ciena.com.blueplanet.mcp:18.06.00-325-
single_unlabeled_2018-05-31T20:15:51Z

Example of Application/JSON -raw

{"solutionName":"artifactory.ciena.com.blueplanet.mcp:18.06.00-325",
"solutionSnapshot":"artifactory.ciena.com.blueplanet.mcp:18.06.00-
325_RestApiBackup_2018-03-27T21:09:14Z"}

Example of equivalent curl command:

curl -X POST \
https://10.92.14.188/backupservice/api/v1/restore \
-H 'Authorization: Bearer 7c1419208814df43dff7' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
-H 'Postman-Token: a81aa601-15f0-407e-8978-f0d1e797b951' \
-d '{"solutionName":"artifactory.ciena.com.blueplanet.mcp:18.06.00-325",
"solutionSnapshot":"artifactory.ciena.com.blueplanet.mcp:18.06.00-
325_RestApiBackup_2018-03-27T21:09:14Z"}'

6. Associate the solutionName and solutionSnapshot parameters with the following command and start
the offline restore by entering:

{{MCP_SERVER}}/backupservice/api/v1/restore

where

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1152
Blue Planet MCP API Reference Guide, Release 18.06 Administration

{{MCP_SERVER}} is the URL of the MCP server that has the backup service running, for
example https://localhost

The type of URL request is POST.

Example of system output:

{
"solutionName": "artifactory.ciena.com.blueplanet.mcp:18.06.00-325",
"solutionSnapshot":
"artifactory.ciena.com.blueplanet.mcp:18.06.00-325_unlabeled_2018-05-
31T20:15:51Z"
}
{
"data": {
"type": "RestoreJobRO",
"id": "5003",
"links": {},
"attributes": {
"solutionName": "artifactory.ciena.com.blueplanet.mcp:18.06.00-325",
"state": "Restoring"
}
},
"links": {},
"meta": {}
}

7. The restore process has three states: Restoring, Succeeded, and Aborted. You can get an update on
the state of the restore process by entering:

{{MCP_SERVER}}/backupservice/api/v1/restore/{{ID}}

where

{{MCP_SERVER}} is the URL of the MCP server that has the backup service running, for
example https://localhost

The type of URL request is GET.

{{ID}} is the ID of the restore process, for example 5003

Note 1: Both backup and restore jobs use long identifiers. It is technically possible for these ids to
overlap. For example both backup and restore jobs could share the 5000 id. This is not harmful to the
operation of the backup and restore service; GET backup calls will still return the matching backup
jobs and GET restore calls will still return restore jobs.

Note 2: The system can display an intermittent 403(Forbidden) error during the restore status query,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1153
Blue Planet MCP API Reference Guide, Release 18.06 Administration

due to the tron service being shutdown and restarted. This system behavior can last a few minutes
after sending a restore request.

Example of system output. In this example, the state is Restoring.

{
"data": {
"type": "RestoreJobRO",
"id": "5003",
"links": {},
"attributes": {
"solutionName": "artifactory.ciena.com.blueplanet.mcp:18.06.00-325",
"state": "Restoring"
}
},
"links": {},
"meta": {}
}

8. Alternatively, you can use a curl command to get an update on the state of the restore process by
entering:

curl -X GET localhost/backupservice/api/v1/restore/{{ID}} |python -m json.tool

9. The restore process restarts the MCP solution. When the restart of the MCP solution is complete,
create and define the following parameters:

username {{USERNAME}}

password {{PASSWORD}}

10. Associate the username and password parameters with the following command and then request a
new authentication token by entering:

{{MCP_SERVER}}/tron/api/v1/tokens

where

{{MCP_SERVER}} is the URL of the MCP server that has the backup service running, for
example https://localhost

The type of URL request is POST.

Restoring the IFDConfiguration file (if applicable)

11. On each host, determine whether the Intent Fulfillment Designer (IFD) instance exists or not by

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1154
Blue Planet MCP API Reference Guide, Release 18.06 Administration

entering:

docker ps | grep ifd

Example of system output:

1db2eb626327 artifactory.ciena.com/blueplanet/ifd: 2.2.20 --------- ifd_2.2.20_0

12. Select your next step.

If the IFD instance Then

exists take note of the IFD instance.

Example: ifd_2.2.20_0

does not exist there is no IFDConfiguration file to restore for that host. Repeat step
11 for the next host. To restore the IFDConfiguration file, perform
step 13.

13. Restore the IFDConfiguration file by entering (on a single line):

cp
/opt/ciena/bp2/snapshots/IFDConfiguration/opt/ciena/bp2/<ifd_instance>/data/yeti
/config/server-config/IFDConfiguration

where

<ifd_instance> is for example, ifd_2.2.20_0 (as recorded in step 11).

End

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1155
Blue Planet MCP API Reference Guide, Release 18.06 Administration

Display a list of MCP solution backup files

Use this procedure to display a list of MCP solution backup files.

Requirements

Before you perform this procedure, you must

• be able to log into the host machine using the bpuser user account
• perform one of the following procedures: Performing an offline backup of the MCP solution data or
Performing an online backup of the MCP solution data

Steps

1. Log into one of the hosts as bpuser.

2. Enter the Solution Manager (solman):

solman

When logging into Host 0, a system output similar to the following displays:

Connecting smcli to solutionmanager_0

3. Display a list of the backup files by entering:

api snapshots get

4. Identify the backup files. Each line that starts with path identifies a backup file.

Example of system output:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1156
Blue Planet MCP API Reference Guide, Release 18.06 Administration

[{'files': ['.',
'./geored_1.8.4_0',
'./pithos_0.0.26_0',
'./discovery_8.0.10_0',
'./tron_1806.0.7-t12.0.4_0',
'./nsi_7.0.69_0',
'./chronos_7.2.14_0',
'./aeprocessor_2.4.61_0',
'./cassandra_3.0.21-c3.10_0',
'./gcs_1.1.18_0',
'./hpmra_1.0.25_0',
'./tdc_13.12.0_0',
'./kafka_3.0.0-k1.0.0-nogcs-1_0',
'./datomic_3.0.2-d0.9.5544-1_0',
'./bpocore_1.8.2-8608-972f799-2_0',
'./api-crinoid_1.4.7-1_0',
'./configmgmt_2.1.4_0',
'./reporting_2.0.0_0',
'./slv-support_1.0.82_0',
'./ifd_4.1.17-1_0'],
'label': 'unlabeled',
'name': 'artifactory.ciena.com.blueplanet.mcp:18.06.00-85-
single_unlabeled_2018-06-21T16:53:52Z',
'path':
'/opt/ciena/bp2/snapshots/artifactory.ciena.com.blueplanet.mcp:18.06.00-85-
single_unlabeled_2018-06-21T16:53:52Z.snap',
'solution': 'artifactory.ciena.com.blueplanet.mcp:18.06.00-85-single',
'solution_type': 'mcp',
'timestamp': '2018-06-21T16:53:52Z'},
{'files': ['.',
'./geored_1.8.4_0',
'./pithos_0.0.26_0',
'./discovery_8.0.10_0',
'./tron_1806.0.7-t12.0.4_0',
'./nsi_7.0.69_0',
'./chronos_7.2.14_0',
'./aeprocessor_2.4.61_0',
'./cassandra_3.0.21-c3.10_0',
'./gcs_1.1.18_0',
'./hpmra_1.0.25_0',
'./tdc_13.12.0_0',
'./kafka_3.0.0-k1.0.0-nogcs-1_0',
'./datomic_3.0.2-d0.9.5544-1_0',
'./bpocore_1.8.2-8608-972f799-2_0',
'./api-crinoid_1.4.7-1_0',
'./configmgmt_2.1.4_0',
'./reporting_2.0.0_0',
'./slv-support_1.0.82_0',
'./ifd_4.1.17-1_0'],
'label': 'unlabeled',
'name': 'artifactory.ciena.com.blueplanet.mcp:18.06.00-85-
single_unlabeled_2018-06-21T19:10:03Z',
'path':
'/opt/ciena/bp2/snapshots/artifactory.ciena.com.blueplanet.mcp:18.06.00-85-
single_unlabeled_2018-06-21T19:10:03Z.snap',
'solution': 'artifactory.ciena.com.blueplanet.mcp:18.06.00-85-single',
'solution_type': 'mcp',
'timestamp': '2018-06-21T19:10:03Z'}]

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1157
Blue Planet MCP API Reference Guide, Release 18.06 Administration

End

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1158
Blue Planet MCP API Reference Guide, Release 18.06 Administration

Download an MCP solution backup file

Use this procedure to download an MCP solution backup file. You are iniating commands from an MCP
host or offsite machine to download a copy of a backup file from an MCP site.

Requirements

Before you perform this procedure, you must

• be able to log into an MCP host or offsite machine where you can run a curl command to download a
backup file from an MCP site
• know the site IP address of the MCP site that is storing the backup file that you want to download
• know the name of the backup file that you want to download (for details see the Display a list of MCP
solution backup files procedure).
• perform one of the following procedures: Performing an offline backup of the MCP solution data or
Performing an online backup of the MCP solution data

Steps

1. Log into an MCP host or offsite machine to which you want to download an MCP solution backup file.
2. Start the download of an MCP solution backup file by entering (on a single line):

curl -o {{BACKUP_FILE}}
{{SERVER}}/solutionmanager/api/v1/snapshots/{{BACKUP_NAME}}/download

where

{{BACKUP_FILE}} is the backup file that you want to download.

{{BACKUP_FILE}} = {{BACKUP_NAME}}.snap

Example: artifactory.ciena.com.blueplanet.mcp:18.06.00-
85_unlabeled_2018-06-21T16:53:52Z.snap

{{SERVER}} is the URL of the MCP server from which you want to download the
backup file.

Make sure to use the virtual Site IP address (not the IP address of the
host) in the URL, for example https://10.186.0.4

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1159
Blue Planet MCP API Reference Guide, Release 18.06 Administration

{{BACKUP_NAME}} is the name of the backup file, without the .snap extension.

Example: artifactory.ciena.com.blueplanet.mcp:18.06.00-
85_unlabeled_2018-06-21T16:53:52Z

3. An HTTP 200 response indicates that the MCP solution backup file was successfully downloaded.

End

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1160
Blue Planet MCP API Reference Guide, Release 18.06 Administration

Upload an MCP solution backup file

Use this procedure to upload an MCP solution backup file. You are iniating commands from the MCP host
that is storing the backup file and then uploading a copy of that file to an another MCP site or offsite
machine.

Requirements

Before you perform this procedure, you must

• be able to log into an MCP host where you can run a curl command to upload a backup file to another
MCP site or offsite machine
• know the site IP address of the MCP site or the IP address of the offsite machine to which you want to
upload the backup file
• know the name of the backup file that you want to upload (for details see the Display a list of MCP
solution backup files procedure).
• perform one of the following procedures: Performing an offline backup of the MCP solution data or
Performing an online backup of the MCP solution data

Steps

1. Locate the MCP site that has the MCP solution backup file that you want to upload and log into one of
the hosts.
2. Start the upload of an MCP solution backup file by entering (on a single line):

curl -i -X POST -H "Content-Type: multipart/form-data" -F

"data=@{{BACKUP_FILE}}"
{{SERVER}}/solutionmanager/api/v1/snapshots/upload?snapshot={{BACKUP_NAME}}

where

{{BACKUP_FILE}} is the backup file that you want to upload.

{{BACKUP_FILE}} = {{BACKUP_NAME}}.snap

Example: artifactory.ciena.com.blueplanet.mcp:18.06.00-
85_unlabeled_2018-06-21T16:53:52Z.snap

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1161
Blue Planet MCP API Reference Guide, Release 18.06 Administration

{{SERVER}} is the URL of the MCP site or offsite machine to which you want to
upload the backup file, for example https://10.186.0.4

If you are uploading a backup file to an MCP site, then make sure to
use the virtual Site IP address (not the IP address of a host) in the
URL.

{{BACKUP_NAME}} is the name of the backup file, without the .snap extension.

Example: artifactory.ciena.com.blueplanet.mcp:18.06.00-
85_unlabeled_2018-06-21T16:53:52Z

3. An HTTP 200 response indicates that the MCP solution backup file was successfully uploaded.

End

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1162
Blue Planet MCP API Reference Guide, Release 18.06 Administration

Delete an MCP solution backup file

Use this procedure to delete an MCP solution backup file.

Requirements

Before you perform this procedure, you must

• be able to log into the host machine using the bpuser user account
• know the name of the backup file that you want to delete (for details see the Display a list of MCP
solution backup files procedure).
• perform one of the following procedures: Performing an offline backup of the MCP solution data or
Performing an online backup of the MCP solution data

Steps

1. Log into one of the hosts as bpuser.

2. Enter the Solution Manager (solman):

solman

When logging into Host 0, a system output similar to the following displays:

Connecting smcli to solutionmanager_0

3. Delete a backup file by entering:

api snapshots {{BACKUP_NAME}} delete

where

{{BACKUP_NAME}} is the name of the backup file, without the .snap extension.

Example: artifactory.ciena.com.blueplanet.mcp:18.06.00-
85_unlabeled_2018-06-21T16:53:52Z

The system deletes the backup file from each host in an MCP cluster, if applicable.

End

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1163
Blue Planet MCP API Reference Guide, Release 18.06 Administration

Retrieve audit/forensic logs

To retrieve audit/forensic logs for analysis, use the API authorization API.

Use this API to enable/disable the addition of HTTP bodies in the audit logs for every API request and
response entering and leaving the system.

Requirements

To enable full logging for request and response HTTP bodies, make sure you specify the following
parameter:

• enable = true

The maximum request body size logged is 8K. Bodies larger than 8K are truncated.

Sample request

POST {{MCP_SERVER}}/rbac-e/api/v1/audit/configuration

Here is a sample request log:

Sample response

Here is a sample response log:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1164
Blue Planet MCP API Reference Guide, Release 18.06 Administration

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1165
Blue Planet MCP API Reference Guide, Release 18.06 Administration

Changing the storage method for the NE maintenance

profile
To change the storage method for the NE maintenance profile for a backup and restore, use this API to
select filesystem or database.

Use the following REST API to select the storage method as filesystem:

POST {{BP_SERVER}}/configmgmt/api/v1/profiles

Sample response

{
"name": "BACKUP-sftp2",
"profileType": "backup_restore",
"protocolType": "sftp",
"storageMethod": "filesystem",
"userName": "root",
"userPassword": "G0t2BTuf",
"ipAddress": "10.186.1.130",
"port": "22",
"imageLocation": "/tmp/upg",
"numberOfBackupFiles": "9",
"profileDescription" : "ATT",
"sshPort": "22"
}

Use the following REST API to select the storage method as database:

Requirements

Before you start this API, make sure that the

• username and the user password are the valid userid/password on the host running the MCP Solution
• user must have write permission to the /bp2/ directory

POST {{BP_SERVER}}/configmgmt/api/v1/profiles

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1166
Blue Planet MCP API Reference Guide, Release 18.06 Administration

{
"name": "testgosftp",
"profileType": "backup_restore",
"protocolType": "sftp",
"userName": "root",
"userPassword": "G0t2BTuf",
"storageMethod": "database"
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1167
Blue Planet MCP API Reference Guide, Release 18.06 Administration

Change the time zone setting

To change the time zone setting, use the Global Config Service API:

Sample request

PATCH {{MCP_SERVER}}/gcs/api/v1/config

Specify the time zone in the "value" parameter.

The Coordinated Universal Time (UTC) is +00:00. You are setting the "value" parameter as an offset
(difference) from the UTC.

For example, if you want to set the time zone to the Pacific Standard Time (PST), then enter "-08:00".

With the "value" set as "local", the MCP UI displays the local time zone used by your browser.

[{
“application”: “global-ui”,
“instance”:”-“,
“name”:”displayTimezone”,
“value”:”-08:00”
}]

Sample response

Status Code: 200 OK

[{
“application”: “global-ui”,
“instance”:”-“,
“name”:”displayTimezone”,
“title”: “Display Timezone”,
“description”: ”Timezone for all UIs”,
“value”:”-08:00”,
“key”:”global-ui/-/displayTimezone”,
}]

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1168
Blue Planet MCP API Reference Guide, Release 18.06 Administration

Delete the time zone setting

To delete the time zone setting, use the Global Config Service API:

Sample request

DELETE {{MCP_SERVER}}/gcs/api/v1/config

[{
“application”: “global-ui”,
“instance”:”-“,
“name”:”displayTimezone”
}]

Sample response

Status Code: 200 OK

[{
“application”: “global-ui”,
“instance”:”-“,
“name”:”displayTimezone”,
“title”: “Display Timezone”,
“description”: ”Timezone for all UIs”,
“key”:”global-ui/-/displayTimezone”,
}]

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1169
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

Alarm management
You can manage alarms using MCP REST APIs.

Top level events

The top level event includes the following types:

For example: "_type": "bp.v1.alarmSuperseded",

Table 30. Top level events

TYPE DESCRIPTION

"bp.v1.alarmRaised", an alarm is raised to an active state

"bp.v1.alarmCleared", an alarm is cleared

"bp.v1.alarmSuperseded", an alarm was raised over top of an existing active

alarm without clearing the first. The alarm in the
event is the newly raised alarm.

"bp.v1.alarmAcknowledged", an alarm is acknowledged

"bp.v1.alarmUnacknowledged", an alarm is unacknowledged

"bp.v1.alarmDeviceAttr" the device changed attributes (for example:

device-name, ip-address, mac-address, device-id,
device-long-name)

Top level event - sample JSON

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1170
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Device",
"javaType":
"com.ciena.bp.nsa.api.v2.common.event.FilteredAlarmNotificationEvent",
"type": "object",
"description": "The kafka notification event for FilteredAlarms on the Northbound
topic bp.aeprocessor.v2_0.alarms",
"properties": {
"_type": {
"title": "Type",
"description": "The type of alarm notifcation event",
"type": "string",
"enum": [
"bp.v1.alarmRaised",
"bp.v1.alarmCleared",
"bp.v1.alarmSuperseded",
"bp.v1.alarmAcknowledged",
"bp.v1.alarmUnacknowledged",
"bp.v1.alarmDeviceAttr"
],
"javaEnumNames": [
"RAISE_ALARM_EVENT",
"CLEAR_ALARM_EVENT",
"SUPERSEDE_ALARM_EVENT",
"ACK_ALARM_EVENT",
"UNACK_ALARM_EVENT",
"DEVICE_ATTR_ALARM_EVENT"
]
},
"time": {
"title": "Time",
"type": "string"
},
"alarm": {
"title": "Alarm",
"description": "The alarm associated with the event",
"type": "object",
"$ref": "../filter/FilteredAlarm.json"
}
},
"additionalProperties": false
}

Filtered alarm - sample JSON

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1171
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Filtered Alarm",
"type": "object",
"javaInterfaces" : ["java.io.Serializable"],
"javaType": "com.ciena.bp.nsa.api.v2.common.filter.FilteredAlarm",
"properties": {
"data": {
"type": "object",
"$ref": "FilteredAlarmsData.json"
}
},
"additionalProperties": false
}

Filtered alarm data - sample JSON

{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Filtered Alarms Data",
"type": "object",
"javaInterfaces" : ["java.io.Serializable"],
"javaType": "com.ciena.bp.nsa.api.v2.common.filter.FilteredAlarmsData",
"properties": {
"id": {
"description": "The unique identifier for the alarm",
"type": "string"
},
"type": {
"type": "string",
"enum": [
"FilteredAlarm"
],
"javaEnumNames": ["FilteredAlarm"],
"default": "FilteredAlarm"
},
"attributes": {
"type": "object",
"description": "Information regarding the individual alarms",
"$ref": "FilteredAlarmsAttributes.json"
}
},
"additionalProperties": false
}

Filtered alarm attributes - sample JSON

{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Filtered Alarms Attributes",
"javaInterfaces" : ["java.io.Serializable"],

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1172
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

"type": "object",
"javaType": "com.ciena.bp.nsa.api.v2.common.filter.FilteredAlarmsAttributes",
"properties": {
"id": {
"description": "The alarm id",
"type": "string"
},
"alarm-id": {
"description": "The original alarm id of the historical alarm",
"type": "string"
},
"node-id": {
"description": "The unique ID associated with the node/device provided by the
RA",
"type": "string"
},
"ra-alarm-id": {
"description": "The RA Alarm identifier",
"type": "string"
},
"node-type": {
"description": "The type of node/device, e.g. 6500",
"type": "string"
},
"state" : {
"type": "string",
"description": "The alarm state",
"enum": [
"ACTIVE",
"CLEARED",
"SUPERSEDED"
],
"javaEnumNames": [
"ACTIVE",
"CLEARED",
"SUPERSEDED"
]
},
"resource": {
"type": "string",
"description": "The location and equipment type"
},
"resource-id": {
"type": "string",
"description": "The a unique id of the resource sending the alarm"
},
"native-condition-type": {
"type": "string",
"description": "The native condition or alarm name"
},
"condition-severity": {
"type": "string",
"description": "The severity of the alarm",
"enum": [
"CRITICAL",
"MAJOR",
"MINOR",
"WARNING",
"INDETERMINATE",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1173
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

"INFO",
"CONFIG",
"DEBUG"
],
"javaEnumNames": [
"CRITICAL",
"MAJOR",
"MINOR",
"WARNING",
"INDETERMINATE",
"INFO",
"CONFIG",
"DEBUG"
]
},
"service-affecting": {
"type": "string",
"description": "The service impact of the alarm",
"enum": [
"UNKNOWN",
"SERVICE_AFFECTING",
"NON_SERVICE_AFFECTING"
],
"javaEnumNames": [
"UNKNOWN",
"SERVICE_AFFECTING",
"NON_SERVICE_AFFECTING"
]
},
"native-state": {
"description": "The native state",
"type": "string"
},
"manual-clearable": {
"type": "boolean",
"description": "Whether or not the alarm can be cleared manually"
},
"additional-text": {
"type": "string",
"description": "Additional information about the alarm"
},
"first-raise-time": {
"type": "string",
"description": "The date and time that the alarm was first raised",
"format": "date-time",
"customDateTimePattern" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"
},
"last-raise-time": {
"type": "string",
"description": "The date and time that the alarm was last raised",
"format": "date-time",
"customDateTimePattern" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"
},
"clear-time": {
"type": "string",
"description": "The date and time that the alarm was cleared",
"format": "date-time",
"customDateTimePattern" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"
},

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1174
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

"supersede-time": {
"type": "string",
"description": "The date and time that the alarm was superseded",
"format": "date-time",
"customDateTimePattern" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"
},
"acknowledge-update-time": {
"type": "string",
"description": "The date and time that the alarms acknowledge state last
changed",
"format": "date-time",
"customDateTimePattern" : "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"
},
"clear-user": {
"type": "string",
"description": "The user that cleared the alarm"
},
"acknowledge-update-user": {
"type": "string",
"description": "The user that last updated the acknowledge state the alarm"
},
"number-of-occurrences": {
"type": "string",
"description": "The number of times the alarm has occurred",
"format": "utc-millisec"
},
"acknowledge-state": {
"type": "string",
"description": "The acknowledge state of the alarm",
"enum": [
"NOT_ACKNOWLEDGED",
"ACKNOWLEDGED"
],
"javaEnumNames": [
"NOT_ACKNOWLEDGED",
"ACKNOWLEDGED"
]
},
"device-id": {
"type": "string",
"description": "Device's id."
},
"device-name": {
"type": "string",
"description": "Device's name."
},
"device-long-name": {
"type": "string",
"description": "Device's long name."
},
"ip-address": {
"type": "string",
"description": "Device's IP address."
},
"mac-address": {
"type": "string",
"description": "Device's Mac address."
},
"partition": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1175
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

"type": "array",
"items": {
"type": "string"
},
"description": "The partitions that the device belongs to."
},
"device-attributes": {
"type": "object",
"description": "Device specific attributes for the alarm",
"additionalProperties": {
"type": "string"
}
},
"additional-attrs": {
"type": "object",
"description": "Additional attributes for the alarm",
"additionalProperties": {
"type": "string"
}
},
"affected-inventory-ids": {
"type": "array",
"description": "Inventory IDs affected by alarms",
"items": {
"type": "string"
}
},
"sequence-id": {
"type": "string",
"description": "The alarm's sequence ID, the last-raise-time of that alarm
instance in long."
}
},
"additionalProperties": false
}

Alarm data structure and attributes

Included in this section is an example of an alarm’s data structure followed by Table 2 - Alarm and event
attributes which describes the individual alarm/event attributes.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1176
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

{
"data": {
"id": "-11783837587299599",
"type": "FilteredAlarm",
"attributes": {
"id": "-11783837587299599",
"alarm-id": "-11783837587299599",
"node-id": "608b2401-85ef-4a23-b970-7969c3099c17",
"ra-alarm-id": "0100008849-0008-0560",
"node-type": "6500",
"state": "ACTIVE",
"resource": "OPTMON-1-11-5S11",
"resource-id": "OPTMON-1-11-5S11",
"native-condition-type": "LOS_OTS",
"condition-severity": "MAJOR",
"service-affecting": "SERVICE_AFFECTING",
"native-state": "online",
"manual-clearable": true,
"additional-text": "Loss Of Signal",
"first-raise-time": "2018-06-20T13:18:49.000Z",
"last-raise-time": "2018-06-23T16:22:18.000Z",
"supersede-time": "2018-06-21T13:18:49.000Z",
"clear-time": "2018-06-23T17:22:18.000Z",
"number-of-occurrences": 11,
"acknowledge-state": "NOT_ACKNOWLEDGED",
"device-id": "c30eea58-9568-3e31-af3c-667561e60646",
"device-name": "PV0011CRFA",
"device-long-name": "PV0011CRFA",
"ip-address": "10.182.216.71",
"mac-address": "40:AB:00:11:01:00",
"additional-attrs": {
"mode": "NONE",
"aidtype": "OPTMON",
"location": "NEND",
"source": "6500:OPTMON-1-11-5S11",
"direction": "RCV"
},

Table 31. Alarm and event attributes

ATTRIBUTE DESCRIPTION

id The MCP identifier of this notification in MCP (for

example, the raise or clear of an alarm/event).

alarm-id The MCP identifier of this alarm in MCP. This is

the MCP ID of the raise alarm.

Note: The example is an alarm clear; as a result,

this identifier does not match the 'id' field above.

node-id The MCP identifier (UUID) of the management

session object handling the connection to the
device.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1177
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

ATTRIBUTE DESCRIPTION

ra-alarm-id The alarm identifier from the device.

In the example, a 6500 provides a three part value

of alarm (for example, 0100000171-0008-1586):

- instance number (0100000171). This is the

occurence identifier of the alarm on the device.

- probable cause (0008). MCP does not use this

value.

- documentation identifier (1586). This attribute

corresponds to an alarm identifier in the 6500
alarm clearing documentation. In this example,
'1586' corresponds to Loss Of Signal (OTM1,
OTM2, OTM3, OTM4, PTP) in 6500 Packet-Optical
Platform Fault Management - Alarm Clearing, Part 2
of 2, 323-1851-543.

Note: Other devices provide alternate formats.

node-type The device type. For example, 6500, 8700 and

Waveserver.

state The state of the alarm (RAISED, CLEARED,

SUPERSEDED).

resource The device-specific description of the source of

the alarm. For 6500, this is a TL1 AID. In this
example, the resource is the OTM4 facility on
logical shelf 151, slot 4, port 1.

resource-id If a UUID is available, this identifier is the UUID for

the resource. For some devices, resource-id is a
copy of the resource string or is empty.

native-condition-type The device-specific condition code. For 6500, this

is the condition type, which is an abbreviation. For
other devices, native-condition-type may be a copy
of the alarm description.

condition-severity The alarm severity (CRITICAL, MAJOR, MINOR,

WARNING, CONFIG, INFO, DEBUG).

service-affecting The device indication of whether the alarm could

be service affecting (SERVICE_AFFECTING,
NON_SERVICE_AFFECTING). This attribute only
applies to 6500 and Waveserver.

native-state Only used for multi-state traps. Some traps can

have multiple states; such as power supply online,
offline, or faulted. These states are tracked as
instances of the same trap.

manual-clearable Whether the alarm can be manually cleared using

MCP (true or false). Defaults to 'true' in MCP
18.06.

additional-text The alarm description.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1178
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

ATTRIBUTE DESCRIPTION

first-raise-time The timestamp of the first instance (of which MCP

is aware) of this alarm on this device. The
timestamp uses the RFC3339 format.

last-raise-time The timestamp when this instance of this alarm on

this device was raised. The timestamp uses the
RFC3339 format.

supercede-time The timestamp when this instance of this event on

this device was superseded (events are
superseded instead of cleared when a new
instance of the same event occurs). The
timestamp uses the RFC3339 format.

clear-time The timestamp of when this instance of this alarm

on this device was cleared. The timestamp uses
the RFC3339 format.

number-of-occurrences The number of occurrences of this alarm (of which

MCP is aware) during the time that this device has
been managed.

acknowledge-state Whether the alarm has been acknowledged in

MCP (ACKNOWLEDGED or
NOT_ACKNOWLEDGED).

device-id The MCP identifier (UUID) of the network construct

representing the device.

device-name The name of the device. For 6500, this is the target
identifier (TID).

device-long-name The long name of the device (6500, only). Because

the TID is limited to 20 characters, the 6500 has
this optional 64 character label.

ip-address The IP address of the device at the time of this

notification.

mac-address The MAC address of the device at the time of this

notification.

additional-attr Additional device-specific attributes. See the

following sections for examples of 6500-specific
attributes:

- Top level event - sample JSON

- Filtered alarm - sample JSON

- Filtered alarm data - sample JSON

- Filtered alarm attributes - sample JSON

mode 6500 NE mode (SONET, SDH, SDHJ, NONE)

aidtype 6500 AID type

location 6500 alarm location (near end [NEND] or far end

[FEND]).

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1179
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

ATTRIBUTE DESCRIPTION

source A concatenation of node-type and resource.

direction The 6500 alarm direction (RCV, TRMT, NA).

The following topics are covered in this section:

• Query network alarms

• Query a network alarm by alarm identifier
• Count network alarms
• Query device types within network alarms
• Query device attributes by device identifier
• Acknowledge an active alarm
• Unacknowledge an active alarm
• Force clear an active alarm
• Manual clear an active alarm
• Query Layer 0 services affected by an alarm identifier and related counts
• Query Layer 2 services affected by an alarm identifier and related counts
• Query the alarm retention period
• Set the alarm retention period
• Create an alarms filter
• Query alarm filters
• Delete an alarms filter
• Query active alarm counts
• Change alarm severity

Query network alarms

To retrieve network alarms, use the Alarms API (v2).

Requirements

Specify one, or more, of the following alarm search filters:

• filter[state] [ ] - alarm states to search

• filter[severity] [ ] - alarm severities to search
• filter[serviceAffecting] [ ] - service affecting values to search
• filter[deviceType] [ ] - device types to search

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1180
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

• filter[acknowledgeState] [ ] - acknowledgement states to search

• filter[deviceId] [ ] - device identifiers to search
• filter[deviceName] [ ] - device names to search
• filter[ipAddress] [ ] - IP addresses to search
• filter[macAddress] [ ] - MAC addresses to search
• filter[keytext] - alarm attributes to report
• filter[lastRaisedTime] - last raised time range to search
• filter[lastRaisedTimeFrom] - last raised time to be searched after
• filter[lastRaisedTimeTo] - last raised time to be searched before
• filter[clearTime] - alarm cleared time range to search
• sort[ ] - alarm attributes with which to sort the response
• filter[refinedRaisedTimeFrom] - raised time to be searched after
• filter[refinedRaisedTimeTo] - raised time to be searched before
• filter[refinedClearTimeFrom] - clear time to be searched after
• filter[refinedClearTimeTo] - clear time to be searched before
• offset - pagination of the response
• pageSize - limit the number of alarms per response page (default = 500)

Sample request

GET {{MCP_SERVER}}/nsa/api/v2_0/filter/filteredAlarms

Sample response

Note 1: Alarm attribute 'additional-attr' contains attributes that are added to the alarm by the network
element (NE) resource adapter (RA). The contents of this attribute can vary according to RA.

Note 2: Alarm attribute 'additional-text' contains the name of the alarm and can be used to determine the
appropriate alarm clearing procedure in the network element customer documentation.

{
"data": [
{
"id": "5172777979018630871",
"type": "FilteredAlarm",
"attributes": {
"id": "5172777979018630871",
"alarm-id": "5172777979018630871",
"node-id": "e3b15133-6289-4987-b478-3748d1a3562d",
"ra-alarm-id": "0100000001-6217-0092",
"node-type": "6500",
"state": "ACTIVE",
"resource": "SP-1-15",
"resource-id": "SP-1-15",
"native-condition-type": "SWLOAD",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1181
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

"condition-severity": "MINOR",
"service-affecting": "NON_SERVICE_AFFECTING",
"manual-clearable": true,
"additional-text": "Incomplete Software Lineup",
"first-raise-time": "2018-06-21T17:47:40.000Z",
"last-raise-time": "2018-06-21T17:47:40.000Z",
"number-of-occurrences": 1,
"acknowledge-state": "NOT_ACKNOWLEDGED",
"device-id": "75081e8a-d030-3ccb-a1b8-0546848082ff",
"device-name": "NE44",
"device-long-name": "NE44",
"ip-address": "10.188.133.19",
"mac-address": "00:01:02:03:05:00",
"additional-attrs": {
"mode": "NONE",
"aidtype": "EQPT",
"source": "6500:SP-1-15"
},
"affected-inventory-ids": [

],
"sequence-id": "1529603260000"
}
},
{
"id": "2598991997623669347",
"type": "FilteredAlarm",
"attributes": {
"id": "2598991997623669347",
"alarm-id": "2598991997623669347",
"node-id": "e3b15133-6289-4987-b478-3748d1a3562d",
"ra-alarm-id": "0100000010-0062-0379",
"node-type": "6500",
"state": "ACTIVE",
"resource": "SLOT-1-6",
"resource-id": "SLOT-1-6",
"native-condition-type": "EQPT_MISSING",
"condition-severity": "MINOR",
"service-affecting": "NON_SERVICE_AFFECTING",
"manual-clearable": true,
"additional-text": "Slot Empty",
"first-raise-time": "2018-06-21T17:47:41.000Z",
"last-raise-time": "2018-06-21T17:47:41.000Z",
"number-of-occurrences": 1,
"acknowledge-state": "NOT_ACKNOWLEDGED",
"device-id": "75081e8a-d030-3ccb-a1b8-0546848082ff",
"device-name": "NE44",
"device-long-name": "NE44",
"ip-address": "10.188.133.19",
"mac-address": "00:01:02:03:05:00",
"additional-attrs": {
"mode": "NONE",
"aidtype": "EQPT",
"source": "6500:SLOT-1-6"
},
"affected-inventory-ids": [

],
"sequence-id": "1529603261000"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1182
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

}
},
{
"id": "-8504817949576492443",
"type": "FilteredAlarm",
"attributes": {
"id": "-8504817949576492443",
"alarm-id": "-8504817949576492443",
"node-id": "e3b15133-6289-4987-b478-3748d1a3562d",
"ra-alarm-id": "0100000012-0062-0379",
"node-type": "6500",
"state": "ACTIVE",
"resource": "SLOT-1-8",
"resource-id": "SLOT-1-8",
"native-condition-type": "EQPT_MISSING",
"condition-severity": "MINOR",
"service-affecting": "NON_SERVICE_AFFECTING",
"manual-clearable": true,
"additional-text": "Slot Empty",
"first-raise-time": "2018-06-21T17:47:41.000Z",
"last-raise-time": "2018-06-21T17:47:41.000Z",
"number-of-occurrences": 1,
"acknowledge-state": "NOT_ACKNOWLEDGED",
"device-id": "75081e8a-d030-3ccb-a1b8-0546848082ff",
"device-name": "NE44",
"device-long-name": "NE44",
"ip-address": "10.188.133.19",
"mac-address": "00:01:02:03:05:00",
"additional-attrs": {
"mode": "NONE",
"aidtype": "EQPT",
"source": "6500:SLOT-1-8"
},
"affected-inventory-ids": [

],
"sequence-id": "1529603261000"
}
},
{
"id": "-1071530511754464347",
"type": "FilteredAlarm",
"attributes": {
"id": "-1071530511754464347",
"alarm-id": "-1071530511754464347",
"node-id": "e3b15133-6289-4987-b478-3748d1a3562d",
"ra-alarm-id": "0100000062-0063-0970",
"node-type": "6500",
"state": "ACTIVE",
"resource": "FAN-1-1",
"resource-id": "FAN-1-1",
"native-condition-type": "EQPT_MISMATCH",
"condition-severity": "CRITICAL",
"service-affecting": "SERVICE_AFFECTING",
"manual-clearable": true,
"additional-text": "Equipment Configuration Mismatch",
"first-raise-time": "2018-06-21T17:48:44.000Z",
"last-raise-time": "2018-06-21T17:48:44.000Z",
"number-of-occurrences": 1,

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1183
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

"acknowledge-state": "NOT_ACKNOWLEDGED",
"device-id": "75081e8a-d030-3ccb-a1b8-0546848082ff",
"device-name": "NE44",
"device-long-name": "NE44",
"ip-address": "10.188.133.19",
"mac-address": "00:01:02:03:05:00",
"additional-attrs": {
"mode": "NONE",
"aidtype": "COM",
"source": "6500:FAN-1-1"
},
"affected-inventory-ids": [

],
"sequence-id": "1529603324000"
}
},
{
"id": "5198498525522000867",
"type": "FilteredAlarm",
"attributes": {
"id": "5198498525522000867",
"alarm-id": "5198498525522000867",
"node-id": "e3b15133-6289-4987-b478-3748d1a3562d",
"ra-alarm-id": "0100000070-0063-0970",
"node-type": "6500",
"state": "ACTIVE",
"resource": "FAN-1-3",
"resource-id": "FAN-1-3",
"native-condition-type": "EQPT_MISMATCH",
"condition-severity": "CRITICAL",
"service-affecting": "SERVICE_AFFECTING",
"manual-clearable": true,
"additional-text": "Equipment Configuration Mismatch",
"first-raise-time": "2018-06-21T17:48:54.000Z",
"last-raise-time": "2018-06-21T17:48:54.000Z",
"number-of-occurrences": 1,
"acknowledge-state": "NOT_ACKNOWLEDGED",
"device-id": "75081e8a-d030-3ccb-a1b8-0546848082ff",
"device-name": "NE44",
"device-long-name": "NE44",
"ip-address": "10.188.133.19",
"mac-address": "00:01:02:03:05:00",
"additional-attrs": {
"mode": "NONE",
"aidtype": "COM",
"source": "6500:FAN-1-3"
},
"affected-inventory-ids": [

],
"sequence-id": "1529603334000"
}
},
{
"id": "-5655636862596489417",
"type": "FilteredAlarm",
"attributes": {
"id": "-5655636862596489417",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1184
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

"alarm-id": "-5655636862596489417",
"node-id": "e3b15133-6289-4987-b478-3748d1a3562d",
"ra-alarm-id": "0100000105-0153-0656",
"node-type": "6500",
"state": "ACTIVE",
"resource": "FANHOUSING-1-1",
"resource-id": "FANHOUSING-1-1",
"native-condition-type": "INVENTORY_CORRUPT",
"condition-severity": "CRITICAL",
"service-affecting": "SERVICE_AFFECTING",
"manual-clearable": true,
"additional-text": "Corrupt Inventory Data",
"first-raise-time": "2018-07-02T17:02:17.000Z",
"last-raise-time": "2018-07-02T17:02:17.000Z",
"number-of-occurrences": 1,
"acknowledge-state": "NOT_ACKNOWLEDGED",
"device-id": "75081e8a-d030-3ccb-a1b8-0546848082ff",
"device-name": "NE44",
"device-long-name": "NE44",
"ip-address": "10.188.133.19",
"mac-address": "00:01:02:03:05:00",
"additional-attrs": {
"mode": "NONE",
"aidtype": "COM",
"source": "6500:FANHOUSING-1-1"
},
"affected-inventory-ids": [

],
"sequence-id": "1530550937000"
}
},
{
"id": "-1353896165820857099",
"type": "FilteredAlarm",
"attributes": {
"id": "-1353896165820857099",
"alarm-id": "-1353896165820857099",
"node-id": "1f3ad417-b928-45b7-98f6-42fbb580de62",
"ra-alarm-id": "0100000001-6217-0092",
"node-type": "6500",
"state": "ACTIVE",
"resource": "SP-1-15",
"resource-id": "SP-1-15",
"native-condition-type": "SWLOAD",
"condition-severity": "MINOR",
"service-affecting": "NON_SERVICE_AFFECTING",
"manual-clearable": true,
"additional-text": "Incomplete Software Lineup",
"first-raise-time": "2018-06-21T17:47:26.000Z",
"last-raise-time": "2018-06-21T17:47:26.000Z",
"number-of-occurrences": 1,
"acknowledge-state": "NOT_ACKNOWLEDGED",
"device-id": "caea76c6-ce8a-33c2-b368-4fd471fbbd9f",
"device-name": "NE3",
"device-long-name": "NE3",
"ip-address": "10.188.133.17",
"mac-address": "00:01:02:03:01:00",
"additional-attrs": {

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1185
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

"mode": "NONE",
"aidtype": "EQPT",
"source": "6500:SP-1-15"
},
"affected-inventory-ids": [

],
"sequence-id": "1529603246000"
}
}
]
}

Query a network alarm by alarm identifier

To query alarm attributes by alarm identifier, use the Alarms API (v2).

Sample request

GET {{MCP_SERVER}}/nsa/api/v2_0/alarms/filter/filteredAlarms/{Id}

Sample response

Note 1: Alarm attribute 'additional-attr' contains attributes that are added to the alarm by the network
element (NE) resource adapter (RA). The contents of this attribute can vary according to RA.

Note 2: Alarm attribute 'additional-text' contains the name of the alarm and can be used to determine the
appropriate alarm clearing procedure in the network element customer documentation.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1186
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

{
"data": {
"id": "3373668756453886205",
"type": "FilteredAlarm",
"attributes": {
"id": "3373668756453886205",
"alarm-id": "8906292521956607123",
"node-id": "490570b6-008d-4564-b527-59242cee7138",
"ra-alarm-id": "0100000000-0000-0000",
"node-type": "6500",
"state": "SUPERSEDED",
"resource": "OTM3-1-14-1",
"native-condition-type": "T-SEFS-OTU",
"condition-severity": "INFO",
"service-affecting": "NON_SERVICE_AFFECTING",
"manual-clearable": false,
"additional-text": "T-SEFS-OTU",
"first-raise-time": "2017-06-27T21:00:14.000Z",
"last-raise-time": "2017-06-28T00:00:16.000Z",
"supersede-time": "2017-06-28T00:15:15.000Z",
"number-of-occurrences": 14,
"acknowledge-state": "NOT_ACKNOWLEDGED",
"device-id": "f69237f7-0e3e-3320-b82b-a839d637380e",
"device-name": "HAN1MD6502PL",
"ip-address": "10.41.88.42",
"mac-address": "40B2C8495DD1",
"additional-attrs": {
"mode": "SONET",
"Threshold Level": "4",
"Condition Effecting": "TC",
"Time Period": "1-DAY",
"Monitor Value": "14",
"source": "6500:OTM3-1-14-1"
},
"affected-inventory-ids": []
}
}
}

Sample response for 5410/5430 network element

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1187
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

{
"data": {
"id": "-1558192964143857348",
"type": "FilteredAlarm",
"attributes": {
"id": "-1558192964143857348",
"alarm-id": "-1558192964143857348",
"node-id": "aff33de8-3a4c-4051-9723-2b7cb92e197d",
"ra-alarm-id": "/NE=5430-OC-214/T=OTUTTP/N=1-A-2-1_OTU LOL",
"node-type": "CN54XX",
"state": "ACTIVE",
"resource": "OTUTTP-1-A-2-1",
"native-condition-type": "OTU LOL",
"condition-severity": "CRITICAL",
"service-affecting": "SERVICE_AFFECTING",
"manual-clearable": false,
"additional-text": "OTL Loss of Lane Alignment",
"first-raise-time": "2017-10-31T12:15:43.000Z",
"last-raise-time": "2017-10-31T12:15:43.000Z",
"number-of-occurrences": 1,
"acknowledge-state": "NOT_ACKNOWLEDGED",
"device-id": "247856e7-f1f3-3fba-97a8-a1dd97faedde",
"device-name": "5430-OC-214",
"ip-address": "192.168.3.214",
"additional-attrs": {},
"affected-inventory-ids": []
}
}
}

Count network alarms

To count network alarms, use the Alarms API for record counts.

Sample request

GET {{MCP_SERVER}}/nsa/api/v1/alarms/alarmRecordsCounts

Sample response

{
"data": {
"id": "1",
"type": "alarmRecordsCount",
"attributes": {
"id": "1",
"totalRecords": 30
}
}
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1188
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

Query device types within network alarms

To query device types within network alarms, use the Alarms API for device types.

Sample request

GET {{MCP_SERVER}}/nsa/api/v1/alarms/device-types

Sample response

{
"data": [
{
"type": "device-type",
"id": "1",
"attributes": {
"id": "1",
"value": "CN6500"
}
},
{
"type": "device-type",
"id": "2",
"attributes": {
"id": "2",
"value": "NUAGE"
}
},
{
"type": "device-type",
"id": "3",
"attributes": {
"id": "3",
"value": "OPENSTACK"
}
},
{
"type": "device-type",
"id": "4",
"attributes": {
"id": "4",
"value": "CN54XX"
}
}
],
"links": {},
"meta": {}
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1189
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

Query device attributes by device identifier

To query device attributes by device identifier, use the Alarms API for device attributes.

Sample request

GET {{MCP_SERVER}}/nsa/api/v1/alarms/deviceAttributes/{Id}

Sample response

{
"data": {
"id": "100000",
"type": "deviceAttributes",
"attributes": {
"id": "100000",
"deviceName": "BestNode",
"ipAddress": "192.168.42.2",
"macAddress": "00-04-DC-01-02-03",
"AdditionalAttribute2": "abcde",
"Additional_attribute1": "12345"
}
}
}

Sample response for 5410/5430 network element

{
"data": {
"id": "aff33de8-3a4c-4051-9723-2b7cb92e197d",
"type": "deviceAttributes",
"attributes": {
"id": "aff33de8-3a4c-4051-9723-2b7cb92e197d",
"deviceId": "247856e7-f1f3-3fba-97a8-a1dd97faedde",
"deviceName" "5430-OC-214",
"ipAddress": "192.168.3.214",
"partition": []
}
}
}

Acknowledge an active alarm

To acknowledge an active alarm by alarm identifier, use the alarms acknowledge API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1190
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

Provide the Id and sequenceId. The Id is the requested alarm identifier. The sequenceId is present in the
alarm record to be acted upon.

To get the Id and sequenceId for an alarm, perform the Alarms API described in the Query network alarms
section.

Sample request

POST {{MCP_SERVER}}/nsa/api/v2_0/alarms/{Id}/acknowledge/{sequenceId}

Sample response

A response code of 204 indicates successful acknowledgement of the alarm.

Unacknowledge an active alarm

To unacknowledge an active alarm by alarm identifier, use the alarms unacknowledge API.

Provide the Id and sequenceId. The Id is the requested alarm identifier. The sequenceId is present in the
alarm record to be acted upon.

To get the Id and sequenceId for an alarm, perform the Alarms API described in the Query network alarms
section.

Sample request

POST {{MCP_SERVER}}/nsa/api/v2_0/alarms/{Id}/unacknowledge/{sequenceId}

Sample response

A response code of 204 indicates successful unacknowledgment of the alarm.

Force clear an active alarm

To force clear an active alarm, use the Alarms API.

Provide the Id and sequenceId. The Id is the requested alarm identifier. The sequenceId is present in the
alarm record to be acted upon.

To get the Id and sequenceId for an alarm, perform the Alarms API described in the Query network alarms
section.

Sample request

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1191
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

POST {{MCP_SERVER}}/nsa/api/v2_0/alarms/{Id}/force-clear/{sequenceId}

Sample response

A response code of 204 indicates successful clearance of the alarm.

Manual clear an active alarm

To manually clear an active alarm, use the Alarms API.

Provide the Id and sequenceId. The Id is the requested alarm identifier. The sequenceId is present in the
alarm record to be acted upon.

To get the Id and sequenceId for an alarm, perform the Alarms API described in the Query network alarms
section.

Sample request

POST {{MCP_SERVER}}/nsa/api/v2_0/alarms/{Id}/manual-clear/{sequenceId}

Sample response

A response code of 204 indicates successful clearance of the alarm.

Query Layer 0 services affected by an alarm identifier and

related counts
This section includes the following topics:

• Query services affected by an alarm identifier

• Query the counts of the services affected by alarm identifiers

Query services affected by an alarm identifier

To query affected services by alarm identifier, use the Correlator Engine API.

Sample request

GET {{MCP_SERVER}}/events-to-service-correlator/api/v1/affectedServices?alarmId={{alarmId}}

Specify the following attribute: alarmId.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1192
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

Sample response

For 6500:

{
"data": [{
"attributes": {
"inventoryType": "fre",
"id": "-5686227573084971313",
"link": "/ui/#/photonics/-5686227573084971313",
"nativeName": "",
"serviceName": "",
"serviceType": "PHY"
},
"id": "-5686227573084971313",
"type": "affectedService"
},
{
"attributes": {
"inventoryType": "fre",
"id": "-3605809751029117228",
"link": "/ui/#/photonics/-3605809751029117228",
"nativeName": "",
"serviceName": "",
"serviceType": "OMS"
},
"id": "-3605809751029117228",
"type": "affectedService"
},
{
"attributes": {
"inventoryType": "fre",
"id": "4837043780625225707",
"link": "/ui/#/photonics/4837043780625225707",
"nativeName": "",
"serviceName": "",
"serviceType": "OTS"
},
"id": "4837043780625225707",
"type": "affectedService"
}
],
"meta": {
"count": "3"
}
}

For Waveserver:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1193
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

{
"data": [{
"attributes": {
"inventoryType": "fre",
"id": "-4264534818257075898",
"link": "/ui/#/photonics/-4264534818257075898",
"nativeName": "",
"serviceName": "",
"serviceType": "DSR_ETHERNET"
},
"id": "-4264534818257075898",
"type": "affectedService"
},
{
"attributes": {
"inventoryType": "fre",
"id": "8360887939273810900",
"link": "/ui/#/photonics/8360887939273810900",
"nativeName": "",
"serviceName": "",
"serviceType": "DSR_ETHERNET"
},
"id": "8360887939273810900",
"type": "affectedService"
}
],
"meta": {
"count": "2"
}
}

Query the counts of the services affected by alarm identifiers

To query the counts of the services affected by alarm identifiers, use the Correlator Engine API.

Sample request

GET {{MCP_SERVER}}/events-to-service-
correlator/api/v1/affectedServicesCounts?alarmIds={{alarmId}}

Specify the following attribute: alarmIds.

Note: Provide multiple values (alarmId) in new lines (at least one required).

Sample response

For 6500 and Waveserver:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1194
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

{
"data": {
"attributes": {
"counts": {
"-1208277793752683809": "2",
"4837043780625225707": "0"
}
},
"id": "1",
"type": "affectedServicesCounts"
}
}

Query Layer 2 services affected by an alarm identifier and

related counts
This section includes the following topic:

• Query services affected by an alarm identifier

• Query the counts of the services affected by alarm identifiers

Query services affected by an alarm identifier

To query affected services by alarm identifier, use the Correlator Engine API.

Sample request

GET {{MCP_SERVER}}/events-to-service-correlator/api/v1/affectedServices?alarmId={{alarmId}}

Specify the following attribute: alarmId.

Sample response

{
"data": [
{
"attributes": {
"inventoryType": "fre",
"id": "d96bca5f-9827-3023-be75-3b6c03cf6eb1::FRE_EVC_scProtPw",
"link": "/ui/#/packet-services/d96bca5f-9827-3023-be75-
3b6c03cf6eb1::FRE_EVC_scProtPw",
"nativeName": "",
"serviceName": "",
"serviceType": "ETHERNET"
},
"id": "d96bca5f-9827-3023-be75-3b6c03cf6eb1::FRE_EVC_scProtPw",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1195
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

"type": "affectedService"
},
{
"attributes": {
"inventoryType": "fre",
"id": "1268213195689691597",
"link": "/ui/#/packet-services/1268213195689691597",
"nativeName": "",
"serviceName": "",
"serviceType": "ETHERNET"
},
"id": "1268213195689691597",
"type": "affectedService"
},
{
"attributes": {
"inventoryType": "fre",
"id": "-5518214677590821756",
"link": "/ui/#/packet-services/-5518214677590821756",
"nativeName": "",
"serviceName": "",
"serviceType": "ETHERNET"
},
"id": "-5518214677590821756",
"type": "affectedService"
},
{
"attributes": {
"inventoryType": "fre",
"id": "889845168507751129",
"link": "/ui/#/packet-services/889845168507751129",
"nativeName": "",
"serviceName": "",
"serviceType": "ETHERNET"
},
"id": "889845168507751129",
"type": "affectedService"
},
{
"attributes": {
"inventoryType": "fre",
"id": "d96bca5f-9827-3023-be75-3b6c03cf6eb1::FRE_EVC_JeffTestEvpl_3",
"link": "/ui/#/packet-services/d96bca5f-9827-3023-be75-
3b6c03cf6eb1::FRE_EVC_JeffTestEvpl_3",
"nativeName": "",
"serviceName": "",
"serviceType": "ETHERNET"
},
"id": "d96bca5f-9827-3023-be75-3b6c03cf6eb1::FRE_EVC_JeffTestEvpl_3",
"type": "affectedService"
},
{
"attributes": {
"inventoryType": "fre",
"id": "d96bca5f-9827-3023-be75-3b6c03cf6eb1::FRE_EVC_EVPL_PPW_min",
"link": "/ui/#/packet-services/d96bca5f-9827-3023-be75-
3b6c03cf6eb1::FRE_EVC_EVPL_PPW_min",
"nativeName": "",
"serviceName": "",

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1196
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

"serviceType": "ETHERNET"
},
"id": "d96bca5f-9827-3023-be75-3b6c03cf6eb1::FRE_EVC_EVPL_PPW_min",
"type": "affectedService"
},
{
"attributes": {
"inventoryType": "fre",
"id": "d96bca5f-9827-3023-be75-3b6c03cf6eb1::FRE_EVC_apMcpMpls",
"link": "/ui/#/packet-services/d96bca5f-9827-3023-be75-
3b6c03cf6eb1::FRE_EVC_apMcpMpls",
"nativeName": "",
"serviceName": "",
"serviceType": "ETHERNET"
},
"id": "d96bca5f-9827-3023-be75-3b6c03cf6eb1::FRE_EVC_apMcpMpls",
"type": "affectedService"
}
],
"meta": {
"count": "7"
}
}

Query the counts of the services affected by alarm identifiers

To query the counts of the services affected by alarm identifiers, use the Correlator Engine API.

Sample request

GET {{MCP_SERVER}}/events-to-service-
correlator/api/v1/affectedServicesCounts?alarmIds={{alarmId}}

Specify the following attribute: alarmIds.

Note: Provide multiple values (alarmId) in new lines (at least one required).

Sample response

{
"data": {
"attributes": {
"counts": {
"5958100796168664834": "2"
}
},
"id": "1",
"type": "affectedServicesCounts"
}
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1197
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

Query the alarm retention period

To query the alarm retention period, use the Alarms API for historical data retention days.

Sample request

GET {{MCP_SERVER}}/nsa/api/v1/alarms/historicalDataRetentionDays

Sample response

{
"retentionDays": 30
}

Set the alarm retention period

Historical alarms that have a cleared and superseded date that is older than the retention period are
removed each day beginning at 1:00 a.m. (UTC time).

The default retention period is 30 days. The retention period can be from 1 to 365 days.

To set the number of days that alarms are retained, use the Alarm API historical data retention days. You
must be a Network Admin role user.

Sample request

PUT {{MCP_SERVER}}/nsa/api/v1/alarms/historicalDataRetentionDays/{retentionDays}

Sample response

{
"retentionDays": 5
}

You also need to manually add a configuration file.

Note: Apply the API update before you update the configuration file.

1. As a Network Admin role user, log into each host.

2. Change directories. Enter:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1198
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

cd /bp2/<aeprocessorcontainer>/data/config/server-config/

3. Create a configuration file "aep" with the following content:

RETENTION_DAYS=<numberOfDays>

Create an alarms filter

To create a new alarms filter, use the Alarms API.

Prerequisite

In order to avoid confusion, before you create an alarms filter, familiarize yourself with opening the
websocket connection and subscribing to a topic. For information on websockets, see Kafkacomet.

Requirements

Provide the values for the new alarms filter.

Note: You have three minutes to subscribe to the new alarms filter using Kafka Comet before the filter is
automatically deleted (clean-up). Clean-up runs once every minute and deletes any filters that have not
been subscribed to or created in the past three minutes.

Sample request

POST {{MCP_SERVER}}/nsa/api/v2_0/alarms/filter

Sample input

{
"data": {
"type": "Filter",
"attributes": {
"severity": ["CRITICAL", "MAJOR"]
}
}
}

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1199
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

{
"data": {
"id": "-6022851661353698515",
"type": "Filter",
"attributes": {
"channel": "bp.aeprocessor.v2_0.alarms.filter59",
"latestOffset": 0,
"nodeType": [],
"resource": [],
"nativeConditionType": [],
"nativeConditionTypeExclusion": [],
"severity": [
"CRITICAL",
"MAJOR"
],
"serviceAffecting": [],
"additionalText": [],
"additionalTextExclusion": [],
"raiseTimeHour": [],
"deviceName": [],
"deviceNameExclusion": [],
"ipAddress": [],
"ipAddressExclusion": []
}
}
}

Query alarm filters

To retrieve active alarms filters, use the Alarms API.

Sample request

GET {{MCP_SERVER}}/nsa/api/v2_0/alarms/filter

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1200
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

{
"data": [
{
"id": "-6022851661353698515",
"type": "Filter",
"attributes": {
"channel": "bp.aeprocessor.v2_0.alarms.filter59",
"nodeType": [],
"resource": [],
"nativeConditionType": [],
"nativeConditionTypeExclusion": [],
"severity": [
"CRITICAL",
"MAJOR"
],
"serviceAffecting": [],
"additionalText": [],
"additionalTextExclusion": [],
"raiseTimeHour": [],
"deviceName": [],
"deviceNameExclusion": [],
"ipAddress": [],
"ipAddressExclusion": []
}
},
{
"id": "2088028032440081749",
"type": "Filter",
"attributes": {
"channel": "bp.aeprocessor.v2_0.alarms.filter44",
"nodeType": [],
"resource": [],
"nativeConditionType": [],
"nativeConditionTypeExclusion": [],
"severity": [
"MAJOR"
],
"serviceAffecting": [],
"additionalText": [],
"additionalTextExclusion": [],
"raiseTimeHour": [],
"deviceName": [],
"deviceNameExclusion": [],
"ipAddress": [],
"ipAddressExclusion": []
}
}
]
}

Delete an alarms filter

To delete an active alarms filters, use the Alarms API.

Note: This API forcefully deletes an alarm filter and must be used with caution. Active consumers

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1201
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

subscribed to the filter will no longer receive notifications for that filter and may begin to receive
notifications for a new filter.

Inactive filters are automatically deleted after 3 - 4 minutes of inactivity. If you do not want to wait for the
automatic clean-up and you are confident there are no other subscribers, use this API to delete the filter.

This API can also be used to delete filters that are suspected to be inactive but have not been
automatically cleaned-up.

The preferred method to delete filters that are not automatically cleaned-up is to subscribe using Kafka
Comet and then unsubscribe. If there are no other active consumers for the filter, the filter will be
automatically cleaned-up after 3 - 4 minutes.

Sample request

DELETE {{MCP_SERVER}}/nsa/api/v2_0/alarms/filter/{channel}

Sample input

bp.aeprocessor.v2_0.alarms.filter59

Sample response

A response code of 204 indicates a successful deletion of the alarms filter.

Query active alarm counts

To retrieve active alarm counts, use the Alarms API.

Sample request

GET {{MCP_SERVER}}/nsa/api/v2_0/alarms/filter/activeAlarmCounts

Sample response

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1202
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

{
"data": [],
"meta": {
"query-total": 36,
"query-aggregations": {
"severity": {
"MAJOR": 11,
"MINOR": 22,
"WARNING": 2,
"CRITICAL": 1
}
}
}
}

The alarm count data is cached in AEP, so the same data can be re-used for the next REST call issued
within 10 seconds.

The frequency can be modified in the following file (no restart required):

/bp2/<aeprocessorcontainer>/data/config/server-config/aep for each host with one line:

ALARM_COUNTS_EXPIRE_SECONDS=<numberOfSeconds>

Change alarm severity for EMS-generated alarms

To change the alarm severity for the following alarms, use the Global Config Service API.

Alarm to be changed Key and Name Application

NE LOA alarm.lossOfAssociation.severity nsi

NE Sync Failed alarm.failedSync.severity nsi

NE Backup Failed ne.backup.failed.alarm.severity configmgmt

NE Upgrade Failed ne.upgrade.failed.alarm.severity configmgmt

Note also:

• If the value has not been changed from the default, use the POST command with the following
information to create the configuration change.
• If the alarm severity has already been changed, to further update, use the PATCH API call.

Sample request

POST {{MCP_SERVER}}/gcs/api/v1/config

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1203
Blue Planet MCP API Reference Guide, Release 18.06 Alarm management

• Specify the relevant name and title exactly as it appears in the 'Key and Name' column of the table
above.
• Specify the value: CRITICAL, MAJOR, MINOR, WARNING, INFO.

Sample request

The following sample is a POST call that sets the severity for the NE LOA alarm to WARNING. The Sample
requests and Sample response for NE Sync Fail, NE Backup, and NE Upgrade alarms are similar.

[
{
"application": "nsi",
"partition": "nsi",
"instance": "-",
"name": "alarm.lossOfAssociation.severity",
"title": "alarm.lossOfAssociation.severity",
"description": "Changing NE LOA from MAJOR to WARNING",
"value": "WARNING",
"default": "MAJOR"
}
]

Sample response

[
{
"application": "nsi",
"partition": "nsi",
"instance": "-",
"name": "alarm.lossOfAssociation.severity",
"title": "alarm.lossOfAssociation.severity",
"description": "Changing NE LOA from MAJOR to WARNING",
"value": "WARNING",
"default": "MAJOR"
"callbacks": [ "http://172.16.0.11:8080/configuration/api/v1/callback" ],
"key": "nsi/-/nsi/alarm.lossOfAssociation.severity"
}
]

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1204
Blue Planet MCP API Reference Guide, Release 18.06 MCP reports using the REST API

MCP reports using the REST API

You can use the MCP REST API to generate reports containing detailed information about some elements
of the managed network. This section includes the following topics:

• Generating and scheduling reports using the REST API

• Alarms reports
• Equipment reports
• Network element list reports
• LLDP reports
• Pseudowire Committed Information rate (CIR) reports
• Performance Monitoring (PM) Cycle Redundancy Check (CRC)/Dropped Packets reports
• Photonic service reports
• Transport client service reports
• Transport client infrastructure reports
• Packet service reports
• Packet infrastructure reports
• API call details

Generating and scheduling reports using the REST API

You can use the MCP REST API to generate reports containing detailed information about some elements
of the managed network. The available reporting API calls support the generation of the following reports:

• ALARMS_REPORT: Provides current alarms present in the network.

• EQUIPMENT_REPORT: Provides a list of equipment present in the network.
• NE_LIST_REPORT: Provides NE details.
• LLDP_LINKS_REPORT: Provides information about LLDP links.
• PW_CIR_REPORT: Provides information about pseudowires and all related services' CIR details.
• PM_CRC_REPORT: Provides information about LLDP port CRC errors.
• PM_DROPPED_PKTS_REPORT: Provides information about LLDP port dropped packets.
• Reports characterizing network service and infrastructure:
◦ PHOTONIC_SERVICE_REPORT
◦ TRANSPORT_CLIENT_REPORT
◦ TRANSPORT_INFRASTRUCTURE_REPORT
◦ PACKET_SERVICE_REPORT
◦ PACKET_INFRASTRUCTURE_REPORT

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1205
Blue Planet MCP API Reference Guide, Release 18.06 MCP reports using the REST API

These reports are also stored on the MCP server and can be retrieved using specific API calls.

Actions available for all supported report types using the API include:

• Generating a report on demand

• Query a report’s metadata information, including report status
• Delete a specific report
• Delete all reports within a time range
• Working with report schedules:
◦ Create a report schedule, so that a report will be automatically generated at a specific time in the
future
◦ Retrieve all schedules for reports
◦ Delete an existing report schedule

The reporting module uses the following API calls to generate, retrieve, and delete reports:

On-demand reporting
You can generate a report immediately using the Reporting API’s report v1 or v2 calls.

You can generate reports using the Swagger interface that is included with the MCP UI. You must have
valid MCP login credentials to access the Swagger UI in MCP.

To run reports from the Swagger UI, navigate to the list of report APIs as described below, and run any
single call using its "Try it out" button. MCP will submit the call to the server and display the response to
the submitted call in the same UI window. You can copy and paste this displayed information into another
application.

To access Swagger:

1. Log into MCP with your credentials.

2. Click System > APIs
3. Click the Reporting entry in the left-hand column.
4. To view a list of available report types, do the following:
a. Click the GET /reporting/api/v2/report/supported/reporttype call.
b. Click the Execute button.

The Response Body lists the available report types in the current release. Note the string after
"reportType", which you will need to generate that report from the API.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1206
Blue Planet MCP API Reference Guide, Release 18.06 MCP reports using the REST API

5. To generate a new report, do the following:

a. Click the POST /reporting/api/v2/report call.
b. Click the Try it out button.
c. In the body of the call, replace the text "string" in the following line:

'"reportType": "string"'

with the correct reportType string (for example, PW_CIR_REPORT".

Note: The correct reportType strings for all available report types were displayed in response to the
previous call.

6. Click the Execute button.

The Code 201 response body displayed in the UI will resemble the following example.

{
"data": [
{
"id": "281b4d163c8d4b0ba93a85aba7b8f771",
"type": "generatedReport",
"attributes": {
"resourceId": "281b4d163c8d4b0ba93a85aba7b8f771",
"reportType": "PW_CIR_REPORT",
"reportGenerationTime": "2018-05-23T04:36:06.480Z",
"reportStatus": "REQUESTED",
"reportGenerationMode": "ON_DEMAND"
}
}],
"links": {},
"meta": {}
}

Note the resourceId value. This is the ID of the generated report You will use this ID to retrieve the
generated report, as described in Retrieving report data .

Retrieving report data

In addition to displaying report data in the Swagger UI, MCP stores the report data for later retrieval.

You can retrieve report data using the following v2 API call:

/reporting/api/v2/report/{resourceid}

You must provide the Resource ID associated with the report you are seeking, and the format in which you
want to download the report data (either CSV or JSON). The resulting data will be delivered in a
downloadable octet-stream.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1207
Blue Planet MCP API Reference Guide, Release 18.06 MCP reports using the REST API

Save the downloaded file in zip format; then you can unzip the file to view the report.

For an LLDP report, the report will resemble the following:

{ "FROM_NE": "5160-BP-3", "FROM_NE_IP": "10.92.25.51", "FROM_NE_TYPE": "5160",

"TO_NE": "8700-10-BP3", "TO_NE_IP": "10.92.25.45", "TO_NE_TYPE": "8700",
"LINK_LABEL": "", "FROM_PORT": "19", "TO_PORT": "1/4", "TAGS": [ "" ] }
,
{ "FROM_NE": "5160-BP-1", "FROM_NE_IP": "10.92.25.50", "FROM_NE_TYPE": "5160",
"TO_NE": "8700-10-BP3", "TO_NE_IP": "10.92.25.45", "TO_NE_TYPE": "8700",
"LINK_LABEL": "", "FROM_PORT": "19", "TO_PORT": "1/5", "TAGS": [ "" ] }
,
{ "FROM_NE": "3926-1C-2", "FROM_NE_IP": "10.92.18.240", "FROM_NE_TYPE": "3926",
"TO_NE": "3928-1C-1", "TO_NE_IP": "10.92.18.239", "TO_NE_TYPE": "3928",
"LINK_LABEL": "", "FROM_PORT": "1.5", "TO_PORT": "9", "TAGS": [ "" ] }
,
{ "FROM_NE": "3928-1C-2", "FROM_NE_IP": "10.92.18.242", "FROM_NE_TYPE": "3928",
"TO_NE": "3926-1C-1", "TO_NE_IP": "10.92.18.254", "TO_NE_TYPE": "3926",
"LINK_LABEL": "", "FROM_PORT": "11", "TO_PORT": "1.7", "TAGS": [ "" ] }
,
{ "FROM_NE": "5160-BP-1", "FROM_NE_IP": "10.92.25.50", "FROM_NE_TYPE": "5160",
"TO_NE": "5160-BP-3", "TO_NE_IP": "10.92.25.51", "TO_NE_TYPE": "5160",
"LINK_LABEL": "", "FROM_PORT": "22", "TO_PORT": "22", "TAGS": [ "" ] }
,
{ "FROM_NE": "5160-BP-1", "FROM_NE_IP": "10.92.25.50", "FROM_NE_TYPE": "5160",
"TO_NE": "5160-BP-3", "TO_NE_IP": "10.92.25.51", "TO_NE_TYPE": "5160",
"LINK_LABEL": "", "FROM_PORT": "21", "TO_PORT": "21", "TAGS": [ "" ] }
,

{ "FROM_NE": "3926-1C-2", "FROM_NE_IP": "10.92.18.240", "FROM_NE_TYPE": "3926",

"TO_NE": "3926-1C-1", "TO_NE_IP": "10.92.18.254", "TO_NE_TYPE": "3926",
"LINK_LABEL": "", "FROM_PORT": "1.1", "TO_PORT": "1.1", "TAGS": [ "" ] }

Deleting reports
You can delete individual reports using the following API call:

/reporting/api/v2/report/delete/{resourceId}

Use syntax resembling the following:

/reporting/api/v2/report/delete/ece539710ba64937b30b27d6e8e5fc01

Or, you can delete a set of reports that fall within a time range using the same API call, but with syntax
resembling the following:

/reporting/api/v2/report/delete?fromDate=2018-02-
18T03%3A00%3A17.103Z&toDate=2018-02-
19T03%3A00%3A17.103Z&reportType=LLDP_LINKS_REPORT

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1208
Blue Planet MCP API Reference Guide, Release 18.06 MCP reports using the REST API

Working with report schedules

To create and manage a schedule that will cause the automatic generation of a report, use the Reporting
API’s Schedule calls.

The payload required for the API call (/reporting/api/v2/schedule/create) is:

{
"cronExpression": "string",
"cronExpressionFormat": "string",
"reportType": "string"
}

Where:

• cronExpression: You can provide cron expression for the schedule and reporting server will take care
of repetitive occurrence of the schedule.
• cronExpressionFormat: You must provide the cron expression format. Acceptable values are
"QUARTZ" or "UNIX".
• reportType: This is the type of report you are scheduling.

Sample Response:

{
"data": [
{
"id": "ddbad61a1eb544e98bb7b829a034aef7",
"type": "reportingSchedule",
"attributes": {
"resourceId": "ddbad61a1eb544e98bb7b829a034aef7",
"reportType": "LLDP_LINKS_REPORT",
"cronExpression": "00 00 19 23 May ? 2018",
"cronExpressionFormat": "QUARTZ",
"cronDescription": "at 19:00 at 23 day at May month at 2018 year"
}
}
],
"links": {},
"meta": {}
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1209
Blue Planet MCP API Reference Guide, Release 18.06 MCP reports using the REST API

The resourceId uniquely identifies this report schedule. You can use that ID to obtain information about
the report, or to delete the report, using the following API calls respectively:

• GET /reporting/api/v2/schedule/{resourceId} to obtain information about the schedule

• DELETE /reporting/api/v2/schedule/delete/{resourceId} to delete the schedule

To retrieve a list of all current schedules, use the following call:

• GET /reporting/api/v2/schedule

The system returns a list of all schedules, each with an associated resourceId.

You can use those resourceId values to retrieve or delete a specific schedule.

Alarms reports
The reporting module supports the generation of a alarms report including the following parameters:

• clfi
• direction
• additional text
• acknowledgeUpdateTime
• acknowledgeUpdateUser
• staticAlarmId
• clearTime
• deviceName
• id
• ipAddress
• firstRaiseTime
• lastRaiseTime
• macAddress
• nativeConditionType
• numberOfOccurrences
• resource
• severity
• serviceAffecting
• type

You can add, delete, and adjust existing report parameters by adding a file with the following name:

• reporting_format_alarms_report_v1_csv

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1210
Blue Planet MCP API Reference Guide, Release 18.06 MCP reports using the REST API

in the docker container at the following location:

• /bp2/data/config/server-config

This file can omit any of the parameters listed above to omit that value from the report. Also, the
sequence of parameters in the .csv file is the sequence in which the parameters will be listed in the
report.

Below is an example of the contents of the reporting_format_alarms_report_v2_csv file.

clfi.VALUE=clfi
direction.VALUE=direction
additionalText.VALUE=additionalText
acknowledgeUpdateTime.VALUE=acknowledgeUpdateTime
acknowledgeUpdateUser.VALUE=acknowledgeUpdateUser
staticAlarmId.VALUE=staticAlarmId
clearTime.VALUE=clearTime
deviceName.VALUE=deviceName
id.VALUE=id
ipAddress.VALUE=ipAddress
firstRaiseTime.VALUE=firstRaiseTime
lastRaiseTime.VALUE=lastRaiseTime
macAddress.VALUE=macAddress
nativeConditionType.VALUE=nativeConditionType
numberOfOccurrences.VALUE=numberOfOccurrences
resource.VALUE=resource
severity.VALUE=severity
serviceAffecting.VALUE=serviceAffecting
type.VALUE=type

Equipment reports
The reporting module supports the generation of an equipment report including the following parameters:

• ID
• customer code
• name
• name format
• network construct
• type
• availability state
• reservation state
• primary state
• part number
• secondary state

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1211
Blue Planet MCP API Reference Guide, Release 18.06 MCP reports using the REST API

• serial number
• project name

You can add, delete, and adjust existing report parameters by adding a file with the following name:

• reporting_format_equipment_report_v2_csv

in the docker container at the following location:

• /bp2/data/config/server-config

This file can omit any of the parameters listed above to omit that value from the report. Also, the
sequence of parameters in the .csv file is the sequence in which the parameters will be listed in the
report.

Below is an example of the contents of the reporting_format_equipment_report_v2_csv file.

ID.VALUE=id
CUSTOMER_CODE.VALUE=customerCode
NAME.VALUE=displayName
NAME_FORMAT.VALUE=displayNameFormat
NETWORK_CONSTRUCT.VALUE=networkConstruct
TYPE.VALUE=type
AVAILABILITY_STATE.VALUE=availabilityState
RESERVATION_STATE.VALUE=reservationState
PRIMARY_STATE.VALUE=state
PART_NUMBER.VALUE=partNumber
SECONDARY_STATE.VALUE=secondaryState
SERIAL_NUMBER.VALUE=serialNumber
PROJECT_NAME.VALUE=projectName

Network element list reports

The reporting module supports the generation of a network element (NE) list report including the
following parameters:

• ID
• association state
• name
• IP address
• resource type
• sync state
• MAC address
• map site
• number of shelves

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1212
Blue Planet MCP API Reference Guide, Release 18.06 MCP reports using the REST API

• partitions
• shelf type
• software version
• sync state text
• sys location

You can add, delete, and adjust existing report parameters by adding a file with the following name:

• reporting_format_ne_list_report_v2_csv

in the docker container at the following location:

• /bp2/data/config/server-config

This file can omit any of the parameters listed above to omit that value from the report. Also, the
sequence of parameters in the .csv file is the sequence in which the parameters will be listed in the
report.

Below is an example of the contents of the reporting_format_ne_list_report_v2_csv file.

ID.VALUE=id
ASSOCIATION_STATE.VALUE=association_state
NAME.VALUE=name
IP_ADDRESS.VALUE=ip_address
RESOURCE_TYPE.VALUE=resource_type
SYNC_STATE.VALUE=sync_state
MAC_ADDRESS.VALUE=mac_address
NUMBER_OF_SHELVES.VALUE=number_of_shelves
PARTITIONS.VALUE=partitions
SHELF_TYPE.VALUE=shelf_type
SOFTWARE_VERSION.VALUE=software_version
SYNC_STATE_TEXT.VALUE=sync_state_text
SYS_LOCATION.VALUE=sys_location

LLDP reports
The reporting module supports the generation of reports regarding LLDP links in the managed network.

The LLDP links report includes the following parameters:

• "From" NE name
• "From" NE IP address
• "From" NE type
• "To" NE name
• "To" NE IP address

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1213
Blue Planet MCP API Reference Guide, Release 18.06 MCP reports using the REST API

• "To" NE type
• Link label
• Link ID
• "From" port
• "To" port
• Tags

You can add, delete and adjust existing report parameters by adding a file with the following name:

• reporting_format_lldp_links_report_v2_csv

in the docker container at the following location:

• /bp2/data/config/server-config

This file can omit any of the parameters listed above to omit that value from the report. Also, the
sequence of parameters in the .csv file is the sequence in which the parameters will be listed in the
report.

Below is an example of the contents of the reporting_format_lldp_links_report_v2_csv file.

HEADER=TAGS, FROM_NE, FROM NE IP, FROM NE TYPE, TO NE, TO NE IP, TO NE TYPE, LINK
LABEL, FROM PORT, TO PORT
FROM_NE.VALUE=from_ne
FROM NE IP.VALUE=from_ne_ip
FROM NE TYPE.VALUE=from_ne_type
TO NE.VALUE=to_ne
TO NE IP.VALUE=to_ne_ip
TO NE TYPE.VALUE=to_ne_type
LINK LABEL.VALUE=link_label
FROM PORT.VALUE=from_port
TO PORT.VALUE=to_port
TAGS.VALUE=tags
tags.TYPE=Array

Pseudowire Committed Information rate (CIR) reports

The reporting module supports the generation of reports regarding pseudowire Committed Information
Rates (CIR). The report includes the following parameters:

• EVC_NAME
• PW_NAME
• PW_ROLE
• PRIMARY_PW_NAME
• BKUP_PW_NAME

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1214
Blue Planet MCP API Reference Guide, Release 18.06 MCP reports using the REST API

• LOCAL_PW_NE
• LOCAL_PW_NE_IP
• LOCAL_LABEL
• LOCAL_PW_MODE
• LOCAL_POLICING
• LOCAL_ENDPOINT
• PEER_PW_NE
• PEER_PW_NE_IP
• PEER_LABEL
• PEER_PW_MODE
• PEER_POLICING
• PEER_ENDPOINT
• TYPE

The above parameters are then followed by the set below, which are repeated for each tunnel on the
pseudowire path (with appended numbers 1, 2, 3, and so on to distinguish each tunnel):

• PRIMARY_TUNNEL_NAME
• PRIMARY_TUNNEL_PATH
• BACKUP_TUNNEL_NAME
• BACKUP_TUNNEL_PATH

Note: This report will include pseudowires for which both endpoints are contained in the list of service
endpoints. If a pseudowire is not associated with any service, then it will not be included in the report.

You can add, delete and adjust existing report parameters by adding a file with the following name:

• reporting_format_pw_cir_report_v2_csv

in the docker container at the following location:

• /bp2/data/config/server-config

This file can omit any of the parameters listed above to omit that value from the report. Also, the
sequence of parameters in the .csv file is the sequence in which the parameters will be listed in the
report.

Performance Monitoring (PM) Cycle Redundancy Check

(CRC)/Dropped Packets reports
The reporting module supports the generation of Performance Monitoring (PM) CRC/Dropped Packets
report with the parameters listed below.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1215
Blue Planet MCP API Reference Guide, Release 18.06 MCP reports using the REST API

There are 96 BINs for a duration of 24 hours. All 15-minute BINs for each port will be added as a separate
row in the report.

Table 32. PM CRC/Dropped Pkts report parameters

NE_NAME NE_IP NE_TYPE LINK_LABE PORT TAGS TIME VALUE

L (15MIN
BIN)

BAR 10.182.13 3938 LABEL 3 TAG1 2018-05- 0

0.105 08T11:00:
00.000Z

BAR 10.182.13 3938 LABEL 3 TAG2 2018-05- 0

0.105 08T11:15:
00.000Z

BAR 10.182.13 3938 LABEL 3 TAG3 2018-05- 0

0.105 08T11:30:
00.000Z

BAR 10.182.13 3938 LABEL 3 TAG4 2018-05- 0

0.105 08T11:45:
00.000Z

BAR 10.182.13 3938 LABEL 3 TAG5 2018-05- 0

0.105 08T12:00:
00.000Z

BAR 10.182.13 3938 LABEL 3 TAG6 2018-05- 0

0.105 08T12:15:
00.000Z

BAR 10.182.13 3938 LABEL 3 TAG7 2018-05- 0

0.105 08T12:30:
00.000Z

Photonic service reports

The reporting module supports the generation of a photonic service report with the following parameters:

• Name
• Customer name
• Overall type
• Layer rate
• Layer rate qualifier
• Deployment state
• Is multipoint
• Is bidirectional
• Number of endpoints
• Source name

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1216
Blue Planet MCP API Reference Guide, Release 18.06 MCP reports using the REST API

• Source locations
• Source format
• Destination name
• Destination locations
• Destination format
• Resiliency
• Life cycle
• Description
• Frequency
• SRLG
• Fiber loss
• Planned margin
• Planned loss
• Operational state
• Admin state
• SNCG
• SNR margin

You can add, delete and adjust existing report parameters by adding a file with the following name:

• reporting_format_photonic_service_report_v2_csv

in the docker container at the following location:

• /bp2/data/config/server-config

This file can omit any of the parameters listed above to omit that value from the report. Also, the
sequence of parameters in the .csv file is the sequence in which the parameters will be listed in the
report.

Transport client service reports

The reporting module supports the generation of a transport client service report with the following
parameters:

• Name
• Customer name
• Overall type
• Layer rate
• Layer rate qualifier

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1217
Blue Planet MCP API Reference Guide, Release 18.06 MCP reports using the REST API

• Deployment state
• Is multipoint
• Is bidirectional
• Number of endpoints
• Source name
• Source locations
• Source format
• Destination name
• Destination locations
• Destination format
• Resiliency
• Life cycle
• Description
• Frequency
• SRLG
• Fiber loss
• Planned margin
• Planned loss
• Operational state
• Admin state
• SNCG
• SNR margin

You can add, delete and adjust existing report parameters by adding a file with the following name:

• reporting_format_transport_client_report_v2_csv

in the docker container at the following location:

• /bp2/data/config/server-config

This file can omit any of the parameters listed above to omit that value from the report. Also, the
sequence of parameters in the .csv file is the sequence in which the parameters will be listed in the
report.

Transport client infrastructure reports

The reporting module supports the generation of a transport client infrastructure report with the following
parameters:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1218
Blue Planet MCP API Reference Guide, Release 18.06 MCP reports using the REST API

• id
• Name
• Customer name
• Overall type
• Layer rate
• Layer rate qualifier
• Deployment state
• Is multipoint
• Is bidirectional
• Number of endpoints
• Source name
• Source locations
• Source format
• Destination name
• Destination locations
• Destination format
• Resiliency
• Life cycle
• Description
• Frequency
• SRLG
• Fiber loss Source
• Fiber loss
• Operational state
• Admin state

You can add, delete and adjust existing report parameters by adding a file with the following name:

• reporting_format_transport_infrastructure_report_v2_csv

in the docker container at the following location:

• /bp2/data/config/server-config

This file can omit any of the parameters listed above to omit that value from the report. Also, the
sequence of parameters in the .csv file is the sequence in which the parameters will be listed in the
report.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1219
Blue Planet MCP API Reference Guide, Release 18.06 MCP reports using the REST API

Packet service reports

The reporting module supports the generation of a packet service report with the following parameters:

• Name
• Customer name
• Overall type
• Layer rate
• Layer rate qualifier
• Deployment state
• Is multipoint
• Is bidirectional
• Number of endpoints
• Source name
• Source locations
• Source format
• Destination name
• Destination locations
• Destination format
• Resiliency
• Life cycle
• Description

You can add, delete and adjust existing report parameters by adding a file with the following name:

• reporting_format_packet_service_report_v2_csv

in the docker container at the following location:

• /bp2/data/config/server-config

This file can omit any of the parameters listed above to omit that value from the report. Also, the
sequence of parameters in the .csv file is the sequence in which the parameters will be listed in the
report.

Packet infrastructure reports

The reporting module supports the generation of a packet infrastructure report with the following
parameters:

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1220
Blue Planet MCP API Reference Guide, Release 18.06 MCP reports using the REST API

• id
• Name
• Customer name
• Overall type
• Layer rate
• Layer rate qualifier
• Deployment state
• Is multipoint
• Is bidirectional
• Number of endpoints
• Source name
• Source locations
• Source format
• Destination name
• Destination locations
• Destination format
• Resiliency
• Life cycle
• Consumed bandwidth
• Max reservable bandwidth
• Max reservable bandwidth unit
• Percent consumed bandwidth

You can add, delete and adjust existing report parameters by adding a file with the following name:

• reporting_format_packet_infrastructure_report_v2_csv

in the docker container at the following location:

• /bp2/data/config/server-config

This file can omit any of the parameters listed above to omit that value from the report. Also, the
sequence of parameters in the .csv file is the sequence in which the parameters will be listed in the
report.

API call details

The tables below summarize the available commands for managing reports and report schedules using
the v2 reporting module.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1221
Blue Planet MCP API Reference Guide, Release 18.06 MCP reports using the REST API

Table 33. Reporting Version 2 API: {{BP_SERVER}}/reporting/api/v2/report/{resourceId}

REPORT ATTRIBUTE DETAILS

API /reporting/api/v2/report/{resourceId}

Request payload NA

Query parameter NA

Path parameter {resourceId}

Request content JSON

type

Response content JSON & CSV

type

Sample URL {{BP_SERVER}}/reporting/api/v2/report/ece539710ba64937b30b27d6e8e5fc01

Response Zip octet stream

Curl command curl -X GET

"{{BP_SERVER}}/reporting/api/v1/report/ece539710ba64937b30b27d6e8e5fc01"
-H "accept: application/json" -H "Authorization: Bearer a341bec9dc1dcd0f1e14"

Table 34. Reporting Version 2 API: {{BP_SERVER}}/reporting/api/v2/report/reportsinfo

REPORT ATTRIBUTE DETAILS

API /reporting/api/v2/report/reportsinfo

Request payload NA

Query parameter 1. fromDate (optional) 2. toDate (optional) 3. reportType (optional)

Path parameter NA

Request content JSON

type

Response content JSON

type

Sample URL {{BP_SERVER}}/reporting/api/v2/report/reportsinfo?fromDate=2018-02-

18T11%3A57%3A40.140Z&toDate=2018-02-
19T11%3A57%3A40.140Z&reportType=LLDP_LINKS_REPORT

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1222
Blue Planet MCP API Reference Guide, Release 18.06 MCP reports using the REST API

REPORT ATTRIBUTE DETAILS

Response {
"data": [
{
"id": "95b3efe3fe42431884c70d22d7b86bbb",
"type": "generatedReport",
"attributes": {
"resourceId": "95b3efe3fe42431884c70d22d7b86bbb",
"reportType": "LLDP_LINKS_REPORT",
"reportGenerationTime": "2018-05-22T11:38:00.423Z",
"reportStatus": "SUCCESS",
"reportGenerationMode": "ON_DEMAND"
}
}
],
"links": {},
"meta": {
"aggregations": [
{
"name": "reportStatus",
"buckets": [
{
"bucketKey": "Requested",
"bucketValue": "0"
},
{
"bucketKey": "Processing",
"bucketValue": "0"
},
{
"bucketKey": "Success",
"bucketValue": "1"
},
{
"bucketKey": "Failed",
"bucketValue": "0"
}
]
},
{
"name": "reportGenerationMode",
"buckets": [
{
"bucketKey": "On demand",
"bucketValue": "1"
},
{
"bucketKey": "Scheduled",
"bucketValue": "0"
}
]
}
]
}
}

Curl command curl -X GET "{{BP_SERVER}}/reporting/api/v1/report/reportsinfo?fromDate=2018-

02-18T11%3A57%3A40.140Z&toDate=2018-02-
19T11%3A57%3A40.140Z&reportType=LLDP_LINKS_REPORT" -H "accept:
application/json" -H "Authorization: Bearer a341bec9dc1dcd0f1e14

Table 35. Reporting Version 2 API: {{BP_SERVER}}/reporting/api/v2/report/reportinfo/{resourceId}

REPORT ATTRIBUTE DETAILS

API /reporting/api/v2/report/reportinfo/{resourceId}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1223
Blue Planet MCP API Reference Guide, Release 18.06 MCP reports using the REST API

REPORT ATTRIBUTE DETAILS

Request payload NA

Query parameter NA

Path parameter {resourceId}

Request content JSON

type

Response content JSON

type

Sample URL {{BP_SERVER}}/reporting/api/v2/report/reportinfo/ece539710ba64937b30b27d6e

8e5fc01

Response {
"data": [
{
"id": "281b4d163c8d4b0ba93a85aba7b8f771",
"type": "generatedReport",
"attributes": {
"resourceId": "281b4d163c8d4b0ba93a85aba7b8f771",
"reportType": "PW_CIR_REPORT",
"reportGenerationTime": "2018-05-23T04:36:06.480Z",
"reportStatus": "REQUESTED",
"reportGenerationMode": "ON_DEMAND"
}
}
],
"links": {},
"meta": {}
}

Curl command curl -X GET

"{{BP_SERVER}}/reporting/api/v1/report/reportinfo/ece539710ba64937b30b27d6
e8e5fc01" -H "accept: application/json" -H "Authorization: Bearer
a341bec9dc1dcd0f1e14"

Table 36. Reporting Version 2 API: {{BP_SERVER}}/reporting/api/v2/report/delete/{resourceId}

REPORT ATTRIBUTE DETAILS

API /reporting/api/v2/report/delete/{resourceId}

Request payload NA

Query parameter NA

Path parameter {resourceId}

Request content JSON

type

Response content JSON

type

Sample URL {{BP_SERVER}}/reporting/api/v2/report/delete/ece539710ba64937b30b27d6e8e5

fc01

Response Response code 204 received.

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1224
Blue Planet MCP API Reference Guide, Release 18.06 MCP reports using the REST API

REPORT ATTRIBUTE DETAILS

Curl command curl -X DELETE

"{{BP_SERVER}}/reporting/api/v1/report/delete/ece539710ba64937b30b27d6e8e
5fc01" -H "accept: application/json" -H "Authorization: Bearer
a341bec9dc1dcd0f1e14"

Table 37. Reporting Version 2 API: {{BP_SERVER}}/reporting/api/v2/report/delete

REPORT ATTRIBUTE DETAILS

API /reporting/api/v2/report/delete

Request payload NA

Query parameter 1. fromDate (Mandatory)

2. toDate (Mandatory)
3. reportType (Mandatory)

Path parameter NA

Request content JSON

type

Response content JSON

type

Sample URL {{BP_SERVER}}/reporting/api/v2/report/delete?fromDate=2018-02-

18T03%3A00%3A17.103Z&toDate=2018-02-
19T03%3A00%3A17.103Z&reportType=LLDP_LINKS_REPORT

Response Response code 204 received.

Curl command curl -X DELETE "{{BP_SERVER}}/reporting/api/v2/report/delete?fromDate=2018-

02-18T03%3A00%3A17.103Z&toDate=2018-02-
19T03%3A00%3A17.103Z&reportType=LLDP_LINKS_REPORT" -H "accept:
application/json" -H "Authorization: Bearer a341bec9dc1dcd0f1e14"

Table 38. Reporting Version 2 API: {{BP_SERVER}}/reporting/api/v2/report

REPORT ATTRIBUTE DETAILS

API /reporting/api/v2/report

Request payload {reportType="LLDP_LINKS_REPORT"}

or

{reportType="PW_CIR_REPORT"}

or

{reportType="PM_CRC_REPORT"}

or

{reportType="PM_DROPPED_PKTS_REPORT"}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1225
Blue Planet MCP API Reference Guide, Release 18.06 MCP reports using the REST API

REPORT ATTRIBUTE DETAILS

Query parameter NA

Path parameter NA

Request content JSON

type

Response content JSON

type

Sample URL {{BP_SERVER}}/reporting/api/v2/report

Response {
"data": [
{
"id": "281b4d163c8d4b0ba93a85aba7b8f771",
"type": "generatedReport",
"attributes": {
"resourceId": "281b4d163c8d4b0ba93a85aba7b8f771",
"reportType": "PW_CIR_REPORT",
"reportGenerationTime": "2018-05-23T04:36:06.480Z",
"reportStatus": "REQUESTED",
"reportGenerationMode": "ON_DEMAND"
}
}
],
"links": {},
"meta": {}
}

Curl command curl -X POST "{{BP_SERVER}}/reporting/api/v2/report" -H "accept:

application/json" -H "Authorization: Bearer a341bec9dc1dcd0f1e14" -H "Content-
Type: application/json" -d "{ \"reportType\": \"LLDP_LINKS_REPORT\"}"

Table 39. Reporting Version 2 API: {{BP_SERVER}}/reporting/api/v2/report/supported/reporttype

REPORT ATTRIBUTE DETAILS

API /reporting/api/v2/report/supported/reporttype

Request payload NA

Query parameter NA

Path parameter NA

Request content JSON

type

Response content JSON

type

Sample URL {{BP_SERVER}}/reporting/api/v2/report/supported/reporttype

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1226
Blue Planet MCP API Reference Guide, Release 18.06 MCP reports using the REST API

REPORT ATTRIBUTE DETAILS

Response {
"data": {
"type": "supportedreporttypes",
"links": {},
"attributes": {
"supportedReportTypeList": [
{
"reportType": "LLDP_LNIKS_REPORT",
"description": "This report provides all LLDP links
information."
},
{
"reportType": "PW_CIR_REPORT",
"description": "This report provides PW and all related
service's CIR details."
},
{
"reportType": "PM_CRC_REPORT",
"description": "This report provides LLDP Port CRC
errors."
}
]
}
},
"links": {},
"meta": {}
}

Curl command curl -X GET "{{BP_SERVER}}/reporting/api/v2/report/supported/reporttype" -H

"accept: application/vnd.api+json" -H "Authorization: Bearer
f2d0a70da68dbfd71e98"

Table 40. Reporting Version 2 API: {{BP_SERVER}}/reporting/api/v2/schedule/{resourceId}

REPORT ATTRIBUTE DETAILS

API /reporting/api/v2/schedule/{resourceId}

Request payload NA

Query parameter NA

Path parameter {resourceId}

Request content JSON

type

Response content JSON

type

Sample URL {{BP_SERVER}}/reporting/api/v2/schedule/e4aef0c0812c4f4181d4a63be50f7b54

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1227
Blue Planet MCP API Reference Guide, Release 18.06 MCP reports using the REST API

REPORT ATTRIBUTE DETAILS

Response {
"data": [
{
"id": "ddbad61a1eb544e98bb7b829a034aef7",
"type": "reportingSchedule",
"attributes": {
"resourceId": "ddbad61a1eb544e98bb7b829a034aef7",
"reportType": "LLDP_LINKS_REPORT",
"cronExpression": "00 00 19 23 May ? 2018",
"cronExpressionFormat": "QUARTZ",
"cronDescription": "at 19:00 at 23 day at May month at 2018 year"
}
}
],
"links": {},
"meta": {}
}

Curl command curl -X GET

"{{BP_SERVER}}/reporting/api/v2/schedule/e4aef0c0812c4f4181d4a63be50f7b5
4" -H "accept: application/json" -H "Authorization: Bearer a341bec9dc1dcd0f1e14"

Table 41. Reporting Version 2 API: {{BP_SERVER}}/reporting/api/v2/schedule/delete/{resourceId}

REPORT ATTRIBUTE DETAILS

API /reporting/api/v2/schedule/delete/{resourceId}

Request payload NA

Query parameter NA

Path parameter {resourceId}

Request content JSON

type

Response content JSON

type

Sample URL {{BP_SERVER}}/reporting/api/v2/schedule/delete/e4aef0c0812c4f4181d4a63be5

0f7b54

Response Response code 204 received.

Curl command curl -X DELETE

"{{BP_SERVER}}/reporting/api/v2/schedule/delete/e4aef0c0812c4f4181d4a63be5
0f7b54" -H "accept: application/json" -H "Authorization: Bearer
a341bec9dc1dcd0f1e14"

Table 42. Reporting Version 2 API: {{BP_SERVER}}/reporting/api/v2/schedule/create

REPORT ATTRIBUTE DETAILS

API /reporting/api/v2/schedule/create

Request payload NA

Query parameter reportType

Path parameter NA

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1228
Blue Planet MCP API Reference Guide, Release 18.06 MCP reports using the REST API

REPORT ATTRIBUTE DETAILS

Request content JSON

type

Response content JSON

type

Sample URL {{BP_SERVER}}/reporting/api/v2/schedule/create

Response {
"data": [
{
"id": "ddbad61a1eb544e98bb7b829a034aef7",
"type": "reportingSchedule",
"attributes": {
"resourceId": "ddbad61a1eb544e98bb7b829a034aef7",
"reportType": "LLDP_LINKS_REPORT",
"cronExpression": "00 00 19 23 May ? 2018",
"cronExpressionFormat": "QUARTZ",
"cronDescription": "at 19:00 at 23 day at May month at 2018 year"
}
}
],
"links": {},
"meta": {}
}

Curl command curl -X POST "{{BP_SERVER}}/reporting/api/v2/schedule/create" -H "accept:

application/json" -H "Authorization: Bearer a341bec9dc1dcd0f1e14" -H "Content-
Type: application/json" -d "{ \"StartTime\": \"2018-03-19T12:15:21.559Z\",
\"reportType\": \"LLDP_LINKS_REPORT\"}"

Table 43. Reporting Version 2 API: {{BP_SERVER}}/reporting/api/v2/schedule

REPORT ATTRIBUTE DETAILS

API call /reporting/api/v2/schedule

Request payload NA

Query parameter reportType

Path parameter NA

Request content JSON

type

Response content JSON

type

Sample URL {{BP_SERVER}}/reporting/api/v2/schedule?reportType=LLDP_LINKS_REPORT

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1229
Blue Planet MCP API Reference Guide, Release 18.06 MCP reports using the REST API

REPORT ATTRIBUTE DETAILS

Response {
"data": [
{
"id": "ddbad61a1eb544e98bb7b829a034aef7",
"type": "reportingSchedule",
"attributes": {
"resourceId": "ddbad61a1eb544e98bb7b829a034aef7",
"reportType": "LLDP_LINKS_REPORT",
"cronExpression": "00 00 19 23 May ? 2018",
"cronExpressionFormat": "QUARTZ",
"cronDescription": "at 19:00 at 23 day at May month at 2018 year"
}
}
],
"links": {},
"meta": {}
}

Curl command curl -X GET

"{{BP_SERVER}}/reporting/api/v2/schedule?reportType=LLDP_LINKS_REPORT" -H
"accept: application/json" -H "Authorization: Bearer a341bec9dc1dcd0f1e14"

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1230
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

Appendix A: Blue Planet MCP REST API

permissions
This table lists the roles that can perform specific REST API calls in Blue Planet MCP.

Table 44. MCP REST API permissions and roles

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

UAC GET Application Network admin Observer Planner admin

/api/v1/api- admin
keys/

UAC POST Application Network admin Observer Planner admin

/api/v1/api- admin
keys/

UAC DELETE Application Network admin Observer Planner admin

/api/v1/api- admin
keys/{keyId}

UAC GET Application Network admin Observer Planner admin

/api/v1/api- admin
keys/{keyId}

UAC GET
/api/v1/applica
tions

UAC POST
/api/v1/applica
tions

UAC DELETE
/api/v1/applica
tions/{uuid}

UAC GET
/api/v1/applica
tions/{uuid}

UAC PATCH
/api/v1/applica
tions/{uuid}

UAC PUT
/api/v1/applica
tions/{uuid}

UAC POST
/api/v1/auth

UAC GET
/api/v1/current
-user

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1231
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

UAC GET
/api/v1/current
-user/login_inf
o

UAC GET Application

/api/v1/health- admin
check

UAC GET Application

/api/v1/ldap- admin
configs

UAC POST Application

/api/v1/ldap- admin
configs

UAC GET Application

/api/v1/ldap- admin
configs/{uuid}

UAC PATCH Application

/api/v1/ldap- admin
configs/{uuid}

UAC PUT Application

/api/v1/ldap- admin
configs/{uuid}

UAC GET Application

/api/v1/login- admin
detail

UAC GET
/api/v1/login-
info

UAC POST
/api/v1/logout

UAC GET Application

/api/v1/notific admin
ation-config

UAC GET Application

/api/v1/notific admin
ation-
config/{uuid}

UAC PATCH Application

/api/v1/notific admin
ation-
config/{uuid}

UAC PUT Application

/api/v1/notific admin
ation-
config/{uuid}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1232
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

UAC POST
/api/v1/oauth2
/tokens

UAC DELETE
/api/v1/oauth2
/tokens/{token
}

UAC POST
/api/v1/oauth2
/tokens/{token
}/change_tena
nt_context

UAC POST Application

/api/v1/partitio admin
ns

UAC GET Application

/api/v1/partitio admin
ns

UAC PUT Application

/api/v1/partitio admin
ns/{uuid}

UAC GET Application Network admin Observer Planner admin

/api/v1/partitio admin
ns/{uuid}

UAC PATCH Application

/api/v1/partitio admin
ns/{uuid}

UAC GET Application Network admin Observer Planner admin

/api/v1/passw admin
ordpolicies

UAC POST Application

/api/v1/passw admin
ordpolicies

UAC GET Application Network admin Observer Planner admin

/api/v1/passw admin
ordpolicies/{uu
id}

UAC PATCH Application

/api/v1/passw admin
ordpolicies/{uu
id}

UAC PUT Application

/api/v1/passw admin
ordpolicies/{uu
id}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1233
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

UAC GET Application

/api/v1/permis admin
sions

UAC POST Application

/api/v1/permis admin
sions

UAC DELETE Application

/api/v1/permis admin
sions/{uuid}

UAC GET Application Network admin Observer Planner admin

/api/v1/permis admin
sions/{uuid}

UAC PATCH Application

/api/v1/permis admin
sions/{uuid}

UAC PUT Application

/api/v1/permis admin
sions/{uuid}

UAC POST Application

/api/v1/permis admin
sions/{uuid}/a
dd_resources

UAC POST Application

/api/v1/permis admin
sions/{uuid}/re
move_resource
s

UAC GET Application

/api/v1/radius- admin
configs

UAC POST Application

/api/v1/radius- admin
configs

UAC GET Application

/api/v1/radius- Admin
configs/{uuid}

UAC PATCH Application

/api/v1/radius- admin
configs/{uuid}

UAC PUT Application

/api/v1/radius- admin
configs/{uuid}

UAC GET Application

/api/v1/registe admin
r

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1234
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

UAC POST
/api/v1/registe
r

UAC POST Application

/api/v1/registe admin
r/approve_user
s

UAC POST
/api/v1/registe
r/confirm_emai
l

UAC POST
/api/v1/registe
r/forgot_passw
ord

UAC POST Application

/api/v1/registe admin
r/reject_users

UAC POST
/api/v1/registe
r/resend_confir
mation

UAC POST
/api/v1/registe
r/set_passwor
d

UAC GET Application

/api/v1/roles admin

UAC POST Application

/api/v1/roles admin

UAC DELETE Application

/api/v1/roles/{ admin
uuid}

UAC GET Application Network admin Observer Planner admin

/api/v1/roles/{ admin
uuid}

UAC PATCH Application

/api/v1/roles/{ admin
uuid}

UAC PUT Application

/api/v1/roles/{ admin
uuid}

UAC POST Application

/api/v1/roles/{ admin
uuid}/add_pare
nts

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1235
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

UAC POST Application

/api/v1/roles/{ admin
uuid}/add_per
missions

UAC POST Application

/api/v1/roles/{ admin
uuid}/add_user
s

UAC POST Application

/api/v1/roles/{ admin
uuid}/remove_
parents

UAC POST Application

/api/v1/roles/{ admin
uuid}/remove_
permissions

UAC POST Application

/api/v1/roles/{ admin
uuid}/remove_
users

UAC GET Application

/api/v1/resour admin
ces

UAC POST Application

/api/v1/resour admin
ces

UAC DELETE Application

/api/v1/resour admin
ces/{uuid}

UAC GET Application Network admin Observer Planner admin

/api/v1/resour admin
ces/{uuid}

UAC PATCH Application

/api/v1/resour admin
ces/{uuid}

UAC PUT Application

/api/v1/resour admin
ces/{uuid}

UAC GET Application

/api/v1/sessio admin
ns

UAC DELETE Application

/api/v1/sessio admin
ns/{session_id}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1236
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

UAC GET Application

/api/v1/sessio admin
ns/{session_id}

UAC GET Application Network admin Observer Planner admin

/api/v1/tenant admin
s

UAC POST Application

/api/v1/tenant admin
s

UAC GET Application Network admin Observer Planner admin

/api/v1/tenant admin
s/{uuid}

UAC PATCH Application

/api/v1/tenant admin
s/{uuid}

UAC PUT Application

/api/v1/tenant admin
s/{uuid}

UAC GET Application Network admin Observer Planner admin

/api/v1/tenant admin
s/{uuid}/subte
nants

UAC POST
/api/v1/tokens

UAC DELETE
/api/v1/tokens
/{token}

UAC POST Application

/api/v1/tokens admin
/{token}/chang
e_tenant_conte
xt

UAC GET Application Network admin Observer Planner admin

/api/v1/usergr admin
oups

UAC POST Application

/api/v1/usergr admin
oups

UAC DELETE Application

/api/v1/usergr admin
oups/{uuid}

UAC GET Application Network admin Observer Planner admin

/api/v1/usergr admin
oups/{uuid}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1237
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

UAC PATCH Application

/api/v1/usergr admin
oups/{uuid}

UAC PUT Application

/api/v1/usergr admin
oups/{uuid}

UAC POST Application

/api/v1/usergr admin
oups/{uuid}/ad
d_parents

UAC POST Application

/api/v1/usergr admin
oups/{uuid}/ad
d_roles

UAC POST Application

/api/v1/usergr admin
oups/{uuid}/ad
d_users

UAC POST Application

/api/v1/usergr admin
oups/{uuid}/re
move_parents

UAC POST Application

/api/v1/usergr admin
oups/{uuid}/re
move_roles

UAC POST Application

/api/v1/usergr admin
oups/{uuid}/re
move_users

UAC GET Application Network admin Observer Planner admin

/api/v1/users admin

UAC POST Application

/api/v1/users admin

UAC DELETE Application

/api/v1/users/{ admin
uuid}

UAC GET Application Network admin Observer Planner admin

/api/v1/users/{ admin
uuid}

UAC PATCH Application

/api/v1/users/{ admin
uuid}

UAC PUT Application

/api/v1/users/{ admin
uuid}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1238
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

UAC POST Application

/api/v1/users/{ admin
uuid}/add_role
s

UAC POST Application

/api/v1/users/{ admin
uuid}/add_user
groups

UAC POST Application

/api/v1/users/{ admin
uuid}/remove_r
oles

UAC POST Application

/api/v1/users/{ admin
uuid}/remove_
usergroups

UAC POST Application

/api/v1/users/{ admin
uuid}/reset_pa
ssword

UAC POST
/api/v1/users/{
uuid}/set_pass
word

UAC POST Application

/api/v1/users/{ admin
uuid}/update_l
ocked_state

NE Connection GET Application Network admin Observer Planner admin

Profiles /discovery/api/ admin
neprofiles

NE Connection POST Application Network admin

Profiles /discovery/api/ admin
neprofiles

NE Connection DELETE Application Network admin

Profiles /discovery/api/ admin
neprofiles/{id}

NE Connection GET Application Network admin Observer Planner admin

Profiles /discovery/api/ admin
neprofiles/{id}

NE Connection PUT Application Network admin

Profiles /discovery/api/ admin
neprofiles/{id}

NE Connection GET Application Network admin Observer Planner admin

Profiles /rbac/api/v3/n admin
eprofiles

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1239
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

NE Connection POST Application Network admin

Profiles /rbac/api/v3/n admin
eprofiles

NE Connection DELETE Application Network admin

Profiles /rbac/api/v3/n admin
eprofiles/{id}

NE Connection GET Application Network admin Observer Planner admin

Profiles /rbac/api/v3/n admin
eprofiles/{id}

NE Connection PUT Application Network admin

Profiles /rbac/api/v3/n admin
eprofiles/{id}

NE Connection GET Application Network admin Observer Planner admin

Profiles /discovery/api/ admin
(mgmtSession v1/neprofiles
s)

NE Connection POST Application Network admin

Profiles /discovery/api/ admin
(mgmtSession v1/neprofiles
s)

NE Connection DELETE Application Network admin

Profiles /discovery/api/ admin
(mgmtSession v1/neprofiles/{i
s) d}

NE Connection GET Application Network admin Observer Planner admin

Profiles /discovery/api/ admin
(mgmtSession v1/neprofiles/{i
s) d}

NE Connection PUT Application Network admin

Profiles /discovery/api/ admin
(mgmtSession v1/neprofiles/{i
s) d}

RADIUS Server POST Application Network admin

Profiles /rbac/api/v1/ra admin
diusprofiles

RADIUS Server GET Application Network admin Observer Planner admin

Profiles /rbac/api/v1/ra admin
diusprofiles

RADIUS Server GET Application Network admin Observer Planner admin

Profiles /rbac/api/v1/ra admin
diusprofiles/{id
}

RADIUS Server DELETE Application Network admin

Profiles /rbac/api/v1/ra admin
diusprofiles/{id
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1240
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

RADIUS Server PUT Application Network admin

Profiles /rbac/api/v1/ra admin
diusprofiles/{id
}

Alarms GET Application Network admin Observer

/nsa/api/v1/al admin
arms

Alarms GET Application Network admin Observer

/nsa/api/v1/al admin
arms/alarmRec
ordsCounts

Alarms GET Application Network admin Observer

/nsa/api/v1/al admin
arms/device-
types

Alarms GET Application Network admin Observer

/nsa/api/v1/al admin
arms/deviceAtt
ributes/{Id}

Alarms GET Application Network admin Observer

/nsa/api/v1/al admin
arms/{Id}

Alarms POST Network admin

/nsa/api/v1/al
arms/{Id}/ackn
owledge

Alarms POST Network admin

/nsa/api/v1/al
arms/{Id}/forc
e-clear

Alarms POST Network admin

/nsa/api/v1/al
arms/{Id}/man
ual-clear

Alarms POST Network admin

/nsa/api/v1/al
arms/{Id}/unac
knowledge

Alarms GET Application Network admin Observer

/nsa/api/v1/al admin
arms/filter/acti
veAlarms

Alarms GET Application Network admin Observer

/nsa/api/v1/al admin
arms/filter/hist
oricalAlarms

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1241
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Alarms GET Application Network admin Observer

/nsa/api/v2_0/ admin
alarms/filter/a
ctiveAlarms

Alarms GET Application Network admin Observer

/nsa/api/v2_0/ admin
alarms/filter/fil
teredAlarms

Alarms GET Application Network admin Observer

/nsa/api/v2_0/ admin
alarms/filter/fil
teredAlarms/{I
d}

Alarms GET Application Network admin Observer

/nsa/api/v2_0/ admin
alarms/filter/hi
storicalAlarms

Alarms POST Network admin

/nsa/api/v2_0/
alarms/filter

Alarms GET Application Network admin Observer

/nsa/api/v2_0/ admin
alarms/filter

Alarms DELETE Network admin

/nsa/api/v2_0/
alarms/filter/{c
hannel}

Alarms GET Application Network admin Observer

/nsa/api/v1/al admin
arms/historical
DataRetention
Days

Alarms PUT Network admin

/nsa/api/v1/al
arms/historical
DataRetention
Days/{retention
Days}

Alarms DELETE Network admin

/nsa/api/v1/al
arms/historical
Alarms/{retenti
onDate}

Correlator GET /events-to- Application Network admin Observer

service- admin
correlator/api/
v1/affectedSer
vices

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1242
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Correlator GET /events-to- Application Network admin Observer

service- admin
correlator/api/
v1/affectedSer
vicesCounts

Commissionin POST/commis Planner admin

g sioning/api/v1/
scripts/

Commissionin POST Network admin

g /commissionin
g/api/v1/equip
ment/

Commissionin GET Network admin Planner admin

g /commissionin
g/api/v1/script
s/

Commissionin DELETE Network admin Planner admin

g /commissionin
g/api/v1/script
s/

Commissionin POST Planner admin

g /commissionin
g/api/v1/servic
es/

Commissionin GET Application Network admin Observer Planner admin

g /commissionin admin
g/api/v1/servic
es/

Commissionin POST Planner admin

g /commissionin
g/api/v1/ipsub
net/

Commissionin GET Application Network admin Observer Planner admin

g /commissionin admin
g/api/v1/ipsub
net/

Commissionin DELETE Planner admin

g /commissionin
g/api/v1/ipsub
net/

Commissionin GET Application Network admin Observer Planner admin

g /commissionin admin
g/api/v1/policy
/

Commissionin DELETE Planner admin

g /commissionin
g/api/v1/policy
/

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1243
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Commissionin POST Planner admin

g /commissionin
g/api/v1/policy
/

Commissionin PUT Planner admin

g /commissionin
g/api/v1/policy
/

Commissionin GET Application Network admin Observer Planner admin

g /commissionin admin
g/api/v1/policy
Types/

Commissionin GET Application Network admin Observer Planner admin

g /commissionin admin
g/api/v1/policy
Defaults/

Commissionin DELETE Planner admin

g /commissionin
g/api/v1/policy
Defaults/

Commissionin POST Planner admin

g /commissionin
g/api/v1/policy
Defaults/

Commissionin PUT Planner admin

g /commissionin
g/api/v1/policy
Defaults/

Commissionin POST Planner admin

g /commissionin
g/api/v1/deplo
yedIPv4Data/

Commissionin GET Application Network admin Observer Planner admin

g /commissionin admin
g/api/v1/deplo
yedIPv4Data/

Commissionin DELETE Planner admin

g /commissionin
g/api/v1/deplo
yedIPv4Data/

Network POST Network admin

element /configmgmt/a
configuration pi/v1/createBa
tch

Network GET Application Network admin Observer

element /configmgmt/a admin
configuration pi/v1/batches

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1244
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Network GET Application Network admin Observer

element /configmgmt/a admin
configuration pi/v1/batches/
{batchId}

Network PUT Network admin

element /configmgmt/a
configuration pi/v1/batches/
{batchId}

Network POST Network admin

element /configmgmt/a
configuration pi/v1/deleteBat
ch

Network PATCH Network admin

element /configmgmt/a
configuration pi/v1/batchesS
chedule

Network GET Application Network admin Observer

element /configmgmt/a admin
configuration pi/v1/backupR
estoreStatus

Network GET Application Network admin Observer

element /configmgmt/a admin
configuration pi/v1/backupI
mages

Network POST Network admin

element /configmgmt/a
configuration pi/v1/callback
ConfigJob

Network GET Application Network admin Observer

element /configmgmt/a admin
configuration pi/v1/nes/{bat
chId}

Network GET Application Network admin Observer

element /configmgmt/a admin
configuration pi/v1/jobs

Network GET Application Network admin Observer

element /configmgmt/a admin
configuration pi/v1/jobs/{job
Id}

Network POST Network admin

element /configmgmt/a
configuration pi/v1/jobs

Network DELETE Network admin

element /configmgmt/a
configuration pi/v1/jobs/{job
Id}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1245
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Network PATCH Network admin

element /configmgmt/a
configuration pi/v1/jobs/{job
Id}

Network GET Application Network admin Observer

element /configmgmt/a admin
configuration pi/v1/resource
s/{resourceId}

Network GET Application Network admin Observer

element /configmgmt/a admin
configuration pi/v1/resource
s/{resourceId}/
history

Network DELETE Network admin

element /configmgmt/a
configuration pi/v1/resource
s/{resourceId}

Network PATCH Network admin

element /configmgmt/a
configuration pi/v1/resource
s/{resourceId}

Network POST Network admin

element /configmgmt/a
configuration pi/v1/profiles

Network GET Application Network admin Observer

element /configmgmt/a admin
configuration pi/v1/profiles

Network GET Application Network admin Observer

element /configmgmt/a admin
configuration pi/v1/profiles/{
profileName}

Network DELETE Network admin

element /configmgmt/a
configuration pi/v1/profiles/{
profileId}

Network GET Application Network admin Observer

element /configmgmt/a admin
configuration pi/v1/scripts

Network GET Application Network admin Observer

element /configmgmt/a admin
configuration pi/v1/scriptsBy
TypeGroup/{ty
peGroup}

Network GET Application Network admin Observer

element /configmgmt/a admin
configuration pi/v1/scriptsBy
Name/{scriptN
ame}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1246
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Network GET Application Network admin Observer Planner admin

element /configmgmt/a admin
configuration pi/v1/customS
cripts

Network POST Network admin

element /configmgmt/a
configuration pi/v1/customS
cripts

Network GET Application Network admin Observer Planner admin

element /configmgmt/a admin
configuration pi/v1/customS
cripts/{id}

Network DELETE Network admin

element /configmgmt/a
configuration pi/v1/customS
cripts/{id}

Network GET Application Network admin Observer Planner admin

element /configmgmt/a admin
configuration pi/v1/customS
cripts/scriptSta
tus

Network GET Application Network admin Observer Planner admin

element /configmgmt/a admin
configuration pi/v1/scriptPro
files

Network POST Network admin

element /configmgmt/a
configuration pi/v1/scriptPro
files

Network GET
element /configmgmt/a
configuration pi/v1/scriptPro
files/{id}

Network DELETE Network admin

element /configmgmt/a
configuration pi/v1/scriptPro
files/{id}

Network GET Application Network admin Observer Planner admin

element /discovery/api/ admin
enrollment v1/manageme
(management ntSessions
sessions)

Network POST Network admin

element /discovery/api/
enrollment v1/manageme
(management ntSessions/de
sessions) enroll

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1247
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Network POST Network admin

element /discovery/api/
enrollment v1/manageme
(management ntSessions/res
sessions) yncOperation

Network POST Network admin

element /discovery/api/
enrollment v1/manageme
(management ntSessions/sta
sessions) ge

Network GET Application Network admin Observer Planner admin

element /discovery/api/ admin
enrollment v1/manageme
(management ntSessions/{se
sessions) ssionId}

Network POST Network admin

element /discovery/api/
enrollment v2_0/enrollmen
(management t
sessions)

Network GET Application Network admin Observer Planner admin

element /discovery/api/ admin
enrollment v2_0/manage
(management mentSessions
sessions)

Network POST Network admin

element /discovery/api/
enrollment v2_0/manage
(management mentSessions/
sessions) deenroll

Network POST Network admin

element /discovery/api/
enrollment v2_0/manage
(management mentSessions/
sessions) resyncOperatio
n

Network POST Network admin

element /discovery/api/
enrollment v2_0/manage
(management mentSessions/
sessions) stage

Network GET Application Network admin Observer Planner admin

element /discovery/api/ admin
enrollment v2_0/manage
(management mentSessions/
sessions) {sessionId}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1248
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Network GET Application Network admin Observer Planner admin

element /discovery/api/ admin
enrollment v3/manageme
(management ntSessions
sessions)

Network POST Network admin

element /discovery/api/
enrollment v3/manageme
(management ntSessions
sessions)

Network DELETE Network admin

element /discovery/api/
enrollment v3/manageme
(management ntSessions/{se
sessions) ssionId}

Network GET Application Network admin Observer Planner admin

element /discovery/api/ admin
enrollment v3/manageme
(management ntSessions/{se
sessions) ssionId}

Network PUT Network admin

element /discovery/api/
enrollment v3/manageme
(management ntSessions/{se
sessions) ssionId}/discov
eryState

Network GET Application Network admin Observer Planner admin

element /discovery/api/ admin
enrollment v4/manageme
(management ntSessions
sessions)

Network PATCH Network admin

element /discovery/api/
enrollment v4/manageme
(management ntSessions/{se
sessions) ssionId}

Network GET Application Network admin Observer Planner admin

element /discovery/api/ admin
enrollment managementS
(management essions
sessions)

Network POST Network admin

element /discovery/api/
enrollment managementS
(management essions
sessions)

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1249
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Network POST Network admin

element /discovery/api/
enrollment managementS
(management essions/resync
sessions) Operation

Network DELETE Network admin

element /discovery/api/
enrollment managementS
(management essions/{sessi
sessions) onId}

Network GET Application Network admin Observer Planner admin

element /discovery/api/ admin
enrollment managementS
(management essions/{sessi
sessions) onId}

Network PATCH Network admin

element /discovery/api/
enrollment managementS
(management essions/{sessi
sessions) onId}

Network PUT Network admin

element /discovery/api/
enrollment managementS
(management essions/{sessi
sessions) onId}/discover
yState

Equipment and GET Planner admin

Topology /equipmenttop
Planning ologyplanning/
api/v1/AutoSla
tData/{projectI
d}

Equipment and GET Planner admin

Topology /equipmenttop
Planning ologyplanning/
api/v1/AutoSla
tData/name/{p
rojectName}

Equipment and POST Planner admin

Topology /equipmenttop
Planning ologyplanning/
api/v1/Equipm
ent

Equipment and GET Application Observer Planner admin

Topology /equipmenttop admin
Planning ologyplanning/
api/v1/Equipm
entSummary/{
projectId}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1250
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Equipment and GET Application Observer Planner admin

Topology /equipmenttop admin
Planning ologyplanning/
api/v1/Equipm
entSummary

Equipment and GET Application Observer Planner admin

Topology /equipmenttop admin
Planning ologyplanning/
api/v2/Equipm
entSummary

Equipment and GET Application Observer Planner admin

Topology /equipmenttop admin
Planning ologyplanning/
api/v1/Equipm
entSummary/p
rojectView

Equipment and POST Planner admin

Topology /equipmenttop
Planning ologyplanning/
api/v1/FiberRo
utes

Equipment and GET Application Observer Planner admin

Topology /equipmenttop admin
Planning ologyplanning/
api/v1/Planned
Data/fiberLoss

Equipment and POST Planner admin

Topology /equipmenttop
Planning ologyplanning/
api/v1/Planned
Data/enterLoss

Equipment and GET Application Observer Planner admin

Topology /equipmenttop admin
Planning ologyplanning/
api/v3/Equipm
entSummary

Equipment and GET Application Observer Planner admin

Topology /equipmenttop admin
Planning ologyplanning/
api/v1/GlobalC
onfigurationDa
ta

Equipment and PUT Planner admin

Topology /equipmenttop
Planning ologyplanning/
api/v1/GlobalC
onfigurationDa
ta/HeatDissipa
tionValue/{heat
DissipationVal
ue}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1251
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Equipment and PUT Planner admin

Topology /equipmenttop
Planning ologyplanning/
api/v1/GlobalC
onfigurationDa
ta/SingleILASit
eLabel/{singleI
LASiteLabelVal
ue}

Equipment and PUT Planner admin

Topology /equipmenttop
Planning ologyplanning/
api/v1/GlobalC
onfigurationDa
ta/DualILASite
Label/{dualILA
SiteLabelValue
}

Equipment and PUT Planner admin

Topology /equipmenttop
Planning ologyplanning/
api/v1/GlobalC
onfigurationDa
ta/DgeWithSin
gleILASiteLabel
/{DgeWithSingl
eILASiteLabelV
alue}

Equipment and PUT Planner admin

Topology /equipmenttop
Planning ologyplanning/
api/v1/GlobalC
onfigurationDa
ta/DgeWithAto
ZDualILAZtoAS
ingleILASiteLa
bel/{DgeWithAt
oZDualILAZtoA
SingleILASiteL
abelValue}

Equipment and PUT Planner admin

Topology /equipmenttop
Planning ologyplanning/
api/v1/GlobalC
onfigurationDa
ta/DgeWithAto
ZSingleILAZto
ADualILASiteLa
bel/{DgeWithAt
oZSingleILAZto
ADualILASiteLa
belValue}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1252
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Equipment and PUT Planner admin

Topology /equipmenttop
Planning ologyplanning/
api/v1/GlobalC
onfigurationDa
ta/DgeWithDua
lILASiteLabel/{
DgeWithDualIL
ASiteLabelValu
e}

Equipment GET Application Network admin Observer

planning and /ifd/api/equip admin
provisioning mentIntents

Equipment POST Network admin

planning and /ifd/api/equip
provisioning mentIntents

Equipment DELETE Network admin

planning and /ifd/api/equip
provisioning mentIntents/{i
d}

Equipment GET Application Network admin Observer

planning and /ifd/api/v2/equ admin
provisioning ipmentIntents

Equipment POST Network admin

planning and /ifd/api/v2/equ
provisioning ipmentIntents

Equipment DELETE Network admin

planning and /ifd/api/v2/equ
provisioning ipmentIntents/
{id}

Equipment GET Application Network admin Observer

planning and /ifd/api/v1/equ admin
provisioning ipmentIntents

Equipment POST Network admin

planning and /ifd/api/v1/equ
provisioning ipmentIntents

Equipment DELETE Network admin

planning and /ifd/api/v1/equ
provisioning ipmentIntents/
{id}

Intent GET Application Network admin Observer

Fulfillment /ifd/api/equip admin
Designer (IFD) mentIntents/{i
Equipment d}

Intent GET Application Network admin Observer

Fulfillment /ifd/api/v2/equ admin
Designer (IFD) ipmentIntents/
Equipment {id}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1253
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Intent GET Application Network admin Observer

Fulfillment /ifd/api/v1/equ admin
Designer (IFD) ipmentIntents/
Equipment {id}

Intent GET Application Network admin Observer

Fulfillment /ifd/api/v2/ser admin
Designer (IFD) viceIntents
Service

Intent POST Network admin

Fulfillment /ifd/api/v2/ser
Designer (IFD) viceIntents
Service

Intent DELETE Network admin

Fulfillment /ifd/api/v2/ser
Designer (IFD) viceIntents/{id}
Service

Intent GET Application Network admin Observer

Fulfillment /ifd/api/v2/ser admin
Designer (IFD) viceIntents/{id}
Service

Intent POST Network admin

Fulfillment /ifd/api/v2/ser
Designer (IFD) viceIntents/{id}
Service /deploy

Intent POST Network admin

Fulfillment /ifd/api/v2/ser
Designer (IFD) viceIntents/{id}
Service /forceFailState

Intent POST Network admin

Fulfillment /ifd/api/v2/ser
Designer (IFD) viceIntents/{id}
Service /promote

Intent GET Application Network admin Observer

Fulfillment /ifd/api/v2/ser admin
Designer (IFD) viceIntents/{id}
Service /resourceTrack
ers

Intent GET Application Network admin Observer

Fulfillment /ifd/api/v2/ser admin
Designer (IFD) viceIntents/{id}
Service /route

Intent POST Network admin

Fulfillment /ifd/api/v2/ser
Designer (IFD) viceIntents/{id}
Service /undeploy

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1254
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Intent PUT Network admin

Fulfillment /ifd/api/v2/ser
Designer (IFD) viceIntents/{id}
Service /update

Intent GET Application Network admin Observer

Fulfillment /ifd/api/v1/ser admin
Designer (IFD) viceIntents
Service

Intent POST Network admin

Fulfillment /ifd/api/v1/ser
Designer (IFD) viceIntents
Service

Intent DELETE Network admin

Fulfillment /ifd/api/v1/ser
Designer (IFD) viceIntents/{id}
Service

Intent GET Application Network admin Observer

Fulfillment /ifd/api/v1/ser admin
Designer (IFD) viceIntents/{id}
Service

Intent POST Network admin

Fulfillment /ifd/api/v1/ser
Designer (IFD) viceIntents/{id}
Service /deploy

Intent POST Network admin

Fulfillment /ifd/api/v1/ser
Designer (IFD) viceIntents/{id}
Service /deploy2

Intent POST Network admin

Fulfillment /ifd/api/v1/ser
Designer (IFD) viceIntents/{id}
Service /deploy3

Intent POST Network admin

Fulfillment /ifd/api/v1/ser
Designer (IFD) viceIntents/{id}
Service /forceFailState

Intent POST Network admin

Fulfillment /ifd/api/v1/ser
Designer (IFD) viceIntents/{id}
Service /promote

Intent GET Application Network admin Observer

Fulfillment /ifd/api/v1/ser admin
Designer (IFD) viceIntents/{id}
Service /resourceTrack
ers

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1255
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Intent GET Application Network admin Observer

Fulfillment /ifd/api/v1/ser admin
Designer (IFD) viceIntents/{id}
Service /route

Intent POST Network admin

Fulfillment /ifd/api/v1/ser
Designer (IFD) viceIntents/{id}
Service /undeploy

Intent PUT Network admin

Fulfillment /ifd/api/v1/ser
Designer (IFD) viceIntents/{id}
Service /update

Intent POST Network admin

Fulfillment /ifd/api/v1/ser
Designer (IFD) viceIntents/get
Service FeasibleRoute

Capability POST Network admin

/nsi/api/v1/ca
pability

Capability POST Network admin

/nsi/api/v2_0/c
apability

Equipment GET Application Network admin Observer Planner admin

/nsi/api/v2_0/e admin
quipment

Equipment POST Network admin

/nsi/api/v2_0/e
quipment

Equipment POST Network admin

/nsi/api/v2_0/e
quipment/main
tenanceOperati
ons

Equipment DELETE Network admin

/nsi/api/v2_0/e
quipment/{equi
pmentId}

Equipment GET Application Network admin Observer Planner admin

/nsi/api/v2_0/e admin
quipment/{equi
pmentId}/equip
mentExpectati
ons

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1256
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Equipment DELETE Network admin

/nsi/api/v2_0/e
quipment/{equi
pmentId}/equip
mentExpectati
ons/{equipmen
tExpectationId}

Equipment GET Application Network admin Observer Planner admin

/nsi/api/v2_0/e admin
quipment/{equi
pmentId}/equip
mentExpectati
ons/{equipmen
tExpectationId}

Equipment DELETE Network admin

/nsi/api/v2_0/e
quipment/{equi
pmentId}/user
Data/{userData
Key}

Equipment PUT Network admin

/nsi/api/v2_0/e
quipment/{equi
pmentId}/user
Data/{userData
Key}

Equipment POST Network admin

/nsi/api/v3/eq
uipment/{equip
mentId}/maint
enanceMode

Equipment GET Application Network admin Observer Planner admin

/nsi/api/v3/eq admin
uipment

Equipment POST Network admin

/nsi/api/v3/eq
uipment

Equipment POST Network admin

/nsi/api/v3/eq
uipment/{equip
mentId}/expect
ations

Equipment GET Application Network admin Observer Planner admin

/nsi/api/v3/eq admin
uipment/{equip
mentId}

Equipment PUT Network admin

/nsi/api/v3/eq
uipment/{equip
mentId}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1257
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Equipment DELETE Network admin

/nsi/api/v3/eq
uipment/{equip
mentId}

Equipment DELETE Network admin

/nsi/api/v3/eq
uipment/{equip
mentId}/equip
mentExpectati
ons/{equipmen
tExpectationId}

Equipment GET Application Network admin Observer Planner admin

/nsi/api/v3/eq admin
uipment/{equip
mentId}/equip
mentPlanned

Equipment PUT Network admin

/nsi/api/v3/eq
uipment/{equip
mentId}/equip
mentPlanned

Equipment GET Application Network admin Observer Planner admin

/nsi/api/v4/eq admin
uipment

Equipment POST Network admin

/nsi/api/v4/eq
uipment

Equipment GET Application Network admin Observer Planner admin

/nsi/api/equip admin
ment

Equipment POST Network admin

/nsi/api/equip
ment

Equipment DELETE Network admin

/nsi/api/equip
ment/{equipme
ntId}

Equipment GET Application Network admin Observer Planner admin

/nsi/api/equip admin
ment/{equipme
ntId}

Equipment POST Network admin

/nsi/api/equip
ment/{equipme
ntId}/expectati
ons

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1258
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Equipment GET Application Network admin Observer Planner admin

/nsi/api/equip admin
ment/{equipme
ntId}/equipmen
tPlanned

Equipment PUT Network admin

/nsi/api/equip
ment/{equipme
ntId}

Equipment GET Application Network admin Observer Planner admin

/nsi/api/equip admin
ment/{equipme
ntId}/equipmen
tExpectations

Equipment DELETE Network admin

/nsi/api/equip
ment/{equipme
ntId}/equipmen
tExpectations/{
equipmentExpe
ctationId}

Equipment GET Application Network admin Observer Planner admin

/nsi/api/equip admin
ment/{equipme
ntId}/equipmen
tExpectations/{
equipmentExpe
ctationId}

Equipment POST Network admin

/nsi/api/equip
ment/{equipme
ntId}/maintena
nceMode

Equipment DELETE Network admin

/nsi/api/equip
ment/{equipme
ntId}/userData/
{userDataKey}

Equipment PUT Network admin

/nsi/api/equip
ment/{equipme
ntId}/userData/
{userDataKey}

Equipment GET Application Network admin Observer Planner admin

Group /nsi/api/v2_0/e admin
quipmentGrou
ps

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1259
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Equipment POST Network admin

Group /nsi/api/v2_0/e
quipmentGrou
ps

Equipment DELETE Network admin

Group /nsi/api/v2_0/e
quipmentGrou
ps/{equipment
GroupId}

Equipment GET Network admin

Group /nsi/api/v2_0/e
quipmentGrou
ps/{equipment
GroupId}

Equipment GET Application Network admin Observer Planner admin

Group /nsi/api/v2_0/e admin
quipmentGrou
ps/{equipment
GroupId}/equip
mentGroupExp
ectations

Equipment POST Network admin

Group /nsi/api/v2_0/e
quipmentGrou
ps/{equipment
GroupId}/equip
mentGroupExp
ectations

Equipment DELETE Network admin

Group /nsi/api/v2_0/e
quipmentGrou
ps/{equipment
GroupId}/equip
mentGroupExp
ectations/{equi
pmentGroupEx
pectationId}

Equipment GET Application Network admin Observer Planner admin

Group /nsi/api/v2_0/e admin
quipmentGrou
ps/{equipment
GroupId}/equip
mentGroupExp
ectations/{equi
pmentGroupEx
pectationId}

Equipment GET Application Network admin Observer Planner admin

Group /nsi/api/equip admin
mentGroups

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1260
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Equipment POST Network admin

Group /nsi/api/equip
mentGroups

Equipment DELETE Network admin

Group /nsi/api/equip
mentGroups/{e
quipmentGrou
pId}

Equipment GET Application Network admin Observer Planner admin

Group /nsi/api/equip admin
mentGroups/{e
quipmentGrou
pId}

Equipment GET Application Network admin Observer Planner admin

Group /nsi/api/equip admin
mentGroups/{e
quipmentGrou
pId}/equipment
GroupExpectati
ons

Equipment POST Network admin

Group /nsi/api/equip
mentGroups/{e
quipmentGrou
pId}/equipment
GroupExpectati
ons

Equipment DELETE Network admin

Group /nsi/api/equip
mentGroups/{e
quipmentGrou
pId}/equipment
GroupExpectati
ons/{equipmen
tGroupExpectat
ionId}

Equipment GET Application Network admin Observer Planner admin

Group /nsi/api/equip admin
mentGroups/{e
quipmentGrou
pId}/equipment
GroupExpectati
ons/{equipmen
tGroupExpectat
ionId}

Equipment GET Application Network admin Observer Planner admin

Holders /nsi/api/v2_0/e admin
quipmentHolde
rs

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1261
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Equipment POST Network admin

Holders /nsi/api/v2_0/e
quipmentHolde
rs

Equipment DELETE Network admin

Holders /nsi/api/v2_0/e
quipmentHolde
rs/{equipment
HolderId}

Equipment GET Application Network admin Observer Planner admin

Holders /nsi/api/v2_0/e admin
quipmentHolde
rs/{equipment
HolderId}

Equipment GET Application Network admin Observer Planner admin

Holders /nsi/api/equip admin
mentHolders

Equipment POST Network admin

Holders /nsi/api/equip
mentHolders

Equipment DELETE Network admin

Holders /nsi/api/equip
mentHolders/{
equipmentHold
erId}

Equipment GET Application Network admin Observer Planner admin

Holders /nsi/api/equip admin
mentHolders/{
equipmentHold
erId}

Equipment PUT Network admin

Holders /nsi/api/equip
mentHolders/{
equipmentHold
erId}

Services GET Application Network admin Observer Planner admin

inventory /nsi/api/v2_0/f admin
(FREs) res

Services POST Network admin

inventory /nsi/api/v2_0/f
(FREs) res

Services POST Network admin

inventory /nsi/api/v2_0/f
(FREs) res/bulkProvisi
oningOperation
s

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1262
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Services POST Network admin

inventory /nsi/api/v2_0/f
(FREs) res/srlgOperati
on

Services DELETE Network admin

inventory /nsi/api/v2_0/f
(FREs) res/{freId}

Services GET Application Network admin Observer Planner admin

inventory /nsi/api/v2_0/f admin
(FREs) res/{freId}

Services GET Application Network admin Observer Planner admin

inventory /nsi/api/v2_0/f admin
(FREs) res/{freId}/freE
xpectations

Services DELETE Network admin

inventory /nsi/api/v2_0/f
(FREs) res/{freId}/freE
xpectations/{fr
eExpectationId
}

Services GET Application Network admin Observer Planner admin

inventory /nsi/api/v2_0/f admin
(FREs) res/{freId}/freE
xpectations/{fr
eExpectationId
}

Services POST Network admin

inventory /nsi/api/v2_0/f
(FREs) res/{freId}/prov
isioningOperati
ons

Services DELETE Network admin

inventory /nsi/api/v2_0/f
(FREs) res/{freId}/user
Data/{userData
Key}

Services PUT Network admin

inventory /nsi/api/v2_0/f
(FREs) res/{freId}/user
Data/{userData
Key}

Services DELETE Network admin

inventory /nsi/api/v2_0/f
(FREs) res/{id}/identifi
ers/{identifierK
ey}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1263
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Services PUT Network admin

inventory /nsi/api/v2_0/f
(FREs) res/{id}/identifi
ers/{identifierK
ey}

Services GET Application Network admin Observer Planner admin

inventory /nsi/api/v3/fre admin
(FREs) s

Services POST Network admin

inventory /nsi/api/v3/fre
(FREs) s

Services GET Application Network admin Observer Planner admin

inventory /nsi/api/v3/fre admin
(FREs) s/{freId}

Services DELETE Network admin

inventory /nsi/api/v3/fre
(FREs) s/{freId}

Services PUT Network admin

inventory /nsi/api/v3/fre
(FREs) s/{freId}/admin
State

Services POST Network admin

inventory /nsi/api/v3/fre
(FREs) s/{freId}/disco
vered/validate

Services POST Network admin

inventory /nsi/api/v3/fre
(FREs) s/{freId}/expec
tations

Services POST Network admin

inventory /nsi/api/v3/fre
(FREs) s/{freId}/expec
tations/{expect
ationId}/realize

Services DELETE Network admin

inventory /nsi/api/v3/fre
(FREs) s/{freId}/freEx
pectations/{fre
ExpectationId}

Services PUT Network admin

inventory /nsi/api/v3/fre
(FREs) s/{freId}/identif
iers

Services DELETE Network admin

inventory /nsi/api/v3/fre
(FREs) s/{freId}/identif
iers

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1264
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Services POST Network admin

inventory /nsi/api/v3/fre
(FREs) s/{freId}/srlg

Services PUT Network admin

inventory /nsi/api/v3/fre
(FREs) s/{freId}/srlg

Services DELETE Network admin

inventory /nsi/api/v3/fre
(FREs) s/{freId}/srlg

Services PUT Network admin

inventory /nsi/api/v3/fre
(FREs) s/{freId}/valida
tionExpectatio
n

Services PUT Network admin

inventory /nsi/api/v3/fre
(FREs) s/deploymentS
tate

Services GET Application Network admin Observer Planner admin

inventory /nsi/api/v4/fre admin
(FREs) s

Services POST Network admin

inventory /nsi/api/v4/fre
(FREs) s

Services PUT Network admin

inventory /nsi/api/v4/fre
(FREs) s/{freId}

Services PATCH Network admin

inventory /nsi/api/v4/fre
(FREs) s/{freId}

Services GET Application Network admin Observer Planner admin

inventory /nsi/api/v4/fre admin
(FREs) s/{freId}/expec
tationMismatc
hes

Services GET Application Network admin Observer Planner admin

inventory /nsi/api/v4/fre admin
(FREs) s/{freId}/frePla
nned

Services PUT Network admin

inventory /nsi/api/v4/fre
(FREs) s/{freId}/frePla
nned

Services GET Application Network admin Observer Planner admin

inventory /nsi/api/fres admin
(FREs)

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1265
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Services POST Network admin

inventory /nsi/api/fres
(FREs)

Services POST Network admin

inventory /nsi/api/fres/b
(FREs) ulkProvisioning
Operations

Services DELETE Network admin

inventory /nsi/api/fres/{f
(FREs) reId}

Services GET Application Network admin Observer Planner admin

inventory /nsi/api/fres/{f admin
(FREs) reId}

Services PUT Network admin

inventory /nsi/api/fres/{f
(FREs) reId}

Services PUT Network admin

inventory /nsi/api/fres/{f
(FREs) reId}/adminSta
te

Services POST Network admin

inventory /nsi/api/fres/{f
(FREs) reId}/expectati
ons

Services POST Network admin

inventory /nsi/api/fres/{f
(FREs) reId}/expectati
ons/{expectati
onId}/realize

Services GET Application Network admin Observer Planner admin

inventory /nsi/api/fres/{f admin
(FREs) reId}/freExpect
ations

Services DELETE Network admin

inventory /nsi/api/fres/{f
(FREs) reId}/freExpect
ations/{freExpe
ctationId}

Services GET Application Network admin Observer Planner admin

inventory /nsi/api/fres/{f admin
(FREs) reId}/freExpect
ations/{freExpe
ctationId}

Services PUT Network admin

inventory /nsi/api/fres/{f
(FREs) reId}/validation
Expectation

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1266
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Services GET Application Network admin Observer Planner admin

inventory /nsi/api/fres/{f admin
(FREs) reId}/planned

Services PATCH Network admin

inventory /nsi/api/fres/{f
(FREs) reId}

Services PUT Network admin

inventory /nsi/api/fres/{f
(FREs) reId}/bookingD
ata/{bookingD
ataKey}

Services DELETE Network admin

inventory /nsi/api/fres/{f
(FREs) reId}/bookingD
ata/{bookingD
ataKey}

Services GET Application Network admin Observer Planner admin

inventory /nsi/api/fres/{f admin
(FREs) reId}/expectati
onMismatches

Services DELETE Network admin

inventory /nsi/api/fres/{f
(FREs) reId}/srlg

Services POST Network admin

inventory /nsi/api/fres/{f
(FREs) reId}/srlg

Services PUT Network admin

inventory /nsi/api/fres/{f
(FREs) reId}/srlg

Services POST Network admin

inventory /nsi/api/fres/{f
(FREs) reId}/unidirecti
onalStitch

Services DELETE Network admin

inventory /nsi/api/fres/{f
(FREs) reId}/userData/
{userDataKey

Services PUT Network admin

inventory /nsi/api/fres/{f
(FREs) reId}/userData/
{userDataKey}

Services DELETE Network admin

inventory /nsi/api/fres/{i
(FREs) d}/identifiers/{i
dentifierKey}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1267
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Services PUT Network admin

inventory /nsi/api/fres/{i
(FREs) d}/identifiers/{i
dentifierKey}

Network GET Application Network admin Observer Planner admin

elements /nsi/api/v2_0/ admin
(constructs) networkConstr
ucts

Network POST Network admin

elements /nsi/api/v2_0/
(constructs) networkConstr
ucts

Network GET Application Network admin Observer Planner admin

elements /nsi/api/v2_0/ admin
(constructs) networkConstr
ucts/{id}

Network DELETE Network admin

elements /nsi/api/v2_0/
(constructs) networkConstr
ucts/{networkC
onstructId}

Network POST Network admin

elements /nsi/api/v2_0/
(constructs) networkConstr
ucts/{networkC
onstructId}/exp
ectations

Network DELETE Network admin

elements /nsi/api/v2_0/
(constructs) networkConstr
ucts/{networkC
onstructId}/exp
ectations/{net
workConstruct
ExpectationId}

Network GET Application Network admin Observer Planner admin

elements /nsi/api/v2_0/ admin
(constructs) networkConstr
ucts/{networkC
onstructId}/exp
ectations/{net
workConstruct
ExpectationId}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1268
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Network PUT Network admin

elements /nsi/api/v2_0/
(constructs) networkConstr
ucts/{networkC
onstructId}/exp
ectations/{net
workConstruct
ExpectationId}/
{attributeName
}

Network DELETE Network admin

elements /nsi/api/v2_0/
(constructs) networkConstr
ucts/{networkC
onstructId}/ide
ntifiers/{identifi
erKey}

Network PUT Network admin

elements /nsi/api/v2_0/
(constructs) networkConstr
ucts/{networkC
onstructId}/ide
ntifiers/{identifi
erKey}

Network DELETE Network admin

elements /nsi/api/v2_0/
(constructs) networkConstr
ucts/{networkC
onstructId}/use
rData/{userDat
aKey}

Network PUT Network admin

elements /nsi/api/v2_0/
(constructs) networkConstr
ucts/{networkC
onstructId}/use
rData/{userDat
aKey}

Network GET Application Network admin Observer Planner admin

elements /nsi/api/v2_0/ admin
(constructs) physicalLocati
ons

Network POST Network admin

elements /nsi/api/v2_0/
(constructs) physicalLocati
ons

Network DELETE Network admin

elements /nsi/api/v2_0/
(constructs) physicalLocati
ons/{physicalL
ocationId}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1269
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Network GET Application Network admin Observer Planner admin

elements /nsi/api/v3/net admin
(constructs) workConstruct
s

Network POST Network admin

elements /nsi/api/v3/net
(constructs) workConstruct
s

Network DELETE Network admin

elements /nsi/api/v3/net
(constructs) workConstruct
s/{id}

Network GET Application Network admin Observer Planner admin

elements /nsi/api/v3/net admin
(constructs) workConstruct
s/{id}

Network POST Network admin

elements /nsi/api/v3/net
(constructs) workConstruct
s/{id}/expectati
ons

Network DELETE Network admin

elements /nsi/api/v3/net
(constructs) workConstruct
s/{id}/expectati
ons/{networkC
onstructExpect
ationId}

Network GET Application Network admin Observer Planner admin

elements /nsi/api/v3/net admin
(constructs) workConstruct
s/{id}/expectati
ons/{networkC
onstructExpect
ationId}

Network PUT Network admin

elements /nsi/api/v3/net
(constructs) workConstruct
s/{id}/expectati
ons/{networkC
onstructExpect
ationId}/{attrib
uteName}

Network DELETE Network admin

elements /nsi/api/v3/net
(constructs) workConstruct
s/{id}/identifier
s/{identifierKey
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1270
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Network PUT Network admin

elements /nsi/api/v3/net
(constructs) workConstruct
s/{id}/identifier
s/{identifierKey
}

Network DELETE Network admin

elements /nsi/api/v3/net
(constructs) workConstruct
s/{id}/userData
/{userDataKey}

Network PUT Network admin

elements /nsi/api/v3/net
(constructs) workConstruct
s/{id}/userData
/{userDataKey}

Network GET Application Network admin Observer Planner admin

elements /nsi/api/v4/net admin
(constructs) workConstruct
s

Network POST Network admin

elements /nsi/api/v4/net
(constructs) workConstruct
s

Network DELETE Network admin

elements /nsi/api/v4/net
(constructs) workConstruct
s/{id}/identifier
s/{identifierKey
}

Network PUT Network admin

elements /nsi/api/v4/net
(constructs) workConstruct
s/{id}/identifier
s/{identifierKey
}

Network DELETE Network admin

elements /nsi/api/v4/net
(constructs) workConstruct
s/{id}/physical
Location/{phys
icalLocationId}

Network PUT Network admin

elements /nsi/api/v4/net
(constructs) workConstruct
s/{id}/physical
Location/{phys
icalLocationId}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1271
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Network DELETE Network admin

elements /nsi/api/v4/net
(constructs) workConstruct
s/{id}/userData
/{userDataKey}

Network PUT Network admin

elements /nsi/api/v4/net
(constructs) workConstruct
s/{id}/userData
/{userDataKey}

Network GET Application Network admin Observer Planner admin

elements /nsi/api/netwo admin
(constructs) rkConstructs

Network POST Network admin

elements /nsi/api/netwo
(constructs) rkConstructs

Network DELETE Network admin

elements /nsi/api/netwo
(constructs) rkConstructs/{i
d}

Network GET Application Network admin Observer Planner admin

elements /nsi/api/netwo admin
(constructs) rkConstructs/{i
d}

Network POST Network admin

elements /nsi/api/netwo
(constructs) rkConstructs/{i
d}/expectation
s

Network DELETE Network admin

elements /nsi/api/netwo
(constructs) rkConstructs/{i
d}/expectation
s/{networkCon
structExpectati
onId}

Network GET Application Network admin Observer Planner admin

elements /nsi/api/netwo admin
(constructs) rkConstructs/{i
d}/expectation
s/{networkCon
structExpectati
onId}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1272
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Network PUT Network admin

elements /nsi/api/netwo
(constructs) rkConstructs/{i
d}/expectation
s/{networkCon
structExpectati
onId}/{attribute
Name}

Network DELETE Network admin

elements /nsi/api/netwo
(constructs) rkConstructs/{i
d}/identifiers/{i
dentifierKey}

Network PUT Network admin

elements /nsi/api/netwo
(constructs) rkConstructs/{i
d}/identifiers/{i
dentifierKey}

Network DELETE Network admin

elements /nsi/api/netwo
(constructs) rkConstructs/{i
d}/userData/{u
serDataKey}

Network PUT Network admin

elements /nsi/api/netwo
(constructs) rkConstructs/{i
d}/userData/{u
serDataKey}

Port inventory GET Application Network admin Observer Planner admin

(TPEs) /nsi/api/v2_0/t admin
pes

Port inventory POST Network admin

(TPEs) /nsi/api/v2_0/t
pes

Port inventory DELETE Network admin

(TPEs) /nsi/api/v2_0/t
pes/{tpeId}

Port inventory GET Application Network admin Observer Planner admin

(TPEs) /nsi/api/v2_0/t admin
pes/{tpeId}

Port inventory GET Application Network admin Observer Planner admin

(TPEs) /nsi/api/v2_0/t admin
pes/{tpeId}/tpe
Expectations

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1273
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Port inventory DELETE Network admin

(TPEs) /nsi/api/v2_0/t
pes/{tpeId}/tpe
Expectations/{t
peExpectationI
d}

Port inventory GET Application Network admin Observer Planner admin

(TPEs) /nsi/api/v2_0/t admin
pes/{tpeId}/tpe
Expectations/{t
peExpectationI
d}

Port inventory GET Application Network admin Observer Planner admin

(TPEs) /nsi/api/v3/tpe admin
s

Port inventory POST Network admin

(TPEs) /nsi/api/v3/tpe
s

Port inventory GET Application Network admin Observer Planner admin

(TPEs) /nsi/api/v3/tpe admin
s/{tpeId}

Port inventory PUT Network admin

(TPEs) /nsi/api/v3/tpe
s/{tpeId}

Port inventory DELETE Network admin

(TPEs) /nsi/api/v3/tpe
s/{tpeId}

Port inventory POST Network admin

(TPEs) /nsi/api/v3/tpe
s/{tpeId}/expe
ctations

Port inventory POST Network admin

(TPEs) /nsi/api/v3/tpe
s/{tpeId}/expe
ctations/{expe
ctationId}/reali
ze

Port inventory DELETE Network admin

(TPEs) /nsi/api/v3/tpe
s/{tpeId}/tpeEx
pectations/{tpe
ExpectationId}

Port inventory GET Application Network admin Observer Planner admin

(TPEs) /nsi/api/v3/tpe admin
s/{tpeId}/tpePl
anned

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1274
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Port inventory PUT Network admin

(TPEs) /nsi/api/v3/tpe
s/{tpeId}/tpePl
anned

Port inventory PUT Network admin

(TPEs) /nsi/api/v3/tpe
s/{tpeId}/userD
ata/{userDataK
ey}

Port inventory DELETE Network admin

(TPEs) /nsi/api/v3/tpe
s/{tpeId}/userD
ata/{userDataK
ey}

Port inventory GET Application Network admin Observer Planner admin

(TPEs) /nsi/api/v4/tpe admin
s

Port inventory POST Network admin

(TPEs) /nsi/api/v4/tpe
s

Port inventory DELETE Network admin

(TPEs) /nsi/api/v4/tpe
s/{id}/identifier
s

Port inventory PUT Network admin

(TPEs) /nsi/api/v4/tpe
s/{id}/identifier
s

Port inventory PUT Network admin

(TPEs) /nsi/api/v4/tpe
s/{tpeId}

Port inventory GET Application Network admin Observer Planner admin

(TPEs) /nsi/api/tpes admin

Port inventory POST Network admin

(TPEs) /nsi/api/tpes

Port inventory DELETE Network admin

(TPEs) /nsi/api/tpes/{t
peId}

Port inventory GET Application Network admin Observer Planner admin

(TPEs) /nsi/api/tpes/{t admin
peId}

Port inventory PUT Network admin

(TPEs) /nsi/api/tpes/{t
peId}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1275
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Port inventory GET Application Network admin Observer Planner admin

(TPEs) /nsi/api/tpes/{t admin
peId}/tpeExpec
tations

Port inventory PUT Network admin

(TPEs) /nsi/api/tpes/{i
d}/identifiers

Port inventory DELETE Network admin

(TPEs) /nsi/api/tpes/{i
d}/identifiers

Port inventory POST Network admin

(TPEs) /nsi/api/tpes/{t
peId}/expectati
ons

Port inventory POST Network admin

(TPEs) /nsi/api/tpes/{t
peId}/expectati
ons/{expectati
onId}/realize

Port inventory GET Application Network admin Observer Planner admin

(TPEs) /nsi/api/tpes/{t admin
peId}/tpePlann
ed

Port inventory PUT Network admin

(TPEs) /nsi/api/tpes/{t
peId}/tpePlann
ed

Port inventory PUT Network admin

(TPEs) /nsi/api/tpes/{t
peId}/userData
/{userDataKey}

Port inventory DELETE Network admin

(TPEs) /nsi/api/tpes/{t
peId}/userData
/{userDataKey}

Port inventory DELETE Network admin

(TPEs) /nsi/api/tpes/{t
peId}/tpeExpec
tations/{tpeExp
ectationId}

Port inventory GET Application Network admin Observer Planner admin

(TPEs) /nsi/api/tpes/{t admin
peId}/tpeExpec
tations/{tpeExp
ectationId}

Performance GET Application Network admin Observer

Metrics /pm/api/v1/co admin
nfigs

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1276
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Performance GET Application Network admin Observer

Metrics /pm/api/v1/co admin
nfigs/{id}

Performance PUT Network admin

Metrics /pm/api/v1/co
nfigs/{id}

Performance POST Network admin

Metrics /pm/api/v1/fac
ilities

Performance POST Application Network admin Observer

Metrics /pm/api/v1/qu admin
ery/metrics

Performance GET Application Network admin Observer

Metrics /pm/api/v1/no admin
des

Performance GET Application Network admin Observer

Metrics /pm/api/v1/no admin
des/{nodeId}

Performance GET Application Network admin Observer

Metrics /pm/api/v1/no admin
des/{nodeId}/c
onfig

Performance PUT Network admin

Metrics /pm/api/v1/no
des/{nodeId}/c
onfig

Performance POST Application Network admin Observer

Metrics /pm/api/v1/qu admin
eries

Performance POST Network admin

Metrics /pmprocessor/
Processor api/v1/threshol
ds

Performance PUT Network admin

Metrics /pmprocessor/
Processor api/v1/threshol
ds

Performance PUT Network admin

Metrics /pmprocessor/
Processor api/v1/threshol
ds/{id}

Performance DELETE Network admin

Metrics /pmprocessor/
Processor api/v1/threshol
ds/{id}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1277
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Performance GET Application Network admin Observer

Metrics /pmprocessor/ admin
Processor api/v1/threshol
ds

Performance GET Application Network admin Observer

Metrics /pmprocessor/ admin
Processor api/v1/threshol
ds/{id}

Performance POST Network admin

Metrics /pmprocessor/
Processor api/v1/threshol
d_groups

Performance PUT Network admin

Metrics /pmprocessor/
Processor api/v1/threshol
d_groups

Performance PUT Network admin

Metrics /pmprocessor/
Processor api/v1/threshol
d_groups/{id}

Performance DELETE Network admin

Metrics /pmprocessor/
Processor api/v1/threshol
d_groups/{id}

Performance GET Application Network admin Observer

Metrics /pmprocessor/ admin
Processor api/v1/threshol
d_groups

Performance GET Application Network admin Observer

Metrics /pmprocessor/ admin
Processor api/v1/threshol
d_groups/{id}

Performance POST Network admin

Metrics /pmprocessor/
Processor api/v1/resourc
e_profiles

Performance PUT Network admin

Metrics /pmprocessor/
Processor api/v1/resourc
e_profiles

Performance PUT Network admin

Metrics /pmprocessor/
Processor api/v1/resourc
e_profiles/{id}

Performance DELETE Network admin

Metrics /pmprocessor/
Processor api/v1/resourc
e_profiles/{id}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1278
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Performance GET Application Network admin Observer

Metrics /pmprocessor/ admin
Processor api/v1/resourc
e_profiles

Performance GET Application Network admin Observer

Metrics /pmprocessor/ admin
Processor api/v1/resourc
e_profiles/{id}

Performance GET Application Network admin Observer

Metrics /pmprocessor/ admin
Processor api/v1/calculat
ioncontexts

Project DELETE Planner admin

Management /projectmanag
ement/api/v1/
PlanningProjec
ts

Project GET Application Observer Planner admin

Management /projectmanag admin
ement/api/v1/
PlanningProjec
ts

Project POST Planner admin

Management /projectmanag
ement/api/v1/
PlanningProjec
ts

Project DELETE Planner admin

Management /projectmanag
ement/api/v1/
PlanningProjec
ts/{id}

Project GET Application Observer Planner admin

Management /projectmanag admin
ement/api/v1/
PlanningProjec
ts/{id}

Project PUT Planner admin

Management /projectmanag
ement/api/v1/
PlanningProjec
ts/{id}

Project POST Planner admin

Management /projectmanag
ement/api/v1/
PlanningProjec
ts/{id}/commit
Operation

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1279
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Project POST Planner admin

Management /projectmanag
ement/api/v1/
PlanningProjec
ts/{id}/commit

Project POST Planner admin

Management /projectmanag
ement/api/v1/
PlanningProjec
ts/commitOper
ation

Project POST Planner admin

Management /projectmanag
ement/api/v1/
PlanningProjec
ts/commit

Project POST Planner admin

Management /projectmanag
ement/api/v1/
PlanningProjec
ts/{id}/cancelO
peration

Project POST Planner admin

Management /projectmanag
ement/api/v1/
PlanningProjec
ts/{id}/cancel

Project POST Planner admin

Management /projectmanag
ement/api/v1/
PlanningProjec
ts/cancelOpera
tion

Project POST Planner admin

Management /projectmanag
ement/api/v1/
PlanningProjec
ts/cancel

Project POST Planner admin

Management /projectmanag
ement/api/v1/
PlanningProjec
ts/nameChang
eOperation

Project PATCH Planner admin

Management /projectmanag
ement/api/v1/
PlanningProjec
ts/name/{proje
ctName}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1280
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Project GET Application Observer Planner admin

Management /projectmanag admin
ement/api/v1/
ProjectLists

Project POST Planner admin

Management /projectmanag
ement/api/v1/
ProjectLists

Project GET Application Observer Planner admin

Management /projectmanag admin
ement/api/v1/
ProjectLists/{id
}

Project POST Planner admin

Management /projectmanag
ement/api/v1/
ProjectLists/{p
rojectListId}/ad
dProject

Project POST Planner admin

Management /projectmanag
ement/api/v1/
ProjectLists/na
me/{projectList
Name}/addProj
ect

Project DELETE Planner admin

Management /projectmanag
ement/api/v1/
ProjectLists/{p
rojectListId}

Project DELETE Planner admin

Management /projectmanag
ement/api/v1/
ProjectLists/na
me/{projectList
Name}

Project GET Application Observer Planner admin

Management /projectmanag admin
ement/api/v2/
ProjectLists

Project POST Planner admin

Management /projectmanag
ement/api/v2/
ProjectLists

Project GET Application Observer Planner admin

Management /projectmanag admin
ement/api/v2/
ProjectLists/{id
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1281
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Project POST Planner admin

Management /projectmanag
ement/api/v2/
ProjectLists/{p
rojectListId}/ad
dProject

Project POST Planner admin

Management /projectmanag
ement/api/v2/
ProjectLists/na
me/{projectList
Name}/addProj
ect

Project DELETE Planner admin

Management /projectmanag
ement/api/v2/
ProjectLists/{p
rojectListId}

Project DELETE Planner admin

Management /projectmanag
ement/api/v2/
ProjectLists/na
me/{projectList
Name}

Test and GET Application Network admin Observer

Diagnostics /tdc/api/v1/co admin
Coordinator nfigProperties

Test and DELETE Network admin

Diagnostics /tdc/api/v1/co
Coordinator nfigProperties/
{propertyName
}

Test and GET Application Network admin Observer

Diagnostics /tdc/api/v1/co admin
Coordinator nfigProperties/
{propertyName
}

Test and PUT Network admin

Diagnostics /tdc/api/v1/co
Coordinator nfigProperties/

Test and GET Application Network admin Observer

Diagnostics /tdc/api/v1/dia admin
Coordinator g/fiberloss

Test and GET Application Network admin Observer

Diagnostics /tdc/api/v1/dia admin
Coordinator g/pms/prfbers

Test and POST Application Network admin Observer

Diagnostics /tdc/api/v1/dia admin
Coordinator g/powers

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1282
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Test and DELETE Network admin

Diagnostics /tdc/api/v1/dia
Coordinator g/powers/{diag
Id}

Test and GET Application Network admin Observer

Diagnostics /tdc/api/v1/dia admin
Coordinator g/spectral

Test and GET Application Network admin Observer

Diagnostics /tdc/api/v1/dia admin
Coordinator g/spectral/allo
cations

Test and GET Application Network admin Observer

Diagnostics /tdc/api/v1/op admin
Coordinator erationalStatus

Test and GET Application Network admin Observer

Diagnostics /tdc/api/v1/tes admin
Coordinator ts

Test and GET Application Network admin Observer

Diagnostics /tdc/api/v1/tes admin
Coordinator ts/Description

Test and POST Network admin

Diagnostics /tdc/api/v1/tes
Coordinator ts/cfmOperatio
ns

Test and POST Network admin

Diagnostics /tdc/api/v1/tes
Coordinator ts/loopbackOp
erations

Test and POST Network admin

Diagnostics /tdc/api/v1/tes
Coordinator ts/lspOperatio
ns

Test and POST Network admin

Diagnostics /tdc/api/v1/tes
Coordinator ts/pwOperatio
ns

Test and POST Network admin

Diagnostics /tdc/api/v1/tes
Coordinator ts/tdmOperatio
ns

Test and GET Application Network admin Observer

Diagnostics /tdc/api/v1/tes admin
Coordinator ts/{testId}

Test and DELETE Network admin

Diagnostics /tdc/api/v1/tes
Coordinator ts/{testId}/can
cel

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1283
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Test and POST Application Network admin Observer

Diagnostics /tdc/api/v2/dia admin
Coordinator g/operMeas

Test and Post Application Network admin Observer

Diagnostics /tdc/api/v2/dia admin
Coordinator g/operMeas/fa
cilities

Logging GET Application

/bplogging/ admin

Logging GET Application

/bplogging/{pa admin
ram}

Logging GET Application

/logarchive/api admin
/v1/logs

Elastic search GET Application

/elasticsearch admin

Metrics GET /grafana Application

admin

Metrics GET Application

/grafana/{para admin
m}

Documentation GET /swagger- Application Network admin Observer Planner admin

ui admin

Documentation GET /swagger- Application Network admin Observer Planner admin

ui/{param} admin

Security-UI GET /security Application

admin

Security-UI GET Application

/security/{para admin
m}

UAC-UI GET /uac Application

admin

API GET /rbac- Application

authorization e/api/v1/admi admin
n/current-
account

API GET /rbac- Application

authorization e/api/v1/admi admin
n/permissions

API POST /rbac- Application

authorization e/api/v1/admi admin
n/permissions/
refresh

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1284
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

API GET /rbac- Application

authorization e/api/v1/admi admin
n/sessions

API POST /rbac- Application

authorization e/api/v1/rbac/ admin
validate

API PUT /rbac- Application

authorization e/api/v1/debu admin
g/logs

API GET /rbac- Application

authorization e/api/v1/debu admin
g/resourceper
mission

API POST /rbac- Application

authorization e/api/v1/debu admin
g/resourceper
mission

Shelf Level GET /slv- Application Network admin Observer

View support/api/v1 admin
/equipmentGra
phics

Shelf Level GET /slv- Application Network admin Observer

View support/api/v1 admin
/equipmentGra
phics/{equipm
entGraphicId}

Shelf Level GET /slv- Application Network admin Observer

View support/api/v1 admin
/equipmentLay
outs

Shelf Level GET /slv- Application Network admin Observer

View support/api/v1 admin
/equipmentLay
outs/{equipme
ntLayoutId}

Shelf Level GET /slv- Application Network admin Observer

View support/api/v1 admin
/shelfGraphics

Shelf Level GET /slv- Application Network admin Observer

View support/api/v1 admin
/shelfLayouts

Shelf Level GET /slv- Application Network admin Observer

View support/api/v1 admin
/shelfLayouts/{
shelfLayoutId}

Market GET /domain- Application Network admin Observer

types admin

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1285
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Market GET /domain- Application Network admin Observer

types admin

Market DELETE Network admin

/domains/{do
mainId}

Market DELETE Network admin

/domains/{do
mainId}

Market GET Application Network admin Observer

/domains/{do admin
mainId}

Market GET Application Network admin Observer

/domains/{do admin
mainId}

Market PATCH Network admin

/domains/{do
mainId}

Market PATCH Network admin

/domains/{do
mainId}

Market PUT Network admin

/domains/{do
mainId}

Market PUT Network admin

/domains/{do
mainId}

Market GET Application Network admin Observer

/domains/{do admin
mainId}/produ
cts

Market GET Application Network admin Observer

/domains/{do admin
mainId}/produ
cts

Market GET /domains Application Network admin Observer

admin

Market GET /domains Application Network admin Observer

admin

Market POST Network admin

/domains

Market POST Network admin

/domains

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1286
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Market POST Network admin

/domains/valid
ate

Market POST Network admin

/domains/valid
ate

Market GET /ping

Market GET /products Application Network admin Observer

admin

Market GET /products Application Network admin Observer

admin

Market POST /product Network admin

Market POST /product Network admin

Market DELETE Network admin

/products/{pro
ductId}

Market DELETE Network admin

/products/{pro
ductId}

Market GET Application Network admin Observer

/products/{pro admin
ductId}

Market GET Application Network admin Observer

/products/{pro admin
ductId}

Market PATCH Network admin

/products/{pro
ductId}

Market PATCH Network admin

/products/{pro
ductId}

Market PUT Network admin

/products/{pro
ductId}

Market PUT Network admin

/products/{pro
ductId}

Market GET Application Network admin Observer

/relationships admin

Market GET Application Network admin Observer

/relationships admin

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1287
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Market POST Network admin

/relationships

Market POST Network admin

/relationships

Market DELETE Network admin

/relationships/{
relationshipId}

Market DELETE Network admin

/relationships/{
relationshipId}

Market GET Application Network admin Observer

/relationships/{ admin
relationshipId}

Market GET Application Network admin Observer

/relationships/{ admin
relationshipId}

Market DELETE Network admin

/resource-
providers/{reso
urceProviderId}

Market DELETE Network admin

/resource-
providers/{reso
urceProviderId}

Market GET /resource- Application Network admin Observer

providers/{reso admin
urceProviderId}

Market GET /resource- Application Network admin Observer

providers/{reso admin
urceProviderId}

Market PATCH Network admin

/resource-
providers/{reso
urceProviderId}

Market PATCH Network admin

/resource-
providers/{reso
urceProviderId}

Market PUT /resource- Network admin

providers/{reso
urceProviderId}

Market PUT /resource- Network admin

providers/{reso
urceProviderId}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1288
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Market GET /resource- Application Network admin Observer

providers admin

Market GET /resource- Application Network admin Observer

providers admin

Market POST Network admin

/resource-
providers

Market POST Network admin

/resource-
providers

Market GET /resource- Application Network admin Observer

providers/{reso admin
urceProviderId}
/domains

Market GET /resource- Application Network admin Observer

providers/{reso admin
urceProviderId}
/domains

Market GET /resource- Application Network admin Observer

types/{resourc admin
eTypeId}

Market GET /resource- Application Network admin Observer

types/{resourc admin
eTypeId}

Market GET /resource- Application Network admin Observer

types admin

Market GET /resource- Application Network admin Observer

types admin

Market GET /resource- Application Network admin Observer

types/{typeId}/ admin
products

Market GET /resource- Application Network admin Observer

types/{typeId}/ admin
products

Market GET Application Network admin Observer

/resources/{re admin
sourceId}/depe
ndencies

Market GET Application Network admin Observer

/resources/{re admin
sourceId}/depe
ndencies

Market DELETE Network admin

/resources/{re
sourceId}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1289
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Market DELETE Network admin

/resources/{re
sourceId}

Market GET Application Network admin Observer

/resources/{re admin
sourceId}

Market GET Application Network admin Observer

/resources/{re admin
sourceId}

Market PATCH Network admin

/resources/{re
sourceId}

Market PATCH Network admin

/resources/{re
sourceId}

Market PUT Network admin

/resources/{re
sourceId}

Market PUT Network admin

/resources/{re
sourceId}

Market POST Network admin

/resources/{re
sourceId}/valid
ate

Market POST Network admin

/resources/{re
sourceId}/valid
ate

Market GET Application Network admin Observer

/resources/{re admin
sourceId}/oper
ations

Market GET Application Network admin Observer

/resources/{re admin
sourceId}/oper
ations

Market POST Network admin

/resources/{re
sourceId}/oper
ations

Market POST Network admin

/resources/{re
sourceId}/oper
ations

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1290
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Market GET Application Network admin Observer

/resources/{re admin
sourceId}/oper
ations/{operati
onId}

Market GET Application Network admin Observer

/resources/{re admin
sourceId}/oper
ations/{operati
onId}

Market GET Application Network admin Observer

/resources/{re admin
sourceId}/depe
ndents

Market GET Application Network admin Observer

/resources/{re admin
sourceId}/depe
ndents

Market GET Application Network admin Observer

/resources/{re admin
sourceId}/inter
faces

Market GET Application Network admin Observer

/resources/{re admin
sourceId}/inter
faces

Market GET Application Network admin Observer

/resources admin

Market GET Application Network admin Observer

/resources admin

Market POST Network admin

/resources

Market POST Network admin

/resources

Market GET Application Network admin Observer

/resources/hist admin
ory

Market GET Application Network admin Observer

/resources/hist admin
ory

Market GET Application Network admin Observer

/resources/{re admin
sourceId}/obse
rved

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1291
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Market GET Application Network admin Observer

/resources/{re admin
sourceId}/obse
rved

Market PATCH Network admin

/resources/{re
sourceId}/obse
rved

Market PATCH Network admin

/resources/{re
sourceId}/obse
rved

Market PUT Network admin

/resources/{re
sourceId}/obse
rved

Market PUT Network admin

/resources/{re
sourceId}/obse
rved

Market POST Network admin

/resources/vali
date

Market POST Network admin

/resources/vali
date

Market GET Application Network admin Observer

/resources/{re admin
sourceId}/histo
ry

Market GET Application Network admin Observer

/resources/{re admin
sourceId}/histo
ry

Market DELETE /tag- Network admin

keys/{tagKey}

Market DELETE /tag- Network admin

keys/{tagKey}

Market GET /tag- Application Network admin Observer

keys/{tagKey} admin

Market GET /tag- Application Network admin Observer

keys/{tagKey} admin

Market PATCH /tag- Network admin

keys/{tagKey}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1292
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Market PATCH /tag- Network admin

keys/{tagKey}

Market PUT /tag- Network admin

keys/{tagKey}

Market PUT /tag- Network admin

keys/{tagKey}

Market DELETE /tag- Network admin

keys/{tagKey}/
tag-
values/{tagVal
ue}

Market DELETE /tag- Network admin

keys/{tagKey}/
tag-
values/{tagVal
ue}

Market GET /tag- Application Network admin Observer

keys/{tagKey}/ admin
tag-
values/{tagVal
ue}

Market GET /tag- Application Network admin Observer

keys/{tagKey}/ admin
tag-
values/{tagVal
ue}

Market PATCH /tag- Network admin

keys/{tagKey}/
tag-
values/{tagVal
ue}

Market PATCH /tag- Network admin

keys/{tagKey}/
tag-
values/{tagVal
ue}

Market PUT /tag- Network admin

keys/{tagKey}/
tag-
values/{tagVal
ue}

Market PUT /tag- Network admin

keys/{tagKey}/
tag-
values/{tagVal
ue}

Market GET /tag-keys Application Network admin Observer

admin

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1293
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Market GET /tag-keys Application Network admin Observer

admin

Market POST /tag-keys Network admin

Market POST /tag-keys Network admin

Market GET /tag- Application Network admin Observer

keys/{tagKey}/ admin
tag-values

Market GET /tag- Application Network admin Observer

keys/{tagKey}/ admin
tag-values

Market POST /tag- Network admin

keys/{tagKey}/
tag-values

Market POST /tag- Network admin

keys/{tagKey}/
tag-values

Market GET /type- Application Network admin Observer

artifacts/{type admin
ArtifactUri}

Market GET /type- Application Network admin Observer

artifacts/{type admin
ArtifactUri}

Market GET /type- Application Network admin Observer

artifacts admin

Market GET /type- Application Network admin Observer

artifacts admin

Market GET /type- Application Network admin Observer

artifacts/realm admin

Market GET /type- Application Network admin Observer

artifacts/realm admin

Policy Manager DELETE Network admin

/conditions/{c
onditionId}

Policy Manager DELETE Network admin

/conditions/{c
onditionId}

Policy Manager GET Application Network admin Observer

/conditions/{c admin
onditionId}

Policy Manager GET Application Network admin Observer

/conditions/{c admin
onditionId}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1294
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Policy Manager GET Application Network admin Observer

/conditions admin

Policy Manager GET Application Network admin Observer

/conditions admin

Policy Manager POST Network admin

/conditions

Policy Manager POST Network admin

/conditions

Policy Manager GET Application Network admin Observer

/conditions/ten admin
ants/{tenantId}
/conditions

Policy Manager GET Application Network admin Observer

/conditions/ten admin
ants/{tenantId}
/conditions

Policy Manager GET /ping

Policy Manager DELETE Network admin

/policies/{polic
yId}

Policy Manager DELETE Network admin

/policies/{polic
yId}

Policy Manager GET Application Network admin Observer

/policies/{polic admin
yId}

Policy Manager GET Application Network admin Observer

/policies/{polic admin
yId}

Policy Manager GET Application Network admin Observer

/policies/tenan admin
ts/{tenantId}/p
olicies

Policy Manager GET Application Network admin Observer

/policies/tenan admin
ts/{tenantId}/p
olicies

Policy Manager GET /policies Application Network admin Observer

admin

Policy Manager GET /policies Application Network admin Observer

admin

Policy Manager POST /policies Network admin

Policy Manager POST /policies Network admin

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1295
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Policy Manager DELETE Network admin

/realms/{realm
Name}

Policy Manager DELETE Network admin

/realms/{realm
Name}

Policy Manager GET Application Network admin Observer

/realms/{realm admin
Name}

Policy Manager GET Application Network admin Observer

/realms/{realm admin
Name}

Policy Manager GET /realms Application Network admin Observer

admin

Policy Manager GET /realms Application Network admin Observer

admin

Policy Manager POST /realms Network admin

Policy Manager POST /realms Network admin

Resource GET Application Network admin Observer

Adapter /api/v1/jsonSc admin
Controller hemas/{title}

Resource GET Application Network admin Observer

Adapter /api/v1/ras/{ra admin
Controller Id}

Resource GET Application Network admin Observer

Adapter /api/v1/ras admin
Controller

Resource POST Network admin

Adapter /api/v1/rebala
Controller nceSessions

Resource GET Application Network admin Observer

Adapter /api/v1/resour admin
Controller ceProviders

Resource GET Application Network admin Observer

Adapter /api/v1/resour admin
Controller ceProviders/{re
sourceProvider
Id}

Resource GET Application Network admin Observer

Adapter /api/v1/resour admin
Controller ceTypes/{reso
urceTypeId}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1296
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Resource GET Application Network admin Observer

Adapter /api/v1/resour admin
Controller ceTypes

Resource GET Application Network admin Observer

Adapter /api/v1/sessio admin
Controller ns

Resource POST Network admin

Adapter /api/v1/sessio
Controller ns

Resource GET Application Network admin Observer

Adapter /api/v1/sessio admin
Controller ns/{sessionId}

Resource PUT Network admin

Adapter /api/v1/sessio
Controller ns/{sessionId}

Resource GET Application Network admin Observer

Adapter /api/v1/typeGr admin
Controller oups/{typeGro
upId}

Resource GET Application Network admin Observer

Adapter /api/v1/typeGr admin
Controller oups

Asset Manager GET Application Network admin Observer

/areas/{areaNa admin
me}/upgrades/
{requestId}

Asset Manager GET Application Network admin Observer

/areas/{areaNa admin
me}/upgrades/
{requestId}

Asset Manager GET Application Network admin Observer

/areas/{areaNa admin
me}/pullreques
ts/{requestId}

Asset Manager GET Application Network admin Observer

/areas/{areaNa admin
me}/pullreques
ts/{requestId}

Asset Manager GET Application Network admin Observer

/areas/{areaNa admin
me}/raw-
files/{path}

Asset Manager GET Application Network admin Observer

/areas/{areaNa admin
me}/raw-
files/{path}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1297
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Asset Manager GET Application Network admin Observer

/areas/{areaNa admin
me}/pullreques
ts

Asset Manager GET Application Network admin Observer

/areas/{areaNa admin
me}/pullreques
ts

Asset Manager POST Network admin

/areas/{areaNa
me}/pullreques
ts

Asset Manager POST Network admin

/areas/{areaNa
me}/pullreques
ts

Asset Manager GET Application Network admin Observer

/areas/{areaNa admin
me}/upgrades

Asset Manager GET Application Network admin Observer

/areas/{areaNa admin
me}/upgrades

Asset Manager POST Network admin

/areas/{areaNa
me}/upgrades

Asset Manager POST Network admin

/areas/{areaNa
me}/upgrades

Asset Manager GET Application Network admin Observer

/areas/{areaNa admin
me}/files

Asset Manager GET Application Network admin Observer

/areas/{areaNa admin
me}/files

Asset Manager GET /areas Application Network admin Observer

admin

Asset Manager GET /areas Application Network admin Observer

admin

Asset Manager GET Application Network admin Observer

/areas/{areaNa admin
me}/files/{path
}

Asset Manager GET Application Network admin Observer

/areas/{areaNa admin
me}/files/{path
}

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1298
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Asset Manager GET Application Network admin Observer

/areas/{areaNa admin
me}

Asset Manager GET Application Network admin Observer

/areas/{areaNa admin
me}

Asset Manager GET Application Network admin Observer

/areas/{areaNa admin
me}/changes

Asset Manager GET Application Network admin Observer

/areas/{areaNa admin
me}/changes

Asset Manager DELETE Network admin

/keys/{keyId}

Asset Manager DELETE Network admin

/keys/{keyId}

Asset Manager GET /keys Application Network admin Observer

admin

Asset Manager GET /keys Application Network admin Observer

admin

Asset Manager POST /keys Network admin

Asset Manager POST /keys Network admin

Asset Manager GET /ping

Service POST Network admin

provisioning /bpoifdnbi/api/
(CD fixed) v1/serviceInten
t/deploy

Service POST Network admin

provisioning /bpoifdnbi/api/
(CD fixed) v1/serviceInten
t/undeploy

PCE POST Network admin

/pce/api/v1/

PCE DELETE Network admin

/pce/api/v1/

PCE GET Application Network admin Observer

/pce/api/v1/ admin

Stitcher POST Network admin

/stitcher/api/v
1/

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1299
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Stitcher DELETE Network admin

/stitcher/api/v
1/

Stitcher GET Application Network admin Observer

/stitcher/api/v admin
1/

Backup Service POST Network admin

/backupservice
/api/v1/backup

Backup Service GET Application Network admin Observer

/backupservice admin
/api/v1/backup

Backup Service GET Application Network admin Observer

/backupservice admin
/api/v1/backup
/{jobid}

Backup Service POST Network admin

/backupservice
/api/v1/restore

Backup Service GET Application Network admin Observer

/backupservice admin
/api/v1/restore

Backup Service GET Application Network admin Observer

/backupservice admin
/api/v1/restore
/{jobid}

Inventory GET Application Network admin Observer Planner admin

Overlay /revell/api/v1/ admin
serviceTrails/{f
reId}

OnePlanner POST /onep- Planner admin

import/export proxy/api/v1/o
nepNetworks/i
mport

OnePlanner GET /onep- Planner admin

import/export proxy/api/v1/o
nepNetworks/e
xport

Design policy GET Planner admin

/equipmenttop
ologyplanning/
api/v1/Plannin
gPolicies

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1300
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Design policy GET Planner admin

/equipmenttop
ologyplanning/
api/v1/Plannin
gPolicies/{id}

Design policy DELETE Planner admin

/equipmenttop
ologyplanning/
api/v1/Plannin
gPolicies/{id}

Design policy POST Planner admin

/equipmenttop
ologyplanning/
api/v1/Plannin
gPolicies

Design policy PUT Planner admin

/equipmenttop
ologyplanning/
api/v1/Plannin
gPolicies/{id}

Geographical GET Application Network admin Observer

redundancy /geored/cluste admin
r/remote-
status

Geographical GET Application Network admin Observer

redundancy /geored/cluste admin
r/status

Geographical POST Application

redundancy /geored/cluste admin
r/status

Geographical POST Application

redundancy /geored/site/b admin
ootstrap

Geographical GET Application Network admin Observer

redundancy /geored/site/re admin
motes

Geographical POST Application

redundancy /geored/site/re admin
motes

Geographical DELETE Application

redundancy /geored/site/re admin
motes

Geographical GET Application Network admin Observer

redundancy /geored/site/st admin
atus

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1301
Blue Planet MCP API Reference Guide, Release 18.06 Appendix A: Blue Planet MCP REST API permissions

APPLICATION API ROLE - ROLE - ROLE - ROLE - PLANNER

APPLICATION NETWORK OBSERVER ADMIN
ADMIN ADMIN

Geographical POST Application

redundancy /geored/site/st admin
atus

Geographical GET Application Network admin Observer

redundancy /geored/site/s admin
ync-status

Configuration- GET Application

UI /configuration admin

Viability GET Application Network admin Observer Planner admin

/viability/api/v admin
1/ViableRoutes
/ViabilityData

Viability PUT Planner admin

/viability/api/v
1/ViableRoutes
/ViabilityData

Viability POST Planner admin

/viability/api/v
1/ViableRoutes
/ViabilityData

450-3709-321 07.04 ©2017-2018 Ciena Corporation. All rights reserved. October 2018 | Page 1302