SONET/SDH components and API summary

SONET/SDH components and API summary lists the SONET/SDH OTM components along with the APIs used to make and find that component. Also indicated is whether the component is physical hardware or a logical construction.

Note:

API names for creating components start with “make” and API names for finding components already created and existing within OTM repository start with “find.” Some API names use the convention “makeNxxx” or “findNxxx.” The “N” emphasizes the fact that the native name (also known as the native AID) is used in forming the final component name without undergoing any change or normalization.

Table 1. SONET/SDH components and API summary

Component Name/Class Instantiated	API Name	Entity Type	Details
EMS	makeEMS findEms	Physical	page 13
OpticalNetworkElement	makeNOpticalNetworkElement findOpticalNetworkElement	Physical	page 15
Equipment/Card	makeNEquipment, findNEquipment makeEquipment, findEquipment makeNCard, findNCard	Physical	page 16
PTP	makeNPTP, findNPTP Note: makePTP and findPTP are deprecated. Use makeNPTP and findNPTP instead.	Physical	page 19
Rack	makeRack findRack	Physical	page 20
Shelf	makeShelf, findShelf makeNShelf, findNShelf	Physical	page 21
TopologicalLink	makeTopologicalLink findTopologicalLink	Physical	page 23
DropSideTopologicalLink	makeDropSideTopologicalLink findDropSideTopologicalLink	Physical	page 24
CTP	makeNCTP, findNCTP makeCTP, findCTP	Logical	page 25
High Order CTP	makeHOCTP, findHOCTP	Logical	page 27
HighOrder_Circuit	makeHOCircuit findHOCircuit	Logical	page 30
HighOrder_Trail	makeHOTrail findHOTrail	Logical	page 31
SubnetworkConnection	makeSubnetworkConnection findSubnetworkConnection	Logical	page 32
TopologicalLinkGroup	makeTLGroup make2FBLSR	Logical	page 34
BlackBoxTopologicalLink	makeBlackBoxTL findBlackBoxTL	Logical	page 36
BlackBoxDropSideTopologicalLink	makeBlackBoxDSTL findBlackBoxDSTL	Logical	page 37
RingProtectionGroup	makeRPGroup	Logical	page 38
EquipmentProtectionGroup	makeEqPGroup	Logical	page 40
LogicalConnectionTPGroup	makeLCTPGroup	Logical	page 41