Cisco Cisco Evolved Programmable Network Manager 2.0 User Manuals

Cisco

Installation Guide (English)Installation Guide (English)Release Notes (English)Installation Guide (English)Developer's Guide (English)Developer's Guide (English)Developer's Guide (English)Developer's Guide (English)Developer's Guide (English)Developer's Guide (English)User Guide (English)Developer's Guide (English)Developer's Guide (English)Licensing Information (English)Release Notes (English)Documentation Roadmaps (English)Release Notes (English)

Installation Guide

Table of Contents

Installation Guide

Size:

269 KB
Pages:

16
Language:

English

Installation Guide

Table of Contents

Installation Guide

Size:

775 KB
Pages:

38
Language:

English

Installation Guide

Table of Contents

Installation Guide

Size:

269 KB
Pages:

16
Language:

English

Developer's Guide

Table of Contents

Developer's Guide

Size:

3.67 MB
Pages:

204
Language:

English

Developer's Guide

Table of Contents

Table of Contents
4
1 Preface
12
2 Northbound RESTCONF Interface
13
3 Supported Use Cases and Interfaces
16
4 RESTCONF Interface Details
18
5 Troubleshooting
61
6 YANG Schema for Cisco EPN Manager RESTCONF NBI Data Modules
62
7 Cisco EPN Manager RESTCONF NBI Request and Response Samples
63
- 7.1 Groups
  63
  - 7.1.1 Get All Groups
    63
    - 7.1.1.1 Request
      63
    - 7.1.1.2 Response
      63
- 7.2 Nodes
  67
  - 7.2.1 Get all Nodes
    67
    - 7.2.1.1 Request
      67
    - 7.2.1.2 Response
      67
- 7.3 Chassis
  76
  - 7.3.1 Get all Chassis
    76
    - 7.3.1.1 Request
      76
    - 7.3.1.2 Response
      76
- 7.4 Equipment
  77
  - 7.4.1 Get all Equipment
    77
    - 7.4.1.1 Request
      77
    - 7.4.1.2 Response
      77
- 7.5 Modules
  78
  - 7.5.1 Get all Modules
    78
    - 7.5.1.1 Request
      78
    - 7.5.1.2 Response
      79
- 7.6 Physical Connectors
  83
  - 7.6.1 Get all Physical Connectors
    83
    - 7.6.1.1 Request
      83
    - 7.6.1.2 Response
      83
- 7.7 Termination Points
  85
  - 7.7.1 Get All Physical Termination Points
    85
    - 7.7.1.1 Request
      85
    - 7.7.1.2 Response
      85
  - 7.7.2 Get All Floating Termination Points
    88
    - 7.7.2.1 Request
      88
    - 7.7.2.2 Response
      88
  - 7.7.3 Get All Connection Termination Points
    90
    - 7.7.3.1 Request
      90
    - 7.7.3.2 Response
      90
  - 7.7.4 Get All Physical Termination Points for Device
    94
    - 7.7.4.1 Request
      94
    - 7.7.4.2 Response
      94
  - 7.7.5 Get All Floating Termination Points for Device
    96
    - 7.7.5.1 Request
      96
    - 7.7.5.2 Response
      96
  - 7.7.6 Get All Connection Termination Points for Device
    99
    - 7.7.6.1 Request
      99
    - 7.7.6.2 Response
      99
  - 7.7.7 Get Single Termination Point
    102
    - 7.7.7.1 Request
      102
    - 7.7.7.2 Response
      103
  - 7.7.8 Get Contained Connection Termination Points
    104
    - 7.7.8.1 Request
      104
    - 7.7.8.2 Response
      104
  - 7.7.9 Get Contained In use Connection Termination Points
    107
    - 7.7.9.1 Request
      107
    - 7.7.9.2 Response
      107
- 7.8 Get All Virtual Connections
  110
  - 7.8.1 Request
    110
  - 7.8.2 Response
    110
- 7.9 Get All Virtual Connections – L3VPN
  114
  - 7.9.1 Request
    114
  - 7.9.2 Response
    114
- 7.10 Get a Virtual Connection
  117
  - 7.10.1 Request
    117
  - 7.10.2 Response
    117
- 7.11 Get All Virtual Connections – CE
  118
  - 7.11.1 Request
    118
  - 7.11.2 Response
    118
- 7.12 Get All Virtual Connections – CEM
  121
  - 7.12.1 Request
    121
  - 7.12.2 Response
    121
- 7.13 Get a Virtual Connection – L3VPN
  127
  - 7.13.1 Request
    127
  - 7.13.2 Response
    127
- 7.14 Get a Virtual Connection – CE
  128
  - 7.14.1 Request
    128
  - 7.14.2 Response
    128
- 7.15 Get a Virtual Connection – CEM
  130
  - 7.15.1 Request
    130
  - 7.15.2 Response
    130
- 7.16 Get All Virtual Connection Route for CEM
  132
  - 7.16.1 Request
    132
  - 7.16.2 Response
    132
- 7.17 Get All Virtual Connection Route – L2VPN
  135
  - 7.17.1 Request
    135
  - 7.17.2 Response
    135
- 7.18 Get All Virtual Connection Route – L3VPN
  138
  - 7.18.1 Request
    138
  - 7.18.2 Response
    138
- 7.19 Get a Virtual Connection Route – L3VPN
  143
  - 7.19.1 Request
    143
  - 7.19.2 Response
    143
- 7.20 Get a Virtual Connection Multi Layer Route – OCHCC
  145
  - 7.20.1 Request
    145
  - 7.20.2 Response
    145
- 7.21 Get All Topology
  152
  - 7.21.1 Request
    152
  - 7.21.2 Response
    152
- 7.22 Get Topology
  154
  - 7.22.1 Request
    154
  - 7.22.2 Response
    155
- 7.23 Get All MPLS TE Explicit Paths
  156
  - 7.23.1 Request
    156
  - 7.23.2 Response
    156
- 7.24 Get A MPLS TE Explicit Path
  158
  - 7.24.1 Request
    158
  - 7.24.2 Response
    158
- 7.25 Set TerminationPoint – SONET LOP
  159
  - 7.25.1 Request
    159
  - 7.25.2 Response
    160
- 7.26 Set TerminationPoint – SONET PORT CONFIG
  161
  - 7.26.1 Request
    161
  - 7.26.2 Response
    162
- 7.27 SetTerminationPoint – T1 PORT CONFIG
  163
  - 7.27.1 Request
    163
  - 7.27.2 Response
    163
- 7.28 SetTerminationPoint – ETHERNET PORT CONFIG
  165
  - 7.28.1 Request
    165
  - 7.28.2 Response
    165
- 7.29 SetTerminationPoint – ODU PORT CONFIG
  166
  - 7.29.1 Request
    166
  - 7.29.2 Response
    167
- 7.30 SetTerminationPoint – OPTICAL PAYLOAD PORT CONFIG
  168
  - 7.30.1 Request
    168
  - 7.30.2 Response
    168
- 7.31 SetTerminationPoint – OTN PORT CONFIG
  169
  - 7.31.1 Request
    169
  - 7.31.2 Response
    170
- 7.32 SetTerminationPoint – ADMIN STATUS PORT CONFIG
  171
  - 7.32.1 Request
    171
  - 7.32.2 Response
    172
- 7.33 SetTerminationPoint – WAVELENGTH PORT CONFIG
  173
  - 7.33.1 Request
    173
  - 7.33.2 Response
    173
- 7.34 Provision CEM Service
  174
  - 7.34.1 Request
    174
  - 7.34.2 Response
    176
  - 7.34.3 Notification
    176
- 7.35 Modify CEM Service
  178
  - 7.35.1 Request
    178
  - 7.35.2 Response
    179
  - 7.35.3 Notification
    179
- 7.36 Terminate CEM Service
  182
  - 7.36.1 Request
    182
  - 7.36.2 Response
    183
  - 7.36.3 Notification
    183
- 7.37 Provision MPLS-TE Service
  185
  - 7.37.1 Request
    185
  - 7.37.2 Response
    187
- 7.38 Provision CE Service
  187
  - 7.38.1 Provision EPL Service
    187
    - 7.38.1.1 Request
      187
    - 7.38.1.2 Response
      189
    - 7.38.1.3 Notification
      189
  - 7.38.2 Modify EPL Service
    191
    - 7.38.2.1 Request
      191
    - 7.38.2.2 Response
      192
  - 7.38.3 Terminate EPL Service
    193
    - 7.38.3.1 Request
      193
    - 7.38.3.2 Response
      193
  - 7.38.4 Provision EVPL Service
    193
    - 7.38.4.1 Request
      193
    - 7.38.4.2 Response
      196
    - 7.38.4.3 Request (with Partial Service support)
      196
    - 7.38.4.4 Response
      197
  - 7.38.5 Provision EP-LAN Service
    198
    - 7.38.5.1 Request
      198
    - 7.38.5.2 Response
      199
  - 7.38.6 Provision EVP-LAN Service
    199
    - 7.38.6.1 Request
      199
    - 7.38.6.2 Response
      201
  - 7.38.7 Provision EP-Tree Service
    201
    - 7.38.7.1 Request
      201
    - 7.38.7.2 Response
      203
  - 7.38.8 Provision EVP-Tree Service
    203
    - 7.38.8.1 Request
      203
    - 7.38.8.2 Response
      206
  - 7.38.9 Provision Access EPL Service
    206
    - 7.38.9.1 Request
      206
    - 7.38.9.2 Response
      208
  - 7.38.10 Provision Access EVPL Service
    208
    - 7.38.10.1 Request
      208
    - 7.38.10.2 Response
      211
  - 7.38.11 Provision QoS Profile Service
    211
    - 7.38.11.1 Request
      211
    - 7.38.11.2 Response
      213
  - 7.38.12 Provision NI Service
    213
    - 7.38.12.1 Request
      213
    - 7.38.12.2 Response
      214
- 7.39 Provision L3VPN – Create Service
  214
  - 7.39.1 Request
    214
  - 7.39.2 Response
    217
- 7.40 Provision L3VPN – Terminate Service
  217
  - 7.40.1 Request
    217
  - 7.40.2 Response
    218
- 7.41 Provision L3VPN – Modify Service
  218
  - 7.41.1 Request
    218
  - 7.41.2 Response
    220
- 7.42 Run CLI Template
  220
  - 7.42.1 Request
    220
  - 7.42.2 Response
    221
- 7.43 CLI Template Run Status
  221
  - 7.43.1 Request
    221
  - 7.43.2 Response
    222
- 7.44 Resource Configuration – Create
  222
  - 7.44.1 Request
    222
  - 7.44.2 Response
    223
- 7.45 Resource Configuration – Modify
  224
  - 7.45.1 Request
    224
  - 7.45.2 Response
    225
- 7.46 Resource Configuration – Delete
  225
  - 7.46.1 Request
    225
  - 7.46.2 Response
    226
- 7.47 Customer
  227
  - 7.47.1 Get all Customers
    227
    - 7.47.1.1 Request
      227
    - 7.47.1.2 Response
      227
- 7.48 Get All QoS Policies
  228
  - 7.48.1 Request
    228
  - 7.48.2 Response
    228
- 7.49 Get All QoS Profiles
  228
  - 7.49.1 Request
    228
  - 7.49.2 Response
    228
  - 7.49.3 Create Customer
    229
    - 7.49.3.1 Request
      229
    - 7.49.3.2 Response
      229
  - 7.49.4 Update Customer
    229
    - 7.49.4.1 Request
      229
    - 7.49.4.2 Response
      229
  - 7.49.5 Delete Customer
    230
    - 7.49.5.1 Request
      230
    - 7.49.5.2 Response
      230
8 Notifications
231
9 References
244

Developer's Guide

Size:

2.94 MB
Pages:

244
Language:

English

Developer's Guide

Table of Contents

Developer's Guide

Size:

1.72 MB
Pages:

88
Language:

English

Developer's Guide

Table of Contents

Developer's Guide

Size:

4.46 MB
Pages:

254
Language:

English

Developer's Guide

Table of Contents

Preface
18
Conventions
18
Additional User Documentation
18
Obtaining Documentation, Obtaining Support, and Security Guidelines
18
Northbound MTOSI Interface
19
Web Services Standards
19
MTOSI Standards
19
Communication Patterns
19
Iterator Pattern
19
MTOSI Object Naming and Configuration
20
OSS Integration Usage Scenarios
21
Retrieving Device Inventory Flow
21
Inventory Notification Registration and Processing Flow
22
Service Provisioning Flow
23
Service Provisioning Flow for Carrier Ethernet
23
Service Provisioning Flow for Optical (OTN) Services
24
Service Provisioning Flow for Optical (DWDM) Services
25
Supported MTOSI Interfaces
26
MTOSI Interface Endpoints
27
Authentication
29
Authorization
29
License
29
MTOSI Interface Details
30
ManagedElementRetrieval
30
Managed Element Data
30
Operations
31
getAllManagedElements
31
4.1.2.1.1 Input
31
4.1.2.1.2 Output
31
4.1.2.1.3 Exceptions
32
getAllManagedElementsIterator
32
4.1.2.2.1 Input
32
4.1.2.2.2 Output
32
4.1.2.2.3 Exceptions
32
getManagedElement
32
4.1.2.3.1 Input
32
4.1.2.3.2 Output
33
4.1.2.3.3 Exceptions
33
ManagedElementNameRetrieval
33
getAllManagedElementNames
33
4.2.1.1.1 Input
33
4.2.1.1.2 Output
33
4.2.1.1.3 Exceptions
33
getManagedElementNamesIterator
33
4.2.1.2.1 Input
33
4.2.1.2.2 Output
34
4.2.1.2.3 Exceptions
34
EquipmentInventoryRetrieval
34
Equipment Data
34
Operations
36
getEquipment
36
4.3.2.1.1 Input
36
4.3.2.1.2 Output
36
4.3.2.1.3 Exceptions
36
getAllEquipment
36
4.3.2.2.1 Input
36
4.3.2.2.2 Output
36
4.3.2.2.3 Exceptions
36
getEquipmentIterator
36
4.3.2.3.1 Input
37
4.3.2.3.2 Output
37
4.3.2.3.3 Exceptions
37
getContainedEquipment
37
4.3.2.4.1 Input
37
4.3.2.4.2 Output
37
4.3.2.4.3 Exceptions
37
TerminationPointRetrieval
37
Termination Point Data
37
Operations
41
getAllPhysicalTerminationPoints
41
4.4.2.1.1 Input
41
4.4.2.1.2 Output
41
4.4.2.1.3 Exceptions
41
getTerminationPointsIterator
41
4.4.2.2.1 Input
41
4.4.2.2.2 Output
41
4.4.2.2.3 Exceptions
41
getTerminationPoint
42
4.4.2.3.1 Input
42
4.4.2.3.2 Output
42
4.4.2.3.3 Exceptions
42
getAllFloatingTerminationPoints
42
4.4.2.4.1 Input
42
4.4.2.4.2 Output
42
4.4.2.4.3 Exceptions
42
getAllSupportedPhysicalTerminationPoints
42
4.4.2.5.1 Input
42
4.4.2.5.2 Output
43
4.4.2.5.3 Exceptions
43
getContainedInUseConnectionTerminationPoints
43
4.4.2.6.1 Input
43
4.4.2.6.2 Output
43
4.4.2.6.3 Exceptions
43
getContainedPotentialConnectionTerminationPoints
43
4.4.2.7.1 Input
43
4.4.2.7.2 Output
44
4.4.2.7.3 Exceptions
44
ConnectionRetrieval (Optical Domain)
44
getAllsubnetworkConnection
44
4.5.1.1.1 Input
44
4.5.1.1.2 Output
44
4.5.1.1.3 Exceptions
46
getSubnetworkConnection
46
4.5.1.2.1 Input
46
4.5.1.2.2 Output
46
4.5.1.2.3 Exceptions
48
getSubnetworkConnectionsIterator
48
4.5.1.3.1 Input
48
4.5.1.3.2 Output
48
4.5.1.3.3 Exceptions
50
getRoute
50
4.5.1.4.1 Input
50
4.5.1.4.2 Output
50
4.5.1.4.3 Exceptions
50
getAllCrossConnections
50
4.5.1.5.1 Input
50
4.5.1.5.2 Output
51
4.5.1.5.3 Exceptions
51
getAllSubnetworkConnectionsWithTP
51
4.5.1.6.1 Input
51
4.5.1.6.2 Output
51
4.5.1.6.3 Exceptions
51
TopologicalLinkRetrieval
52
getAllTopologicalLinks
52
4.6.1.1.1 Input
52
4.6.1.1.2 Output
52
4.6.1.1.3 Exceptions
52
getTopologicalLink
52
4.6.1.2.1 Input
52
4.6.1.2.2 Output
53
4.6.1.2.3 Exceptions
53
getTopologicalLinksIterator
53
4.6.1.3.1 Input
53
4.6.1.3.2 Output
53
4.6.1.3.3 Exceptions
54
getRouteAndTopologicalLinks
54
4.6.1.4.1 Input
54
4.6.1.4.2 Output
54
4.6.1.4.3 Exceptions
55
FlowDomainRetrieval (Carrier Ethernet Inventory)
55
Flow Domain Fragment Data
55
Operations
57
getAllFlowDomainFragments
57
4.7.2.1.1 Input
57
4.7.2.1.2 Output
57
4.7.2.1.3 Exceptions
57
getFlowDomainFragmentIterator
57
4.7.2.2.1 Input
57
4.7.2.2.2 Output
57
4.7.2.2.3 Exceptions
58
getFlowDomainFragment
58
4.7.2.3.1 Input
58
4.7.2.3.2 Output
58
4.7.2.3.3 Exceptions
58
getFlowDomainFragmentRoute
58
4.7.2.4.1 Input
58
4.7.2.4.2 Output
58
4.7.2.4.3 Exceptions
59
FlowDomainFragmentNameRetrieval (Carrier Ethernet Inventory)
59
Operations
60
getAllFlowDomainFragmentNames
60
4.8.1.1.1 Input
60
4.8.1.1.2 Output
60
4.8.1.1.3 Exceptions
60
getFlowDomainFragmentNamesIterator
60
4.8.1.2.1 Input
60
4.8.1.2.2 Output
60
4.8.1.2.3 Exceptions
61
ServiceInventoryRetrieval
61
Customer Facing Service (CFS) Data
61
Service Access Point (SAP) Data
67
Operations
70
getServiceInventory
70
4.9.3.1.1 Input
70
4.9.3.1.2 Output
71
4.9.3.1.3 Exceptions
71
getServiceInventoryIterator
72
4.9.3.2.1 Input
72
4.9.3.2.2 Output
72
4.9.3.2.3 Exceptions
72
NetworkInterfaceRetrieval
72
Network Interface Data
72
Operations
73
4.10.2.1 getNetworkInterface
73
4.10.2.1.1 Input
73
4.10.2.1.2 Output
73
4.10.2.2 getAllNetworkInterfaces
73
4.10.2.2.1 Input
73
4.10.2.2.2 Output
73
4.10.2.3 getNetworkInterfacesIterator
74
Input
74
Output
74
CustomerNameRetrieval
74
4.11.1.1 getAllCustomerNames
74
4.11.1.1.1 Input
74
4.11.1.1.2 Output
75
4.11.1.2 getCustomerNamesIterator
75
4.11.1.2.1 Input
75
4.11.1.2.2 Output
75
4.11.1.2.3 Exceptions
75
QosProfileNameRetrieval
76
4.12.1.1 getAllQosProfileNames
76
4.12.1.1.1 Input
76
4.12.1.1.2 Output
76
4.12.1.1.3 Exceptions
76
4.12.1.2 getQosProfileNamesIterator
76
4.12.1.2.1 Input
76
4.12.1.2.2 Output
76
4.12.1.2.3 Exceptions
77
OpticalLinkInterfaceRetrieval
77
getAllOpticalLinkInterfaces
77
4.13.1.1.1 Input
77
4.13.1.1.2 Output
77
4.13.1.1.3 Exceptions
77
getOpticalLinkInterfacesIterator
77
4.13.2.1.1 Input
78
4.13.2.1.2 Output
78
4.13.2.1.3 Exceptions
78
ServiceActivationInterface
78
Supported Services for Provisioning
78
Error Message Format with Error Codes
79
4.14.2.1 Deploy Result Error or Info message
79
4.14.2.2 List of error or info codes
80
Service Order Data
80
4.14.3.1 Optical Service Order Data
80
4.14.3.1.1 OTN Service Order Data
80
4.14.3.1.2 OTN Path Options
82
4.14.3.1.3 TRAIL UNI – UNI Config Parameters
83
4.14.3.1.4 TRAIL UNI – UNI Explicit Path
83
4.14.3.1.5 OCH Trail Uni Diversity
84
4.14.3.1.6 DMDM Service Order Data
84
4.14.3.1.7 DMDM Service Constraints
86
4.14.3.1.8 DMDM Channel to Frequency Mapping Grid
87
4.14.3.2 Carrier Ethernet Service Order Data
88
4.14.3.2.1 QinQ Configuration in Order data
96
4.14.3.2.2 Multi-UNI Configuration in Order data
96
4.14.3.3 Carrier Ethernet Endpoint Service Order Data
97
4.14.3.3.1 Carrier Ethernet UNI Endpoint Service Order Data
97
4.14.3.3.2 Carrier Ethernet ENNI Endpoint Service Order Data
99
4.14.3.4 Carrier Ethernet QoS Profile Service Order Data
99
Operations
100
4.14.4.1 Provision
100
4.14.4.1.1 Optical Services
101
4.14.4.1.2 Carrier Ethernet Services
101
4.14.4.1.3 Service Input Data
101
4.14.4.1.4 Input
101
4.14.4.1.5 Provision Response
101
4.14.4.1.6 Output
101
4.14.4.1.7 Exceptions
102
4.14.4.2 modify
102
4.14.4.2.1 Input
102
4.14.4.2.2 Modify Response
103
4.14.4.2.3 Output
103
4.14.4.2.4 Exceptions
103
4.14.4.3 Terminate
103
4.14.4.3.1 Input
103
4.14.4.3.2 Terminate Response
104
4.14.4.3.3 Output
104
4.14.4.3.4 Exceptions
104
4.14.4.4 activate
104
4.14.4.4.1 Input
104
4.14.4.4.2 Activate Response
105
4.14.4.4.3 Output
105
4.14.4.4.4 Exceptions
105
4.14.4.5 deActivate
105
4.14.4.5.1 Input
105
4.14.4.5.2 Activate Response
106
4.14.4.5.3 Output
106
4.14.4.5.4 Exceptions
106
4.14.4.6 retrieveServiceStates
106
4.14.4.6.1 Input
106
4.14.4.6.2 Output
107
4.14.4.6.3 Exceptions
107
Alarm Retrieval
107
Operations
107
4.15.1.1 getActiveAlarms
107
4.15.1.1.1 Input
107
4.15.1.1.2 Output
108
4.15.1.1.3 Exceptions
109
4.15.1.2 getActiveAlarmsCount
109
4.15.1.2.1 Input
109
4.15.1.2.2 Output
110
4.15.1.2.3 Exceptions
110
4.15.1.3 getActiveAlarmsIterator
110
4.15.1.3.1 Input
110
4.15.1.3.2 Output
110
4.15.1.3.3 Exceptions
110
TerminationPointControl
110
Operations
110
4.16.1.1 setTerminationPointData
110
4.16.1.1.1 Input
110
4.16.1.1.2 Supported Parameter Name and Value Table
111
NOTE:
114
4.16.1.1.3 Output
114
4.16.1.1.4 Exceptions
114
ConnectionControl
115
Operations
115
4.17.1.1 switchRoute
115
4.17.1.1.1 Output
115
4.17.1.1.2 Exceptions
115
4.17.1.2 setIntendedRoute
116
4.17.1.2.1 Output
116
4.17.1.2.2 Exceptions
116
ProtectionProfileControl
116
ProtectionProfileDataType
116
Operations
117
4.18.2.1 CreateProtectionProfile
117
4.18.2.1.1 Input
117
4.18.2.1.2 Output
117
4.18.2.1.3 Exceptions
117
4.18.2.2 ModifyProtectionProfile
118
4.18.2.2.1 Input
118
4.18.2.2.2 Output
118
4.18.2.2.3 Exceptions
118
4.18.2.3 DeleteProtectionProfile
118
4.18.2.3.1 Input
118
4.18.2.3.2 Output
118
4.18.2.3.3 Exceptions
119
ProtectionProfileRetrieval
119
4.19.1.1 getAllProtectionProfiles
119
4.19.1.1.1 Input
119
4.19.1.1.2 Output
119
4.19.1.1.3 Exceptions
119
4.19.1.2 getProtectionProfile
120
4.19.1.2.1 Input
120
4.19.1.2.2 Output
120
4.19.1.2.3 Exceptions
120
4.19.1.3 getAllSubnetworkConnectionsWithProtectionProfile
120
4.19.1.3.1 Input
120
4.19.1.3.2 Output
121
4.19.1.3.3 Exceptions
121
MPLSTEExplicitPathControl
121
MPLSTEExplicitPathDataType
121
Operations
121
4.20.2.1 CreateMPLSTEExplicitPath
121
4.20.2.1.1 Input
121
4.20.2.1.2 Output
122
4.20.2.1.3 Exceptions
122
4.20.2.2 ModifyMPLSTEExplicitPath
122
4.20.2.2.1 Input
122
4.20.2.2.2 Output
122
4.20.2.2.3 Exceptions
123
4.20.2.3 DeleteMPLSTEExplicitPath
123
4.20.2.3.1 Input
123
4.20.2.3.2 Output
123
4.20.2.3.3 Exceptions
123
MPLSTEExplicitPathRetrieval
123
4.21.1.1 getAllMPLSTEExplicitPaths
123
4.21.1.1.1 Input
123
4.21.1.1.2 Output
123
4.21.1.1.3 Exceptions
124
4.21.1.2 getMPLSTEExplicitpath
124
4.21.1.2.1 Input
124
4.21.1.2.2 Output
124
4.21.1.2.3 Exceptions
124
4.21.1.3 getAllSubnetworkConnectionsWithExplicitPath
124
4.21.1.3.1 Input
124
4.21.1.3.2 Output
124
4.21.1.3.3 Exceptions
124
CiscoConfigActivationControl
125
Operations
125
4.22.1.1 create
125
4.22.1.1.1 Input
125
4.22.1.1.2 Output
125
4.22.1.1.3 Exceptions
125
4.22.1.2 modify
125
4.22.1.2.1 Input
125
4.22.1.2.2 Output
125
4.22.1.2.3 Exceptions
125
4.22.1.3 delete
126
4.22.1.3.1 Input
126
4.22.1.3.2 Output
126
4.22.1.3.3 Exceptions
126
Notifications
126
Notification Support Matrix
126
4.23.1.1 Service Provisioning Notifications Matrix
127
Notification Subscribe Interface
127
4.23.2.1.1 Input
127
Alarm Handling
127
Operations
127
4.24.1.1 acknolwledgeAlarms
127
4.24.1.1.1 Input
127
4.24.1.1.2 Output
127
4.24.1.1.3 Exceptions
128
4.24.1.2 unacknolwledgeAlarms
128
4.24.1.2.1 Input
128
4.24.1.2.2 Output
128
4.24.1.2.3 Exceptions
128
Cisco-Specific Interfaces
129
Troubleshooting
130
Appendix I – WSDL Document References
131
MTOSI WSDL Documents
131
Appendix II – Example Java Client to Retrieve Inventory
132
Appendix III – Sample SOAP Request Response
134
getAllManagedElements
134
SOAP Request
134
SOAP Response
134
getAllManagedElementsIterator
139
SOAP Request
139
SOAP Response
140
getManagedElement
143
SOAP Request
143
SOAP Response
143
getAllEquipment
145
SOAP Request
145
SOAP Response
146
getEquipment
153
SOAP Request
153
SOAP Response
153
getContainedEquipment
155
SOAP Request
155
SOAP Response
156
getEquipmentIterator
160
SOAP Request
160
SOAP Response
161
getAllCrossConnections
163
SOAP Request
163
SOAP Response
164
getAllSubnetworkConnectionsWithTP
168
SOAP Request
168
SOAP Response
168
getAllPhysicalTerminationPoints
172
SOAP Request
172
SOAP Response
173
getTerminationPointsIterator
180
SOAP Request
180
SOAP Response
180
getAllFloatingTerminationPoints
193
SOAP Request
193
SOAP Response
193
getTerminationPoint
208
SOAP Request
208
SOAP Response
209
getAllSupportedPhysicalTerminationPoints
211
SOAP Request
211
SOAP Response
212
getContainedPotentialConnectionTerminationPoints
217
SOAP Request
217
SOAP Response
218
getContainedInUseConnectionTerminationPoints
220
SOAP Request
220
SOAP Response
221
getAllSubnetworkConnections
223
SOAP Request
223
SOAP Response
223
getSubnetworkConnection
227
SOAP Request
227
SOAP Response
228
SOAP Response – SNC with Diverse From Circuit Reference
230
getSubnetworkConnectionsIterator
233
SOAP Request
233
SOAP Response
233
getRoute
236
SOAP Request
236
SOAP Response
236
getAllTopologicalLinks
241
SOAP Request
241
SOAP Response
241
getTopologicalLink
251
SOAP Request
251
SOAP Response
251
getTopologicalLinksIterator
254
SOAP Request
254
SOAP Response
254
getRouteAndTopologicalLinks
262
SOAP Request
262
SOAP Response - OCHTrail
263
SOAP Response – ODU-UNI
278
SOAP Response – OCHNC
282
getAllFlowDomainFragments
287
SOAP Request
287
SOAP Response
287
getFlowDomainFragment
315
SOAP Request
315
SOAP Response
316
getFlowDomainFragmentRoute
320
SOAP Request
320
SOAP Response
320
getFlowDomainFragmentsIterator
325
SOAP Request
325
SOAP Response
325
getAllFlowDomainFragmentNames
341
SOAP Request
341
SOAP Response
342
getFlowDomainFragmentNamesIterator
353
SOAP Request
353
SOAP Response
353
getAllOpticalLinkInterfaces
358
SOAP Request
358
SOAP Response
358
getAllNetworkInterfaces
360
SOAP Request
360
SOAP Response
360
getNetworkInterface
362
SOAP Request
362
SOAP Response
362
getAllCustomerNames
364
SOAP Request
364
SOAP Response
364
getAllQosProfileNames
365
SOAP Request
365
SOAP Response
366
getProtectionProfile
367
SOAP Request
367
SOAP Response
367
getAllProtectionProfiles
369
SOAP Request
369
SOAP Response
369
createProtectionProfile
372
SOAP Request
372
SOAP Response
374
modifyProtectionProfile
375
SOAP Request
375
SOAP Response
376
deleteProtectionProfile
378
SOAP Request
378
SOAP Response
378
getMPLSTEExplicitPath
379
SOAP Request
379
SOAP Response
380
getAllMPLSTEExplicitPaths
382
SOAP Request
382
SOAP Response
383
createMPLSTEExplicitPath
396
SOAP Request
396
SOAP Response
397
modifyMPLSTEExplicitPath
399
SOAP Request
399
SOAP Response
400
deleteMPLSTEExplicitPath
401
SOAP Request
401
SOAP Response
402
getServiceInventory for CFS Data
404
CE Service SOAP Request
404
CE Service SOAP Response
405
DWDM/OTN Service SOAP Request
409
DWDM/OTN Service SOAP Response
410
getServiceInventory for SAP Data
414
CE Service SOAP Request
414
CE Service SOAP Response
415
CE Service SAP SOAP Response for QinQ
416
DWDM/OTN Service SOAP Resquest
419
DWDM/OTN Service SOAP Response
420
provision - DWDM services
424
DWDM Services SOAP Request
424
DWDM Services SOAP Response
428
provision – OTN services
430
OTN Services SOAP Request
430
OTN Services SOAP Response
432
provision –TRAIL-UNI services
434
TRAIL-UNI Services SOAP Request
434
TRAIL-UNI Services SOAP Response
436
TRAIL-UNI Services with Diversity SOAP Request
439
TRAIL-UNI Services with Diversity SOAP Response
442
TRAIL-UNI Services with Explicit Path SOAP Request
445
TRAIL-UNI Services with Explicit Path SOAP Response
448
provision – Carrier Ethernet Services
451
EPL Provision SOAP Request
451
EPL Provision SOAP Response
453
EVPL Provision SOAP Request
456
EVPL Provision SOAP Response
459
EVPL Provision with QinQ Configuration - SOAP Request
461
EVPL Provision with QinQ Configuration - SOAP Response
465
Access EPL Provision SOAP Request
468
Access EPL Provision SOAP Response
472
Access EVPL Provision SOAP Request
474
Access EVPL Provision SOAP Response
476
Access EVPL Provision with QinQ Configuration - SOAP Request
479
Access EVPL Provision with QinQ Configuration - SOAP Response
483
EP-LAN Provision SOAP Request
486
EP-LAN Provision SOAP Response
488
EVP-LAN Provision SOAP Request
490
EVP-LAN Provision SOAP Response
492
EVP-LAN Provision with Multi-UNI Configuration - SOAP Request
494
EVP-LAN Provision with Multi-UNI Configuration - SOAP Response
498
EP-Tree Provision SOAP Request
501
EP-Tree Provision SOAP Response
503
EVP-Tree Provision SOAP Request
505
EVP-Tree Provision SOAP Response
507
QOS Profile Provision SOAP Request
509
QOS Profile Provision SOAP Response
511
UNI Service Provision SOAP Request
513
UNI Service Provision SOAP Response
515
ENNI Service Provision SOAP Request
517
ENNI Service Provision SOAP Response
519
modify – CE Services
520
CE Service EPL Modify SOAP Request
520
CE Service EPL Modify SOAP Response
522
CE Service EP-LAN Modify (Add Site) SOAP Request
524
CE Service EP-LAN Modify (Add Site) SOAP Response
526
CE Service EP-LAN Modify (Remove Site) SOAP Request
529
CE Service EP-LAN Modify (Remove Site) SOAP Response
530
UNI Service Modify SOAP Request
533
UNI Service Modify SOAP Response
535
ENNI Service Modify SOAP Request
536
ENNI Service Modify SOAP Response
538
modify – DWDM Services
540
DWDM Service Modify SOAP Request
540
DWDM Service Modify SOAP Response
543
OTN Service Modify SOAP Request
545
OTN Service Modify SOAP Response
547
retrieveServiceStates – CE Services
549
CE Service Retrieve Service States SOAP Request
549
CE Service Retrieve Service States SOAP Response
550
retrieveServiceStates – DWDM / OTN Services
551
DWDM/OTN Services SOAP Request
551
DWDM/OTN Services SOAP Response
552
terminate – DWDM/OTN Services
553
DWDM/OTN Service SOAP Request
553
DWDM/OTN Service SOAP Response
554
terminate – CE Services
556
CE Service Terminate SOAP Request
556
CE Service Terminate SOAP Response
557
Terminate QOS Profile SOAP Request
559
Terminate QOS Profile SOAP Response
560
Terminate UNI / ENNI Service SOAP Request
562
Terminate UNI / ENNI Service SOAP Response
563
Alarm Retrieval
565
getActiveAlarms
565
9.58.1.1 SOAP Request
565
9.58.1.2 SOAP Response
566
getActiveAlarmsCount
567
9.58.2.1 SOAP Request
567
9.58.2.2 SOAP Response
568
ConnectionControl
568
switchRoute
568
9.59.1.1 SOAP Request
568
9.59.1.2 SOAP Response
570
setIntendedRoute
572
9.59.2.1 SOAP Request
572
9.59.2.2 SOAP Response
573
TerminationPointControl
575
setTerminationPointData
575
9.60.1.1 SOAP Request Regular
575
9.60.1.2 SOAP Response Regular
576
9.60.1.3 SOAP Request SAPI DAPI
579
9.60.1.4 SOAP Response SAPI DAPI
581
9.60.1.5 SOAP Request ODU Controller
583
9.60.1.6 SOAP Response ODU Controller
585
9.60.1.7 SOAP Request Breakout Lane Creation
587
9.60.1.8 SOAP Response Breakout Lane Creation
589
9.60.1.9 SOAP Request Breakout Lane Deletion
592
SOAP Response Breakout Lane Deletion
593
SOAP Request Breakout Lane Updation
596
SOAP Response Breakout Lane Updation
598
CiscoConfigActivationControl
601
create
601
9.61.1.1 SOAP Request
601
9.61.1.2 SOAP Response
602
modify
603
9.61.2.1 SOAP Request
603
9.61.2.2 SOAP Response
604
delete
605
9.61.3.1 SOAP Request
605
9.61.3.2 SOAP Response
606
Notification
606
Subscribe Request
606
Subscribe Response
607
UnSubscribe Request
607
UnSubscribe Response
608
Notification Samples
608
Equipment Add
608
ManagedElement Delete
611
Equipment Update
612
SubNetworkConnection - Attribute Value Change
614
Service Provisioning – CFS Created
617
Service Provisioning – CFS Service State Change
620
Service Provisioning – CFS Terminate
622
FDN Value Change Notification
624
Alarm Handling
628
acknowledgeAlarms
628
9.64.1.1 SOAP Request
628
9.64.1.2 SOAP Response
628
unacknowledgeAlarms
629
9.64.2.1 SOAP Request
629
9.64.2.2 SOAP Response
630
10 References
631

Developer's Guide

Size:

8.88 MB
Pages:

631
Language:

English

Developer's Guide

Table of Contents

Developer's Guide

Size:

6.85 MB
Pages:

632
Language:

English

Developer's Guide

Table of Contents

Preface
18
Conventions
18
Additional User Documentation
18
Obtaining Documentation, Obtaining Support, and Security Guidelines
18
Northbound MTOSI Interface
19
Web Services Standards
19
MTOSI Standards
19
Communication Patterns
19
Iterator Pattern
19
MTOSI Object Naming and Configuration
20
OSS Integration Usage Scenarios
21
Retrieving Device Inventory Flow
21
Inventory Notification Registration and Processing Flow
22
Service Provisioning Flow
23
Service Provisioning Flow for Carrier Ethernet
23
Service Provisioning Flow for Optical (OTN) Services
24
Service Provisioning Flow for Optical (DWDM) Services
25
Supported MTOSI Interfaces
26
MTOSI Interface Endpoints
27
Authentication
29
Authorization
29
License
29
MTOSI Interface Details
30
ManagedElementRetrieval
30
Managed Element Data
30
Operations
31
getAllManagedElements
31
4.1.2.1.1 Input
31
4.1.2.1.2 Output
31
4.1.2.1.3 Exceptions
32
getAllManagedElementsIterator
32
4.1.2.2.1 Input
32
4.1.2.2.2 Output
32
4.1.2.2.3 Exceptions
32
getManagedElement
32
4.1.2.3.1 Input
32
4.1.2.3.2 Output
33
4.1.2.3.3 Exceptions
33
ManagedElementNameRetrieval
33
getAllManagedElementNames
33
4.2.1.1.1 Input
33
4.2.1.1.2 Output
33
4.2.1.1.3 Exceptions
33
getManagedElementNamesIterator
33
4.2.1.2.1 Input
33
4.2.1.2.2 Output
34
4.2.1.2.3 Exceptions
34
EquipmentInventoryRetrieval
34
Equipment Data
34
Operations
36
getEquipment
36
4.3.2.1.1 Input
36
4.3.2.1.2 Output
36
4.3.2.1.3 Exceptions
36
getAllEquipment
36
4.3.2.2.1 Input
36
4.3.2.2.2 Output
36
4.3.2.2.3 Exceptions
36
getEquipmentIterator
36
4.3.2.3.1 Input
37
4.3.2.3.2 Output
37
4.3.2.3.3 Exceptions
37
getContainedEquipment
37
4.3.2.4.1 Input
37
4.3.2.4.2 Output
37
4.3.2.4.3 Exceptions
37
TerminationPointRetrieval
37
Termination Point Data
37
Operations
41
getAllPhysicalTerminationPoints
41
4.4.2.1.1 Input
41
4.4.2.1.2 Output
41
4.4.2.1.3 Exceptions
41
getTerminationPointsIterator
41
4.4.2.2.1 Input
41
4.4.2.2.2 Output
41
4.4.2.2.3 Exceptions
41
getTerminationPoint
42
4.4.2.3.1 Input
42
4.4.2.3.2 Output
42
4.4.2.3.3 Exceptions
42
getAllFloatingTerminationPoints
42
4.4.2.4.1 Input
42
4.4.2.4.2 Output
42
4.4.2.4.3 Exceptions
42
getAllSupportedPhysicalTerminationPoints
42
4.4.2.5.1 Input
42
4.4.2.5.2 Output
43
4.4.2.5.3 Exceptions
43
getContainedInUseConnectionTerminationPoints
43
4.4.2.6.1 Input
43
4.4.2.6.2 Output
43
4.4.2.6.3 Exceptions
43
getContainedPotentialConnectionTerminationPoints
43
4.4.2.7.1 Input
43
4.4.2.7.2 Output
44
4.4.2.7.3 Exceptions
44
ConnectionRetrieval (Optical Domain)
44
getAllsubnetworkConnection
44
4.5.1.1.1 Input
44
4.5.1.1.2 Output
44
4.5.1.1.3 Exceptions
46
getSubnetworkConnection
46
4.5.1.2.1 Input
46
4.5.1.2.2 Output
46
4.5.1.2.3 Exceptions
48
getSubnetworkConnectionsIterator
48
4.5.1.3.1 Input
48
4.5.1.3.2 Output
48
4.5.1.3.3 Exceptions
51
getRoute
51
4.5.1.4.1 Input
51
4.5.1.4.2 Output
51
4.5.1.4.3 Exceptions
51
getAllCrossConnections
51
4.5.1.5.1 Input
51
4.5.1.5.2 Output
51
4.5.1.5.3 Exceptions
52
getAllSubnetworkConnectionsWithTP
52
4.5.1.6.1 Input
52
4.5.1.6.2 Output
52
4.5.1.6.3 Exceptions
52
TopologicalLinkRetrieval
53
getAllTopologicalLinks
53
4.6.1.1.1 Input
53
4.6.1.1.2 Output
53
4.6.1.1.3 Exceptions
53
getTopologicalLink
53
4.6.1.2.1 Input
53
4.6.1.2.2 Output
54
4.6.1.2.3 Exceptions
54
getTopologicalLinksIterator
54
4.6.1.3.1 Input
54
4.6.1.3.2 Output
54
4.6.1.3.3 Exceptions
55
getRouteAndTopologicalLinks
55
4.6.1.4.1 Input
55
4.6.1.4.2 Output
55
4.6.1.4.3 Exceptions
56
FlowDomainRetrieval (Carrier Ethernet Inventory)
56
Flow Domain Fragment Data
56
Operations
58
getAllFlowDomainFragments
58
4.7.2.1.1 Input
58
4.7.2.1.2 Output
58
4.7.2.1.3 Exceptions
58
getFlowDomainFragmentIterator
58
4.7.2.2.1 Input
58
4.7.2.2.2 Output
58
4.7.2.2.3 Exceptions
59
getFlowDomainFragment
59
4.7.2.3.1 Input
59
4.7.2.3.2 Output
59
4.7.2.3.3 Exceptions
59
getFlowDomainFragmentRoute
59
4.7.2.4.1 Input
59
4.7.2.4.2 Output
59
4.7.2.4.3 Exceptions
60
FlowDomainFragmentNameRetrieval (Carrier Ethernet Inventory)
60
Operations
61
getAllFlowDomainFragmentNames
61
4.8.1.1.1 Input
61
4.8.1.1.2 Output
61
4.8.1.1.3 Exceptions
61
getFlowDomainFragmentNamesIterator
61
4.8.1.2.1 Input
61
4.8.1.2.2 Output
61
4.8.1.2.3 Exceptions
62
ServiceInventoryRetrieval
62
Customer Facing Service (CFS) Data
62
Service Access Point (SAP) Data
68
Operations
71
getServiceInventory
71
4.9.3.1.1 Input
71
4.9.3.1.2 Output
72
4.9.3.1.3 Exceptions
72
getServiceInventoryIterator
73
4.9.3.2.1 Input
73
4.9.3.2.2 Output
73
4.9.3.2.3 Exceptions
73
NetworkInterfaceRetrieval
73
Network Interface Data
73
Operations
74
getNetworkInterface
74
4.10.2.1.1 Input
74
4.10.2.1.2 Output
74
getAllNetworkInterfaces
74
4.10.2.2.1 Input
74
4.10.2.2.2 Output
74
getNetworkInterfacesIterator
75
Input
75
Output
75
CustomerNameRetrieval
75
getAllCustomerNames
75
4.11.1.1.1 Input
75
4.11.1.1.2 Output
76
getCustomerNamesIterator
76
4.11.1.2.1 Input
76
4.11.1.2.2 Output
76
4.11.1.2.3 Exceptions
76
QosProfileNameRetrieval
77
getAllQosProfileNames
77
4.12.1.1.1 Input
77
4.12.1.1.2 Output
77
4.12.1.1.3 Exceptions
77
getQosProfileNamesIterator
77
4.12.1.2.1 Input
77
4.12.1.2.2 Output
77
4.12.1.2.3 Exceptions
78
OpticalLinkInterfaceRetrieval
78
getAllOpticalLinkInterfaces
78
4.13.1.1.1 Input
78
4.13.1.1.2 Output
78
4.13.1.1.3 Exceptions
78
getOpticalLinkInterfacesIterator
78
4.13.2.1.1 Input
79
4.13.2.1.2 Output
79
4.13.2.1.3 Exceptions
79
ServiceActivationInterface
79
Supported Services for Provisioning
79
Error Message Format with Error Codes
80
Deploy Result Error or Info message
80
List of error or info codes
81
Service Order Data
81
Optical Service Order Data
81
4.14.3.1.1 OTN Service Order Data
81
4.14.3.1.2 OTN Path Options
83
4.14.3.1.3 TRAIL UNI – UNI Config Parameters
84
4.14.3.1.4 TRAIL UNI – UNI Explicit Path
84
4.14.3.1.5 OCH Trail Uni Diversity
85
4.14.3.1.6 DMDM Service Order Data
85
4.14.3.1.7 DMDM Service Constraints
87
4.14.3.1.8 DMDM Channel to Frequency Mapping Grid
88
Carrier Ethernet Service Order Data
89
4.14.3.2.1 QinQ Configuration in Order data
97
4.14.3.2.2 Multi-UNI Configuration in Order data
97
Carrier Ethernet Endpoint Service Order Data
98
4.14.3.3.1 Carrier Ethernet UNI Endpoint Service Order Data
98
4.14.3.3.2 Carrier Ethernet ENNI Endpoint Service Order Data
100
Carrier Ethernet QoS Profile Service Order Data
100
Operations
101
Provision
101
4.14.4.1.1 Optical Services
102
4.14.4.1.2 Carrier Ethernet Services
102
4.14.4.1.3 Service Input Data
102
4.14.4.1.4 Input
102
4.14.4.1.5 Provision Response
102
4.14.4.1.6 Output
102
4.14.4.1.7 Exceptions
103
modify
103
4.14.4.2.1 Input
103
4.14.4.2.2 Modify Response
104
4.14.4.2.3 Output
104
4.14.4.2.4 Exceptions
104
Terminate
104
4.14.4.3.1 Input
104
4.14.4.3.2 Terminate Response
105
4.14.4.3.3 Output
105
4.14.4.3.4 Exceptions
105
activate
105
4.14.4.4.1 Input
105
4.14.4.4.2 Activate Response
106
4.14.4.4.3 Output
106
4.14.4.4.4 Exceptions
106
deActivate
106
4.14.4.5.1 Input
106
4.14.4.5.2 Activate Response
107
4.14.4.5.3 Output
107
4.14.4.5.4 Exceptions
107
retrieveServiceStates
107
4.14.4.6.1 Input
107
4.14.4.6.2 Output
108
4.14.4.6.3 Exceptions
108
Alarm Retrieval
108
Operations
108
getActiveAlarms
108
4.15.1.1.1 Input
108
4.15.1.1.2 Output
109
4.15.1.1.3 Exceptions
110
getActiveAlarmsCount
110
4.15.1.2.1 Input
110
4.15.1.2.2 Output
111
4.15.1.2.3 Exceptions
111
getActiveAlarmsIterator
111
4.15.1.3.1 Input
111
4.15.1.3.2 Output
111
4.15.1.3.3 Exceptions
111
TerminationPointControl
111
Operations
111
setTerminationPointData
111
4.16.1.1.1 Input
111
4.16.1.1.2 Supported Parameter Name and Value Table
112
NOTE:
115
4.16.1.1.3 Output
115
4.16.1.1.4 Exceptions
115
ConnectionControl
116
Operations
116
switchRoute
116
4.17.1.1.1 Output
116
4.17.1.1.2 Exceptions
116
setIntendedRoute
117
4.17.1.2.1 Output
117
4.17.1.2.2 Exceptions
117
ProtectionProfileControl
117
ProtectionProfileDataType
117
Operations
118
CreateProtectionProfile
118
4.18.2.1.1 Input
118
4.18.2.1.2 Output
118
4.18.2.1.3 Exceptions
118
ModifyProtectionProfile
119
4.18.2.2.1 Input
119
4.18.2.2.2 Output
119
4.18.2.2.3 Exceptions
119
DeleteProtectionProfile
119
4.18.2.3.1 Input
119
4.18.2.3.2 Output
119
4.18.2.3.3 Exceptions
120
ProtectionProfileRetrieval
120
getAllProtectionProfiles
120
4.19.1.1.1 Input
120
4.19.1.1.2 Output
120
4.19.1.1.3 Exceptions
120
getProtectionProfile
121
4.19.1.2.1 Input
121
4.19.1.2.2 Output
121
4.19.1.2.3 Exceptions
121
getAllSubnetworkConnectionsWithProtectionProfile
121
4.19.1.3.1 Input
121
4.19.1.3.2 Output
122
4.19.1.3.3 Exceptions
122
MPLSTEExplicitPathControl
122
MPLSTEExplicitPathDataType
122
Operations
122
CreateMPLSTEExplicitPath
122
4.20.2.1.1 Input
122
4.20.2.1.2 Output
123
4.20.2.1.3 Exceptions
123
ModifyMPLSTEExplicitPath
123
4.20.2.2.1 Input
123
4.20.2.2.2 Output
123
4.20.2.2.3 Exceptions
124
DeleteMPLSTEExplicitPath
124
4.20.2.3.1 Input
124
4.20.2.3.2 Output
124
4.20.2.3.3 Exceptions
124
MPLSTEExplicitPathRetrieval
124
getAllMPLSTEExplicitPaths
124
4.21.1.1.1 Input
124
4.21.1.1.2 Output
124
4.21.1.1.3 Exceptions
125
getMPLSTEExplicitpath
125
4.21.1.2.1 Input
125
4.21.1.2.2 Output
125
4.21.1.2.3 Exceptions
125
getAllSubnetworkConnectionsWithExplicitPath
125
4.21.1.3.1 Input
125
4.21.1.3.2 Output
125
4.21.1.3.3 Exceptions
125
CiscoConfigActivationControl
126
Operations
126
create
126
4.22.1.1.1 Input
126
4.22.1.1.2 Output
126
4.22.1.1.3 Exceptions
126
modify
126
4.22.1.2.1 Input
126
4.22.1.2.2 Output
126
4.22.1.2.3 Exceptions
126
delete
127
4.22.1.3.1 Input
127
4.22.1.3.2 Output
127
4.22.1.3.3 Exceptions
127
Notifications
127
Notification Support Matrix
127
Service Provisioning Notifications Matrix
128
Notification Subscribe Interface
128
4.23.2.1.1 Input
128
Alarm Handling
128
Operations
128
acknolwledgeAlarms
128
4.24.1.1.1 Input
128
4.24.1.1.2 Output
128
4.24.1.1.3 Exceptions
129
unacknolwledgeAlarms
129
4.24.1.2.1 Input
129
4.24.1.2.2 Output
129
4.24.1.2.3 Exceptions
129
Cisco-Specific Interfaces
130
Troubleshooting
131
Appendix I – WSDL Document References
132
MTOSI WSDL Documents
132
Appendix II – Example Java Client to Retrieve Inventory
133
Appendix III – Sample SOAP Request Response
135
getAllManagedElements
135
SOAP Request
135
SOAP Response
135
getAllManagedElementsIterator
140
SOAP Request
140
SOAP Response
141
getManagedElement
144
SOAP Request
144
SOAP Response
144
getAllEquipment
146
SOAP Request
146
SOAP Response
147
getEquipment
154
SOAP Request
154
SOAP Response
154
getContainedEquipment
156
SOAP Request
156
SOAP Response
157
getEquipmentIterator
161
SOAP Request
161
SOAP Response
162
getAllCrossConnections
164
SOAP Request
164
SOAP Response
165
getAllSubnetworkConnectionsWithTP
169
SOAP Request
169
SOAP Response
169
getAllPhysicalTerminationPoints
173
SOAP Request
173
SOAP Response
174
getTerminationPointsIterator
181
SOAP Request
181
SOAP Response
181
getAllFloatingTerminationPoints
194
SOAP Request
194
SOAP Response
194
getTerminationPoint
209
SOAP Request
209
SOAP Response
210
getAllSupportedPhysicalTerminationPoints
212
SOAP Request
212
SOAP Response
213
getContainedPotentialConnectionTerminationPoints
218
SOAP Request
218
SOAP Response
219
getContainedInUseConnectionTerminationPoints
221
SOAP Request
221
SOAP Response
222
getAllSubnetworkConnections
224
SOAP Request
224
SOAP Response
224
getSubnetworkConnection
228
SOAP Request
228
SOAP Response
229
SOAP Response – SNC with Diverse From Circuit Reference
231
getSubnetworkConnectionsIterator
234
SOAP Request
234
SOAP Response
234
getRoute
237
SOAP Request
237
SOAP Response
237
getAllTopologicalLinks
242
SOAP Request
242
SOAP Response
242
getTopologicalLink
252
SOAP Request
252
SOAP Response
252
getTopologicalLinksIterator
255
SOAP Request
255
SOAP Response
255
getRouteAndTopologicalLinks
263
SOAP Request
263
SOAP Response - OCHTrail
264
SOAP Response – ODU-UNI
279
SOAP Response – OCHNC
283
getAllFlowDomainFragments
288
SOAP Request
288
SOAP Response
288
getFlowDomainFragment
316
SOAP Request
316
SOAP Response
317
getFlowDomainFragmentRoute
321
SOAP Request
321
SOAP Response
321
getFlowDomainFragmentsIterator
326
SOAP Request
326
SOAP Response
326
getAllFlowDomainFragmentNames
342
SOAP Request
342
SOAP Response
343
getFlowDomainFragmentNamesIterator
354
SOAP Request
354
SOAP Response
354
getAllOpticalLinkInterfaces
359
SOAP Request
359
SOAP Response
359
getAllNetworkInterfaces
361
SOAP Request
361
SOAP Response
361
getNetworkInterface
363
SOAP Request
363
SOAP Response
363
getAllCustomerNames
365
SOAP Request
365
SOAP Response
365
getAllQosProfileNames
366
SOAP Request
366
SOAP Response
367
getProtectionProfile
368
SOAP Request
368
SOAP Response
368
getAllProtectionProfiles
370
SOAP Request
370
SOAP Response
370
createProtectionProfile
373
SOAP Request
373
SOAP Response
375
modifyProtectionProfile
376
SOAP Request
376
SOAP Response
377
deleteProtectionProfile
379
SOAP Request
379
SOAP Response
379
getMPLSTEExplicitPath
380
SOAP Request
380
SOAP Response
381
getAllMPLSTEExplicitPaths
383
SOAP Request
383
SOAP Response
384
createMPLSTEExplicitPath
397
SOAP Request
397
SOAP Response
398
modifyMPLSTEExplicitPath
400
SOAP Request
400
SOAP Response
401
deleteMPLSTEExplicitPath
402
SOAP Request
402
SOAP Response
403
getServiceInventory for CFS Data
405
CE Service SOAP Request
405
CE Service SOAP Response
406
DWDM/OTN Service SOAP Request
410
DWDM/OTN Service SOAP Response
411
getServiceInventory for SAP Data
415
CE Service SOAP Request
415
CE Service SOAP Response
416
CE Service SAP SOAP Response for QinQ
417
DWDM/OTN Service SOAP Resquest
420
DWDM/OTN Service SOAP Response
421
provision - DWDM services
425
DWDM Services SOAP Request
425
DWDM Services SOAP Response
429
provision – OTN services
431
OTN Services SOAP Request
431
OTN Services SOAP Response
433
provision –TRAIL-UNI services
435
TRAIL-UNI Services SOAP Request
435
TRAIL-UNI Services SOAP Response
437
TRAIL-UNI Services with Diversity SOAP Request
440
TRAIL-UNI Services with Diversity SOAP Response
443
TRAIL-UNI Services with Explicit Path SOAP Request
446
TRAIL-UNI Services with Explicit Path SOAP Response
449
provision – Carrier Ethernet Services
452
EPL Provision SOAP Request
452
EPL Provision SOAP Response
454
EVPL Provision SOAP Request
457
EVPL Provision SOAP Response
460
EVPL Provision with QinQ Configuration - SOAP Request
462
EVPL Provision with QinQ Configuration - SOAP Response
466
Access EPL Provision SOAP Request
469
Access EPL Provision SOAP Response
473
Access EVPL Provision SOAP Request
475
Access EVPL Provision SOAP Response
477
Access EVPL Provision with QinQ Configuration - SOAP Request
480
Access EVPL Provision with QinQ Configuration - SOAP Response
484
EP-LAN Provision SOAP Request
487
EP-LAN Provision SOAP Response
489
EVP-LAN Provision SOAP Request
491
EVP-LAN Provision SOAP Response
493
EVP-LAN Provision with Multi-UNI Configuration - SOAP Request
495
EVP-LAN Provision with Multi-UNI Configuration - SOAP Response
499
EP-Tree Provision SOAP Request
502
EP-Tree Provision SOAP Response
504
EVP-Tree Provision SOAP Request
506
EVP-Tree Provision SOAP Response
508
QOS Profile Provision SOAP Request
510
QOS Profile Provision SOAP Response
512
UNI Service Provision SOAP Request
514
UNI Service Provision SOAP Response
516
ENNI Service Provision SOAP Request
518
ENNI Service Provision SOAP Response
520
modify – CE Services
521
CE Service EPL Modify SOAP Request
521
CE Service EPL Modify SOAP Response
523
CE Service EP-LAN Modify (Add Site) SOAP Request
525
CE Service EP-LAN Modify (Add Site) SOAP Response
527
CE Service EP-LAN Modify (Remove Site) SOAP Request
530
CE Service EP-LAN Modify (Remove Site) SOAP Response
531
UNI Service Modify SOAP Request
534
UNI Service Modify SOAP Response
536
ENNI Service Modify SOAP Request
537
ENNI Service Modify SOAP Response
539
modify – DWDM / OTN Services
541
DWDM Service Modify SOAP Request
541
DWDM Service Modify SOAP Response
544
OTN Service Modify SOAP Request
546
OTN Service Modify SOAP Response
548
Provision – OPU over ODU Services
550
OPU over ODU Service Provision SOAP Request
550
OPU over ODU Service Provision SOAP Response
552
Modify – OPU over ODU Services
555
OPU over ODU Service Modify SOAP Request
555
OPU over ODU Service Modify SOAP Response
557
Terminate – OPU over ODU Services
559
OPU over ODU Service Terminate SOAP Request
559
retrieveServiceStates – CE Services
560
CE Service Retrieve Service States SOAP Request
560
CE Service Retrieve Service States SOAP Response
560
retrieveServiceStates – DWDM / OTN Services
562
DWDM/OTN Services SOAP Request
562
DWDM/OTN Services SOAP Response
562
terminate – DWDM/OTN Services
564
DWDM/OTN Service SOAP Request
564
DWDM/OTN Service SOAP Response
565
terminate – CE Services
566
CE Service Terminate SOAP Request
566
CE Service Terminate SOAP Response
567
Terminate QOS Profile SOAP Request
569
Terminate QOS Profile SOAP Response
570
Terminate UNI / ENNI Service SOAP Request
572
Terminate UNI / ENNI Service SOAP Response
574
Alarm Retrieval
576
getActiveAlarms
576
SOAP Request
576
SOAP Response
576
getActiveAlarmsCount
578
SOAP Request
578
SOAP Response
578
ConnectionControl
579
switchRoute
579
SOAP Request
579
SOAP Response
581
setIntendedRoute
583
SOAP Request
583
SOAP Response
583
TerminationPointControl
585
setTerminationPointData
585
SOAP Request Regular
585
SOAP Response Regular
587
SOAP Request SAPI DAPI
589
SOAP Response SAPI DAPI
591
SOAP Request ODU Controller
594
SOAP Response ODU Controller
595
SOAP Request Breakout Lane Creation
598
SOAP Response Breakout Lane Creation
599
SOAP Request Breakout Lane Deletion
602
SOAP Response Breakout Lane Deletion
604
SOAP Request Breakout Lane Updation
607
SOAP Response Breakout Lane Updation
608
CiscoConfigActivationControl
612
create
612
SOAP Request
612
SOAP Response
613
modify
613
SOAP Request
613
SOAP Response
615
delete
616
SOAP Request
616
SOAP Response
616
Notification
617
Subscribe Request
617
Subscribe Response
617
UnSubscribe Request
618
UnSubscribe Response
618
Notification Samples
619
Equipment Add
619
ManagedElement Delete
621
Equipment Update
623
SubNetworkConnection - Attribute Value Change
625
Service Provisioning – CFS Created
628
Service Provisioning – CFS Service State Change
630
Service Provisioning – CFS Terminate
633
FDN Value Change Notification
635
Alarm Handling
638
acknowledgeAlarms
638
SOAP Request
638
SOAP Response
639
unacknowledgeAlarms
639
SOAP Request
639
SOAP Response
640
10 References
642

Developer's Guide

Size:

9.3 MB
Pages:

642
Language:

English

Developer's Guide

Table of Contents

Preface
18
Conventions
18
Additional User Documentation
18
Obtaining Documentation, Obtaining Support, and Security Guidelines
18
Northbound MTOSI Interface
19
Web Services Standards
19
MTOSI Standards
19
Communication Patterns
19
Iterator Pattern
19
MTOSI Object Naming and Configuration
20
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
Supported MTOSI Interfaces
26
MTOSI Interface Endpoints
27
Authentication
29
Authorization
29
License
29
MTOSI Interface Details
30
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
ManagedElementNameRetrieval
33
4.2.1.1 getAllManagedElementNames
33
4.2.1.1.1 Input
33
4.2.1.1.2 Output
33
4.2.1.1.3 Exceptions
33
4.2.1.2 getManagedElementNamesIterator
33
4.2.1.2.1 Input
33
4.2.1.2.2 Output
34
4.2.1.2.3 Exceptions
34
EquipmentInventoryRetrieval
34
4.3.1 Equipment Data
34
4.3.2 Operations
36
4.3.2.1 getEquipment
36
4.3.2.1.1 Input
36
4.3.2.1.2 Output
36
4.3.2.1.3 Exceptions
36
4.3.2.2 getAllEquipment
36
4.3.2.2.1 Input
36
4.3.2.2.2 Output
36
4.3.2.2.3 Exceptions
36
4.3.2.3 getEquipmentIterator
36
4.3.2.3.1 Input
37
4.3.2.3.2 Output
37
4.3.2.3.3 Exceptions
37
4.3.2.4 getContainedEquipment
37
4.3.2.4.1 Input
37
4.3.2.4.2 Output
37
4.3.2.4.3 Exceptions
37
TerminationPointRetrieval
37
4.4.1 Termination Point Data
37
4.4.2 Operations
41
4.4.2.1 getAllPhysicalTerminationPoints
41
4.4.2.1.1 Input
41
4.4.2.1.2 Output
41
4.4.2.1.3 Exceptions
41
4.4.2.2 getTerminationPointsIterator
41
4.4.2.2.1 Input
41
4.4.2.2.2 Output
41
4.4.2.2.3 Exceptions
41
4.4.2.3 getTerminationPoint
42
4.4.2.3.1 Input
42
4.4.2.3.2 Output
42
4.4.2.3.3 Exceptions
42
4.4.2.4 getAllFloatingTerminationPoints
42
4.4.2.4.1 Input
42
4.4.2.4.2 Output
42
4.4.2.4.3 Exceptions
42
4.4.2.5 getAllSupportedPhysicalTerminationPoints
42
4.4.2.5.1 Input
42
4.4.2.5.2 Output
43
4.4.2.5.3 Exceptions
43
4.4.2.6 getContainedInUseConnectionTerminationPoints
43
4.4.2.6.1 Input
43
4.4.2.6.2 Output
43
4.4.2.6.3 Exceptions
43
4.4.2.7 getContainedPotentialConnectionTerminationPoints
43
4.4.2.7.1 Input
43
4.4.2.7.2 Output
44
4.4.2.7.3 Exceptions
44
ConnectionRetrieval (Optical Domain)
44
4.5.1.1 getAllsubnetworkConnection
44
4.5.1.1.1 Input
44
4.5.1.1.2 Output
44
4.5.1.1.3 Exceptions
46
4.5.1.2 getSubnetworkConnection
46
4.5.1.2.1 Input
46
4.5.1.2.2 Output
46
4.5.1.2.3 Exceptions
48
4.5.1.3 getSubnetworkConnectionsIterator
48
4.5.1.3.1 Input
48
4.5.1.3.2 Output
48
4.5.1.3.3 Exceptions
50
4.5.1.4 getRoute
50
4.5.1.4.1 Input
50
4.5.1.4.2 Output
50
4.5.1.4.3 Exceptions
50
4.5.1.5 getAllCrossConnections
50
4.5.1.5.1 Input
50
4.5.1.5.2 Output
51
4.5.1.5.3 Exceptions
51
4.5.1.6 getAllSubnetworkConnectionsWithTP
51
4.5.1.6.1 Input
51
4.5.1.6.2 Output
51
4.5.1.6.3 Exceptions
51
TopologicalLinkRetrieval
52
4.6.1.1 getAllTopologicalLinks
52
4.6.1.1.1 Input
52
4.6.1.1.2 Output
52
4.6.1.1.3 Exceptions
52
4.6.1.2 getTopologicalLink
52
4.6.1.2.1 Input
52
4.6.1.2.2 Output
53
4.6.1.2.3 Exceptions
53
4.6.1.3 getTopologicalLinksIterator
53
4.6.1.3.1 Input
53
4.6.1.3.2 Output
53
4.6.1.3.3 Exceptions
54
4.6.1.4 getRouteAndTopologicalLinks
54
4.6.1.4.1 Input
54
4.6.1.4.2 Output
54
4.6.1.4.3 Exceptions
55
FlowDomainRetrieval (Carrier Ethernet Inventory)
55
4.7.1 Flow Domain Fragment Data
55
4.7.2 Operations
57
4.7.2.1 getAllFlowDomainFragments
57
4.7.2.1.1 Input
57
4.7.2.1.2 Output
57
4.7.2.1.3 Exceptions
57
4.7.2.2 getFlowDomainFragmentIterator
57
4.7.2.2.1 Input
57
4.7.2.2.2 Output
58
4.7.2.2.3 Exceptions
58
4.7.2.3 getFlowDomainFragment
58
4.7.2.3.1 Input
58
4.7.2.3.2 Output
58
4.7.2.3.3 Exceptions
58
4.7.2.4 getFlowDomainFragmentRoute
58
4.7.2.4.1 Input
58
4.7.2.4.2 Output
58
4.7.2.4.3 Exceptions
59
FlowDomainFragmentNameRetrieval (Carrier Ethernet Inventory)
60
4.8.1 Operations
60
4.8.1.1 getAllFlowDomainFragmentNames
60
4.8.1.1.1 Input
60
4.8.1.1.2 Output
60
4.8.1.1.3 Exceptions
60
4.8.1.2 getFlowDomainFragmentNamesIterator
60
4.8.1.2.1 Input
60
4.8.1.2.2 Output
60
4.8.1.2.3 Exceptions
61
ServiceInventoryRetrieval
61
4.9.1 Customer Facing Service (CFS) Data
61
4.9.2 Service Access Point (SAP) Data
68
4.9.3 Operations
70
4.9.3.1 getServiceInventory
70
4.9.3.1.1 Input
71
4.9.3.1.2 Output
71
4.9.3.1.3 Exceptions
72
4.9.3.2 getServiceInventoryIterator
72
4.9.3.2.1 Input
72
4.9.3.2.2 Output
72
4.9.3.2.3 Exceptions
72
NetworkInterfaceRetrieval
72
4.10.1 Network Interface Data
72
4.10.2 Operations
73
4.10.2.1 getNetworkInterface
73
4.10.2.1.1 Input
73
4.10.2.1.2 Output
73
4.10.2.2 getAllNetworkInterfaces
73
4.10.2.2.1 Input
73
4.10.2.2.2 Output
73
4.10.2.3 getNetworkInterfacesIterator
74
Input
74
Output
74
CustomerNameRetrieval
74
4.11.1.1 getAllCustomerNames
74
4.11.1.1.1 Input
75
4.11.1.1.2 Output
75
4.11.1.2 getCustomerNamesIterator
75
4.11.1.2.1 Input
75
4.11.1.2.2 Output
75
4.11.1.2.3 Exceptions
75
QosProfileNameRetrieval
76
4.12.1.1 getAllQosProfileNames
76
4.12.1.1.1 Input
76
4.12.1.1.2 Output
76
4.12.1.1.3 Exceptions
76
4.12.1.2 getQosProfileNamesIterator
76
4.12.1.2.1 Input
76
4.12.1.2.2 Output
76
4.12.1.2.3 Exceptions
77
OpticalLinkInterfaceRetrieval
77
4.13.1 getAllOpticalLinkInterfaces
77
4.13.1.1.1 Input
77
4.13.1.1.2 Output
77
4.13.1.1.3 Exceptions
77
4.13.2 getOpticalLinkInterfacesIterator
78
4.13.2.1.1 Input
78
4.13.2.1.2 Output
78
4.13.2.1.3 Exceptions
78
ServiceActivationInterface
78
4.14.1 Supported Services for Provisioning
78
4.14.2 Error Message Format with Error Codes
79
4.14.2.1 Deploy Result Error or Info message
79
4.14.2.2 List of error or info codes
80
4.14.3 Service Order Data
80
4.14.3.1 Optical Service Order Data
81
4.14.3.1.1 OTN Service Order Data
81
4.14.3.1.2 OTN Path Options
82
4.14.3.1.3 TRAIL UNI – UNI Config Parameters
83
4.14.3.1.4 TRAIL UNI – UNI Explicit Path
83
4.14.3.1.5 OCH Trail Uni Diversity
84
4.14.3.1.6 DMDM Service Order Data
84
4.14.3.1.7 DMDM Service Constraints
86
4.14.3.1.8 DMDM Channel to Frequency Mapping Grid
87
4.14.3.2 Carrier Ethernet Service Order Data
88
4.14.3.2.1 QinQ Configuration in Order data
96
4.14.3.2.2 Multi-UNI Configuration in Order data
97
4.14.3.3 Carrier Ethernet Endpoint Service Order Data
97
4.14.3.3.1 Carrier Ethernet UNI Endpoint Service Order Data
98
4.14.3.3.2 Carrier Ethernet ENNI Endpoint Service Order Data
99
4.14.3.4 Carrier Ethernet QoS Profile Service Order Data
100
4.14.4 Operations
101
4.14.4.1 Provision
101
4.14.4.1.1 Optical Services
101
4.14.4.1.2 Carrier Ethernet Services
102
4.14.4.1.3 Service Input Data
102
4.14.4.1.4 Input
102
4.14.4.1.5 Provision Response
102
4.14.4.1.6 Output
102
4.14.4.1.7 Exceptions
103
4.14.4.2 modify
103
4.14.4.2.1 Input
103
4.14.4.2.2 Modify Response
103
4.14.4.2.3 Output
103
4.14.4.2.4 Exceptions
104
4.14.4.3 Terminate
104
4.14.4.3.1 Input
104
4.14.4.3.2 Terminate Response
105
4.14.4.3.3 Output
105
4.14.4.3.4 Exceptions
105
4.14.4.4 activate
105
4.14.4.4.1 Input
105
4.14.4.4.2 Activate Response
106
4.14.4.4.3 Output
106
4.14.4.4.4 Exceptions
106
4.14.4.5 deActivate
106
4.14.4.5.1 Input
106
4.14.4.5.2 Activate Response
107
4.14.4.5.3 Output
107
4.14.4.5.4 Exceptions
107
4.14.4.6 retrieveServiceStates
107
4.14.4.6.1 Input
107
4.14.4.6.2 Output
107
4.14.4.6.3 Exceptions
108
Alarm Retrieval
108
4.15.1 Operations
108
4.15.1.1 getActiveAlarms
108
4.15.1.1.1 Input
108
4.15.1.1.2 Output
109
4.15.1.1.3 Exceptions:
110
4.15.1.2 getActiveAlarmsCount
110
4.15.1.2.1 Input
110
4.15.1.2.2 Output
111
4.15.1.2.3 Exceptions:
111
4.15.1.3 getActiveAlarmsIterator
111
4.15.1.3.1 Input
111
4.15.1.3.2 Output
111
4.15.1.3.3 Exceptions:
111
TerminationPointControl
111
4.16.1 Operations
111
4.16.1.1 setTerminationPointData
111
4.16.1.1.1 Input
112
4.16.1.1.2 Supported Parameter Name and Value Table
112
NOTE:
115
4.16.1.1.3 Output
115
4.16.1.1.4 Exceptions:
116
ConnectionControl
116
4.17.1 Operations
116
4.17.1.1 switchRoute
116
4.17.1.1.1 Output
116
4.17.1.1.2 Exceptions:
116
4.17.1.2 setIntendedRoute
117
4.17.1.2.1 Output
117
4.17.1.2.2 Exceptions:
117
ProtectionProfileControl
118
4.18.1 ProtectionProfileDataType
118
4.18.2 Operations
118
4.18.2.1 CreateProtectionProfile
118
4.18.2.1.1 Input
118
4.18.2.1.2 Output
118
4.18.2.1.3 Exceptions:
119
4.18.2.2 ModifyProtectionProfile
119
4.18.2.2.1 Input
119
4.18.2.2.2 Output
119
4.18.2.2.3 Exceptions:
119
4.18.2.3 DeleteProtectionProfile
119
4.18.2.3.1 Input
119
4.18.2.3.2 Output
120
4.18.2.3.3 Exceptions
120
ProtectionProfileRetrieval
120
4.19.1.1 getAllProtectionProfiles
120
4.19.1.1.1 Input
120
4.19.1.1.2 Output
120
4.19.1.1.3 Exceptions
121
4.19.1.2 getProtectionProfile
121
4.19.1.2.1 Input
121
4.19.1.2.2 Output
121
4.19.1.2.3 Exceptions
121
4.19.1.3 getAllSubnetworkConnectionsWithProtectionProfile
121
4.19.1.3.1 Input
121
4.19.1.3.2 Output
122
4.19.1.3.3 Exceptions
122
MPLSTEExplicitPathControl
122
4.20.1 MPLSTEExplicitPathDataType
122
4.20.2 Operations
123
4.20.2.1 CreateMPLSTEExplicitPath
123
4.20.2.1.1 Input
123
4.20.2.1.2 Output
123
4.20.2.1.3 Exceptions:
123
4.20.2.2 ModifyMPLSTEExplicitPath
123
4.20.2.2.1 Input
123
4.20.2.2.2 Output
123
4.20.2.2.3 Exceptions:
124
4.20.2.3 DeleteMPLSTEExplicitPath
124
4.20.2.3.1 Input
124
4.20.2.3.2 Output
124
4.20.2.3.3 Exceptions
124
MPLSTEExplicitPathRetrieval
124
4.21.1.1 getAllMPLSTEExplicitPaths
124
4.21.1.1.1 Input
124
4.21.1.1.2 Output
125
4.21.1.1.3 Exceptions
125
4.21.1.2 getMPLSTEExplicitpath
125
4.21.1.2.1 Input
125
4.21.1.2.2 Output
125
4.21.1.2.3 Exceptions
125
4.21.1.3 getAllSubnetworkConnectionsWithExplicitPath
125
4.21.1.3.1 Input
126
4.21.1.3.2 Output
126
4.21.1.3.3 Exceptions
126
CiscoConfigActivationControl
126
4.22.1 Operations
126
4.22.1.1 create
126
4.22.1.1.1 Input
126
4.22.1.1.2 Output
126
4.22.1.1.3 Exceptions:
126
4.22.1.2 modify
127
4.22.1.2.1 Input
127
4.22.1.2.2 Output
127
4.22.1.2.3 Exceptions:
127
4.22.1.3 delete
127
4.22.1.3.1 Input
127
4.22.1.3.2 Output
127
4.22.1.3.3 Exceptions:
128
Notifications
129
4.23.1 Notification Support Matrix
129
4.23.1.1 Service Provisioning Notifications Matrix
129
4.23.2 Notification Subscribe Interface
129
4.23.2.1.1 Input
129
Alarm Handling
130
4.24.1 Operations
130
4.24.1.1 acknolwledgeAlarms
130
4.24.1.1.1 Input
130
4.24.1.1.2 Output
130
4.24.1.1.3 Exceptions
130
4.24.1.2 unacknolwledgeAlarms
130
4.24.1.2.1 Input
130
4.24.1.2.2 Output
131
4.24.1.2.3 Exceptions
131
Cisco-Specific Interfaces
132
Troubleshooting
133
Appendix I – WSDL Document References
134
MTOSI WSDL Documents
134
Appendix II – Example Java Client to Retrieve Inventory
135
Appendix III – Sample SOAP Request Response
137
getAllManagedElements
137
SOAP Request
137
SOAP Response
137
getAllManagedElementsIterator
142
SOAP Request
142
SOAP Response
143
getManagedElement
146
SOAP Request
146
SOAP Response
146
getAllEquipment
148
SOAP Request
148
SOAP Response
149
getEquipment
156
SOAP Request
156
SOAP Response
156
getContainedEquipment
158
SOAP Request
158
SOAP Response
159
getEquipmentIterator
164
SOAP Request
164
SOAP Response
164
getAllCrossConnections
167
SOAP Request
167
SOAP Response
167
getAllSubnetworkConnectionsWithTP
171
SOAP Request
171
SOAP Response
171
getAllPhysicalTerminationPoints
175
SOAP Request
175
SOAP Response
176
getTerminationPointsIterator
183
SOAP Request
183
SOAP Response
183
getAllFloatingTerminationPoints
196
SOAP Request
196
SOAP Response
197
getTerminationPoint
212
SOAP Request
212
SOAP Response
212
getAllSupportedPhysicalTerminationPoints
214
SOAP Request
214
SOAP Response
215
getContainedPotentialConnectionTerminationPoints
220
SOAP Request
220
SOAP Response
221
getContainedInUseConnectionTerminationPoints
224
SOAP Request
224
SOAP Response
224
getAllSubnetworkConnections
226
SOAP Request
226
SOAP Response
227
getSubnetworkConnection
230
SOAP Request
230
SOAP Response
231
SOAP Response – SNC with Diverse From Circuit Reference
233
getSubnetworkConnectionsIterator
236
SOAP Request
236
SOAP Response
236
getRoute
239
SOAP Request
239
SOAP Response
239
getAllTopologicalLinks
244
SOAP Request
244
SOAP Response
244
getTopologicalLink
254
SOAP Request
254
SOAP Response
254
getTopologicalLinksIterator
257
SOAP Request
257
SOAP Response
257
getRouteAndTopologicalLinks
265
SOAP Request
265
SOAP Response - OCHTrail
266
SOAP Response – ODU-UNI
281
SOAP Response – OCHNC
285
getAllFlowDomainFragments
290
SOAP Request
290
SOAP Response
290
getFlowDomainFragment
318
SOAP Request
318
SOAP Response
319
getFlowDomainFragmentRoute
323
SOAP Request
323
SOAP Response
323
getFlowDomainFragmentsIterator
328
SOAP Request
328
SOAP Response
328
getAllFlowDomainFragmentNames
344
SOAP Request
344
SOAP Response
345
getFlowDomainFragmentNamesIterator
356
SOAP Request
356
SOAP Response
357
getAllOpticalLinkInterfaces
361
SOAP Request
361
SOAP Response
362
getAllNetworkInterfaces
363
SOAP Request
363
SOAP Response
363
getNetworkInterface
365
SOAP Request
365
SOAP Response
365
getAllCustomerNames
367
SOAP Request
367
SOAP Response
367
getAllQosProfileNames
368
SOAP Request
368
SOAP Response
369
getProtectionProfile
370
SOAP Request
370
SOAP Response
370
getAllProtectionProfiles
372
SOAP Request
372
SOAP Response
372
createProtectionProfile
376
SOAP Request
376
SOAP Response
377
modifyProtectionProfile
378
SOAP Request
378
SOAP Response
379
deleteProtectionProfile
381
SOAP Request
381
SOAP Response
381
getMPLSTEExplicitPath
383
SOAP Request
383
SOAP Response
383
getAllMPLSTEExplicitPaths
386
SOAP Request
386
SOAP Response
386
createMPLSTEExplicitPath
399
SOAP Request
399
SOAP Response
400
modifyMPLSTEExplicitPath
402
SOAP Request
402
SOAP Response
403
deleteMPLSTEExplicitPath
404
SOAP Request
404
SOAP Response
405
getServiceInventory for CFS Data
407
CE Service SOAP Request
407
CE Service SOAP Response
408
DWDM/OTN Service SOAP Request
412
DWDM/OTN Service SOAP Response
413
getServiceInventory for SAP Data
417
CE Service SOAP Request
417
CE Service SOAP Response
418
CE Service SAP SOAP Response for QinQ
420
DWDM/OTN Service SOAP Resquest
422
DWDM/OTN Service SOAP Response
423
provision - DWDM services
427
DWDM Services SOAP Request
427
DWDM Services SOAP Response
431
provision – OTN services
433
OTN Services SOAP Request
433
OTN Services SOAP Response
436
provision –TRAIL-UNI services
438
TRAIL-UNI Services SOAP Request
438
TRAIL-UNI Services SOAP Response
440
TRAIL-UNI Services with Diversity SOAP Request
443
TRAIL-UNI Services with Diversity SOAP Response
446
TRAIL-UNI Services with Explicit Path SOAP Request
449
TRAIL-UNI Services with Explicit Path SOAP Response
452
provision – Carrier Ethernet Services
455
EPL Provision SOAP Request
455
EPL Provision SOAP Response
457
EVPL Provision SOAP Request
460
EVPL Provision SOAP Response
463
EVPL Provision with QinQ Configuration - SOAP Request
465
EVPL Provision with QinQ Configuration - SOAP Response
469
Access EPL Provision SOAP Request
472
Access EPL Provision SOAP Response
476
Access EVPL Provision SOAP Request
478
Access EVPL Provision SOAP Response
480
Access EVPL Provision with QinQ Configuration - SOAP Request
483
Access EVPL Provision with QinQ Configuration - SOAP Response
487
EP-LAN Provision SOAP Request
490
EP-LAN Provision SOAP Response
492
EVP-LAN Provision SOAP Request
494
EVP-LAN Provision SOAP Response
496
EVP-LAN Provision with Multi-UNI Configuration - SOAP Request
498
EVP-LAN Provision with Multi-UNI Configuration - SOAP Response
501
EP-Tree Provision SOAP Request
505
EP-Tree Provision SOAP Response
507
EVP-Tree Provision SOAP Request
509
EVP-Tree Provision SOAP Response
511
QOS Profile Provision SOAP Request
513
QOS Profile Provision SOAP Response
515
UNI Service Provision SOAP Request
517
UNI Service Provision SOAP Response
519
ENNI Service Provision SOAP Request
521
ENNI Service Provision SOAP Response
523
modify – CE Services
524
CE Service EPL Modify SOAP Request
524
CE Service EPL Modify SOAP Response
526
CE Service EP-LAN Modify (Add Site) SOAP Request
528
CE Service EP-LAN Modify (Add Site) SOAP Response
530
CE Service EP-LAN Modify (Remove Site) SOAP Request
533
CE Service EP-LAN Modify (Remove Site) SOAP Response
534
UNI Service Modify SOAP Request
537
UNI Service Modify SOAP Response
539
ENNI Service Modify SOAP Request
540
ENNI Service Modify SOAP Response
542
modify – DWDM Services
544
DWDM Service Modify SOAP Request
544
DWDM Service Modify SOAP Response
547
OTN Service Modify SOAP Request
549
OTN Service Modify SOAP Response
551
retrieveServiceStates – CE Services
553
CE Service Retrieve Service States SOAP Request
553
CE Service Retrieve Service States SOAP Response
554
retrieveServiceStates – DWDM / OTN Services
555
DWDM/OTN Services SOAP Request
556
DWDM/OTN Services SOAP Response
556
terminate – DWDM/OTN Services
558
DWDM/OTN Service SOAP Request
558
DWDM/OTN Service SOAP Response
559
terminate – CE Services
560
CE Service Terminate SOAP Request
560
CE Service Terminate SOAP Response
561
Terminate QOS Profile SOAP Request
563
Terminate QOS Profile SOAP Response
564
Terminate UNI / ENNI Service SOAP Request
567
Terminate UNI / ENNI Service SOAP Response
568
Alarm Retrieval
570
9.58.1 getActiveAlarms
570
9.58.1.1 SOAP Request
570
9.58.1.2 SOAP Response
570
9.58.2 getActiveAlarmsCount
572
9.58.2.1 SOAP Request
572
9.58.2.2 SOAP Response
572
ConnectionControl
573
9.59.1 switchRoute
573
9.59.1.1 SOAP Request
573
9.59.1.2 SOAP Response
575
9.59.2 setIntendedRoute
577
9.59.2.1 SOAP Request
577
9.59.2.2 SOAP Response
578
TerminationPointControl
580
9.60.1 setTerminationPointData
580
9.60.1.1 SOAP Request Regular
580
9.60.1.2 SOAP Response Regular
581
9.60.1.3 SOAP Request SAPI DAPI
584
9.60.1.4 SOAP Response SAPI DAPI
586
9.60.1.5 SOAP Request ODU Controller
588
9.60.1.6 SOAP Response ODU Controller
590
9.60.1.7 SOAP Request Breakout Lane Creation
593
9.60.1.8 SOAP Response Breakout Lane Creation
594
9.60.1.9 SOAP Request Breakout Lane Deletion
597
9.60.1.10 SOAP Response Breakout Lane Deletion
599
9.60.1.11 SOAP Request Breakout Lane Updation
602
9.60.1.12 SOAP Response Breakout Lane Updation
603
CiscoConfigActivationControl
606
9.61.1 create
606
9.61.1.1 SOAP Request
606
9.61.1.2 SOAP Response
608
9.61.2 modify
608
9.61.2.1 SOAP Request
608
9.61.2.2 SOAP Response
610
9.61.3 delete
611
9.61.3.1 SOAP Request
611
9.61.3.2 SOAP Response
611
Notification
612
Subscribe Request
612
Subscribe Response
612
UnSubscribe Request
613
UnSubscribe Response
613
Notification Samples
614
Equipment Add
614
ManagedElement Delete
616
Equipment Update
618
SubNetworkConnection - Attribute Value Change
620
Service Provisioning – CFS Created
623
Service Provisioning – CFS Service State Change
626
Service Provisioning – CFS Terminate
628
FDN Value Change Notification
630
Alarm Handling
634
9.64.1 acknowledgeAlarms
634
9.64.1.1 SOAP Request
634
9.64.1.2 SOAP Response
634
9.64.2 unacknowledgeAlarms
635
9.64.2.1 SOAP Request
635
9.64.2.2 SOAP Response
636
References
637

Developer's Guide

Size:

8.3 MB
Pages:

637
Language:

English

Release Notes

Size:

191 KB
Pages:

14
Language:

English

User Guide

Size:

278 KB
Pages:

2
Language:

English

Licensing Information

Licensing Information

Size:

11.2 MB
Pages:

6264
Language:

English

Release Notes

Size:

300 KB
Pages:

14
Language:

English

Documentation Roadmaps

Documentation Roadmaps

Size:

179 KB
Pages:

8
Language:

English

Release Notes

Size:

249 KB
Pages:

12
Language:

English