Operation

post /esmService/MCLAG/abortMclag
abortMclag (abortMclag : /esmService/MCLAG/abortMclag)
abortMclag

Request body

Name

IsRequired

Description

Data Type

Enum

body optional reqData N_MCLagIdHolder ---

Return type
  • N_MCLagIdRespHolder
  • Responses

    Response Messages

    Schema

    200success N_MCLagIdRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    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/xml

    External Docs
    See Also :

    Operation

    post /esmService/MCLAG/allocateMclag
    allocateMCLAG (allocateMCLAG : /esmService/MCLAG/allocateMclag)
    allocateMCLAG

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData MCLAGInstHolderMapper ---

    Return type
  • MCLAGDataRespHolder
  • Responses

    Response Messages

    Schema

    200success MCLAGDataRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    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/xml

    External Docs
    See Also :

    Operation

    post /esmService/MCLAG/dbDeleteMclag
    dbDeleteMclag (dbDeleteMclag : /esmService/MCLAG/dbDeleteMclag)
    dbDeleteMclag

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData N_MCLagIdHolder ---

    Return type
  • N_MCLagIdRespHolder
  • Responses

    Response Messages

    Schema

    200success N_MCLagIdRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    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/xml

    External Docs
    See Also :

    Operation

    post /esmService/MCLAG/deleteMclag
    deleteMclag (deleteMclag : /esmService/MCLAG/deleteMclag)
    deleteMclag

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData N_MCLagIdHolder ---

    Return type
  • N_MCLagIdRespHolder
  • Responses

    Response Messages

    Schema

    200success N_MCLagIdRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    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/xml

    External Docs
    See Also :

    Operation

    post /esmService/MCLAG/forceActiveStandbyMCLAG
    forceActiveStandbyMCLAG (forceActiveStandbyMCLAG : /esmService/MCLAG/forceActiveStandbyMCLAG)
    forceActiveStandbyMCLAG

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData N_MCLagPeerIdUIHolder ---

    Return type
  • MCLAGDataRespHolder
  • Responses

    Response Messages

    Schema

    200success MCLAGDataRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    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/xml

    External Docs
    See Also :

    Operation

    post /esmService/MCLAG/modifySaveMclagInstance
    modifySaveMCLAG (modifySaveMCLAG : /esmService/MCLAG/modifySaveMclagInstance)
    modifySaveMCLAG

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData MCLAGInstHolderMapper ---

    Return type
  • MCLAGDataRespHolder
  • Responses

    Response Messages

    Schema

    200success MCLAGDataRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    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/xml

    External Docs
    See Also :

    Operation

    post /esmService/MCLAG/overrideMCLAGAttributes
    overrideMCLAGAttributes (overrideMCLAGAttributes : /esmService/MCLAG/overrideMCLAGAttributes)
    overrideMCLAGAttributes

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData MCLAGInstHolderMapper ---

    Return type
  • MCLAGDataRespHolder
  • Responses

    Response Messages

    Schema

    200success MCLAGDataRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    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/xml

    External Docs
    See Also :

    Operation

    post /esmService/MCLAG/plannedToAllocateMCLAG
    plannedToAllocateMCLAG (plannedToAllocateMCLAG : /esmService/MCLAG/plannedToAllocateMCLAG)
    plannedToAllocateMCLAG

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData N_MCLagIdHolder ---

    Return type
  • N_MCLagIdRespHolder
  • Responses

    Response Messages

    Schema

    200success N_MCLagIdRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    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/xml

    External Docs
    See Also :

    Operation

    post /esmService/MCLAG/allocateToDeployMCLAG
    scheduleAllocateToDeployMCLAG (scheduleAllocateToDeployMCLAG : /esmService/MCLAG/allocateToDeployMCLAG)
    scheduleAllocateToDeployMCLAG

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData MCLAGInstHolderMapper ---

    Return type
  • MCLAGDataRespHolder
  • Responses

    Response Messages

    Schema

    200success MCLAGDataRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    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/xml

    External Docs
    See Also :

    Operation

    post /esmService/MCLAG/schedForceCompleteMCLAG
    scheduleForceCompleteMCLAGInstance (scheduleForceCompleteMCLAGInstance : /esmService/MCLAG/schedForceCompleteMCLAG)
    scheduleForceCompleteMCLAGInstance

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData N_MCLagIdHolder ---

    Return type
  • N_MCLagIdRespHolder
  • Responses

    Response Messages

    Schema

    200success N_MCLagIdRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    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/xml

    External Docs
    See Also :

    Operation

    post /esmService/MCLAG/scheduledActivateMCLag
    scheduledActivateMCLag (scheduledActivateMCLag : /esmService/MCLAG/scheduledActivateMCLag)
    scheduledActivateMCLag

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData N_MCLagIdHolder ---

    Return type
  • N_MCLagIdRespHolder
  • Responses

    Response Messages

    Schema

    200success N_MCLagIdRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    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/xml

    External Docs
    See Also :

    Operation

    post /esmService/MCLAG/scheduledBackToAllocateMCLag
    scheduledBackToAllocateMCLag (scheduledBackToAllocateMCLag : /esmService/MCLAG/scheduledBackToAllocateMCLag)
    scheduledBackToAllocateMCLag

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData N_MCLagIdHolder ---

    Return type
  • N_MCLagIdRespHolder
  • Responses

    Response Messages

    Schema

    200success N_MCLagIdRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    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/xml

    External Docs
    See Also :

    Operation

    post /esmService/MCLAG/scheduledDeactivateMCLag
    scheduledDeactivateMCLag (scheduledDeactivateMCLag : /esmService/MCLAG/scheduledDeactivateMCLag)
    scheduledDeactivateMCLag

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData N_MCLagIdHolder ---

    Return type
  • N_MCLagIdRespHolder
  • Responses

    Response Messages

    Schema

    200success N_MCLagIdRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    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/xml

    External Docs
    See Also :

    Operation

    post /esmService/MCLAG/scheduledDeleteMCLag
    scheduledDeleteMCLag (scheduledDeleteMCLag : /esmService/MCLAG/scheduledDeleteMCLag)
    scheduledDeleteMCLag

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData N_MCLagIdHolder ---

    Return type
  • N_MCLagIdRespHolder
  • Responses

    Response Messages

    Schema

    200success N_MCLagIdRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    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/xml

    External Docs
    See Also :

    Operation

    post /esmService/MCLAG/deployMclag
    scheduledDeployMCLAG (scheduledDeployMCLAG : /esmService/MCLAG/deployMclag)
    scheduledDeployMCLAG

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData MCLAGInstHolderMapper ---

    Return type
  • MCLAGDataRespHolder
  • Responses

    Response Messages

    Schema

    200success MCLAGDataRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    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/xml

    External Docs
    See Also :

    Operation

    post /esmService/MCLAG/schedModifyMCLAG
    scheduledModifyMCLAG (scheduledModifyMCLAG : /esmService/MCLAG/schedModifyMCLAG)
    scheduledModifyMCLAG

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData MCLAGInstHolderMapper ---

    Return type
  • MCLAGDataRespHolder
  • Responses

    Response Messages

    Schema

    200success MCLAGDataRespHolder
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    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/xml

    External Docs
    See Also :

    ElementaryMep

    Name

    Type

    Description

    Enum

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

    eOAMRemoteMepInst

    Name

    Type

    Description

    Enum

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

    MCLAG_PeerLagUIData

    Name

    Type

    Description

    Enum

    lagEncapType String string --- ---
    nePack1 NeNamePackName NeNamePackName --- ---
    peer1Name String string --- ---
    lag1Name String string --- ---
    lagRate String string --- ---
    nePack2 NeNamePackName NeNamePackName --- ---
    peer2Name String string --- ---
    lag2Name String string --- ---

    MCLAGDataRespHolder

    Name

    Type

    Description

    Enum

    responseId ResponseHeader ResponseHeader --- ---
    response MCLAGInstMapper MCLAGInstMapper --- ---
    mcLagId Integer integer --- ---

    MCLAGInstHolderMapper

    Name

    Type

    Description

    Enum

    sessionId String string --- ---
    requestURI String string --- ---
    logReqId String string --- ---
    operator String string --- ---
    client String string --- ---
    req MCLAGInstMapper MCLAGInstMapper --- ---
    scheduler SchedReqMapper SchedReqMapper --- ---
    oam nOAMInstMapper nOAMInstMapper --- ---
    oamConfigured Boolean boolean --- ---
    activate Boolean boolean --- ---

    MCLAGInstMapper

    Name

    Type

    Description

    Enum

    reqId nRequestHeaderMapper nRequestHeaderMapper --- ---
    mcLagName String string --- ---
    description String string --- ---
    author String string --- ---
    configurationType String string --- ---
    neNamePackNames array[NeNamePackName] NeNamePackName --- ---
    controlServiceName String string --- ---
    erpName String string --- ---
    cvLan String string --- ---
    svLan String string --- ---
    customer String string --- ---
    vsOperationalMode String string --- ---
    vplsName String string --- ---
    peers MCLAGPeers MCLAGPeers --- ---
    systemId String string --- ---
    systemPriority Integer integer --- ---
    adminKey Integer integer --- ---
    flushEthernetRingEnabled Boolean boolean --- ---
    peerLagData array[MCLAG_PeerLagUIData] MCLAG_PeerLagUIData --- ---
    preCliCommand String string --- ---
    postCliCommand String string --- ---
    managementState String string --- ---
    bindingEnabled Boolean boolean --- ---
    controlServiceProtected Boolean boolean --- ---

    MCLAGPeerDetails

    Name

    Type

    Description

    Enum

    peerName String string --- ---
    description String string --- ---

    MCLAGPeers

    Name

    Type

    Description

    Enum

    peerData array[MCLAGPeerUIData] MCLAGPeerUIData --- ---
    neighborFailureMultiplier Integer integer --- ---
    keepAliveInterval Integer integer --- ---

    MCLAGPeerUIData

    Name

    Type

    Description

    Enum

    neNamePackName NeNamePackName NeNamePackName --- ---
    peerList array[MCLAGPeerDetails] MCLAGPeerDetails --- ---

    N_MCLagId

    Name

    Type

    Description

    Enum

    mclagConfigName String string --- ---
    jobTaskId Long long --- ---
    author String string --- ---
    description String string --- ---
    mclagConfigHandle Long long --- ---
    configType String string --- ---
    targetManagementState String string --- ---
    customerName String string --- ---
    managementState String string --- ---

    N_MCLagIdHolder

    Name

    Type

    Description

    Enum

    sessionId String string --- ---
    requestURI String string --- ---
    logReqId String string --- ---
    operator String string --- ---
    client String string --- ---
    reqId nRequestHeaderMapper nRequestHeaderMapper --- ---
    req N_MCLagId N_MCLagId --- ---
    scheduler SchedReqMapper SchedReqMapper --- ---
    activate Boolean boolean --- ---

    N_MCLagIdRespHolder

    Name

    Type

    Description

    Enum

    responseId ResponseHeader ResponseHeader --- ---
    rsp N_MCLagId N_MCLagId --- ---

    N_MCLagPeerId

    Name

    Type

    Description

    Enum

    mclagConfigHandle Long long --- ---
    mclagConfigName String string --- ---
    configType String string --- ---
    targetNeName String string --- ---
    targetPackName String string --- ---
    targetSourceId Long long --- ---
    targetPeerId Long long --- ---
    prevToPrevOper Integer integer --- ---
    operation String string --- ---
    forceCurrentOperation String string --- ---
    forcePrevOperation String string --- ---
    jobTaskId Long long --- ---

    N_MCLagPeerIdUIHolder

    Name

    Type

    Description

    Enum

    sessionId String string --- ---
    requestURI String string --- ---
    logReqId String string --- ---
    operator String string --- ---
    client String string --- ---
    reqId nRequestHeaderMapper nRequestHeaderMapper --- ---
    req N_MCLagPeerId N_MCLagPeerId --- ---
    scheduler SchedReqMapper SchedReqMapper --- ---
    activate Boolean boolean --- ---

    NeNamePackName

    Name

    Type

    Description

    Enum

    neName String string --- ---
    packName String string --- ---

    nMAInstMapper

    Name

    Type

    Description

    Enum

    remoteMepInstList array[eOAMRemoteMepInst] eOAMRemoteMepInst --- ---
    maName String string --- ---
    maFormat String string --- ---
    ccmInterval String string --- ---
    mhfCreation String string --- ---
    mep nMEPInstMapper nMEPInstMapper --- ---
    remteMepList array[eOAMRemoteMepInst] eOAMRemoteMepInst --- ---

    nMepAISInstMapper

    Name

    Type

    Description

    Enum

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

    nMepCCMInstMapper

    Name

    Type

    Description

    Enum

    ccmEnabled Boolean boolean --- ---
    priority Integer integer --- ---

    nMEPInstMapper

    Name

    Type

    Description

    Enum

    upDirectionally Boolean boolean --- ---
    interfaceType String string --- ---
    active Boolean boolean --- ---
    controlMepEnabled Boolean boolean --- ---
    lowestPriorityDeffect String string --- ---
    propagateHoldTime Integer integer --- ---
    standbyMepShutdownEnabled Boolean boolean --- ---
    ccm nMepCCMInstMapper nMepCCMInstMapper --- ---
    ais nMepAISInstMapper nMepAISInstMapper --- ---

    nOAMInstMapper

    Name

    Type

    Description

    Enum

    templateName String string --- ---
    mdLevel Integer integer --- ---
    mdFormat String string --- ---
    maInst nMAInstMapper nMAInstMapper --- ---
    elementaryMepList array[ElementaryMep] ElementaryMep --- ---

    nRequestHeaderMapper

    Name

    Type

    Description

    Enum

    reqId String string --- ---
    clientName String string --- ---

    RequestHeader

    Name

    Type

    Description

    Enum

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

    ResponseHeader

    Name

    Type

    Description

    Enum

    req RequestHeader RequestHeader --- ---
    errorReason String string --- ---
    errorCode String string --- ---
    message String string --- ---
    cmdStatus String string --- ---
    opMsg String string --- ---
    msgCode String string --- ---
    parameters array[String] string --- ---
    paramCount Integer integer --- ---
    objectId Integer integer --- ---
    jobName String string --- ---
    objectType Integer integer --- ---

    SchedReqMapper

    Name

    Type

    Description

    Enum

    jobName String string --- ---
    jobDescription String string --- ---
    username String string --- ---
    trigger SchedTriggerMapper SchedTriggerMapper --- ---

    SchedTriggerMapper

    Name

    Type

    Description

    Enum

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