Cisco Cisco Prime Optical 10.6 Developer's Guide

Page of 665
Cisco Prime Optical 10.6 GateWay/CORBA Programmer Reference Guide 
 
 
388
 
3.14.2  getAllProtectionGroups  
Synopsis 
Description 
This interface is used by the client to discover all of the protection groups currently in operation for the 
ME. Note that Prime Optical does not have any protection groups for path protection. 
The supported protection group types are PGT_MSP_1_FOR_N, PGT_MSP_1_PLUS_1, 
PGT_2_FIBER_BLSR, PGT_4_FIBER_BLSR, and PGT_Y_CABLE. 
 
The following table lists default names for the protection groups when created through CTC. 
 
PGT_MSP_1_FOR_1 
Slot n (Equipment Native Name), where n represents the slot number of the 
protecting equipment. For example, slot 3 (DS3IN). 
PGT_MSP_1_FOR_N 
Slot n (Equipment Native Name), where n represents the slot number of the 
protecting equipment. For example, slot 3 (DS3XM). 
PGT_MSP_1_PLUS_1  Slot n (Equipment Native Name), port m, where n represents the slot number 
and m represents the protecting port number. For example, slot 5 (OC3), port 1. 
PGT_2_FIBER_BLSR  No defaults; the name is a user-specified ring ID from 1 to 9999. 
PGT_4_FIBER_BLSR  No defaults; the name is a user-specified ring ID from 1 to 9999. 
PGT_Y_CABLE 
SHELF N SLOT M PORT O, where N represents the shelf number, M 
represents the slot number, and O represents the protecting port number.  
For example, SHELF 5 SLOT 6 PORT 1-1 
If the PGP configuration is 4-fiber BLSR, there are three protection groups reported for this 
configuration: two PGT_1_FOR_N component groups and one PGT_4_FIBER_BLSR group. 
The ONS 15600 SONET and ONS 15600 SDH support only PGT_MSP_1_PLUS_1 protection group. 
Parameters 
Name 
Type 
Input/Output  Description 
meName 
Globaldefs::NamingAttributes_T  In 
Name of the ME for which the request 
is made. 
how_many  unsigned long 
In 
Maximum number of protection groups 
to report in the first batch. 
pgList 
ProtectionGroupList_T 
Out 
First batch of protection groups. 
PgIt 
ProtectionGroupIterator_I 
Out 
Iterator used to access the remaining 
protection groups (PGs), if any. 
Prime Optical support for ProtectionGroup_T structure is as follows: 
•  globaldefs::NamingAttributes_T name 
–  Supported. This field contains three tuples. The first tuple contains the EMS name; the 
second tuple contains the ME name; and the last tuple contains the nativeEMSName of this 
protection group. 
•  string userLabel 
–  Not supported. 
•  string nativeEMSName