Operation
post /esmService/mplstptunnel/allocate
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Mplstp Tunnel Data | MPLSTPTunnelInstHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MPLSTP_TunnelResponseHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
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
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
Operation
post /esmService/mplstptunnel/allocateToPlan
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Mplstp Tunnel Data | MPLSTPTunnelIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MPLSTP_TunnelResponseHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Example Request Data
{"reqId":{},"req":{"tunnelName":"Tunnel_ex1","fromManagementState":"Allocated","toManagementState":"PLAN"},"scheduler":{"trigger":{}}}
Produces
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
Operation
post /esmService/mplstptunnel/dbDeleteTunnel
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
Responses
Response Messages |
Schema |
---|---|
200success |
MPLSTP_TunnelResponseHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Example Request Data
{"reqId":{},"req":{"tunnelName":"Tunnel_ex2","fromManagementState":"Allocated","toManagementState":"DBDELETE"},"scheduler":{"trigger":{}}}
Produces
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
Operation
post /esmService/mplstptunnel/deleteTunnel
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Mplstp Tunnel Id Holder Data | MPLSTPTunnelIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MPLSTP_TunnelResponseHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Example Request Data
{"reqId":{},"req":{"tunnelName":"Tunnel_ex1","fromManagementState":"Allocated","toManagementState":"DELETE"},"scheduler":{"trigger":{}}}
Produces
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
Operation
post /esmService/mplstptunnel/MBATunnel
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Mplstp Tunnel Id Holder Data | MPLSTPTunnelIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MPLSTP_TunnelResponseHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
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
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
Operation
post /esmService/mplstptunnel/modifyMplsTpTunnel
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Mplstp Tunnel Data | MPLSTPTunnelInstHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MPLSTP_TunnelResponseHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
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
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
Operation
post /esmService/mplstptunnel/plan
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Mplstp Tunnel Data | MPLSTPTunnelInstHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MPLSTP_TunnelResponseHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
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
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
Operation
post /esmService/mplstptunnel/planToAllocate
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Mplstp Tunnel Data | MPLSTPTunnelIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MPLSTP_TunnelResponseHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Example Request Data
{"reqId":{},"req":{"tunnelName":"Tunnel_ex1","fromManagementState":"Planned","toManagementState":"ALLOCATE"},"scheduler":{"trigger":{}}}
Produces
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
Operation
post /esmService/mplstptunnel/scheduledDeployMplsTpTunnel
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Mplstp Tunnel Data | MPLSTPTunnelInstHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MPLSTP_TunnelResponseHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
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
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
Operation
post /esmService/mplstptunnel/scheduledForceCompleteMplsTpTunnel
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Mplstp Tunnel Data | MPLSTPTunnelIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MPLSTP_TunnelResponseHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
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
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
Operation
post /esmService/mplstptunnel/scheduledModifyMplsTpTunnel
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Mplstp Tunnel Data | MPLSTPTunnelInstHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MPLSTP_TunnelResponseHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
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
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
Operation
post /esmService/mplstptunnel/scheduledMoveToDeployMplsTpTunnel
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Mplstp Tunnel Data | MPLSTPTunnelIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MPLSTP_TunnelResponseHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
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
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
Operation
post /esmService/mplstptunnel/scheduledSwitchAndClearTunnel
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Mplstp Tunnel Id Holder Data | MPLSTPTunnelIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MPLSTP_TunnelResponseHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
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
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
Operation
post /esmService/mplstptunnel/ScheduledTunnelActivate
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Mplstp Tunnel Id Holder Data | MPLSTPTunnelIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MPLSTP_TunnelResponseHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
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
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
Operation
post /esmService/mplstptunnel/ScheduledTunnelDeactivate
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Mplstp Tunnel Id Holder Data | MPLSTPTunnelIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MPLSTP_TunnelResponseHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
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
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
Operation
post /esmService/mplstptunnel/ScheduledTunnelDelete
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Mplstp Tunnel Id Holder Data | MPLSTPTunnelIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MPLSTP_TunnelResponseHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
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
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
Operation
post /esmService/mplstptunnel/terminateMplsTpTunnel
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Mplstp Tunnel Data | MPLSTPTunnelIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MPLSTP_TunnelResponseHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Example Request Data
{"reqId":{},"req":{"tunnelName":"Tunnel_ex1","fromManagementState":"DEPLOYING"},"scheduler":{"trigger":{}}}
Produces
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
Operation
post /esmService/mplstptunnel/updateMplsTpTunnelVNEScripts
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Mplstp Tunnel Data | MPLSTPTunnelInstHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MPLSTP_TunnelResponseHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
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 | --- |
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 |
--- | --- |
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 |
--- | --- |
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] |