Operation
post /esmService/topoService/abortERP
State transition :
Deploying -> Deploy Failed
OR
Modifying -> Modify Failed
ie., It is used to bring the service back to a non-transient state when its struck in a transient state of deploying/modifying
This will mark all the In-progress commands and tasks as Aborted. After marking the commands as Aborted if SNA sends a response, such a response will be dropped by ESM. It will also mark the management state of the service as Modify-Failed, if it were struck in Modifying, will mark it as Deploy-Failed if it were struck in Deploying and is not a scheduled operation.
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Erp Data | nERPIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ERPIdResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<ERPIdHolder> <req> <managementState>Deploying</managementState> <ringAdminState/> <ringId>10</ringId> <ringName>test-ERP</ringName> <ringType/> </req> <reqId> <clientName/> <reqId>0</reqId> <respBeanRef/> </reqId> </ERPIdHolder>
Produces
application/xml
External Docs
Operation
post /esmService/topoService/allocateERP
State transition :
New -> Planned -> Allocated
Saving an ERP in Allocated state in ESM is almost identical to saving it in Planned state(refer to planERP).The main difference between the two is, resources will be allocated(reserved) in Allocated management state, where as this is not true in Planned management state. As there are limitations on the number of ERP instances that can be created per pack and per port, the allocate state transition will ensure the number of ERPs thus created are within the allowed limits. Once the resources (network ports) are allocated for an ERP, it is guaranteed that ERP deployment to the NE's involved will not fail because of the resource constrains. In the UI, this can be accomplished by enabling the check-box Reserve-Resources while saving an ERP instance.
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Erp Data | nERPInstHolderMapper |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ERPDataRespHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<ERPInstHolder> <req> <ringName>AUTOCVLAN-ERP-2</ringName> <Author>REST</Author> <ringType>Major Ring</ringType> <subRingConfig/> <parentRingIds/> <propogateTopoChange>false</propogateTopoChange> <sharedVpls>1</sharedVpls> <ringDescription>REST-Description</ringDescription> <reserveResource>1</reserveResource> <cvlanId>2028</cvlanId> <svlanId>2029</svlanId> <linkType>PORT</linkType> <ownerTPID>2092</ownerTPID> <ownerTPName>11OPE8-1-11-X1</ownerTPName> <neighbourTPID>1528</neighbourTPID> <neighbourName>11QPE24-1-10-X2</neighbourName> <neDataList> <nNEData> <portRole/> <ringNodeHandle>0</ringNodeHandle> <ringNode>NODE-O</ringNode> <ringPortHandle>0</ringPortHandle> <ringPort>11OPE8-1-10-X1</ringPort> <ringLinkHandle>17</ringLinkHandle> <ringLink>NODE-O/11OPE8-1-10-X1-1 NODE-K/11QCE12X-2-7-X1-1 DSR</ringLink> <farEndNodeHandle>0</farEndNodeHandle> <farEndNode>NODE-K</farEndNode> <farEndPortHandle>0</farEndPortHandle> <farEndPort>11QCE12X-2-7-X1</farEndPort> </nNEData> <nNEData> <portRole/> <ringNodeHandle>0</ringNodeHandle> <ringNode>NODE-K</ringNode> <ringPortHandle>0</ringPortHandle> <ringPort>11QCE12X-2-7-X2</ringPort> <ringLinkHandle>57</ringLinkHandle> <ringLink>NODE-K/11QCE12X-2-7-X2-1 NODE-N/11QPE24-1-10-X1-1 DSR</ringLink> <farEndNodeHandle>0</farEndNodeHandle> <farEndNode>NODE-N</farEndNode> <farEndPortHandle>0</farEndPortHandle> <farEndPort>11QPE24-1-10-X1</farEndPort> </nNEData> <nNEData> <portRole>owner</portRole> <ringNodeHandle>0</ringNodeHandle> <ringNode>NODE-O</ringNode> <ringPortHandle>0</ringPortHandle> <ringPort>11OPE8-1-11-X1</ringPort> <ringLinkHandle>39</ringLinkHandle> <ringLink>NODE-N/11QPE24-1-10-X2-NODE-O/11OPE8-1-11-X1</ringLink> <farEndNodeHandle>0</farEndNodeHandle> <farEndNode>NODE-N</farEndNode> <farEndPortHandle>0</farEndPortHandle> <farEndPort>11QPE24-1-10-X2</farEndPort> </nNEData> <nNEData> <portRole/> <ringNodeHandle>0</ringNodeHandle> <ringNode>NODE-O</ringNode> <ringPortHandle>0</ringPortHandle> <ringPort>11OPE8-1-10-M1</ringPort> <ringLinkHandle>8</ringLinkHandle> <ringLink>NODE-O/11OPE8-1-10-M1/11OPE8-1-11-M1/OS</ringLink> <farEndNodeHandle>0</farEndNodeHandle> <farEndNode>NODE-O</farEndNode> <farEndPortHandle>0</farEndPortHandle> <farEndPort>11OPE8-1-11-M1</farEndPort> </nNEData> </neDataList> <protectiondata> <guardtime>6</guardtime> <revertTime>205</revertTime> <revertive>true</revertive> <protectionSwitchState>on</protectionSwitchState> <templateId>1</templateId> </protectiondata> <managementState>New</managementState> <targetMgmtState>Allocated</targetMgmtState> <preProvCliCmd/> <postProvCliCmd/> </req> <reqId> <clientName>dojoclient</clientName> <reqId>123</reqId> </reqId> <oam> <templateName/> <mdLevel>0</mdLevel> <mdFormat>NONE</mdFormat> <maInst> <ccmInterval>3.3ms</ccmInterval> <maFormat>ITU-ICC</maFormat> <maName>csvlaner02</maName> <mep> <active>true</active> <controlMepEnabled>true</controlMepEnabled> <interfaceType>Ring Path</interfaceType> <lowestPriorityDeffect>MAC, Remote, Error, Xcon</lowestPriorityDeffect> <upDirectionally>false</upDirectionally> <ccm> <ccmEnabled>true</ccmEnabled> <priority>7</priority> </ccm> <ais> <aisEnabled>false</aisEnabled> <interval>60</interval> <priority>7</priority> <aisLevels/> </ais> </mep> </maInst> </oam> </ERPInstHolder>
Produces
application/xml
Example Response Data
<ERPIdResponse> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>ERP_SUCCESS_0010</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>AUTOCVLAN-ERP-2</parameters> <req> <clientName>dojoclient</clientName> <reqId>123</reqId> <selectiveSyncViaPolling>false</selectiveSyncViaPolling> </req> </responseId> <req> <createTime>0</createTime> <description>REST-Description</description> <jobTaskId>0</jobTaskId> <ringId>0</ringId> <ringName>AUTOCVLAN-ERP-2</ringName> </req> </ERPIdResponse>
External Docs
Operation
post /esmService/topoService/dbDeleteERP
However,the entities that are already deployed on the NE will remain as it is on the NE.
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 ERP, Network discovery will discover this ERP back.
If user has done DB delete of an inconsistent ERP, Network discovery will not discover the whole ERP back. It will only sync the elementary entities from the NE to ESM.
If the ERP is not discovered after network discovery, user can refer to Network disocvery joblist 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 | Erp Data | nERPIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ERPIdResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<ERPIdHolder> <req> <managementState>Commissioned</managementState> <ringAdminState/> <ringId/> <ringName>REST-ELM-ERP-2</ringName> <ringType/> </req> <reqId> <clientName/> <reqId/> <respBeanRef/> </reqId> </ERPIdHolder>
Produces
application/xml
Example Response Data
<ERPIdResponse> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>ERP_SUCCESS_0004</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>REST-ELM-ERP-2</parameters> <req> <clientName/> <reqId/> <selectiveSyncViaPolling>false</selectiveSyncViaPolling> </req> </responseId> <req> <createTime>0</createTime> <jobTaskId>0</jobTaskId> <managementState>Commissioned</managementState> <ringAdminState/> <ringId>0</ringId> <ringName>REST-ELM-ERP-2</ringName> <ringType/> </req> </ERPIdResponse>
External Docs
Operation
post /esmService/topoService/deAllocateERP
State transition :
Allocated -> Planned
ie., The resources(network ports involved in the ERP) will no more be reserved after successful completion of this operation.
It can be triggered only on an ERP with Allocated management state and is not a scheduled operation.
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Erp Data | nERPInstHolderMapper |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ERPIdResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<ERPInstHolder> <req> <ringName>REST-ELM-ERP-2</ringName> <ringType/> <managementState>Allocated</managementState> <targetMgmtState>Planned</targetMgmtState> </req> <reqId> <clientName/> <reqId>123</reqId> </reqId> </ERPInstHolder>
Produces
application/xml
Example Response Data
<ERPIdResponse> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>ERP_SUCCESS_0009</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>REST-ELM-ERP-2</parameters> <req> <clientName/> <reqId>123</reqId> <selectiveSyncViaPolling>false</selectiveSyncViaPolling> </req> </responseId> <req> <createTime>0</createTime> <jobTaskId>0</jobTaskId> <ringId>0</ringId> <ringName>REST-ELM-ERP-2</ringName> </req> </ERPIdResponse>
External Docs
Operation
post /esmService/topoService/deleteERP
State transition :
Allocated -> Deleted
OR
Planned -> Deleted
This operation can be triggered only on Planned and Allocated ERP. It will delete the ERP instance and all its associations from ESM.
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Erp Data | nERPIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ERPIdResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<ERPIdHolder> <req> <managementState>Planned</managementState> <ringAdminState/> <ringId>0</ringId> <ringName>AUTOCVLAN-ERP-1</ringName> <ringType/> </req> <reqId> <clientName/> <reqId>123</reqId> <respBeanRef/> </reqId> </ERPIdHolder>
Produces
application/xml
Example Response Data
<ERPIdResponse> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>ERP_SUCCESS_0004</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>AUTOCVLAN-ERP-1</parameters> <req> <clientName/> <reqId>123</reqId> <selectiveSyncViaPolling>false</selectiveSyncViaPolling> </req> </responseId> <req> <createTime>0</createTime> <jobTaskId>0</jobTaskId> <managementState>Planned</managementState> <ringAdminState/> <ringId>0</ringId> <ringName>AUTOCVLAN-ERP-1</ringName> <ringType/> </req> </ERPIdResponse>
External Docs
Operation
post /esmService/topoService/deleteERPScheduled
It is applicable only to Deploy Failed management state. Internally does deactivate and delete for the involved entities.
State transition :
Deploy Failed -> Deleted
The operation is same almost same as move back to allocate operation(refer to moveBackToAllocateERPScheduled ), except that it also deletes the ERP instance from ESM.
This is a scheduled operation in ESM. User can choose to delete an ERP for a future time or delete it right away.
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Erp Data | nERPIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ERPIdResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<ERPIdHolder> <req> <managementState>Deploy Failed</managementState> <ringAdminState/> <ringId>41</ringId> <ringName>REST-ELM-ERP-1</ringName> <ringType/> <createTime>0</createTime> <description/> <preProvCliCmd/> <postProvCliCmd/> </req> <reqId> <clientName/> <reqId>4</reqId> <respBeanRef/> </reqId> <scheduler> <jobName>REST-ELM-ERP-1_1449235060821</jobName> <jobDescription>REST Description</jobDescription> <username/> <trigger> <name>REST-ELM-ERP-1_1449235060821Trigger</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </ERPIdHolder>
Produces
application/xml
Example Response Data
<ERPIdResponse> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>ERP_SUCCESS_0012</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>REST-ELM-ERP-1</parameters> </responseId> </ERPIdResponse>
External Docs
Operation
post /esmService/topoService/ForceDeployERPScheduled
State transition :
Commissioned, Inconsistent state To Commissioned, In Service state
Entities : Ring id , Path A, Path B , VPLS , SAP, OAM
There is no guarantee that the ERP will be consistent. It is subject to proper deployment of entities on the NE.
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Erp Data | nERPIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ERPIdResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<ERPIdHolder> <req> <managementState>Commissioned</managementState> <ringAdminState/> <ringId>2</ringId> <ringName>KINIERP01</ringName> <ringType/> <createTime>1494303150000</createTime> <description/> <preProvCliCmd/> <postProvCliCmd/> </req> <reqId> <clientName/> <reqId>4</reqId> <respBeanRef/> </reqId> <scheduler> <jobName>ERP_KINIERP01_Wed May 10 2017 11:58:36 UTC+5:30</jobName> <jobDescription/> <username>alcatel</username> <trigger> <name>ERP_KINIERP01_Wed May 10 2017 11:58:36 UTC+5:30Trigger</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </ERPIdHolder>
Produces
application/xml
Example Response Data
<ERPIdResponse> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>ERP_SUCCESS_0011</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>KINIERP01</parameters> </responseId> </ERPIdResponse>
External Docs
Operation
post /esmService/topoService/lockERP
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Erp Data | nERPInstHolderMapper |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ERPIdResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<ERPInstHolder> <req> <ringName>REST-ERP-03</ringName> <ringType/> <managementState>Commissioned</managementState> <targetMgmtState>Commissioned</targetMgmtState> </req> <reqId> <clientName/> <reqId>6</reqId> </reqId> </ERPInstHolder>
Produces
application/xml
Example Response Data
<ERPIdResponse> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>ERP_SUCCESS_0020</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>REST-ERP-03</parameters> <req> <clientName/> <reqId>6</reqId> <selectiveSyncViaPolling>false</selectiveSyncViaPolling> </req> </responseId> </ERPIdResponse>
External Docs
Operation
post /esmService/topoService/modifyERP
State transition :
Planned -> Planned
OR
Allocated -> Allocated
The ERP attributes, its topology and other details can be modified and saved in the Planned and Allocated states using this API.The validations that are done during planERP and allocateERP will be done again during this operation.
Important parameters that can be modified on an ERP in Planned/Allocated state are :
Ring name, description, author
Ring topology(links, lag links) and marking/unmarking ERP nodes as transparent , RPL Owner, C-Vlan and S-Vlan
Ring protection parameters (Protection type, guard time, revert time)
OAM attributes : Some attributes on MA and MEP. MD cannot be changed
Enabling/disabling CLI and editing the CLI text
All this updated values will be saved in ESM.
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Erp Data | nERPInstHolderMapper |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ERPDataRespHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<ERPInstHolder> <req> <ringName>MAJOR-RING-1A</ringName> <Author>Alcatel-lucent</Author> <ringType>Major Ring</ringType> <propogateTopoChange>false</propogateTopoChange> <sharedVpls>1</sharedVpls> <subRingConfig/> <parentRingIds/> <ringDescription>REST Description</ringDescription> <reserveResource>0</reserveResource> <cvlanId>450</cvlanId> <svlanId>450</svlanId> <linkType>LAG</linkType> <ownerTPID>13394</ownerTPID> <ownerTPName>11QCE12X-1-10-LAG1</ownerTPName> <neighbourTPID>13390</neighbourTPID> <neighbourName>11QCE12X-1-11-LAG1</neighbourName> <neDataList> <nNEData> <portRole>owner</portRole> <ringNodeHandle>0</ringNodeHandle> <ringNode>REST-O</ringNode> <ringPortHandle>0</ringPortHandle> <ringPort>11QCE12X-1-10-LAG1</ringPort> <ringLinkHandle>322</ringLinkHandle> <ringLink>REST-O/11QCE12X-1-10-LAG1 REST-O/11QCE12X-1-11-LAG1</ringLink> <farEndNodeHandle/> <farEndNode>REST-O</farEndNode> <farEndPortHandle/> <farEndPort>11QCE12X-1-11-LAG1</farEndPort> </nNEData> <nNEData> <portRole/> <ringNodeHandle>0</ringNodeHandle> <ringNode>REST-O</ringNode> <ringPortHandle>0</ringPortHandle> <ringPort>11QCE12X-1-10-LAG2</ringPort> <ringLinkHandle>323</ringLinkHandle> <ringLink>REST-O/11QCE12X-1-10-LAG2 REST-L/11QPE24-2-7-LAG2</ringLink> <farEndNodeHandle/> <farEndNode>REST-L</farEndNode> <farEndPortHandle/> <farEndPort>11QPE24-2-7-LAG2</farEndPort> </nNEData> <nNEData> <portRole/> <ringNodeHandle>0</ringNodeHandle> <ringNode>REST-M</ringNode> <ringPortHandle>0</ringPortHandle> <ringPort>11OPE8-1-10-LAG1</ringPort> <ringLinkHandle>324</ringLinkHandle> <ringLink>REST-M/11OPE8-1-10-LAG1 REST-O/11QCE12X-1-11-LAG2</ringLink> <farEndNodeHandle/> <farEndNode>REST-O</farEndNode> <farEndPortHandle/> <farEndPort>11QCE12X-1-11-LAG2</farEndPort> </nNEData> <nNEData> <portRole/> <ringNodeHandle>0</ringNodeHandle> <ringNode>REST-M</ringNode> <ringPortHandle>0</ringPortHandle> <ringPort>11OPE8-1-10-LAG2</ringPort> <ringLinkHandle>325</ringLinkHandle> <ringLink>REST-M/11OPE8-1-10-LAG2 REST-L/11QPE24-2-7-LAG1</ringLink> <farEndNodeHandle/> <farEndNode>REST-L</farEndNode> <farEndPortHandle/> <farEndPort>11QPE24-2-7-LAG1</farEndPort> </nNEData> </neDataList> <protectiondata> <guardtime>5</guardtime> <revertTime>210</revertTime> <revertive>false</revertive> <protectionSwitchState>on</protectionSwitchState> <templateId>1</templateId> <holdUpTime>450</holdUpTime> <holdDownTime>650</holdDownTime> <holdTimeType>centiseconds</holdTimeType> </protectiondata> <managementState>Planned</managementState> <targetMgmtState>Planned</targetMgmtState> <preProvCliCmd/> <postProvCliCmd/> </req> <reqId> <clientName>dojoclient</clientName> <reqId>123</reqId> </reqId> <scheduler> <jobName>MAJOR-RING-1A_1449247470840</jobName> <jobDescription>AUTO</jobDescription> <username/> <trigger> <triggerName>MAJOR-RING-1A_1449247470840Trigger</triggerName> <deployNow>Yes</deployNow> <triggerType/> <triggerExpression/> <triggerTimeOffset/> </trigger> </scheduler> <oam> <templateName/> <mdLevel>2</mdLevel> <mdFormat>NONE</mdFormat> <maInst> <ccmInterval>3.3ms</ccmInterval> <maFormat>ITU-ICC</maFormat> <maName>MAJORR0045</maName> <mep> <active>true</active> <controlMepEnabled>true</controlMepEnabled> <interfaceType>Ring Path</interfaceType> <lowestPriorityDeffect>MAC, Remote, Error, Xcon</lowestPriorityDeffect> <upDirectionally>false</upDirectionally> <ccm> <ccmEnabled>true</ccmEnabled> <priority>6</priority> </ccm> <ais> <aisEnabled>true</aisEnabled> <interval>60</interval> <priority>7</priority> <aisLevels> <levels>2</levels> <levels>3</levels> <levels>4</levels> </aisLevels> </ais> </mep> </maInst> <elementaryMepList/> </oam> </ERPInstHolder>
Produces
application/xml
Example Response Data
<ERPDataRespHolder> <resp> <ringName>MAJOR-RING-1A</ringName> <ringType>Major Ring</ringType> <Author>Alcatel-lucent</Author> <ringDescription>REST Description</ringDescription> <reserveResource>false</reserveResource> <cvlanId>450</cvlanId> <svlanId>450</svlanId> <ownerTPID>13394</ownerTPID> <ownerTPName>11QCE12X-1-10-LAG1</ownerTPName> <neighbourTPID>13390</neighbourTPID> <neighbourName>11QCE12X-1-11-LAG1</neighbourName> <managementState>Planned</managementState> <targetMgmtState>Planned</targetMgmtState> <neDataList> <nNEData> <farEndNode>REST-O</farEndNode> <farEndNodeHandle>0</farEndNodeHandle> <farEndNodeVSID>0</farEndNodeVSID> <farEndPort>11QCE12X-1-11-LAG1</farEndPort> <farEndPortHandle>0</farEndPortHandle> <linkState>0</linkState> <neighbour>0</neighbour> <owner>0</owner> <portRole>owner</portRole> <ringId>0</ringId> <ringLink>REST-O/11QCE12X-1-10-LAG1 REST-O/11QCE12X-1-11-LAG1</ringLink> <ringLinkHandle>322</ringLinkHandle> <ringNode>REST-O</ringNode> <ringNodeHandle>0</ringNodeHandle> <ringNodeVSID>0</ringNodeVSID> <ringPort>11QCE12X-1-10-LAG1</ringPort> <ringPortHandle>0</ringPortHandle> </nNEData> <nNEData> <farEndNode>REST-L</farEndNode> <farEndNodeHandle>0</farEndNodeHandle> <farEndNodeVSID>0</farEndNodeVSID> <farEndPort>11QPE24-2-7-LAG2</farEndPort> <farEndPortHandle>0</farEndPortHandle> <linkState>0</linkState> <neighbour>0</neighbour> <owner>0</owner> <portRole/> <ringId>0</ringId> <ringLink>REST-O/11QCE12X-1-10-LAG2 REST-L/11QPE24-2-7-LAG2</ringLink> <ringLinkHandle>323</ringLinkHandle> <ringNode>REST-O</ringNode> <ringNodeHandle>0</ringNodeHandle> <ringNodeVSID>0</ringNodeVSID> <ringPort>11QCE12X-1-10-LAG2</ringPort> <ringPortHandle>0</ringPortHandle> </nNEData> <nNEData> <farEndNode>REST-O</farEndNode> <farEndNodeHandle>0</farEndNodeHandle> <farEndNodeVSID>0</farEndNodeVSID> <farEndPort>11QCE12X-1-11-LAG2</farEndPort> <farEndPortHandle>0</farEndPortHandle> <linkState>0</linkState> <neighbour>0</neighbour> <owner>0</owner> <portRole/> <ringId>0</ringId> <ringLink>REST-M/11OPE8-1-10-LAG1 REST-O/11QCE12X-1-11-LAG2</ringLink> <ringLinkHandle>324</ringLinkHandle> <ringNode>REST-M</ringNode> <ringNodeHandle>0</ringNodeHandle> <ringNodeVSID>0</ringNodeVSID> <ringPort>11OPE8-1-10-LAG1</ringPort> <ringPortHandle>0</ringPortHandle> </nNEData> <nNEData> <farEndNode>REST-L</farEndNode> <farEndNodeHandle>0</farEndNodeHandle> <farEndNodeVSID>0</farEndNodeVSID> <farEndPort>11QPE24-2-7-LAG1</farEndPort> <farEndPortHandle>0</farEndPortHandle> <linkState>0</linkState> <neighbour>0</neighbour> <owner>0</owner> <portRole/> <ringId>0</ringId> <ringLink>REST-M/11OPE8-1-10-LAG2 REST-L/11QPE24-2-7-LAG1</ringLink> <ringLinkHandle>325</ringLinkHandle> <ringNode>REST-M</ringNode> <ringNodeHandle>0</ringNodeHandle> <ringNodeVSID>0</ringNodeVSID> <ringPort>11OPE8-1-10-LAG2</ringPort> <ringPortHandle>0</ringPortHandle> </nNEData> </neDataList> <protectiondata> <guardtime>5</guardtime> <protectionSwitchState>on</protectionSwitchState> <revertTime>210</revertTime> <revertive>false</revertive> <templateId>1</templateId> </protectiondata> <templateId>0</templateId> <subRingConfig/> <parentRingIds/> <propogateTopoChange>false</propogateTopoChange> <preProvCliCmd/> <postProvCliCmd/> <jobTaskId>0</jobTaskId> <mdIndex>0</mdIndex> <maIndex>0</maIndex> <linkType>LAG</linkType> </resp> <response> <cmdStatus>Success</cmdStatus> <msgCode>ERP_SUCCESS_0018</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>MAJOR-RING-1A</parameters> </response> </ERPDataRespHolder>
External Docs
Operation
post /esmService/topoService/modifyERPScheduled
Commissioned -> Commissioned
OR
Modify Failed -> Commissioned
Some validations will be performed by ESM for this request. This operation will first update the ESM database with the changes done on the ERP by user, updates the ERP remarks and then it deploys the changes to the NE, and clears the remarks when the operation is successful. When the commands are being created and deployed, ERP will be moved to a transient management state Modifying
The modification is allowed for the following entities using this operation :
Ring name and description
Author(not propagated to NE)
RPL Owner change
Ring protection parameters
OAM : some attributes for MA and MEP
PRE and post CLI commands
Ring topology :
Modification of Ring topology on a commissioned ERP calls for an sequence of prerequisite steps before performing this operation in ESM. In topology modification, only one link addition is allowed. (link removal and adding of multiple links in one step is currently not supported by ESM)
1. Ensure the ERP is unlocked (refer to unlockERP API )
2. Delete (DB remove connections and clients) and create required OTN links from the OTN application (The newly created link must use the earlier link ports)
3. If the RPL link in deleted then new RPL Link and Port must be selected
4. When the topology is being modified, the corresponding services riding on this ERP are marked inconsistent.
5. On successful ERP topology modification, the corresponding services riding on this ERP are also modified sequentially, to create new service entities on them. The details of the service modification can be viewed in its corresponding service job.
6. On each successful service modification, the service is restored back to commissioned state.
7. When all services are modified successfully, the overall ERP modification is marked successful. The details of the ERP modification can be viewed in its corresponding ERP job.
When modifying Ring topology, it is better not to modify other attributes of the Ring.(Attribute modification can be done after the topology modification is completed)
All the commands executed and their status along with error reason if failed, will be logged in ESM job list.
If all the commands executed are successful, the ERP will be marked Commissioned.
If any of the commands deployed to NE are failed ERPs will be marked as Modify-Failed and remarks will not be cleared.
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Erp Data | nERPInstHolderMapper |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ERPDataRespHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<ERPInstHolder> <req> <ringName>SUB-RING-1A</ringName> <Author>Alcatel-lucent</Author> <ringType>Sub Ring</ringType> <propogateTopoChange>false</propogateTopoChange> <sharedVpls>1</sharedVpls> <subRingConfig>Non-Virtual Channel</subRingConfig> <parentRingIds>50</parentRingIds> <ringDescription>REST Description</ringDescription> <reserveResource>1</reserveResource> <cvlanId>550</cvlanId> <svlanId>550</svlanId> <linkType>PORT</linkType> <ownerTPID>12567</ownerTPID> <ownerTPName>11QCE12X-1-11-X1</ownerTPName> <neighbourTPID>12035</neighbourTPID> <neighbourName>11QPE24-1-10-X2</neighbourName> <neDataList> <nNEData> <portRole/> <ringNodeHandle>0</ringNodeHandle> <ringNode>REST-O</ringNode> <ringPortHandle>0</ringPortHandle> <ringPort>11QCE12X-1-10-X1</ringPort> <ringLinkHandle>254</ringLinkHandle> <ringLink>REST-O/11QCE12X-1-10-X1-1 REST-K/11QCE12X-2-7-X1-1 DSR</ringLink> <farEndNodeHandle/> <farEndNode>REST-K</farEndNode> <farEndPortHandle/> <farEndPort>11QCE12X-2-7-X1</farEndPort> </nNEData> <nNEData> <portRole/> <ringNodeHandle>0</ringNodeHandle> <ringNode>REST-K</ringNode> <ringPortHandle>0</ringPortHandle> <ringPort>11QCE12X-2-7-X2</ringPort> <ringLinkHandle>300</ringLinkHandle> <ringLink>REST-K/11QCE12X-2-7-X2-1 REST-N/11QPE24-1-10-X1-1 DSR</ringLink> <farEndNodeHandle/> <farEndNode>REST-N</farEndNode> <farEndPortHandle/> <farEndPort>11QPE24-1-10-X1</farEndPort> </nNEData> <nNEData> <portRole>owner</portRole> <ringNodeHandle>0</ringNodeHandle> <ringNode>REST-O</ringNode> <ringPortHandle>0</ringPortHandle> <ringPort>11QCE12X-1-11-X1</ringPort> <ringLinkHandle>280</ringLinkHandle> <ringLink>REST-N/11QPE24-1-10-X2-REST-O/11QCE12X-1-11-X1</ringLink> <farEndNodeHandle/> <farEndNode>REST-N</farEndNode> <farEndPortHandle/> <farEndPort>11QPE24-1-10-X2</farEndPort> </nNEData> </neDataList> <protectiondata> <guardtime>5</guardtime> <revertTime>210</revertTime> <revertive>false</revertive> <protectionSwitchState>on</protectionSwitchState> <templateId>1</templateId> <holdUpTime>3</holdUpTime> <holdDownTime>7</holdDownTime> <holdTimeType>seconds</holdTimeType> </protectiondata> <managementState>Planned</managementState> <targetMgmtState>Planned</targetMgmtState> <preProvCliCmd/> <postProvCliCmd/> </req> <reqId> <clientName>dojoclient</clientName> <reqId>123</reqId> </reqId> <scheduler> <jobName>SUB-RING-1A_1449247303606</jobName> <jobDescription>AUTO</jobDescription> <username/> <trigger> <triggerName>SUB-RING-1A_1449247303606Trigger</triggerName> <deployNow>Yes</deployNow> <triggerType/> <triggerExpression/> <triggerTimeOffset/> </trigger> </scheduler> <oam> <templateName/> <mdLevel>2</mdLevel> <mdFormat>NONE</mdFormat> <maInst> <ccmInterval>3.3ms</ccmInterval> <maFormat>ITU-ICC</maFormat> <maName>SUBRNG0046</maName> <mep> <active>true</active> <controlMepEnabled>true</controlMepEnabled> <interfaceType>Ring Path</interfaceType> <lowestPriorityDeffect>MAC, Remote, Error, Xcon</lowestPriorityDeffect> <upDirectionally>false</upDirectionally> <ccm> <ccmEnabled>true</ccmEnabled> <priority>6</priority> </ccm> <ais> <aisEnabled>true</aisEnabled> <interval>60</interval> <priority>7</priority> <aisLevels> <levels>2</levels> <levels>3</levels> <levels>4</levels> </aisLevels> </ais> </mep> </maInst> <elementaryMepList/> </oam> </ERPInstHolder>
Produces
application/xml
Example Response Data
<ERPDataRespHolder> <resp> <ringName>SUB-RING-1A</ringName> <ringType>Sub Ring</ringType> <Author>Alcatel-lucent</Author> <ringDescription>REST Description</ringDescription> <reserveResource>true</reserveResource> <cvlanId>550</cvlanId> <svlanId>550</svlanId> <ownerTPID>12567</ownerTPID> <ownerTPName>11QCE12X-1-11-X1</ownerTPName> <neighbourTPID>12035</neighbourTPID> <neighbourName>11QPE24-1-10-X2</neighbourName> <managementState>Planned</managementState> <targetMgmtState>Planned</targetMgmtState> <neDataList> <nNEData> <farEndNode>REST-K</farEndNode> <farEndNodeHandle>0</farEndNodeHandle> <farEndNodeVSID>0</farEndNodeVSID> <farEndPort>11QCE12X-2-7-X1</farEndPort> <farEndPortHandle>0</farEndPortHandle> <linkState>0</linkState> <neighbour>0</neighbour> <owner>0</owner> <portRole/> <ringId>0</ringId> <ringLink>REST-O/11QCE12X-1-10-X1-1 REST-K/11QCE12X-2-7-X1-1 DSR</ringLink> <ringLinkHandle>254</ringLinkHandle> <ringNode>REST-O</ringNode> <ringNodeHandle>0</ringNodeHandle> <ringNodeVSID>0</ringNodeVSID> <ringPort>11QCE12X-1-10-X1</ringPort> <ringPortHandle>0</ringPortHandle> </nNEData> <nNEData> <farEndNode>REST-N</farEndNode> <farEndNodeHandle>0</farEndNodeHandle> <farEndNodeVSID>0</farEndNodeVSID> <farEndPort>11QPE24-1-10-X1</farEndPort> <farEndPortHandle>0</farEndPortHandle> <linkState>0</linkState> <neighbour>0</neighbour> <owner>0</owner> <portRole/> <ringId>0</ringId> <ringLink>REST-K/11QCE12X-2-7-X2-1 REST-N/11QPE24-1-10-X1-1 DSR</ringLink> <ringLinkHandle>300</ringLinkHandle> <ringNode>REST-K</ringNode> <ringNodeHandle>0</ringNodeHandle> <ringNodeVSID>0</ringNodeVSID> <ringPort>11QCE12X-2-7-X2</ringPort> <ringPortHandle>0</ringPortHandle> </nNEData> <nNEData> <farEndNode>REST-N</farEndNode> <farEndNodeHandle>0</farEndNodeHandle> <farEndNodeVSID>0</farEndNodeVSID> <farEndPort>11QPE24-1-10-X2</farEndPort> <farEndPortHandle>0</farEndPortHandle> <linkState>0</linkState> <neighbour>0</neighbour> <owner>0</owner> <portRole>owner</portRole> <ringId>0</ringId> <ringLink>REST-N/11QPE24-1-10-X2-REST-O/11QCE12X-1-11-X1</ringLink> <ringLinkHandle>280</ringLinkHandle> <ringNode>REST-O</ringNode> <ringNodeHandle>0</ringNodeHandle> <ringNodeVSID>0</ringNodeVSID> <ringPort>11QCE12X-1-11-X1</ringPort> <ringPortHandle>0</ringPortHandle> </nNEData> </neDataList> <protectiondata> <guardtime>5</guardtime> <protectionSwitchState>on</protectionSwitchState> <revertTime>210</revertTime> <revertive>false</revertive> <templateId>1</templateId> </protectiondata> <templateId>0</templateId> <subRingConfig>Non-Virtual Channel</subRingConfig> <parentRingIds>50</parentRingIds> <propogateTopoChange>false</propogateTopoChange> <preProvCliCmd/> <postProvCliCmd/> <jobTaskId>0</jobTaskId> <mdIndex>0</mdIndex> <maIndex>0</maIndex> <linkType>PORT</linkType> </resp> <response> <cmdStatus>Success</cmdStatus> <msgCode>ERP_SUCCESS_0018</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>SUB-RING-1A</parameters> </response> </ERPDataRespHolder>
External Docs
Operation
post /esmService/topoService/moveBackToAllocateERPScheduled
State transition :
Commissioned -> Allocated
OR
Deploy Failed -> Allocated
This operation will refer to ESM database to find all the entities created on the NE for the ERP instance on which operation is being invoked.
This is a scheduled operation in ESM. User can choose to move back to allocate an ERP for a future time or move back to allocate it right away.
Creates the commands and sends the commands to NE(SNA) to delete these entities.
The entity deletion/updation commands will be sent in the following order :
PRE CLI commands(if provided)
Deactivate ring path
OAM entity deletion
MEP deactivation and deletion
MA(Remote MEP will be deleted automatically when MA is deleted)
Control service deletion (SAP deactivation and deletion, VPLS deactivation and deletion)
Ring and path deletion
All the commands executed and their status along with error reason if failed, will be logged in ESM job list.
If all the commands executed are successful, ESM will delete elementary records from its database and the ERP will be marked as Allocated.
If any of the commands have failed, the ERP will be marked Deploy-Failed(only the elementary database records for successful commands will be removed from ESM database).
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Erp Data | nERPIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ERPIdResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<ERPIdHolder> <req> <managementState>Commissioned</managementState> <ringAdminState/> <ringId>40</ringId> <ringName>REST-ERP-03</ringName> <ringType/> <createTime/> <description/> <preProvCliCmd/> <postProvCliCmd/> </req> <reqId> <clientName/> <reqId>123</reqId> <respBeanRef/> </reqId> <scheduler> <jobName>REST-ERP-03_1449234890244</jobName> <jobDescription>AUTO</jobDescription> <username/> <trigger> <name>REST-ERP-03_1449234890244Trigger</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </ERPIdHolder>
Produces
application/xml
Example Response Data
<ERPIdResponse> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>ERP_SUCCESS_0008</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>REST-ERP-03</parameters> </responseId> </ERPIdResponse>
External Docs
Operation
post /esmService/topoService/moveToAllocateERP
State transition :
Planned -> Allocated
This operation can be triggered only on an ERP with Planned management state. As there are limitations on the number of ERP instances that can be created per pack and per port,the allocate state transition will ensure the number of ERPs thus created are within the allowed limits.
Once the resources (network ports) are allocated for an ERP, it is guaranteed that ERP deployment to the NE's involved will not fail because of the resource constrains. This is not a scheduled operation.
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Erp Data | nERPInstHolderMapper |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ERPIdResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<ERPInstHolder> <req> <ringName>REST-ERP-SERV-1</ringName> <ringType/> <managementState>Planned</managementState> <targetMgmtState>Allocated</targetMgmtState> </req> <reqId> <clientName/> <reqId>123</reqId> </reqId> </ERPInstHolder>
Produces
application/xml
Example Response Data
<ERPIdResponse> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>ERP_SUCCESS_0010</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>REST-ERP-SERV-1</parameters> <req> <clientName/> <reqId>123</reqId> <selectiveSyncViaPolling>false</selectiveSyncViaPolling> </req> </responseId> <req> <createTime>0</createTime> <jobTaskId>0</jobTaskId> <ringId>0</ringId> <ringName>REST-ERP-SERV-1</ringName> </req> </ERPIdResponse>
External Docs
Operation
post /esmService/topoService/MoveToDeployERPScheduled
State transition :
Allocated -> Commissioned/Deploy-Failed
This operation is almost same as schedDeployERP operation.(refer to schedDeployERP API)
The only difference is the management state from which the operation is started is Allocated(Plan and Allocate would have been done already before).
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Erp Data | nERPIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ERPIdResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<ERPIdHolder> <req> <managementState>Allocated</managementState> <ringAdminState/> <ringId>46</ringId> <ringName>REST-ERP-SERV-1</ringName> <ringType/> <createTime>0</createTime> <description/> <preProvCliCmd/> <postProvCliCmd/> </req> <reqId> <clientName/> <reqId>8</reqId> <respBeanRef/> </reqId> <scheduler> <jobName>REST-ERP-SERV-1_1449235626461</jobName> <jobDescription>AUTO</jobDescription> <username/> <trigger> <name>REST-ERP-SERV-1_1449235626461Trigger</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </ERPIdHolder>
Produces
application/xml
Example Response Data
<ERPIdResponse> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>ERP_SUCCESS_0011</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>REST-ERP-SERV-1</parameters> </responseId> </ERPIdResponse>
External Docs
Operation
post /esmService/topoService/planERP
State transition :
New -> Planned
When an ERP instance is in Planned management state, its existence will be only in ESM. It will create a new erp instance in ESM with the unique name given by user and a unique CVLAN-SVLAN combination. Validation errors will be thrown if either ERP name or the CVLAN-SVLAN combination is not unique and the ERP instance will not be saved in even ESM.Resources(Topology and network ports) will not be reserved when an ERP has been saved in Planned management state.
While creating the ERP instance in ESM, the details of the following entities will also be saved in ESM database:
The ERP instance itself.
The topology selected by user, either otn links or LAG links
The service endpoints selected by user.
ERP OAM details including Maintenance Domain(MD), Maintenance Association(MA) and Maintenance End Points(MEP)
The CLI commands given by user in Pre/Post CLI fields
Creating an ERP in planned state is not a scheduled operation. Once the ERP is created in Planned state in ESM, it can be seen/operated on from the Operate-> ERP list.
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Erp Data | nERPInstHolderMapper |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ERPDataRespHolder
|
201Created | --- |
401Unauthorized | --- |
500Internal server error |
Void
|
403Forbidden | --- |
404ERP creation failed. |
Void
|
Consumes
application/xml
Example Request Data
<ERPInstHolder> <req> <ringName>REST-ERP-SERV-1</ringName> <Author>REST</Author> <ringType>Major Ring</ringType> <subRingConfig/> <parentRingIds/> <propogateTopoChange/> <sharedVpls>1</sharedVpls> <ringDescription>REST Description</ringDescription> <reserveResource>0</reserveResource> <cvlanId>615</cvlanId> <svlanId>616</svlanId> <linkType>PORT</linkType> <ownerTPID>3</ownerTPID> <ownerTPName>11QCE12X-2-7-X2</ownerTPName> <neighbourTPID>1565</neighbourTPID> <neighbourName>11QPE24-1-10-X1</neighbourName> <neDataList> <nNEData> <portRole/> <ringNodeHandle>0</ringNodeHandle> <ringNode>NODE-O</ringNode> <ringPortHandle>0</ringPortHandle> <ringPort>11OPE8-1-10-X1</ringPort> <ringLinkHandle>17</ringLinkHandle> <ringLink>NODE-O/11OPE8-1-10-X1-1 NODE-K/11QCE12X-2-7-X1-1 DSR</ringLink> <farEndNodeHandle>0</farEndNodeHandle> <farEndNode>NODE-K</farEndNode> <farEndPortHandle>0</farEndPortHandle> <farEndPort>11QCE12X-2-7-X1</farEndPort> </nNEData> <nNEData> <portRole/> <ringNodeHandle>0</ringNodeHandle> <ringNode>NODE-O</ringNode> <ringPortHandle>0</ringPortHandle> <ringPort>11OPE8-1-11-X1</ringPort> <ringLinkHandle>39</ringLinkHandle> <ringLink>NODE-N/11QPE24-1-10-X2-NODE-O/11OPE8-1-11-X1</ringLink> <farEndNodeHandle>0</farEndNodeHandle> <farEndNode>NODE-N</farEndNode> <farEndPortHandle>0</farEndPortHandle> <farEndPort>11QPE24-1-10-X2</farEndPort> </nNEData> <nNEData> <portRole/> <ringNodeHandle>0</ringNodeHandle> <ringNode>NODE-O</ringNode> <ringPortHandle>0</ringPortHandle> <ringPort>11OPE8-1-10-M1</ringPort> <ringLinkHandle>8</ringLinkHandle> <ringLink>NODE-O/11OPE8-1-10-M1/11OPE8-1-11-M1/OS</ringLink> <farEndNodeHandle>0</farEndNodeHandle> <farEndNode>NODE-O</farEndNode> <farEndPortHandle>0</farEndPortHandle> <farEndPort>11OPE8-1-11-M1</farEndPort> </nNEData> <nNEData> <portRole>owner</portRole> <ringNodeHandle>0</ringNodeHandle> <ringNode>NODE-K</ringNode> <ringPortHandle>0</ringPortHandle> <ringPort>11QCE12X-2-7-X2</ringPort> <ringLinkHandle>57</ringLinkHandle> <ringLink>NODE-K/11QCE12X-2-7-X2-1 NODE-N/11QPE24-1-10-X1-1 DSR</ringLink> <farEndNodeHandle>0</farEndNodeHandle> <farEndNode>NODE-N</farEndNode> <farEndPortHandle>0</farEndPortHandle> <farEndPort>11QPE24-1-10-X1</farEndPort> </nNEData> </neDataList> <protectiondata> <guardtime>5</guardtime> <revertTime>300</revertTime> <revertive>true</revertive> <protectionSwitchState>on</protectionSwitchState> <templateId>1</templateId> </protectiondata> <managementState>New</managementState> <targetMgmtState>Planned</targetMgmtState> <preProvCliCmd/> <postProvCliCmd/> </req> <reqId> <clientName>dojoclient</clientName> <reqId>123</reqId> </reqId> <oam> <templateName/> <mdLevel>0</mdLevel> <mdFormat>NONE</mdFormat> <maInst> <ccmInterval>3.3ms</ccmInterval> <maFormat>ITU-ICC</maFormat> <maName>SERVMA0045</maName> <mep> <active>true</active> <controlMepEnabled>true</controlMepEnabled> <interfaceType>Ring Path</interfaceType> <lowestPriorityDeffect>All Defects</lowestPriorityDeffect> <upDirectionally>false</upDirectionally> <ccm> <ccmEnabled>true</ccmEnabled> <priority>7</priority> </ccm> <ais> <aisEnabled>false</aisEnabled> <interval>60</interval> <priority>7</priority> <aisLevels/> </ais> </mep> </maInst> </oam> </ERPInstHolder>
Produces
application/xml
Example Response Data
<ERPDataRespHolder> <resp> <ringName>REST-ERP-SERV-1</ringName> <ringType>Major Ring</ringType> <Author>REST</Author> <ringDescription>REST Description</ringDescription> <reserveResource>false</reserveResource> <cvlanId>615</cvlanId> <svlanId>616</svlanId> <ownerTPID>3</ownerTPID> <ownerTPName>11QCE12X-2-7-X2</ownerTPName> <neighbourTPID>1565</neighbourTPID> <neighbourName>11QPE24-1-10-X1</neighbourName> <managementState>New</managementState> <targetMgmtState>Planned</targetMgmtState> <neDataList> <nNEData> <farEndNode>NODE-K</farEndNode> <farEndNodeHandle>0</farEndNodeHandle> <farEndNodeVSID>0</farEndNodeVSID> <farEndPort>11QCE12X-2-7-X1</farEndPort> <farEndPortHandle>0</farEndPortHandle> <linkState>0</linkState> <neighbour>0</neighbour> <owner>0</owner> <portRole/> <ringId>0</ringId> <ringLink>NODE-O/11OPE8-1-10-X1-1 NODE-K/11QCE12X-2-7-X1-1 DSR</ringLink> <ringLinkHandle>17</ringLinkHandle> <ringNode>NODE-O</ringNode> <ringNodeHandle>0</ringNodeHandle> <ringNodeVSID>0</ringNodeVSID> <ringPort>11OPE8-1-10-X1</ringPort> <ringPortHandle>0</ringPortHandle> </nNEData> <nNEData> <farEndNode>NODE-N</farEndNode> <farEndNodeHandle>0</farEndNodeHandle> <farEndNodeVSID>0</farEndNodeVSID> <farEndPort>11QPE24-1-10-X2</farEndPort> <farEndPortHandle>0</farEndPortHandle> <linkState>0</linkState> <neighbour>0</neighbour> <owner>0</owner> <portRole/> <ringId>0</ringId> <ringLink>NODE-N/11QPE24-1-10-X2-NODE-O/11OPE8-1-11-X1</ringLink> <ringLinkHandle>39</ringLinkHandle> <ringNode>NODE-O</ringNode> <ringNodeHandle>0</ringNodeHandle> <ringNodeVSID>0</ringNodeVSID> <ringPort>11OPE8-1-11-X1</ringPort> <ringPortHandle>0</ringPortHandle> </nNEData> <nNEData> <farEndNode>NODE-O</farEndNode> <farEndNodeHandle>0</farEndNodeHandle> <farEndNodeVSID>0</farEndNodeVSID> <farEndPort>11OPE8-1-11-M1</farEndPort> <farEndPortHandle>0</farEndPortHandle> <linkState>0</linkState> <neighbour>0</neighbour> <owner>0</owner> <portRole/> <ringId>0</ringId> <ringLink>NODE-O/11OPE8-1-10-M1/11OPE8-1-11-M1/OS</ringLink> <ringLinkHandle>8</ringLinkHandle> <ringNode>NODE-O</ringNode> <ringNodeHandle>0</ringNodeHandle> <ringNodeVSID>0</ringNodeVSID> <ringPort>11OPE8-1-10-M1</ringPort> <ringPortHandle>0</ringPortHandle> </nNEData> <nNEData> <farEndNode>NODE-N</farEndNode> <farEndNodeHandle>0</farEndNodeHandle> <farEndNodeVSID>0</farEndNodeVSID> <farEndPort>11QPE24-1-10-X1</farEndPort> <farEndPortHandle>0</farEndPortHandle> <linkState>0</linkState> <neighbour>0</neighbour> <owner>0</owner> <portRole>owner</portRole> <ringId>0</ringId> <ringLink>NODE-K/11QCE12X-2-7-X2-1 NODE-N/11QPE24-1-10-X1-1 DSR</ringLink> <ringLinkHandle>57</ringLinkHandle> <ringNode>NODE-K</ringNode> <ringNodeHandle>0</ringNodeHandle> <ringNodeVSID>0</ringNodeVSID> <ringPort>11QCE12X-2-7-X2</ringPort> <ringPortHandle>0</ringPortHandle> </nNEData> </neDataList> <protectiondata> <guardtime>5</guardtime> <protectionSwitchState>on</protectionSwitchState> <revertTime>300</revertTime> <revertive>true</revertive> <templateId>1</templateId> </protectiondata> <templateId>0</templateId> <subRingConfig/> <parentRingIds/> <propogateTopoChange/> <preProvCliCmd/> <postProvCliCmd/> <jobTaskId>0</jobTaskId> <mdIndex>0</mdIndex> <maIndex>0</maIndex> <linkType>PORT</linkType> </resp> <response> <cmdStatus>Success</cmdStatus> <msgCode>ERP_SUCCESS_0001</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>REST-ERP-SERV-1</parameters> <req> <clientName>dojoclient</clientName> <reqId>123</reqId> <selectiveSyncViaPolling>false</selectiveSyncViaPolling> </req> </response> </ERPDataRespHolder>
External Docs
Operation
post /esmService/topoService/schedDeployERP
State transition :
New -> Planned
Planned -> Allocated
Allocated -> Commissioned/Deploy-Failed
This operation will first save the ERP instance in planned state in ESM and then to Allocated state.This is a scheduled operation in ESM. User can choose to deploy an ERP for a future time or deploy it right away. The ERP will be deployed from Allocated state at the scheduled time.
During this operation ESM performs the validation done in planERP and allocateERP and few more validation. It Persists all the elementary entities required(direct mapping with entities on the NE) in ESM database and when the commands are being created and deployed, ERP will be moved to a transient management state Deploying. It also generates the commands to be deployed on the NE(will be logged in ESM job list).
The entities that wil be created/updated on the NE during a ERP deployment are (in order):
PRE CLI commands(if provided)
Ring and Path creation
Control service configuration (VPLS and SAP creation and activation)
OAM entity creation :
MD(If the selected MD level is not already deployed on the NE)
MA
MEP creation and activation
Remote MEP configuration
Activating the ring path
POST CLI commands(if provided)
All the commands executed and their status along with error reason if failed, will be logged in ESM job list.
If all the commands created are successful(all entities are successfully created on the NE), ESM will mark the ERP in Commissioned management state.
If any of the commands are failed(except POST CLI which are best effort commands), ESM will mark the ERP in Deploy-Failed management state.
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Erp Data | nERPInstHolderMapper |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ERPDataRespHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<ERPInstHolder> <req> <ringName>REST-CVLAN-SVLAN-ERP2</ringName> <Author>REST</Author> <ringType>Major Ring</ringType> <subRingConfig/> <parentRingIds/> <propogateTopoChange>false</propogateTopoChange> <sharedVpls>1</sharedVpls> <ringDescription>REST Description</ringDescription> <reserveResource>1</reserveResource> <cvlanId>2024</cvlanId> <svlanId>2025</svlanId> <linkType>PORT</linkType> <ownerTPID>2085</ownerTPID> <ownerTPName>11OPE8-1-10-X2</ownerTPName> <neighbourTPID>504</neighbourTPID> <neighbourName>11QPE24-2-7-X3</neighbourName> <neDataList> <nNEData> <portRole>owner</portRole> <ringNodeHandle>0</ringNodeHandle> <ringNode>NODE-O</ringNode> <ringPortHandle>0</ringPortHandle> <ringPort>11OPE8-1-10-X2</ringPort> <ringLinkHandle>20</ringLinkHandle> <ringLink>NODE-L/11QPE24-2-7-X3-NODE-O/11OPE8-1-10-X2</ringLink> <farEndNodeHandle>0</farEndNodeHandle> <farEndNode>NODE-L</farEndNode> <farEndPortHandle>0</farEndPortHandle> <farEndPort>11QPE24-2-7-X3</farEndPort> </nNEData> <nNEData> <portRole/> <ringNodeHandle>0</ringNodeHandle> <ringNode>NODE-L</ringNode> <ringPortHandle>0</ringPortHandle> <ringPort>11QPE24-2-7-X1</ringPort> <ringLinkHandle>58</ringLinkHandle> <ringLink>NODE-L/11QPE24-2-7-X1-1 NODE-M/11QCE12X-1-10-X4-1 DSR</ringLink> <farEndNodeHandle>0</farEndNodeHandle> <farEndNode>NODE-M</farEndNode> <farEndPortHandle>0</farEndPortHandle> <farEndPort>11QCE12X-1-10-X4</farEndPort> </nNEData> <nNEData> <portRole/> <ringNodeHandle>0</ringNodeHandle> <ringNode>NODE-O</ringNode> <ringPortHandle>0</ringPortHandle> <ringPort>11OPE8-1-11-X2</ringPort> <ringLinkHandle>26</ringLinkHandle> <ringLink>NODE-O/11OPE8-1-11-X2-1 NODE-M/11QCE12X-1-10-X1-1 DSR</ringLink> <farEndNodeHandle>0</farEndNodeHandle> <farEndNode>NODE-M</farEndNode> <farEndPortHandle>0</farEndPortHandle> <farEndPort>11QCE12X-1-10-X1</farEndPort> </nNEData> <nNEData> <portRole/> <ringNodeHandle>0</ringNodeHandle> <ringNode>NODE-O</ringNode> <ringPortHandle>0</ringPortHandle> <ringPort>11OPE8-1-10-M2</ringPort> <ringLinkHandle>9</ringLinkHandle> <ringLink>NODE-O/11OPE8-1-10-M2/11OPE8-1-11-M2/OS</ringLink> <farEndNodeHandle>0</farEndNodeHandle> <farEndNode>NODE-O</farEndNode> <farEndPortHandle>0</farEndPortHandle> <farEndPort>11OPE8-1-11-M2</farEndPort> </nNEData> </neDataList> <protectiondata> <guardtime>6</guardtime> <revertTime>205</revertTime> <revertive>true</revertive> <protectionSwitchState>on</protectionSwitchState> <templateId>1</templateId> <holdUpTime>450</holdUpTime> <holdDownTime>650</holdDownTime> <holdTimeType>centiseconds</holdTimeType> </protectiondata> <managementState>New</managementState> <targetMgmtState>Deploying</targetMgmtState> <preProvCliCmd/> <postProvCliCmd/> </req> <reqId> <clientName>dojoclient</clientName> <reqId>123</reqId> </reqId> <scheduler> <jobName>REST-CVLAN-SVLAN-ERP2_1449242295876</jobName> <jobDescription>AUTO</jobDescription> <username/> <trigger> <triggerName>REST-CVLAN-SVLAN-ERP2_1449242295876Trigger</triggerName> <deployNow>Yes</deployNow> <triggerType/> <triggerExpression/> <triggerTimeOffset/> </trigger> </scheduler> <oam> <templateName/> <mdLevel>2</mdLevel> <mdFormat>NONE</mdFormat> <maInst> <ccmInterval>3.3ms</ccmInterval> <maFormat>ITU-ICC</maFormat> <maName>RE23ERPC12</maName> <mep> <active>true</active> <controlMepEnabled>true</controlMepEnabled> <interfaceType>Ring Path</interfaceType> <lowestPriorityDeffect>MAC, Remote, Error, Xcon</lowestPriorityDeffect> <upDirectionally>false</upDirectionally> <ccm> <ccmEnabled>true</ccmEnabled> <priority>7</priority> </ccm> <ais> <aisEnabled>false</aisEnabled> <interval>60</interval> <priority>7</priority> <aisLevels/> </ais> </mep> </maInst> </oam> </ERPInstHolder>
Produces
application/xml
Example Response Data
<ERPDataRespHolder> <resp> <ringName>REST-CVLAN-SVLAN-ERP2</ringName> <ringType>Major Ring</ringType> <Author>REST</Author> <ringDescription>REST Description</ringDescription> <reserveResource>true</reserveResource> <cvlanId>2024</cvlanId> <svlanId>2025</svlanId> <ownerTPID>2085</ownerTPID> <ownerTPName>11OPE8-1-10-X2</ownerTPName> <neighbourTPID>504</neighbourTPID> <neighbourName>11QPE24-2-7-X3</neighbourName> <managementState>New</managementState> <targetMgmtState>Deploying</targetMgmtState> <neDataList> <nNEData> <farEndNode>NODE-L</farEndNode> <farEndNodeHandle>0</farEndNodeHandle> <farEndNodeVSID>0</farEndNodeVSID> <farEndPort>11QPE24-2-7-X3</farEndPort> <farEndPortHandle>0</farEndPortHandle> <linkState>0</linkState> <neighbour>0</neighbour> <owner>0</owner> <portRole>owner</portRole> <ringId>0</ringId> <ringLink>NODE-L/11QPE24-2-7-X3-NODE-O/11OPE8-1-10-X2</ringLink> <ringLinkHandle>20</ringLinkHandle> <ringNode>NODE-O</ringNode> <ringNodeHandle>0</ringNodeHandle> <ringNodeVSID>0</ringNodeVSID> <ringPort>11OPE8-1-10-X2</ringPort> <ringPortHandle>0</ringPortHandle> </nNEData> <nNEData> <farEndNode>NODE-M</farEndNode> <farEndNodeHandle>0</farEndNodeHandle> <farEndNodeVSID>0</farEndNodeVSID> <farEndPort>11QCE12X-1-10-X4</farEndPort> <farEndPortHandle>0</farEndPortHandle> <linkState>0</linkState> <neighbour>0</neighbour> <owner>0</owner> <portRole/> <ringId>0</ringId> <ringLink>NODE-L/11QPE24-2-7-X1-1 NODE-M/11QCE12X-1-10-X4-1 DSR</ringLink> <ringLinkHandle>58</ringLinkHandle> <ringNode>NODE-L</ringNode> <ringNodeHandle>0</ringNodeHandle> <ringNodeVSID>0</ringNodeVSID> <ringPort>11QPE24-2-7-X1</ringPort> <ringPortHandle>0</ringPortHandle> </nNEData> <nNEData> <farEndNode>NODE-M</farEndNode> <farEndNodeHandle>0</farEndNodeHandle> <farEndNodeVSID>0</farEndNodeVSID> <farEndPort>11QCE12X-1-10-X1</farEndPort> <farEndPortHandle>0</farEndPortHandle> <linkState>0</linkState> <neighbour>0</neighbour> <owner>0</owner> <portRole/> <ringId>0</ringId> <ringLink>NODE-O/11OPE8-1-11-X2-1 NODE-M/11QCE12X-1-10-X1-1 DSR</ringLink> <ringLinkHandle>26</ringLinkHandle> <ringNode>NODE-O</ringNode> <ringNodeHandle>0</ringNodeHandle> <ringNodeVSID>0</ringNodeVSID> <ringPort>11OPE8-1-11-X2</ringPort> <ringPortHandle>0</ringPortHandle> </nNEData> <nNEData> <farEndNode>NODE-O</farEndNode> <farEndNodeHandle>0</farEndNodeHandle> <farEndNodeVSID>0</farEndNodeVSID> <farEndPort>11OPE8-1-11-M2</farEndPort> <farEndPortHandle>0</farEndPortHandle> <linkState>0</linkState> <neighbour>0</neighbour> <owner>0</owner> <portRole/> <ringId>0</ringId> <ringLink>NODE-O/11OPE8-1-10-M2/11OPE8-1-11-M2/OS</ringLink> <ringLinkHandle>9</ringLinkHandle> <ringNode>NODE-O</ringNode> <ringNodeHandle>0</ringNodeHandle> <ringNodeVSID>0</ringNodeVSID> <ringPort>11OPE8-1-10-M2</ringPort> <ringPortHandle>0</ringPortHandle> </nNEData> </neDataList> <protectiondata> <guardtime>6</guardtime> <protectionSwitchState>on</protectionSwitchState> <revertTime>205</revertTime> <revertive>true</revertive> <templateId>1</templateId> </protectiondata> <templateId>0</templateId> <subRingConfig/> <parentRingIds/> <propogateTopoChange>false</propogateTopoChange> <preProvCliCmd/> <postProvCliCmd/> <jobTaskId>0</jobTaskId> <mdIndex>0</mdIndex> <maIndex>0</maIndex> <linkType>PORT</linkType> </resp> <response> <cmdStatus>Success</cmdStatus> <msgCode>ERP_SUCCESS_0011</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>REST-CVLAN-SVLAN-ERP2</parameters> </response> </ERPDataRespHolder>
External Docs
Operation
post /esmService/topoService/activateERP
It can be performed on Commissioned ERP with Service state "Out of service" only and is an operation which impacts traffic flow.
State transition :
Commissioned (Service state : Out of Service) -> Commissioned(Service state : In Service)
This is a scheduled operation in ESM. User can choose to activate an ERP for a future time or activate it right away.
Creates the commands and sends the commands to NE(SNA) to mark the admin state of the entities as Up.
The commands will be sent for the following entities to bring up the admin state in the following order :
ERP
Path A, Path B
Control service VPLS
Control service SAP
MEP( MEP active parameter is enabled)
If all the commands are successful, The service-state of the corresponding ERP instance will be marked as In Service, and the ERP will remain in Commissioned management state.
If there is any failure, user can refer to the corresponding job details, for the failure reason and the entity on which there is failure.
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Erp Data | nERPIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ERPIdResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<ERPIdHolder> <req> <managementState>Commissioned</managementState> <ringAdminState/> <ringId>46</ringId> <ringName>REST-ERP-SERV-1</ringName> <ringType/> <createTime/> <description/> <preProvCliCmd/> <postProvCliCmd/> </req> <reqId> <clientName/> <reqId>123</reqId> <respBeanRef/> </reqId> <scheduler> <jobName>REST-ERP-SERV-1_1449236720995</jobName> <jobDescription>REST Description</jobDescription> <username/> <trigger> <name>REST-ERP-SERV-1_1449236720995Trigger</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </ERPIdHolder>
Produces
application/xml
Example Response Data
<ERPIdResponse> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>ERP_SUCCESS_0015</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>REST-ERP-SERV-1</parameters> </responseId> </ERPIdResponse>
External Docs
Operation
post /esmService/topoService/deactivateERP
It can be performed on Commissioned ERP with Service state "In Service" only and is an operation which impacts traffic flow.
State transition :
Commissioned (Service state : In Service) -> Commissioned(Service state : Out of Service)
This is a scheduled operation in ESM. User can choose to deactivate an ERP for a future time or deactivate it right away.
Creates the commands and sends the commands to NE(SNA) to mark the admin state of the entities as Down.
The commands will be sent for the following entities to bring down the admin state in the order :
ERP
Path A, Path B
Control service VPLS
Control service SAP
MEP( MEP active parameter is disabled)
If all the commands are successful, The service-state of the corresponding ERP instance will be marked as Out Of Service, and the ERP will remain in Commissioned management state.
If there is any failure, user can refer to the corresponding job details, for the failure reason and the entity on which there is failure.
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Erp Data | nERPIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ERPIdResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<ERPIdHolder> <req> <managementState>Commissioned</managementState> <ringAdminState/> <ringId>40</ringId> <ringName>REST-ERP-03</ringName> <ringType/> <createTime/> <description/> <preProvCliCmd/> <postProvCliCmd/> </req> <reqId> <clientName/> <reqId>123</reqId> <respBeanRef/> </reqId> <scheduler> <jobName>REST-ERP-03_1449234872571</jobName> <jobDescription>REST Description</jobDescription> <username/> <trigger> <name>REST-ERP-03_1449234872571Trigger</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </ERPIdHolder>
Produces
application/xml
Example Response Data
<ERPIdResponse> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>ERP_SUCCESS_0016</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>REST-ERP-03</parameters> </responseId> </ERPIdResponse>
External Docs
Operation
post /esmService/topoService/switchERP
This can be used to perform switch operation for a ring or sub ring where Management state of the ERP is in Commissioned state and service state
is either In service or Out of Service state.
'
Set Blocked or Force Blocked switch options can be selected.
Once a set Blocked or Force Blocked are applied on a given ring, Clear operation has to be run on this ERP before applying a next switch. This is a scheduled operation in ESM. User can choose to switch for a future time or do it right away.
State transition :
Commissioned -> Commissioned
If the switch operation fails, clear operation has to be applied on the ERP to attempt for a next switch.
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Erp Data | nERPInstHolderMapper |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ERPIdResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<ERPInstHolder> <req> <ringName>REST-ERP-SERV-1</ringName> <Author>REST</Author> <ringType>Major Ring</ringType> <subRingConfig/> <parentRingIds/> <propogateTopoChange/> <ringDescription>REST Description</ringDescription> <reserveResource>0</reserveResource> <cvlanId>615</cvlanId> <svlanId>616</svlanId> <linkType>PORT</linkType> <ownerTPID>3</ownerTPID> <ownerTPName>11QCE12X-2-7-X2</ownerTPName> <neighbourTPID>1565</neighbourTPID> <neighbourName>11QPE24-1-10-X1</neighbourName> <neDataList> <nNEData> <portRole/> <ringNodeHandle>0</ringNodeHandle> <ringNode>NODE-O</ringNode> <ringPortHandle>0</ringPortHandle> <ringPort>11OPE8-1-10-X1</ringPort> <ringLinkHandle>17</ringLinkHandle> <ringLink>NODE-O/11OPE8-1-10-X1-1 NODE-K/11QCE12X-2-7-X1-1 DSR</ringLink> <farEndNodeHandle>0</farEndNodeHandle> <farEndNode>NODE-K</farEndNode> <farEndPortHandle>0</farEndPortHandle> <farEndPort>11QCE12X-2-7-X1</farEndPort> </nNEData> <nNEData> <portRole/> <ringNodeHandle>0</ringNodeHandle> <ringNode>NODE-O</ringNode> <ringPortHandle>0</ringPortHandle> <ringPort>11OPE8-1-11-X1</ringPort> <ringLinkHandle>39</ringLinkHandle> <ringLink>NODE-N/11QPE24-1-10-X2-NODE-O/11OPE8-1-11-X1</ringLink> <farEndNodeHandle>0</farEndNodeHandle> <farEndNode>NODE-N</farEndNode> <farEndPortHandle>0</farEndPortHandle> <farEndPort>11QPE24-1-10-X2</farEndPort> </nNEData> <nNEData> <portRole/> <ringNodeHandle>0</ringNodeHandle> <ringNode>NODE-O</ringNode> <ringPortHandle>0</ringPortHandle> <ringPort>11OPE8-1-10-M1</ringPort> <ringLinkHandle>8</ringLinkHandle> <ringLink>NODE-O/11OPE8-1-10-M1/11OPE8-1-11-M1/OS</ringLink> <farEndNodeHandle>0</farEndNodeHandle> <farEndNode>NODE-O</farEndNode> <farEndPortHandle>0</farEndPortHandle> <farEndPort>11OPE8-1-11-M1</farEndPort> </nNEData> <nNEData> <portRole>owner</portRole> <ringNodeHandle>0</ringNodeHandle> <ringNode>NODE-K</ringNode> <ringPortHandle>0</ringPortHandle> <ringPort>11QCE12X-2-7-X2</ringPort> <ringLinkHandle>57</ringLinkHandle> <ringLink>NODE-K/11QCE12X-2-7-X2-1 NODE-N/11QPE24-1-10-X1-1 DSR</ringLink> <farEndNodeHandle>0</farEndNodeHandle> <farEndNode>NODE-N</farEndNode> <farEndPortHandle>0</farEndPortHandle> <farEndPort>11QPE24-1-10-X1</farEndPort> </nNEData> </neDataList> <protectiondata> <guardtime>5</guardtime> <revertTime>300</revertTime> <revertive>true</revertive> <protectionSwitchState>on</protectionSwitchState> <templateId>1</templateId> </protectiondata> <managementState>New</managementState> <targetMgmtState>Planned</targetMgmtState> <preProvCliCmd/> <postProvCliCmd/> </req> <reqId> <clientName>dojoclient</clientName> <reqId>123</reqId> </reqId> <oam> <templateName/> <mdLevel>0</mdLevel> <mdFormat>NONE</mdFormat> <maInst> <ccmInterval>3.3ms</ccmInterval> <maFormat>ITU-ICC</maFormat> <maName>SERVMA0045</maName> <mep> <active>true</active> <controlMepEnabled>true</controlMepEnabled> <interfaceType>Ring Path</interfaceType> <lowestPriorityDeffect>All Defects</lowestPriorityDeffect> <upDirectionally>false</upDirectionally> <ccm> <ccmEnabled>true</ccmEnabled> <priority>7</priority> </ccm> <ais> <aisEnabled>false</aisEnabled> <interval>60</interval> <priority>7</priority> <aisLevels/> </ais> </mep> </maInst> </oam> </ERPInstHolder>
Produces
application/xml
Example Response Data
<ERPIdResponse> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>ERP_SUCCESS_0023</msgCode> <opMsg/> <paramCount>1</paramCount> <parameters>AUTOCVLAN-ERP-2</parameters> <req> <clientName>dojoclient</clientName> <reqId>123</reqId> <selectiveSyncViaPolling>false</selectiveSyncViaPolling> </req> </responseId> <req> <createTime>0</createTime> <description>REST-Description</description> <jobTaskId>0</jobTaskId> <ringId>0</ringId> <ringName>AUTOCVLAN-ERP-2</ringName> </req> </ERPIdResponse>
External Docs
Operation
post /esmService/topoService/unlockERP
It is enabled for the ERPs that are already locked irrespective of the ERP management or service state.When the Unlock icon is selected, the links can be db deleted from OTN.
To DB delete the OTN physical link, all the ERP instances that are configured on it must be unlocked one after another.
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Erp Data | nERPInstHolderMapper |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ERPIdResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
<ERPInstHolder> <req> <ringName>REST-ERP-SERV-1</ringName> <ringType/> <managementState>Commissioned</managementState> <targetMgmtState>Commissioned</targetMgmtState> </req> <reqId> <clientName/> <reqId>5</reqId> </reqId> </ERPInstHolder>
Produces
application/xml
Example Response Data
<ERPIdResponse> <responseId> <cmdStatus>Success</cmdStatus> <msgCode>ERP_SUCCESS_0021</msgCode> <opMsg/> <paramCount>2</paramCount> <parameters>REST-ERP-SERV-1</parameters> <parameters>1.REST-ERP-1 </parameters> <req> <clientName/> <reqId>5</reqId> <selectiveSyncViaPolling>false</selectiveSyncViaPolling> </req> </responseId> </ERPIdResponse>
External Docs
Entry«string,ArrayList«int»»
Name |
Type |
Description |
Enum |
---|---|---|---|
key | array[Integer] integer |
--- | --- |
ERP Mapper
Name |
Type |
Description |
Enum |
---|---|---|---|
ringName | String string |
RingName | --- |
ringOldName | String string |
ringOldName | --- |
ringType | String string |
ringType | [Ring, Sub-Ring] |
author | String string |
author | --- |
ringDescription | String string |
ringDescription | --- |
reserveResource | Boolean boolean |
reserveResource | --- |
cvlanId | String string |
cvlanId | --- |
svlanId | String string |
svlanId | --- |
ownerTPID | Integer integer |
ownerTPID | --- |
ownerTPName | String string |
ownerTPID | --- |
ownerNeName | String string |
ownerNeName | --- |
neighbourTPID | Integer integer |
ownerTPID | --- |
neighbourName | String string |
ownerTPID | --- |
managementState | String string |
managementState | [Plan, Allocate, Commissioned, Deploy, Failed] |
targetMgmtState | String string |
targetMgmtState | [Plan, Allocate, Commissioned, Deploy, Failed] |
cfmData | Object object |
cfmData | --- |
additionalInfo | Object object |
additionalInfo | --- |
sharedVpls | Integer integer |
SharedVpls | --- |
erpRingId | Long long |
--- | --- |
neDataList | array[NeData] NeData |
neDataList | --- |
protectiondata | ProtectionParams ProtectionParams |
protectiondata | --- |
templateId | Integer integer |
templateId | --- |
subRingConfig | String string |
subRingConfig | [VC, NON-VC ] |
parentRingIds | String string |
parentRingIds | --- |
propogateTopoChange | String string |
propogateTopoChange | [true, false] |
preProvCliCmd | String string |
preProvCliCmd | --- |
postProvCliCmd | String string |
postProvCliCmd | --- |
jobTaskId | Long long |
jobTaskId | --- |
maName | String string |
maName | --- |
mdIndex | Long long |
mdIndex | --- |
maIndex | Long long |
MA index | --- |
linkType | String string |
linkType | --- |
transVsList | array[TransVsData] TransVsData |
transVsList | --- |
transparentVsIdS | array[Integer] integer |
transVsList | --- |
vneScriptDataList | array[VNEScriptData] VNEScriptData |
--- | --- |
ERPDataRespHolder
Name |
Type |
Description |
Enum |
---|---|---|---|
resp | ERP Mapper ERP Mapper |
resp | --- |
oam | EsmOAMDataModel EsmOAMDataModel |
oam | --- |
response | Response Header Model Response Header Model |
response | --- |
schedReqMapper | ESMSchedulerDataModel ESMSchedulerDataModel |
schedReqMapper | --- |
ERPIdResponse
Name |
Type |
Description |
Enum |
---|---|---|---|
responseId | Response Header Model Response Header Model |
responseId | --- |
req | nERPId nERPId |
erpIdRespHolder | --- |
schedReqMapper | ESMSchedulerDataModel ESMSchedulerDataModel |
schedReqMapper | --- |
EsmOAMDataModel
Name |
Type |
Description |
Enum |
---|---|---|---|
templateName | String string |
OAM template name | --- |
mdLevel | Integer integer |
OAM maintenance domain level | [0, 1, 2, 3, 4, 5, 6, 7] |
mdFormat | String string |
OAM maintenance domain format | [NONE] |
maInst | EsmOamMADataModel EsmOamMADataModel |
OAM maintenance association wrapper | --- |
elementaryMepList | array[ElementaryMep] ElementaryMep |
OAM maintenance end point wrapper | --- |
EsmOamMADataModel
Name |
Type |
Description |
Enum |
---|---|---|---|
remoteMepInstList | array[eOAMRemoteMepInst] eOAMRemoteMepInst |
--- | --- |
maName | String string |
MA name | --- |
maFormat | String string |
MA format | [ITU-ICC] |
ccmInterval | String string |
CCM interval for the MA | --- |
mhfCreation | String string |
MHF Creation to be supported | --- |
mep | EsmOamMEPDataModel EsmOamMEPDataModel |
OAM maintenance end point wrapper | --- |
remteMepList | array[eOAMRemoteMepInst] eOAMRemoteMepInst |
--- | --- |
EsmOamMEPDataModel
Name |
Type |
Description |
Enum |
---|---|---|---|
upDirectionally | Boolean boolean |
MEP direction | --- |
interfaceType | String string |
MEP Interface type | [SAP, PATH] |
active | Boolean boolean |
MEP Active | --- |
controlMepEnabled | Boolean boolean |
Control MEP enabled | --- |
lowestPriorityDeffect | 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'] |
propagateHoldTime | Integer integer |
ESM OAM MEP propagate hold down time | --- |
standbyMepShutdownEnabled | Boolean boolean |
ESM OAM MEP Standby MEP enabled | --- |
ccm | EsmOamMEPCCMDataModel EsmOamMEPCCMDataModel |
ESM OAM model wrapper for CCM attributes on MEP | --- |
ais | EsmOamMEPAISDataModel EsmOamMEPAISDataModel |
ESM OAM model wrapper for AIS attributes on MEP | --- |
ESMSchedulerDataModel
Name |
Type |
Description |
Enum |
---|---|---|---|
jobName | String string |
Job Name | --- |
jobDescription | String string |
Job description | --- |
trigger | ESMSchedulerTriggerDataModel ESMSchedulerTriggerDataModel |
Job Trigger data model | --- |
username | String string |
User name | --- |
N_MA_Data
Name |
Type |
Description |
Enum |
---|---|---|---|
maId | Long long |
--- | --- |
format | String string |
--- | --- |
maName | String string |
--- | --- |
ccmInterval | Integer integer |
--- | --- |
mhfCreation | String string |
--- | --- |
mepData | N_MEP_Data N_MEP_Data |
--- | --- |
remoteMepDataList | array[E_OAM_RemoteMepData] E_OAM_RemoteMepData |
--- | --- |
manameTpId | array[Entry«string,ArrayList«int»»] Entry«string,ArrayList«int»» |
--- | --- |
N_MD_Data
Name |
Type |
Description |
Enum |
---|---|---|---|
mdId | Long long |
--- | --- |
mdFormat | String string |
--- | --- |
mdLevel | Integer integer |
--- | --- |
maData | N_MA_Data N_MA_Data |
--- | --- |
type | String string |
--- | [SERVICE, ERP, QOS, ERP_TEMPLATE, SERVICE_TEMPLATE, INVALID, LAG, MCLAG, MPLSTP_NPA_TEMPLATE, MPLSTP_NPA, MPLSTP_TUNNEL, MPLSTP_TUNNEL_TEMPLATE, MPLSTP_NPA_PACK, MPLSTP_CHANNEL, PACKET_SWITCH_TEMPLATE, PACKET_SWITCH, DEMARCATION, ETH_IBM_ERP, ELINE] |
vsIdList | array[Integer] integer |
--- | --- |
modifyReq | Boolean boolean |
--- | --- |
N_MEP_CCM_Data
Name |
Type |
Description |
Enum |
---|
N_MEP_Data
Name |
Type |
Description |
Enum |
---|---|---|---|
upDirectionally | Boolean boolean |
--- | --- |
interfaceType | Integer integer |
--- | --- |
active | Boolean boolean |
--- | --- |
controlMepEnabled | Boolean boolean |
--- | --- |
lowestPriorityDeffect | Integer integer |
--- | --- |
ccmEnable | Boolean boolean |
--- | --- |
ccmPriority | Integer integer |
--- | --- |
mepId | Long long |
--- | --- |
aisData | N_MEP_AIS_Data N_MEP_AIS_Data |
--- | --- |
ccmData | N_MEP_CCM_Data N_MEP_CCM_Data |
--- | --- |
propagateHoldTime | Integer integer |
--- | --- |
standbyMepShutdownEnabled | Boolean boolean |
--- | --- |
NeData
Name |
Type |
Description |
Enum |
---|---|---|---|
ringId | Long long |
ringId | --- |
ringName | String string |
ringName | --- |
ringType | String string |
ringType | [Ring, Sub-Ring] |
owner | Integer integer |
owner | --- |
neighbour | Integer integer |
neighbour | --- |
portRole | String string |
portRole | --- |
ringNodeHandle | Integer integer |
ringNodeHandle | --- |
ringNode | String string |
ringNode | --- |
ringPortHandle | Integer integer |
ringPortHandle | --- |
ringPort | String string |
ringPort | --- |
ringPortPrimaryState | String string |
RingPortPrimaryState | [In Service, In Service, AINS, Out Of Service - Autonomous, Out Of Service - Auto and Mgmt, In Service - Autonomous, Maintenance] |
ringPortUserLabel | String string |
--- | --- |
ringLinkHandle | Integer integer |
ringLinkHandle | --- |
ringLink | String string |
ringLink | --- |
farEndNodeHandle | Integer integer |
farEndNodeHandle | --- |
farEndNode | String string |
farEndNode | --- |
farEndPortHandle | Integer integer |
farEndPortHandle | --- |
farEndPort | String string |
farEndPort | --- |
farEndPortPrimaryState | String string |
FarEndPortPrimaryState | [In Service, In Service, AINS, Out Of Service - Autonomous, Out Of Service - Auto and Mgmt, In Service - Autonomous, Maintenance] |
farEndPortUserLabel | String string |
--- | --- |
ownerNEPort | String string |
ownerNEPort | --- |
ownerLink | String string |
ownerLink | --- |
linkState | Integer integer |
linkState | --- |
ringNodeVSID | Integer integer |
ringNodeVSID | --- |
farEndNodeVSID | Integer integer |
farEndNodeVSID | --- |
cRingIdL | String string |
cRingIdL | --- |
linkType | String string |
linkType | --- |
otnLinkId | Integer integer |
otnLinkId | --- |
connectionRate | Integer integer |
connectionRate | --- |
internalConnId | Integer integer |
internalConnId | --- |
operationalState | String string |
operationalState | --- |
operationState | String string |
--- | --- |
ownerRPLLink | String string |
ownerRPLLink | [-- for Ring with Transparent Node , link name for Normal Ring] |
linkId | Integer integer |
--- | --- |
linkStateUi | String string |
--- | --- |
srcPacketSwitchName | String string |
srcPacketSwitchName | [Name Of the Source Packet Switch] |
srcPsId | Integer integer |
srcPsId | --- |
sinkPacketSwitchName | String string |
sinkPacketSwitchName | [Name Of the Sink Packet Switch] |
sinkPsId | Integer integer |
sinkPsId | --- |
cirUnit | String string |
--- | --- |
availableCir | String string |
--- | --- |
consumedCir | String string |
--- | --- |
linkRate | String string |
--- | --- |
linkRateMbps | String string |
--- | --- |
aPortOrLagDescription | String string |
--- | --- |
zPortOrLagDescription | String string |
--- | --- |
key | String string |
--- | --- |
className | String string |
--- | --- |
id | String string |
--- | --- |
sinkVNE | Boolean boolean |
--- | --- |
srcVNE | Boolean boolean |
--- | --- |
vneInvolved | Boolean boolean |
--- | --- |
ringWithTransNode | Boolean boolean |
isRingWithTransNode | --- |
nERPId
Name |
Type |
Description |
Enum |
---|---|---|---|
managementState | String string |
--- | --- |
ringName | String string |
--- | --- |
ringType | String string |
--- | --- |
ringId | Long long |
--- | --- |
ringAdminState | String string |
--- | --- |
createTime | Long long |
--- | --- |
description | String string |
--- | --- |
jobTaskId | Long long |
--- | --- |
preProvCliCmd | String string |
--- | --- |
postProvCliCmd | String string |
--- | --- |
nERPIdHolder
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 | nERPId nERPId |
--- | --- |
scheduler | ESMSchedulerDataModel ESMSchedulerDataModel |
--- | --- |
operationName | String string |
--- | --- |
vneScriptDataList | array[VNEScriptData] VNEScriptData |
--- | --- |
activate | Boolean boolean |
--- | --- |
nERPInstHolderMapper
Name |
Type |
Description |
Enum |
---|---|---|---|
sessionId | String string |
--- | --- |
requestURI | String string |
--- | --- |
logReqId | String string |
--- | --- |
operator | String string |
--- | --- |
client | String string |
--- | --- |
reqId | EsmRequestHeaderMapper EsmRequestHeaderMapper |
--- | --- |
req | ERP Mapper ERP Mapper |
--- | --- |
scheduler | ESMSchedulerDataModel ESMSchedulerDataModel |
--- | --- |
oam | EsmOAMDataModel EsmOAMDataModel |
--- | --- |
oamData | N_MD_Data N_MD_Data |
--- | --- |
erpGraphHandler | Object object |
--- | --- |
operationName | String string |
--- | --- |
switchMap | nERPSwitchMapper nERPSwitchMapper |
--- | --- |
holdTimeChange | Boolean boolean |
--- | --- |
topologyChange | Boolean boolean |
--- | --- |
userName | String string |
--- | --- |
errorReason | String string |
--- | --- |
cmdStatus | String string |
--- | --- |
activate | Boolean boolean |
--- | --- |
ProtectionParams
Name |
Type |
Description |
Enum |
---|---|---|---|
revertive | Boolean boolean |
revertive | --- |
guardtime | Integer integer |
guardtime | --- |
revertTime | Integer integer |
revertTime | --- |
protectionSwitchState | String string |
protectionSwitchState | --- |
templateId | Integer integer |
templateId | --- |
holdUpTime | Integer integer |
holdUpTime | --- |
holdDownTime | Integer integer |
holdDownTime | --- |
holdTimeType | String string |
holdTimeType | --- |
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 | --- |
TransVsData
Name |
Type |
Description |
Enum |
---|---|---|---|
ringNode | String string |
ringNode | --- |
ringPack | String string |
ringNode | --- |
transNode | Boolean boolean |
transNode | --- |
ringLink | String string |
ringLink | --- |
rplTransPort | String string |
rplTransPort | --- |
key | String string |
--- | --- |
className | String string |
--- | --- |
id | String string |
--- | --- |
srcOrSinkTPID | Integer integer |
SrcOrSinkTPID | --- |
Void
Name |
Type |
Description |
Enum |
---|