Operation
post /esmBrowser/topoMCLAGTemplate/createMCLAGTemplate
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | MCLag template Data | MCLAGTemplateDataHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Template Response Data Holder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<MCLAGTemplateHolder> <reqId> <clientName/> <reqId/> <respBeanRef/> <selectiveSyncViaPolling/> </reqId> <req> <tempId> <templateName>MclagTest</templateName> <templatePath>My Templates/MCLAG Templates/</templatePath> <templateId/> </tempId> <desc>rest</desc> <author>alcatel</author> <mclagConfig>2 PEERS WITH 1 MC-LAG (V-CONFIG)</mclagConfig> <holdOnNeighborFailurMulti>3</holdOnNeighborFailurMulti> <keepAliveInterval>10</keepAliveInterval> <mclagBindingEnabled>Yes</mclagBindingEnabled> <controlServiceProtected>Yes</controlServiceProtected> <portMode>ACCESS</portMode> <flushEthernetRingEnable>FALSE</flushEthernetRingEnable> <preProvcliCommand/> <postProvcliCommand/> <state>UNPUBLISHED</state> <mclagType>MC-LAG</mclagType> </req> </MCLAGTemplateHolder>
Produces
application/xml
Example Response Data
<ServiceTemplateResponse> <message>MCLAG Template saved successfully</message> <msgCode>TMPL_001</msgCode> <paramCount>1</paramCount> <parameters>MclagTest</parameters> <status>SUCCESS</status> </ServiceTemplateResponse>
External Docs
Operation
post /esmBrowser/topoMCLAGTemplate/deleteMCLAGTemplate
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | MCLag template state Data | MCLAGTemplateStateHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MCLAGTemplateIdRespHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<MCLAGTemplateStateHolder> <reqId> <reqId>1</reqId> <respBeanRef/> <clientName/> </reqId> <req> <templateState>UNPUBLISHED</templateState> <templateId> <templateName>MclagTest</templateName> <templatePath>My Templates/MCLAG Templates/</templatePath> </templateId> </req> </MCLAGTemplateStateHolder>
Produces
application/xml
Example Response Data
<MCLAGTemplateIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>ERP_TMPL_DEL_001</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>My Templates/MCLAG Templates/MclagTest</parameters> <parameters>MclagTest</parameters> </responseId> </MCLAGTemplateIdRespHolder>
External Docs
Operation
get /esmBrowser/topoMCLAGTemplate/getMCLAGTemplateDetails/{context}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
context | required | Template name | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MCLAGTemplate
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
/esmBrowser/topoMCLAGTemplate/getMCLAGTemplateDetails/Best%20Practices+MCLAG%20Templates+MCLAG_Using_Unprotected_Control_Service?dojo.preventCache=1504528964571
Produces
application/xml
Example Response Data
<MCLAGTemplate> <author>--</author> <bestPractice>1</bestPractice> <controlServiceProtected>FALSE</controlServiceProtected> <createTime>0</createTime> <desc>This template is used to provision MCLAG</desc> <flushEthernetRingEnable>FALSE</flushEthernetRingEnable> <holdOnNeighborFailurMulti>3</holdOnNeighborFailurMulti> <keepAliveInterval>10</keepAliveInterval> <mclagBindingEnabled>TRUE</mclagBindingEnabled> <mclagConfig>2 PEERS WITH 1 MC-LAG (V-CONFIG)</mclagConfig> <mclagTemplateId>2</mclagTemplateId> <mclagType>MC-LAG</mclagType> <modifyTime>0</modifyTime> <oamMaNAme>OAMmclag</oamMaNAme> <oamMdId>3</oamMdId> <oamMdLevel>4</oamMdLevel> <oamTemplateName>OAM_FOR_MCLAG_CTRL_SERVICE</oamTemplateName> <oamTemplatePath>Best Practices/OAM Template</oamTemplatePath> <portMode>ACCESS</portMode> <state>PUBLISHED</state> <templateName>MCLAG_Using_Unprotected_Control_Service</templateName> <templatePath>Best Practices/MCLAG Templates/</templatePath> </MCLAGTemplate>
External Docs
Operation
get /esmBrowser/topoMCLAGTemplate/getMCLAGTemplateDetailsById/{id}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
id | required | Template name | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MCLAGTemplate
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
/oms1350/esmBrowser/topoMCLAGTemplate/getMCLAGTemplateDetailsById/1
Produces
application/json
Example Response Data
{ "mclagTemplateId": 1, "templateName": "MCLAG_Using_Protected_Control_Service", "templatePath": "Best Practices/MCLAG Templates/", "bestPractice": 1, "state": "PUBLISHED", "mclagType": "MC-LAG", "createTime": 0, "modifyTime": 0, "desc": "This template is used to provision MCLAG", "author": "--", "mclagConfig": "2 PEERS WITH 1 MC-LAG (V-CONFIG)", "holdOnNeighborFailurMulti": "3", "keepAliveInterval": "10", "mclagBindingEnabled": "TRUE", "controlServiceProtected": "TRUE", "portMode": "ACCESS", "flushEthernetRingEnable": "0", "preProvcliCommand": null, "postProvcliCommand": null, "oamTemplateName": "OAM_FOR_MCLAG_CTRL_SERVICE", "oamMaNAme": "OAMmclag", "oamTemplatePath": "Best Practices/OAM Template", "oamMdId": 3, "oamMdLevel": 4, "oamtemplateMAHolders": [ { "templateName": "Best Practices/OAM Template/OAM_FOR_MCLAG_CTRL_SERVICE", "maName": "OAMmclag", "author": "alcatel", "description": "Best practice OAM for MCLAG Control Service", "oamSupported": "2", "maFormat": "ITU-ICC", "ccmInterval": "1s", "mhfCreation": "0", "direction": "DOWN", "interfaceType": "SAP", "active": "true", "controlMep": "true", "lowestPriorityDefect": "MAC, Remote, Error, Xcon", "ccmEnable": "true", "ccmPriority": 7, "aisEnable": "false", "aisPriority": 7, "aisInterval": 60, "aisLevel": null, "aisLevel1": false, "aisLevel2": false, "aisLevel3": false, "aisLevel4": false, "aisLevel5": false, "aisLevel6": false, "aisLevel7": false, "id": 3, "mdId": 3 } ] }
External Docs
Operation
post /esmBrowser/topoMCLAGTemplate/modifyMCLAGTemplate
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | MCLag template Data | MCLAGTemplateDataHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Template Response Data Holder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<MCLAGTemplateHolder> <reqId> <clientName/> <reqId/> <respBeanRef/> <selectiveSyncViaPolling/> </reqId> <req> <tempId> <templateName>test-mclag</templateName> <templatePath>My Templates/MCLAG Templates/</templatePath> <templateId/> </tempId> <desc>rest auto</desc> <author>nokia</author> <mclagConfig>2 PEERS WITH 1 MC-LAG (V-CONFIG)</mclagConfig> <holdOnNeighborFailurMulti>3</holdOnNeighborFailurMulti> <keepAliveInterval>10</keepAliveInterval> <mclagBindingEnabled>Yes</mclagBindingEnabled> <controlServiceProtected>Yes</controlServiceProtected> <portMode>ACCESS</portMode> <flushEthernetRingEnable>FALSE</flushEthernetRingEnable> <preProvcliCommand/> <postProvcliCommand/> <state>UNPUBLISHED</state> <mclagType>MC-LAG</mclagType> </req> </MCLAGTemplateHolder>
Produces
application/xml
Example Response Data
<ServiceTemplateResponse> <msgCode>ERP_TMPL_MODIFY_001</msgCode> <paramCount>0</paramCount> <parameters>test-mclag</parameters> <status>Success</status> </ServiceTemplateResponse>
External Docs
Operation
post /esmBrowser/topoMCLAGTemplate/publishMCLAGTemplate
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | MCLag template state Data | MCLAGTemplateStateHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MCLAGTemplateIdRespHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<MCLAGTemplateStateHolder> <reqId> <reqId>1</reqId> <respBeanRef/> <clientName/> </reqId> <req> <templateState>UNPUBLISHED</templateState> <templateId> <templateName>MclagTest</templateName> <templatePath>My Templates/MCLAG Templates/</templatePath> </templateId> </req> </MCLAGTemplateStateHolder>
Produces
application/xml
Example Response Data
<MCLAGTemplateIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>ERP_TMPL_PUBLISH_001</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>My Templates/MCLAG Templates/MclagTest</parameters> </responseId> </MCLAGTemplateIdRespHolder>
External Docs
Operation
post /esmBrowser/topoMCLAGTemplate/unpublishMCLAGTemplate
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | MCLag template state Data | MCLAGTemplateStateHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MCLAGTemplateIdRespHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<MCLAGTemplateStateHolder> <reqId> <reqId>1</reqId> <respBeanRef/> <clientName/> </reqId> <req> <templateState>PUBLISHED</templateState> <templateId> <templateName>test-mclag</templateName> <templatePath>My Templates/MCLAG Templates/</templatePath> </templateId> </req> </MCLAGTemplateStateHolder>
Produces
application/xml
Example Response Data
<MCLAGTemplateIdRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>ERP_TMPL_UNPUB_001</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>My Templates/MCLAG Templates/test-mclag</parameters> </responseId> </MCLAGTemplateIdRespHolder>
External Docs
MCLAGTemplate
Name |
Type |
Description |
Enum |
---|---|---|---|
mclagTemplateId | Integer integer |
MclagTemplateId | --- |
templateName | String string |
TemplateName | --- |
templatePath | String string |
TemplatePath | --- |
bestPractice | Integer integer |
BestPractice | --- |
state | String string |
state | [Published, unPublished] |
mclagType | String string |
MclagType | --- |
createTime | Long long |
CreateTime | --- |
modifyTime | Long long |
ModifyTime | --- |
desc | String string |
Description for the MC-Lag | --- |
author | String string |
Author for the MC-Lag | --- |
mclagConfig | String string |
MClagConfig | --- |
holdOnNeighborFailurMulti | String string |
HoldOnNeighborFailurMult | [3 to 5] |
keepAliveInterval | String string |
KeepAliveInterval | [5 to 500 deciseconds] |
mclagBindingEnabled | String string |
MCLagBindingEnabled | [enable, disable] |
controlServiceProtected | String string |
ControlServiceProtected | [enable, disable] |
portMode | String string |
PortMode | [Access, Uplink] |
flushEthernetRingEnable | String string |
FlushEthernetRingEnable | [Enable, disable] |
preProvcliCommand | String string |
Pre CLI commands | --- |
postProvcliCommand | String string |
Post CLI commands | --- |
oamTemplateName | String string |
OAM template name | --- |
oamMaNAme | String string |
MA name | --- |
oamTemplatePath | String string |
OamTemplatePath | --- |
oamMdId | Integer integer |
OamMdId | --- |
oamMdLevel | Integer integer |
OAM maintenance domain level | [0, 1, 2, 3, 4, 5, 6, 7] |
MCLAGTemplateData
Name |
Type |
Description |
Enum |
---|---|---|---|
tempId | MC-Lag Template data MC-Lag Template data |
--- | --- |
desc | String string |
--- | --- |
author | String string |
--- | --- |
mclagConfig | String string |
--- | --- |
holdOnNeighborFailurMulti | String string |
--- | --- |
keepAliveInterval | String string |
--- | --- |
mclagBindingEnabled | String string |
--- | --- |
controlServiceProtected | String string |
--- | --- |
portMode | String string |
--- | --- |
flushEthernetRingEnable | String string |
--- | --- |
preProvcliCommand | String string |
--- | --- |
postProvcliCommand | String string |
--- | --- |
state | String string |
--- | --- |
mclagType | String string |
--- | --- |
MCLAGTemplateDataHolder
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 | MCLAGTemplateData MCLAGTemplateData |
--- | --- |
oamTemplate | nOAMTemplateId nOAMTemplateId |
--- | --- |
activate | Boolean boolean |
--- | --- |
MCLAGTemplateIdRespHolder
Name |
Type |
Description |
Enum |
---|---|---|---|
responseId | Response Header Model Response Header Model |
Response wrapper for operation status | --- |
rsp | MC-Lag Template data MC-Lag Template data |
MC-lag Template data | --- |
MCLAGTemplateState
Name |
Type |
Description |
Enum |
---|---|---|---|
templateId | MC-Lag Template data MC-Lag Template data |
--- | --- |
templateState | String string |
--- | --- |
MCLAGTemplateStateHolder
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 | MCLAGTemplateState MCLAGTemplateState |
--- | --- |
activate | Boolean boolean |
--- | --- |
nOAMTemplateId
Name |
Type |
Description |
Enum |
---|---|---|---|
id | String string |
Id | --- |
maName | String string |
MaName | --- |
demarcName | String string |
Name | --- |
demarcPath | String string |
OamTemplatePath | --- |
demarcId | String string |
Id | --- |
demarcMaName | String string |
DemarcationMaName | --- |
path | String string |
OamTemplatePath | --- |
name | String string |
Name | --- |
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 | --- |