Operation
post /esmService/packetSwitch/deletePacketSwitchRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | required | Packet Switch data | PacketSwitchWorkflowModel |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
PacketSwitchRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Example Request Data
{"scheduler":{"trigger":{"name":"PacketSwitch_Delete_NODE1-PS-4_Mon Jan 29 2018 12:07:39 UTC+5:30Trigger","deployNow":"Yes","type":"","expression":"","timeOffset":""},"username":"alcatel","jobName":"PacketSwitch_Delete_NODE1-PS-4_Mon Jan 29 2018 12:07:39 UTC+5:30","jobDescription":""},"req":{"psId":"4","vsId":42,"neName":"NODE1"}}
Produces
application/json
Example Response Data
{"responseId":{"req":null,"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Success","opMsg":"","msgCode":"PACKET_SWITCH_DELETE_SUCCESS_MESSAGE_0001","parameters":[null],"paramCount":1,"objectId":42,"jobName":"PacketSwitch_Delete_NODE1-PS-4_Mon Jan 29 2018 12:07:39 UTC+5:30","objectType":32}}
External Docs
Operation
post /esmService/packetSwitch/forceDeployServiceService 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
post /esmService/packetSwitch/modifyPacketSwitchRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | required | Packet Switch data | PacketSwitchWorkflowModel |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
PacketSwitchRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Example Request Data
{"reqId":{},"req":{"packetSwitchDescr":"","packetSwitchName":"NODE3-PS-1","syncEEnabled":1,"lacpSystemPriority":"32788","faultManagementMode":"IEEE","vsId":56,"neId":47,"psId":1,"neName":"NODE3"},"scheduler":{"trigger":{"name":"Packet_SwitchOPERATE_NODE3-PS-1_Mon Jan 29 2018 12:11:32 UTC+5:30Trigger","deployNow":"Yes","type":"","expression":"","timeOffset":""},"username":"alcatel","jobName":"Packet_SwitchOPERATE_NODE3-PS-1_Mon Jan 29 2018 12:11:32 UTC+5:30","jobDescription":""}}
Produces
application/json
Example Response Data
{"responseId":{"req":null,"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Success","opMsg":"","msgCode":"PACKET_SWITCH_MODIFY_SUCCESS_MESSAGE_0001","parameters":["NODE3-PS-1"],"paramCount":1,"objectId":56,"jobName":"Packet_SwitchOPERATE_NODE3-PS-1_Mon Jan 29 2018 12:11:32 UTC+5:30","objectType":32}}
External Docs
Operation
post /esmService/packetSwitch/resetPacketSwitchRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | required | Packet Switch data | PacketSwitchWorkflowModel |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
PacketSwitchRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Example Request Data
{"scheduler": {"trigger": {"name": "PacketSwitch_RESET_65_176-PS-99_Mon Jan 08 2018 10:59:49 UTC+5:30Trigger","deployNow": "Yes","type": "","expression": "","timeOffset": ""},"username": "alcatel","jobName": "PacketSwitch_RESET_65_176-PS-99_Mon Jan 08 2018 10:59:49 UTC+5:30","jobDescription": ""},"req": {"psId": "99","vsId": 16,"neName": "65_176","reset": "warmReset"}}
Produces
application/json
Example Response Data
{"responseId": {"req": null,"errorReason": null,"errorCode": null,"message": null,"cmdStatus": "Success","opMsg": "","msgCode": "PACKET_SWITCH_RESET_SUCCESS_MESSAGE_0001","parameters": [],"paramCount": 0,"objectId": 16,"jobName": "PacketSwitch_RESET_65_176-PS-99_Mon Jan 08 2018 10:59:49 UTC+5:30","objectType": 32}}
External Docs
Operation
post /esmService/packetSwitch/schedulePacketSwitchDeployThe entities that wil be created on the NE during packet switch deployment are (in order):
PRE CLI commands(if provided)
Packet Card 1
Packet Card 2 , Uplink Card 1 and Uplink Card 2 (if Provided)
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | required | Packet Switch data | PacketSwitchWorkflowModel |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
PacketSwitchRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Example Request Data
{"reqId":{},"req":{"packetSwitchName":"PS1","packetSwitchDescr":"","packetSwitchAuthor":"alcatel","operationalMode":"Provider Bridge","neName":"NODE1","packetCard1VsId":10,"preProvCliCmd":"","postProvCliCmd":""},"scheduler":{"trigger":{"name":"Packet_SwitchDEPLOY_PS1_Mon Jan 29 2018 13:10:11 UTC+5:30Trigger","deployNow":"Yes","type":"","expression":"","timeOffset":""},"username":"alcatel","jobName":"Packet_SwitchDEPLOY_PS1_Mon Jan 29 2018 13:10:11 UTC+5:30","jobDescription":""}}
Produces
application/json
Example Response Data
{"responseId":{"req":null,"errorReason":null,"errorCode":null,"message":null,"cmdStatus":"Success","opMsg":"","msgCode":"PACKET_SWTICH_DEPLOY_SUCCESS_001","parameters":["PS1"],"paramCount":1,"objectId":58,"jobName":"Packet_SwitchDEPLOY_PS1_Mon Jan 29 2018 13:10:11 UTC+5:30","objectType":32}}
External Docs
Operation
put /esmService/packetSwitch/updateSystemProperties/{name}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| name | required | name of the property | --- |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | required | value of the property | String |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
Response Header Model
|
| 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] |
| mdName | String string |
OAM maintenance domain name | [NONE] |
| maInst | EsmOamMADataModel EsmOamMADataModel |
OAM maintenance association wrapper | --- |
| slmTsData | nTestSuiteTempData nTestSuiteTempData |
--- | --- |
| dmTsData | nTestSuiteTempData nTestSuiteTempData |
--- | --- |
| 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 |
--- | --- |
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 |
--- | --- |
| mdName | String string |
--- | --- |
| 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 |
--- | --- |
| slmTsData | nTestSuiteTempData nTestSuiteTempData |
--- | --- |
| dmTsData | nTestSuiteTempData nTestSuiteTempData |
--- | --- |
| 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 |
--- | --- |
| subnetIdList | array[Long] long |
--- | --- |
| 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 | --- |
nTestSuiteTempData
Name |
Type |
Description |
Enum |
|---|---|---|---|
| testSuiteName | String string |
--- | --- |
| testSuiteType | String string |
--- | [TWO_WAY_DM, TWO_WAY_SLM, LINK_PATH_TRACE, LOOPBACK, TWO_WAY_SLM_PRO, TWO_WAY_DM_PRO, LSP_PING, LSP_TRACE, VCCV_PING, VCCV_TRACE, TWO_WAY_LM] |
| author | String string |
--- | --- |
| forwardClass | String string |
--- | --- |
| dataSize | String string |
--- | --- |
| forwardingClass | String string |
--- | --- |
| interval | String string |
--- | --- |
| managementState | String string |
--- | --- |
| timeOut | String string |
--- | --- |
| flrInterval_15min | String string |
--- | --- |
| flrInterval_1day | String string |
--- | --- |
| flrIntervals | String string |
--- | --- |
| flrThreshold | String string |
--- | --- |
| priority | String string |
--- | --- |
| sendCount | String string |
--- | --- |
| timeToLive | String string |
--- | --- |
| vlanPriority | String string |
--- | --- |
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] |
| sinkNeModel | String string |
--- | --- |
| srcNodeID | String string |
--- | --- |
| srcNeModel | 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 |
--- | --- |
Packet Switchdata holder
Name |
Type |
Description |
Enum |
|---|---|---|---|
| psId | Integer integer |
--- | --- |
| neId | Integer integer |
--- | --- |
| vsId | Long long |
--- | --- |
| packetSwitchName | String string |
Unique name for the packet switch | --- |
| packetSwitchDescr | String string |
Description for the packet switch | --- |
| packetSwitchAuthor | String string |
Author for the packet switch | --- |
| operationalMode | String string |
Operational Mode | --- |
| neName | String string |
NE Name | --- |
| packetCard1VsId | Long long |
Packet Card 1 VSID | --- |
| uplinkCard1VsId | Long long |
Packet Card 1 VSID | --- |
| packetCard2VsId | Long long |
Packet Card 1 VSID | --- |
| uplinkCard2VsId | Long long |
Packet Card 1 VSID | --- |
| preProvCliCmd | String string |
Pre CLI commands | --- |
| postProvCliCmd | String string |
Post CLI commands | --- |
| provisionedBPPortList | array[String] string |
Provisioned BP Port List | --- |
| uplinkCard1Name | String string |
Uplink Card 1 Name | --- |
| packetCard1Name | String string |
Packet Card 1 Name | --- |
| packetCard2Name | String string |
Packet Card 2 Name | --- |
| uplinkCard2Name | String string |
Uplink Card 2 Name | --- |
| syncEEnabled | Integer integer |
Sync E Enabled | --- |
| lacpSystemPriority | Long long |
LACP System Priority | --- |
| faultManagementMode | String string |
faultManagementMode | --- |
| newPacketSwitchName | String string |
New Packet Switch Name | --- |
| reset | String string |
--- | --- |
| shelfData | String string |
Shelf ID for the Mixed Mode packet switch | --- |
| localAge | Long long |
Local Age | --- |
| switchControllerState | Integer integer |
switchControllerState | --- |
PacketSwitchRespHolder
Name |
Type |
Description |
Enum |
|---|---|---|---|
| responseId | Response Header Model Response Header Model |
--- | --- |
PacketSwitchWorkflowModel
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 | Packet Switchdata holder Packet Switchdata holder |
ESM Packet Switch data wrapper model | --- |
| scheduler | ESMSchedulerDataModel ESMSchedulerDataModel |
ESM Job Scheduler model wrapper | --- |
| jobTaskId | Long long |
--- | --- |
| activate | Boolean boolean |
--- | --- |
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 |
|---|---|---|---|
| encapType | String string |
--- | --- |
| role | Integer integer |
--- | --- |
| portControl | Integer integer |
--- | --- |
| neName | String string |
Network element name | --- |
| portName | String string |
Port native name | --- |
| accessCVLANEnabled | Boolean boolean |
Is access CVLAN enabled | --- |
| vsId | Integer integer |
--- | --- |
| fragmentType | Integer integer |
Whether the service is Tagged or allows all frames | --- |
| accessCVLAN | String string |
Access CVLAN value | --- |
| shgDescription | String string |
SHG description if hubAndSpoke value is Leaf | --- |
| tpID | Integer integer |
System generated unique identifier for a port | --- |
| mclagId | Integer integer |
MCLAG ID to be used | --- |
| mapperPayLoadLength | Long long |
--- | --- |
| 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 | --- |
| portRate | String string |
--- | --- |
| accessSVLAN | String string |
Access SVLAN value | --- |
| portType | String string |
Port type | [ACCESS, UPLINK] |
| mappingType | Integer integer |
--- | --- |
| presTimeOffsetFs | Long long |
--- | --- |
| demapperPayLoadLength | Long long |
--- | --- |
| hubAndSpoke | String string |
Role of the port in Tree services | [None, Root, Leaf] |
| portRole | String string |
Port role | [ACCESS, UPLINK] |
| presTimeOffsetNs | Long long |
--- | --- |
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] |
| asymmetric | Integer integer |
--- | --- |
| 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 | --- |
| healthCheckConfigured | Boolean boolean |
Is health check to be configured | --- |
| hcInterval | Long long |
--- | --- |
| preemptCheckConfigured | Boolean boolean |
Is Preempt check to be configured | --- |
| onlyPreemptConfigured | Boolean boolean |
--- | --- |
| 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 | --- |
| asymmetrciLinkId | Integer integer |
--- | --- |
| nonPsdTpIdForAsymmetricLink | Integer integer |
--- | --- |
| svcSapType | String string |
--- | --- |
| psdTpIdForAsymmetricLink | Integer integer |
--- | --- |
| noOfLinksInReqForAsym | Integer integer |
--- | --- |
| asymmetricEvpl | Boolean boolean |
--- | --- |
| activate | Boolean boolean |
--- | --- |