NMS_V5DeleteE1

Deletes an E1 link from an active variant of a provisioned interface.

Prototype

NMS_V5_RESULT_T NMS_V5DeleteE1( NMS_V5_INTERFACE_ID_T interfaceId, NMS_V5_E1_LOCATION_T e1_loc)

Argument

Description

interfaceId

Interface ID of a provisioned interface.

e1_loc

E1 link location specified by the following structure:

typedef union _NMS_V5_E1_LOCATION_T
{
   struct {
   DWORD  boardNb;
   DWORD  trunkNb;
}  CG;
}NMS_V5_E1_LOCATION_T;

See the Details section for field descriptions.


Return values

Return value

Description

NMSV5_SUCCESS

 

NMSV5_INTERNAL_FAILURE

Internal failure. Refer to the trace log for more information.

NMSV5_INVALID_INTERFACE_ID

Specified interface is not provisioned.

NMSV5_NOT_INITIALIZED

NMS V5 library was not initialized with NMS_V5Initialize.


Details

NMS_V5DeleteE1 deletes an E1 link associated with voice or HDLC channels from an active variant of a provisioned interface without requiring the application to re-provision the interface. However, applications must remove any HDLC channels associated with an E1 link before invoking NMS_V5DeleteE1 for that link.

When the application invokes NMS_V5DeleteE1, the NMS V5 library stops monitoring status information associated with the physical E1 link. Applications cannot call NMS_V5DeleteE1 on standby variants.

Applications provide the following information in the NMS_V5_E1_LOCATION_T structure:

Field

Description

boardNb

Logical board number where the E1 link is located (as defined by NMS OAM).

trunkNb

Logical trunk number associated with the E1 link (as defined by NMS OAM).


See also

NMS_V5ProvisionInterface, NMS_V5AddE1

Example

void  DeleteE1( void )
{
    NMS_V5_RESULT_T       NmsResult;
    DWORD                 InterfaceId;
    NMS_V5_E1_LOCATION_T  NMSE1Loc;

    printf("NMS_V5DeleteE1:\n");

    PrintInterfaces();
    /* Get parameters */
    promptdw_nodft("Enter interfaceId", &InterfaceId);

    /* Ask for E1 location parameters */
    GetE1LocationNMS( &NMSE1Loc ); 

    NmsResult = NMS_V5DeleteE1( InterfaceId, NMSE1Loc );

    printf ("NMS_V5DeleteE1: Result=%s\n",PRINT_RESULT(NmsResult));
}