Cisco Cisco Prime Optical 9.8 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:

3.67 MB
Pages:

115
Language:

English

Open manual

Developer's Guide

Preface
17
Objectives
17
Audience
17
Conventions
17
Related Documentation
18
Obtaining Documentation and Submitting a Service Request
22
Overview of Cisco Prime Optical GateWay/CORBA
23
1.1 Features of GateWay/CORBA
25
1.2 GateWay/CORBA Fault Management
26
1.3 Overview of CORBA Services
26
Naming Service
26
Notification Service
26
1.4 Information Model
28
1.5 IDL-Related Changes
28
1.6 Functionalities Not Supported in Prime Optical 9.8
30
1.7 Summary
31
NE- and Cisco Prime Optical-Specific Details
32
2.1 NE-Specific Details
32
ONS 15216
32
ONS 15305 and ONS 15305 CTC
32
ONS 15310 CL
33
ONS 15310 MA SDH
35
ONS 15310 MA SONET
36
ONS 15327
37
ONS 15454 SDH
40
ONS 15454 SONET
42
ONS 15600 SONET
45
ONS 15600 SDH
48
Carrier Packet Transport 200/600 SONET/SDH
49
Unmanaged NEs
49
2.2 Prime Optical-Specific Details
49
Layer Rate
49
Inventory
53
Interfaces
54
Object Details
55
Naming Conventions
56
Programming Details
70
Provisioning Subnetwork Connections
72
Using GateWay/CORBA Interfaces
83
3.1 Overview of APIs Supported by NE Type
83
3.2 common::Common_I
115
common::Common_I:: getCapabilities
115
3.3 emsMgr::EMSMgr_I
116
TMF 3.0 Alarm Data Structures and Parameters
116
AlarmAndTCAIDList_T
116
TCAId_T
117
AlarmOrTCAIdentifier_T
117
acknowledgeAlarms
118
unacknowledgeAlarms
118
getAllEMSAndMEUnacknowledgedActiveAlarms
119
getAllEMSSystemUnacknowledgedActiveAlarms
120
setAdditionalInfo
121
getAllEMSAndMEActiveAlarms
121
getAllEMSSystemActiveAlarms
123
getAllTopLevelSubnetworks
124
getAllTopLevelSubnetworkNames
125
getAllTopLevelTopologicalLinks
126
getAllTopLevelTopologicalLinkNames
128
getTopLevelTopologicalLink
129
createTopologicalLink
130
createTopologicalLinkWithYCableProtection
133
deleteTopologicalLink
135
modifyTopologicalLink
136
getEMS
138
getAllL2Topologies
139
getAllQoSTemplateNames
142
getAllQoSTemplates
142
getQoSTemplate
145
getAllEMSandMEClearedAlarms
146
getAllEMSSystemClearedAlarms
147
Passive Unit EMS Alarms
148
createServerTrailLink
148
deleteServerTrailLink
151
addNetworkPartition
151
addMultiLayerSubnetwork
152
deleteNetworkPartition
153
deleteMultiLayerSubnetwork
154
getAllSupportedMEModels
154
3.4 EmsSession::EmsSession_I
155
getEventChannel
155
GetManager
155
getSupportedManagers
156
3.5 emsSessionFactory::EmsSessionFactory_I
157
getEmsSession
157
getEmsPublicKey
158
getEmsPublicKeyPair
159
3.6 equipment::EquipmentInventoryMgr_I
160
getAllEquipment
160
getAllEquipmentNames
169
getAllSupportedPTPs
170
getAllSupportedPTPNames
185
getAllSupportingEquipment
186
getAllSupportingEquipmentNames
187
getContainedEquipment
187
getEquipment
188
provisionEquipment
195
setAlarmReportingOff
197
setAlarmReportingOn
197
unprovisionEquipment
198
3.7 maintenanceOps::MaintenanceMgr_I
199
getActiveMaintenanceOperations
199
performMaintenanceOperation
201
3.8 managedElementManager::ManagedElementManager_I
203
getAllActiveAlarms
203
getAllSNCs
205
getAllManagedElements
208
getAllManagedElementNames
211
getAllPTPs
212
getAllPTPNames
214
getContainedInUseTPs
215
getContainedInUseTPNames
216
getContainedPotentialTPs
217
getContainedPotentialTPNames
219
getContainingSubnetworkNames
220
getManagedElement
221
getAllCTMMEInternalPatchcord
221
setAdditionalInfo
222
getTP
224
getAssociatedTopologicalLinks
226
setTPData
226
getAllSrcPTPsForSNCProvisioning
230
getAllSrcCTPsForSNCProvisioning
231
getAllSrcCTPsForVCATMemberSNCProvisioning
232
getAllDestPTPsForSNCProvisioning
233
getAllDestCTPsForSNCProvisioning
234
getAllDestCTPsForVCATMemberSNCProvisioning
236
getAllSrcFTPsForSNCProvisioning
237
getAllDestFTPsForSNCProvisioning
238
forceNEResync
239
getAllTopologicalLinksForME
240
getAllRolls
241
getAllRollNames
242
getRoll
243
getRollToPTPs
244
getRollToCTPs
245
getRollFromCTPs
246
setPortName
247
getPortName
248
getAllClearedAlarms
249
getAllCrossConnections
250
getAllSoftwareDownloadJobs
252
setMEAdminState
253
3.9 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I
254
getAllEdgePoints
254
getAllEdgePointNames
256
getAllManagedElement
257
getAllManagedElementNames
258
getAllSubnetworkConnections
259
getAllSubnetworkConnectionsWithTP
260
getAllSubnetworkConnectionNames
262
getAllSubnetworkConnectionNamesWithTP
263
getAllTopologicalLinks
264
getAllTopologicalLinkNames
265
getMultiLayerSubnetwork
266
getCTPsAndTopologicalLinks
266
getSNC
268
getSNCsByUserLabel
269
getTopologicalLink
270
createAndActivateSNCFromUserLabel
271
CreateAndActivateSNC
283
(Deprecated) createAndActivateProtectedOchccFromUserLabel
283
addDrops
284
deactivateAndDeleteSNC
285
getVCATSNC
287
getAllVCATSNCs
289
getAllVCATSNCNames
291
getAllVCATMemberSNCs
292
getAllVCATMemberSNCNames
293
createVCAT
294
deleteVCAT
296
addMemberSNCsToVCAT
297
deleteMemberSNCsFromVCAT
298
deleteAllMemberSNCFromVCAT
299
getValidSubnetworkConnectionsForMerge
300
upgrade
302
createRoll
303
deleteRoll
306
cancelRoll
307
forceValidSignal
307
completeRoll
308
finishRoll
309
getAllRolls
309
getAllRollNames
310
getAssociatedRollNamesForSNC
311
getAssociatedSNCNamesForRoll
312
createAndActivateSNCOnDRI
312
addManagedElement
315
deleteManagedElement
320
3.10 L2 Topology and ML VLAN for ML-Series Ethernet Cards
320
createMLVLAN
321
modifyMLVLANAddFrontPorts
324
modifyMLVLANDropFrontPorts
325
modifyMLVLANPortState
326
modifyMLVLANRSTPState
327
modifyMLVLANTPQOS
329
modifyMLVLANCustomerIDServiceID
330
getMLVLAN
331
deleteMLVLAN
332
3.10.10 getAllMLVLANs
332
3.10.11 getAllMLVLANNames
333
3.10.12 getAllAssociatedSNCs
334
3.10.13 getL2Topology
335
3.10.14 getAssociatedL2TopologyForSNC
336
3.10.15 getAssociatedL2TopologyForMLVLAN
337
3.10.16 createL2Topology
338
3.10.17 deleteL2Topology
348
3.10.18 modifyL2Topology
348
3.10.19 getAllAvailableMLEquipmentOrTPNames
349
3.11 E-Series VLAN Interfaces
350
createVLAN
351
deleteVLAN
351
getAllVLANs
352
modifySNC
353
3.12 nmsSession::NmsSession_I
357
historyPMDataCompleted
357
historyPMDataFailed
358
operationInfo
358
alarmLossOccurred
359
3.13 performance::PerformanceManagementMgr_I
360
disablePMData
360
enablePMData
361
setTCATPParameter
362
getTCATPParameter
421
getCTMHistoryPMData
422
getCTMValidHistoryPMData
425
deleteHistoryPMDataFile
425
getTPHistoryPMData
426
getHoldingTime
429
3.13.10 getAllCurrentPMData
430
3.13.11 getMEPMcapabilities
432
3.13.12 Passive Unit EMS PM
432
3.14 protection::ProtectionMgr_I
432
getAllProtectedTPNames
433
getAllProtectionGroups
434
getProtectionGroup
436
performProtectionCommand
437
createProtectionGroup
440
deleteProtectionGroup
444
getAssociatedProtectionGroup
445
3.15 session::Session_I
446
endSession
446
ping
446
3.16 mtnmVersion::Version_I
447
getVersion
447
3.17 cpoEmsManager:: CpoEmsManager_I
448
getAllEMSAndMEUnacknowledgedActiveAlarms
448
3.18 cpoManagedElementManager_I:: CpoManagedElementManager_I
449
getAllUnacknowledgedActiveAlarms
449
3.19 Transmission Descriptor Interfaces
450
getAllTransmissionDescriptors
451
getAllTransmissionDescriptorsNames
452
getTransmissionDescriptor
453
getAssociatedTPs
454
createTransmissionDescriptor
455
deleteTransmissionDescriptor
455
3.20 Software and Data Manager Interface
456
backupME
457
getMEBackupStatus
457
abortMEBackup
458
getBackupList
459
activateSoftwareOnME
460
revertSoftwareOnME
461
restoreME
462
getMERestoreStatus
462
abortMERestore
463
3.20.10 getAllSupportedMESoftwareVersions
464
3.20.11 downloadMESoftware
466
3.20.12 addSupportedMESoftwareVersion
467
3.20.13 getSWDownloadStatus
469
Using GateWay/CORBA Connectionless Interfaces
470
4.1 Understanding Key Concepts
470
Ethernet Virtual Circuit
470
Connectionless Port Termination Point
473
Matrix Flow Domain
474
Flow Domain
475
EVC Flow Domain Fragment
475
Link Aggregation
476
MPLS and MPLS-TP
477
MPLS-TP Tunnel
479
MPLS-TP LSP
479
Pseudowire
480
Pseudowire Flow Domain Fragment
480
4.2 Interface Managers
481
4.3 Entity Characteristics
483
Entity Naming
483
Entity Iterators
485
Entity Notifications
487
4.4 Supported Provisioning Interfaces
496
4.5 EVC Provisioning Interfaces
498
CPTP Provisioning Interfaces
498
MFD Provisioning Interfaces
502
Flow Domain Provisioning Interfaces
509
EVC FDFr Provisioning Interfaces
518
Link Aggregation Provisioning Interfaces
529
Traffic Conditioning Profile Provisioning Interfaces
536
4.6 MPLS-TP Provisioning Interfaces
546
MPLS-TP Tunnel Provisioning Interfaces
546
MPLS-TP LSP Provisioning Interfaces
552
MPLS-TP Protection (Provisioning)
558
BFD Template, Node ID, and Label Range Provisioning Interface
558
4.7 Pseudowire Provisioning Interfaces
559
Pseudowire FDFr Provisioning Interfaces
559
Pseudowire Mixed Configuration (Provisioning)
572
Pseudowire Class and Loopback Provisioning Interface
572
Pseudowire QoS Provisioning Interface
576
4.8 Supported Inventory Interfaces
577
4.9 EVC Inventory Interfaces
580
CPTP Inventory Interfaces
580
MFD Inventory Interfaces
584
Flow Domain Inventory Interfaces
587
EVC FDFr Inventory Interfaces
589
Link Aggregation Inventory Interfaces
595
Common Inventory Interface
599
Traffic Conditioning Profile Inventory Interfaces
600
4.10 MPLS-TP Inventory Interfaces
601
MPLS-TP Tunnel Inventory Interfaces
601
MPLS-TP LSP Inventory Interfaces
605
MPLS-TP Tunnel Link Inventory Interfaces
608
MPLS-TP LSP Route Inventory Interfaces
609
MPLS-TP Protection (Inventory)
612
Inventory Interface
613
4.11 Pseudowire Inventory Interfaces
615
Pseudowire FDFr Inventory Interfaces
615
Pseudowire Class, Loopback, and QoS Policy Inventory Interface
626
4.12 Alarm Summaries
629
Alarm Summary Example—Channel Group Port
630
Pseudowire Alarm Event Example
631
MPLS-TP Tunnel Alarm Event Example
632
Channel Group Alarm Event Example
633
4.13 Error Messages
633
MPLS-TP Tunnel Error Messages
634
LSP Error Messages
634
Pseudowire Error Messages
635
EVC Error Messages
635
FD, MFD, and CPTP Error Messages
636
Notifications, Fault Management, and Probable Cause Mapping
638
5.1 Overview of Notifications
638
5.2 Resolving the Notification Service
639
5.3 Tips to Improve Notification Throughput
639
5.4 Supported Events
640
Object Creation
640
Object Deletion
641
Attribute Value Change
642
SubnetworkConnection Name Change - AttributeValueChange
647
State Change Event
648
Protection Switch
649
Threshold Crossing Alert
650
Alarm
651
Heartbeat Event
653
Backup Status Event
653
5.5 Probable Cause Mapping
653
TMF-Defined Probable Cause
653
GateWay/CORBA Mapping—EMS
655
GateWay/CORBA Mapping—ONS 15216
655
GateWay/CORBA Mapping—ONS 15305 and ONS 15305 CTC
657
SDH, CPT 200, CPT 200 SDH, CPT 600, and CPT 600 SDH
661
200, CPT 200 SDH, CPT 600, and CPT 600 SDH
686
GateWay/CORBA Mapping—PTS
686
GateWay/CORBA Mapping—ONS 15600 SONET
689
GateWay/CORBA Mapping—ONS 15600 SDH
699
Server Administration and Configuration
710
6.1 Creating an OSS Client Profile for GateWay/CORBA
710
6.2 Deleting an OSS Client Profile for GateWay/CORBA
711
6.3 Viewing Currently Logged In GateWay/CORBA OSS Users
711
6.4 Logging Out GateWay/CORBA OSS Users
711
6.5 Unsupported Events
712
6.6 Using Encryption Between the OSS Client and GateWay/CORBA
712
6.7 Using Multiple Naming Servers
713
6.8 Naming Conventions for Published GateWay/CORBA Objects
714
6.9 Location of the Naming Service IOR File
715
6.10 Useful Debugging Utilities for Resolving Naming Service-Related Issues
715
6.11 Configuring GateWay/CORBA
715
6.12 Using the CLI to Start and Stop GateWay/CORBA
718
6.13 Configuring Secure Socket Layer for GateWay/CORBA
718
Generating the Server-Side Certificate
718
Generating the Client-Side Certificate
719
Adding the Client-Side Certificate to the Server-Side Keystore
720
Adding the Server-Side Certificate to the Client-Side Keystore
721
Configuring the Client-Side Properties
721
6.14 Installation Program
722
6.15 Cisco Prime Optical 9.6.3-to-Cisco Prime Optical 9.8 Migration
722
OSS Use Cases and Client Development
723
7.1 Use Cases to Resynchronize the NMS from the EMS
723
7.2 Developing a GateWay/CORBA Client
727
Recommended Tools
727
Sample Code in Java
727
Running the Client
736
Known Interoperability Issues When Using Orbix
736
Equipment List for NEs
738
8.1 Equipment List for ONS 15216
738
8.2 Equipment List for ONS 15305
739
8.3 Equipment List for ONS 15305 CTC
739
8.4 Equipment List for ONS 15310 CL
740
8.5 Equipment List for ONS 15310 MA SDH
740
8.6 Equipment List for ONS 15310 MA SONET
741
8.7 Equipment List for ONS 15327
741
8.8 Equipment List for ONS 15454 SDH
741
8.9 Equipment List for ONS 15454 SONET
744
8.10 Equipment List for ONS 15454-M2
748
8.11 Equipment List for ONS 15454-M6
748
8.12 Equipment List for CPT 200, CPT 200 SDH, CPT 600, and CPT 600 SDH
749
8.13 Equipment List for ONS 15600 SDH
750
8.14 Equipment List for ONS 15600 SONET
750
8.15 Equipment List for Unmanaged NEs
751
8.16 CRS1 and CRS3 NEs
751
Layered Parameters and Layer Rates
752
10 Payloads and Layer Rates Matrix
758

Size:

24.1 MB
Pages:

762
Language:

English

Open manual

Information Guide

Size:

178 KB
Pages:

1
Language:

English

Open manual

Getting Started Guide

Size:

258 KB
Pages:

1
Language:

English

Open manual

Release Notes

Size:

290 KB
Pages:

8
Language:

English

Open manual

Installation Guide

Size:

560 KB
Pages:

25
Language:

English

Open manual

Documentation Roadmaps

Size:

241 KB
Pages:

2
Language:

English

Open manual

Information Guide

Size:

296 KB
Pages:

7
Language:

English

Open manual

Technical References

Size:

201 KB
Pages:

8
Language:

English

Open manual

Licensing Information

Size:

1.2 MB
Pages:

261
Language:

English

Open manual

Cisco Cisco Prime Optical 9.8 User Manuals

Table of Contents

Table of Contents