Operation
post /esmBrowser/topoLAGTemplate/createLAGTemplate
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Lag template Data | LAGTemplateDataHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Template Response Data Holder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<LAGTemplateHolder> <reqId> <clientName/> <reqId/> <respBeanRef/> <selectiveSyncViaPolling/> </reqId> <req> <tempId> <templateName>TestLag</templateName> <templatePath>My Templates/LAG Templates/</templatePath> <templateId/> </tempId> <usage>Standard</usage> <serviceState>Out Of Service</serviceState> <mode>ACCESS</mode> <encapType>NULL</encapType> <holdDownTime>0.0</holdDownTime> <portThreshold>0</portThreshold> <descr>rest</descr> <author>alcatel</author> <portRate>1GbE</portRate> <lacpEnabled>Disabled</lacpEnabled> <lacpMode>Passive</lacpMode> <lacpTransmitInterval>Fast</lacpTransmitInterval> <lacpEnabledOnStandby>Enabled</lacpEnabledOnStandby> <selectionCriteria>Highest Count</selectionCriteria> <slaveToPartner>Disabled</slaveToPartner> <templateState>UNPUBLISHED</templateState> <preProvCliCmd/> <postProvCliCmd/> </req> </LAGTemplateHolder>
Produces
application/xml
Example Response Data
<ServiceTemplateResponse> <message>LAG Template saved successfully</message> <msgCode>TMPL_001</msgCode> <paramCount>1</paramCount> <parameters>TestLag</parameters> <status>SUCCESS</status> </ServiceTemplateResponse>
External Docs
Operation
post /esmBrowser/topoLAGTemplate/deleteLAGTemplate
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Lag template state Data | LAGTemplateStateHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
LAGTemplateIdRespHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<LAGTemplateStateHolder> <reqId> <reqId>1</reqId> <respBeanRef/> <clientName/> </reqId> <req> <templateState>UNPUBLISHED</templateState> <templateId> <templateName>TestLag</templateName> <templatePath>My Templates/LAG Templates/</templatePath> </templateId> </req> </LAGTemplateStateHolder>
Produces
application/xml
Example Response Data
<LAGTemplateIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>ERP_TMPL_DEL_001</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>My Templates/LAG Templates/TestLag</parameters> </responseId> </LAGTemplateIdRespHolder>
External Docs
Operation
get /esmBrowser/topoLAGTemplate/getLAGTemplate/{context}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
context | required | Template name | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
LAGTemplate
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
/esmBrowser/topoLAGTemplate/getLAGTemplate/LAG_USAGE_IN_ERP_OVER_LAG
Produces
application/xml
Example Response Data
<LAGTemplate> <author>--</author> <bestPractice>1</bestPractice> <createTime>0</createTime> <desc>This template is used to provision LAG to be used as endpoints for ELINE-EPL Services</desc> <encapType>NULL</encapType> <holdDownTime>0.0</holdDownTime> <lacpEnabled>Disabled</lacpEnabled> <lacpEnabledOnStandBy>Enabled</lacpEnabledOnStandBy> <lacpMode>Passive</lacpMode> <lacpTransmitInterval>Fast</lacpTransmitInterval> <lagMode>ACCESS</lagMode> <lagTemplateId>2</lagTemplateId> <lagType>LAG</lagType> <lagUsage>Standard</lagUsage> <modifyTime>0</modifyTime> <portRate>1GbE</portRate> <portThershold>0</portThershold> <selectionCriteria>Highest Count</selectionCriteria> <serviceState>Out Of Service</serviceState> <slaveToPartner>Disabled</slaveToPartner> <state>PUBLISHED</state> <templateName>LAG_USAGE_IN_ELINE_EPL_SERVICES</templateName> <templatePath>Best Practices/LAG Templates/</templatePath> </LAGTemplate>
External Docs
Operation
get /esmBrowser/topoLAGTemplate/getLAGTemplateById/{id}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
id | required | Template Id | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
LAGTemplate
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
/oms1350/esmBrowser/topoLAGTemplate/getLAGTemplateById/1
Produces
application/json
Example Response Data
{ "lagTemplateId": 1, "templateName": "LAG_USAGE_IN_ERP_OVER_LAG", "templatePath": "Best Practices/LAG Templates/", "bestPractice": 1, "state": "PUBLISHED", "lagType": "LAG", "createTime": 0, "modifyTime": 0, "desc": "LAG Template created for ERP over LAG", "author": "--", "lagUsage": "ERP", "serviceState": "Out Of Service", "lagMode": "UPLINK", "encapType": "QinQ", "holdDownTime": "0.0", "portThershold": "0", "portRate": "10GbE", "lacpEnabled": "Disabled", "lacpEnabledOnStandBy": "Enabled", "lacpMode": "Passive", "lacpTransmitInterval": "Fast", "selectionCriteria": "Highest Count", "slaveToPartner": "Disabled", "preProvcliCommand": null, "postProvcliCommand": null }
External Docs
Operation
post /esmBrowser/topoLAGTemplate/modifyLAGTemplate
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Lag template Data | LAGTemplateDataHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Template Response Data Holder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<LAGTemplateHolder> <reqId> <clientName/> <reqId/> <respBeanRef/> <selectiveSyncViaPolling/> </reqId> <req> <tempId> <templateName>test-lag</templateName> <templatePath>My Templates/LAG Templates/</templatePath> <templateId/> </tempId> <usage>Standard</usage> <serviceState>In Service</serviceState> <mode>ACCESS</mode> <encapType>NULL</encapType> <holdDownTime>0.0</holdDownTime> <portThreshold>0</portThreshold> <descr/> <author>alcatel</author> <portRate>1GbE</portRate> <lacpEnabled>Disabled</lacpEnabled> <lacpMode>Passive</lacpMode> <lacpTransmitInterval>Fast</lacpTransmitInterval> <lacpEnabledOnStandby>Enabled</lacpEnabledOnStandby> <selectionCriteria>Highest Count</selectionCriteria> <slaveToPartner>Disabled</slaveToPartner> <templateState>UNPUBLISHED</templateState> <preProvCliCmd/> <postProvCliCmd/> </req> </LAGTemplateHolder>
Produces
application/xml
Example Response Data
<ServiceTemplateResponse> <msgCode>ERP_TMPL_MODIFY_001</msgCode> <paramCount>0</paramCount> <parameters>test-lag</parameters> <status>Success</status> </ServiceTemplateResponse>
External Docs
Operation
post /esmBrowser/topoLAGTemplate/publishLAGTemplate
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Lag template state Data | LAGTemplateStateHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
LAGTemplateIdRespHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<LAGTemplateStateHolder> <reqId> <reqId>1</reqId> <respBeanRef/> <clientName/> </reqId> <req> <templateState>UNPUBLISHED</templateState> <templateId> <templateName>TestLag</templateName> <templatePath>My Templates/LAG Templates/</templatePath> </templateId> </req> </LAGTemplateStateHolder>
Produces
application/xml
Example Response Data
<LAGTemplateIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>ERP_TMPL_PUBLISH_001</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>My Templates/LAG Templates/TestLag</parameters> </responseId> </LAGTemplateIdRespHolder>
External Docs
Operation
post /esmBrowser/topoLAGTemplate/unpublishLAGTemplate
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Lag template state Data | LAGTemplateStateHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
LAGTemplateIdRespHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<LAGTemplateStateHolder> <reqId> <reqId>1</reqId> <respBeanRef/> <clientName/> </reqId> <req> <templateState>PUBLISHED</templateState> <templateId> <templateName>TestLag</templateName> <templatePath>My Templates/LAG Templates/</templatePath> </templateId> </req> </LAGTemplateStateHolder>
Produces
application/xml
Example Response Data
<LAGTemplateIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>ERP_TMPL_UNPUB_001</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>My Templates/LAG Templates/TestLag</parameters> </responseId> </LAGTemplateIdRespHolder>
External Docs
LAGTemplate
Name |
Type |
Description |
Enum |
---|---|---|---|
lagTemplateId | Integer integer |
LagTemplateId | --- |
templateName | String string |
TemplateName | --- |
templatePath | String string |
TemplatePath | --- |
bestPractice | Integer integer |
BestPractice | --- |
state | String string |
state | [Published, unPublished] |
lagType | String string |
LagType | --- |
createTime | Long long |
CreateTime | --- |
modifyTime | Long long |
ModifyTime | --- |
desc | String string |
Description for the Lag | --- |
author | String string |
Author for the Lag | --- |
lagUsage | String string |
LagUsage | [Standard, erp, mc-lag] |
serviceState | String string |
serviceState | [In service, Out of Service] |
lagMode | String string |
LagMode | [Access, uplink] |
encapType | String string |
Encapsulation Type | [Dot1q, Null, QinQ] |
holdDownTime | String string |
holdDownTime | [0s to 200s] |
portThershold | String string |
portThresHold | [0 to 3] |
portRate | String string |
PortRate | [1GbE and 10GbE] |
lacpEnabled | String string |
LacpEnable | [enable, disable] |
lacpEnabledOnStandBy | String string |
LacpEnabledOnStandBy | [enable, disable] |
lacpMode | String string |
LacpMode | [active, passive] |
lacpTransmitInterval | String string |
LacpTransmitInterval | [fast, slow] |
selectionCriteria | String string |
SelectionCriteria | [Highest count, highest weight] |
slaveToPartner | String string |
slaveToPartner | [enable, disable] |
preProvcliCommand | String string |
Pre CLI commands | --- |
postProvcliCommand | String string |
Post CLI commands | --- |
LAGTemplateData
Name |
Type |
Description |
Enum |
---|---|---|---|
tempId | LAGTemplateId LAGTemplateId |
--- | --- |
usage | String string |
--- | --- |
serviceState | String string |
--- | --- |
mode | String string |
--- | --- |
encapType | String string |
--- | --- |
holdDownTime | String string |
--- | --- |
portThreshold | String string |
--- | --- |
descr | String string |
--- | --- |
author | String string |
--- | --- |
portRate | String string |
--- | --- |
lacpEnabled | String string |
--- | --- |
lacpMode | String string |
--- | --- |
lacpTransmitInterval | String string |
--- | --- |
lacpEnabledOnStandby | String string |
--- | --- |
selectionCriteria | String string |
--- | --- |
slaveToPartner | String string |
--- | --- |
templateState | String string |
--- | --- |
preProvCliCmd | String string |
--- | --- |
postProvCliCmd | String string |
--- | --- |
LAGTemplateDataHolder
Name |
Type |
Description |
Enum |
---|---|---|---|
sessionId | String string |
--- | --- |
requestURI | String string |
--- | --- |
logReqId | String string |
--- | --- |
operator | String string |
--- | --- |
client | String string |
--- | --- |
reqId | Request Header Request Header |
--- | --- |
req | LAGTemplateData LAGTemplateData |
--- | --- |
activate | Boolean boolean |
--- | --- |
LAGTemplateIdRespHolder
Name |
Type |
Description |
Enum |
---|---|---|---|
responseId | Response Header Model Response Header Model |
Response wrapper for operation status | --- |
rsp | LAGTemplateId LAGTemplateId |
Lag Template data | --- |
LAGTemplateState
Name |
Type |
Description |
Enum |
---|---|---|---|
templateId | LAGTemplateId LAGTemplateId |
--- | --- |
templateState | String string |
--- | --- |
LAGTemplateStateHolder
Name |
Type |
Description |
Enum |
---|---|---|---|
sessionId | String string |
--- | --- |
requestURI | String string |
--- | --- |
logReqId | String string |
--- | --- |
operator | String string |
--- | --- |
client | String string |
--- | --- |
reqId | Request Header Request Header |
--- | --- |
req | LAGTemplateState LAGTemplateState |
--- | --- |
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 | --- |