multilayersubnetwork.idl

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

   * 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 CTP or PTP.<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when tpName references a CTP or PTP object
   *  that does not exist<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost<br>
   * </dir>
   **/
   void getAssociatedTP(
         in globaldefs::NamingAttributes_T tpName,
         out terminationPoint::TerminationPointList_T tpList)
        raises(globaldefs::ProcessingFailureException);


  /** 
   * <p>This method allows the NMS to query the TP pool-CTP associations.</p>
   *
   * <p>If a TPPool name is supplied, the method will return the names of all the CTPs
   * that have been grouped
   * to the supplied TPPool.
   * If a CTP name is supplied, the method will return the names of any associated TPPools.
   * An empty list is
   * returned if no associated TP pools exist for the input CTP, or if no CTPs have been grouped
   * to the input TP pool.</p>
   *  
   * @parm globaldefs::NamingAttributes tpName: The name of the TP pool or CTP for which to 
   * retrieve the association.
   * @parm unsigned long how_many: Maximum number of "contained" CTP names or 
   *  "containing" TP pool names to return in the first batch.
   * @parm globaldefs::NamingAttributesList_T nameList: First batch of "contained" CTP names or 
   *  "containing" TP pool names.
   * @parm globaldefs::NamingAttributesIterator_I nameIt: Iterator to retrieve the remaining
   *  "contained" CTP names or "containing" TP pool names.
   * @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 CTP or TPPool object<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when tpName references a CTP to TP pool object
   *  that does not exist<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost<br>
   * </dir>
   **/
   void getTPGroupingRelationships(
         in globaldefs::NamingAttributes_T tpName,
         in unsigned long how_many,
         out globaldefs::NamingAttributesList_T nameList,
         out globaldefs::NamingAttributesIterator_I nameIt)
         raises(globaldefs::ProcessingFailureException);


  /**
   * <p>This allows an NMS to request a list of the SNCs for the
   * specified Subnetwork at the specified connectionRates.</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 subnetName: Name of the subnetwork.
   * @parm transmissionParameters::LayerRateList_T connectionRateList:
   * List of rates of the SNCs to be reported.
   * If an empty list is specified, then all SNCs of all rates are to be reported.
   * @parm unsigned long how_many: Maximum number of SNCs to be reported in the first batch.
   * @parm subnetworkConnection::SubnetworkConnectionList_T sncList: First batch of SNCs.
   * @parm subnetworkConnection::SNCIterator_I sncIt: Iterator to retrieve the
   *  remaining SNCs.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when subnetName does not reference an multiLayerSubnetwork object
   *  or connectionRateList contains undefined values<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references object which 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<br>
   * </dir>
   **/
   void getAllSubnetworkConnections(
         in globaldefs::NamingAttributes_T subnetName,
         in transmissionParameters::LayerRateList_T connectionRateList,
         in unsigned long how_many,
         out subnetworkConnection::SubnetworkConnectionList_T sncList,
         out subnetworkConnection::SNCIterator_I sncIt) 
         raises(globaldefs::ProcessingFailureException);


  /**
   * <p>This operation has exactly the same behaviour as 
   * <a href=_multiLayerSubnetwork.MultiLayerSubnetworkMgr_I.html#multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllSubnetworkConnections>getAllSubnetworkConnections</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 subnetName: Name of the subnetwork.
   * @parm transmissionParameters::LayerRateList_T connectionRateList:
   * List of rates of the SNC names to be reported.
   * If an empty list is specified, then all SNC names of all rates are to be reported.
   * @parm unsigned long how_many: Maximum number of SNC names to be reported in the first batch.
   * @parm globaldefs::NamingAttributesList_T nameList: First batch of SNC names.
   * @parm globaldefs::NamingAttributesIterator_I nameIt: Iterator to retrieve the
   *  remaining SNC names.
   * @raises globaldefs::ProcessingFailureException
   * As for <a href=_multiLayerSubnetwork.MultiLayerSubnetworkMgr_I.html#multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllSubnetworkConnections>getAllSubnetworkConnections</a>.
   **/
   void getAllSubnetworkConnectionNames(
         in globaldefs::NamingAttributes_T subnetName,
         in transmissionParameters::LayerRateList_T connectionRateList,
         in unsigned long how_many,
         out globaldefs::NamingAttributesList_T nameList,
         out globaldefs::NamingAttributesIterator_I nameIt)
         raises(globaldefs::ProcessingFailureException);


  /**
   * <p>This allows an NMS to request a list of the SNCs using the
   * specified termination point at the specified connection rates. A TP may be a
   * PTP in which case a full list of SNCs using any of its contained CTPs
   * is required. A TP may be a CTP, in 
   * which case only SNCs using that CTP or any of its contained CTPs are required.
   * Both end CTPs and intermediate CTPs at the same layer are considered.
   * In all cases, only SNCs that also match the specified connection rate filter are returned.</p>
   *
   * <p>All legs of a broadcast system can be retrieved using this operation where
   * the source TP of the broadcast system is used as input to the operation.
   * The output will be the list of individual SNCs that make up the broadcast
   * system.</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: Termination point for which
   * to report SNCs.
   * @parm transmissionParameters::LayerRateList_T connectionRateList:
   * The list of rates of the SNCs to be reported.
   * If an empty list is specified, then all SNCs of all rates are to be reported.
   * @parm unsigned long how_many: Maximum number of SNCs to report in the first batch.
   * @parm subnetworkConnection::SubnetworkConnectionList_T sncList:  First batch of SNCs.
   * An SNC is
   * only reported if it respects both the tpName and connectionRateList filters.
   * @parm subnetworkConnection::SNCIterator_I sncIt: Iterator to retrieve the remaining SNCs.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised if tpName does not reference a terminationPoint object or
   *  connectionRateList contains undefined values<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when tpName references an 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 getAllSubnetworkConnectionsWithTP (
         in globaldefs::NamingAttributes_T tpName,
         in transmissionParameters::LayerRateList_T connectionRateList,
         in unsigned long how_many,
         out subnetworkConnection::SubnetworkConnectionList_T sncList,
         out subnetworkConnection::SNCIterator_I sncIt)
         raises(globaldefs::ProcessingFailureException);

  /**
   * <p>This operation has exactly the same behaviour as 
   * <a href=_multiLayerSubnetwork.MultiLayerSubnetworkMgr_I.html#multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllSubnetworkConnectionsWithTP>getAllSubnetworkConnectionsWithTP</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: Termination point for which
   * to report SNCs.
   * @parm transmissionParameters::LayerRateList_T connectionRateList:
   * The list of rates of the SNCs to be reported.
   * If an empty list is specified, then all SNCs of all rates are to be reported.
   * @parm unsigned long how_many: Maximum number of SNCs to report in the first batch.
   * @parm globaldefs::NamingAttributesList_T nameList: First batch of SNC names.
   * @parm globaldefs::NamingAttributesIterator_I nameIt: Iterator to retrieve the
   *  remaining SNC names.
   * @raises globaldefs::ProcessingFailureException
   * As for <a href=_multiLayerSubnetwork.MultiLayerSubnetworkMgr_I.html#multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllSubnetworkConnectionsWitTP>getAllSubnetworkConnectionsWithTP</a>.
   **/
   void getAllSubnetworkConnectionNamesWithTP (
         in globaldefs::NamingAttributes_T tpName,
         in transmissionParameters::LayerRateList_T connectionRateList,
         in unsigned long how_many,
         out globaldefs::NamingAttributesList_T nameList,
         out globaldefs::NamingAttributesIterator_I nameIt)
         raises(globaldefs::ProcessingFailureException);

  /**
   * <p>This service returns the route for the SNC whose name is specified 
   * as a parameter.</p>
   *
   * <p>The route information, in the form of crossconnects, should identify the resources
   * allocated to the SNC at the time of the request and the way in which these resources
   * are used. For example, for a resilient SNC that is implemented in the subnetwork using
   * subnetwork connection protection, all details of the route including normal and
   * alternative paths should be provided. If the SNC is using some form of dynamic
   * rerouting then it is clearly acceptable that the route include only the single
   * thread of crossconnections that is supporting the traffic (as there may be many
   * alternative potential paths that could be selected).</p>
   *
   * <p>The NMS specifies if it wants to retrieve only resources in the layer of the
   * SNC (the CCs that belong to the SNC), or higher order CCs also (the CCs of other SNCs
   * that are used to carry the traffic of the queried SNC).  The ability to retrieve
   * higher order CCs is optional.</p>
   *
   * <p>All cross-connections allocated to the SNC must be returned, even if they are not
   * active in the managed elements.  This allows the NMS to query the route that will be
   * used before activating an SNC.</p>
   *
   * @parm globaldefs::NamingAttributes sncName: The name of the SNC.
   * @parm boolean includeHigherOrderCCs: Specifies whether the higher order CCs of other
   *  SNCs used to carry the queried SNC have to be included in addition to the CCs of the 
   *  queried SNC.<br>
   * @parm subnetworkConnection::Route_T route: The route of the SNC.<br>
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_NOT_IMPLEMENTED - Raised if an EMS does not implement the specified
   *  includeHigherOrderCCs value<br>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when sncName does not reference a subnetworkConnection object<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when sncName references an SNC object that does not exist<br>
   * </dir>
   **/
   void getRoute(
         in globaldefs::NamingAttributes_T sncName,
         in boolean includeHigherOrderCCs,
         out subnetworkConnection::Route_T route) 
         raises (globaldefs::ProcessingFailureException);


  /**
   * <p> This operation will return the SubnetworkConnection structure 
   * for the SNC whose name is supplied as a parameter. </p>
   *
   * @parm globaldefs::NamingAttributes sncName: The name of the SNC to retrieve.
   * @parm subnetworkConnection::SubnetworkConnection_T snc: The SNC structure retrieved.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when sncName does not reference a subnetworkConnection object<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when sncName references an SNC object that does not exist<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost<br>
   * </dir>
   **/