managedelementmanager.idl

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

   * a specific PTP or CTP, at specific layer rates. 
   * A "current" CTP is defined as a CTP that is either cross-connectable or cross-connected, 
   * in the current mapping configuration. </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 
   *  current contained CTPs.
   * @parm transmissionParameters::LayerRateList_T layerRateList: The list of rates of the
   *  current contained CTPS to be returned.
   *  An empty list indicates to the EMS to get all current contained CTPs (of 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 current CTPs.
   * @parm TerminationPointIterator_I tpIt: Iterator to retrieve the remaining
   *  contained current CTPs.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_NOT_IMPLEMENTED - Raised if EMS cannot support this service<br>
   * 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 getContainedCurrentTPs(
         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::getContainedCurrentTPs>getContainedCurrentTPs</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 PTP or CTP for which to get 
   *  current contained CTPs.
   * @parm transmissionParameters::LayerRateList_T layerRateList: The list of rates of the
   *  current contained CTPS to be returned.
   *  An empty list indicates to the EMS to get all current contained 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::getContainedCurrentTPs>getContainedCurrentTPs</a>.
   **/
   void getContainedCurrentTPNames(
         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 returns a list of the containing TPs given a CTP. 
   * Using the UPSR OC3 example used in getContainedPotentialTPs, getContainingTPs
   * on the working T1 CTP will return a working STS1 CTP and a working OC3 
   * PTP.
   * If the OC3 was in APS, then getContainingTPs on the T1 CTP would return
   * an STS1 CTP, an OC3 working PTP and an OC3 protect PTP. 
   * 
   * <p>For details on how TPs should be modelled, see
   * <a href=supportingDocumentation/layers.pdf>layering</a>.</p>
   *
   * @parm globaldefs::NamingAttributes tpName: Name of the CTP for which containing
   * CTPs and PTPs are to be reported.
   * @parm terminationPoint::TerminationPointList_T tpList: List of the containing
   * CTPs and PTPs.
   * @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 CTP object<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when tpName references a CTP object that does not exist<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost<br>
   * </dir>
   **/
   void getContainingTPs(
         in globaldefs::NamingAttributes_T tpName,
         out terminationPoint::TerminationPointList_T tpList)
         raises (globaldefs::ProcessingFailureException);


  /**
   * <p>This operation has exactly the same behaviour as 
   * <a href=_managedElementManager.ManagedElementMgr_I.html#managedElementManager::ManagedElementMgr_I::getContainingTPs>getContainingTPs</a>, but
   * instead of returning the entire object structures, this operation returns their names.</p>
   *
   * @parm globaldefs::NamingAttributes_T tpName: Name of the PTP or CTP for which to get
   * the names of the containing TPs.
   * @parm globaldefs::NamingAttributesList_T tpNameList: List of the names of the containing TPs.
   * @raises globaldefs::ProcessingFailureException:
   * As for <a href=_managedElementManager.ManagedElementMgr_I.html#managedElementManager::ManagedElementMgr_I::getContainingTPs>getContainingTPs</a>.
   **/
   void getContainingTPNames(
         in globaldefs::NamingAttributes_T tpName,
         out globaldefs::NamingAttributesList_T tpNameList)
         raises (globaldefs::ProcessingFailureException);


  /**
   * <p>This allows an NMS to request all of the active alarms and TCAs 
   * for the specified managed element.
   * Alarms that are not reported by the ME to the EMS should not be reported by this operation.
   * Some alarms may be
   * filtered out (excluded) by specifying their probable causes or severities.
   * </p>
   *
   * <p>The result of this operation is independent of the filtering set up by the NMS 
   * for the notification service.</p>
   *
   * @parm globaldefs::NamingAttributes meName: The name of the 
   * Managed Element for which to retrieve alarms and TCAs.
   * @parm notifications::ProbableCauseList_T excludeProbCauseList: List of probable causes
   *  to exclude from the output event list.
   * @parm notifications::PerceivedSeverityList_T excludeSeverityList: List of severities
   *  to exclude from the output event list.
   * @parm unsigned long how_many: Maximum number of events to report in the first batch.
   * @parm  notifications::EventList_T eventList: First batch of events.
   * @parm  notifications::EventIterator_I eventIt: Iterator to retrieve the remaining events.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when meName does not reference a managed element object or
   *  excludeProbCauseList contains undefined values<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when meName references an ME object that does not exist<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost<br>
   * </dir>
   **/
   void getAllActiveAlarms(
         in globaldefs::NamingAttributes_T meName,
         in notifications::ProbableCauseList_T excludeProbCauseList,
         in notifications::PerceivedSeverityList_T excludeSeverityList,
         in unsigned long how_many,
         out notifications::EventList_T eventList,
         out notifications::EventIterator_I eventIt) 
	     raises(globaldefs::ProcessingFailureException);

  /** 
   * <p>This service allows the NMS to set parameters on a specified 
   * Termination Point.</p>
   *
   * <p>This operation is best effort. The results of the operation are returned
   * so that the NMS is aware of what modifications succeeded.</p>
   *
   * <p>If the source TP of a broadcast system is used as input, then
   * the entire multipoint system will be affected based on the new
   * parameter values for the source TP.</p>
   *
   * <p>The tpMappingMode may be set with this operation. When the mode is
   * set to TM_TERMINATED_AND_AVAILABLE_FOR_MAPPING, the EMS will terminate the
   * specified CTP. In this case the EMS must create the specified CTP on the NE
   * if it does not actually exist. 
   * Setting the tpMappingMode of an ATM VP or VC CTP can only be done if
   * the CTP has been created. Note that the tpMappingMode can be set
   * only on the ingress and egress CTPs of an ATM SNC since they are the only
   * ones which may not be cross-connected.</p>
   *
   * <p>No change to tpMappingMode or trafficDescriptors will take place if
   * there is any active cross connect (NE cross connect)
   * using the CTP passed in parameter.</p>
   *
   * <p>The transmissionParams is a "delta" list that needs to be
   * applied to the specified TP, i.e. only a subset of the
   * parameters may be specified in the list, in which case only those
   * should be applied in the NE.</p>
   *
   * @parm subnetworkConnection::TPData_T tpInfo: Details of modifications required.
   * @parm terminationPoint::TerminationPoint_T modifiedTP: Result of modification.
   * @raises globaldefs::ProcessingFailureException:<dir>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised if the TP referred to in tpInfo does not exist<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost<br>
   * </dir>
   **/
   void setTPData(
         in subnetworkConnection::TPData_T tpInfo,
         out terminationPoint::TerminationPoint_T modifiedTP)
        raises(globaldefs::ProcessingFailureException);


  /**
   * <p>This allows an NMS to request a list of the cross-connects for the specified managed element 
   * at the specified layer rates.</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 managedElementName: Name of the 
   * Managed Element for which to retrieve CCs.
   * @parm transmissionParameters::LayerRateList_T connectionRateList: List of 
   * rates for which to retrieve CCs. This must not be an empty list. In this case an 
   * INVALID_INPUT exception is thrown.
   * @parm in unsigned long how_many: Maximum number of CCs to report in the first batch.
   * @parm subnetworkConnection::CrossConnectList_T ccList: First batch of CCs.
   * @parm subnetworkConnection::CCIterator_I ccIt: Iterator to retrieve remaining CCs.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised if connectionRateList is empty or contains
   *  invalid rates, or if managedElementName does not reference a managed element.<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when managedElementName references an ME 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 getAllCrossConnections(
         in globaldefs::NamingAttributes_T managedElementName,
         in transmissionParameters::LayerRateList_T connectionRateList,
         in unsigned long how_many,
         out subnetworkConnection::CrossConnectList_T ccList,
         out subnetworkConnection::CCIterator_I ccIt)
         raises(globaldefs::ProcessingFailureException);

    };

};

#endif