WDM components and API summary

This chapter describes all the APIs needed to create the object instances in the WDM Domain Manager's repository. WDM network segment configurationis a basic WDM network segment configuration. It has two end terminals with an in line amplifier (ILA). This figure is for reference and shows various physical and logical classes that can be instantiated in the repository of WDM Domain Manager for building the topology into the WDM Domain Manager using the APIs.

Figure 1. WDM network segment configuration

WDM components and API summary lists the WDM 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 “makeN xxx” or “findN xxx.” 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. WDM components and API summary

Component Name	API Name	Details	Entity Type	Class Used/Returned
EMS	makeEMSs	page 47	Physical	EMS
	findEms	page 49
OpticalNetworkElement	makeOpticalNetworkElement	page 50	Physical	OpticalNetworkElement
	findOpticalNetworkElement	page 51
Card	makeNCard	page 52	Physical	Card Amplifier Transponder OscCard
	makeNSubcard	page 53
	findNCard	page 54
Input Port	makeNInputPort Note: makeInputPort is deprecated. Use makeNInputPort instead.	page 55	Physical	TransponderInOcnPort TransponderInOchPort MuxInOchPort MuxInOmsPort DemuxInOmsPort AmpInOmsPort AmpInOtsPort AmpInOscPort OscInOscPort
	findNInputPort Note: findInputPort is deprecated. Use findNInputPort instead.	page 58
Output Port	makeNOutputPort Note: makeOutputPort is deprecated. Use makeNOutputPort instead.	page 59	Physical	TransponderOutOcnPort TransponderOutOchPort DemuxOutOchPort MuxOutOmsPort DemuxOutOmsPort AmpOutOmsPort AmpOutOtsPort AmpOutOscPort OscOutOscPort
	findNOutputPort Note: findOutputPort is deprecated. Use findNOutputPort instead.	page 62
FiberLink	makeFiberLink	page 63	Physical	FiberLink
	findFiberLink	page 65
PassiveFiberLink	makePassiveFiberLink	page 66	Physical	FiberLink
BlackBoxFiberLink	makeBlackFL	page 68	Physical	FiberLink
	findBlackFL	page 69
PTP	makeNPTP, findNPTP Note: makePTP and findPTP are deprecated. Use makeNPTP and findNPTP instead.	page 70	Physical	PTP
TopologicalLink	makeTopologicalLink	page 72	Physical	TopologicalLink
LinkGroup	makeLinkGroup	page 73	Logical	LinkGroup
findLinkGroup	findLinkGroup	page 76	Logical	LinkGroup
OchLink	makeLogicalLink	page 77	Logical	OchLink
	findLogicalLink	page 78
OcnLink	makeLogicalLink	page 77	Logical	OcnLink
	findLogicalLink	page 78
ClientTrail	makeClientTrail	page 79	Logical	ClientTrail
	findClientTrail	page 81
ClientCircuit	makeClientCircuit	page 82	Logical	ClientCircuit
	findClientCircuit	page 83