Operation
post /esmService/mplstpNpa/abortService
State transition :
Deploying -> Deploy Failed
OR
Modifying -> Modify Failed
ie., Used to bring the service back to a non-transient state when its struck in a transient state. 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.This is not a scheduled operation.
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Service Data | N_ServiceIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ServiceIdResponseHolderModel
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/mplstpNpa/ActivateCardorNPA
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | MPLSTP NPA data | nMplstpCardorPackHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
nMplstpNpaIdRespHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Example Request Data
https://135.250.76.235:8443/oms1350/esmService/mplstpNpa/ActivateCardorNPA {"req":{"cardOrNPA":1,"neName":"ESM-4V1-L",packName:"11QCE12X-3-8","vneScriptDataList":[]},"reqId":9, "scheduler":{"jobDescription":"","jobName":"NPA Activation_Fri Sep 08 2017 16:20:10 UTC+5:30","trigger":{"deployNow" :"Yes","expression":"","name":"NPA Activation_Fri Sep 08 2017 16:20:10 UTC+5:30Trigger","timeOffset":"",type:""},"username":"alcatel"} }
Produces
application/json
Example Response Data
{"responseId":{"req":null,"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Success","opMsg":"","msgCode":"MPLSTP_CARD_NPA_ACTIVATION_SUCCESS_001","parameters":["ESM-4V1-L:11QCE12X-3-8"],"paramCount":1,"objectId":0,"jobName":"","objectType":0},"req":null,"scheduler":null,"operationName":""}
External Docs
Operation
post /esmService/mplstpNpa/activateChannel
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | MPLSTP NPA data | nMplstpIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
nMplstpNpaIdRespHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Example Request Data
https://135.250.76.235:8443/oms1350/esmService/mplstpNpa/activateChannel { "req":{ "channelName":"ESM-4V1-L/11QCE12X-3-7-X2-ESM-4V1-M/11OPE8-2-4-X3 OTU2:1 ODU2:1 DSR:1-NULL","interfaceEndA":"A-End","interfaceEndZ" :"Z-End","interfaceNameZ":"I_11OPE8-2-4-X3_NULL","neNameA":"ESM-4V1-L","portLagAssocA":"11QCE12X-3-7-X2","portLagAssocZ":"11OPE8-2-4-X3" },"reqId": 9,"scheduler":{"jobDescription":"","jobName":"MPLS-TP-Channel Activation_Fri Sep 08 2017 16:35:04 UTC+5:30","trigger":{"deployNow" :"Yes","expression":"","name":"MPLS-TP-Channel Activation_Fri Sep 08 2017 16:35:04 UTC+5:30Trigger","timeOffset":"","type":""}} }
Produces
application/json
Example Response Data
{"sessionId":null,"requestURI":null,"logReqId":null,"operator":null,"client":null,"responseId":{"req":null,"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Failure","opMsg":"","msgCode":"MPLSTP_NPA_CHANNEL_ACTIVATION_ERROR_002","parameters":["ESM-4V1-L/11QCE12X-3-7-X2-ESM-4V1-M/11OPE8-2-4-X3 OTU2:1 ODU2:1 DSR:1-NULL"],"paramCount":1,"objectId":0,"jobName":"","objectType":0},"req":null,"schedReqMapper":null,"activate":false}
External Docs
Operation
post /esmService/mplstpNpa/allocateEPLService
@ApiParam(value = "Service Data",required=true ) @RequestBody N_ServiceInstHolderMapper reqData,
@ApiParam(value = "Http Servlet Request model" ) HttpServletRequest servletRequest) throws Exception{
Used to create a service in ESM in Allocated state.
State transition :
New -> Planned -> Allocated
Saving a service in Allocated state in ESM is almost identical to saving it in Planned state(refer to planEPLService).
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. Once the resources(service endpoint ports) are allocated for a service, it is guaranteed that service 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 a service instance.
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Service Data | ServiceWorkflowModel |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ServiceResponseHolderModel
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/mplstpNpa/dbDeleteChannel
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | MPLSTP NPA data | nMplstpIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MPLSTPNpaRespHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
https://135.250.76.235:8443/oms1350/esmService/mplstpNpa/dbDeleteChannel { "req":{ "channelName":"ESM-4V1-L/11QCE12X-3-7-X2-ESM-4V1-M/11OPE8-2-4-X3 OTU2:1 ODU2:1 DSR:1-NULL","interfaceEndA":"A-End","interfaceEndZ" :"Z-End","interfaceNameZ":"I_11OPE8-2-4-X3_NULL","neNameA":"ESM-4V1-L","portLagAssocA":"11QCE12X-3-7-X2","portLagAssocZ":"11OPE8-2-4-X3" },"reqId": 9,"scheduler":{"jobDescription":"","jobName":"MPLS-TP-Channel DB DELETE_Fri Sep 08 2017 16:35:04 UTC+5:30","trigger":{"deployNow" :"Yes","expression":"","name":"MPLS-TP-Channel DB DELETE_Fri Sep 08 2017 16:35:04 UTC+5:30Trigger","timeOffset":"","type":""}} }
Produces
application/xml
Example Response Data
{"sessionId":null,"requestURI":null,"logReqId":null,"operator":null,"client":null,"responseId":{"req":null,"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Failure","opMsg":"","msgCode":"MPLSTP_NPA_CHANNEL_DB_DELETE_ERROR_002","parameters":["ESM-4V1-L/11QCE12X-3-7-X2-ESM-4V1-M/11OPE8-2-4-X3 OTU2:1 ODU2:1 DSR:1-NULL"],"paramCount":1,"objectId":0,"jobName":"","objectType":0},"req":null,"schedReqMapper":null,"activate":false}
External Docs
Operation
post /esmService/mplstpNpa/dbDeleteService
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 service, Network discovery will discover this service back. If user has done DB delete of an inconsistent service, Network discovery will not discover the whole service back. It will only sync the elementary entities from the NE to ESM. If the service is not discovered after network discovery, user can refer to Network discovery 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 | Service Data | N_ServiceIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ServiceIdResponseHolderModel
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/mplstpNpa/deActivateCardorNPA
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | MPLSTP NPA data | nMplstpCardorPackHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
nMplstpNpaIdRespHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Example Request Data
https://135.250.76.235:8443/oms1350/esmService/mplstpNpa/deActivateCardorNPA {"req":{"cardOrNPA":1,"neName":"ESM-4V1-L",packName:"11QCE12X-3-8","vneScriptDataList":[]},"reqId":9, "scheduler":{"jobDescription":"","jobName":"NPA Activation_Fri Sep 08 2017 16:20:10 UTC+5:30","trigger":{"deployNow" :"Yes","expression":"","name":"NPA Deactivation_Fri Sep 08 2017 16:20:10 UTC+5:30Trigger","timeOffset":"",type:""},"username":"alcatel"} }
Produces
application/json
Example Response Data
{"responseId":{"req":null,"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Success","opMsg":"","msgCode":"MPLSTP_CARD_NPA_DEACTIVATION_SUCCESS_001","parameters":["ESM-4V1-L:11QCE12X-3-8"],"paramCount":1,"objectId":0,"jobName":"","objectType":0},"req":null,"scheduler":null,"operationName":""}
External Docs
Operation
post /esmService/mplstpNpa/deActivateChannel
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | MPLSTP NPA data | nMplstpIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
nMplstpNpaIdRespHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Example Request Data
https://135.250.76.235:8443/oms1350/esmService/mplstpNpa/deActivateChannel { "req":{ "channelName":"ESM-4V1-L/11QCE12X-3-7-X2-ESM-4V1-M/11OPE8-2-4-X3 OTU2:1 ODU2:1 DSR:1-NULL","interfaceEndA":"A-End","interfaceEndZ" :"Z-End","interfaceNameZ":"I_11OPE8-2-4-X3_NULL","neNameA":"ESM-4V1-L","portLagAssocA":"11QCE12X-3-7-X2","portLagAssocZ":"11OPE8-2-4-X3" },"reqId": 9,"scheduler":{"jobDescription":"","jobName":"MPLS-TP-Channel Deactivation_Fri Sep 08 2017 16:35:04 UTC+5:30","trigger":{"deployNow" :"Yes","expression":"","name":"MPLS-TP-Channel Deactivation_Fri Sep 08 2017 16:35:04 UTC+5:30Trigger","timeOffset":"","type":""}} }
Produces
application/json
Example Response Data
{"sessionId":null,"requestURI":null,"logReqId":null,"operator":null,"client":null,"responseId":{"req":null,"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Failure","opMsg":"","msgCode":"MPLSTP_NPA_CHANNEL_DEACTIVATION_ERROR_002","parameters":["ESM-4V1-L/11QCE12X-3-7-X2-ESM-4V1-M/11OPE8-2-4-X3 OTU2:1 ODU2:1 DSR:1-NULL"],"paramCount":1,"objectId":0,"jobName":"","objectType":0},"req":null,"schedReqMapper":null,"activate":false}
External Docs
Operation
post /esmService/mplstpNpa/DeleteCardorNPA
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | MPLSTP NPA data | nMplstpCardorPackHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
nMplstpNpaIdRespHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Example Request Data
https://135.250.76.235:8443/oms1350/esmService/mplstpNpa/DeleteCardorNPA {"req":{"cardOrNPA":1,"neName":"ESM-4V1-L",packName:"11QCE12X-3-8","vneScriptDataList":[]},"reqId":9, "scheduler":{"jobDescription":"","jobName":"NPA Activation_Fri Sep 08 2017 16:20:10 UTC+5:30","trigger":{"deployNow" :"Yes","expression":"","name":"NPA Deletion_Fri Sep 08 2017 16:20:10 UTC+5:30Trigger","timeOffset":"",type:""},"username":"alcatel"} }
Produces
application/json
Example Response Data
{"responseId":{"req":null,"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Success","opMsg":"","msgCode":"MPLSTP_CARD_NPA_DELETION_SUCCESS_001","parameters":["ESM-4V1-L:11QCE12X-3-8"],"paramCount":1,"objectId":0,"jobName":"","objectType":0},"req":null,"scheduler":null,"operationName":""}
External Docs
Operation
post /esmService/mplstpNpa/deleteService
State transition :
Allocated -> Deleted
OR
Planned -> Deleted
This can be triggered only on Planned and Allocated services and it will delete the service instance and all its associations from ESM.
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Service Data | N_ServiceIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ServiceIdResponseHolderModel
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
get /esmService/mplstpNpa/emlConfigChgDetected
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
String
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
text/plain
External Docs
Operation
post /esmService/mplstpNpa/forceDeployService
Service State : Inconsistent (Due to a discovery process)
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Service Data | ServiceWorkflowModel |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ServiceResponseHolderModel
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
get /esmService/mplstpNpa/GetCARRIERLINKSVNETopology/{channelName}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
channelName | required | channelName, The value for channel Name can be got using GetAllErpWithAlarmState/{localTimeZoneOffset}/{nodeName}/{portName}/{pageContext}/{selectedRingName} | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
VNEDataList
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
https://135.250.76.235:8443/oms1350/esmService/mplstpNpa/GetCARRIERLINKSVNETopology/"L-M-O"
Produces
application/json
Example Response Data
{ "vneDataList": [], "items": [] }
External Docs
Operation
post /esmService/mplstpNpa/getURL
Query parameters
Name |
IsRequired |
Description |
---|---|---|
token | required | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
String
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/x-www-form-urlencoded
Produces
text/plain
External Docs
Operation
get /esmService/mplstpNpa/GetcardDeleteVNETopology/{npaName}/{neName}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
npaName | required | npaName, The value for NPA Name can be got using GetAllErpWithAlarmState/{localTimeZoneOffset}/{nodeName}/{portName}/{pageContext}/{selectedRingName} | --- |
neName | required | neName, The value for NPA Name can be got using GetAllErpWithAlarmState/{localTimeZoneOffset}/{nodeName}/{portName}/{pageContext}/{selectedRingName} | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
VNEDataList
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
https://135.250.76.235:8443/oms1350/esmService/mplstpNpa/GetcardDeleteVNETopology/NPA-NEW-1/ESM-4V1-L
Produces
application/json
Example Response Data
{ "vneDataList": [], "items": [] }
External Docs
Operation
get /esmService/mplstpNpa/GetnpaDeleteVNETopology/{npaName}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
npaName | required | npaNAme, The value for channel Name can be got using GetAllErpWithAlarmState/{localTimeZoneOffset}/{nodeName}/{portName}/{pageContext}/{selectedRingName} | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
VNEDataList
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
https://135.250.76.235:8443/oms1350/esmService/mplstpNpa/GetnpaDeleteVNETopology/NPA-NEW-1
Produces
application/json
Example Response Data
{ "vneDataList": [], "items": [] }
External Docs
Operation
post /esmService/mplstpNpa/modifyChannel
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | MPLSTP Channel data | nMplstpIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MPLSTPNpaRespHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Example Request Data
https://135.250.76.235:8443/oms1350/esmService/mplstpNpa/modifyChannel { "req":{ "channelName":"ESM-4V1-L/11QCE12X-3-7-X2-ESM-4V1-M/11OPE8-2-4-X3 OTU2:1 ODU2:1 DSR:1-NULL","interfaceEndA":"A-End","interfaceEndZ" :"Z-End","interfaceNameZ":"I_11OPE8-2-4-X3_NULL","neNameA":"ESM-4V1-L","portLagAssocA":"11QCE12X-3-7-X2","portLagAssocZ":"11OPE8-2-4-X3" },"reqId": 9,"scheduler":{"jobDescription":"","jobName":"MPLS-TP-Channel Modification_Fri Sep 08 2017 16:35:04 UTC+5:30","trigger":{"deployNow" :"Yes","expression":"","name":"MPLS-TP-Channel Modification_Fri Sep 08 2017 16:35:04 UTC+5:30Trigger","timeOffset":"","type":""}} }
Produces
application/xml
Example Response Data
{"sessionId":null,"requestURI":null,"logReqId":null,"operator":null,"client":null,"responseId":{"req":null,"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Failure","opMsg":"","msgCode":"MPLSTP_NPA_CHANNEL_MODIFICATION_ERROR_002","parameters":["ESM-4V1-L/11QCE12X-3-7-X2-ESM-4V1-M/11OPE8-2-4-X3 OTU2:1 ODU2:1 DSR:1-NULL"],"paramCount":1,"objectId":0,"jobName":"","objectType":0},"req":null,"schedReqMapper":null,"activate":false}
External Docs
Operation
post /esmService/mplstpNpa/modifyEPLService
State transition :
Planned -> Planned
OR
Allocated -> Allocated
The service attributes, its topology, end points and other details can be modified and saved in the Planned and Allocated states using this rest-API. The validations that are done during planEPLService and allocateServiceInstance will be done again during this operation.
Important parameters that can be modified on a service in Planned/Allocated state are :
Service name, customer
Service topology(links, rings in case of Provider Bridge and service end points, CVLAN and SVLAN values(in case of Provider Bridge))
Primary/Secondary Pseudowires in case of MPLSTP Services. User can select more than one tunnel for each pseudowire precedence.
# Only the whole pseudowire can be added or deleted. Segments/tunnels of the existing pseudowire cannot be added or removed.
Miscellaneous attributes on Access end points
QoS policies on Network ports from the selected topology and Access end points
OAM attributes : Enabling/Disabling OAM, and some attribues on MA and MEP. MD cannot be changed
Enabling/disabling PM
Enabling/disabling CLI
All these updated values will be saved in ESM.
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Service Data | ServiceWorkflowModel |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ServiceResponseHolderModel
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/mplstpNpa/moveBackToPlannedService
State transition :
Allocated -> Planned
ie., the resources(service end points) will no more be reserved after successful completion of this operation. This can be triggered only on a service with Allocated management state and is not a scheduled operation.
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Service Data | N_ServiceIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ServiceIdResponseHolderModel
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/mplstpNpa/moveToAllocateService
State transition :
Planned -> Allocated
It is triggered only on a service with Planned management state. Once this operation is successful, its guaranteed that service deployment operation will not fail due to resource constraints. This is not a scheduled operation.
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Service Data | N_ServiceIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ServiceIdResponseHolderModel
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/mplstpNpa/moveToDeployService
State transition :
Allocated -> Commissioned/Deploy-Failed
This operation is almost same as schedDeployEPLService operation.(refer to schedDeployEPLService 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 | Service Data | ServiceWorkflowModel |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ServiceResponseHolderModel
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/mplstpNpa/moveToDeployServiceByServiceName
State transition :
Allocated -> Commissioned/Deploy-Failed
This operation is almost same as schedDeployEPLService operation.(refer to schedDeployEPLService 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 | Service Data | ServiceWorkflowModel |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ServiceResponseHolderModel
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/mplstpNpa/planEPLService
ESM uses the task chain for service management state transition.
State transition :
New -> Planned
Provider Bridge Service
When a service instance is in Planned management state, its existance will be only in ESM. It Will create a new service instance in ESM with the unique name given by user and a unique CVLAN-SVLAN combination.
Validation errors will be thrown if either service name or the CVLAN-SVLAN combination is not unique and the service instance will not be saved in even ESM.
Other validations done while creating a service instance in Planned state are :
If topology is incomplete
If more than one endpoints selected per pack for the same pack
If endpoints selected are not on the selected topology(ring/links)
Access CVLAN/SVLAN if used is already used by other service on an endpoint
If a selected endpoint has been used in any other private service.
Resources(service end points) will not be reserved when a service has been saved in Planned management state.
MPLSTP Service
Only EPL or EVPL service can be created with MPLSTP
When a service instance is in Planned management state, its existance will be only in ESM. It will create a new service instance in ESM with the unique Service name given by user, end Points and Primary Pseudowire .
Validation errors will be thrown if service name is not unique or if mandatory fields are empty or if End Points and Primary Pseduowire is not selected, in such case the service instance will not be saved in even ESM.
While creating the MPLSTP or Provider Bridge service instance in ESM, the details of the following entities will also be saved in ESM database:
For an MPLS-TP service, User can select more than one tunnel for each pseudowire precedence(multi-segment pseudowire).
But the ends of the pseudowire segments together should start and end on the packs where access endpoints are being added.
The service instance itself.
The Provider Bridge Service topology selected by user, all the links and the ring details if the selected link is part of a ring selected . MPLSTP Service topology selected by user, all the working and protected tunnels
The service endpoints selected by user.
Service OAM details(If OAM is being configured by user) including Maintenance Domain(MD), Maintenance Association(MA) and Maintenance End Points(MEP)
QoS parameters inlcuding the Ingress and Egress parameters on Access and Network ports(QoS policy association).
The CLI commands given by user in Pre/Post CLI fields
Split Horizon Group details, if the service is a E-ETREE(EPTREE, EVPTREE)
Whether Performance monitoring(PM) should be enbaled or not, and PM report profile association
Creating a service in planned state is not a scheduled operation.
Once the service is created in Planned state in ESM, it can be seen/operated on from the Operate list.
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Service Data | ServiceWorkflowModel |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ServiceResponseHolderModel
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/mplstpNpa/scheduleChannelDelete
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | MPLSTP Channel data | nMplstpIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
nMplstpNpaIdRespHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Example Request Data
https://135.250.76.235:8443/oms1350/esmService/mplstpNpa/scheduleChannelDelete { "req":{ "channelName":"ESM-4V1-L/11QCE12X-3-7-X2-ESM-4V1-M/11OPE8-2-4-X3 OTU2:1 ODU2:1 DSR:1-NULL","interfaceEndA":"A-End","interfaceEndZ" :"Z-End","interfaceNameZ":"I_11OPE8-2-4-X3_NULL","neNameA":"ESM-4V1-L","portLagAssocA":"11QCE12X-3-7-X2","portLagAssocZ":"11OPE8-2-4-X3" },"reqId": 9,"scheduler":{"jobDescription":"","jobName":"MPLS-TP-Channel Deletion Sep 08 2017 16:35:04 UTC+5:30","trigger":{"deployNow" :"Yes","expression":"","name":"MPLS-TP-Channel DELETE_Fri Sep 08 2017 16:35:04 UTC+5:30Trigger","timeOffset":"","type":""}} }
Produces
application/json
Example Response Data
{"sessionId":null,"requestURI":null,"logReqId":null,"operator":null,"client":null,"responseId":{"req":null,"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Failure","opMsg":"","msgCode":"MPLSTP_NPA_CHANNEL_SHCEDULED_DELETE_ERROR_002","parameters":["ESM-4V1-L/11QCE12X-3-7-X2-ESM-4V1-M/11OPE8-2-4-X3 OTU2:1 ODU2:1 DSR:1-NULL"],"paramCount":1,"objectId":0,"jobName":"","objectType":0},"req":null,"schedReqMapper":null,"activate":false}
External Docs
Operation
post /esmService/mplstpNpa/schedDeployEPLService
State transition :
New -> Planned
Planned -> ALlocated
Allocated -> Commissioned/Deploy-Failed
This operation will first save the service instance in planned state in ESM and then to Allocated state. This is a scheduled operation in ESM. The user can choose to deploy a service for a future time or deploy it right away. The service will be deployed from Allocated state at the scheduled time. During this operation ESM performs the validation done in planEPLService and allocateServiceInstance and some more validation. This operation persists all the elementary entities required(direct mapping with entities on the NE) in ESM database. When the commands are being created and deployed, service will be moved to a transient management state Deploying. It 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 Provider Bridge service deployment are (in order):
PRE CLI commands(if provided)
Pack level attributes
Port configuration if required
SHG creation, for tree services
Access(Ingress and Egress) and Network(QoS and Queue) policy creation, if the selected policy is not already created on the NE
VPLS creation and activation
SAP creation (Network and Access) and activation
SAP policy association for access SAPs
OAM entity creation :
MD(If the selected MD level is not already deployed on the NE)
MA
MEP creation and activation
Remote MEP
PM enabling
POST CLI commands(if provided)
The entities that wil be created/updated on the NE during a MPLSTP service deployment are (in order):
Pack level attributes
Access Ingress policy creation
EPIPE creation and activation, customer association
End Point creation if secondary pseudowire is created
SAP creation and Activation , SAP Ingress QOS association
Spoke SDP creation and activation
Pseudowire creation
User can select more than one tunnel for each pseudowire precedence(multi-segment pseudowire).
But the ends of the pseudowire segments together should start and end on the packs where access endpoints are being added.
OAM entity creation :
MD(If the selected MD level is not already deployed on the NE)
MA
MEP creation and activation
Remote MEP
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 service in Commissioned management state.
If any of the commands are failed(except PM and POST CLI which are best effort commands), ESM will mark the service in Deploy-Failed management state.
The eth interface entities like eth interface id , vlan id , IPV4 , IPV6 Proxy ARP , MD keys values are created on the NE during a ETH-IBM service deployment
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Service Data | ServiceWorkflowModel |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ServiceResponseHolderModel
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/mplstpNpa/scheduleNPADeploy
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | MPLSTP NPA data | MPLSTPNpaInstHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MPLSTPNpaRespHolder
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Example Request Data
https://135.250.76.235:8443/oms1350/esmService/mplstpNpa/scheduleNPADeploy { "req":{ "author":"alcatel", "globalId":2, "linkInterfaceDataList":{ { "aNodeName":"ESM-4V1-L","aPortInterfaceName":"I_11QCE12X-3-8-X2_NULL","aPortName":"11QCE12X-3-8-X2", "channelweight":"20","linkId":"144","linkName":"ESM-4V1-L/11QCE12X-3-8-X2-ESM-4V1-O/11QCE12X-2-9-X1 OTU2:1 ODU2:1 DSR:1","linkType":"LINK","zNodeName":"ESM-4V1-O","zPortInterfaceName":"I_11QCE12X-2-9-X1_NULL","zPortName":"11QCE12X-2-9-X1" }},"nodeDataList":{{"globalId":1,"lspEndLabel":2047,"lspStartLabel":32,"maxTunnelId":4095,"minTunnelId":1,"neName":"ESM-4V1-L","nodeId":"0.0.0.8","npaConfigured":true,"packName":"11QCE12X-3-8","svcEndLabel":18431,"svcStartLabel":2048,"vsId" :18},{"globalId":2,"lspEndLabel":2047,"lspStartLabel":32,"maxTunnelId":4095,"minTunnelId":1,"neName":"ESM-4V1-O","nodeId":"0.0.0.13","npaConfigured":true,"packName":"11QCE12X-2-9", "svcEndLabel":18431,"svcStartLabel":2048,"vsId":29} },"npaDescr":"","npaName":"NPA1","postProvCliCmd":"","preProvCliCmd":"","vneScriptDataList":[] },"reqId":{},"scheduler":{jobDescription:"","jobName":"MPLS_TP_NPA_DEPLOY_NPA1_Fri Sep 08 2017 15:40:57 UTC+5:30", "trigger":{"deployNow":"Yes","expression":"","name":"MPLS_TP_NPA_DEPLOY_NPA1_Fri Sep 08 2017 15:40:57 UTC+5:30Trigger","timeOffset":"","type":""}, "username:""alcatel"}}
Produces
application/json
Example Response Data
{"responseId":{"req":null,"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Success","opMsg":"","msgCode":"MPLSTP_NPA_DEPLOY_SUCCESS_001","parameters":["NPA1"],"paramCount":1,"objectId":8,"jobName":"MPLS_TP_NPA_DEPLOY_NPA1_Fri Sep 08 2017 15:40:57 UTC+5:30","objectType":21}}
External Docs
Operation
post /esmService/mplstpNpa/scheduledActivateService
State transition :
Commissioned (Service state : Out of Service) -> Commissioned(Service state : In Service)
This is a scheduled operation in ESM. The User can choose to activate a service for a future time or activate it right away. It 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 Provider Bridge service entities to bring up the admin state in the following order :
VPLS
SAP
MEP(If OAM is enabled on the service)
The commands will be sent for the following MPLSTP service entities to bring up the admin state in the following order :
EPIPE
SAP
MEP
EPIP SPOKE SDP
If all the commands are successful, The service-state of the corresponding service instance will be marked as In Service, and the service 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 | Service Data | N_ServiceIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ServiceIdResponseHolderModel
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/mplstpNpa/scheduledClearPmCounters
Only for PM Enabled Services
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Service Data | ServiceWorkflowModel |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ServiceResponseHolderModel
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /esmService/mplstpNpa/scheduledClearPmCountersOnNodePort
Only for PM Enabled Ports
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Port Data | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ServiceResponseHolderModel
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /esmService/mplstpNpa/scheduledClearPmCountersOnPort
Only for PM Enabled Ports
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Port Data | PM_Counters_Data |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ServiceResponseHolderModel
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /esmService/mplstpNpa/scheduledClearPmCountersOnTestCase
Only for Pro Active SLM and DM Test cases
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Test Case Data | PM_Counters_Data |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ServiceResponseHolderModel
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /esmService/mplstpNpa/scheduledClearPmCountersOnTestSuite
Only for Pro Active SLM and DM Test cases
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Test Suite Data | PM_Counters_Data |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ServiceResponseHolderModel
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /esmService/mplstpNpa/scheduledDeactivateService
State transition :
Commissioned (Service state : In Service) -> Commissioned(Service state : Out of Service)
This is a scheduled operation in ESM. The User can choose to deactivate a service for a future time or deactivate it right away. It 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 Provider Bridge Service entities to bring down the admin state in the order :
VPLS
SAP
MEP(If OAM is enabled on the service)
The commands will be sent for the following MPLSTP Service entities to bring down the admin state in the order :
EPIPE
SAP
MEP
SPOKE SDP
If all the commands are successful,the service-state of the corresponding service instance will be marked as Out Of Service, and the service 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 | Service Data | N_ServiceIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ServiceIdResponseHolderModel
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/mplstpNpa/scheduledDeleteService
State transition :
Deploy Failed -> Deleted
The operation is almost same as move back to allocate operation (refer to moveBackToAllocatedServiceScheduled), except that it also deletes the service instance from ESM. This is a scheduled operation in ESM. User can choose to delete a service for a future time or delete it right away.
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Service Data | N_ServiceIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ServiceIdResponseHolderModel
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/mplstpNpa/forceCompleteModifyFailedServiceScheduled
State transition :
Modifying -> Commissioned
This is a scheduled operation in ESM. User can choose to force complete a service for a future time or do it right away. Even if the modification operation is failed, this operation will mark the service as Commissioned, but with a remark "Best effort: force complete". If The modification retry is successful, the service will be marked as Commissioned.
When a service is in Modify failed state, move back to Allocate or delete operations will not be enabled. In order to cleanup the service entities, the service should be in Commissioned or Deploy-Failed state. This operation can be used to mark it as Commissioned even though modification is failure, so that user can cleanup the service from Commissioned state. (For the service modification details refer to scheduledModifyEPLService)
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Service Data | N_ServiceIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ServiceIdResponseHolderModel
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/mplstpNpa/scheduledModifyEPLService
State transition :
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 service by user, updates the service remarks. 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, service will be moved to a transient management state Modifying.
The modification is allowed for the following entities using this operation for Provider bridge services :
Author(not propagated to NE)
Tunneling attributes
Link/Ring addition/deletion to/from topology in case of Provider Bridge Service.
Primary/Secondary Pseudowires in case of MPLSTP Services. User can select more than one tunnel for each pseudowire precedence.
# Only the whole pseudowire can be added or deleted. Segments/tunnels of the existing pseudowire cannot be added or removed.
Access Endpoint addition/deletion
QoS policies
Enabling/Disabling OAM, along with some attributes for MA and MEP
PM enable/disable
PRE and post CLI commands
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 service will be marked Commissioned.
If any of the commands deployed to NE are failed service will be marked as Modify-Failed and remarks will not be cleared.
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Service Data | ServiceWorkflowModel |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ServiceResponseHolderModel
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/mplstpNpa/moveBackToAllocatedServiceScheduled
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 service instance on which the operation is being invoked. This is a scheduled operation in ESM.The user can choose to move back to allocate a service for a future time or move back to allocate it right away. It 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 for Provider Bridge service:
PRE CLI commands(if provided)
PM disabling
OAM entity deletion
MEP deactivation and deletion
MA(Remote MEP will be deleted automatically when MA is deleted)
SAP deactivation and deletion, both network and access SAPs
VPLS deactivation and deletion
Policy deletion if any other service instance is not using the same policy
SHG deletion, if any other service instance is not using the same SHG
The entity deletion/updation commands will be sent in the following order for MPLSTP service:
PRE CLI commands(if provided)
PM disabling
Maintenance end point deletion
Pseudowire deletion
Spoke SDP control channel deactivation
EPIPE SPOKE SDP deletion
SAP deactivation and deletion
End Point 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 service will be marked as Allocated.
If any of the commands have failed, the service 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 | Service Data | N_ServiceIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ServiceIdResponseHolderModel
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/xml
Produces
application/xml
External Docs
Operation
post /esmService/mplstpNpa/moveBackToUndeployAndDeleteService
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 service instance on which the operation is being invoked. This is a scheduled operation in ESM.The user can choose to move back to allocate a service for a future time or move back to allocate it right away. It 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 for Provider Bridge service:
PRE CLI commands(if provided)
PM disabling
OAM entity deletion
MEP deactivation and deletion
MA(Remote MEP will be deleted automatically when MA is deleted)
SAP deactivation and deletion, both network and access SAPs
VPLS deactivation and deletion
Policy deletion if any other service instance is not using the same policy
SHG deletion, if any other service instance is not using the same SHG
The entity deletion/updation commands will be sent in the following order for MPLSTP service:
PRE CLI commands(if provided)
PM disabling
Maintenance end point deletion
Pseudowire deletion
Spoke SDP control channel deactivation
EPIPE SPOKE SDP deletion
SAP deactivation and deletion
End Point 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 service will be marked as Allocated.
If any of the commands have failed, the service 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 | Service Data | N_ServiceIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ServiceIdResponseHolderModel
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /esmService/mplstpNpa/scheduledSwitchAndClearService
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | Service Data | N_ServiceIdHolder |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ServiceIdResponseHolderModel
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Entry«string,ArrayList«int»»
Name |
Type |
Description |
Enum |
---|---|---|---|
key | array[Integer] integer |
--- | --- |
Entry«string,int»
Name |
Type |
Description |
Enum |
---|---|---|---|
key | Integer integer |
--- | --- |
ESMElementaryDataModel
Name |
Type |
Description |
Enum |
---|---|---|---|
neName | String string |
neName | [ ] |
packName | String string |
packName | [ ] |
vsId | Integer integer |
vsId | --- |
elementaryId | Long long |
ElementaryId | --- |
interconnectedRingId | String string |
InterConnectedRingId | --- |
subRingType | String string |
SubRing Type | [Virtual Channel, Non-Virtual Channel, None] |
propagateTopoChange | String string |
Propogate Topology Change | [Enable , Disable] |
vplsId | Long long |
--- | --- |
mdId | Integer integer |
mdIndex | --- |
maId | Integer integer |
MA index | --- |
bridgeId | Long long |
--- | --- |
vlanId | String string |
--- | --- |
epipeId | Long long |
--- | --- |
maName | String string |
MA name | --- |
ccmInterval | String string |
CCM Enabled | [true, false] |
mdLevel | Integer integer |
OAM maintenance domain level | [0, 1, 2, 3, 4, 5, 6, 7] |
mdFormat | String string |
OAM maintenance domain format | [NONE] |
elementaryName | String string |
ElementaryName | --- |
objectScope | Integer integer |
Service Object Scope | --- |
adminState | String string |
--- | --- |
operationalState | String string |
Operational state | [up, down, unknown, transition, --] |
ringState | String string |
--- | |
mark | Integer integer |
--- | --- |
entityType | String string |
Service elementary entity | [erp ring, srvc, srvc vpls, svc sap, srvc mep, erp path, erp vpls, erp sap] |
cardName | String string |
--- | --- |
policyType | String string |
Policy type | [None, Access, Network] |
editedSapName | String string |
SapName in shelf/slot/port:SVLAN:CVLAN format | --- |
customerId | Integer integer |
Customer Id to be associated with Service | --- |
policyAssociation | String string |
--- | --- |
sapId | Integer integer |
--- | --- |
sapRingId | Long long |
--- | --- |
sapRingIdStr | String string |
--- | --- |
pathA | String string |
--- | --- |
pathB | String string |
--- | --- |
rplNode | String string |
--- | --- |
pathAFwdState | String string |
path A Forward State | [Blocked, unblocked] |
pathBFwdState | String string |
path A Forward State | [Blocked, unblocked] |
ringPortAState | String string |
--- | |
ringPortBState | String string |
--- | |
inConsistentFlag | String string |
InConsistentFlag | [Consistent, Inconsistent] |
policyName | String string |
--- | --- |
entityName | String string |
--- | --- |
policyId | Long long |
--- | --- |
pathainConsistentFlag | String string |
InConsistentFlag | [PATHACONSISTENT, PATHAINCONSISTENT] |
pathbinConsistentFlag | String string |
InConsistentFlag | [PATHBCONSISTENT, PATHBINCONSISTENT] |
pmonPolicyId | Integer integer |
TCA policy Identifier | --- |
profName | String string |
TCA profile name to be used | --- |
pathAAdminState | String string |
path A adminState | [up, down, unknown] |
pathBAdminState | String string |
path B adminState | [up, down, unknown] |
pathAOperState | String string |
path A Operational State | [up, down, unknown, transition, NA] |
pathBOperState | String string |
path B Operational State | [up, down, unknown, transition, NA] |
svcSapType | String string |
Service Sap Type Value | [Dot1Q-Preserve, Dot1Q-Range, Null-Star, Any] |
sapEncapType | String string |
SAP encapsulation Type | [Null, QinQ, Dot1Q] |
cpId | Integer integer |
Connection Profile Identifier | --- |
cpRange | String string |
Connection Profile Range | --- |
cpDescription | String string |
Connection Profile Description | --- |
cpLastModifiedTime | String string |
Connection Profile Last modified Time | --- |
mhfCreation | String string |
mhfCreation | --- |
uniqueUIId | String string |
--- | --- |
vcSwitchingEnabled | String string |
vcSwitchingEnabled | --- |
endPoint | String string |
endPoint | --- |
holdTimeType | String string |
holdTimeType | [seconds, centiseconds] |
holdUpTime | String string |
holdUpTime | --- |
holdDownTime | String string |
holdDownTime | --- |
pathInterface | String string |
--- | |
pathType | String string |
--- | |
path | String string |
--- | |
pathFwdState | String string |
--- | |
ringPortState | String string |
--- | |
pathinConsistentFlag | String string |
--- | |
pathAdminState | String string |
--- | |
pathOperState | String string |
--- | |
pathSide | String string |
--- | --- |
vplsname | String string |
--- | --- |
id | String string |
--- | --- |
key | String string |
--- | --- |
className | String string |
--- | --- |
consistency | String string |
--- | --- |
sapAssn | String string |
--- | --- |
customerIdStr | Integer integer |
--- | --- |
mepId | Integer integer |
mepId | --- |
transmittedCcms | String string |
transmittedCcms | [ ] |
ccmSeqErrors | String string |
ccmSeqErrors | [ ] |
lastErrorCcmFailureFrame | String string |
lastErrorCcmFailureFrame | [ ] |
lastXconCcmFailureFrame | String string |
lastXconCcmFailureFrame | [ ] |
highestPriorityDefect | String string |
highestPriorityDefect | [ ] |
highestPriorityDefectString | String string |
highestPriorityDefect | [ ] |
nmlMacAddress | String string |
nmlMacAddress | [ ] |
macAddress | String string |
macAddress | [ ] |
direction | String string |
direction | [ ] |
interfaceType | String string |
interfaceType | [ ] |
active | String string |
active | [ ] |
lowestPriorityDefect | String string |
lowestPriorityDefect | [ ] |
controlMep | String string |
controlMep | [ ] |
ccmEnable | String string |
ccmEnable | [ ] |
ccmPriority | Integer integer |
ccmPriority | --- |
aisEnable | String string |
aisEnable | [ ] |
aisPriority | Integer integer |
aisPriority | --- |
aisInterval | Integer integer |
aisInterval | --- |
aisLevel | String string |
aisLevel | [ ] |
remoteMepId | Integer integer |
remoteMepId | --- |
remoteMepNeName | String string |
remoteMepNeName | [ ] |
remoteMepPackName | String string |
remoteMepPackName | [ ] |
psId | String string |
PSID | --- |
sapSubType | String string |
--- | --- |
packetSwitchId | String string |
--- | --- |
ehName | String string |
--- | --- |
entityId | Long long |
--- | --- |
remoteMepSapSubType | String string |
Remote Mep Sap SubType | [ ] |
llfEnable | String string |
llf enabled for SAP | [ ] |
ethIfId | Integer integer |
--- | --- |
ethIBMVlanId | Integer integer |
--- | --- |
ethIfDescription | String string |
--- | --- |
mdName | String string |
--- | --- |
format | String string |
--- | --- |
EsmMplstpAttributesDataModel
Name |
Type |
Description |
Enum |
---|---|---|---|
pwControlChannelEnabled | String string |
Control Channel Enable/Disable | --- |
pwRetryTimer | Long long |
Retry Timer in Seconds | --- |
pwRequestTimer | Long long |
Request Timer in Seconds | --- |
epStandbySignallingSlave | String string |
Stand By Signalling Slave | --- |
epRevertTimer | Long long |
Revert Timer in Seconds | --- |
epActiveHoldDelay | Long long |
Active Hold Delay in deciSeconds | --- |
pwAcknowledgementEnabled | String string |
PW Acknowledgement Enable/Disable | --- |
pwTimeoutMultiplier | Long long |
Timeout Multiplier in Seconds | --- |
epStandbySignallingMaster | String string |
Stand By Signalling Master | --- |
pwRefreshTimer | Long long |
Refresh Timer in Seconds | --- |
pwStatusSignalEnabled | String string |
Status Signal Enable/Disable | --- |
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 | --- |
username | String string |
User name | --- |
trigger | ESMSchedulerTriggerDataModel ESMSchedulerTriggerDataModel |
Job Trigger data model | --- |
EthIBMServiceAddlInfo
Name |
Type |
Description |
Enum |
---|---|---|---|
ringName | String string |
--- | --- |
isProtected | Integer integer |
--- | --- |
isReUse | Integer integer |
--- | --- |
protectiondata | ProtectionParams ProtectionParams |
--- | --- |
cvlanId | String string |
cvlanId | --- |
svlanId | String string |
svlanId | --- |
ownerTPID | Integer integer |
ownerTPID | --- |
ownerTPName | String string |
--- | --- |
ownerNeName | String string |
--- | --- |
neighbourTPID | Integer integer |
neighbourTPID | --- |
neighbourName | String string |
--- | --- |
oam | EsmOAMDataModel EsmOAMDataModel |
--- | --- |
oamData | N_MD_Data N_MD_Data |
--- | --- |
templateId | Integer integer |
--- | --- |
portList | array[PortModel] PortModel |
--- | --- |
tpMaName | Object object |
--- | --- |
tpMepId | array[Entry«string,int»] Entry«string,int» |
--- | --- |
tpRemoteMepId | array[Entry«string,int»] Entry«string,int» |
--- | --- |
toDeployRemoteMeps | Integer integer |
--- | --- |
linkInterfaceData
Name |
Type |
Description |
Enum |
---|---|---|---|
channelweight | String string |
--- | --- |
linkType | String string |
--- | --- |
linkId | Integer integer |
--- | --- |
linkName | String string |
--- | --- |
aNodeName | String string |
--- | --- |
aPortName | String string |
--- | --- |
aPortInterfaceName | String string |
--- | --- |
zNodeName | String string |
--- | --- |
zPortName | String string |
--- | --- |
zPortInterfaceName | String string |
--- | --- |
channelWeight | String string |
--- | --- |
MPLS TP NPA Mapper
Name |
Type |
Description |
Enum |
---|---|---|---|
npaName | String string |
--- | --- |
npaDescr | String string |
--- | --- |
author | String string |
--- | --- |
globalId | String string |
--- | --- |
additionalInfo | Object object |
--- | --- |
linkType | String string |
--- | --- |
linkInterfaceDataList | array[linkInterfaceData] linkInterfaceData |
--- | --- |
nodeDataList | array[nodeData] nodeData |
--- | --- |
preProvCliCmd | String string |
--- | --- |
postProvCliCmd | String string |
--- | --- |
vneScriptDataList | array[VNEScriptData] VNEScriptData |
--- | --- |
MPLSTPNpaInstHolder
Name |
Type |
Description |
Enum |
---|---|---|---|
sessionId | String string |
--- | --- |
requestURI | String string |
--- | --- |
logReqId | String string |
--- | --- |
operator | String string |
--- | --- |
client | String string |
--- | --- |
reqId | EsmRequestHeaderMapper EsmRequestHeaderMapper |
--- | --- |
req | MPLS TP NPA Mapper MPLS TP NPA Mapper |
--- | --- |
scheduler | ESMSchedulerDataModel ESMSchedulerDataModel |
--- | --- |
activate | Boolean boolean |
--- | --- |
MPLSTPNpaRespHolder
Name |
Type |
Description |
Enum |
---|---|---|---|
responseId | Response Header Model Response Header Model |
--- | --- |
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 |
--- | --- |
N_ServiceIdHolder
Name |
Type |
Description |
Enum |
---|---|---|---|
sessionId | String string |
--- | --- |
requestURI | String string |
--- | --- |
logReqId | String string |
--- | --- |
operator | String string |
--- | --- |
client | String string |
--- | --- |
reqId | EsmRequestHeaderMapper EsmRequestHeaderMapper |
--- | --- |
req | Service UI Data model Service UI Data model |
--- | --- |
scheduler | ESMSchedulerDataModel ESMSchedulerDataModel |
--- | --- |
vneScriptDataList | array[VNEScriptData] VNEScriptData |
--- | --- |
activate | Boolean boolean |
--- | --- |
N_SHGData
Name |
Type |
Description |
Enum |
---|---|---|---|
rootEndpoints | array[Integer] integer |
RootEndPoints | --- |
leafEndpoints | array[Integer] integer |
LeafEndPoints | --- |
name | String string |
Split Horizon Group Name | --- |
description | String string |
Split Horizon Group Description | --- |
shgHandle | Long long |
Split Horizon Group Handle | --- |
vsid | Integer integer |
Vitual Switch Identifier | --- |
nEndToEndOamInstMapper
Name |
Type |
Description |
Enum |
---|---|---|---|
e2eDataList | array[nEndToEndOamTpVlanMapper] nEndToEndOamTpVlanMapper |
ESM E2E OAM model wrapper | --- |
oamEnabled | Boolean boolean |
E2E Oam Enabled | --- |
oam | EsmOAMDataModel EsmOAMDataModel |
ESM E2E OAM model wrapper | --- |
nLinkOamInstMapper
Name |
Type |
Description |
Enum |
---|---|---|---|
endpointTpId | Long long |
Endpoint TPID | --- |
linkId | Long long |
Link Id | --- |
vlan | Long long |
Vlan Value | --- |
autoGenVlan | Long long |
Vlan Value | --- |
linkType | String string |
--- | |
linkOamEnabled | Boolean boolean |
Link Oam Enabled | --- |
presetRemoteMEPID | Integer integer |
--- | --- |
oam | EsmOAMDataModel EsmOAMDataModel |
ESM OAM model wrapper | --- |
nMplstpCardorPackHolder
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 | nMplsTPcardorPackDetails nMplsTPcardorPackDetails |
--- | --- |
scheduler | ESMSchedulerDataModel ESMSchedulerDataModel |
--- | --- |
operationName | String string |
--- | --- |
activate | Boolean boolean |
--- | --- |
nMplstpIdHolder
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 | nMplstpNpaId nMplstpNpaId |
--- | --- |
scheduler | ESMSchedulerDataModel ESMSchedulerDataModel |
--- | --- |
operationName | String string |
--- | --- |
activate | Boolean boolean |
--- | --- |
nMplstpNpaId
Name |
Type |
Description |
Enum |
---|---|---|---|
channelId | Long long |
--- | --- |
interfaceEndA | String string |
--- | --- |
neNameA | String string |
--- | --- |
interfaceNameA | String string |
--- | --- |
portLagAssocA | String string |
--- | --- |
interfaceIdA | String string |
--- | --- |
interfaceEndZ | String string |
--- | --- |
neNameZ | String string |
--- | --- |
interfaceNameZ | String string |
--- | --- |
portLagAssocZ | String string |
--- | --- |
interfaceIdZ | String string |
--- | --- |
channelName | String string |
--- | --- |
newChannelName | String string |
--- | --- |
channelWeight | Integer integer |
--- | --- |
linkId | Long long |
--- | --- |
vneScriptDataList | array[VNEScriptData] VNEScriptData |
--- | --- |
jobTaskId | Long long |
--- | --- |
nMplstpNpaIdRespHolder
Name |
Type |
Description |
Enum |
---|---|---|---|
sessionId | String string |
--- | --- |
requestURI | String string |
--- | --- |
logReqId | String string |
--- | --- |
operator | String string |
--- | --- |
client | String string |
--- | --- |
responseId | Response Header Model Response Header Model |
responseId | --- |
req | nMplstpNpaId nMplstpNpaId |
erpIdRespHolder | --- |
schedReqMapper | ESMSchedulerDataModel ESMSchedulerDataModel |
schedReqMapper | --- |
activate | Boolean boolean |
--- | --- |
nodeData
Name |
Type |
Description |
Enum |
---|---|---|---|
vsId | String string |
--- | --- |
neName | String string |
--- | --- |
packName | String string |
--- | --- |
globalId | String string |
--- | --- |
nodeId | String string |
--- | --- |
maxTunnelId | String string |
--- | --- |
minTunnelId | String string |
--- | --- |
lspMaxLabels | String string |
--- | --- |
lspStartLabel | String string |
--- | --- |
lspEndLabel | String string |
--- | --- |
lspTotalAvailableLabels | String string |
--- | --- |
svcMaxLabels | String string |
--- | --- |
svcStartLabel | String string |
--- | --- |
svcEndLabel | String string |
--- | --- |
svcTotalAvailableLabels | String string |
--- | --- |
npaConfigured | Boolean boolean |
--- | --- |
OtnInterfaceLinkUIData
Name |
Type |
Description |
Enum |
---|---|---|---|
sinkPortOrLagDescription | String string |
--- | --- |
srcUserLabel | String string |
--- | --- |
sinkVNE | Boolean boolean |
--- | --- |
srcLagPortMembers | array[String] string |
--- | --- |
aNetworkTechType | Integer integer |
--- | --- |
className | String string |
--- | --- |
srcPrimaryState | String string |
SourcePortPrimaryState | [In Service, In Service, AINS, Out Of Service - Autonomous, Out Of Service - Auto and Mgmt, In Service - Autonomous, Maintenance] |
srcNodeID | String string |
--- | --- |
srcIsNPAConfigured | Boolean boolean |
--- | --- |
sinkIsNPAConfigured | Boolean boolean |
--- | --- |
zNeVersion | String string |
--- | --- |
transportType | String string |
--- | --- |
id | String string |
--- | --- |
srcVNE | Boolean boolean |
--- | --- |
sinkUserLabel | String string |
--- | --- |
key | String string |
--- | --- |
srcPortOrLagDescription | String string |
--- | --- |
sinkNodeID | String string |
--- | --- |
tsCount | String string |
--- | --- |
sinkGlobalID | Long long |
--- | --- |
orderid | Integer integer |
--- | --- |
linkBandWidth | String string |
--- | --- |
sinkNPAID | Long long |
--- | --- |
connectionRate | Integer integer |
--- | --- |
sinkPrimaryState | String string |
SinkPortPrimaryState | [In Service, In Service, AINS, Out Of Service - Autonomous, Out Of Service - Auto and Mgmt, In Service - Autonomous, Maintenance] |
srcVSID | Integer integer |
SrcVSID | --- |
aNeVersion | String string |
--- | --- |
internalConnId | Integer integer |
--- | --- |
zNetworkTechType | Integer integer |
--- | --- |
oduFlexRate | String string |
oduFlexRate | --- |
srcGlobalID | Long long |
--- | --- |
srcNPAID | Long long |
--- | --- |
sinkVSID | Integer integer |
SrcVSID | --- |
sinkLagPortMembers | array[String] string |
--- | --- |
PM_Counters_Data
Name |
Type |
Description |
Enum |
---|---|---|---|
sessionId | String string |
--- | --- |
requestURI | String string |
--- | --- |
logReqId | String string |
--- | --- |
operator | String string |
--- | --- |
client | String string |
--- | --- |
reqId | EsmRequestHeaderMapper EsmRequestHeaderMapper |
--- | --- |
req | Request Header Request Header |
--- | --- |
reqDataForPort | ESMElementaryDataModel ESMElementaryDataModel |
--- | --- |
scheduler | ESMSchedulerDataModel ESMSchedulerDataModel |
--- | --- |
elementaryDetailsList | array[ESMElementaryDataModel] ESMElementaryDataModel |
--- | --- |
schedServiceData | SchedServiceData SchedServiceData |
--- | --- |
serviceId | Long long |
--- | --- |
tpId | Long long |
--- | --- |
testSuiteId | Long long |
--- | --- |
serviceName | String string |
--- | --- |
description | String string |
--- | --- |
testCaseId | Long long |
--- | --- |
jobTaskId | Long long |
--- | --- |
taskDetailsIdentifier | String string |
--- | --- |
proSlmTestCaseList | array[String] string |
--- | --- |
proDmTestCaseList | array[String] string |
--- | --- |
clearPmCountersRequestFrom | String string |
--- | --- |
testSuiteName | String string |
--- | --- |
testCaseName | String string |
--- | --- |
portName | String string |
--- | --- |
sapId | Long long |
--- | --- |
activate | Boolean boolean |
--- | --- |
PolicyModel
Name |
Type |
Description |
Enum |
---|---|---|---|
bestPractice | Boolean boolean |
Is it a best practice policy being used | --- |
templateType | Integer integer |
--- | --- |
cirPirUnitReqd | Boolean boolean |
--- | --- |
jobTaskId | Long long |
--- | --- |
policyId | Long long |
System generated unique ID for the policy | --- |
policyName | String string |
Policy name | --- |
policyScope | Integer integer |
--- | --- |
policyType | String string |
Policy type | [None, Access, Network] |
nServiceHandle | String string |
--- | --- |
PortModel
Name |
Type |
Description |
Enum |
---|---|---|---|
tpID | Integer integer |
System generated unique identifier for a port | --- |
mclagId | Integer integer |
MCLAG ID to be used | --- |
endpointType | String string |
End point type | [PORT, LAG, MCLAG] |
accessSVLANEnabled | Boolean boolean |
Is access SVLAN enabled | --- |
shgId | Long long |
System generated ID for the SHG | --- |
shgName | String string |
SHG name if hubAndSpoke value is Leaf | --- |
neName | String string |
Network element name | --- |
portName | String string |
Port native name | --- |
accessCVLANEnabled | Boolean boolean |
Is access CVLAN enabled | --- |
accessSVLAN | String string |
Access SVLAN value | --- |
vsId | Integer integer |
--- | --- |
portType | String string |
Port type | [ACCESS, UPLINK] |
hubAndSpoke | String string |
Role of the port in Tree services | [None, Root, Leaf] |
fragmentType | Integer integer |
Whether the service is Tagged or allows all frames | --- |
accessCVLAN | String string |
Access CVLAN value | --- |
portRole | String string |
Port role | [ACCESS, UPLINK] |
shgDescription | String string |
SHG description if hubAndSpoke value is Leaf | --- |
PortPolicyModel
Name |
Type |
Description |
Enum |
---|---|---|---|
policyId | PolicyModel PolicyModel |
QoS Policy model | --- |
port | PortModel PortModel |
Port model | --- |
activate | Boolean boolean |
--- | --- |
client | String string |
--- | --- |
sessionId | String string |
--- | --- |
requestURI | String string |
--- | --- |
logReqId | String string |
--- | --- |
operator | String string |
--- | --- |
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 | --- |
SchedServiceData
Name |
Type |
Description |
Enum |
---|---|---|---|
jobName | String string |
--- | --- |
jobDesc | String string |
--- | --- |
userName | String string |
--- | --- |
trigger | SchedTriggerData SchedTriggerData |
--- | --- |
Service UI Data model
Name |
Type |
Description |
Enum |
---|---|---|---|
serviceType | String string |
Service type | [EPL, EVPL, EPLAN, EVPLAN, EPTREE, EVPTREE] |
jobTaskId | Long long |
JobTaskId | --- |
eTreeType | Integer integer |
--- | --- |
svcParams | ServiceParams ServiceParams |
service parameters | --- |
toManagementState | String string |
The target management state of the service | --- |
serviceName | String string |
Unique name for the service | --- |
shgData | N_SHGData N_SHGData |
shgData | --- |
serviceState | String string |
Service state | [In service, Out of service, Not in service, Inconsistent, partial, unknown , --] |
networkTechnology | Integer integer |
--- | --- |
targetPseudowire | String string |
Target Pseudowire name | [PRIMARY, STANDBY_1, STANDBY_2, STANDBY_3, STANDBY_4] |
switchOperationName | String string |
Switch Operation Name | [SWITCH, CLEARSWITCH] |
pmState | Integer integer |
pmState | --- |
serviceId | Long long |
Service Identifier | --- |
managementState | String string |
Current management state of the service | --- |
serviceDescr | String string |
Description for the service | --- |
ServiceDataModel
Name |
Type |
Description |
Enum |
---|---|---|---|
serviceType | String string |
Service type | [EPL, EVPL, EPLAN, EVPLAN, EPTREE, EVPTREE] |
branchSvlanId | String string |
Branch S-VLAN Id | --- |
templatePolicyName | String string |
Template Policy Name | --- |
vneScriptDataList | array[VNEScriptData] VNEScriptData |
--- | --- |
eTreeType | String string |
ETree Type | --- |
cvlanId | String string |
Customer VLAN ID | --- |
nmlLinkDataList | array[OtnInterfaceLinkUIData] OtnInterfaceLinkUIData |
OTN link wrapper model list | --- |
serviceTemplateId | Long long |
Template ID | --- |
preProvCliCmd | String string |
Pre CLI commands | --- |
description | String string |
Description for the service | --- |
hubList | array[Integer] integer |
Hub VSID list | --- |
repProf15m | String string |
15 min PM report profile | --- |
tcaProfOldName | String string |
Old TCA profile name being modified | --- |
nmlRingNameList | array[String] string |
Ring name list | --- |
pwStandby | Boolean boolean |
--- | --- |
additionalInfo | Object object |
--- | --- |
serviceOldName | String string |
Old name of the service | --- |
shgDescription | String string |
Split Horizon Group Description | --- |
mplstpAttributesData | EsmMplstpAttributesDataModel EsmMplstpAttributesDataModel |
MplstpAttributesData | --- |
cacCheck | Boolean boolean |
cacCheck | --- |
author | String string |
Author for the service | --- |
svcParams | ServiceParams ServiceParams |
Additional service parameters | --- |
shgName | String string |
Split Horizon Group Name | --- |
networkingTechnology | String string |
--- | --- |
serviceName | String string |
Unique name for the service | --- |
customerName | String string |
Customer name | --- |
targetManagementState | String string |
The target management state of the service | --- |
repProf24h | String string |
24 hour PM report profile | --- |
postProvCliCmd | String string |
Post CLI commands | --- |
trunkSvlanId | String string |
Trunk S-VLAN Id | --- |
tcaProfName | String string |
TCA profile name to be used | --- |
portQos | array[PortPolicyModel] PortPolicyModel |
Port and QoS policy wrapper | --- |
reserveResource | Boolean boolean |
Ports to be reserved | --- |
objId | Long long |
Object Id | --- |
svlanId | String string |
Subscriber VLAN ID | --- |
autoRouting | Boolean boolean |
--- | --- |
warningValidateOverride | Boolean boolean |
Warning Validation Override to Skip | --- |
tunnelDataList | array[ServiceTunnelUIData] ServiceTunnelUIData |
--- | --- |
segmentType | String string |
--- | --- |
managementState | String string |
Current management state of the service | --- |
ServiceIdResponseHolderModel
Name |
Type |
Description |
Enum |
---|---|---|---|
responseId | Response Header Model Response Header Model |
Response wrapper for operation status | --- |
rsp | Service UI Data model Service UI Data model |
Wrapper for different attribute values that were used for the service | --- |
ServiceParams
Name |
Type |
Description |
Enum |
---|---|---|---|
lacp | Integer integer |
LAPT Enabled/Disabled | [0, 1] |
l2cp | Integer integer |
L2CP Enabled/Disabled | [0, 1] |
llf | Integer integer |
LLF Enabled/Disabled | [0, 1] |
eplOp2TunnelEnabled | Integer integer |
EPL Option 2 Tunnel Enabled/Disabled | [0, 1] |
l2pt | Integer integer |
L2PT Enabled/Disabled | [0, 1] |
fragmentType | Integer integer |
Fragment Type | [0, 1] |
cvlan | String string |
CVLAN Value | --- |
vlanRangeEnabled | Integer integer |
VLAN Range Enabled/Disabled | [0, 1] |
ServiceResponseHolderModel
Name |
Type |
Description |
Enum |
---|---|---|---|
responseId | Response Header Model Response Header Model |
Response wrapper for operation status | --- |
response | ServiceDataModel ServiceDataModel |
Wrapper for different attribute values that were used for the service | --- |
ServiceTunnelUIData
Name |
Type |
Description |
Enum |
---|---|---|---|
mclagId | Integer integer |
mclag unique id for which this tunnel can be an ICB | --- |
isICB | Boolean boolean |
--- | --- |
aNEName | String string |
Node Name for Tunnel A end | --- |
orderId | Integer integer |
Tunnel Order | --- |
aVsId | Integer integer |
Tunnel A end VS id | --- |
autogenerated_ZToALabel | Integer integer |
Auto generated Service label for the tunnel : A-in , Z-out | --- |
mclagName | String string |
mclag for which this tunnel can be an ICB | --- |
autogenerated_AToZLabel | Integer integer |
Auto generated Service label for the tunnel : A-out , Z-in | --- |
priority | Integer integer |
Tunnel Priority | [0, 1, 2, 3, 4] |
lagAssn | String string |
lags of mclag to which this tunnel should be associated | --- |
zVsId | Integer integer |
Tunnel Z end VS id | --- |
lagAssnVsId | Integer integer |
--- | --- |
tunnelId | Integer integer |
Tunnel Id | --- |
tunnelName | String string |
Tunnel Name | --- |
zNEName | String string |
Node Name for Tunnel Z end | --- |
ServiceWorkflowModel
Name |
Type |
Description |
Enum |
---|---|---|---|
sessionId | String string |
--- | --- |
requestURI | String string |
--- | --- |
logReqId | String string |
--- | --- |
operator | String string |
--- | --- |
client | String string |
--- | --- |
reqId | EsmRequestHeaderMapper EsmRequestHeaderMapper |
Request header model | --- |
req | ServiceDataModel ServiceDataModel |
ESM Service data wrapper model | --- |
scheduler | ESMSchedulerDataModel ESMSchedulerDataModel |
ESM Job Scheduler model wrapper | --- |
oam | EsmOAMDataModel EsmOAMDataModel |
ESM OAM model wrapper | --- |
linkOamList | array[nLinkOamInstMapper] nLinkOamInstMapper |
--- | --- |
endToEndOamList | array[nEndToEndOamInstMapper] nEndToEndOamInstMapper |
--- | --- |
oamConfigured | Boolean boolean |
Is OAM to be configured | --- |
pmSelectionEPL | Integer integer |
PM data collection | --- |
nRateData | array[ServiceAggrMeterDataModel] ServiceAggrMeterDataModel |
Aggregate Meter and Egress Rate model | --- |
nEthIfDetails | N_EthIfDetails N_EthIfDetails |
Ethernet Interface Parameters | --- |
nEthIbmAddlInfo | EthIBMServiceAddlInfo EthIBMServiceAddlInfo |
ESM Eth IBM Service Details model wrapper | --- |
activate | Boolean boolean |
--- | --- |
VNEDataList
Name |
Type |
Description |
Enum |
---|---|---|---|
vneDataList | array[VNEScriptDataModel] VNEScriptDataModel |
--- | --- |
items | array[VNEScriptDataModel] VNEScriptDataModel |
--- | --- |