Operation
get /esmBrowser/mplstpNpa/autoGenerateNodeAndGlobalIds/{vsIdList}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
vsIdList | required | Vs Id list, unique ids to <node,pack> | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ERP Details Data Holder
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
post /esmBrowser/mplstpNpa/autoGenerateNodeAndGlobalIdsJSON
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | MPLSTP NPA data | MPLSTPNpaNodeIdGlobalIdList |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ERP Details Data Holder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Example Request Data
https://135.250.76.235:8443/oms1350/esmBrowser/mplstpNpa/autoGenerateNodeAndGlobalIdsJSON/ {nodeIdGlbIdVsIdData: [{vsId: 44}, {vsId: 32}]}
Produces
application/json
Example Response Data
{"nodeIdGlbIdVsIdData":[{"vsId":32,"globalId":"2","nodeId":"0.0.0.19"}],"templateSeedNodeId":""}
External Docs
Operation
get /esmBrowser/mplstpNpa/clearMaMask/{maMask}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
maMask | required | maMask | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
systemValue
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/xml
External Docs
Operation
get /esmBrowser/mplstpNpa/clearPrevCVLAN/{prevVsIdList}/{prevAutoVal}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
prevVsIdList | required | prevVsIdList | --- |
prevAutoVal | required | prevAutoVal | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
systemValue
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/xml
External Docs
Operation
get /esmBrowser/mplstpNpa/clearPrevSVLAN/{prevVsIdList}/{prevAutoVal}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
prevVsIdList | required | prevVsIdList | --- |
prevAutoVal | required | prevAutoVal | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
systemValue
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/xml
External Docs
Operation
get /esmBrowser/mplstpNpa/GetEgressOperRateByTpId/{TpId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
tpId | required | Tp Id | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
systemValue
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/xml
External Docs
Operation
get /esmBrowser/mplstpNpa/getNextCVLanValueForLinkorErp/{ERPOrLinkId}/{erpOrLink}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
eRPOrLinkId | required | ERPOrLinkId | --- |
erpOrLink | required | erpOrLink | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
systemValue
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /esmBrowser/mplstpNpa/getNextMaMask
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
systemValue
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/xml
External Docs
Operation
get /esmBrowser/mplstpNpa/getNextMaMaskJson
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
systemValue
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /esmBrowser/mplstpNpa/getNextSVLanValueForLinkorErp/{ERPOrLinkId}/{erpOrLink}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
eRPOrLinkId | required | ERPOrLinkId | --- |
erpOrLink | required | erpOrLink | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
systemValue
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /esmBrowser/mplstpNpa/getNextCVLAN/{vsIdList}/{prevVsIdList}/{prevAutoVal}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
vsIdList | required | vsIdList | --- |
prevVsIdList | required | prevVsIdList | --- |
prevAutoVal | required | prevAutoVal | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
systemValue
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/xml
External Docs
Operation
get /esmBrowser/mplstpNpa/getNextCVLANJSON/{vsIdList}/{prevVsIdList}/{prevAutoVal}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
vsIdList | required | vsIdList | --- |
prevVsIdList | required | prevVsIdList | --- |
prevAutoVal | required | prevAutoVal | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
systemValue
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/xml
External Docs
Operation
get /esmBrowser/mplstpNpa/getNextSVLAN/{vsIdList}/{prevVsIdList}/{prevAutoVal}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
vsIdList | required | vsIdList | --- |
prevVsIdList | required | prevVsIdList | --- |
prevAutoVal | required | prevAutoVal | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
systemValue
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/xml
External Docs
Operation
post /esmBrowser/mplstpNpa/getNodeAndPackDetails
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | MPLSTP NPA data | MPLS TP NPA UI Mapper |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MPLS TP NPA UI Mapper
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Example Request Data
https://135.250.76.235:8443/oms1350/esmBrowser/mplstpNpa/getNodeAndPackDetails {neName: "ESM-4V1-N", packName: "11QCE12X-2-6", vsId: "13"}
Produces
application/json
Example Response Data
[{"neName":"ESM-4V1-L","packName":"11QCE12X-3-7","vsId":17,"vne":false},{"neName":"ESM-4V1-N","packName":"11QCE12X-2-6","vsId":13,"vne":false},{"neName":"ESM-4V1-N","packName":"11QCE12X-2-7","vsId":10,"vne":false},{"neName":"ESM-4V1-N","packName":"11QCE12X-2-5","vsId":9,"vne":false},{"neName":"ESM-4V1-O","packName":"11QCE12X-2-9","vsId":29,"vne":false},{"neName":"NPA_VNE-1","packName":"CARD-2-10","vsId":48,"vne":true},{"neName":"ESM-4V1-N","packName":"11QCE12X-2-10","vsId":44,"vne":false},{"neName":"ESM-4V1-N","packName":"11OPE8-2-11","vsId":46,"vne":false},{"neName":"NPA_VNE-2","packName":"NPANV-2-11","vsId":50,"vne":true},{"neName":"ESM-VNE-3","packName":"CARD-2-4","vsId":22,"vne":true}]
External Docs
Operation
get /esmBrowser/mplstpNpa/fetchRemoteMepList/{vsId}/{mdId}/{maId}/{handles}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
vsId | required | vsId | --- |
mdId | required | mdId | --- |
maId | required | maId | --- |
handles | required | handles | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MepDetailsList
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/xml
External Docs
Operation
get /esmBrowser/mplstpNpa/pollToGetRemoteMepDetails/{handle}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
handle | required | handle | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MepDetailsList
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/xml
External Docs
Operation
get /esmBrowser/mplstpNpa/fetchDeletedRemoteMepList/{vsId}/{mdId}/{maId}/{handles}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
vsId | required | vsId | --- |
mdId | required | mdId | --- |
maId | required | maId | --- |
handles | required | handles | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MepDetailsList
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/xml
External Docs
Operation
get /esmBrowser/mplstpNpa/tree/{context}
Here Context can be one of the two values
1. Design
2. Deploy
If the context is Design,the templates will be retrieved as per Design -> Network Configuration filtering rules(Both published and unpublished templates)
If the context is Deploy,the templates will be retrieved as per Deploy -> Network Configuration filtering rules(Only published templates).
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
context | required | Context can be one of the two values 1.Design 2.Deploy | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
nodes
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
ERP Details Data Holder
Name |
Type |
Description |
Enum |
---|---|---|---|
nERPDetailsDataHolders | array[ERPDetailsDataHolder] ERPDetailsDataHolder |
ERP NML Data List | --- |
items | array[ERPDetailsDataHolder] ERPDetailsDataHolder |
--- | --- |
ERPDetailsDataHolder
Name |
Type |
Description |
Enum |
---|---|---|---|
templateId | Integer integer |
Template ID | --- |
erpRingID | Long long |
Erp Ring Identifier | --- |
ringName | String string |
Ring Name | --- |
ringType | String string |
Ring Type | [Ring/Sub-Ring] |
ringDescr | String string |
Description for the Ring | --- |
cvlanId | String string |
Customer VLAN ID | --- |
svlanId | String string |
Subscriber VLAN ID | --- |
createTime | Date DateTime |
ERP creation time | --- |
modifyTime | Date DateTime |
ERP modification time | --- |
scheduleTime | Date DateTime |
Schedule time | --- |
protectionSwitchState | String string |
protection switch state | [Switched, Normal, None] |
managementState | String string |
Current management state of the erp | --- |
protectionType | String string |
Erp protection type | [Revertive, Non-Revertive] |
serviceState | String string |
Service state | [In service, Out of service, Not in service, Inconsistent, partial, unknown , --] |
operationalState | String string |
Operational state | [up, down, unknown, transition, --] |
guardTime | Integer integer |
Guard Time | --- |
revertTimer | Integer integer |
Revert Timer | --- |
holdUpTime | Integer integer |
Hold Up Time | --- |
holdDownTime | Integer integer |
Hold Down Time | --- |
holdTimeType | String string |
Hold Time Unit Type | --- |
alarmSeverity | String string |
alarm severity | --- |
alarmToolTip1 | String string |
AlarmToolTip1 | --- |
alarmToolTip2 | String string |
AlarmToolTip2 | --- |
alarmToolTip3 | String string |
AlarmToolTip3 | --- |
alarmToolTip4 | String string |
AlarmToolTip4 | --- |
alarmToolTip5 | String string |
AlarmToolTip5 | --- |
toolTipCount | Integer integer |
ToolTipCount | --- |
mdFormat | String string |
Maintenance Domain Format | [Y.1731 supports only NONE Format for MD] |
mdLevel | Integer integer |
Maintenance Domain Level | --- |
maFormat | String string |
Maintenance Association Format | [ITU-ICC] |
maName | String string |
Ma Name | --- |
ccmInterval | String string |
Ccm Interval | --- |
direction | Boolean boolean |
MEP direction | --- |
active | Boolean boolean |
MEP Active | --- |
ccmEnable | Boolean boolean |
CCM Enabled | --- |
enable | Boolean boolean |
AIS Enabled | --- |
aisLevel | array[Integer] integer |
AIS levels list | --- |
controlMepEnabled | Boolean boolean |
Control MEP enabled | --- |
ccmPriority | Integer integer |
CCM Priority | [0, 1, 2, 3, 4, 5, 6, 7] |
lockState | Integer integer |
Lock State | --- |
remark | String string |
Remark | --- |
aisPriority | Integer integer |
AIS priority | [0, 1, 2, 3, 4, 5, 6, 7] |
aisInterval | Integer integer |
AIS Interval | [1, 60] |
interfaceType | String string |
MEP Interface type | [SAP, PATH] |
lowestPriorityDefect | String string |
Lowest priority deffect on the MEP | ['All Defects', 'MAC, Remote, Error, Xcon', 'Remote, Error, Xcon', 'Error, Xcon', 'Xcon only', 'No defects Xcon or lower'] |
oamConfigured | Boolean boolean |
isOamConfigured | --- |
linkType | String string |
Link Type | [port, lag, mc-lag] |
hasChildren | Boolean boolean |
Ring has sub-Rings | --- |
id | String string |
Ring identifier | --- |
parent | String string |
Parent Ring name | --- |
subRingConfig | String string |
subRing Config | [VC, NON-VC ] |
propagateTopoChange | Integer integer |
--- | --- |
pRingIdL | String string |
parent Ring id in case of sub Ring | --- |
isSelected | Integer integer |
whether erp selected or not | --- |
defaultPort | Boolean boolean |
--- | --- |
defaultNode | Boolean boolean |
--- | --- |
switchState | String string |
protection switch state | [NONE, CLEAR , FORCE_BLOCKED, SET_BLOCKED] |
ringState | String string |
Ring state of the owner port | [Deactivated, Idle, Protection, Manual Switch, Forced Switch, Pending] |
alarmStatus | String string |
Alarm Status | --- |
serverAlarmStatus | String string |
Server Alarm Status | --- |
uiRingType | String string |
--- | --- |
propagateTopoChangeBoolean | Boolean boolean |
--- | --- |
sharedVplsBoolean | Boolean boolean |
--- | --- |
sharedVpls | Integer integer |
--- | --- |
notificationTime | Long long |
--- | --- |
ownerTpid | Integer integer |
--- | --- |
key | String string |
--- | --- |
className | String string |
--- | --- |
reserveResource | Boolean boolean |
reserveResource | --- |
preProvCLICommand | String string |
Pre CLI commands | --- |
postProvCLICommand | String string |
Post CLI commands | --- |
partialLinkPresent | Boolean boolean |
--- | --- |
author | String string |
Author for the erp | --- |
vneInvolved | Boolean boolean |
--- | --- |
topoChanged | Boolean boolean |
Topology Changed | --- |
MepDetails
Name |
Type |
Description |
Enum |
---|---|---|---|
mepId | Integer integer |
mepId | --- |
vsId | Integer integer |
vsId | --- |
transmittedCcms | String string |
transmittedCcms | [ ] |
ccmSeqErr | String string |
ccmSeqErr | [ ] |
lastErrCcmFailureFrame | String string |
lastErrCcmFailureFrame | [ ] |
lastXconCcmFailureFrame | String string |
lastXconCcmFailureFrame | [ ] |
highestPriorityDefect | String string |
highestPriorityDefect | [ ] |
maId | Integer integer |
--- | --- |
mdId | Integer integer |
mdId | --- |
maName | String string |
maName | [ ] |
nmlMacAddress | String string |
nmlMacAddress | [ ] |
macAddress | String string |
macAddress | [ ] |
packName | String string |
packName | [ ] |
mark | String string |
mark | [ ] |
neName | String string |
neName | [ ] |
commState | Integer integer |
--- | --- |
mepState | String string |
mepState | [ ] |
entityName | String string |
entityName | [ ] |
direction | String string |
direction | [ ] |
enitityPortPrimaryState | String string |
--- | --- |
monitoredObjSapSubType | String string |
sap sub type | [ ] |
remoteMepSapSubType | String string |
--- | --- |
entityType | Integer integer |
Entity Type | --- |
MepDetailsList
Name |
Type |
Description |
Enum |
---|---|---|---|
mepDetailsList | array[MepDetails] MepDetails |
List |
--- |
MPLSTPNpaNodeIdGlobalIdList
Name |
Type |
Description |
Enum |
---|---|---|---|
nodeIdGlbIdVsIdData | array[<nodeId, global Id, vsId> for mpls NPA deployment] <nodeId, global Id, vsId> for mpls NPA deployment |
List of |
--- |
templateSeedNodeId | String string |
seed value of NodeId; template values | [a range of addresses similar to IPV4 address; from 0.0.0.1 -- 255.255.255.255] |
Node
Name |
Type |
Description |
Enum |
---|
systemValue
Name |
Type |
Description |
Enum |
---|---|---|---|
systemValue | String string |
systemValue | --- |