User guide

3-35
Cisco Transport Manager Release 9.2 GateWay/CORBA User Guide and Programmer Manual
OL-20937-01
Chapter 3 Using CTM GateWay/CORBA Interfaces
3.3.13 getAllL2Topologies
3.3.13 getAllL2Topologies
Synopsis
void getAllL2Topologies(in multiLayerSubnetwork::L2TopoType_T l2TopoType,
in unsigned long how_many,
out multiLayerSubnetwork::L2TopologyList_T l2TopoList,
out multiLayerSubnetwork::L2TopologyIterator_I l2TopoIt)
raises(globaldefs::ProcessingFailureException);
Description
This interface lists all L2 topologies of a particular topology type in the EMS. The L2 topology has a
scope in the EMS. CTM supports only Resilient Packet Ring (RPR) and point-to-point L2 topology
types.
Parameters
CTM support for L2Topology_T structure is as follows:
• globaldefs::NamingAttributes_T name
– Supported. The field contains two tuples. The first tuple contains a value for EMS. The second
tuple contains the L2 topology name.
• string userLabel
– Not supported.
• string nativeEMSName
– Supported. The L2 topology name is reported.
• string owner
– Not supported.
• L2TopoLayerRate_T layerRate
– Supported. This represents the total capacity of the L2 topology. L2TopoLayerRate_T contains
the following information:
• LayerRate_T layerRate—Represents the layer rate of the SNCs. For VCAT, represents the layer
rate of the member SNCs.
• Unsigned long numberOfVcatMembers—Represents the number of members in each SNC of
an L2 topology consisting of all VCAT SNCs. In all other cases, it contains a value less than
one and should be ignored.
• Supported layer rates are:
LR_STS1_and_AU3_High_Order_VC3
Name Type Input/Output Description
l2TopoType MultiLayerSubnetwork::L2TopoType_T In Type of L2 topologies to return.
how_many unsigned long In Maximum number of L2 topologies to
return in the first batch.
l2TopoList multiLayerSubnetwork::L2TopologyList_T Out List of available L2 topologies in this
multilayer subnetwork.
l2TopoIt multiLayerSubnetwork::L2TopologyIterator_I Out Iterator used to retrieve the remaining L2
topologies.