Operation

post /esmService/mplstptunnel/allocate
allocateMplsTpTunnel (allocateMplsTpTunnel : /esmService/mplstptunnel/allocate)
allocateMplsTpTunnel

Request body

Name

IsRequired

Description

Data Type

Enum

body optional reqData MPLSTPTunnelInstHolder ---

Return type
  • MPLSTP_TunnelResponseHolder
  • Responses

    Response Messages

    Schema

    200success MPLSTP_TunnelResponseHolder
    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 /esmService/mplstptunnel/allocateToPlan
    allocateToPlan (allocateToPlan : /esmService/mplstptunnel/allocateToPlan)
    allocateToPlan

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData MPLSTPTunnelIdHolder ---

    Return type
  • MPLSTP_TunnelResponseHolder
  • Responses

    Response Messages

    Schema

    200success MPLSTP_TunnelResponseHolder
    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 /esmService/mplstptunnel/dbDeleteTunnel
    dbDeleteTunnel (dbDeleteTunnel : /esmService/mplstptunnel/dbDeleteTunnel)
    dbDeleteTunnel

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData MPLSTPTunnelIdHolder ---

    Return type
  • MPLSTP_TunnelResponseHolder
  • Responses

    Response Messages

    Schema

    200success MPLSTP_TunnelResponseHolder
    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 /esmService/mplstptunnel/deleteTunnel
    deleteTunnel (deleteTunnel : /esmService/mplstptunnel/deleteTunnel)
    deleteTunnel

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData MPLSTPTunnelIdHolder ---

    Return type
  • MPLSTP_TunnelResponseHolder
  • Responses

    Response Messages

    Schema

    200success MPLSTP_TunnelResponseHolder
    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 /esmService/mplstptunnel/MBATunnel
    MBATunnel (mBATunnel : /esmService/mplstptunnel/MBATunnel)
    MBATunnel

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData MPLSTPTunnelIdHolder ---

    Return type
  • MPLSTP_TunnelResponseHolder
  • Responses

    Response Messages

    Schema

    200success MPLSTP_TunnelResponseHolder
    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 /esmService/mplstptunnel/modifyMplsTpTunnel
    modifyMplsTpTunnel (modifyMplsTpTunnel : /esmService/mplstptunnel/modifyMplsTpTunnel)
    modifyMplsTpTunnel

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData MPLSTPTunnelInstHolder ---

    Return type
  • MPLSTP_TunnelResponseHolder
  • Responses

    Response Messages

    Schema

    200success MPLSTP_TunnelResponseHolder
    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 /esmService/mplstptunnel/plan
    planMplsTpTunnel (planMplsTpTunnel : /esmService/mplstptunnel/plan)
    planMplsTpTunnel

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData MPLSTPTunnelInstHolder ---

    Return type
  • MPLSTP_TunnelResponseHolder
  • Responses

    Response Messages

    Schema

    200success MPLSTP_TunnelResponseHolder
    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 /esmService/mplstptunnel/planToAllocate
    planToAllocate (planToAllocate : /esmService/mplstptunnel/planToAllocate)
    planToAllocate

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData MPLSTPTunnelIdHolder ---

    Return type
  • MPLSTP_TunnelResponseHolder
  • Responses

    Response Messages

    Schema

    200success MPLSTP_TunnelResponseHolder
    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 /esmService/mplstptunnel/scheduledDeployMplsTpTunnel
    scheduledDeployMplsTpTunnel (scheduledDeployMplsTpTunnel : /esmService/mplstptunnel/scheduledDeployMplsTpTunnel)
    scheduledDeployMplsTpTunnel

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData MPLSTPTunnelInstHolder ---

    Return type
  • MPLSTP_TunnelResponseHolder
  • Responses

    Response Messages

    Schema

    200success MPLSTP_TunnelResponseHolder
    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 /esmService/mplstptunnel/scheduledForceCompleteMplsTpTunnel
    scheduledForceCompleteMplsTpTunnel (scheduledForceCompleteMplsTpTunnel : /esmService/mplstptunnel/scheduledForceCompleteMplsTpTunnel)
    scheduledForceCompleteMplsTpTunnel

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData MPLSTPTunnelIdHolder ---

    Return type
  • MPLSTP_TunnelResponseHolder
  • Responses

    Response Messages

    Schema

    200success MPLSTP_TunnelResponseHolder
    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 /esmService/mplstptunnel/scheduledModifyMplsTpTunnel
    scheduledModifyMplsTpTunnel (scheduledModifyMplsTpTunnel : /esmService/mplstptunnel/scheduledModifyMplsTpTunnel)
    scheduledModifyMplsTpTunnel

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData MPLSTPTunnelInstHolder ---

    Return type
  • MPLSTP_TunnelResponseHolder
  • Responses

    Response Messages

    Schema

    200success MPLSTP_TunnelResponseHolder
    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 /esmService/mplstptunnel/scheduledMoveToDeployMplsTpTunnel
    scheduledMoveToDeployMplsTpTunnel (scheduledMoveToDeployMplsTpTunnel : /esmService/mplstptunnel/scheduledMoveToDeployMplsTpTunnel)
    scheduledMoveToDeployMplsTpTunnel

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData MPLSTPTunnelIdHolder ---

    Return type
  • MPLSTP_TunnelResponseHolder
  • Responses

    Response Messages

    Schema

    200success MPLSTP_TunnelResponseHolder
    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 /esmService/mplstptunnel/scheduledSwitchAndClearTunnel
    scheduledSwitchAndClearTunnel (scheduledSwitchAndClearTunnel : /esmService/mplstptunnel/scheduledSwitchAndClearTunnel)
    scheduledSwitchAndClearTunnel

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData MPLSTPTunnelIdHolder ---

    Return type
  • MPLSTP_TunnelResponseHolder
  • Responses

    Response Messages

    Schema

    200success MPLSTP_TunnelResponseHolder
    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 /esmService/mplstptunnel/ScheduledTunnelActivate
    ScheduledTunnelActivate (scheduledTunnelActivate : /esmService/mplstptunnel/ScheduledTunnelActivate)
    ScheduledTunnelActivate

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData MPLSTPTunnelIdHolder ---

    Return type
  • MPLSTP_TunnelResponseHolder
  • Responses

    Response Messages

    Schema

    200success MPLSTP_TunnelResponseHolder
    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 /esmService/mplstptunnel/ScheduledTunnelDeactivate
    ScheduledTunnelDeactivate (scheduledTunnelDeactivate : /esmService/mplstptunnel/ScheduledTunnelDeactivate)
    ScheduledTunnelDeactivate

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData MPLSTPTunnelIdHolder ---

    Return type
  • MPLSTP_TunnelResponseHolder
  • Responses

    Response Messages

    Schema

    200success MPLSTP_TunnelResponseHolder
    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 /esmService/mplstptunnel/ScheduledTunnelDelete
    scheduledTunnelDelete (scheduledTunnelDelete : /esmService/mplstptunnel/ScheduledTunnelDelete)
    scheduledTunnelDelete

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData MPLSTPTunnelIdHolder ---

    Return type
  • MPLSTP_TunnelResponseHolder
  • Responses

    Response Messages

    Schema

    200success MPLSTP_TunnelResponseHolder
    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 /esmService/mplstptunnel/terminateMplsTpTunnel
    terminateMplsTpTunnel (terminateMplsTpTunnel : /esmService/mplstptunnel/terminateMplsTpTunnel)
    terminateMplsTpTunnel

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData MPLSTPTunnelIdHolder ---

    Return type
  • MPLSTP_TunnelResponseHolder
  • Responses

    Response Messages

    Schema

    200success MPLSTP_TunnelResponseHolder
    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 /esmService/mplstptunnel/updateMplsTpTunnelVNEScripts
    updateMplsTpTunnelVNEScripts (updateMplsTpTunnelVNEScripts : /esmService/mplstptunnel/updateMplsTpTunnelVNEScripts)
    updateMplsTpTunnelVNEScripts

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional reqData MPLSTPTunnelInstHolder ---

    Return type
  • MPLSTP_TunnelResponseHolder
  • Responses

    Response Messages

    Schema

    200success MPLSTP_TunnelResponseHolder
    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 :

    MPLSTP_TunnelResponseHolder

    Name

    Type

    Description

    Enum

    header ResponseHeader ResponseHeader --- ---
    tunnelData Object object --- ---

    MPLSTPBFDDataMapper

    Name

    Type

    Description

    Enum

    templateName String string --- ---
    templateDescr String string --- ---
    transmitTimer Long long --- ---
    receiveTimer Long long --- ---
    multiplier Long long --- ---

    MPLSTPOAMDataMapper

    Name

    Type

    Description

    Enum

    aTemplateName String string --- ---
    aDescr String string --- ---
    aHoldDownTime Long long --- ---
    aHoldUpTime Long long --- ---
    aBfdDataMapper MPLSTPBFDDataMapper MPLSTPBFDDataMapper --- ---
    zTemplateName String string --- ---
    zDescr String string --- ---
    zHoldDownTime Long long --- ---
    zHoldUpTime Long long --- ---
    bfdEnable String string --- ---
    zBfdDataMapper MPLSTPBFDDataMapper MPLSTPBFDDataMapper --- ---

    MPLSTPProtectionDataMapper

    Name

    Type

    Description

    Enum

    aTemplateName String string --- ---
    aProtectionTemplateName String string --- ---
    aDescr String string --- ---
    aProtectionType String string --- ---
    aWaitToRestore Long long --- ---
    aRapidPscTimer Integer integer --- ---
    aSlowPscTimer Long long --- ---
    zTemplateName String string --- ---
    zProtectionTemplateName String string --- ---
    zDescr String string --- ---
    zProtectionType String string --- ---
    zWaitToRestore Long long --- ---
    zRapidPscTimer Integer integer --- ---
    zSlowPscTimer Long long --- ---

    MPLSTPTunnelId

    Name

    Type

    Description

    Enum

    tunnelId Long long --- ---
    tunnelName String string --- ---
    fromManagementState String string --- ---
    toManagementState String string --- ---
    jobTaskId Long long --- ---
    switchOperationName String string --- ---
    endPack String string --- ---

    MPLSTPTunnelIdHolder

    Name

    Type

    Description

    Enum

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

    MPLSTPTunnelInstHolder

    Name

    Type

    Description

    Enum

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

    MPLSTPTunnelInstMapper

    Name

    Type

    Description

    Enum

    tunnelName String string --- ---
    new_tunnelName String string --- ---
    tunnelDescr String string --- ---
    author String string --- ---
    protectedTunnel Boolean boolean --- ---
    autoRouting Boolean boolean --- ---
    manualRouting Boolean boolean --- ---
    additionalInfo Object object --- ---
    managementState String string --- ---
    targetManagementState String string --- ---
    templateId Long long --- ---
    reserveResource Boolean boolean --- ---
    aNEName String string --- ---
    zNEName String string --- ---
    aPackName String string --- ---
    zPackName String string --- ---
    oamDataMapper MPLSTPOAMDataMapper MPLSTPOAMDataMapper --- ---
    protectionDataMapper MPLSTPProtectionDataMapper MPLSTPProtectionDataMapper --- ---
    preProvCliCmd String string --- ---
    postProvCliCmd String string --- ---
    switchOperationName String string --- ---
    endPack String string --- ---
    bfdEnabled String string --- ---
    vneScriptDataList array[VNEScriptData] VNEScriptData --- ---
    includeListWorking array[String] string --- ---
    excludeListWorking array[String] string --- ---
    includeListProtection array[String] string --- ---
    excludeListProtection array[String] string --- ---

    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 --- ---

    VNEScriptData

    Name

    Type

    Description

    Enum

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