Operation

post /carrierEthLinks/dbDeleteSOAMInstance
Perform DB-Delete operation on the SOAM entities deployed on OTN E-Line connection. (dbDeleteSOAMInstance : /carrierEthLinks/dbDeleteSOAMInstance)
Perform DB-Delete operation on the SOAM entities deployed on OTN E-Line connection.

Request body

Name

IsRequired

Description

Data Type

Enum

body required Link Data OtnElineLinkTemplate ---

Return type
  • ServiceResponseHolderModel
  • Responses

    Response Messages

    Schema

    200success ServiceResponseHolderModel
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    post /carrierEthLinks/scheduledConfigureSoamOnOtnElineLink
    Configure SOAM on Otn Eline Link (scheduledConfigureSoamOnOtnElineLink : /carrierEthLinks/scheduledConfigureSoamOnOtnElineLink)
    Used to configure SOAM on Otn Eline Link
    And to Enable PM

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required Link Data OtnElineLinkTemplate ---

    Return type
  • ServiceResponseHolderModel
  • Responses

    Response Messages

    Schema

    200success ServiceResponseHolderModel
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    E_OAM_RemoteMepData

    Name

    Type

    Description

    Enum

    vsId Integer integer --- ---
    eMaId Integer integer --- ---
    eMdId Integer integer --- ---
    remoteMepIds array[Integer] integer --- ---

    ElementaryMep

    Name

    Type

    Description

    Enum

    mepId Integer integer --- ---
    maId Integer integer --- ---
    mdId Integer integer --- ---
    vsId Integer integer --- ---
    macAddress String string --- ---
    neName String string --- ---

    Entry«string,ArrayList«int»»

    Name

    Type

    Description

    Enum

    key array[Integer] integer --- ---

    EsmMplstpAttributesDataModel

    Name

    Type

    Description

    Enum

    pwStatusSignalEnabled String string Status Signal Enable/Disable ---
    pwControlChannelEnabled String string Control Channel Enable/Disable ---
    pwAcknowledgementEnabled String string PW Acknowledgement Enable/Disable ---
    epStandbySignallingMaster String string Stand By Signalling Master ---
    epStandbySignallingSlave String string Stand By Signalling Slave ---
    pwRefreshTimer Long long Refresh Timer in Seconds ---
    pwRequestTimer Long long Request Timer in Seconds ---
    pwRetryTimer Long long Retry Timer in Seconds ---
    pwTimeoutMultiplier Long long Timeout Multiplier in Seconds ---
    epRevertTimer Long long Revert Timer in Seconds ---
    epActiveHoldDelay Long long Active Hold Delay in deciSeconds ---

    EsmRequestHeaderMapper

    Name

    Type

    Description

    Enum

    reqId String string Request ID ---
    clientName String string Client name ---

    ESMSchedulerDataModel

    Name

    Type

    Description

    Enum

    jobName String string Job Name ---
    jobDescription String string Job description ---
    username String string User name ---
    trigger ESMSchedulerTriggerDataModel ESMSchedulerTriggerDataModel Job Trigger data model ---

    ESMSchedulerTriggerDataModel

    Name

    Type

    Description

    Enum

    name String string Trigger Name ---
    deployNow String string Deploy Now [Yes]
    type String string Job Type ---
    expression String string Job trigger expression ---
    timeOffset String string User PC time zone offset ---

    N_END_END_OAM_DATA

    Name

    Type

    Description

    Enum

    nmlServiceId Long long --- ---
    neId Long long --- ---
    tpId Long long --- ---
    cvLan Long long --- ---
    autoGenVlanId Long long --- ---
    mclagConfigHandle Long long --- ---
    oamData N_MD_Data N_MD_Data --- ---
    oamEnabled Boolean boolean --- ---
    prevOamEnabled Boolean boolean --- ---

    N_LINK_OAM_DATA

    Name

    Type

    Description

    Enum

    nmlServiceId Long long --- ---
    aNeId Long long --- ---
    aTpId Long long --- ---
    zNeId Long long --- ---
    zTpId Long long --- ---
    linkId Long long --- ---
    vlanId Long long --- ---
    autoGenVlanId Long long --- ---
    oamData N_MD_Data N_MD_Data --- ---
    oamEnabled Boolean boolean --- ---
    prevOamEnabled Boolean boolean --- ---
    presetRemoteMEPID Integer integer --- ---

    N_MA_Data

    Name

    Type

    Description

    Enum

    maId Long long --- ---
    format String string --- ---
    maName String string --- ---
    ccmInterval Integer integer --- ---
    mhfCreation String string --- ---
    mepData N_MEP_Data N_MEP_Data --- ---
    remoteMepDataList array[E_OAM_RemoteMepData] E_OAM_RemoteMepData --- ---
    manameTpId array[Entry«string,ArrayList«int»»] Entry«string,ArrayList«int»» --- ---

    N_MD_Data

    Name

    Type

    Description

    Enum

    mdId Long long --- ---
    mdFormat String string --- ---
    mdLevel Integer integer --- ---
    maData N_MA_Data N_MA_Data --- ---
    type String string --- [SERVICE, ERP, QOS, ERP_TEMPLATE, SERVICE_TEMPLATE, INVALID, LAG, MCLAG, MPLSTP_NPA_TEMPLATE, MPLSTP_NPA, MPLSTP_TUNNEL, MPLSTP_TUNNEL_TEMPLATE, MPLSTP_NPA_PACK, MPLSTP_CHANNEL, PACKET_SWITCH_TEMPLATE, PACKET_SWITCH, DEMARCATION, ETH_IBM_ERP, ELINE]
    vsIdList array[Integer] integer --- ---
    modifyReq Boolean boolean --- ---

    N_MEP_AIS_Data

    Name

    Type

    Description

    Enum

    enabled Boolean boolean --- ---
    levels array[Integer] integer --- ---
    priority Integer integer --- ---
    interval Integer integer --- ---

    N_MEP_CCM_Data

    Name

    Type

    Description

    Enum

    N_MEP_Data

    Name

    Type

    Description

    Enum

    upDirectionally Boolean boolean --- ---
    interfaceType Integer integer --- ---
    active Boolean boolean --- ---
    controlMepEnabled Boolean boolean --- ---
    lowestPriorityDeffect Integer integer --- ---
    ccmEnable Boolean boolean --- ---
    ccmPriority Integer integer --- ---
    mepId Long long --- ---
    aisData N_MEP_AIS_Data N_MEP_AIS_Data --- ---
    ccmData N_MEP_CCM_Data N_MEP_CCM_Data --- ---
    propagateHoldTime Integer integer --- ---
    standbyMepShutdownEnabled Boolean boolean --- ---

    OtnElineLinkTemplate

    Name

    Type

    Description

    Enum

    sessionId String string --- ---
    requestURI String string --- ---
    logReqId String string --- ---
    operator String string --- ---
    client String string --- ---
    templateId Long long templateId ---
    templateName String string templateName ---
    templatePath String string templatePath ---
    descr String string descr ---
    linkName String string linkName ---
    linkRate String string linkRate ---
    linkId Long long linkId ---
    a1NeId Integer integer --- ---
    z1NeId Integer integer --- ---
    a1TpId Integer integer --- ---
    z1TpId Integer integer --- ---
    a1TpName String string --- ---
    z1TpName String string --- ---
    serviceState String string --- ---
    linkType Integer integer --- ---
    soamConfigured Boolean boolean --- ---
    maIndex Long long --- ---
    pmStartTime Long long --- ---
    managementState String string --- ---
    preOamConfigured Boolean boolean --- ---
    fromManagementState Integer integer --- ---
    toManagementState Integer integer --- ---
    consistencyState Integer integer --- ---
    remark String string --- ---
    oamData N_MD_Data N_MD_Data --- ---
    mdIndex Long long --- ---
    pmState Integer integer pmState ---
    pmStateEnabled Boolean boolean --- ---
    repProf15m String string repProf15m ---
    repProf24h String string repProf24h ---
    tcaProfName String string tcaProfName ---
    tcaProfOldName String string --- ---
    scheduler ESMSchedulerDataModel ESMSchedulerDataModel --- ---
    schedServiceData SchedServiceData SchedServiceData --- ---
    reqId EsmRequestHeaderMapper EsmRequestHeaderMapper --- ---
    req Request Header Request Header --- ---
    jobTaskId Long long --- ---
    endToEndOamDataList array[N_END_END_OAM_DATA] N_END_END_OAM_DATA --- ---
    linkOamDataList array[N_LINK_OAM_DATA] N_LINK_OAM_DATA --- ---
    elementaryMepList array[ElementaryMep] ElementaryMep --- ---
    id String string --- ---
    key String string --- ---
    className String string --- ---
    activate Boolean boolean --- ---

    OtnInterfaceLinkUIData

    Name

    Type

    Description

    Enum

    transportType String string --- ---
    srcGlobalID Long long --- ---
    srcNPAID Long long --- ---
    srcNodeID String string --- ---
    srcIsNPAConfigured Boolean boolean --- ---
    srcPrimaryState String string SourcePortPrimaryState [In Service, In Service, AINS, Out Of Service - Autonomous, Out Of Service - Auto and Mgmt, In Service - Autonomous, Maintenance]
    srcUserLabel String string --- ---
    linkBandWidth String string --- ---
    sinkGlobalID Long long --- ---
    sinkNPAID Long long --- ---
    sinkNodeID String string --- ---
    sinkIsNPAConfigured Boolean boolean --- ---
    sinkPrimaryState String string SinkPortPrimaryState [In Service, In Service, AINS, Out Of Service - Autonomous, Out Of Service - Auto and Mgmt, In Service - Autonomous, Maintenance]
    sinkUserLabel String string --- ---
    srcVSID Integer integer SrcVSID ---
    sinkVSID Integer integer SrcVSID ---
    connectionRate Integer integer --- ---
    internalConnId Integer integer --- ---
    srcLagPortMembers array[String] string --- ---
    sinkLagPortMembers array[String] string --- ---
    srcPortOrLagDescription String string --- ---
    sinkPortOrLagDescription String string --- ---
    orderid Integer integer --- ---
    aNetworkTechType Integer integer --- ---
    zNetworkTechType Integer integer --- ---
    oduFlexRate String string oduFlexRate ---
    tsCount String string --- ---
    aNeVersion String string --- ---
    zNeVersion String string --- ---
    id String string --- ---
    key String string --- ---
    className String string --- ---
    sinkVNE Boolean boolean --- ---
    srcVNE Boolean boolean --- ---

    PolicyModel

    Name

    Type

    Description

    Enum

    policyName String string Policy name ---
    policyType String string Policy type [None, Access, Network]
    policyId Long long System generated unique ID for the policy ---
    bestPractice Boolean boolean Is it a best practice policy being used ---
    nServiceHandle String string --- ---
    policyScope Integer integer --- ---
    templateType Integer integer --- ---
    jobTaskId Long long --- ---
    cirPirUnitReqd Boolean boolean --- ---

    PortModel

    Name

    Type

    Description

    Enum

    neName String string Network element name ---
    portName String string Port native name ---
    portRole String string Port role [ACCESS, UPLINK]
    portType String string Port type [ACCESS, UPLINK]
    tpID Integer integer System generated unique identifier for a port ---
    endpointType String string End point type [PORT, LAG, MCLAG]
    mclagId Integer integer MCLAG ID to be used ---
    vsId Integer integer --- ---
    shgId Long long System generated ID for the SHG ---
    shgName String string SHG name if hubAndSpoke value is Leaf ---
    shgDescription String string SHG description if hubAndSpoke value is Leaf ---
    hubAndSpoke String string Role of the port in Tree services [None, Root, Leaf]
    accessCVLANEnabled Boolean boolean Is access CVLAN enabled ---
    accessSVLANEnabled Boolean boolean Is access SVLAN enabled ---
    accessCVLAN String string Access CVLAN value ---
    accessSVLAN String string Access SVLAN value ---
    fragmentType Integer integer Whether the service is Tagged or allows all frames ---

    PortPolicyModel

    Name

    Type

    Description

    Enum

    sessionId String string --- ---
    requestURI String string --- ---
    logReqId String string --- ---
    operator String string --- ---
    client String string --- ---
    port PortModel PortModel Port model ---
    policyId PolicyModel PolicyModel QoS Policy model ---
    activate Boolean boolean --- ---

    Request Header

    Name

    Type

    Description

    Enum

    respBeanRef String string --- ---
    selectiveSyncViaPolling Boolean boolean --- ---
    clientName String string ClientName ---
    reqId String string ReqId ---

    Response Header Model

    Name

    Type

    Description

    Enum

    req Request Header Request Header req ---
    errorReason String string errorReason [Error reason]
    errorCode String string --- ---
    message String string --- ---
    cmdStatus String string cmdStatus [Success, Failure, Timed-Out, Unknown]
    opMsg String string Operation message ---
    msgCode String string msgCode [Message code]
    parameters array[String] string --- ---
    paramCount Integer integer parameter count returned in the response ---
    objectId Integer integer Object Id ---
    jobName String string Job Name ---
    objectType Integer integer Job Object TYpe ---

    SchedServiceData

    Name

    Type

    Description

    Enum

    jobName String string --- ---
    jobDesc String string --- ---
    userName String string --- ---
    trigger SchedTriggerData SchedTriggerData --- ---

    SchedTriggerData

    Name

    Type

    Description

    Enum

    name String string --- ---
    deployNow String string --- ---
    type String string --- ---
    expression String string --- ---
    timeOffset String string --- ---

    ServiceDataModel

    Name

    Type

    Description

    Enum

    networkingTechnology String string --- ---
    autoRouting Boolean boolean --- ---
    pwStandby Boolean boolean --- ---
    segmentType String string --- ---
    tunnelDataList array[ServiceTunnelUIData] ServiceTunnelUIData --- ---
    templatePolicyName String string Template Policy Name ---
    objId Long long Object Id ---
    serviceType String string Service type [EPL, EVPL, EPLAN, EVPLAN, EPTREE, EVPTREE]
    serviceName String string Unique name for the service ---
    serviceOldName String string Old name of the service ---
    author String string Author for the service ---
    description String string Description for the service ---
    svcParams ServiceParams ServiceParams Additional service parameters ---
    vneScriptDataList array[VNEScriptData] VNEScriptData --- ---
    customerName String string Customer name ---
    cvlanId String string Customer VLAN ID ---
    svlanId String string Subscriber VLAN ID ---
    eTreeType String string ETree Type ---
    trunkSvlanId String string Trunk S-VLAN Id ---
    branchSvlanId String string Branch S-VLAN Id ---
    additionalInfo Object object --- ---
    serviceTemplateId Long long Template ID ---
    nmlRingNameList array[String] string Ring name list ---
    hubList array[Integer] integer Hub VSID list ---
    nmlLinkDataList array[OtnInterfaceLinkUIData] OtnInterfaceLinkUIData OTN link wrapper model list ---
    portQos array[PortPolicyModel] PortPolicyModel Port and QoS policy wrapper ---
    managementState String string Current management state of the service ---
    targetManagementState String string The target management state of the service ---
    reserveResource Boolean boolean Ports to be reserved ---
    preProvCliCmd String string Pre CLI commands ---
    postProvCliCmd String string Post CLI commands ---
    shgName String string Split Horizon Group Name ---
    shgDescription String string Split Horizon Group Description ---
    repProf15m String string 15 min PM report profile ---
    repProf24h String string 24 hour PM report profile ---
    tcaProfName String string TCA profile name to be used ---
    tcaProfOldName String string Old TCA profile name being modified ---
    mplstpAttributesData EsmMplstpAttributesDataModel EsmMplstpAttributesDataModel MplstpAttributesData ---
    cacCheck Boolean boolean cacCheck ---
    warningValidateOverride Boolean boolean Warning Validation Override to Skip ---

    ServiceParams

    Name

    Type

    Description

    Enum

    llf Integer integer LLF Enabled/Disabled [0, 1]
    l2pt Integer integer L2PT Enabled/Disabled [0, 1]
    lacp Integer integer LAPT Enabled/Disabled [0, 1]
    l2cp Integer integer L2CP Enabled/Disabled [0, 1]
    eplOp2TunnelEnabled Integer integer EPL Option 2 Tunnel Enabled/Disabled [0, 1]
    fragmentType Integer integer Fragment Type [0, 1]
    vlanRangeEnabled Integer integer VLAN Range Enabled/Disabled [0, 1]
    cvlan String string CVLAN Value ---

    ServiceResponseHolderModel

    Name

    Type

    Description

    Enum

    responseId Response Header Model Response Header Model Response wrapper for operation status ---
    response ServiceDataModel ServiceDataModel Wrapper for different attribute values that were used for the service ---

    ServiceTunnelUIData

    Name

    Type

    Description

    Enum

    tunnelName String string Tunnel Name ---
    tunnelId Integer integer Tunnel Id ---
    priority Integer integer Tunnel Priority [0, 1, 2, 3, 4]
    orderId Integer integer Tunnel Order ---
    aVsId Integer integer Tunnel A end VS id ---
    zVsId Integer integer Tunnel Z end VS id ---
    autogenerated_AToZLabel Integer integer Auto generated Service label for the tunnel : A-out , Z-in ---
    autogenerated_ZToALabel Integer integer Auto generated Service label for the tunnel : A-in , Z-out ---
    aNEName String string Node Name for Tunnel A end ---
    zNEName String string Node Name for Tunnel Z end ---
    lagAssn String string lags of mclag to which this tunnel should be associated ---
    lagAssnVsId Integer integer --- ---
    mclagName String string mclag for which this tunnel can be an ICB ---
    mclagId Integer integer mclag unique id for which this tunnel can be an ICB ---
    isICB Boolean boolean --- ---

    VNEScriptData

    Name

    Type

    Description

    Enum

    NENAME String string --- ---
    SCRIPTNAME String string --- ---