managedelementmanager.idl

UCS (Ultra Corba Simulator) is one more powerful corba client/servant simulator tool than other simi

  /**
   * <p>This allows an NMS to request all of the CTPs that it is potentially capable of 
   * supporting in all possible mapping configurations, at the specified rates 
   * and that are contained by the
   * specified termination point.</p>
   *
   * <p>This service returns all potential contained CTPs for a given TP. The TP may be
   * a PTP or a CTP. If the layerRateList is empty then 
   * contained CTPs at all flexible and/or static LayerRates are 
   * returned.</p>
   *
   * <p>For an OC3 PTP that has the potential of mapping to 
   * VT1.5 the response would contain 3 STS1 CTPs and 84 VT1.5 CTPs;
   * on a T1 PTP, the contained TPs would be one T1 CTP; for
   * an STS1 CTP the response would contain 28 VT1.5 CTPs.  
   * In the case where an OC3 PTP supports mapping 
   * to T1s and VT1.5,
   * then the contained list for the OC3 PTP
   * could be 1 STS3c, 3 STS1, 84 VT1.5 and 84 T1 CTPs;  
   * if a VT1.5 CTP is provided, 1 T1 CTP is returned;
   * if a T1 CTP is provided, the result is an empty list.</p>
   *
   * <p>Whenever a protection group is involved, the behaviour of
   * this service is described below:</p>
   *
   * <TABLE BORDER=2 COLS=2 WIDTH="80%">
   * <TR>
   * <TD>Scenario</TD><TD>Query On Worker TPs </TD><TD>Query On Protection TPs</TD>
   * </TR>
   * <TR>
   * <TD>Before the Protection Group is created</TD>
   * <TD>returns list of all CTPs </TD>
   * <TD>returns list of all CTPs</TD>
   * </TR>
   * <TR>
   * <TD>After ProtectionGroup is created, if extra (preemptible/non-pre-emptible) traffic is allowed.</TD>
   * <TD>returns list of all CTPs </TD>
   * <TD>returns list of all CTPs</TD>
   *</TR>
   * <TR>
   * <TD>After ProtectionGroup is created, if extra (preemptible/non-pre-emptible) traffic is not allowed </TD>
   * <TD>returns list of CTPs that allow protected traffic</TD>
   * <TD>returns an empty list (regardless of the switch status)</TD>
   * </TR>
   * </TABLE>
   * 
   * <p>In case the protection group is created after a query is made, 
   * no object delete notification is 
   * made, the NMS is expected to query the ports in the protection group 
   * to find the list of contained CTPs.</p>
   *
   * <p>When an NMS is interacting with an EMS that supports ATM, this operation
   * needs to be used with caution. The reason for this is that, in ATM, there
   * can be a prohibitively large number of potential VP and VC CTPs returned
   * by this operation. For retrieving ATM CTPs, the getContainedInUseTPs()
   * operation should be considered.</p>
   *
   * <p>If DWDM, SONET and/or SDH is combined with ATM, it is advisable that this
   * operation be used with the appropriate DWDM, SONET and/or SDH layer rates 
   * entered into the layerRateList. Otherwise, ATM CTPs will be returned and
   * the resulting list of contained TPs could get prohibitive.</p>
   * 
   * <p>For details on how TPs should be modelled, see
   * <a href=supportingDocumentation/layers.pdf>layering</a>.</p>
   *
   * <p>In order to allow the NMS to deal with a large number of objects,
   * this operation uses an iterator. See
   * <a href=supportingDocumentation/iterators.html>iterator overview</a>
   * for information on how iterators are used in this interface.</p>
   * 
   * @parm globaldefs::NamingAttributes_T tpName: The name of the PTP or CTP for which to 
   *  get contained CTPs. 
   * @parm transmissionParameters::LayerRateList_T layerRateList: The list of the rates the
   *  contained CTPs to report. An 
   *  empty list indicates to the EMS to report all contained CTPs (of all rates).
   * @parm unsigned long how_many: Maximum number of contained CTPs to report in the first batch.
   * @parm TerminationPointList_T tpList: First batch of contained CTPs.
   * @parm TerminationPointIterator_I tpIt: Iterator to retrieve the remaining contained CTPs.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when tpName does not reference a PTP or CTP object
   *  or layerRateList contains undefined rates<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when tpName references a PTP or CTP object
   *  that does not exist<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost<br>
   * EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS
   *  can support has been reached.
   * </dir>
   **/
   void getContainedPotentialTPs(
         in globaldefs::NamingAttributes_T tpName,
         in transmissionParameters::LayerRateList_T layerRateList,
         in unsigned long how_many,
         out terminationPoint::TerminationPointList_T tpList, 
         out terminationPoint::TerminationPointIterator_I tpIt)
         raises(globaldefs::ProcessingFailureException);



  /** 
   * <p>This operation has exactly the same behaviour as 
   * <a href=_managedElementManager.ManagedElementMgr_I.html#managedElementManager::ManagedElementMgr_I::getContainedPotentialTPs>getContainedPotentialTPs</a>, but
   * instead of returning the entire object structures, this operation returns their names.</p>
   *
   * <p>In order to allow the NMS to deal with a large number of objects,
   * this operation uses an iterator. See
   * <a href=supportingDocumentation/iterators.html>iterator overview</a>
   * for information on how iterators are used in this interface.</p>
   * 
   * @parm globaldefs::NamingAttributes_T tpName: Name of the PTP or CTP for which to get
   *  contained CTPs.
   * @parm transmissionParameters::LayerRateList_T layerRateList: the list of the rates of
   *  the contained CTPs to be reported. An 
   *  empty list indicates to the EMS to get all contained CTPs (of all rates).
   * @parm  unsigned long how_many: Maximum number of contained CTPs to return in the first batch.
   * @parm  globaldefs::NamingAttributesList_T nameList: First batch of contained CTPs.
   * @parm  globaldefs::NamingAttributesListIterator_I nameIt: Iterator to retrieve the remaining
   *  contained CTPs.
   * @raises globaldefs::ProcessingFailureException:
   * As for <a href=_managedElementManager.ManagedElementMgr_I.html#managedElementManager::ManagedElementMgr_I::getContainedPotentialTPs>getContainedPotentialTPs</a>.
   **/
   void getContainedPotentialTPNames(
         in globaldefs::NamingAttributes_T tpName,
         in transmissionParameters::LayerRateList_T layerRateList,
         in unsigned long how_many,
         out globaldefs::NamingAttributesList_T nameList,
         out globaldefs::NamingAttributesIterator_I nameIt)
         raises(globaldefs::ProcessingFailureException);


  /** 
   * <p>This service is used to retrieve the "in use" CTPs that are contained within
   * a specific PTP or CTP, at specific layer rates. 
   * An "in use" CTP is defined as a CTP that is used by an SNC
   * in any state (including pending) or a CTP that is terminated and mapped.
   * This operation will be used when there are a large number of potential CTPs
   * (e.g., in ATM).</p>
   *
   * <p>Example of usage with respect to ATM:<dir>
   * To retrieve all actual ATM Network Interfaces associated with a PTP,
   * this operation will be invoked using the PTP name as the tpName and
   * LR_ATM_NI as the only layer rate in the layerRateList. The VPI and
   * VCI ranges that are specified in the returned ATM Network Interface
   * transmissionParams (i.e., Max_VPI_Bits and Max_VCI_Bits) can then be
   * used to determine the potential VPI/VCI range. A subsequent invocation of
   * this operation using an ATM Network Interface CTP as input can be used to
   * determine which VPIs/VCIs are actually in use (with LR_ATM_VP and LR_ATM_VC
   * included in the connectionRateList).</dir></p>
   *
   * <p>Example of usage with respect to SONET/SDH:<dir>
   * Consider an STM4 PTP with layerRate: LR_Optical_OC12_and_STM4.
   * Assume that the set of CTPs returned by operation getContainedPotentialTPs()
   * contains one CTP with layerRate LR_STS3c_and_AU4_VC4 that is terminating
   * an SNC (layerRate LR_STS3c_and_AU4_VC4), and another CTP with layerRate
   * LR_STS3c_and_AU4_VC4 that is terminated and mapped (attribute
   * tpMappingMode is set to TM_TERMINATED_AND_AVAILABLE_FOR_MAPPING).
   * The CTP with layerRate LR_STS3c_and_AU4_VC4 that is terminated and mapped
   * contains one CTP with layerRate LR_VT2_and_TU12_VC12
   * that is involved in an SNC. None of the other contained CTPs have attribute
   * tpMappingMode set to TM_TERMINATED_AND_AVAILABLE_FOR_MAPPING, or are
   * involved in an SNC.<br>
   * Operation getContainedInUseTPs then returns three CTPs:<ul>
   * <li>The CTP with layerRate LR_STS3c_and_AU4_VC4 that is terminating an SNC.</li>
   * <li>The CTP with layerRate LR_STS3c_and_AU4_VC4 that has attribute
   * tpMappingMode set to TM_TERMINATED_AND_AVAILABLE_FOR_MAPPING.</li>
   * <li>The CTP with layerRate LR_VT2_and_TU12_VC12 that is terminating an SNC.</li>
   * </ul></dir></p>
   * 
   * <p>For details on how TPs should be modelled, see
   * <a href=supportingDocumentation/layers.pdf>layering</a>.</p>
   *
   * <p>In order to allow the NMS to deal with a large number of objects,
   * this operation uses an iterator. See
   * <a href=supportingDocumentation/iterators.html>iterator overview</a>
   * for information on how iterators are used in this interface.</p>
   * 
   * @parm globaldefs::NamingAttributes_T tpName: The name of the PTP or CTP for which to get 
   *  contained actual CTPs.
   * @parm transmissionParameters::LayerRateList_T layerRateList: The list of rates of the
   *  contained actual CTPS to be returned.
   *  An empty list indicates to the EMS to get all contained actual CTPs (for all rates).
   * @parm unsigned long how_many: The maximum number of CTPs to be returned in the first batch.
   * @parm TerminationPointList_T tpList: First batch of contained in use CTPs.
   * @parm TerminationPointIterator_I tpIt: Iterator to retrieve the remaining
   *  contained in use CTPs.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when tpName does not reference a PTP or CTP object
   *  or layerRateList contains undefined rates<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when tpName references a PTP or CTP object
   *  that does not exist<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost<br>
   * EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS
   *  can support has been reached.
   * </dir>
   **/
   void getContainedInUseTPs(
         in globaldefs::NamingAttributes_T tpName,
         in transmissionParameters::LayerRateList_T layerRateList,
         in unsigned long how_many,
         out terminationPoint::TerminationPointList_T tpList, 
         out terminationPoint::TerminationPointIterator_I tpIt)
         raises(globaldefs::ProcessingFailureException);


  /**
   * <p>This operation has exactly the same behaviour as 
   * <a href=_managedElementManager.ManagedElementMgr_I.html#managedElementManager::ManagedElementMgr_I::getContainedInUseTPs>getContainedInUseTPs</a>, but
   * instead of returning the entire object structures, this operation returns their names.</p>
   *
   * <p>In order to allow the NMS to deal with a large number of objects,
   * this operation uses an iterator. See
   * <a href=supportingDocumentation/iterators.html>iterator overview</a>
   * for information on how iterators are used in this interface.</p>
   * 
   * @parm globaldefs::NamingAttributes_T tpName: The name of the TP for which to get contained 
   *  in use TPs.
   * @parm transmissionParameters::LayerRateList_T layerRateList: The list of rates of the 
   *  contained in use CTPs to be returned. An 
   *  empty list indicates to the EMS to get all contained in use CTPs (of all rates).
   * @parm unsigned long how_many: Maximum number of CTP names to be returned in the first batch.
   * @parm globaldefs::NamingAttributesList_T nameList: First batch of CTP names.
   * @parm globaldefs::NamingAttributesListIterator_I nameIt: Iterator to retrieve the remaining
   *  CTP names.
   * @raises globaldefs::ProcessingFailureException:
   * As for <a href=_managedElementManager.ManagedElementMgr_I.html#managedElementManager::ManagedElementMgr_I::getContainedInUseTPs>getContainedInUseTPs</a>.
   **/
   void getContainedInUseTPNames(
         in globaldefs::NamingAttributes_T tpName,
         in transmissionParameters::LayerRateList_T layerRateList,
         in  unsigned long how_many,
         out globaldefs::NamingAttributesList_T nameList,
         out globaldefs::NamingAttributesIterator_I nameIt)
         raises(globaldefs::ProcessingFailureException);


  /** 
   * <p>This service is used to retrieve the "current" CTPs that are contained within