Cisco Cisco Evolved Programmable Network Manager 1.2 User Manuals

Cisco

Installation Guide (English)Release Notes (English)Release Notes (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)Developer's Guide (English)Release Notes (English)Licensing Information (English)Release Notes (English)Documentation Roadmaps (English)Release Notes (English)Release Notes (English)

Installation Guide

Table of Contents

Installation Guide

Size:

543 KB
Pages:

24
Language:

English

Developer's Guide

Table of Contents

Developer's Guide

Size:

4.91 MB
Pages:

365
Language:

English

Developer's Guide

Table of Contents

Developer's Guide

Size:

4.93 MB
Pages:

360
Language:

English

Developer's Guide

Table of Contents

Preface
16
Conventions
16
Additional User Documentation
16
Obtaining Documentation, Obtaining Support, and Security Guidelines
16
Northbound MTOSI Interface
18
Web Services Standards
18
MTOSI Standards
18
Communication Patterns
18
Iterator Pattern
18
MTOSI Object Naming and Configuration
19
OSS Integration Usage Scenarios
20
Retrieving Device Inventory Flow
20
Inventory Notification Registration and Processing Flow
21
Service Provisioning Flow
22
Service Provisioning Flow for Carrier Ethernet
22
Service Provisioning Flow for Optical (OTN) Services
22
Service Provisioning Flow for Optical (DWDM) Services
23
Supported MTOSI Interfaces
25
MTOSI Interface Endpoints
26
Authentication
27
Authorization
27
License
28
MTOSI Interface Details
29
ManagedElementRetrieval
29
Managed Element Data
29
Operations
31
getAllManagedElements
31
4.1.2.1.1 Input
31
4.1.2.1.2 Output
31
4.1.2.1.3 Exceptions
31
getAllManagedElementsIterator
31
4.1.2.2.1 Input
31
4.1.2.2.2 Output
31
4.1.2.2.3 Exceptions
32
getManagedElement
32
4.1.2.3.1 Input
32
4.1.2.3.2 Output
32
4.1.2.3.3 Exceptions
32
ManagedElementNameRetrieval
32
getAllManagedElementNames
32
4.2.1.1.1 Input
32
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
33
4.2.1.2.3 Exceptions
33
EquipmentInventoryRetrieval
33
Equipment Data
34
Operations
35
getEquipment
35
4.3.2.1.1 Input
35
4.3.2.1.2 Output
35
4.3.2.1.3 Exceptions
35
getAllEquipment
35
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
36
4.3.2.3.2 Output
36
4.3.2.3.3 Exceptions
36
getContainedEquipment
36
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
40
getAllPhysicalTerminationPoints
40
4.4.2.1.1 Input
40
4.4.2.1.2 Output
40
4.4.2.1.3 Exceptions
40
getTerminationPointsIterator
40
4.4.2.2.1 Input
40
4.4.2.2.2 Output
40
4.4.2.2.3 Exceptions
41
getTerminationPoint
41
4.4.2.3.1 Input
41
4.4.2.3.2 Output
41
4.4.2.3.3 Exceptions
41
getAllFloatingTerminationPoints
41
4.4.2.4.1 Input
41
4.4.2.4.2 Output
41
4.4.2.4.3 Exceptions
41
getAllSupportedPhysicalTerminationPoints
42
4.4.2.5.1 Input
42
4.4.2.5.2 Output
42
4.4.2.5.3 Exceptions
42
getContainedInUseConnectionTerminationPoints
42
4.4.2.6.1 Input
42
4.4.2.6.2 Output
42
4.4.2.6.3 Exceptions
42
getContainedPotentialConnectionTerminationPoints
42
4.4.2.7.1 Input
43
4.4.2.7.2 Output
43
4.4.2.7.3 Exceptions
43
ConnectionRetrieval (Optical Domain)
43
getAllsubnetworkConnection
43
4.5.1.1.1 Input
43
4.5.1.1.2 Output
43
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
CustomerNameRetrieval
72
getAllCustomerNames
72
4.10.1.1.1 Input
72
4.10.1.1.2 Output
72
getCustomerNamesIterator
73
4.10.1.2.1 Input
73
4.10.1.2.2 Output
73
4.10.1.2.3 Exceptions
73
QosProfileNameRetrieval
73
getAllQosProfileNames
73
4.11.1.1.1 Input
73
4.11.1.1.2 Output
73
4.11.1.1.3 Exceptions
74
getQosProfileNamesIterator
74
4.11.1.2.1 Input
74
4.11.1.2.2 Output
74
4.11.1.2.3 Exceptions
74
OpticalLinkInterfaceRetrieval
74
getAllOpticalLinkInterfaces
74
4.12.1.1.1 Input
75
4.12.1.1.2 Output
75
4.12.1.1.3 Exceptions
75
getOpticalLinkInterfacesIterator
75
4.12.2.1.1 Input
75
4.12.2.1.2 Output
75
4.12.2.1.3 Exceptions
76
ServiceActivationInterface
76
Supported Services for Provisioning
76
Service Order Data
76
Optical Service Order Data
77
4.13.2.1.1 OTN Service Order Data
77
4.13.2.1.2 OTN Path Options
78
4.13.2.1.3 TRAIL UNI – UNI Config Parameters
79
4.13.2.1.4 TRAIL UNI – UNI Explicit Path
79
4.13.2.1.5 DMDM Service Order Data
80
4.13.2.1.6 DMDM Service Constraints
82
4.13.2.1.7 DMDM Channel to Frequency Mapping Grid
83
Carrier Ethernet Service Order Data
84
4.13.2.2.1 QinQ Configuration in Order data
93
4.13.2.2.2 Multi-UNI Configuration in Order data
93
Carrier Ethernet Endpoint Service Order Data
94
4.13.2.3.1 Carrier Ethernet UNI Endpoint Service Order Data
94
4.13.2.3.2 Carrier Ethernet ENNI Endpoint Service Order Data
96
Carrier Ethernet QoS Profile Service Order Data
97
Operations
98
Provision
98
4.13.3.1.1 Optical Services
98
4.13.3.1.2 Carrier Ethernet Services
99
4.13.3.1.3 Service Input Data
99
4.13.3.1.4 Input
99
4.13.3.1.5 Provision Response
99
4.13.3.1.6 Output
99
4.13.3.1.7 Exceptions
100
modify
100
4.13.3.2.1 Input
100
4.13.3.2.2 Modify Response
100
4.13.3.2.3 Output
101
4.13.3.2.4 Exceptions
101
Terminate
101
4.13.3.3.1 Input
101
4.13.3.3.2 Terminate Response
102
4.13.3.3.3 Output
102
4.13.3.3.4 Exceptions
102
activate
102
4.13.3.4.1 Input
102
4.13.3.4.2 Activate Response
103
4.13.3.4.3 Output
103
4.13.3.4.4 Exceptions
103
deActivate
103
4.13.3.5.1 Input
104
4.13.3.5.2 Activate Response
104
4.13.3.5.3 Output
104
4.13.3.5.4 Exceptions
104
retrieveServiceStates
104
4.13.3.6.1 Input
105
4.13.3.6.2 Output
105
4.13.3.6.3 Exceptions
105
Alarm Retrieval
105
Operations
105
getActiveAlarms
105
4.14.1.1.1 Input
105
4.14.1.1.2 Output
106
4.14.1.1.3 Exceptions:
107
getActiveAlarmsCount
107
4.14.1.2.1 Input
107
4.14.1.2.2 Output
108
4.14.1.2.3 Exceptions:
108
getActiveAlarmsIterator
108
4.14.1.3.1 Input
108
4.14.1.3.2 Output
109
4.14.1.3.3 Exceptions:
109
TerminationPointControl
109
Operations
109
setTerminationPointData
109
4.15.1.1.1 Input
109
4.15.1.1.2 Supported Parameter Name and Value Table
109
4.15.1.1.3 Output
111
4.15.1.1.4 Exceptions:
111
ConnectionControl
112
Operations
112
switchRoute
112
4.16.1.1.1 Output
112
4.16.1.1.2 Exceptions:
112
setIntendedRoute
113
4.16.1.2.1 Output
113
4.16.1.2.2 Exceptions:
113
ProtectionProfileControl
114
ProtectionProfileDataType
114
Operations
114
CreateProtectionProfile
114
4.17.2.1.1 Input
114
4.17.2.1.2 Output
114
4.17.2.1.3 Exceptions:
115
ModifyProtectionProfile
115
4.17.2.2.1 Input
115
4.17.2.2.2 Output
115
4.17.2.2.3 Exceptions:
115
DeleteProtectionProfile
115
4.17.2.3.1 Input
116
4.17.2.3.2 Output
116
4.17.2.3.3 Exceptions:
116
ProtectionProfileRetrieval
116
getAllProtectionProfiles
116
4.18.1.1.1 Input
116
4.18.1.1.2 Output
116
4.18.1.1.3 Exceptions
117
getProtectionProfile
117
4.18.1.2.1 Input
117
4.18.1.2.2 Output
117
4.18.1.2.3 Exceptions
118
getAllSubnetworkConnectionsWithProtectionProfile
118
4.18.1.3.1 Input
118
4.18.1.3.2 Output
118
4.18.1.3.3 Exceptions
118
MPLSTEExplicitPathControl
118
MPLSTEExplicitPathDataType
118
Operations
119
CreateMPLSTEExplicitPath
119
4.19.2.1.1 Input
119
4.19.2.1.2 Output
119
4.19.2.1.3 Exceptions:
120
ModifyMPLSTEExplicitPath
120
4.19.2.2.1 Input
120
4.19.2.2.2 Output
120
4.19.2.2.3 Exceptions:
120
DeleteMPLSTEExplicitPath
120
4.19.2.3.1 Input
120
4.19.2.3.2 Output
121
4.19.2.3.3 Exceptions
121
MPLSTEExplicitPathRetrieval
121
getAllMPLSTEExplicitPaths
121
4.20.1.1.1 Input
121
4.20.1.1.2 Output
121
4.20.1.1.3 Exceptions
122
getMPLSTEExplicitpath
122
4.20.1.2.1 Input
122
4.20.1.2.2 Output
122
4.20.1.2.3 Exceptions
122
getAllSubnetworkConnectionsWithExplicitPath
122
4.20.1.3.1 Input
122
4.20.1.3.2 Output
122
4.20.1.3.3 Exceptions
123
Notifications
123
Notification Support Matrix
123
Service Provisioning Notifications Matrix
123
Notification Subscribe Interface
124
4.21.2.1.1 Input
124
Alarm Handling
124
Operations
124
acknolwledgeAlarms
124
4.22.1.1.1 Input
124
4.22.1.1.2 Output
124
4.22.1.1.3 Exceptions
125
unacknolwledgeAlarms
125
4.22.1.2.1 Input
125
4.22.1.2.2 Output
125
4.22.1.2.3 Exceptions
125
Cisco-Specific Interfaces
126
Troubleshooting
127
Appendix I – WSDL Document References
128
MTOSI WSDL Documents
128
Appendix II – Example Java Client to Retrieve Inventory
129
Appendix III – Sample SOAP Request Response
131
getAllManagedElements
131
SOAP Request
131
SOAP Response
131
getAllManagedElementsIterator
136
SOAP Request
136
SOAP Response
137
CgetManagedElement
140
SOAP Request
140
SOAP Response
140
getAllEquipment
142
SOAP Request
142
SOAP Response
143
getEquipment
150
SOAP Request
150
SOAP Response
150
getContainedEquipment
152
SOAP Request
152
SOAP Response
153
getEquipmentIterator
158
SOAP Request
158
SOAP Response
158
getAllCrossConnections
161
SOAP Request
161
SOAP Response
161
getAllSubnetworkConnectionsWithTP
165
SOAP Request
165
SOAP Response
165
getAllPhysicalTerminationPoints
169
SOAP Request
169
SOAP Response
170
getTerminationPointsIterator
177
SOAP Request
177
SOAP Response
177
getAllFloatingTerminationPoints
190
SOAP Request
190
SOAP Response
191
getTerminationPoint
206
SOAP Request
206
SOAP Response
206
getAllSupportedPhysicalTerminationPoints
208
SOAP Request
208
SOAP Response
209
getContainedPotentialConnectionTerminationPoints
214
SOAP Request
214
SOAP Response
215
getContainedInUseConnectionTerminationPoints
218
SOAP Request
218
SOAP Response
218
getAllSubnetworkConnections
220
SOAP Request
220
SOAP Response
221
getSubnetworkConnection
224
SOAP Request
224
SOAP Response
225
getSubnetworkConnectionsIterator
227
SOAP Request
227
SOAP Response
228
getRoute
230
SOAP Request
230
SOAP Response
231
getAllTopologicalLinks
235
SOAP Request
235
SOAP Response
236
getTopologicalLink
245
SOAP Request
245
SOAP Response
246
getTopologicalLinksIterator
248
SOAP Request
248
SOAP Response
249
getRouteAndTopologicalLinks
257
SOAP Request
257
SOAP Response - OCHTrail
258
SOAP Response – ODU-UNI
265
getAllFlowDomainFragments
270
SOAP Request
270
SOAP Response
270
getFlowDomainFragment
298
SOAP Request
298
SOAP Response
299
getFlowDomainFragmentRoute
303
SOAP Request
303
SOAP Response
303
getFlowDomainFragmentsIterator
308
SOAP Request
308
SOAP Response
308
getAllFlowDomainFragmentNames
324
SOAP Request
324
SOAP Response
325
getFlowDomainFragmentNamesIterator
336
SOAP Request
336
SOAP Response
337
getAllOpticalLinkInterfaces
341
SOAP Request
341
SOAP Response
342
getAllCustomerNames
343
SOAP Request
343
SOAP Response
343
getAllQosProfileNames
345
SOAP Request
345
SOAP Response
345
getProtectionProfile
346
SOAP Request
346
SOAP Response
347
getAllProtectionProfiles
348
SOAP Request
348
SOAP Response
348
createProtectionProfile
352
SOAP Request
352
SOAP Response
353
modifyProtectionProfile
354
SOAP Request
354
SOAP Response
356
deleteProtectionProfile
357
SOAP Request
357
SOAP Response
358
getMPLSTEExplicitPath
359
SOAP Request
359
SOAP Response
359
getAllMPLSTEExplicitPaths
362
SOAP Request
362
SOAP Response
362
createMPLSTEExplicitPath
375
SOAP Request
375
SOAP Response
376
modifyMPLSTEExplicitPath
378
SOAP Request
378
SOAP Response
379
deleteMPLSTEExplicitPath
381
SOAP Request
381
SOAP Response
381
getServiceInventory for CFS Data
383
CE Service SOAP Request
383
CE Service SOAP Response
384
DWDM/OTN Service SOAP Request
388
DWDM/OTN Service SOAP Response
389
getServiceInventory for SAP Data
394
CE Service SOAP Request
394
CE Service SOAP Response
394
CE Service SAP SOAP Response for QinQ
396
DWDM/OTN Service SOAP Resquest
398
DWDM/OTN Service SOAP Response
399
provision - DWDM services
403
DWDM Services SOAP Request
403
DWDM Services SOAP Response
407
provision – OTN services
410
OTN Services SOAP Request
410
OTN Services SOAP Response
412
provision –TRAIL-UNI services
414
TRAIL-UNI Services SOAP Request
414
TRAIL-UNI Services SOAP Response
416
provision – Carrier Ethernet Services
419
EPL Provision SOAP Request
419
EPL Provision SOAP Response
421
EVPL Provision SOAP Request
424
EVPL Provision SOAP Response
427
EVPL Provision with QinQ Configuration - SOAP Request
429
EVPL Provision with QinQ Configuration - SOAP Response
433
Access EPL Provision SOAP Request
437
Access EPL Provision SOAP Response
440
Access EVPL Provision SOAP Request
442
Access EVPL Provision SOAP Response
445
Access EVPL Provision with QinQ Configuration - SOAP Request
447
Access EVPL Provision with QinQ Configuration - SOAP Response
451
EP-LAN Provision SOAP Request
454
EP-LAN Provision SOAP Response
456
EVP-LAN Provision SOAP Request
459
EVP-LAN Provision SOAP Response
461
EVP-LAN Provision with Multi-UNI Configuration - SOAP Request
463
EVP-LAN Provision with Multi-UNI Configuration - SOAP Response
466
EP-Tree Provision SOAP Request
469
EP-Tree Provision SOAP Response
472
EVP-Tree Provision SOAP Request
473
EVP-Tree Provision SOAP Response
475
QOS Profile Provision SOAP Request
477
QOS Profile Provision SOAP Response
480
UNI Service Provision SOAP Request
482
UNI Service Provision SOAP Response
484
ENNI Service Provision SOAP Request
485
ENNI Service Provision SOAP Response
487
modify – CE Services
489
CE Service EPL Modify SOAP Request
489
CE Service EPL Modify SOAP Response
490
CE Service EP-LAN Modify (Add Site) SOAP Request
493
CE Service EP-LAN Modify (Add Site) SOAP Response
495
CE Service EP-LAN Modify (Remove Site) SOAP Request
497
CE Service EP-LAN Modify (Remove Site) SOAP Response
499
UNI Service Modify SOAP Request
501
UNI Service Modify SOAP Response
503
ENNI Service Modify SOAP Request
505
ENNI Service Modify SOAP Response
507
modify – DWDM Services
509
DWDM Service Modify SOAP Request
509
DWDM Service Modify SOAP Response
512
OTN Service Modify SOAP Request
513
OTN Service Modify SOAP Response
515
retrieveServiceStates – CE Services
518
CE Service Retrieve Service States SOAP Request
518
CE Service Retrieve Service States SOAP Response
519
retrieveServiceStates – DWDM / OTN Services
520
DWDM/OTN Services SOAP Request
520
DWDM/OTN Services SOAP Response
521
terminate – DWDM/OTN Services
522
DWDM/OTN Service SOAP Request
522
DWDM/OTN Service SOAP Response
523
terminate – CE Services
525
CE Service Terminate SOAP Request
525
CE Service Terminate SOAP Response
526
Terminate QOS Profile SOAP Request
528
Terminate QOS Profile SOAP Response
529
Terminate UNI / ENNI Service SOAP Request
531
Terminate UNI / ENNI Service SOAP Response
532
Alarm Retrieval
534
getActiveAlarms
534
SOAP Request
534
SOAP Response
535
getActiveAlarmsCount
536
SOAP Request
536
SOAP Response
537
ConnectionControl
538
switchRoute
538
SOAP Request
538
SOAP Response
539
setIntendedRoute
541
SOAP Request
541
SOAP Response
542
TerminationPointControl
544
setTerminationPointData
544
SOAP Request
544
SOAP Response
546
Notification
548
Subscribe Request
548
Subscribe Response
549
UnSubscribe Request
549
UnSubscribe Response
550
Notification Samples
550
Equipment Add
550
ManagedElement Delete
553
Equipment Update
555
SubNetworkConnection - Attribute Value Change
557
Service Provisioning – CFS Created
560
Service Provisioning – CFS Service State Change
562
Service Provisioning – CFS Terminate
564
FDN Value Change Notification
567
Alarm Handling
570
acknowledgeAlarms
570
SOAP Request
570
SOAP Response
571
unacknowledgeAlarms
571
SOAP Request
571
SOAP Response
572
10 References
574

Developer's Guide

Size:

7.58 MB
Pages:

574
Language:

English

Developer's Guide

Table of Contents

Preface
17
Conventions
17
Additional User Documentation
17
Obtaining Documentation, Obtaining Support, and Security Guidelines
17
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
28
Authorization
28
License
29
MTOSI Interface Details
30
ManagedElementRetrieval
30
Managed Element Data
30
Operations
32
getAllManagedElements
32
4.1.2.1.1 Input
32
4.1.2.1.2 Output
32
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
33
getManagedElement
33
4.1.2.3.1 Input
33
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
34
getManagedElementNamesIterator
34
4.2.1.2.1 Input
34
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
37
4.3.2.2.3 Exceptions
37
getEquipmentIterator
37
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
38
4.3.2.4.3 Exceptions
38
TerminationPointRetrieval
38
Termination Point Data
38
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
CustomerNameRetrieval
72
4.10.1.1 getAllCustomerNames
72
4.10.1.1.1 Input
72
4.10.1.1.2 Output
72
4.10.1.2 getCustomerNamesIterator
73
4.10.1.2.1 Input
73
4.10.1.2.2 Output
73
4.10.1.2.3 Exceptions
73
QosProfileNameRetrieval
73
4.11.1.1 getAllQosProfileNames
73
4.11.1.1.1 Input
73
4.11.1.1.2 Output
74
4.11.1.1.3 Exceptions
74
4.11.1.2 getQosProfileNamesIterator
74
4.11.1.2.1 Input
74
4.11.1.2.2 Output
74
4.11.1.2.3 Exceptions
74
OpticalLinkInterfaceRetrieval
74
getAllOpticalLinkInterfaces
74
4.12.1.1.1 Input
75
4.12.1.1.2 Output
75
4.12.1.1.3 Exceptions
75
getOpticalLinkInterfacesIterator
75
4.12.2.1.1 Input
75
4.12.2.1.2 Output
75
4.12.2.1.3 Exceptions
76
ServiceActivationInterface
76
Supported Services for Provisioning
76
Service Order Data
76
4.13.2.1 Optical Service Order Data
77
4.13.2.1.1 OTN Service Order Data
77
4.13.2.1.2 OTN Path Options
78
4.13.2.1.3 TRAIL UNI – UNI Config Parameters
79
4.13.2.1.4 TRAIL UNI – UNI Explicit Path
79
4.13.2.1.5 OCH Trail Uni Diversity
80
4.13.2.1.6 DMDM Service Order Data
80
4.13.2.1.7 DMDM Service Constraints
82
4.13.2.1.8 DMDM Channel to Frequency Mapping Grid
83
4.13.2.2 Carrier Ethernet Service Order Data
84
4.13.2.2.1 QinQ Configuration in Order data
92
4.13.2.2.2 Multi-UNI Configuration in Order data
93
4.13.2.3 Carrier Ethernet Endpoint Service Order Data
93
4.13.2.3.1 Carrier Ethernet UNI Endpoint Service Order Data
94
4.13.2.3.2 Carrier Ethernet ENNI Endpoint Service Order Data
95
4.13.2.4 Carrier Ethernet QoS Profile Service Order Data
96
Operations
97
4.13.3.1 Provision
97
4.13.3.1.1 Optical Services
97
4.13.3.1.2 Carrier Ethernet Services
98
4.13.3.1.3 Service Input Data
98
4.13.3.1.4 Input
98
4.13.3.1.5 Provision Response
98
4.13.3.1.6 Output
98
4.13.3.1.7 Exceptions
99
4.13.3.2 modify
99
4.13.3.2.1 Input
99
4.13.3.2.2 Modify Response
99
4.13.3.2.3 Output
99
4.13.3.2.4 Exceptions
100
4.13.3.3 Terminate
100
4.13.3.3.1 Input
100
4.13.3.3.2 Terminate Response
101
4.13.3.3.3 Output
101
4.13.3.3.4 Exceptions
101
4.13.3.4 activate
101
4.13.3.4.1 Input
101
4.13.3.4.2 Activate Response
102
4.13.3.4.3 Output
102
4.13.3.4.4 Exceptions
102
4.13.3.5 deActivate
102
4.13.3.5.1 Input
102
4.13.3.5.2 Activate Response
103
4.13.3.5.3 Output
103
4.13.3.5.4 Exceptions
103
4.13.3.6 retrieveServiceStates
103
4.13.3.6.1 Input
103
4.13.3.6.2 Output
103
4.13.3.6.3 Exceptions
104
Alarm Retrieval
104
Operations
104
4.14.1.1 getActiveAlarms
104
4.14.1.1.1 Input
104
4.14.1.1.2 Output
105
4.14.1.1.3 Exceptions:
106
4.14.1.2 getActiveAlarmsCount
106
4.14.1.2.1 Input
106
4.14.1.2.2 Output
107
4.14.1.2.3 Exceptions:
107
4.14.1.3 getActiveAlarmsIterator
107
4.14.1.3.1 Input
107
4.14.1.3.2 Output
107
4.14.1.3.3 Exceptions:
107
TerminationPointControl
107
Operations
107
4.15.1.1 setTerminationPointData
107
4.15.1.1.1 Input
108
4.15.1.1.2 Supported Parameter Name and Value Table
108
4.15.1.1.3 Output
110
4.15.1.1.4 Exceptions:
110
ConnectionControl
110
Operations
110
4.16.1.1 switchRoute
110
4.16.1.1.1 Output
111
4.16.1.1.2 Exceptions:
111
4.16.1.2 setIntendedRoute
111
4.16.1.2.1 Output
111
4.16.1.2.2 Exceptions:
112
ProtectionProfileControl
112
ProtectionProfileDataType
112
Operations
113
4.17.2.1 CreateProtectionProfile
113
4.17.2.1.1 Input
113
4.17.2.1.2 Output
113
4.17.2.1.3 Exceptions:
113
4.17.2.2 ModifyProtectionProfile
113
4.17.2.2.1 Input
113
4.17.2.2.2 Output
113
4.17.2.2.3 Exceptions:
114
4.17.2.3 DeleteProtectionProfile
114
4.17.2.3.1 Input
114
4.17.2.3.2 Output
114
4.17.2.3.3 Exceptions
114
ProtectionProfileRetrieval
114
4.18.1.1 getAllProtectionProfiles
114
4.18.1.1.1 Input
114
4.18.1.1.2 Output
115
4.18.1.1.3 Exceptions
115
4.18.1.2 getProtectionProfile
115
4.18.1.2.1 Input
115
4.18.1.2.2 Output
115
4.18.1.2.3 Exceptions
116
4.18.1.3 getAllSubnetworkConnectionsWithProtectionProfile
116
4.18.1.3.1 Input
116
4.18.1.3.2 Output
116
4.18.1.3.3 Exceptions
116
MPLSTEExplicitPathControl
116
MPLSTEExplicitPathDataType
116
Operations
117
4.19.2.1 CreateMPLSTEExplicitPath
117
4.19.2.1.1 Input
117
4.19.2.1.2 Output
117
4.19.2.1.3 Exceptions:
117
4.19.2.2 ModifyMPLSTEExplicitPath
118
4.19.2.2.1 Input
118
4.19.2.2.2 Output
118
4.19.2.2.3 Exceptions:
118
4.19.2.3 DeleteMPLSTEExplicitPath
118
4.19.2.3.1 Input
118
4.19.2.3.2 Output
118
4.19.2.3.3 Exceptions
119
MPLSTEExplicitPathRetrieval
119
4.20.1.1 getAllMPLSTEExplicitPaths
119
4.20.1.1.1 Input
119
4.20.1.1.2 Output
119
4.20.1.1.3 Exceptions
119
4.20.1.2 getMPLSTEExplicitpath
119
4.20.1.2.1 Input
119
4.20.1.2.2 Output
119
4.20.1.2.3 Exceptions
120
4.20.1.3 getAllSubnetworkConnectionsWithExplicitPath
120
4.20.1.3.1 Input
120
4.20.1.3.2 Output
120
4.20.1.3.3 Exceptions
120
Notifications
120
Notification Support Matrix
120
4.21.1.1 Service Provisioning Notifications Matrix
121
Notification Subscribe Interface
121
4.21.2.1.1 Input
121
Alarm Handling
121
Operations
121
4.22.1.1 acknolwledgeAlarms
121
4.22.1.1.1 Input
121
4.22.1.1.2 Output
122
4.22.1.1.3 Exceptions
122
4.22.1.2 unacknolwledgeAlarms
122
4.22.1.2.1 Input
122
4.22.1.2.2 Output
122
4.22.1.2.3 Exceptions
122
Cisco-Specific Interfaces
123
Troubleshooting
124
Appendix I – WSDL Document References
125
MTOSI WSDL Documents
125
Appendix II – Example Java Client to Retrieve Inventory
126
Appendix III – Sample SOAP Request Response
128
getAllManagedElements
128
SOAP Request
128
SOAP Response
128
getAllManagedElementsIterator
133
SOAP Request
133
SOAP Response
134
getManagedElement
137
SOAP Request
137
SOAP Response
137
getAllEquipment
139
SOAP Request
139
SOAP Response
140
getEquipment
147
SOAP Request
147
SOAP Response
147
getContainedEquipment
149
SOAP Request
149
SOAP Response
150
getEquipmentIterator
155
SOAP Request
155
SOAP Response
155
getAllCrossConnections
158
SOAP Request
158
SOAP Response
158
getAllSubnetworkConnectionsWithTP
162
SOAP Request
162
SOAP Response
162
getAllPhysicalTerminationPoints
166
SOAP Request
166
SOAP Response
167
getTerminationPointsIterator
174
SOAP Request
174
SOAP Response
174
getAllFloatingTerminationPoints
187
SOAP Request
187
SOAP Response
188
getTerminationPoint
203
SOAP Request
203
SOAP Response
203
getAllSupportedPhysicalTerminationPoints
205
SOAP Request
205
SOAP Response
206
getContainedPotentialConnectionTerminationPoints
211
SOAP Request
211
SOAP Response
212
getContainedInUseConnectionTerminationPoints
215
SOAP Request
215
SOAP Response
215
getAllSubnetworkConnections
217
SOAP Request
217
SOAP Response
218
getSubnetworkConnection
221
SOAP Request
221
SOAP Response
222
SOAP Response – SNC with Diverse From Circuit Reference
224
getSubnetworkConnectionsIterator
227
SOAP Request
227
SOAP Response
227
getRoute
230
SOAP Request
230
SOAP Response
230
getAllTopologicalLinks
235
SOAP Request
235
SOAP Response
235
getTopologicalLink
245
SOAP Request
245
SOAP Response
245
getTopologicalLinksIterator
248
SOAP Request
248
SOAP Response
248
getRouteAndTopologicalLinks
256
SOAP Request
256
SOAP Response - OCHTrail
257
SOAP Response – ODU-UNI
265
getAllFlowDomainFragments
269
SOAP Request
269
SOAP Response
269
getFlowDomainFragment
298
SOAP Request
298
SOAP Response
298
getFlowDomainFragmentRoute
302
SOAP Request
302
SOAP Response
303
getFlowDomainFragmentsIterator
307
SOAP Request
307
SOAP Response
307
getAllFlowDomainFragmentNames
324
SOAP Request
324
SOAP Response
324
getFlowDomainFragmentNamesIterator
336
SOAP Request
336
SOAP Response
336
getAllOpticalLinkInterfaces
341
SOAP Request
341
SOAP Response
341
getAllCustomerNames
342
SOAP Request
342
SOAP Response
343
getAllQosProfileNames
344
SOAP Request
344
SOAP Response
344
getProtectionProfile
345
SOAP Request
345
SOAP Response
346
getAllProtectionProfiles
347
SOAP Request
347
SOAP Response
348
createProtectionProfile
351
SOAP Request
351
SOAP Response
352
modifyProtectionProfile
354
SOAP Request
354
SOAP Response
355
deleteProtectionProfile
356
SOAP Request
356
SOAP Response
357
getMPLSTEExplicitPath
358
SOAP Request
358
SOAP Response
359
getAllMPLSTEExplicitPaths
361
SOAP Request
361
SOAP Response
361
createMPLSTEExplicitPath
374
SOAP Request
374
SOAP Response
376
modifyMPLSTEExplicitPath
378
SOAP Request
378
SOAP Response
378
deleteMPLSTEExplicitPath
380
SOAP Request
380
SOAP Response
380
getServiceInventory for CFS Data
382
CE Service SOAP Request
382
CE Service SOAP Response
383
DWDM/OTN Service SOAP Request
388
DWDM/OTN Service SOAP Response
388
getServiceInventory for SAP Data
393
CE Service SOAP Request
393
CE Service SOAP Response
394
CE Service SAP SOAP Response for QinQ
395
DWDM/OTN Service SOAP Resquest
397
DWDM/OTN Service SOAP Response
399
provision - DWDM services
403
DWDM Services SOAP Request
403
DWDM Services SOAP Response
407
provision – OTN services
409
OTN Services SOAP Request
409
OTN Services SOAP Response
411
provision –TRAIL-UNI services
413
TRAIL-UNI Services SOAP Request
413
TRAIL-UNI Services SOAP Response
416
TRAIL-UNI Services with Diversity SOAP Request
418
TRAIL-UNI Services with Diversity SOAP Response
421
provision – Carrier Ethernet Services
424
EPL Provision SOAP Request
424
EPL Provision SOAP Response
427
EVPL Provision SOAP Request
429
EVPL Provision SOAP Response
432
EVPL Provision with QinQ Configuration - SOAP Request
435
EVPL Provision with QinQ Configuration - SOAP Response
438
Access EPL Provision SOAP Request
442
Access EPL Provision SOAP Response
445
Access EVPL Provision SOAP Request
447
Access EVPL Provision SOAP Response
450
Access EVPL Provision with QinQ Configuration - SOAP Request
452
Access EVPL Provision with QinQ Configuration - SOAP Response
456
EP-LAN Provision SOAP Request
459
EP-LAN Provision SOAP Response
462
EVP-LAN Provision SOAP Request
464
EVP-LAN Provision SOAP Response
466
EVP-LAN Provision with Multi-UNI Configuration - SOAP Request
468
EVP-LAN Provision with Multi-UNI Configuration - SOAP Response
471
EP-Tree Provision SOAP Request
474
EP-Tree Provision SOAP Response
477
EVP-Tree Provision SOAP Request
478
EVP-Tree Provision SOAP Response
481
QOS Profile Provision SOAP Request
482
QOS Profile Provision SOAP Response
485
UNI Service Provision SOAP Request
487
UNI Service Provision SOAP Response
489
ENNI Service Provision SOAP Request
491
ENNI Service Provision SOAP Response
492
modify – CE Services
494
CE Service EPL Modify SOAP Request
494
CE Service EPL Modify SOAP Response
495
CE Service EP-LAN Modify (Add Site) SOAP Request
498
CE Service EP-LAN Modify (Add Site) SOAP Response
500
CE Service EP-LAN Modify (Remove Site) SOAP Request
502
CE Service EP-LAN Modify (Remove Site) SOAP Response
504
UNI Service Modify SOAP Request
506
UNI Service Modify SOAP Response
508
ENNI Service Modify SOAP Request
510
ENNI Service Modify SOAP Response
512
modify – DWDM Services
514
DWDM Service Modify SOAP Request
514
DWDM Service Modify SOAP Response
517
OTN Service Modify SOAP Request
518
OTN Service Modify SOAP Response
521
retrieveServiceStates – CE Services
523
CE Service Retrieve Service States SOAP Request
523
CE Service Retrieve Service States SOAP Response
524
retrieveServiceStates – DWDM / OTN Services
525
DWDM/OTN Services SOAP Request
525
DWDM/OTN Services SOAP Response
526
terminate – DWDM/OTN Services
527
DWDM/OTN Service SOAP Request
527
DWDM/OTN Service SOAP Response
528
terminate – CE Services
530
CE Service Terminate SOAP Request
530
CE Service Terminate SOAP Response
531
Terminate QOS Profile SOAP Request
533
Terminate QOS Profile SOAP Response
534
Terminate UNI / ENNI Service SOAP Request
536
Terminate UNI / ENNI Service SOAP Response
537
Alarm Retrieval
539
getActiveAlarms
539
9.56.1.1 SOAP Request
539
9.56.1.2 SOAP Response
540
getActiveAlarmsCount
542
9.56.2.1 SOAP Request
542
9.56.2.2 SOAP Response
542
ConnectionControl
543
switchRoute
543
9.57.1.1 SOAP Request
543
9.57.1.2 SOAP Response
545
setIntendedRoute
547
9.57.2.1 SOAP Request
547
9.57.2.2 SOAP Response
547
TerminationPointControl
549
setTerminationPointData
549
9.58.1.1 SOAP Request
549
9.58.1.2 SOAP Response
551
Notification
554
Subscribe Request
554
Subscribe Response
554
UnSubscribe Request
555
UnSubscribe Response
555
Notification Samples
556
Equipment Add
556
ManagedElement Delete
558
Equipment Update
560
SubNetworkConnection - Attribute Value Change
562
Service Provisioning – CFS Created
565
Service Provisioning – CFS Service State Change
567
Service Provisioning – CFS Terminate
570
FDN Value Change Notification
572
Alarm Handling
575
acknowledgeAlarms
575
9.61.1.1 SOAP Request
575
9.61.1.2 SOAP Response
576
unacknowledgeAlarms
577
9.61.2.1 SOAP Request
577
SOAP Response
577
10 References
579

Developer's Guide

Size:

7.65 MB
Pages:

579
Language:

English

Developer's Guide

Table of Contents

Developer's Guide

Size:

6.34 MB
Pages:

594
Language:

English

Developer's Guide

Table of Contents

Preface
17
Conventions
17
Additional User Documentation
17
Obtaining Documentation, Obtaining Support, and Security Guidelines
17
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
28
Authorization
28
License
29
MTOSI Interface Details
30
ManagedElementRetrieval
30
Managed Element Data
30
Operations
32
getAllManagedElements
32
4.1.2.1.1 Input
32
4.1.2.1.2 Output
32
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
33
getManagedElement
33
4.1.2.3.1 Input
33
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
34
getManagedElementNamesIterator
34
4.2.1.2.1 Input
34
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
37
4.3.2.2.3 Exceptions
37
getEquipmentIterator
37
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
38
TerminationPointRetrieval
38
Termination Point Data
38
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
42
4.4.2.2.3 Exceptions
42
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
43
getAllSupportedPhysicalTerminationPoints
43
4.4.2.5.1 Input
43
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
44
getContainedPotentialConnectionTerminationPoints
44
4.4.2.7.1 Input
44
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
47
4.5.1.2.1 Input
47
4.5.1.2.2 Output
47
4.5.1.2.3 Exceptions
48
getSubnetworkConnectionsIterator
49
4.5.1.3.1 Input
49
4.5.1.3.2 Output
49
4.5.1.3.3 Exceptions
50
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 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
59
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
60
4.7.2.4.3 Exceptions
60
FlowDomainFragmentNameRetrieval (Carrier Ethernet Inventory)
61
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
69
Operations
71
getServiceInventory
71
4.9.3.1.1 Input
72
4.9.3.1.2 Output
72
4.9.3.1.3 Exceptions
73
getServiceInventoryIterator
73
4.9.3.2.1 Input
73
4.9.3.2.2 Output
73
4.9.3.2.3 Exceptions
73
CustomerNameRetrieval
73
getAllCustomerNames
73
4.10.1.1.1 Input
73
4.10.1.1.2 Output
73
4.10.1.1.3 Exceptions
74
getCustomerNamesIterator
74
4.10.1.2.1 Input
74
4.10.1.2.2 Output
74
4.10.1.2.3 Exceptions
74
QosProfileNameRetrieval
75
getAllQosProfileNames
75
4.11.1.1.1 Input
75
4.11.1.1.2 Output
75
4.11.1.1.3 Exceptions
75
getQosProfileNamesIterator
75
4.11.1.2.1 Input
75
4.11.1.2.2 Output
75
4.11.1.2.3 Exceptions
76
OpticalLinkInterfaceRetrieval
76
getAllOpticalLinkInterfaces
76
4.12.1.1.1 Input
76
4.12.1.1.2 Output
76
4.12.1.1.3 Exceptions
76
getOpticalLinkInterfacesIterator
77
4.12.2.1.1 Input
77
4.12.2.1.2 Output
77
4.12.2.1.3 Exceptions
77
ServiceActivationInterface
77
Supported Services for Provisioning
77
Error Message Format with Error Codes
78
List of error codes
79
Service Order Data
79
Optical Service Order Data
79
4.13.3.1.1 OTN Service Order Data
79
4.13.3.1.2 OTN Path Options
80
4.13.3.1.3 TRAIL UNI – UNI Config Parameters
81
4.13.3.1.4 TRAIL UNI – UNI Explicit Path
82
4.13.3.1.5 OCH Trail Uni Diversity
82
4.13.3.1.6 DMDM Service Order Data
83
4.13.3.1.7 DMDM Service Constraints
85
4.13.3.1.8 DMDM Channel to Frequency Mapping Grid
86
Carrier Ethernet Service Order Data
87
4.13.3.2.1 QinQ Configuration in Order data
94
4.13.3.2.2 Multi-UNI Configuration in Order data
95
Carrier Ethernet Endpoint Service Order Data
95
4.13.3.3.1 Carrier Ethernet UNI Endpoint Service Order Data
96
4.13.3.3.2 Carrier Ethernet ENNI Endpoint Service Order Data
97
Carrier Ethernet QoS Profile Service Order Data
98
Operations
99
Provision
99
4.13.4.1.1 Optical Services
99
4.13.4.1.2 Carrier Ethernet Services
99
4.13.4.1.3 Service Input Data
99
4.13.4.1.4 Input
99
4.13.4.1.5 Provision Response
100
4.13.4.1.6 Output
100
4.13.4.1.7 Exceptions
100
modify
100
4.13.4.2.1 Input
101
4.13.4.2.2 Modify Response
101
4.13.4.2.3 Output
101
4.13.4.2.4 Exceptions
102
Terminate
102
4.13.4.3.1 Input
102
4.13.4.3.2 Terminate Response
102
4.13.4.3.3 Output
102
4.13.4.3.4 Exceptions
103
activate
103
4.13.4.4.1 Input
103
4.13.4.4.2 Activate Response
103
4.13.4.4.3 Output
103
4.13.4.4.4 Exceptions
104
deActivate
104
4.13.4.5.1 Input
104
4.13.4.5.2 Activate Response
104
4.13.4.5.3 Output
104
4.13.4.5.4 Exceptions
105
retrieveServiceStates
105
4.13.4.6.1 Input
105
4.13.4.6.2 Output
105
4.13.4.6.3 Exceptions
105
Alarm Retrieval
105
Operations
105
getActiveAlarms
105
4.14.1.1.1 Input
106
4.14.1.1.2 Output
106
4.14.1.1.3 Exceptions:
107
getActiveAlarmsCount
107
4.14.1.2.1 Input
107
4.14.1.2.2 Output
108
4.14.1.2.3 Exceptions:
108
getActiveAlarmsIterator
108
4.14.1.3.1 Input
108
4.14.1.3.2 Output
109
4.14.1.3.3 Exceptions
109
TerminationPointControl
109
Operations
109
setTerminationPointData
109
4.15.1.1.1 Input
109
4.15.1.1.2 Supported Parameter Name and Value Table
109
NOTE:
112
4.15.1.1.3 Output
112
4.15.1.1.4 Exceptions:
113
ConnectionControl
113
Operations
113
switchRoute
113
4.16.1.1.1 Output
113
4.16.1.1.2 Exceptions
113
setIntendedRoute
114
4.16.1.2.1 Output
114
4.16.1.2.2 Exceptions:
114
ProtectionProfileControl
115
ProtectionProfileDataType
115
Operations
115
CreateProtectionProfile
115
4.17.2.1.1 Input
115
4.17.2.1.2 Output
115
4.17.2.1.3 Exceptions
116
ModifyProtectionProfile
116
4.17.2.2.1 Input
116
4.17.2.2.2 Output
116
4.17.2.2.3 Exceptions
116
DeleteProtectionProfile
116
4.17.2.3.1 Input
116
4.17.2.3.2 Output
117
4.17.2.3.3 Exceptions
117
ProtectionProfileRetrieval
117
getAllProtectionProfiles
117
4.18.1.1.1 Input
117
4.18.1.1.2 Output
117
4.18.1.1.3 Exceptions
118
getProtectionProfile
118
4.18.1.2.1 Input
118
4.18.1.2.2 Output
118
4.18.1.2.3 Exceptions
118
getAllSubnetworkConnectionsWithProtectionProfile
118
4.18.1.3.1 Input
119
4.18.1.3.2 Output
119
4.18.1.3.3 Exceptions
119
MPLSTEExplicitPathControl
119
MPLSTEExplicitPathDataType
119
Operations
120
CreateMPLSTEExplicitPath
120
4.19.2.1.1 Input
120
4.19.2.1.2 Output
120
4.19.2.1.3 Exceptions
120
ModifyMPLSTEExplicitPath
120
4.19.2.2.1 Input
120
4.19.2.2.2 Output
120
4.19.2.2.3 Exceptions:
121
DeleteMPLSTEExplicitPath
121
4.19.2.3.1 Input
121
4.19.2.3.2 Output
121
4.19.2.3.3 Exceptions
121
MPLSTEExplicitPathRetrieval
121
getAllMPLSTEExplicitPaths
121
4.20.1.1.1 Input
122
4.20.1.1.2 Output
122
4.20.1.1.3 Exceptions
122
getMPLSTEExplicitpath
122
4.20.1.2.1 Input
122
4.20.1.2.2 Output
122
4.20.1.2.3 Exceptions
122
getAllSubnetworkConnectionsWithExplicitPath
122
4.20.1.3.1 Input
123
4.20.1.3.2 Output
123
4.20.1.3.3 Exceptions
123
Notifications
123
Notification Support Matrix
123
Service Provisioning Notifications Matrix
123
Notification Subscribe Interface
124
4.21.2.1.1 Input
124
Alarm Handling
124
Operations
124
acknolwledgeAlarms
124
4.22.1.1.1 Input
124
4.22.1.1.2 Output
124
4.22.1.1.3 Exceptions
124
unacknolwledgeAlarms
125
4.22.1.2.1 Input
125
4.22.1.2.2 Output
125
4.22.1.2.3 Exceptions
125
Cisco-Specific Interfaces
126
Troubleshooting
127
Appendix I – WSDL Document References
128
MTOSI WSDL Documents
128
Appendix II – Example Java Client to Retrieve Inventory
129
Appendix III – Sample SOAP Request Response
131
getAllManagedElements
131
9.1.1 SOAP Request
131
SOAP Response
131
getAllManagedElementsIterator
136
SOAP Request
136
SOAP Response
137
getManagedElement
140
SOAP Request
140
SOAP Response
140
getAllEquipment
142
SOAP Request
142
9.4.2 SOAP Response
143
getEquipment
150
SOAP Request
150
SOAP Response
150
getContainedEquipment
152
SOAP Request
152
SOAP Response
153
getEquipmentIterator
158
SOAP Request
158
SOAP Response
158
getAllCrossConnections
161
SOAP Request
161
SOAP Response
161
getAllSubnetworkConnectionsWithTP
165
SOAP Request
165
SOAP Response
165
getAllPhysicalTerminationPoints
169
SOAP Request
169
SOAP Response
170
getTerminationPointsIterator
177
SOAP Request
177
SOAP Response
177
getAllFloatingTerminationPoints
190
SOAP Request
190
SOAP Response
191
getTerminationPoint
206
SOAP Request
206
SOAP Response
206
getAllSupportedPhysicalTerminationPoints
208
SOAP Request
208
SOAP Response
209
getContainedPotentialConnectionTerminationPoints
214
SOAP Request
214
SOAP Response
215
getContainedInUseConnectionTerminationPoints
218
SOAP Request
218
SOAP Response
218
getAllSubnetworkConnections
220
SOAP Request
220
SOAP Response
221
getSubnetworkConnection
224
SOAP Request
224
SOAP Response
225
SOAP Response – SNC with Diverse From Circuit Reference
227
getSubnetworkConnectionsIterator
230
SOAP Request
230
SOAP Response
230
getRoute
233
SOAP Request
233
SOAP Response
233
getAllTopologicalLinks
238
SOAP Request
238
SOAP Response
238
getTopologicalLink
248
SOAP Request
248
SOAP Response
248
getTopologicalLinksIterator
251
SOAP Request
251
SOAP Response
251
getRouteAndTopologicalLinks
259
SOAP Request
259
SOAP Response - OCHTrail
260
SOAP Response – ODU-UNI
268
SOAP Response – OCHNC
272
getAllFlowDomainFragments
277
SOAP Request
277
SOAP Response
277
getFlowDomainFragment
305
SOAP Request
305
SOAP Response
306
getFlowDomainFragmentRoute
310
SOAP Request
310
SOAP Response
310
getFlowDomainFragmentsIterator
315
SOAP Request
315
SOAP Response
315
getAllFlowDomainFragmentNames
331
SOAP Request
331
SOAP Response
332
getFlowDomainFragmentNamesIterator
343
SOAP Request
343
SOAP Response
344
getAllOpticalLinkInterfaces
348
SOAP Request
348
SOAP Response
349
getAllCustomerNames
350
SOAP Request
350
SOAP Response
350
getAllQosProfileNames
352
SOAP Request
352
SOAP Response
352
getProtectionProfile
353
SOAP Request
353
SOAP Response
354
getAllProtectionProfiles
355
SOAP Request
355
SOAP Response
355
createProtectionProfile
359
SOAP Request
359
SOAP Response
360
modifyProtectionProfile
361
SOAP Request
361
SOAP Response
363
deleteProtectionProfile
364
SOAP Request
364
SOAP Response
365
getMPLSTEExplicitPath
366
SOAP Request
366
SOAP Response
366
getAllMPLSTEExplicitPaths
369
SOAP Request
369
SOAP Response
369
createMPLSTEExplicitPath
382
SOAP Request
382
SOAP Response
383
modifyMPLSTEExplicitPath
386
SOAP Request
386
SOAP Response
386
deleteMPLSTEExplicitPath
388
SOAP Request
388
SOAP Response
388
getServiceInventory for CFS Data
390
CE Service SOAP Request
390
CE Service SOAP Response
391
DWDM/OTN Service SOAP Request
395
DWDM/OTN Service SOAP Response
396
getServiceInventory for SAP Data
401
CE Service SOAP Request
401
CE Service SOAP Response
401
CE Service SAP SOAP Response for QinQ
403
DWDM/OTN Service SOAP Resquest
405
DWDM/OTN Service SOAP Response
406
provision - DWDM services
410
DWDM Services SOAP Request
410
DWDM Services SOAP Response
415
provision – OTN services
417
OTN Services SOAP Request
417
OTN Services SOAP Response
419
provision –TRAIL-UNI services
421
TRAIL-UNI Services SOAP Request
421
TRAIL-UNI Services SOAP Response
423
TRAIL-UNI Services with Diversity SOAP Request
426
TRAIL-UNI Services with Diversity SOAP Response
429
TRAIL-UNI Services with Explicit Path SOAP Request
432
TRAIL-UNI Services with Explicit Path SOAP Response
435
provision – Carrier Ethernet Services
438
EPL Provision SOAP Request
438
EPL Provision SOAP Response
440
EVPL Provision SOAP Request
443
EVPL Provision SOAP Response
446
EVPL Provision with QinQ Configuration - SOAP Request
448
EVPL Provision with QinQ Configuration - SOAP Response
452
Access EPL Provision SOAP Request
456
Access EPL Provision SOAP Response
459
Access EVPL Provision SOAP Request
461
Access EVPL Provision SOAP Response
464
Access EVPL Provision with QinQ Configuration - SOAP Request
466
Access EVPL Provision with QinQ Configuration - SOAP Response
470
EP-LAN Provision SOAP Request
473
EP-LAN Provision SOAP Response
475
EVP-LAN Provision SOAP Request
478
EVP-LAN Provision SOAP Response
480
EVP-LAN Provision with Multi-UNI Configuration - SOAP Request
482
EVP-LAN Provision with Multi-UNI Configuration - SOAP Response
485
EP-Tree Provision SOAP Request
488
EP-Tree Provision SOAP Response
491
EVP-Tree Provision SOAP Request
492
EVP-Tree Provision SOAP Response
495
QOS Profile Provision SOAP Request
496
QOS Profile Provision SOAP Response
499
UNI Service Provision SOAP Request
501
UNI Service Provision SOAP Response
503
ENNI Service Provision SOAP Request
504
ENNI Service Provision SOAP Response
506
modify – CE Services
508
CE Service EPL Modify SOAP Request
508
CE Service EPL Modify SOAP Response
509
CE Service EP-LAN Modify (Add Site) SOAP Request
512
CE Service EP-LAN Modify (Add Site) SOAP Response
514
CE Service EP-LAN Modify (Remove Site) SOAP Request
516
CE Service EP-LAN Modify (Remove Site) SOAP Response
518
UNI Service Modify SOAP Request
520
UNI Service Modify SOAP Response
522
ENNI Service Modify SOAP Request
524
ENNI Service Modify SOAP Response
526
modify – DWDM Services
528
DWDM Service Modify SOAP Request
528
DWDM Service Modify SOAP Response
531
OTN Service Modify SOAP Request
532
OTN Service Modify SOAP Response
534
retrieveServiceStates – CE Services
537
CE Service Retrieve Service States SOAP Request
537
CE Service Retrieve Service States SOAP Response
538
retrieveServiceStates – DWDM / OTN Services
539
DWDM/OTN Services SOAP Request
539
DWDM/OTN Services SOAP Response
540
terminate – DWDM/OTN Services
541
DWDM/OTN Service SOAP Request
541
DWDM/OTN Service SOAP Response
542
terminate – CE Services
544
CE Service Terminate SOAP Request
544
CE Service Terminate SOAP Response
545
Terminate QOS Profile SOAP Request
547
Terminate QOS Profile SOAP Response
548
Terminate UNI / ENNI Service SOAP Request
550
Terminate UNI / ENNI Service SOAP Response
551
Alarm Retrieval
553
getActiveAlarms
553
SOAP Request
553
SOAP Response
554
getActiveAlarmsCount
555
SOAP Request
555
SOAP Response
556
ConnectionControl
556
switchRoute
556
SOAP Request
556
SOAP Response
558
setIntendedRoute
560
SOAP Request
560
SOAP Response
561
TerminationPointControl
563
setTerminationPointData
563
SOAP Request
563
SOAP Response
566
Notification
569
Subscribe Request
569
Subscribe Response
569
UnSubscribe Request
570
UnSubscribe Response
570
Notification Samples
571
Equipment Add
571
ManagedElement Delete
573
Equipment Update
575
SubNetworkConnection - Attribute Value Change
577
Service Provisioning – CFS Created
580
Service Provisioning – CFS Service State Change
582
Service Provisioning – CFS Terminate
585
FDN Value Change Notification
587
Alarm Handling
590
acknowledgeAlarms
590
SOAP Request
590
SOAP Response
591
unacknowledgeAlarms
591
SOAP Request
591
SOAP Response
592
10 References
594

Developer's Guide

Size:

7.76 MB
Pages:

594
Language:

English

Developer's Guide

Table of Contents

Preface
16
Conventions
16
Additional User Documentation
16
Obtaining Documentation, Obtaining Support, and Security Guidelines
16
Northbound MTOSI Interface
18
Web Services Standards
18
MTOSI Standards
18
Communication Patterns
18
Iterator Pattern
18
MTOSI Object Naming and Configuration
19
OSS Integration Usage Scenarios
20
Retrieving Device Inventory Flow
20
Inventory Notification Registration and Processing Flow
21
Service Provisioning Flow
22
Service Provisioning Flow for Carrier Ethernet
22
Service Provisioning Flow for Optical (OTN) Services
22
Service Provisioning Flow for Optical (DWDM) Services
23
Supported MTOSI Interfaces
24
MTOSI Interface Endpoints
25
Authentication
26
Authorization
26
License
26
MTOSI Interface Details
27
ManagedElementRetrieval
27
Managed Element Data
27
Operations
29
getAllManagedElements
29
4.1.2.1.1 Input
29
4.1.2.1.2 Output
29
4.1.2.1.3 Exceptions
29
getAllManagedElementsIterator
29
4.1.2.2.1 Input
29
4.1.2.2.2 Output
29
4.1.2.2.3 Exceptions
30
getManagedElement
30
4.1.2.3.1 Input
30
4.1.2.3.2 Output
30
4.1.2.3.3 Exceptions
30
ManagedElementNameRetrieval
30
getAllManagedElementNames
30
4.2.1.1.1 Input
30
4.2.1.1.2 Output
31
4.2.1.1.3 Exceptions
31
getManagedElementNamesIterator
31
4.2.1.2.1 Input
31
4.2.1.2.2 Output
31
4.2.1.2.3 Exceptions
31
EquipmentInventoryRetrieval
32
Equipment Data
32
Operations
33
getEquipment
33
4.3.2.1.1 Input
33
4.3.2.1.2 Output
33
4.3.2.1.3 Exceptions
33
getAllEquipment
34
4.3.2.2.1 Input
34
4.3.2.2.2 Output
34
4.3.2.2.3 Exceptions
34
getEquipmentIterator
34
4.3.2.3.1 Input
34
4.3.2.3.2 Output
34
4.3.2.3.3 Exceptions
35
getContainedEquipment
35
4.3.2.4.1 Input
35
4.3.2.4.2 Output
35
4.3.2.4.3 Exceptions
35
TerminationPointRetrieval
35
Termination Point Data
35
Operations
38
getAllPhysicalTerminationPoints
38
4.4.2.1.1 Input
38
4.4.2.1.2 Output
38
4.4.2.1.3 Exceptions
38
getTerminationPointsIterator
39
4.4.2.2.1 Input
39
4.4.2.2.2 Output
39
4.4.2.2.3 Exceptions
39
getTerminationPoint
39
4.4.2.3.1 Input
39
4.4.2.3.2 Output
39
4.4.2.3.3 Exceptions
39
getAllFloatingTerminationPoints
39
4.4.2.4.1 Input
40
4.4.2.4.2 Output
40
4.4.2.4.3 Exceptions
40
getAllSupportedPhysicalTerminationPoints
40
4.4.2.5.1 Input
40
4.4.2.5.2 Output
40
4.4.2.5.3 Exceptions
40
getContainedInUseConnectionTerminationPoints
40
4.4.2.6.1 Input
40
4.4.2.6.2 Output
41
4.4.2.6.3 Exceptions
41
getContainedPotentialConnectionTerminationPoints
41
4.4.2.7.1 Input
41
4.4.2.7.2 Output
41
4.4.2.7.3 Exceptions
41
ConnectionRetrieval (Optical Domain)
41
getAllsubnetworkConnection
41
4.5.1.1.1 Input
41
4.5.1.1.2 Output
41
4.5.1.1.3 Exceptions
44
getSubnetworkConnection
44
4.5.1.2.1 Input
44
4.5.1.2.2 Output
44
4.5.1.2.3 Exceptions
46
getSubnetworkConnectionsIterator
46
4.5.1.3.1 Input
46
4.5.1.3.2 Output
46
4.5.1.3.3 Exceptions
48
getRoute
48
4.5.1.4.1 Input
48
4.5.1.4.2 Output
48
4.5.1.4.3 Exceptions
48
getAllCrossConnections
48
4.5.1.5.1 Input
48
4.5.1.5.2 Output
49
4.5.1.5.3 Exceptions
49
getAllSubnetworkConnectionsWithTP
49
4.5.1.6.1 Input
49
4.5.1.6.2 Output
49
4.5.1.6.3 Exceptions
49
TopologicalLinkRetrieval
50
getAllTopologicalLinks
50
4.6.1.1.1 Input
50
4.6.1.1.2 Output
50
4.6.1.1.3 Exceptions
50
getTopologicalLink
50
4.6.1.2.1 Input
50
4.6.1.2.2 Output
51
4.6.1.2.3 Exceptions
51
getTopologicalLinksIterator
51
4.6.1.3.1 Input
51
4.6.1.3.2 Output
51
4.6.1.3.3 Exceptions
52
getRouteAndTopologicalLinks
52
4.6.1.4.1 Input
52
4.6.1.4.2 Output
52
4.6.1.4.3 Exceptions
53
FlowDomainRetrieval (Carrier Ethernet Inventory)
53
Flow Domain Fragment Data
53
Operations
55
getAllFlowDomainFragments
55
4.7.2.1.1 Input
55
4.7.2.1.2 Output
55
4.7.2.1.3 Exceptions
55
getFlowDomainFragmentIterator
55
4.7.2.2.1 Input
55
4.7.2.2.2 Output
55
4.7.2.2.3 Exceptions
56
getFlowDomainFragment
56
4.7.2.3.1 Input
56
4.7.2.3.2 Output
56
4.7.2.3.3 Exceptions
56
getFlowDomainFragmentRoute
56
4.7.2.4.1 Input
56
4.7.2.4.2 Output
56
4.7.2.4.3 Exceptions
57
FlowDomainFragmentNameRetrieval (Carrier Ethernet Inventory)
57
Operations
58
getAllFlowDomainFragmentNames
58
4.8.1.1.1 Input
58
4.8.1.1.2 Output
58
4.8.1.1.3 Exceptions
58
getFlowDomainFragmentNamesIterator
58
4.8.1.2.1 Input
58
4.8.1.2.2 Output
58
4.8.1.2.3 Exceptions
59
ServiceInventoryRetrieval
59
Customer Facing Service (CFS) Data
59
Service Access Point (SAP) Data
65
Operations
68
getServiceInventory
68
4.9.3.1.1 Input
68
4.9.3.1.2 Output
69
4.9.3.1.3 Exceptions
69
getServiceInventoryIterator
70
4.9.3.2.1 Input
70
4.9.3.2.2 Output
70
4.9.3.2.3 Exceptions
70
CustomerNameRetrieval
70
getAllCustomerNames
70
4.10.1.1.1 Input
70
4.10.1.1.2 Output
70
getCustomerNamesIterator
71
4.10.1.2.1 Input
71
4.10.1.2.2 Output
71
4.10.1.2.3 Exceptions
71
QosProfileNameRetrieval
71
getAllQosProfileNames
71
4.11.1.1.1 Input
71
4.11.1.1.2 Output
71
4.11.1.1.3 Exceptions
72
getQosProfileNamesIterator
72
4.11.1.2.1 Input
72
4.11.1.2.2 Output
72
4.11.1.2.3 Exceptions
72
OpticalMPLSTEPathNameRetrieval
72
getAllOpticalMplsTEPathNames
72
4.12.1.1.1 Input
72
4.12.1.1.2 Output
73
4.12.1.1.3 Exceptions
73
getOpticalMplsTEPathNamesIterator
73
4.12.1.2.1 Input
73
4.12.1.2.2 Output
73
4.12.1.2.3 Exceptions
73
OpticalLinkInterfaceRetrieval
74
getAllOpticalLinkInterfaces
74
4.13.1.1.1 Input
74
4.13.1.1.2 Output
74
4.13.1.1.3 Exceptions
74
getOpticalLinkInterfacesIterator
74
4.13.2.1.1 Input
74
4.13.2.1.2 Output
75
4.13.2.1.3 Exceptions
75
ServiceActivationInterface
75
Supported Services for Provisioning
75
Service Order Data
76
Optical Service Order Data
76
4.14.2.1.1 OTN Service Order Data
76
4.14.2.1.2 OTN Path Options
77
4.14.2.1.3 TRAIL UNI – UNI Config Parameters
78
4.14.2.1.4 DMDM Service Order Data
78
4.14.2.1.5 DMDM Service Constraints
80
4.14.2.1.6 DMDM Channel to Frequency Mapping Grid
82
Carrier Ethernet Service Order Data
83
4.14.2.2.1 QinQ Configuration in Order data
91
4.14.2.2.2 Multi-UNI Configuration in Order data
91
Carrier Ethernet Endpoint Service Order Data
92
4.14.2.3.1 Carrier Ethernet UNI Endpoint Service Order Data
92
4.14.2.3.2 Carrier Ethernet ENNI Endpoint Service Order Data
94
Carrier Ethernet QoS Profile Service Order Data
95
Operations
96
Provision
96
4.14.3.1.1 Optical Services
97
4.14.3.1.2 Carrier Ethernet Services
97
4.14.3.1.3 Service Input Data
97
4.14.3.1.4 Input
97
4.14.3.1.5 Provision Response
98
4.14.3.1.6 Output
98
4.14.3.1.7 Exceptions
98
modify
98
4.14.3.2.1 Input
98
4.14.3.2.2 Modify Response
99
4.14.3.2.3 Output
99
4.14.3.2.4 Exceptions
99
Terminate
99
4.14.3.3.1 Input
100
4.14.3.3.2 Terminate Response
100
4.14.3.3.3 Output
100
4.14.3.3.4 Exceptions
100
activate
100
4.14.3.4.1 Input
101
4.14.3.4.2 Activate Response
101
4.14.3.4.3 Output
101
4.14.3.4.4 Exceptions
101
deActivate
102
4.14.3.5.1 Input
102
4.14.3.5.2 Activate Response
102
4.14.3.5.3 Output
102
4.14.3.5.4 Exceptions
103
retrieveServiceStates
103
4.14.3.6.1 Input
103
4.14.3.6.2 Output
103
4.14.3.6.3 Exceptions
103
Alarm Retrieval
103
Operations
103
getActiveAlarms
103
4.15.1.1.1 Input
104
4.15.1.1.2 Output
104
4.15.1.1.3 Exceptions:
105
getActiveAlarmsCount
105
4.15.1.2.1 Input
105
4.15.1.2.2 Output
106
4.15.1.2.3 Exceptions:
106
getActiveAlarmsIterator
107
4.15.1.3.1 Input
107
4.15.1.3.2 Output
107
4.15.1.3.3 Exceptions:
107
TerminationPointControl
107
Operations
107
setTerminationPointData
107
4.16.1.1.1 Input
107
4.16.1.1.2 Supported Parameter Name and Value Table
108
4.16.1.1.3 Output
109
4.16.1.1.4 Exceptions:
110
ConnectionControl
110
Operations
110
switchRoute
110
4.17.1.1.1 Output
110
4.17.1.1.2 Exceptions:
111
setIntendedRoute
111
4.17.1.2.1 Output
111
Exceptions:
111
ProtectionProfileControl
112
ProtectionProfileDataType
112
Operations
112
CreateProtectionProfile
112
4.18.2.1.1 Input
112
4.18.2.1.2 Output
113
4.18.2.1.3 Exceptions:
113
ModifyProtectionProfile
113
4.18.2.2.1 Input
113
4.18.2.2.2 Output
113
4.18.2.2.3 Exceptions:
114
DeleteProtectionProfile
114
4.18.2.3.1 Input
114
4.18.2.3.2 Output
114
4.18.2.3.3 Exceptions:
114
ProtectionProfileRetrieval
114
getAllProtectionProfiles
114
4.19.1.1.1 Input
114
4.19.1.1.2 Output
115
4.19.1.1.3 Exceptions
115
getProtectionProfile
115
4.19.1.2.1 Input
115
4.19.1.2.2 Output
115
4.19.1.2.3 Exceptions
116
getAllSubnetworkConnectionsWithProtectionProfile
116
4.19.1.3.1 Input
116
4.19.1.3.2 Output
116
4.19.1.3.3 Exceptions
117
MPLSTEExplicitPathControl
117
MPLSTEExplicitPathDataType
117
Operations
117
CreateMPLSTEExplicitPath
117
4.20.2.1.1 Input
117
4.20.2.1.2 Output
118
4.20.2.1.3 Exceptions:
118
ModifyMPLSTEExplicitPath
118
4.20.2.2.1 Input
118
4.20.2.2.2 Output
118
4.20.2.2.3 Exceptions:
119
DeleteMPLSTEExplicitPath
119
4.20.2.3.1 Input
119
4.20.2.3.2 Output
119
4.20.2.3.3 Exceptions:
119
MPLSTEExplicitPathRetrieval
120
getAllMPLSTEExplicitPaths
120
4.21.1.1.1 Input
120
4.21.1.1.2 Output
120
4.21.1.1.3 Exceptions
120
getMPLSTEExplicitpath
120
4.21.1.2.1 Input
120
4.21.1.2.2 Output
120
4.21.1.2.3 Exceptions
121
getAllSubnetworkConnectionsWithExplicitPath
121
4.21.1.3.1 Input
121
4.21.1.3.2 Output
121
4.21.1.3.3 Exceptions
121
Notifications
121
Notification Support Matrix
121
Service Provisioning Notifications Matrix
122
Notification Subscribe Interface
122
4.22.2.1.1 Input
122
Alarm Handling
123
Operations
123
acknolwledgeAlarms
123
4.23.1.1.1 Input
123
4.23.1.1.2 Output
123
4.23.1.1.3 Exceptions:
123
unacknolwledgeAlarms
123
4.23.1.2.1 Input
123
4.23.1.2.2 Output
124
4.23.1.2.3 Exceptions:
124
Cisco-Specific Interfaces
125
Troubleshooting
126
Appendix I – WSDL Document References
127
MTOSI WSDL Documents
127
Appendix II – Example Java Client to Retrieve Inventory
128
Appendix III – Sample SOAP Request Response
130
getAllManagedElements
130
SOAP Request
130
SOAP Response
130
getAllManagedElementsIterator
135
SOAP Request
135
SOAP Response
136
CgetManagedElement
139
SOAP Request
139
SOAP Response
139
getAllEquipment
141
SOAP Request
141
SOAP Response
142
getEquipment
149
SOAP Request
149
SOAP Response
149
getContainedEquipment
151
SOAP Request
151
SOAP Response
152
getEquipmentIterator
157
SOAP Request
157
SOAP Response
157
getAllCrossConnections
160
SOAP Request
160
SOAP Response
160
getAllSubnetworkConnectionsWithTP
164
SOAP Request
164
SOAP Response
164
getAllPhysicalTerminationPoints
168
SOAP Request
168
SOAP Response
169
getTerminationPointsIterator
176
SOAP Request
176
SOAP Response
177
getAllFloatingTerminationPoints
189
SOAP Request
189
SOAP Response
190
getTerminationPoint
205
SOAP Request
205
SOAP Response
205
getAllSupportedPhysicalTerminationPoints
207
SOAP Request
207
SOAP Response
208
getContainedPotentialConnectionTerminationPoints
213
SOAP Request
213
SOAP Response
214
getContainedInUseConnectionTerminationPoints
217
SOAP Request
217
SOAP Response
217
getAllSubnetworkConnections
219
SOAP Request
219
SOAP Response
220
getSubnetworkConnection
224
SOAP Request
224
SOAP Response
224
getSubnetworkConnectionsIterator
227
SOAP Request
227
SOAP Response
227
getRoute
230
SOAP Request
230
SOAP Response
230
getAllTopologicalLinks
235
SOAP Request
235
SOAP Response
235
getTopologicalLink
245
SOAP Request
245
SOAP Response
245
getTopologicalLinksIterator
248
SOAP Request
248
SOAP Response
248
getRouteAndTopologicalLinks
256
SOAP Request
256
SOAP Response
257
getAllFlowDomainFragments
265
SOAP Request
265
SOAP Response
265
getFlowDomainFragment
293
SOAP Request
293
SOAP Response
294
getFlowDomainFragmentRoute
298
SOAP Request
298
SOAP Response
298
getFlowDomainFragmentsIterator
303
SOAP Request
303
SOAP Response
303
getAllFlowDomainFragmentNames
319
SOAP Request
319
SOAP Response
320
getFlowDomainFragmentNamesIterator
331
SOAP Request
331
SOAP Response
332
getAllOpticalMplsTEPathNames
336
SOAP Request
336
SOAP Response
337
getAllOpticalLinkInterfaces
338
SOAP Request
338
SOAP Response
338
getAllCustomerNames
339
SOAP Request
339
SOAP Response
340
getAllQosProfileNames
341
SOAP Request
341
SOAP Response
341
getServiceInventory for CFS Data
342
CE Service SOAP Request
342
CE Service SOAP Response
343
DWDM/OTN Service SOAP Request
347
DWDM/OTN Service SOAP Response
348
getServiceInventory for SAP Data
353
CE Service SOAP Request
353
CE Service SOAP Response
354
CE Service SAP SOAP Response for QinQ
355
DWDM/OTN Service SOAP Resquest
357
DWDM/OTN Service SOAP Response
359
provision - DWDM services
363
DWDM Services SOAP Request
363
DWDM Services SOAP Response
367
provision – OTN services
369
OTN Services SOAP Request
369
OTN Services SOAP Response
371
provision –TRAIL-UNI services
374
TRAIL-UNI Services SOAP Request
374
TRAIL-UNI Services SOAP Response
375
provision – Carrier Ethernet Services
378
EPL Provision SOAP Request
378
EPL Provision SOAP Response
380
EVPL Provision SOAP Request
383
EVPL Provision SOAP Response
386
EVPL Provision with QinQ Configuration - SOAP Request
388
EVPL Provision with QinQ Configuration - SOAP Response
392
Access EPL Provision SOAP Request
396
Access EPL Provision SOAP Response
399
Access EVPL Provision SOAP Request
401
Access EVPL Provision SOAP Response
404
Access EVPL Provision with QinQ Configuration - SOAP Request
406
Access EVPL Provision with QinQ Configuration - SOAP Response
410
EP-LAN Provision SOAP Request
413
EP-LAN Provision SOAP Response
415
EVP-LAN Provision SOAP Request
417
EVP-LAN Provision SOAP Response
420
EVP-LAN Provision with Multi-UNI Configuration - SOAP Request
422
EVP-LAN Provision with Multi-UNI Configuration - SOAP Response
425
EP-Tree Provision SOAP Request
428
EP-Tree Provision SOAP Response
430
EVP-Tree Provision SOAP Request
432
EVP-Tree Provision SOAP Response
434
QOS Profile Provision SOAP Request
436
QOS Profile Provision SOAP Response
438
UNI Service Provision SOAP Request
441
UNI Service Provision SOAP Response
443
ENNI Service Provision SOAP Request
444
ENNI Service Provision SOAP Response
446
modify – CE Services
448
CE Service EPL Modify SOAP Request
448
CE Service EPL Modify SOAP Response
449
CE Service EP-LAN Modify (Add Site) SOAP Request
452
CE Service EP-LAN Modify (Add Site) SOAP Response
454
CE Service EP-LAN Modify (Remove Site) SOAP Request
456
CE Service EP-LAN Modify (Remove Site) SOAP Response
458
UNI Service Modify SOAP Request
460
UNI Service Modify SOAP Response
462
ENNI Service Modify SOAP Request
464
ENNI Service Modify SOAP Response
466
modify – DWDM Services
468
DWDM Service Modify SOAP Request
468
DWDM Service Modify SOAP Response
471
OTN Service Modify SOAP Request
472
OTN Service Modify SOAP Response
474
retrieveServiceStates – CE Services
477
CE Service Retrieve Service States SOAP Request
477
CE Service Retrieve Service States SOAP Response
478
retrieveServiceStates – DWDM / OTN Services
479
DWDM/OTN Services SOAP Request
479
DWDM/OTN Services SOAP Response
480
terminate – DWDM/OTN Services
481
DWDM/OTN Service SOAP Request
481
DWDM/OTN Service SOAP Response
482
terminate – CE Services
484
CE Service Terminate SOAP Request
484
CE Service Terminate SOAP Response
485
Terminate QOS Profile SOAP Request
487
Terminate QOS Profile SOAP Response
488
Terminate UNI / ENNI Service SOAP Request
490
Terminate UNI / ENNI Service SOAP Response
491
Alarm Retrieval
493
getActiveAlarms
493
SOAP Request
493
SOAP Response
494
getActiveAlarmsCount
496
SOAP Request
496
SOAP Response
496
ConnectionControl
497
switchRoute
497
SOAP Request
497
SOAP Response
499
setIntendedRoute
501
SOAP Request
501
SOAP Response
501
TerminationPointControl
503
setTerminationPointData
503
SOAP Request
503
SOAP Response
505
Notification
508
Subscribe Request
508
Subscribe Response
508
UnSubscribe Request
509
UnSubscribe Response
509
Notification Samples
510
Equipment Add
510
ManagedElement Delete
512
Equipment Update
514
SubNetworkConnection - Attribute Value Change
516
Service Provisioning – CFS Created
519
Service Provisioning – CFS Service State Change
521
Service Provisioning – CFS Terminate
524
FDN Value Change Notification
526
Alarm Handling
529
acknowledgeAlarms
529
SOAP Request
529
SOAP Response
530
unacknowledgeAlarms
531
SOAP Request
531
SOAP Response
531
10 References
533

Developer's Guide

Size:

7.29 MB
Pages:

533
Language:

English

Developer's Guide

Table of Contents

Preface
17
Conventions
17
Additional User Documentation
17
Obtaining Documentation, Obtaining Support, and Security Guidelines
17
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
21
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
28
Authorization
28
License
29
MTOSI Interface Details
30
ManagedElementRetrieval
30
4.1.1 Managed Element Data
30
4.1.2 Operations
32
4.1.2.1 getAllManagedElements
32
4.1.2.1.1 Input
32
4.1.2.1.2 Output
32
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
33
4.1.2.3 getManagedElement
33
4.1.2.3.1 Input
33
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
34
4.2.1.2 getManagedElementNamesIterator
34
4.2.1.2.1 Input
34
4.2.1.2.2 Output
34
4.2.1.2.3 Exceptions
34
EquipmentInventoryRetrieval
34
4.3.1 Equipment Data
35
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
37
4.3.2.2.2 Output
37
4.3.2.2.3 Exceptions
37
4.3.2.3 getEquipmentIterator
37
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
38
4.3.2.4.2 Output
38
4.3.2.4.3 Exceptions
38
TerminationPointRetrieval
38
4.4.1 Termination Point Data
38
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
42
4.4.2.2.1 Input
42
4.4.2.2.2 Output
42
4.4.2.2.3 Exceptions
42
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
43
4.4.2.4.3 Exceptions
43
4.4.2.5 getAllSupportedPhysicalTerminationPoints
43
4.4.2.5.1 Input
43
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
44
4.4.2.6.3 Exceptions
44
4.4.2.7 getContainedPotentialConnectionTerminationPoints
44
4.4.2.7.1 Input
44
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
45
4.5.1.1.3 Exceptions
46
4.5.1.2 getSubnetworkConnection
47
4.5.1.2.1 Input
47
4.5.1.2.2 Output
47
4.5.1.2.3 Exceptions
48
4.5.1.3 getSubnetworkConnectionsIterator
49
4.5.1.3.1 Input
49
4.5.1.3.2 Output
49
4.5.1.3.3 Exceptions
50
4.5.1.4 getRoute
51
4.5.1.4.1 Input
51
4.5.1.4.2 Output
51
4.5.1.4.3 Exceptions
51
4.5.1.5 getAllCrossConnections
51
4.5.1.5.1 Input
51
4.5.1.5.2 Output
51
4.5.1.5.3 Exceptions
52
4.5.1.6 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
4.6.1.1 getAllTopologicalLinks
53
4.6.1.1.1 Input
53
4.6.1.1.2 Output
53
4.6.1.1.3 Exceptions
53
4.6.1.2 getTopologicalLink
53
4.6.1.2.1 Input
53
4.6.1.2.2 Output
54
4.6.1.2.3 Exceptions
54
4.6.1.3 getTopologicalLinksIterator
54
4.6.1.3.1 Input
54
4.6.1.3.2 Output
54
4.6.1.3.3 Exceptions
55
4.6.1.4 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
57
Operations getAllFlowDomainFragments
58
4.7.2.1.1 Input
58
4.7.2.1.2 Output
59
4.7.2.1.3 Exceptions
59
4.7.2.2 getFlowDomainFragmentIterator
59
4.7.2.2.1 Input
59
4.7.2.2.2 Output
59
4.7.2.2.3 Exceptions
59
4.7.2.3 getFlowDomainFragment
59
4.7.2.3.1 Input
59
4.7.2.3.2 Output
59
4.7.2.3.3 Exceptions
60
4.7.2.4 getFlowDomainFragmentRoute
60
4.7.2.4.1 Input
60
4.7.2.4.2 Output
60
4.7.2.4.3 Exceptions
61
FlowDomainFragmentNameRetrieval (Carrier Ethernet Inventory)
61
4.8.1 Operations
61
4.8.1.1 getAllFlowDomainFragmentNames
61
4.8.1.1.1 Input
61
4.8.1.1.2 Output
61
4.8.1.1.3 Exceptions
62
4.8.1.2 getFlowDomainFragmentNamesIterator
62
4.8.1.2.1 Input
62
4.8.1.2.2 Output
62
4.8.1.2.3 Exceptions
62
ServiceInventoryRetrieval
62
4.9.1 Customer Facing Service (CFS) Data
62
4.9.2 Service Access Point (SAP) Data
69
4.9.3 Operations
72
4.9.3.1 getServiceInventory
72
4.9.3.1.1 Input
72
4.9.3.1.2 Output
72
4.9.3.1.3 Exceptions
73
4.9.3.2 getServiceInventoryIterator
73
4.9.3.2.1 Input
73
4.9.3.2.2 Output
73
4.9.3.2.3 Exceptions
73
CustomerNameRetrieval
73
4.10.1.1 getAllCustomerNames
73
4.10.1.1.1 Input
74
4.10.1.1.2 Output
74
4.10.1.1.3 Exceptions
74
4.10.1.2 getCustomerNamesIterator
74
4.10.1.2.1 Input
74
4.10.1.2.2 Output
74
4.10.1.2.3 Exceptions
74
QosProfileNameRetrieval
75
4.11.1.1 getAllQosProfileNames
75
4.11.1.1.1 Input
75
4.11.1.1.2 Output
75
4.11.1.1.3 Exceptions
75
4.11.1.2 getQosProfileNamesIterator
75
4.11.1.2.1 Input
75
4.11.1.2.2 Output
75
4.11.1.2.3 Exceptions
76
OpticalLinkInterfaceRetrieval
76
4.12.1 getAllOpticalLinkInterfaces
76
4.12.1.1.1 Input
76
4.12.1.1.2 Output
76
4.12.1.1.3 Exceptions
76
4.12.2 getOpticalLinkInterfacesIterator
77
4.12.2.1.1 Input
77
4.12.2.1.2 Output
77
4.12.2.1.3 Exceptions
77
ServiceActivationInterface
77
4.13.1 Supported Services for Provisioning
77
4.13.2 Error Message Format with Error Codes
78
4.13.2.1 Deploy Result Error or Info message
78
4.13.2.2 List of error codes
79
4.13.3 Service Order Data
79
4.13.3.1 Optical Service Order Data
80
4.13.3.1.1 OTN Service Order Data
80
4.13.3.1.2 OTN Path Options
81
4.13.3.1.3 TRAIL UNI – UNI Config Parameters
82
4.13.3.1.4 TRAIL UNI – UNI Explicit Path
83
4.13.3.1.5 OCH Trail Uni Diversity
83
4.13.3.1.6 DMDM Service Order Data
84
4.13.3.1.7 DMDM Service Constraints
86
4.13.3.1.8 DMDM Channel to Frequency Mapping Grid
87
4.13.3.2 Carrier Ethernet Service Order Data
88
4.13.3.2.1 QinQ Configuration in Order data
95
4.13.3.2.2 Multi-UNI Configuration in Order data
96
4.13.3.3 Carrier Ethernet Endpoint Service Order Data
96
4.13.3.3.1 Carrier Ethernet UNI Endpoint Service Order Data
97
4.13.3.3.2 Carrier Ethernet ENNI Endpoint Service Order Data
98
4.13.3.4 Carrier Ethernet QoS Profile Service Order Data
99
4.13.4 Operations
100
4.13.4.1 Provision
100
4.13.4.1.1 Optical Services
100
4.13.4.1.2 Carrier Ethernet Services
100
4.13.4.1.3 Service Input Data
100
4.13.4.1.4 Input
100
4.13.4.1.5 Provision Response
101
4.13.4.1.6 Output
101
4.13.4.1.7 Exceptions
101
4.13.4.2 modify
101
4.13.4.2.1 Input
102
4.13.4.2.2 Modify Response
102
4.13.4.2.3 Output
102
4.13.4.2.4 Exceptions
103
4.13.4.3 Terminate
103
4.13.4.3.1 Input
103
4.13.4.3.2 Terminate Response
103
4.13.4.3.3 Output
103
4.13.4.3.4 Exceptions
104
4.13.4.4 activate
104
4.13.4.4.1 Input
104
4.13.4.4.2 Activate Response
104
4.13.4.4.3 Output
104
4.13.4.4.4 Exceptions
105
4.13.4.5 deActivate
105
4.13.4.5.1 Input
105
4.13.4.5.2 Activate Response
105
4.13.4.5.3 Output
105
4.13.4.5.4 Exceptions
106
4.13.4.6 retrieveServiceStates
106
4.13.4.6.1 Input
106
4.13.4.6.2 Output
106
4.13.4.6.3 Exceptions
106
Alarm Retrieval
106
4.14.1 Operations
106
4.14.1.1 getActiveAlarms
106
4.14.1.1.1 Input
107
4.14.1.1.2 Output
107
4.14.1.1.3 Exceptions:
108
4.14.1.2 getActiveAlarmsCount
108
4.14.1.2.1 Input
108
4.14.1.2.2 Output
109
4.14.1.2.3 Exceptions:
109
4.14.1.3 getActiveAlarmsIterator
109
4.14.1.3.1 Input
109
4.14.1.3.2 Output
110
4.14.1.3.3 Exceptions
110
TerminationPointControl
110
4.15.1 Operations
110
4.15.1.1 setTerminationPointData
110
4.15.1.1.1 Input
110
4.15.1.1.2 Supported Parameter Name and Value Table
110
NOTE:
113
4.15.1.1.3 Output
113
4.15.1.1.4 Exceptions:
114
ConnectionControl
114
4.16.1 Operations
114
4.16.1.1 switchRoute
114
4.16.1.1.1 Output
114
4.16.1.1.2 Exceptions
114
4.16.1.2 setIntendedRoute
115
4.16.1.2.1 Output
115
Exceptions:
115
ProtectionProfileControl
116
4.17.1 ProtectionProfileDataType
116
4.17.2 Operations
116
4.17.2.1 CreateProtectionProfile
116
4.17.2.1.1 Input
116
4.17.2.1.2 Output
116
4.17.2.1.3 Exceptions
117
4.17.2.2 ModifyProtectionProfile
117
4.17.2.2.1 Input
117
4.17.2.2.2 Output
117
4.17.2.2.3 Exceptions
117
4.17.2.3 DeleteProtectionProfile
117
4.17.2.3.1 Input
117
4.17.2.3.2 Output
118
4.17.2.3.3 Exceptions
118
ProtectionProfileRetrieval
118
4.18.1.1 getAllProtectionProfiles
118
4.18.1.1.1 Input
118
4.18.1.1.2 Output
118
4.18.1.1.3 Exceptions
119
4.18.1.2 getProtectionProfile
119
4.18.1.2.1 Input
119
4.18.1.2.2 Output
119
4.18.1.2.3 Exceptions
119
4.18.1.3 getAllSubnetworkConnectionsWithProtectionProfile
120
4.18.1.3.1 Input
120
4.18.1.3.2 Output
120
4.18.1.3.3 Exceptions
120
MPLSTEExplicitPathControl
120
4.19.1 MPLSTEExplicitPathDataType
120
4.19.2 Operations
121
4.19.2.1 CreateMPLSTEExplicitPath
121
4.19.2.1.1 Input
121
4.19.2.1.2 Output
121
4.19.2.1.3 Exceptions
121
4.19.2.2 ModifyMPLSTEExplicitPath
121
4.19.2.2.1 Input
121
4.19.2.2.2 Output
122
4.19.2.2.3 Exceptions:
122
4.19.2.3 DeleteMPLSTEExplicitPath
122
4.19.2.3.1 Input
122
4.19.2.3.2 Output
122
4.19.2.3.3 Exceptions
122
MPLSTEExplicitPathRetrieval
122
4.20.1.1 getAllMPLSTEExplicitPaths
122
4.20.1.1.1 Input
123
4.20.1.1.2 Output
123
4.20.1.1.3 Exceptions
123
4.20.1.2 getMPLSTEExplicitpath
123
4.20.1.2.1 Input
123
4.20.1.2.2 Output
123
4.20.1.2.3 Exceptions
123
4.20.1.3 getAllSubnetworkConnectionsWithExplicitPath
123
4.20.1.3.1 Input
124
4.20.1.3.2 Output
124
4.20.1.3.3 Exceptions
124
Notifications
124
4.21.1 Notification Support Matrix
124
4.21.1.1 Service Provisioning Notifications Matrix
124
4.21.2 Notification Subscribe Interface
125
4.21.2.1.1 Input
125
Alarm Handling
125
4.22.1 Operations
125
4.22.1.1 acknolwledgeAlarms
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 unacknolwledgeAlarms
126
4.22.1.2.1 Input
126
4.22.1.2.2 Output
126
4.22.1.2.3 Exceptions
126
Cisco-Specific Interfaces
127
Troubleshooting
128
Appendix I – WSDL Document References
129
MTOSI WSDL Documents
129
Appendix II – Example Java Client to Retrieve Inventory
130
Appendix III – Sample SOAP Request Response
132
getAllManagedElements
132
9.1.1 SOAP Request
132
9.1.2 SOAP Response
132
getAllManagedElementsIterator
137
SOAP Request
137
SOAP Response
138
getManagedElement
141
SOAP Request
141
SOAP Response
141
getAllEquipment
143
9.4.1 SOAP Request
143
9.4.2 SOAP Response
144
getEquipment
151
SOAP Request
151
SOAP Response
151
getContainedEquipment
153
SOAP Request
153
SOAP Response
154
getEquipmentIterator
159
SOAP Request
159
SOAP Response
159
getAllCrossConnections
162
SOAP Request
162
SOAP Response
162
getAllSubnetworkConnectionsWithTP
166
SOAP Request
166
SOAP Response
166
getAllPhysicalTerminationPoints
170
SOAP Request
170
SOAP Response
171
getTerminationPointsIterator
178
SOAP Request
178
SOAP Response
178
getAllFloatingTerminationPoints
191
SOAP Request
191
SOAP Response
192
getTerminationPoint
207
SOAP Request
207
SOAP Response
207
getAllSupportedPhysicalTerminationPoints
209
SOAP Request
209
SOAP Response
210
getContainedPotentialConnectionTerminationPoints
215
SOAP Request
215
SOAP Response
216
getContainedInUseConnectionTerminationPoints
219
SOAP Request
219
SOAP Response
219
getAllSubnetworkConnections
221
SOAP Request
221
SOAP Response
222
getSubnetworkConnection
225
SOAP Request
225
SOAP Response
226
SOAP Response – SNC with Diverse From Circuit Reference
228
getSubnetworkConnectionsIterator
231
SOAP Request
231
SOAP Response
231
getRoute
234
SOAP Request
234
SOAP Response
234
getAllTopologicalLinks
239
SOAP Request
239
SOAP Response
239
getTopologicalLink
249
SOAP Request
249
SOAP Response
249
getTopologicalLinksIterator
252
SOAP Request
252
SOAP Response
252
getRouteAndTopologicalLinks
260
SOAP Request
260
SOAP Response - OCHTrail
261
SOAP Response – ODU-UNI
276
SOAP Response – OCHNC
280
getAllFlowDomainFragments
285
SOAP Request
285
SOAP Response
285
getFlowDomainFragment
313
SOAP Request
313
SOAP Response
314
getFlowDomainFragmentRoute
318
SOAP Request
318
SOAP Response
318
getFlowDomainFragmentsIterator
323
SOAP Request
323
SOAP Response
323
getAllFlowDomainFragmentNames
339
SOAP Request
339
SOAP Response
340
getFlowDomainFragmentNamesIterator
351
SOAP Request
351
SOAP Response
352
getAllOpticalLinkInterfaces
356
SOAP Request
356
SOAP Response
357
getAllCustomerNames
358
SOAP Request
358
SOAP Response
358
getAllQosProfileNames
360
SOAP Request
360
SOAP Response
360
getProtectionProfile
361
SOAP Request
361
SOAP Response
362
getAllProtectionProfiles
363
SOAP Request
363
SOAP Response
363
createProtectionProfile
367
SOAP Request
367
SOAP Response
368
modifyProtectionProfile
369
SOAP Request
369
SOAP Response
371
deleteProtectionProfile
372
SOAP Request
372
SOAP Response
373
getMPLSTEExplicitPath
374
SOAP Request
374
SOAP Response
374
getAllMPLSTEExplicitPaths
377
SOAP Request
377
SOAP Response
377
createMPLSTEExplicitPath
390
SOAP Request
390
SOAP Response
392
modifyMPLSTEExplicitPath
394
SOAP Request
394
SOAP Response
394
deleteMPLSTEExplicitPath
396
SOAP Request
396
SOAP Response
396
getServiceInventory for CFS Data
398
CE Service SOAP Request
398
CE Service SOAP Response
399
DWDM/OTN Service SOAP Request
403
DWDM/OTN Service SOAP Response
404
getServiceInventory for SAP Data
409
CE Service SOAP Request
409
CE Service SOAP Response
409
CE Service SAP SOAP Response for QinQ
411
DWDM/OTN Service SOAP Resquest
413
DWDM/OTN Service SOAP Response
414
provision - DWDM services
418
DWDM Services SOAP Request
418
DWDM Services SOAP Response
423
provision – OTN services
425
OTN Services SOAP Request
425
OTN Services SOAP Response
427
provision –TRAIL-UNI services
429
TRAIL-UNI Services SOAP Request
429
TRAIL-UNI Services SOAP Response
431
TRAIL-UNI Services with Diversity SOAP Request
434
TRAIL-UNI Services with Diversity SOAP Response
437
TRAIL-UNI Services with Explicit Path SOAP Request
440
TRAIL-UNI Services with Explicit Path SOAP Response
443
provision – Carrier Ethernet Services
446
EPL Provision SOAP Request
446
EPL Provision SOAP Response
448
EVPL Provision SOAP Request
451
EVPL Provision SOAP Response
454
EVPL Provision with QinQ Configuration - SOAP Request
456
EVPL Provision with QinQ Configuration - SOAP Response
460
Access EPL Provision SOAP Request
464
Access EPL Provision SOAP Response
467
Access EVPL Provision SOAP Request
469
Access EVPL Provision SOAP Response
472
Access EVPL Provision with QinQ Configuration - SOAP Request
474
Access EVPL Provision with QinQ Configuration - SOAP Response
478
EP-LAN Provision SOAP Request
481
EP-LAN Provision SOAP Response
483
EVP-LAN Provision SOAP Request
486
EVP-LAN Provision SOAP Response
488
EVP-LAN Provision with Multi-UNI Configuration - SOAP Request
490
EVP-LAN Provision with Multi-UNI Configuration - SOAP Response
493
EP-Tree Provision SOAP Request
496
EP-Tree Provision SOAP Response
499
EVP-Tree Provision SOAP Request
500
EVP-Tree Provision SOAP Response
503
QOS Profile Provision SOAP Request
504
QOS Profile Provision SOAP Response
507
UNI Service Provision SOAP Request
509
UNI Service Provision SOAP Response
511
ENNI Service Provision SOAP Request
512
ENNI Service Provision SOAP Response
514
modify – CE Services
516
CE Service EPL Modify SOAP Request
516
CE Service EPL Modify SOAP Response
517
CE Service EP-LAN Modify (Add Site) SOAP Request
520
CE Service EP-LAN Modify (Add Site) SOAP Response
522
CE Service EP-LAN Modify (Remove Site) SOAP Request
524
CE Service EP-LAN Modify (Remove Site) SOAP Response
526
UNI Service Modify SOAP Request
528
UNI Service Modify SOAP Response
530
ENNI Service Modify SOAP Request
532
ENNI Service Modify SOAP Response
534
modify – DWDM Services
536
DWDM Service Modify SOAP Request
536
DWDM Service Modify SOAP Response
539
OTN Service Modify SOAP Request
540
OTN Service Modify SOAP Response
542
retrieveServiceStates – CE Services
545
CE Service Retrieve Service States SOAP Request
545
CE Service Retrieve Service States SOAP Response
546
retrieveServiceStates – DWDM / OTN Services
547
DWDM/OTN Services SOAP Request
547
DWDM/OTN Services SOAP Response
548
terminate – DWDM/OTN Services
549
DWDM/OTN Service SOAP Request
549
DWDM/OTN Service SOAP Response
550
terminate – CE Services
552
CE Service Terminate SOAP Request
552
CE Service Terminate SOAP Response
553
Terminate QOS Profile SOAP Request
555
Terminate QOS Profile SOAP Response
556
Terminate UNI / ENNI Service SOAP Request
558
Terminate UNI / ENNI Service SOAP Response
559
Alarm Retrieval
561
9.56.1 getActiveAlarms
561
9.56.1.1 SOAP Request
561
9.56.1.2 SOAP Response
562
9.56.2 getActiveAlarmsCount
563
9.56.2.1 SOAP Request
563
9.56.2.2 SOAP Response
564
ConnectionControl
564
9.57.1 switchRoute
564
9.57.1.1 SOAP Request
564
9.57.1.2 SOAP Response
566
9.57.2 setIntendedRoute
568
9.57.2.1 SOAP Request
568
9.57.2.2 SOAP Response
569
TerminationPointControl
571
9.58.1 setTerminationPointData
571
9.58.1.1 SOAP Request
571
9.58.1.2 SOAP Response
574
Notification
577
Subscribe Request
577
Subscribe Response
577
UnSubscribe Request
578
UnSubscribe Response
578
Notification Samples
579
Equipment Add
579
ManagedElement Delete
581
Equipment Update
583
SubNetworkConnection - Attribute Value Change
585
Service Provisioning – CFS Created
588
Service Provisioning – CFS Service State Change
590
Service Provisioning – CFS Terminate
593
FDN Value Change Notification
595
Alarm Handling
598
9.61.1 acknowledgeAlarms
598
9.61.1.1 SOAP Request
598
9.61.1.2 SOAP Response
599
9.61.2 unacknowledgeAlarms
599
9.61.2.1 SOAP Request
599
9.61.2.2 SOAP Response
600
References
602

Developer's Guide

Size:

7.92 MB
Pages:

602
Language:

English

Release Notes

Size:

312 KB
Pages:

16
Language:

English

Release Notes

Size:

202 KB
Pages:

12
Language:

English

User Guide

Size:

276 KB
Pages:

1
Language:

English

Release Notes

Size:

186 KB
Pages:

10
Language:

English

Licensing Information

Licensing Information

Size:

5.75 MB
Pages:

2858
Language:

English

Release Notes

Size:

334 KB
Pages:

20
Language:

English

Documentation Roadmaps

Documentation Roadmaps

Size:

156 KB
Pages:

6
Language:

English

Release Notes

Size:

274 KB
Pages:

14
Language:

English

Release Notes

Size:

194 KB
Pages:

10
Language:

English