Cisco Cisco Evolved Programmable Network Manager 2.0 Developer's Guide

Page of 642
 
Table of Contents 
 
 
 
 
 
 
Cisco EPN Manager 2.0.3 MTOSI API Guide for OSS Integration  
 
 
iii 
Table of Contents 
Table of Contents ................................................................................................................. iii
 
1
 
Preface ........................................................................................................................ 18
 
1.1 
Conventions..................................................................................................................... 18 
1.2 
Additional User Documentation ....................................................................................... 18 
1.3 
Obtaining Documentation, Obtaining Support, and Security Guidelines ............................. 18 
2
 
Northbound MTOSI Interface ....................................................................................... 19
 
2.1 
Web Services Standards ................................................................................................... 19 
2.2 
MTOSI Standards ............................................................................................................. 19 
2.3 
Communication Patterns .................................................................................................. 19 
2.3.1
 
Iterator Pattern .................................................................................................................................... 19
 
2.4 
MTOSI Object Naming and Configuration.......................................................................... 20 
2.5 
OSS Integration Usage Scenarios ...................................................................................... 21 
2.5.1
 
Retrieving Device Inventory Flow ........................................................................................................ 21
 
2.5.2
 
Inventory Notification Registration and Processing Flow .................................................................... 22
 
2.5.3
 
Service Provisioning Flow .................................................................................................................... 23
 
2.5.3.1
 
Service Provisioning Flow for Carrier Ethernet .......................................................................... 23
 
2.5.3.2
 
Service Provisioning Flow for Optical (OTN) Services ................................................................. 24
 
2.5.3.3
 
Service Provisioning Flow for Optical (DWDM) Services ............................................................ 25
 
3
 
Supported MTOSI Interfaces ......................................................................................... 26
 
3.1 
MTOSI Interface Endpoints ............................................................................................... 27 
3.1.1
 
Authentication ..................................................................................................................................... 29
 
3.1.2
 
Authorization ....................................................................................................................................... 29
 
3.1.3
 
License ................................................................................................................................................. 29
 
4
 
MTOSI Interface Details ............................................................................................... 30
 
4.1 
ManagedElementRetrieval ............................................................................................... 30 
4.1.1
 
Managed Element Data ....................................................................................................................... 30
 
4.1.2
 
Operations ........................................................................................................................................... 31
 
4.1.2.1
 
getAllManagedElements ............................................................................................................ 31
 
4.1.2.1.1
 
Input ...................................................................................................................................... 31
 
4.1.2.1.2
 
Output ................................................................................................................................... 31
 
4.1.2.1.3
 
Exceptions ............................................................................................................................. 32
 
4.1.2.2
 
getAllManagedElementsIterator ................................................................................................ 32
 
4.1.2.2.1
 
Input ...................................................................................................................................... 32
 
4.1.2.2.2
 
Output ................................................................................................................................... 32
 
4.1.2.2.3
 
Exceptions ............................................................................................................................. 32
 
4.1.2.3
 
getManagedElement .................................................................................................................. 32
 
4.1.2.3.1
 
Input ...................................................................................................................................... 32
 
4.1.2.3.2
 
Output ................................................................................................................................... 33
 
4.1.2.3.3
 
Exceptions ............................................................................................................................. 33
 
4.2 
ManagedElementNameRetrieval ...................................................................................... 33