Operation

post /esmService/mplstptunnel/allocate
Creates a mplstp tunnel in Allocate management state (allocateMplsTpTunnel : /esmService/mplstptunnel/allocate)
Creates the mplstp tunnel entities in ESM only.As a part of allcoation, routes are determined between the Aend and Zend of the tunnel.If protection is enabled, it also finds the protection path.

Request body

Name

IsRequired

Description

Data Type

Enum

body required Mplstp Tunnel Data 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
    Example Request Data

    {"reqId":{},"req":{"tunnelName":"Tunnel_ex4","tunnelDescr":"","author":"alcatel","protectedTunnel":false,"autoRouting":true,"manualRouting":false,"aNEName":"SETUP-4V1-O","zNEName":"SETUP-4V1-M","aPackName":"11QCE12X-2-4","zPackName":"11OPE8-2-4","additionalInfo":{},"managementState":"NEW","targetManagementState":"ALLOCATED","templateId":0,"reserveResource":true,"oamDataMapper":{"aTemplateName":"Oam","aDescr":"Best Practices for Mpls Tp","aHoldDownTime":0,"aHoldUpTime":20,"zTemplateName":"Oam","zDescr":"Best Practices for Mpls Tp","zHoldDownTime":0,"zHoldUpTime":20,"aBfdDataMapper":{"templateName":"Bfd","templateDescr":"Best Practices for Mpls Tp","transmitTimer":3,"receiveTimer":"3","multiplier":3},"zBfdDataMapper":{"templateName":"Bfd","templateDescr":"Best Practices for Mpls Tp","transmitTimer":3,"receiveTimer":"3","multiplier":3}},"protectionDataMapper":{"aTemplateName":"Protection","aDescr":"Best Practices for Mpls Tp","aProtectionType":"Revertive","aWaitToRestore":300,"aRapidPscTimer":3.33,"aSlowPscTimer":5,"zTemplateName":"Protection","zDescr":"Best Practices for Mpls Tp","zProtectionType":"Revertive","zWaitToRestore":300,"zRapidPscTimer":3.33,"zSlowPscTimer":5},"preProvCliCmd":"","postProvCliCmd":"","bfdEnabled":"ccCv","vneScriptDataList":[]},"scheduler":{"trigger":{}}}

    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
    Example Response Data
    {"header":{"req":{"reqId":null,"respBeanRef":null,"clientName":null,"selectiveSyncViaPolling":false},"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Success","opMsg":"","msgCode":"MPLSTP_TUNNEL_ALLOCATE_SUCCESS_0001","parameters":["Tunnel_ex4"],"paramCount":1},"tunnelData":null}

    External Docs
    See Also :

    Operation

    post /esmService/mplstptunnel/allocateToPlan
    Move a mplstp tunnel from Allocate to Planned management state (allocateToPlan : /esmService/mplstptunnel/allocateToPlan)
    Tunnel from allocate to plan in ESM only

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required Mplstp Tunnel Data 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
    Example Request Data

    {"reqId":{},"req":{"tunnelName":"Tunnel_ex1","fromManagementState":"Allocated","toManagementState":"PLAN"},"scheduler":{"trigger":{}}}

    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
    Example Response Data
    {"header":{"req":null,"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Success","opMsg":"","msgCode":"MPLSTP_TUNNEL_PLAN_SUCCESS_0001","parameters":["Tunnel_ex1"],"paramCount":1},"tunnelData":null}

    External Docs
    See Also :

    Operation

    post /esmService/mplstptunnel/dbDeleteTunnel
    DB Delete a Tunnel (dbDeleteTunnel : /esmService/mplstptunnel/dbDeleteTunnel)
    This operation can be used to clean up a Tunnel and its associated entities from ESM database. However, the entities that are already deployed on the NE will remain as it is on the NE.

    State transition :
    Commissioned/Deploy-Failed/Modify-Failed -> DB Deleted

    Once the DB deleted operation is performed user is expected to trigger network discovery operation. This will make sure all the entities present in NE are synced up in ESM and there is no ID conflict during subsequent deployment operations. If user has done DB delete of a Consistent Tunnel, Network discovery will discover this Tunnel back. If user has done DB delete of an inconsistent Tunnel, Network discovery will not discover the whole Tunnel back. It will only sync the elementary entities from the NE to ESM. If the service is not discovered after network discovery, user can refer to Network discovery job list to know about the entities that are missing/mismatch. This is not a scheduled operation.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required Tunnel Data 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
    Example Request Data

    {"reqId":{},"req":{"tunnelName":"Tunnel_ex2","fromManagementState":"Allocated","toManagementState":"DBDELETE"},"scheduler":{"trigger":{}}}

    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
    Example Response Data
    {"header":{"req":null,"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Success","opMsg":"","msgCode":"MPLSTP_TUNNEL_DBDELETE_SUCCESS_0001","parameters":["Tunnel_ex2"],"paramCount":1},"tunnelData":null}

    External Docs
    See Also :

    Operation

    post /esmService/mplstptunnel/deleteTunnel
    Delete Tunnel (deleteTunnel : /esmService/mplstptunnel/deleteTunnel)
    Delete Tunnel from Planned and Allocated states

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required Mplstp Tunnel Id Holder Data 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
    Example Request Data

    {"reqId":{},"req":{"tunnelName":"Tunnel_ex1","fromManagementState":"Allocated","toManagementState":"DELETE"},"scheduler":{"trigger":{}}}

    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
    Example Response Data
    {"header":{"req":null,"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Failure","opMsg":"","msgCode":"MPLSTP_TUNNEL_DELETE_ERROR_0001","parameters":["Tunnel_ex1"],"paramCount":1,"output":null},"tunnelData":null}

    External Docs
    See Also :

    Operation

    post /esmService/mplstptunnel/MBATunnel
    MBATunnel (mBATunnel : /esmService/mplstptunnel/MBATunnel)
    Move Tunnel back to allocated state from from commissioned, deploy failed

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required Mplstp Tunnel Id Holder Data 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
    Example Request Data

    {"req":{"fromManagementState":"Commissioned","tunnelName":"Testing1","toManagementState":"ALLOCATED"},"reqId":{"reqId":6},"scheduler":{"username":"","jobName":"Testing1_Move Back to AllocateWed Dec 21 2016 16:49:46 UTC+5:30","jobDescription":"","trigger":{"name":"Testing1_Move Back to AllocateWed Dec 21 2016 16:49:46 UTC+5:30Trigger","deployNow":"Yes","type":"","expression":"","timeOffset":""}}}

    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
    Example Response Data
    {"header":{"req":null,"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Success","opMsg":"","msgCode":"MPLSTP_TUNNEL_MBA_SUCCESS_0001","parameters":["Testing1"],"paramCount":1},"tunnelData":null}S

    External Docs
    See Also :

    Operation

    post /esmService/mplstptunnel/modifyMplsTpTunnel
    Modify mplstp tunnel in Planned/allocate/commissioned management state (modifyMplsTpTunnel : /esmService/mplstptunnel/modifyMplsTpTunnel)
    Modify mplstp tunnel in Planned/allocate/commissioned management state

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required Mplstp Tunnel Data 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
    Example Request Data

    {"reqId":{},"req":{"tunnelName":"Tunnel_ex1","new_tunnelName":"Tunnel_ex1","tunnelDescr":"","author":"hjbv","protectedTunnel":false,"autoRouting":true,"manualRouting":false,"aNEName":"SETUP-4V1-O","zNEName":"SETUP-4V1-M","aPackName":"11QCE12X-2-4","zPackName":"11OPE8-2-5","additionalInfo":{},"managementState":"NEW","targetManagementState":"Allocated","templateId":0,"reserveResource":true,"oamDataMapper":{"aTemplateName":"Oam","aDescr":"Best Practices for Mpls Tp","aHoldDownTime":0,"aHoldUpTime":20,"zTemplateName":"Oam","zDescr":"Best Practices for Mpls Tp","zHoldDownTime":0,"zHoldUpTime":20,"aBfdDataMapper":{"templateName":"Bfd","templateDescr":"Best Practices for Mpls Tp","transmitTimer":3,"receiveTimer":"3","multiplier":3},"zBfdDataMapper":{"templateName":"Bfd","templateDescr":"Best Practices for Mpls Tp","transmitTimer":3,"receiveTimer":"3","multiplier":3}},"protectionDataMapper":{"aTemplateName":"Protection","aDescr":"Best Practices for Mpls Tp","aProtectionType":"Revertive","aWaitToRestore":300,"aRapidPscTimer":3.33,"aSlowPscTimer":5,"zTemplateName":"Protection","zDescr":"Best Practices for Mpls Tp","zProtectionType":"Revertive","zWaitToRestore":300,"zRapidPscTimer":3.33,"zSlowPscTimer":5},"preProvCliCmd":"","postProvCliCmd":"","bfdEnabled":"ccCv","vneScriptDataList":[]},"scheduler":{"trigger":{}}}

    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
    Example Response Data
    {"header":{"req":{"reqId":null,"respBeanRef":null,"clientName":null,"selectiveSyncViaPolling":false},"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Success","opMsg":"","msgCode":"MPLSTP_TUNNEL_MODIFY_SUCCESS_0001","parameters":["Tunnel_ex1"],"paramCount":1},"tunnelData":null}

    External Docs
    See Also :

    Operation

    post /esmService/mplstptunnel/plan
    Creates a mplstp tunnel in Planned management state (planMplsTpTunnel : /esmService/mplstptunnel/plan)
    Creates the mplstp tunnel entities in ESM only

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required Mplstp Tunnel Data 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
    Example Request Data

    {"reqId":{},"req":{"tunnelName":"Tunnel_ex1","tunnelDescr":"","author":"hjbv","protectedTunnel":false,"autoRouting":true,"manualRouting":false,"aNEName":"SETUP-4V1-O","zNEName":"SETUP-4V1-M","aPackName":"11QCE12X-2-4","zPackName":"11OPE8-2-5","additionalInfo":{},"managementState":"NEW","targetManagementState":"PLANNED","templateId":0,"reserveResource":false,"oamDataMapper":{"aTemplateName":"Oam","aDescr":"Best Practices for Mpls Tp","aHoldDownTime":0,"aHoldUpTime":20,"zTemplateName":"Oam","zDescr":"Best Practices for Mpls Tp","zHoldDownTime":0,"zHoldUpTime":20,"aBfdDataMapper":{"templateName":"Bfd","templateDescr":"Best Practices for Mpls Tp","transmitTimer":3,"receiveTimer":"3","multiplier":3},"zBfdDataMapper":{"templateName":"Bfd","templateDescr":"Best Practices for Mpls Tp","transmitTimer":3,"receiveTimer":"3","multiplier":3}},"protectionDataMapper":{"aTemplateName":"Protection","aDescr":"Best Practices for Mpls Tp","aProtectionType":"Revertive","aWaitToRestore":300,"aRapidPscTimer":3.33,"aSlowPscTimer":5,"zTemplateName":"Protection","zDescr":"Best Practices for Mpls Tp","zProtectionType":"Revertive","zWaitToRestore":300,"zRapidPscTimer":3.33,"zSlowPscTimer":5},"preProvCliCmd":"","postProvCliCmd":"","bfdEnabled":"ccCv","vneScriptDataList":[]},"scheduler":{"trigger":{}}}

    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
    Example Response Data
    {"header":{"req":{"reqId":null,"respBeanRef":null,"clientName":null,"selectiveSyncViaPolling":false},"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Success","opMsg":"","msgCode":"MPLSTP_TUNNEL_PLAN_SUCCESS_0001","parameters":["Tunnel_ex1"],"paramCount":1},"tunnelData":null}

    External Docs
    See Also :

    Operation

    post /esmService/mplstptunnel/planToAllocate
    Move a mplstp tunnel from Plan to Allocate management state (planToAllocate : /esmService/mplstptunnel/planToAllocate)
    Plan to Allocate mplstp tunnel entities in ESM only

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required Mplstp Tunnel Data 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
    Example Request Data

    {"reqId":{},"req":{"tunnelName":"Tunnel_ex1","fromManagementState":"Planned","toManagementState":"ALLOCATE"},"scheduler":{"trigger":{}}}

    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
    Example Response Data
    {"header":{"req":{"reqId":null,"respBeanRef":null,"clientName":null,"selectiveSyncViaPolling":false},"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Success","opMsg":"","msgCode":"MPLSTP_TUNNEL_ALLOCATE_SUCCESS_0001","parameters":["Tunnel_ex1"],"paramCount":1},"tunnelData":null}

    External Docs
    See Also :

    Operation

    post /esmService/mplstptunnel/scheduledDeployMplsTpTunnel
    Creates a mplstp tunnel in Commissioned management state (scheduledDeployMplsTpTunnel : /esmService/mplstptunnel/scheduledDeployMplsTpTunnel)
    Creates the mplstp tunnel entities in ESM only

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required Mplstp Tunnel Data 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
    Example Request Data

    {"req":{"fromManagementState":"Allocated","tunnelName":"Tunnel-MS-222","toManagementState":"DEPLOY"},"reqId":{"reqId":4},"scheduler":{"username":"alcatel","jobName":"Tunnel-MS-222_Move Allocate to DeployMon Sep 11 2017 22:57:28 UTC+5:30","jobDescription":"","trigger":{"name":"Tunnel-MS-222_Move Allocate to DeployMon Sep 11 2017 22:57:28 UTC+5:30Trigger","deployNow":"Yes","type":"","expression":"","timeOffset":""}}}

    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
    Example Response Data
    {"header":{"req":null,"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Success","opMsg":"","msgCode":"MPLSTP_TUNNEL_DEPLOY_SUCCESS_0001","parameters":["Tunnel-MS-222"],"paramCount":1,"objectId":0,"jobName":"","objectType":0},"tunnelData":null}

    External Docs
    See Also :

    Operation

    post /esmService/mplstptunnel/scheduledForceCompleteMplsTpTunnel
    Modify MPLSTP tunnel in Modify Failed management state (scheduledForceCompleteMplsTpTunnel : /esmService/mplstptunnel/scheduledForceCompleteMplsTpTunnel)
    Modifies MPLSTP tunnel in Modify Failed management state

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required Mplstp Tunnel Data 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
    Example Request Data

    {"req":{"fromManagementState":"DEPLOY FAILED","tunnelName":"Tunnel-MS-222","toManagementState":"DEPLOY"},"reqId":{"reqId":2},"scheduler":{"username":"alcatel","jobName":"Tunnel-MS-222_Move Allocate to DeployMon Sep 11 2017 22:07:57 UTC+5:30","jobDescription":"","trigger":{"name":"Tunnel-MS-222_Move Allocate to DeployMon Sep 11 2017 22:07:57 UTC+5:30Trigger","deployNow":"Yes","type":"","expression":"","timeOffset":""}}}

    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
    Example Response Data
    {"header":{"req":null,"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Success","opMsg":"","msgCode":"MPLSTP_TUNNEL_DEPLOY_SUCCESS_0001","parameters":["Tunnel-MS-222"],"paramCount":1,"objectId":0,"jobName":"","objectType":0},"tunnelData":null}

    External Docs
    See Also :

    Operation

    post /esmService/mplstptunnel/scheduledModifyMplsTpTunnel
    Modify MPLSTP tunnel in Commissioned management state (scheduledModifyMplsTpTunnel : /esmService/mplstptunnel/scheduledModifyMplsTpTunnel)
    Modifies MPLSTP tunnel in commissioned management state

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required Mplstp Tunnel Data 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
    Example Request Data

    {"header":{"req":null,"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Success","opMsg":"","msgCode":"MPLSTP_TUNNEL_MODIFY_SCHEDULED_SUCCESS_0001","parameters":["Testing1"],"paramCount":1},"tunnelData":null}S

    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
    Example Response Data
    {"header":{"req":null,"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Success","opMsg":"","msgCode":"MPLSTP_TUNNEL_MODIFY_SUCCESS_0001","parameters":["MPLS-2"],"paramCount":1,"objectId":0,"jobName":"","objectType":0},"tunnelData":null}

    External Docs
    See Also :

    Operation

    post /esmService/mplstptunnel/scheduledMoveToDeployMplsTpTunnel
    Creates a mplstp tunnel from Allocated to Commissioned management state (scheduledMoveToDeployMplsTpTunnel : /esmService/mplstptunnel/scheduledMoveToDeployMplsTpTunnel)
    Creates the mplstp tunnel entities in ESM only

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required Mplstp Tunnel Data 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
    Example Request Data

    {"req":{"fromManagementState":"Allocated","tunnelName":"Tunnel_ex1","toManagementState":"DEPLOY"},"reqId":{"reqId":6},"scheduler":{"username":"","jobName":"Tunnel_ex1_Move Allocate to DeployWed Dec 21 2016 15:30:53 UTC+5:30","jobDescription":"","trigger":{"name":"Tunnel_ex1_Move Allocate to DeployWed Dec 21 2016 15:30:53 UTC+5:30Trigger","deployNow":"Yes","type":"","expression":"","timeOffset":""}}}

    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
    Example Response Data
    {"header":{"req":null,"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Success","opMsg":"","msgCode":"MPLSTP_TUNNEL_DEPLOY_SUCCESS_0001","parameters":["Tunnel_ex1"],"paramCount":1},"tunnelData":null}

    External Docs
    See Also :

    Operation

    post /esmService/mplstptunnel/scheduledSwitchAndClearTunnel
    scheduledSwitchAndClearTunnel (scheduledSwitchAndClearTunnel : /esmService/mplstptunnel/scheduledSwitchAndClearTunnel)
    Switch or Clear protected commissioned tunnel

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required Mplstp Tunnel Id Holder Data 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
    Example Request Data

    {"req":{"tunnelName":"REAL_NE_TUNNEL_1","switchOperationName":"CLEAR","endPack":"","switchOperationType":"CLEAR"},"reqId":{"reqId":8},"scheduler":{"username":"","jobName":"Tunnel_Clear_REAL_NE_TUNNEL_1_Fri Sep 23 2016 14:17:53 UTC+5:30","jobDescription":"","trigger":{"name":"Tunnel_Clear_REAL_NE_TUNNEL_1_Fri Sep 23 2016 14:17:53 UTC+5:30Trigger","deployNow":"Yes","type":"","expression":"","timeOffset":""}}}

    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
    Example Response Data
    {"header":{"req":null,"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Success","opMsg":"","msgCode":"MPLSTP_TUNNEL_SWITCH_SUCCESS_0001","parameters":["REAL_NE_TUNNEL_1"],"paramCount":1},"tunnelData":null}

    External Docs
    See Also :

    Operation

    post /esmService/mplstptunnel/ScheduledTunnelActivate
    MBATunnel (scheduledTunnelActivate : /esmService/mplstptunnel/ScheduledTunnelActivate)
    Move Tunnel back to allocated state from from commissioned, deploy failed

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required Mplstp Tunnel Id Holder Data 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
    Example Request Data

    {"req":{"tunnelName":"Testing1"},"scheduler":{"username":"","jobName":"Testing1_ActivationWed Dec 21 2016 16:45:20 UTC+5:30","jobDescription":"","trigger":{"name":"Testing1_ActivationWed Dec 21 2016 16:45:20 UTC+5:30Trigger","deployNow":"Yes","type":"","expression":"","timeOffset":""}}}

    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
    Example Response Data
    {"header":{"req":null,"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Success","opMsg":"","msgCode":"MPLSTP_TUNNEL_ACTIVATE_SUCCESS_0001","parameters":["Testing1"],"paramCount":1},"tunnelData":null}

    External Docs
    See Also :

    Operation

    post /esmService/mplstptunnel/ScheduledTunnelDeactivate
    MBATunnel (scheduledTunnelDeactivate : /esmService/mplstptunnel/ScheduledTunnelDeactivate)
    Move Tunnel back to allocated state from from commissioned, deploy failed

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required Mplstp Tunnel Id Holder Data 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
    Example Request Data

    {"req":{"tunnelName":"Testing1"},"scheduler":{"username":"","jobName":"Testing1_DectivationWed Dec 21 2016 15:48:13 UTC+5:30","jobDescription":"","trigger":{"name":"Testing1_DectivationWed Dec 21 2016 15:48:13 UTC+5:30Trigger","deployNow":"Yes","type":"","expression":"","timeOffset":""}}}

    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
    Example Response Data
    {"header":{"req":null,"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Success","opMsg":"","msgCode":"MPLSTP_TUNNEL_DEACTIVATE_SUCCESS_0001","parameters":["Testing1"],"paramCount":1},"tunnelData":null}

    External Docs
    See Also :

    Operation

    post /esmService/mplstptunnel/ScheduledTunnelDelete
    ScheduledTunnelDelete (scheduledTunnelDelete : /esmService/mplstptunnel/ScheduledTunnelDelete)
    Delete from commissioned, deploy failed states

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required Mplstp Tunnel Id Holder Data 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
    Example Request Data

    {"req":{"fromManagementState":"Commissioned","tunnelName":"Testing1","toManagementState":"DELETE"},"reqId":{"reqId":6},"scheduler":{"username":"","jobName":"Testing1_Move Back to AllocateWed Dec 21 2016 16:49:46 UTC+5:30","jobDescription":"","trigger":{"name":"Testing1_Move Back to AllocateWed Dec 21 2016 16:49:46 UTC+5:30Trigger","deployNow":"Yes","type":"","expression":"","timeOffset":""}}}

    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
    Example Response Data
    {"header":{"req":null,"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Success","opMsg":"","msgCode":"MPLSTP_TUNNEL_DELETE_SUCCESS_0001","parameters":["Testing1"],"paramCount":1},"tunnelData":null}S

    External Docs
    See Also :

    Operation

    post /esmService/mplstptunnel/terminateMplsTpTunnel
    Terminates MPLSTP tunnel from Deploying or Modifying (terminateMplsTpTunnel : /esmService/mplstptunnel/terminateMplsTpTunnel)
    Terminates MPLSTP tunnel from Deploying or Modifying

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required Mplstp Tunnel Data 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
    Example Request Data

    {"reqId":{},"req":{"tunnelName":"Tunnel_ex1","fromManagementState":"DEPLOYING"},"scheduler":{"trigger":{}}}

    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
    Example Response Data
    {"header":{"req":null,"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Success","opMsg":"","msgCode":"MPLSTP_TUNNEL_DEPLOY_SUCCESS_0001","parameters":["Tunnel_ex1"],"paramCount":1},"tunnelData":null}

    External Docs
    See Also :

    Operation

    post /esmService/mplstptunnel/updateMplsTpTunnelVNEScripts
    Updates the VNE's involved for the mplstp tunnel topology (updateMplsTpTunnelVNEScripts : /esmService/mplstptunnel/updateMplsTpTunnelVNEScripts)
    Updates the VNE's involved for the mplstp tunnel topologyAs a part of allcoation, routes are determined between the Aend and Zend of the tunnel.If VNE is involved in the topology, This service will update the corresponding scripts

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required Mplstp Tunnel Data 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 :

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

    MPLS TP Tunnel Mapper

    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 MPLSTPOAMData MPLSTPOAMData --- ---
    protectionDataMapper MPLSTPProtectionData MPLSTPProtectionData --- ---
    preProvCliCmd String string --- ---
    postProvCliCmd String string --- ---
    switchOperationName String string Switch Operation Name [ManualSwitch, ForceSwitch, Lockout, Clear]
    endPack String string End Pack [A, Z]
    bfdEnabled String string --- ---
    vneScriptDataList array[VNEScriptData] VNEScriptData --- ---
    includeListWorking array[String] string --- ---
    excludeListWorking array[String] string --- ---
    includeListProtection array[String] string --- ---
    excludeListProtection array[String] string --- ---

    MPLSTP_TunnelResponseHolder

    Name

    Type

    Description

    Enum

    header Response Header Model Response Header Model --- ---
    tunnelData Object object --- ---

    MPLSTPBFDData

    Name

    Type

    Description

    Enum

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

    MPLSTPOAMData

    Name

    Type

    Description

    Enum

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

    MPLSTPProtectionData

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

    MPLSTPTunnelIdHolder

    Name

    Type

    Description

    Enum

    sessionId String string --- ---
    requestURI String string --- ---
    logReqId String string --- ---
    operator String string --- ---
    client String string --- ---
    reqId EsmRequestHeaderMapper EsmRequestHeaderMapper --- ---
    req Tunnel UI Data Tunnel UI Data --- ---
    scheduler ESMSchedulerDataModel ESMSchedulerDataModel --- ---
    activate Boolean boolean --- ---

    MPLSTPTunnelInstHolder

    Name

    Type

    Description

    Enum

    sessionId String string --- ---
    requestURI String string --- ---
    logReqId String string --- ---
    operator String string --- ---
    client String string --- ---
    reqId EsmRequestHeaderMapper EsmRequestHeaderMapper --- ---
    req MPLS TP Tunnel Mapper MPLS TP Tunnel Mapper --- ---
    scheduler ESMSchedulerDataModel ESMSchedulerDataModel --- ---
    activate Boolean boolean --- ---

    Request Header

    Name

    Type

    Description

    Enum

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

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

    Tunnel UI Data

    Name

    Type

    Description

    Enum

    tunnelId Long long Tunnel Identifier ---
    tunnelName String string Tunnel name ---
    fromManagementState String string Current management state of the Tunnel ---
    toManagementState String string The target management state of the Tunnel ---
    jobTaskId Long long JobTaskId ---
    switchOperationName String string Switch Operation Name [ManualSwitch, ForceSwitch, Lockout, Clear]
    endPack String string End Pack [A, Z]

    VNEScriptData

    Name

    Type

    Description

    Enum

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