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.
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.
| Component Name/Class Instantiated |
API Name |
Entity Type |
Details |
| EMS |
makeEMS findEms |
Physical |
|
| OpticalNetworkElement |
makeNOpticalNetworkElement findOpticalNetworkElement |
Physical |
|
| Equipment/Card |
makeNEquipment, findNEquipment makeEquipment, findEquipment makeNCard, findNCard |
Physical |
|
| PTP |
makeNPTP, findNPTP
Note:
makePTP and findPTP are deprecated. Use makeNPTP and findNPTP instead. |
Physical |
|
| Rack |
makeRack findRack |
Physical |
|
| Shelf |
makeShelf, findShelf makeNShelf, findNShelf |
Physical |
|
| TopologicalLink |
makeTopologicalLink findTopologicalLink |
Physical |
|
| DropSideTopologicalLink |
makeDropSideTopologicalLink findDropSideTopologicalLink |
Physical |
|
| CTP |
makeNCTP, findNCTP makeCTP, findCTP |
Logical |
|
| High Order CTP |
makeHOCTP, findHOCTP |
Logical |
|
| HighOrder_Circuit |
makeHOCircuit findHOCircuit |
Logical |
|
| HighOrder_Trail |
makeHOTrail findHOTrail |
Logical |
|
| SubnetworkConnection |
makeSubnetworkConnection findSubnetworkConnection |
Logical |
|
| TopologicalLinkGroup |
makeTLGroup make2FBLSR |
Logical |
|
| BlackBoxTopologicalLink |
makeBlackBoxTL findBlackBoxTL |
Logical |
|
| BlackBoxDropSideTopologicalLink |
makeBlackBoxDSTL findBlackBoxDSTL |
Logical |
|
| RingProtectionGroup |
makeRPGroup |
Logical |
|
| EquipmentProtectionGroup |
makeEqPGroup |
Logical |
|
| LogicalConnectionTPGroup |
makeLCTPGroup |
Logical |
