Cisco Cisco Prime Optical 10.6 manuals

Technical References

Notice
2
Table of Contents
3
List of Tables
9
- Updates for Version 3.0
  13
- Updates for Version 3.5
  13
- Overview
  14
  - FIS Template
    14
  - Data Types
    14
  - Interfaces
    16
  - Operations
    17
  - Exceptions
    19
  - Notifications
    19
- Alarm Severity Assignment Profile (v3.0)
  23
  - Data Types
    23
  - Interfaces
    23
  - Notifications
    24
- Call SNC Module (v3.5)
  24
  - Data Types
    24
  - Interfaces
    26
  - Notifications
    26
- Common Module
  26
  - Data Types
    26
  - Interfaces
    26
  - Notifications
    27
- EmsMgr Module
  27
  - Data Types
    27
  - Interfaces
    28
  - Notifications
    29
- EMS Session Module
  29
  - Data Types
    29
  - Interfaces
    29
  - Notifications
    29
- EmsSessionFactory
  29
  - Data Types
    29
  - Interfaces
    30
  - Notifications
    30
- Equipment Module
  30
  - Data Types
    30
  - Interfaces
    33
  - Notifications
    34
- FlowDomain Module
  34
  - Data Types
    34
  - Interfaces
    38
  - Notifications
    39
- FlowDomainFragment Module
  39
  - Data Types
    39
  - Interfaces
    41
  - Notifications
    41
- Globaldefs Module
  42
  - Data Types
    42
  - Interfaces
    42
  - Notifications
    42
- GuiCutThrough Module
  42
  - Data Types
    42
  - Interfaces
    43
  - Notifications
    43
- MaintenanceOperations Module
  43
  - Data Types
    43
  - Interfaces
    43
  - Notifications
    44
- Managed Element Module
  44
  - Data Types
    44
  - Interfaces
    45
  - Notifications
    45
- ManagedElementManager Module
  45
  - Data Types
    45
  - Interfaces
    45
  - Notifications
    46
- MLSNPP Module
  46
  - Data Types
    46
  - Interfaces
    47
  - Notifications
    47
- MLSNPP Link Module
  47
  - Data Types
    47
  - Interfaces
    48
  - Notifications
    48
- MTNM Version Module
  49
  - Data Types
    49
  - Interfaces
    49
  - Notifications
    49
- MultiLayerSubnetwork Module
  49
  - Data Types
    49
  - Interfaces
    50
  - Notifications
    53
- NMS Session Module
  53
  - Data Types
    53
  - Interfaces
    53
  - Notifications
    53
- Notifications Module
  54
  - Data Types
    54
  - Interfaces
    54
  - Notifications
    54
- Performance Module
  54
  - Data Types
    54
  - Interfaces
    56
  - Notifications
    57
- Protection Module
  57
  - Data Types
    57
  - Interfaces
    58
  - Notifications
    59
- Session Module
  59
  - Data Types
    59
  - Interfaces
    59
  - Notifications
    59
- SoftwareAndDataManager Module (v3.0)
  59
  - Data Types
    59
  - Interfaces
    59
  - Notifications
    60
- Subnetwork Connection Module
  60
  - Data Types
    60
  - Interfaces
    68
  - Notifications
    68
- Termination Point Module
  68
  - Data Types
    68
  - Interfaces
    71
  - Notifications
    71
- Topological Link Module
  72
  - Data Types
    72
  - Interfaces
    73
  - Notifications
    73
- Traffic Conditioning Profile Module (v3.5)
  73
  - Data Types
    73
  - Interfaces
    74
  - Notifications
    75
- TrafficDescriptor Module
  75
  - Data Types
    75
  - Interfaces
    76
  - Notifications
    76
- Transmission Descriptor Module (v3.0)
  76
  - Data Types
    76
  - Interfaces
    78
  - Notifications
    79
- Transmission Parameters Module
  79
  - Data Types
    79
  - Interfaces
    79
  - Notifications
    79
- Miscellaneous
  79
  - Version of CORBA and CORBA Services
    79
  - Usage of the OMG Notification Service
    80
  - Proprietary LayerRates
    81
  - SNC Type Transitions Related to the ModifySNC Operation
    82
- Iterator Implementation Issues
  85
- Timing Issues
  85
- Implementation-specific Use Cases
  87
- EMS Subnetwork Configuration
  87
- Usage of the Various Resource Names
  88
- SNC State Representations – Modes
  90
  - Mode A
    90
  - Mode B
    91
  - Mode C
    91
  - Mode D
    91
- Example Probable Cause Template
  91
- Mapping of MTNM Services States to Other Models
  93
  - Mapping to Telcordia State Model (GR-1093-CORE)
    93
  - Mapping to ITU-T States
    95
- Usage of Network Access Domains (NADs)
  95
- Root Cause Alarm Indication
  96
- FTP Examples
  96

Size:

1.23 MB
Pages:

115
Language:

English

Open manual

Developer's Guide

Preface
12
Objectives
12
Audience
12
Conventions
12
Related Documentation
13
Obtaining Documentation and Submitting a Service Request
17
1. Overview of Cisco Prime Optical GateWay/CORBA
18
1.1 Hardware Modifications
19
1.2 Features of GateWay/CORBA
20
1.3 GateWay/CORBA Fault Management
20
1.4 Overview of CORBA Services
20
Naming Service
20
Notification Service
21
1.5 Information Model
22
1.6 IDL-Related Changes
23
1.7 Functionalities Not Supported in Prime Optical 10.6
24
1.8 Summary
25
2 NE- and Cisco Prime Optical-Specific Details
27
2.1 NE-Specific Details
27
ONS 15216
27
ONS 15305 and ONS 15305 CTC
27
ONS 15310 CL
28
ONS 15310 MA SDH
30
ONS 15310 MA SONET
30
ONS 15327
31
ONS 15454 SDH
33
ONS 15454 SONET
36
ONS NCS2K SDH
38
ONS NCS2K SONET
38
ONS 15600 SONET
38
ONS 15600 SDH
40
Carrier Packet Transport 200/600 SONET/SDH
41
Unmanaged NEs
41
2.2 Prime Optical-Specific Details
41
Layer Rate
41
Inventory
45
Interfaces
46
Object Details
47
Naming Conventions
48
Programming Details
62
Provisioning Subnetwork Connections
63
3 Using GateWay/CORBA Interfaces
77
3.1 Overview of APIs Supported by NE Type
77
3.2 common::Common_I
112
common::Common_I:: getCapabilities
112
3.3 emsMgr::EMSMgr_I
113
TMF 3.0 Alarm Data Structures and Parameters
113
AlarmAndTCAIDList_T
113
TCAId_T
113
AlarmOrTCAIdentifier_T
114
acknowledgeAlarms
114
unacknowledgeAlarms
115
getAllEMSAndMEUnacknowledgedActiveAlarms
116
getAllEMSSystemUnacknowledgedActiveAlarms
116
setAdditionalInfo
117
getAllEMSAndMEActiveAlarms
117
getAllEMSSystemActiveAlarms
118
getAllTopLevelSubnetworks
119
getAllTopLevelSubnetworkNames
120
getAllTopLevelTopologicalLinks
121
getAllTopLevelTopologicalLinkNames
123
getTopLevelTopologicalLink
123
createTopologicalLink
124
createTopologicalLinkWithYCableProtection
127
deleteTopologicalLink
128
modifyTopologicalLink
129
getEMS
130
getAllL2Topologies
131
getAllQoSTemplateNames
133
getAllQoSTemplates
134
getQoSTemplate
136
getAllEMSandMEClearedAlarms
136
getAllEMSSystemClearedAlarms
137
Passive Unit EMS Alarms
138
createServerTrailLink
138
deleteServerTrailLink
140
addNetworkPartition
141
addMultiLayerSubnetwork
141
deleteNetworkPartition
142
deleteMultiLayerSubnetwork
143
getAllSupportedMEModels
143
EmsSession::EmsSession_I
144
getEventChannel
144
GetManager
144
getSupportedManagers
145
emsSessionFactory::EmsSessionFactory_I
145
getEmsSession
146
getEmsPublicKey
147
getEmsPublicKeyPair
147
equipment::EquipmentInventoryMgr_I
148
getAllEquipment
148
getAllEquipmentNames
157
getAllSupportedPTPs
157
getAllSupportedPTPNames
174
getAllSupportingEquipment
175
getAllSupportingEquipmentNames
175
getContainedEquipment
176
getEquipment
177
provisionEquipment
184
setAlarmReportingOff
185
setAlarmReportingOn
186
unprovisionEquipment
187
maintenanceOps::MaintenanceMgr_I
188
getActiveMaintenanceOperations
188
performMaintenanceOperation
189
managedElementManager::ManagedElementManager_I
191
getAllActiveAlarms
191
getAllSNCs
192
getAllManagedElements
193
getAllManagedElementNames
195
getAllPTPs
196
getAllPTPNames
198
getContainedInUseTPs
199
getContainedInUseTPNames
200
getContainedPotentialTPs
201
getContainedPotentialTPNames
202
getContainingSubnetworkNames
203
getManagedElement
204
getAllCTMMEInternalPatchcord
204
setAdditionalInfo
205
getTP
206
getAssociatedTopologicalLinks
208
setTPData
208
getAllSrcPTPsForSNCProvisioning
211
getAllSrcCTPsForSNCProvisioning
212
getAllSrcCTPsForVCATMemberSNCProvisioning
213
getAllDestPTPsForSNCProvisioning
214
getAllDestCTPsForSNCProvisioning
215
getAllDestCTPsForVCATMemberSNCProvisioning
216
getAllSrcFTPsForSNCProvisioning
217
getAllDestFTPsForSNCProvisioning
218
forceNEResync
219
getAllTopologicalLinksForME
219
getAllRolls
220
getAllRollNames
221
getRoll
222
getRollToPTPs
223
getRollToCTPs
223
getRollFromCTPs
224
setPortName
225
getPortName
226
getAllClearedAlarms
226
getAllCrossConnections
227
getAllSoftwareDownloadJobs
229
setMEAdminState
230
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I
231
getAllEdgePoints
231
getAllEdgePointNames
232
getAllManagedElement
233
getAllManagedElementNames
234
getAllSubnetworkConnections
235
getAllSubnetworkConnectionsWithTP
236
getAllSubnetworkConnectionNames
237
getAllSubnetworkConnectionNamesWithTP
238
getAllTopologicalLinks
239
getAllTopologicalLinkNames
240
getMultiLayerSubnetwork
241
getCTPsAndTopologicalLinks
241
getSNC
243
getSNCsByUserLabel
243
getTopologicalLink
244
createAndActivateSNCFromUserLabel
245
CreateAndActivateSNC
255
(Deprecated) createAndActivateProtectedOchccFromUserLabel
256
addDrops
256
deactivateAndDeleteSNC
257
getVCATSNC
259
getAllVCATSNCs
260
getAllVCATSNCNames
262
getAllVCATMemberSNCs
263
getAllVCATMemberSNCNames
264
createVCAT
264
deleteVCAT
266
addMemberSNCsToVCAT
267
deleteMemberSNCsFromVCAT
268
deleteAllMemberSNCFromVCAT
268
getValidSubnetworkConnectionsForMerge
269
upgrade
271
createRoll
272
deleteRoll
274
cancelRoll
275
forceValidSignal
275
completeRoll
276
finishRoll
276
getAllRolls
277
getAllRollNames
277
getAssociatedRollNamesForSNC
278
getAssociatedSNCNamesForRoll
278
createAndActivateSNCOnDRI
279
addManagedElement
281
deleteManagedElement
285
3.10 L2 Topology and ML VLAN for ML-Series Ethernet Cards
286
createMLVLAN
286
modifyMLVLANAddFrontPorts
289
modifyMLVLANDropFrontPorts
290
modifyMLVLANPortState
291
modifyMLVLANRSTPState
292
modifyMLVLANTPQOS
293
modifyMLVLANCustomerIDServiceID
294
getMLVLAN
295
deleteMLVLAN
295
3.10.10 getAllMLVLANs
296
3.10.11 getAllMLVLANNames
296
3.10.12 getAllAssociatedSNCs
297
3.10.13 getL2Topology
298
3.10.14 getAssociatedL2TopologyForSNC
299
3.10.15 getAssociatedL2TopologyForMLVLAN
299
3.10.16 createL2Topology
300
3.10.17 deleteL2Topology
308
3.10.18 modifyL2Topology
309
3.10.19 getAllAvailableMLEquipmentOrTPNames
309
E-Series VLAN Interfaces
310
createVLAN
311
deleteVLAN
311
getAllVLANs
312
modifySNC
312
nmsSession::NmsSession_I
316
historyPMDataCompleted
316
historyPMDataFailed
316
operationInfo
317
alarmLossOccurred
317
performance::PerformanceManagementMgr_I
317
disablePMData
318
enablePMData
319
setTCATPParameter
319
getTCATPParameter
377
getCTMHistoryPMData
378
getCTMValidHistoryPMData
380
deleteHistoryPMDataFile
381
getTPHistoryPMData
381
getHoldingTime
384
3.13.10 getAllCurrentPMData
385
3.13.11 getMEPMcapabilities
386
3.13.12 Passive Unit EMS PM
386
protection::ProtectionMgr_I
387
getAllProtectedTPNames
387
getAllProtectionGroups
388
getProtectionGroup
389
performProtectionCommand
390
createProtectionGroup
392
deleteProtectionGroup
396
getAssociatedProtectionGroup
397
session::Session_I
397
endSession
397
ping
398
mtnmVersion::Version_I
398
getVersion
398
cpoEmsManager:: CpoEmsManager_I
399
getAllEMSAndMEUnacknowledgedActiveAlarms
399
cpoManagedElementManager_I:: CpoManagedElementManager_I
400
getAllUnacknowledgedActiveAlarms
400
Transmission Descriptor Interfaces
401
getAllTransmissionDescriptors
401
getAllTransmissionDescriptorsNames
402
getTransmissionDescriptor
403
getAssociatedTPs
404
createTransmissionDescriptor
404
deleteTransmissionDescriptor
405
3.20 Software and Data Manager Interface
406
backupME
406
getMEBackupStatus
407
abortMEBackup
408
getBackupList
408
activateSoftwareOnME
409
revertSoftwareOnME
410
restoreME
410
getMERestoreStatus
411
abortMERestore
411
3.20.10 getAllSupportedMESoftwareVersions
412
3.20.11 downloadMESoftware
413
3.20.12 addSupportedMESoftwareVersion
415
3.20.13 getSWDownloadStatus
416
4.1 Understanding Key Concepts
417
Ethernet Virtual Circuit
417
Connectionless Port Termination Point
420
Matrix Flow Domain
421
Flow Domain
422
EVC Flow Domain Fragment
422
Link Aggregation
423
MPLS and MPLS-TP
424
MPLS-TP Tunnel
425
MPLS-TP LSP
426
Pseudowire
426
Pseudowire Flow Domain Fragment
427
4.2 Interface Managers
427
4.3 Entity Characteristics
429
Entity Naming
429
Entity Iterators
430
Entity Notifications
432
4.4 Supported Provisioning Interfaces
440
4.5 EVC Provisioning Interfaces
442
CPTP Provisioning Interfaces
442
MFD Provisioning Interfaces
445
Flow Domain Provisioning Interfaces
452
EVC FDFr Provisioning Interfaces
459
Link Aggregation Provisioning Interfaces
468
Traffic Conditioning Profile Provisioning Interfaces
475
4.6 MPLS-TP Provisioning Interfaces
483
MPLS-TP Tunnel Provisioning Interfaces
483
MPLS-TP LSP Provisioning Interfaces
489
MPLS-TP Protection (Provisioning)
493
BFD Template, Node ID, and Label Range Provisioning Interface
494
4.7 Pseudowire Provisioning Interfaces
495
Pseudowire FDFr Provisioning Interfaces
495
Pseudowire Mixed Configuration (Provisioning)
506
Pseudowire Class and Loopback Provisioning Interface
506
Pseudowire QoS Provisioning Interface
510
4.8 Supported Inventory Interfaces
511
4.9 EVC Inventory Interfaces
513
CPTP Inventory Interfaces
513
MFD Inventory Interfaces
516
Flow Domain Inventory Interfaces
519
EVC FDFr Inventory Interfaces
521
Link Aggregation Inventory Interfaces
525
Common Inventory Interface
530
Traffic Conditioning Profile Inventory Interfaces
530
4.10 MPLS-TP Inventory Interfaces
531
MPLS-TP Tunnel Inventory Interfaces
531
MPLS-TP LSP Inventory Interfaces
534
MPLS-TP Tunnel Link Inventory Interfaces
536
MPLS-TP LSP Route Inventory Interfaces
538
MPLS-TP Protection (Inventory)
540
Interface
541
4.11 Pseudowire Inventory Interfaces
543
Pseudowire FDFr Inventory Interfaces
543
Pseudowire Class, Loopback, and QoS Policy Inventory Interface
552
4.12 Alarm Summaries
555
Alarm Summary Example—Channel Group Port
556
Pseudowire Alarm Event Example
557
MPLS-TP Tunnel Alarm Event Example
558
Channel Group Alarm Event Example
558
4.13 Error Messages
559
MPLS-TP Tunnel Error Messages
559
LSP Error Messages
560
Pseudowire Error Messages
560
EVC Error Messages
561
FD, MFD, and CPTP Error Messages
562
5.1 Overview of Notifications
563
5.2 Tips to Improve Notification Throughput
564
5.3 Supported Events
564
Object Creation
564
Object Deletion
565
Attribute Value Change
566
State Change Event
572
Protection Switch
573
Threshold Crossing Alert
574
Alarm
574
Heartbeat Event
575
Backup Status Event
576
5.4 Unsupported Events
576
5.5 Probable Cause Mapping
576
TMF-Defined Probable Cause
576
GateWay/CORBA Mapping—EMS
578
GateWay/CORBA Mapping—ONS 15216
578
5.5.4 GateWay/CORBA Mapping—ONS 15305 and ONS 15305 CTC
579
CPT 600, and CPT 600 SDH
582
CPT 600 SDH
598
GateWay/CORBA Mapping—PTS
598
GateWay/CORBA Mapping—ONS 15600 SONET
600
GateWay/CORBA Mapping—ONS 15600 SDH
607
6.1 Creating an OSS Client Profile for GateWay/CORBA
614
6.2 Deleting an OSS Client Profile for GateWay/CORBA
614
6.3 Viewing Currently Logged In GateWay/CORBA OSS Users
615
6.4 Logging Out GateWay/CORBA OSS Users
615
6.5 Using Encryption Between the OSS Client and GateWay/CORBA
616
6.6 Using Multiple Naming Servers
616
6.7 Naming Conventions for Published GateWay/CORBA Objects
617
6.8 Location of the Naming Service IOR File
618
6.9 Useful Debugging Utilities for Resolving Naming Service-Related Issues
618
6.10 Configuring GateWay/CORBA
619
6.11 Using the CLI to Start and Stop GateWay/CORBA
620
6.12 Configuring Secure Socket Layer for GateWay/CORBA
621
Generating the Server-Side Certificate
621
Generating the Client-Side Certificate
622
Adding the Client-Side Certificate to the Server-Side Keystore
623
Adding the Server-Side Certificate to the Client-Side Keystore
623
Configuring the Client-Side Properties
624
6.13 Installation Program
624
6.14 Cisco Prime Optical 9.8-to-Cisco Prime Optical 10.6 Migration
624
7.1 Use Cases to Resynchronize the NMS from the EMS
625
7.2 Developing a GateWay/CORBA Client
629
Recommended Tools
629
Sample Code in Java
629
Running the Client
637
Known Interoperability Issues When Using Orbix
637
8.1 Equipment List for ONS 15216
638
8.2 Equipment List for ONS 15305
639
8.3 Equipment List for ONS 15305 CTC
639
8.4 Equipment List for ONS 15310 CL
640
8.5 Equipment List for ONS 15310 MA SDH
640
8.6 Equipment List for ONS 15310 MA SONET
640
8.7 Equipment List for ONS 15327
641
8.8 Equipment List for ONS 15454 SDH
641
8.9 Equipment List for ONS 15454 SONET
643
8.10 Equipment List for ONS 15454-M2
646
8.11 Equipment List for ONS 15454-M6
647
8.12 Equipment List for CPT 200, CPT 200 SDH, CPT 600, and CPT 600 SDH
647
8.13 Equipment List for ONS 15600 SDH
648
8.14 Equipment List for ONS 15600 SONET
648
8.15 Equipment List for Unmanaged NEs
649
8.16 CRS1 and CRS3 NEs
649
8.17 Equipment List for ONS NCS2K SONET and ONS NCS2K SDH
649
9 Layered Parameters and Layer Rates
653
10 Payloads and Layer Rates Matrix
659
11 PTP dataRate attribute
664

Size:

27.1 MB
Pages:

665
Language:

English

Open manual

Information Guide

Size:

178 KB
Pages:

1
Language:

English

Open manual

Licensing Information

Size:

1.32 MB
Pages:

362
Language:

English

Open manual

Release Notes

Size:

164 KB
Pages:

8
Language:

English

Open manual

Technical References

Size:

202 KB
Pages:

8
Language:

English

Open manual

Documentation Roadmaps

Size:

123 KB
Pages:

2
Language:

English

Open manual

Cisco Cisco Prime Optical 10.6 User Manuals

Installation Guide

Table of Contents

Technical References

Table of Contents

Developer's Guide

Table of Contents

Information Guide

Licensing Information

Release Notes

Technical References

Documentation Roadmaps