Operation
post /esmService/MCLAG/abortMclagRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | N_MCLagIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
N_MCLagIdRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/MCLAG/allocateMclagRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | MCLAGInstHolderMapper |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
MCLAGDataRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/MCLAG/dbDeleteMclagRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | N_MCLagIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
N_MCLagIdRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/MCLAG/deleteMclagRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | N_MCLagIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
N_MCLagIdRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/MCLAG/forceActiveStandbyMCLAGRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | N_MCLagPeerIdUIHolder |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
MCLAGDataRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/MCLAG/modifySaveMclagInstanceRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | MCLAGInstHolderMapper |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
MCLAGDataRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/MCLAG/overrideMCLAGAttributesRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | MCLAGInstHolderMapper |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
MCLAGDataRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/MCLAG/plannedToAllocateMCLAGRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | N_MCLagIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
N_MCLagIdRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/MCLAG/allocateToDeployMCLAGRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | MCLAGInstHolderMapper |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
MCLAGDataRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/MCLAG/schedForceCompleteMCLAGRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | N_MCLagIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
N_MCLagIdRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/MCLAG/scheduledActivateMCLagRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | N_MCLagIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
N_MCLagIdRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/MCLAG/scheduledBackToAllocateMCLagRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | N_MCLagIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
N_MCLagIdRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/MCLAG/scheduledDeactivateMCLagRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | N_MCLagIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
N_MCLagIdRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/MCLAG/scheduledDeleteMCLagRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | N_MCLagIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
N_MCLagIdRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/MCLAG/deployMclagRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | MCLAGInstHolderMapper |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
MCLAGDataRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/MCLAG/schedModifyMCLAGRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | MCLAGInstHolderMapper |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
MCLAGDataRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
MCLAG_PeerLagUIData
Name |
Type |
Description |
Enum |
|---|---|---|---|
| lagEncapType | String string |
--- | --- |
| nePack1 | NeNamePackName NeNamePackName |
--- | --- |
| peer1Name | String string |
--- | --- |
| lag1Name | String string |
--- | --- |
| lagRate | String string |
--- | --- |
| nePack2 | NeNamePackName NeNamePackName |
--- | --- |
| peer2Name | String string |
--- | --- |
| lag2Name | String string |
--- | --- |
MCLAGDataRespHolder
Name |
Type |
Description |
Enum |
|---|---|---|---|
| responseId | ResponseHeader ResponseHeader |
--- | --- |
| response | MCLAGInstMapper MCLAGInstMapper |
--- | --- |
| mcLagId | Integer integer |
--- | --- |
MCLAGInstHolderMapper
Name |
Type |
Description |
Enum |
|---|---|---|---|
| sessionId | String string |
--- | --- |
| requestURI | String string |
--- | --- |
| logReqId | String string |
--- | --- |
| operator | String string |
--- | --- |
| client | String string |
--- | --- |
| req | MCLAGInstMapper MCLAGInstMapper |
--- | --- |
| scheduler | SchedReqMapper SchedReqMapper |
--- | --- |
| oam | nOAMInstMapper nOAMInstMapper |
--- | --- |
| oamConfigured | Boolean boolean |
--- | --- |
| activate | Boolean boolean |
--- | --- |
MCLAGInstMapper
Name |
Type |
Description |
Enum |
|---|---|---|---|
| reqId | nRequestHeaderMapper nRequestHeaderMapper |
--- | --- |
| mcLagName | String string |
--- | --- |
| description | String string |
--- | --- |
| author | String string |
--- | --- |
| configurationType | String string |
--- | --- |
| neNamePackNames | array[NeNamePackName] NeNamePackName |
--- | --- |
| controlServiceName | String string |
--- | --- |
| erpName | String string |
--- | --- |
| cvLan | String string |
--- | --- |
| svLan | String string |
--- | --- |
| customer | String string |
--- | --- |
| vsOperationalMode | String string |
--- | --- |
| vplsName | String string |
--- | --- |
| peers | MCLAGPeers MCLAGPeers |
--- | --- |
| systemId | String string |
--- | --- |
| systemPriority | Integer integer |
--- | --- |
| adminKey | Integer integer |
--- | --- |
| flushEthernetRingEnabled | Boolean boolean |
--- | --- |
| peerLagData | array[MCLAG_PeerLagUIData] MCLAG_PeerLagUIData |
--- | --- |
| preCliCommand | String string |
--- | --- |
| postCliCommand | String string |
--- | --- |
| managementState | String string |
--- | --- |
| bindingEnabled | Boolean boolean |
--- | --- |
| controlServiceProtected | Boolean boolean |
--- | --- |
MCLAGPeers
Name |
Type |
Description |
Enum |
|---|---|---|---|
| peerData | array[MCLAGPeerUIData] MCLAGPeerUIData |
--- | --- |
| neighborFailureMultiplier | Integer integer |
--- | --- |
| keepAliveInterval | Integer integer |
--- | --- |
MCLAGPeerUIData
Name |
Type |
Description |
Enum |
|---|---|---|---|
| neNamePackName | NeNamePackName NeNamePackName |
--- | --- |
| peerList | array[MCLAGPeerDetails] MCLAGPeerDetails |
--- | --- |
N_MCLagId
Name |
Type |
Description |
Enum |
|---|---|---|---|
| mclagConfigName | String string |
--- | --- |
| jobTaskId | Long long |
--- | --- |
| author | String string |
--- | --- |
| description | String string |
--- | --- |
| mclagConfigHandle | Long long |
--- | --- |
| configType | String string |
--- | --- |
| targetManagementState | String string |
--- | --- |
| customerName | String string |
--- | --- |
| managementState | String string |
--- | --- |
N_MCLagIdHolder
Name |
Type |
Description |
Enum |
|---|---|---|---|
| sessionId | String string |
--- | --- |
| requestURI | String string |
--- | --- |
| logReqId | String string |
--- | --- |
| operator | String string |
--- | --- |
| client | String string |
--- | --- |
| reqId | nRequestHeaderMapper nRequestHeaderMapper |
--- | --- |
| req | N_MCLagId N_MCLagId |
--- | --- |
| scheduler | SchedReqMapper SchedReqMapper |
--- | --- |
| activate | Boolean boolean |
--- | --- |
N_MCLagIdRespHolder
Name |
Type |
Description |
Enum |
|---|---|---|---|
| responseId | ResponseHeader ResponseHeader |
--- | --- |
| rsp | N_MCLagId N_MCLagId |
--- | --- |
N_MCLagPeerId
Name |
Type |
Description |
Enum |
|---|---|---|---|
| mclagConfigHandle | Long long |
--- | --- |
| mclagConfigName | String string |
--- | --- |
| configType | String string |
--- | --- |
| targetNeName | String string |
--- | --- |
| targetPackName | String string |
--- | --- |
| targetSourceId | Long long |
--- | --- |
| targetPeerId | Long long |
--- | --- |
| prevToPrevOper | Integer integer |
--- | --- |
| operation | String string |
--- | --- |
| forceCurrentOperation | String string |
--- | --- |
| forcePrevOperation | String string |
--- | --- |
| jobTaskId | Long long |
--- | --- |
N_MCLagPeerIdUIHolder
Name |
Type |
Description |
Enum |
|---|---|---|---|
| sessionId | String string |
--- | --- |
| requestURI | String string |
--- | --- |
| logReqId | String string |
--- | --- |
| operator | String string |
--- | --- |
| client | String string |
--- | --- |
| reqId | nRequestHeaderMapper nRequestHeaderMapper |
--- | --- |
| req | N_MCLagPeerId N_MCLagPeerId |
--- | --- |
| scheduler | SchedReqMapper SchedReqMapper |
--- | --- |
| activate | Boolean boolean |
--- | --- |
nMAInstMapper
Name |
Type |
Description |
Enum |
|---|---|---|---|
| remoteMepInstList | array[eOAMRemoteMepInst] eOAMRemoteMepInst |
--- | --- |
| maName | String string |
--- | --- |
| maFormat | String string |
--- | --- |
| ccmInterval | String string |
--- | --- |
| mhfCreation | String string |
--- | --- |
| mep | nMEPInstMapper nMEPInstMapper |
--- | --- |
| remteMepList | array[eOAMRemoteMepInst] eOAMRemoteMepInst |
--- | --- |
nMEPInstMapper
Name |
Type |
Description |
Enum |
|---|---|---|---|
| upDirectionally | Boolean boolean |
--- | --- |
| interfaceType | String string |
--- | --- |
| active | Boolean boolean |
--- | --- |
| controlMepEnabled | Boolean boolean |
--- | --- |
| lowestPriorityDeffect | String string |
--- | --- |
| propagateHoldTime | Integer integer |
--- | --- |
| standbyMepShutdownEnabled | Boolean boolean |
--- | --- |
| ccm | nMepCCMInstMapper nMepCCMInstMapper |
--- | --- |
| ais | nMepAISInstMapper nMepAISInstMapper |
--- | --- |
nOAMInstMapper
Name |
Type |
Description |
Enum |
|---|---|---|---|
| templateName | String string |
--- | --- |
| mdLevel | Integer integer |
--- | --- |
| mdFormat | String string |
--- | --- |
| maInst | nMAInstMapper nMAInstMapper |
--- | --- |
| elementaryMepList | array[ElementaryMep] ElementaryMep |
--- | --- |
ResponseHeader
Name |
Type |
Description |
Enum |
|---|---|---|---|
| req | RequestHeader RequestHeader |
--- | --- |
| errorReason | String string |
--- | --- |
| errorCode | String string |
--- | --- |
| message | String string |
--- | --- |
| cmdStatus | String string |
--- | --- |
| opMsg | String string |
--- | --- |
| msgCode | String string |
--- | --- |
| parameters | array[String] string |
--- | --- |
| paramCount | Integer integer |
--- | --- |
| objectId | Integer integer |
--- | --- |
| jobName | String string |
--- | --- |
| objectType | Integer integer |
--- | --- |
SchedReqMapper
Name |
Type |
Description |
Enum |
|---|---|---|---|
| jobName | String string |
--- | --- |
| jobDescription | String string |
--- | --- |
| username | String string |
--- | --- |
| trigger | SchedTriggerMapper SchedTriggerMapper |
--- | --- |