multilayersubnetwork.idl

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

   void getSNC(
         in globaldefs::NamingAttributes_T sncName,
         out subnetworkConnection::SubnetworkConnection_T snc)
        raises (globaldefs::ProcessingFailureException);


  /**
   * <p> This operation will return the SubnetworkConnection structures 
   * for the SNCs whose userLabel is supplied as a parameter. </p>
   *
   * <p>This operation does not use an iterator, since the number of SNCs
   * returned is expected to be usually 1.</p>
   *
   * @parm string userLabel: The userLabel of the SNCs to retrieve.
   * @parm subnetworkConnection::SubnetworkConnection_T sncList: The SNCs retrieved.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost<br>
   * </dir>
   **/
   void getSNCsByUserLabel(
         in string userLabel,
         out subnetworkConnection::SubnetworkConnectionList_T sncList)
        raises (globaldefs::ProcessingFailureException);


  /**
   * <p>The NMS invokes the createSNC service to request the EMS to create an SNC given
   * the parameters passed in the method.</p>
   *
   * <p>Failure : This will throw an exception if it fails.  No SNC object 
   * will be created on the EMS.</p> 
   *
   * <p>Success : SNC is created in the EMS and the SNCState is set to the appropriate state
   * in the parameter theSNC.  The parameter theSNC will contain the attributes of 
   * the created SNC.</p>
   *
   * <p>For more details on how this service affects the state of an SNC see
   * <a href=supportingDocumentation/modesOfOperation.html>SNC Management Modes of Operation</a>
   * and
   * <a href=supportingDocumentation/SNCStateDiagram.pdf>SNC state diagram</a>.</p>
   *
   * <p>If an existing SNC respects all the conditions described in createData, 
   * then the EMS is allowed to return that existing SNC.  It is also allowed for 
   * the EMS to attempt to create a different SNC as explained below.  The rest of the
   * description below applies to the cases where the EMS decides to create a new SNC.</p>
   *
   * <p>If the NMS specifies a routing constraint in the request, then the EMS must respect
   * the specified constraint even if there are pending, partial, or active SNCs using
   * the required parts of the route.</p>
   * 
   * <p>The EMS tries to find a route for the request and if found
   * returns the SubnetworkConnection_T structure back to the NMS with the 
   * members set to the appropriate values.  The EMS should attempt to find a route that
   * does not conflict or share CCs with any other existing SNC, before it resorts to
   * creating a conflicting SNC or an SNC that shares CCs.</p>
   *
   * <p>If the CTPs at the Aend and the Zend are already
   * in use by another SNC, the EMS may still create the SNC
   * or EXCPT_OBJECT_IN_USE or EXCPT_TIMESLOT_IN_USE may be thrown,
   * depending on its mode of operation.</p>
   *
   * <p>If there already exists
   * between the same termination points and with the same directionality and type, 
   * another SNC that is in the partial state, the EMS will still attempt to create
   * the new SNC.
   * If no constraint is specified, the EMS should   
   * attempt to find a different path. If constraints are specified, then the EMS attempts 
   * to create the SNC with an appropriate route.</p>
   *
   * <p>If a route cannot be found, the SNC is <b>not</b> created in the EMS 
   * and the EXCPT_UNABLE_TO_COMPLY exception 
   * is thrown (unless a more precise exception applies), indicating the reason.</p>
   *
   * <p>Depending on the SNC management mode of operation, it is acceptable for an EMS
   * to not implement this service in which case 
   * the EXCPT_NOT_IMPLEMENTED exception is thrown.</p>
   * 
   * <p>VC SNCs are normally created over a VP network. Therefore, the VPI numbers of the VC SNCs
   * specified with createData should match existing terminated and mapped VP CTPs.
   * If a VPI number does not match an existing VP CTP, then the EMS may create
   * the VP CTP as 'TERMINATED and MAPPED' if emsFreedomLevel allows it. 
   * Such a VP CTP is created with no traffic parameters. Note that such
   * automatic creation of resourceless terminated VP CTPs depends on the capability
   * of the EMS and/or the ATM NE to support VC connections directly on ATM links
   * (i.e., with no VP overlay network).</p>
   * 
   * <p>An NMS can request the EMS to create an ATM network routed SNC (VP or VC layer rates);
   * the EMS will then manage the subnetwork connection as a soft PVC. The soft PVC may
   * be completely or partially defined with regards to its source and destination CTPs.
   * The aEnd will, by definition, be the source of the Soft PVC (i.e., the originator
   * of the call) and the zEnd will be the destination (i.e., being called). In order
   * to allow the NMS to manage Soft PVCs that may have only their source CTPs in
   * the subnetwork, the ctpName parameter from TPDataList zEnd will be used to either
   * specify the VPI and/or VCI value of the destination CTP (including EMS, 
   * managedElement, PTP and ATM_NI a.k.a., the full location in the physical ATM NE)
   * or the address of the ATM interface on which the call will terminate and optionally
   * the VPI/VCI values if they are specified/known by the NMS (but not the complete
   * physical location of the VP or VC CTP).<p>
   *
   * <p>Note that all SNC state transitions (including to/from PENDING and PARTIAL)
   * are applicable to ATM VPCs and VCCs. However, the PARTIAL state should
   * only apply to plain PVCs (intermediate CTPs of a Soft PVC are automatically
   * created and deleted by the network elements and they do not usually notify 
   * the EMS).</p>
   *
   * <p>This operation is only used to create subnetwork connections in which CTPs are 
   * all cross-connected.  Trails can be created by the NMS by
   * using setTPData to terminate and map CTPs that are adjacent to the CTPs 
   * at the end of subnetwork connections created by means of createSNC.</p>
   *
   * <p>CreateSNC allows for the creation of either point-to-point
   * connections or legs of point-to-multipoint connections.</p>
   *
   * <p>To add a leg to a broadcast system, the aEnd TP in SNCCreateData_T shall
   * be populated with the common source TP of the broadcast system.
   * Each leg of a broadcast system is a separate SNC and is managed individually,
   * even though they may share cross-connects.
   * </p>
   *
   * <p>To create a broadcast system from a Point to Point SNC, the aEnd of the
   * Point to Point SNC is used as the aEnd TP in TPDataList_T.</p>
   *
   * @parm SNCCreateData_T createData: structure describing the subnetwork connection
   *  to be created.
   * @parm GradesOfImpact_T tolerableImpact: the maximum tolerable impact allowed.
   * @parm EMSFreedomLevel_T emsFreedomLevel: the maximum level of freedom allowed to the EMS
   *  to perform the creation.
   * @parm SubnetworkConnection_T theSNC:
   *  The newly created SNC.  It will have sncState and name set.  The EMS selects the SNC names
   *  so that they are not reused (within a reasonable time frame) for different SNCs.
   * @parm string errorReason: Specifies the creation error(s) if any.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_NOT_IMPLEMENTED - Raised if an EMS does not implement this service<br>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when a field of createData is invalid<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when fields of createData refer to an object that does
   *  not exist<br>
   * EXCPT_PROTECTION_EFFORT_NOT_MET - Raised if the NMS requests an SNC
   *  with a static protection level and protection effort that cannot be met by the EMS<br>
   * EXCPT_UNABLE_TO_COMPLY - Raised if the EMS is unable to find an appropriate
   *  route for the SNC<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost and this
   *  prevents creation of the SNC<br>
   * EXCPT_UNSUPPORTED_ROUTING_CONSTRAINTS - Raised if the EMS does not support the 
   *  routing constraints specified<br>
   * EXCPT_USERLABEL_IN_USE - Raised when the userLabel uniqueness constraint is not met<br>
   * </dir>
   **/
   void createSNC (
         in subnetworkConnection::SNCCreateData_T createData,
         in subnetworkConnection::GradesOfImpact_T tolerableImpact,
         in EMSFreedomLevel_T emsFreedomLevel,
         out subnetworkConnection::SubnetworkConnection_T theSNC, 
         out string errorReason)
         raises (globaldefs::ProcessingFailureException);

  /**
   * <p>This service is used to put an SNC into the ACTIVE state.</p>
   * 
   * <p><i>Success:</i> SNCState in the parameter theSNC is set to SNCS_ACTIVE.  
   * All cross-connects 
   * required for the SNC were activated successfully.
   * The errorReason parameter is set to an empty string.</p>
   *
   * <p><i>Failure:</i> No exception thrown, except in the cases listed below.
   * If the SNC or any of its network resources have changed as a result of this operation,
   * then no exception can be
   * thrown so that theSNC can be passed back to the NMS.
   * The SNCState in resulting theSNC will be either SNCS_PARTIAL or SNCS_PENDING.
   * The state will be SNCS_PARTIAL if not all
   * cross-connects on MEs have been successfully set up.  The state will be 
   * SNCS_PENDING if the EMS mode of operation prevents the activation of the SNC.
   * The errorReason parameter is set accordingly.</p>
   *
   * <p>For more details on how this service affects the state of an SNC see
   * <a href=supportingDocumentation/modesOfOperation.html>SNC Management Modes of Operation</a>
   * and
   * <a href=supportingDocumentation/SNCStateDiagram.pdf>SNC state diagram</a>.</p>
   *
   * <p> During activation of an SNC, the TPs of the SNC are configured, and the necessary 
   * cross-connects are established
   * for the SNC. An SNC can be activated while in any state.</p>
   *
   * <p>In case of an ATM SNC (VP or VC), multiple termination points (VP CTP or VC CTP) 
   * can be created as a result of an activateSNC operation. These CTPs are all created
   * in compliance with the egress and ingress traffic parameters provided in the 
   * tpsToModify structure. For example, a non terminated VP SNC created over 3 
   * managed elements will result, upon activation, in the usage of 6 VP CTPs
   * and 3 VP cross-connections.</p>
   *
   * <p>Note that the activateSNC operation can be called repeatedly and eventually
   * should succeed
   * (except in conflict cases where the SNC remains in SNCS_PENDING or SNCS_PARTIAL).
   * Should the missing cross-connects be activated in the MEs via 
   * a craft interface, for example, prior to communications to those MEs
   * being re-established, the activateSNC command ultimately should 
   * succeed when communication to the MEs is re-established 
   * (even though all cross-connects already exist).</p>
   * 
   * <p>The EMS will apply the transmissionParams specified 
   * in the tpsToModify parameter (same behaviour as
   * <a href=_managedElementManager.ManagedElementMgr_I.html#managedElementManager::ManagedElementMgr_I::setTPData>setTPData</a>).
   * They may be applied before or after the creation of the CCs, as appropriate.
   * Existing TP transmission parameters for which no changes
   * were requested in tpsToModify will be left unchanged.
   * However, the alarm reporting on the CTPs and the containing TPs
   * may be turned on by the EMS
   * as part of this request, unless otherwise specified via the transmission parameter
   * "AlarmReporting".  A similar behaviour is also allowed for the serviceState parameter,
   * which may be set to IN_SERVICE for the CTPs and the containing TPs.
   * See <a href=supportingDocumentation/layeredParameters.html>transmissionParameters</a>.
   * </p>
   * 
   * <p>If a given entry in the list of transmission parameters specified in
   * the TPData_T can not be successfully applied to the TP, for any reason, 
   * then the errorReason
   * field is appended with an appropriate reason text.
   * Applying transmission parameters is best-effort
   * and the resulting values of the transmission parameters
   * are provided in the updated tpsToModify parameter.</p>
   *
   * <p>An already active SNC
   * can be activated again; the EMS is allowed to not send the 
   * commands to the ME a second time for the cross connect establishment however
   * the commands may be sent for the transmission parameters.
   * While in SNCS_PARTIAL state, it is possible to activate an SNC again, this 
   * corresponds to a retry. </p>
   *
   * @parm NamingAttributes_T sncName: the name of the subnetwork connection to be deactivated.
   * @parm GradesOfImpact_T tolerableImpact: the maximum tolerable impact allowed.
   * @parm EMSFreedomLevel_T emsFreedomLevel: The maximum level of freedom allowed to the EMS
   * to perform the activation.<br>
   * @parm TPDataList_T tpsToModify: a list of TPs and parameters to apply, updated to 
   *  provide the resulting parameters.
   * @parm SubnetworkConnection theSNC: The subnetwork connection after the operation.
   * @parm string errorReason: Specifies the activation error(s) if any.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_NOT_IMPLEMENTED - Raised if an EMS does not implement this service; this is only
   *  allowed if the EMS does not support the PENDING state and if the PARTIAL state is
   *  unreachable<br>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when sncName does not refer to an SNC object, or any field
   *  in tpsToModify is invalid<br>
   * EXCPT_OBJECT_IN_USE - Raised if the SNC can not be activated because of CC or CTP conflicts
   *  with other SNCs<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised if sncName or tpsToModify reference an SNC/TP object
   *  that does not exist<br>