Operation
post /esmBrowser/SAT/deploySAT/Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | reqData | SATTemplateDataHolder |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
N_ServiceIdRespHolder
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
get /esmBrowser/SAT/getAllAvailablePortForLoopback/{NENAME}/{PACKNAME}/{excludeTpidList}/{virtualTpName}/{forLoopback}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| nENAME | required | NENAME | --- |
| pACKNAME | required | PACKNAME | --- |
| excludeTpidList | required | excludeTpidList | --- |
| forLoopback | required | forLoopback | --- |
| virtualTpName | required | virtualTpName | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
PortDetailsList
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
get /esmBrowser/SAT/getAllAvailablePortForTestHeadCreation/{NENAME}/{PACKNAME}/{excludeTpidList}/{virtualTpName}/{forLoopback}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| nENAME | required | NENAME | --- |
| pACKNAME | required | PACKNAME | --- |
| excludeTpidList | required | excludeTpidList | --- |
| forLoopback | required | forLoopback | --- |
| virtualTpName | required | virtualTpName | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
PortDetailsList
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
get /esmBrowser/SAT/getAllSATAcceptanceCriteriaByProfileIdAndVSID/{profileId}/{vsId}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| profileId | required | profileId | --- |
| vsId | required | vsId | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
SATAcceptanceCriteriaUIData
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
get /esmBrowser/SAT/getAllSATDetailsfromServiceId/{svcId}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| svcId | required | svcId | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
SATDetailsUIData
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
get /esmBrowser/SAT/getAllSATDetailsfromServiceName/{svcName}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| svcName | required | svcName | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
SATDetailsUIData
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
get /esmBrowser/SAT/getAllSATPayloadByProfileIdAndVSID/{profileId}/{vsId}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| profileId | required | profileId | --- |
| vsId | required | vsId | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
SATFramePayloadUIData
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
get /esmBrowser/SAT/getAllSATPortselectionNEFEBySatName/{satName}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| satName | required | satName | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
SATPortSelectionUIData
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
get /esmBrowser/SAT/getAllSATProfilesByServiceId/{svcId}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| svcId | required | svcId | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
SATTestHeadProfileUIData
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
get /esmBrowser/SAT/getAllSATProfilesByServiceName/{svcName}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| svcName | required | svcName | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
SATTestHeadProfileUIData
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
get /esmBrowser/SAT/getAllSATProfilesByVSID/{vsId}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| vsId | required | vsId | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
SATTestHeadProfileUIData
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
get /esmBrowser/SAT/getAllSATresultsFromServiceId/{svcId}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| svcId | required | svcId | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
SATResultUIData
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
get /esmBrowser/SAT/getAllSATresultsFromServiceName/{svcName}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| svcName | required | svcName | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
SATResultUIData
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
get /esmBrowser/SAT/GetSATAssnDetailsByProfileIdAndVsId/{profileId}/{vsId}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| profileId | required | profileId | --- |
| vsId | required | vsId | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
SATUIDataList
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
get /esmBrowser/SAT/getSatDetailsForTemplate/{satName}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| satName | required | satName | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
SATTemplateDataHolder
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
get /esmBrowser/SAT/getServiceEndPointForSAT/{serviceName}/{selectedPort}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| serviceName | required | serviceName | --- |
| selectedPort | required | selectedPort | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
ServiceEndPointsList
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
get /esmBrowser/SAT/getServiceNetworkPortForSAT/{serviceName}/{NENAME}/{PACKNAME}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| serviceName | required | serviceName | --- |
| nENAME | required | NENAME | --- |
| pACKNAME | required | PACKNAME | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
PortDetailsList
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
Operation
get /esmBrowser/SAT/isSATonAServiceWithLagOrMacLagEp/{serviceName}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| serviceName | required | serviceName | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
Boolean
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json
External Docs
AcceptanceCriteria
Name |
Type |
Description |
Enum |
|---|---|---|---|
| cirThreshold | Long long |
--- | --- |
| cirThresholdUnits | String string |
--- | --- |
| pirThreshold | Long long |
--- | --- |
| pirThresholdUnits | String string |
--- | --- |
| latencyRisingThreshold | String string |
--- | --- |
| latencyRisingThresholdIn | String string |
--- | --- |
| latencyRisingThresholdOut | String string |
--- | --- |
| jitterRisingThreshold | String string |
--- | --- |
| jitterRisingThresholdIn | String string |
--- | --- |
| jiterRisingThresholdOut | String string |
--- | --- |
| lossRisingThreshold | String string |
--- | --- |
| lossRisingThresholdIn | String string |
--- | --- |
| lossRisingThresholdOut | String string |
--- | --- |
| satACID | Long long |
--- | --- |
| satAsscdProfileId | Long long |
--- | --- |
| satVsId | Long long |
--- | --- |
| id | String string |
--- | --- |
| key | String string |
--- | --- |
| className | String string |
--- | --- |
N_ServiceId
Name |
Type |
Description |
Enum |
|---|---|---|---|
| managementState | String string |
--- | --- |
| toManagementState | String string |
--- | --- |
| serviceName | String string |
--- | --- |
| serviceDescr | String string |
--- | --- |
| serviceType | String string |
--- | --- |
| serviceState | String string |
--- | --- |
| serviceId | Long long |
--- | --- |
| jobTaskId | Long long |
--- | --- |
| pmState | Integer integer |
--- | --- |
| shgData | N_SHGData N_SHGData |
--- | --- |
| eTreeType | Integer integer |
--- | --- |
| svcParams | ServiceParams ServiceParams |
--- | --- |
| networkTechnology | Integer integer |
--- | --- |
| switchOperationName | String string |
--- | --- |
| targetPseudowire | String string |
--- | --- |
N_ServiceIdRespHolder
Name |
Type |
Description |
Enum |
|---|---|---|---|
| responseId | ResponseHeader ResponseHeader |
--- | --- |
| rsp | N_ServiceId N_ServiceId |
--- | --- |
PayLoad
Name |
Type |
Description |
Enum |
|---|---|---|---|
| payloadType | String string |
--- | --- |
| dataPattern | String string |
--- | --- |
| etherType | String string |
--- | --- |
| satPayloadId | Long long |
--- | --- |
| satAsscdProfileId | Long long |
--- | --- |
| satVsId | Long long |
--- | --- |
| id | String string |
--- | --- |
| key | String string |
--- | --- |
| className | String string |
--- | --- |
PortDetails
Name |
Type |
Description |
Enum |
|---|---|---|---|
| portName | String string |
--- | --- |
| tpId | Integer integer |
--- | --- |
| autoNeg | String string |
--- | --- |
| duplexMode | String string |
--- | --- |
| neId | Integer integer |
--- | --- |
| portRate | String string |
--- | --- |
| neVersion | String string |
--- | --- |
| portState | String string |
--- | --- |
| portMacAddress | String string |
--- | --- |
| id | String string |
--- | --- |
| portPrimaryState | String string |
--- | --- |
| priority | Integer integer |
--- | --- |
PortDetailsList
Name |
Type |
Description |
Enum |
|---|---|---|---|
| portDetails | array[PortDetails] PortDetails |
--- | --- |
| items | array[PortDetails] PortDetails |
--- | --- |
PortSelection
Name |
Type |
Description |
Enum |
|---|---|---|---|
| nearEndAccessPoint | String string |
--- | --- |
| testHead | String string |
--- | --- |
| nearEndLoopback | String string |
--- | --- |
| nearEndSrcMacAddress | String string |
--- | --- |
| nearEndDestAddress | String string |
--- | --- |
| farEndAccessPoint | String string |
--- | --- |
| farEndLoopback | String string |
--- | --- |
| farEndSrcMacAddress | String string |
--- | --- |
| farEndDestMacAddress | String string |
--- | --- |
ResponseHeader
Name |
Type |
Description |
Enum |
|---|---|---|---|
| req | RequestHeader RequestHeader |
--- | --- |
| errorReason | String string |
--- | --- |
| errorCode | String string |
--- | --- |
| message | String string |
--- | --- |
| cmdStatus | String string |
--- | --- |
| opMsg | String string |
--- | --- |
| msgCode | String string |
--- | --- |
| parameters | array[String] string |
--- | --- |
| paramCount | Integer integer |
--- | --- |
| objectId | Integer integer |
--- | --- |
| jobName | String string |
--- | --- |
| objectType | Integer integer |
--- | --- |
SATAcceptanceCriteriaUIData
Name |
Type |
Description |
Enum |
|---|---|---|---|
| acList | array[AcceptanceCriteria] AcceptanceCriteria |
--- | --- |
| items | array[AcceptanceCriteria] AcceptanceCriteria |
--- | --- |
SATDetailsUI
Name |
Type |
Description |
Enum |
|---|---|---|---|
| satSvcName | String string |
--- | --- |
| satName | String string |
--- | --- |
| satDesc | String string |
--- | --- |
| satcreateTime | Long long |
--- | --- |
| satAuth | String string |
--- | --- |
| satColorAware | String string |
--- | --- |
| satForwClass | String string |
--- | --- |
| satProfId | Long long |
--- | --- |
| satPayldId | Long long |
--- | --- |
| satAccCrtId | Long long |
--- | --- |
| satrunState | String string |
--- | --- |
| satnmlSvcId | Long long |
--- | --- |
| satnmlTestId | Long long |
--- | --- |
| satRunId | Integer integer |
--- | --- |
| vsId | Long long |
--- | --- |
| hours | String string |
--- | --- |
| minites | String string |
--- | --- |
| seconds | String string |
--- | --- |
| id | String string |
--- | --- |
| key | String string |
--- | --- |
| className | String string |
--- | --- |
SATDetailsUIData
Name |
Type |
Description |
Enum |
|---|---|---|---|
| satDetailsUIList | array[SATDetailsUI] SATDetailsUI |
--- | --- |
| items | array[SATDetailsUI] SATDetailsUI |
--- | --- |
SATPortSelectionUIData
Name |
Type |
Description |
Enum |
|---|---|---|---|
| items | array[SATPortsUI] SATPortsUI |
--- | --- |
SATPortsUI
Name |
Type |
Description |
Enum |
|---|---|---|---|
| satAccEndpntNE | String string |
--- | --- |
| satTestHead | String string |
--- | --- |
| satLoopBackNE | String string |
--- | --- |
| satSrcMacAddrsNE | String string |
--- | --- |
| satDestMacAddrsNE | String string |
--- | --- |
| satAccEndpntFE | String string |
--- | --- |
| satLoopBackFE | String string |
--- | --- |
| satSrcMacAddrsFE | String string |
--- | --- |
| satDestMacAddrsFE | String string |
--- | --- |
| id | String string |
--- | --- |
| key | String string |
--- | --- |
| className | String string |
--- | --- |
SATResults
Name |
Type |
Description |
Enum |
|---|---|---|---|
| rtestName | String string |
--- | --- |
| rprofId | Long long |
--- | --- |
| rpayId | Long long |
--- | --- |
| rACId | Long long |
--- | --- |
| rstartTime | String string |
--- | --- |
| rendTime | String string |
--- | --- |
| rAvgTime | String string |
--- | --- |
| rStoped | String string |
--- | --- |
| rCompletd | String string |
--- | --- |
| rinjected | Double double |
--- | --- |
| rreceived | Double double |
--- | --- |
| rmin | Long long |
--- | --- |
| rmax | Long long |
--- | --- |
| ravg | Long long |
--- | --- |
| rjitter | Integer integer |
--- | --- |
| rconfig | String string |
--- | --- |
| roper | String string |
--- | --- |
| rmeasued | String string |
--- | --- |
| rflrnconfig | Integer integer |
--- | --- |
| rflrmeasured | Integer integer |
--- | --- |
| rflraccptd | String string |
--- | --- |
| rlatnconfig | Integer integer |
--- | --- |
| rlatnmeasured | Long long |
--- | --- |
| rlataccptd | String string |
--- | --- |
| rjitterconfig | Integer integer |
--- | --- |
| rjittermeasured | Integer integer |
--- | --- |
| rjitteraccptd | String string |
--- | --- |
| sapIdName | String string |
--- | --- |
| forwardingClass | String string |
--- | --- |
| colorAwareTest | String string |
--- | --- |
| id | String string |
--- | --- |
| key | String string |
--- | --- |
| className | String string |
--- | --- |
SATResultUIData
Name |
Type |
Description |
Enum |
|---|---|---|---|
| items | array[SATResults] SATResults |
--- | --- |
SATTemplateDataHolder
Name |
Type |
Description |
Enum |
|---|---|---|---|
| sessionId | String string |
--- | --- |
| requestURI | String string |
--- | --- |
| logReqId | String string |
--- | --- |
| operator | String string |
--- | --- |
| client | String string |
--- | --- |
| id | Long long |
--- | --- |
| templateId | Long long |
--- | --- |
| templateName | String string |
--- | --- |
| author | String string |
--- | --- |
| desc | String string |
--- | --- |
| templateState | String string |
--- | --- |
| templatePath | String string |
--- | --- |
| createTime | Long long |
--- | --- |
| modifyTime | Long long |
--- | --- |
| colourAware | Integer integer |
--- | --- |
| forwardingClass | String string |
--- | --- |
| serviceName | String string |
--- | --- |
| testPorfile | TestProfile TestProfile |
--- | --- |
| payLoad | PayLoad PayLoad |
--- | --- |
| acceptanceCriteria | AcceptanceCriteria AcceptanceCriteria |
--- | --- |
| portSelection | PortSelection PortSelection |
--- | --- |
| schedServiceData | SchedServiceData SchedServiceData |
--- | --- |
| activate | Boolean boolean |
--- | --- |
SATTestHeadProfileUIData
Name |
Type |
Description |
Enum |
|---|---|---|---|
| profileList | array[TestProfile] TestProfile |
--- | --- |
| items | array[TestProfile] TestProfile |
--- | --- |
SATUIData
Name |
Type |
Description |
Enum |
|---|---|---|---|
| nmlTestId | Long long |
--- | --- |
| testName | String string |
--- | --- |
| author | String string |
--- | --- |
| description | String string |
--- | --- |
| forwardingClass | String string |
--- | --- |
| isColorAware | String string |
--- | --- |
| remark | String string |
--- | --- |
| createTime | String string |
--- | --- |
| lastUpdateTime | String string |
--- | --- |
| vsId | Long long |
--- | --- |
| runId | Long long |
--- | --- |
| satProfileId | Long long |
--- | --- |
| satPayloadId | Long long |
--- | --- |
| satACID | Long long |
--- | --- |
| satSAPID | Long long |
--- | --- |
| satSAPName | String string |
--- | --- |
| runState | String string |
--- | --- |
| objectScope | String string |
--- | --- |
| nmlServiceId | Long long |
--- | --- |
| asscdServiceName | String string |
--- | --- |
| id | String string |
--- | --- |
| key | String string |
--- | --- |
| className | String string |
--- | --- |
| satProfileIdUI | Long long |
--- | --- |
SchedServiceData
Name |
Type |
Description |
Enum |
|---|---|---|---|
| jobName | String string |
--- | --- |
| jobDesc | String string |
--- | --- |
| userName | String string |
--- | --- |
| trigger | SchedTriggerData SchedTriggerData |
--- | --- |
ServiceEndPoints
Name |
Type |
Description |
Enum |
|---|---|---|---|
| encapType | String string |
--- | --- |
| ethManPort | String string |
--- | --- |
| portRate | String string |
--- | --- |
| vsId | Integer integer |
--- | --- |
| noOfServicesDeployed | Integer integer |
--- | --- |
| remainingDeployableServiceCount | Integer integer |
--- | --- |
| vsName | String string |
--- | --- |
| endpointType | Integer integer |
--- | --- |
| mclagid | Long long |
--- | --- |
| mclagName | String string |
--- | --- |
| shgCreated | Boolean boolean |
--- | --- |
| shgId | Integer integer |
--- | --- |
| shgName | String string |
--- | --- |
| shgDescription | String string |
--- | --- |
| hubSpoke | String string |
--- | --- |
| ingrsEMLVALUE | String string |
--- | --- |
| egrsEMLVALUE | String string |
--- | --- |
| primaryState | String string |
--- | --- |
| userLabel | String string |
--- | --- |
| portDescription | String string |
--- | --- |
| id | String string |
--- | --- |
| key | String string |
--- | --- |
| className | String string |
--- | --- |
| vne | Boolean boolean |
--- | --- |
| packetSwitch | Boolean boolean |
--- | --- |
| macAddress | String string |
--- | --- |
| neVersionR12 | Boolean boolean |
--- | --- |
ServiceEndPointsList
Name |
Type |
Description |
Enum |
|---|---|---|---|
| items | array[ServiceEndPoints] ServiceEndPoints |
--- | --- |
TestProfile
Name |
Type |
Description |
Enum |
|---|---|---|---|
| dot1pInprofile | Integer integer |
--- | --- |
| dot1pOutprofile | Integer integer |
--- | --- |
| cirRate | Long long |
--- | --- |
| cirRateUnits | String string |
--- | --- |
| pirRate | Long long |
--- | --- |
| pirRatUnits | String string |
--- | --- |
| adaptationRule | String string |
--- | --- |
| frameSize | Integer integer |
--- | --- |
| hours | String string |
--- | --- |
| minites | String string |
--- | --- |
| seconds | String string |
--- | --- |
| satProfileId | Long long |
--- | --- |
| satVsId | Long long |
--- | --- |
| timeDurationStr | String string |
--- | --- |
| id | String string |
--- | --- |
| key | String string |
--- | --- |
| className | String string |
--- | --- |
| satProfileIdUI | Long long |
--- | --- |