User guide

3-278
Cisco Transport Manager Release 9.2 GateWay/CORBA User Guide and Programmer Manual
OL-20937-01
Chapter 3 Using CTM GateWay/CORBA Interfaces
3.14.2 getAllProtectionGroups
Description
This interface is used by the client to discover all of the protection groups currently in operation for the
ME. Note that CTM 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, and PGT_4_FIBER_BLSR.
The following table lists default names for the protection groups when created through CTC.
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
CTM 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
Supported. The name is reported by the NE. It is Ring Id for 2_FIBER_BLSR and 4_FIBER_BLSR.
It is <Ring Id>-EAST or <Ring Id>-WEST for the two component groups of 4-fiber BLSR PGP.
• string owner
Not supported.
• ProtectionGroupType_T protectionGroupType
Supported.
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.
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.