Operation

put /data/eml/NE/AbortAutoDiscovery/{neGroupId_neId_userLabel}
Abort Auto-Discovery (abortAutoDiscovery : /data/eml/NE/AbortAutoDiscovery/{neGroupId_neId_userLabel})
Sends request to OAM to stop the already initiated Auto-Discovery.

Path parameters

Name

IsRequired

Description

Enum

neGroupIdNeIdUserLabel required EmlGroupID_EmlNeId_NeUserLabel ---

Return type
  • inline_response_200
  • Responses

    Response Messages

    Schema

    200success inline_response_200
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    /data/eml/NE/AbortAutoDiscovery/103_236_PSS8-100-62-104

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    {"Response":"Successfully aborted","requestId":"4753734890450516"}

    External Docs
    See Also :

    Operation

    put /emlnemgr/NE/AbortAutoDiscovery/{neGroupId_neId_userLabel}
    Abort Auto-Discovery (abortAutoDiscovery : /emlnemgr/NE/AbortAutoDiscovery/{neGroupId_neId_userLabel})
    Sends request to OAM to stop the already initiated Auto-Discovery.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neGroupIdNeIdUserLabel required EmlGroupID_EmlNeId_NeUserLabel ---

    Return type
  • inline_response_200
  • Responses

    Response Messages

    Schema

    200success inline_response_200
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    /emlnemgr/NE/AbortAutoDiscovery/103_236_PSS8-100-62-104

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    {"Response":"Successfully aborted","requestId":"4753734890450516"}

    External Docs
    See Also :

    Operation

    post /data/eml/NODE
    Add Node (addNode : /data/eml/NODE)
    Can add 1830PSS, 1830PSS-4, 1830PSS-1 family, TDMX, TDMXC, 1626-LM, GEN NE, SLTE.
    Can create compound Node as well, including PHN+OCS+TDMX/C, or any combination with these NEs.
    (If trying to create compound node with TDMX/C then either a PHn or an OCS should be present in the node.)
    Can add Cluster Association also.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional nodeInfoMap List[Map«string,string»] ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    REST call: /data/eml/NODE Request Payload: [ { "version": "9.0", "address": "55.6.77.71", "secondaryIPAddress": "", "partnerAddress": "55.6.77.7", "userName": "admin", "password": "admin", "snmpVersion": "V2C", "v2readCommunity": "nms_snmp", "v2writeCommunity": "nms_snmp", "neType": "1830PSS", "neGroupId": "100", "acd": "unknown", "userLabel": "testReqResp", "location": "QW", "comments": "", "subType": "PHN", "operation": "add", "associatedPHNNEIpAddresses": "test-dual:4.2.4.32;finally:55.4.3.65", "associatedOCSNEIpAddresses": "testReqResp#OCS:55.6.77.7", "containsAssociation": "containsAssociation" }, { "version": "9.0", "TID": "testReqResp", "address": "55.6.77.7", "partnerAddress": "55.6.77.71", "userName": "admin", "password": "admin", "snmpVersion": "V3", "secuLevel": "authPriv", "usmUser": "v3DefaultUser", "usmAuthPwd": "v3DefAuthPass", "usmPrivPwd": "v3DefPrivPass", "authMethod": "HMAC-MD5", "privMethod": "AES-128", "SecureComm": "SSH2", "ssh2pubKey": "DEFAULT", "neType": "1830PSS", "neGroupId": "100", "acd": "unknown", "userLabel": "testReqResp#OCS", "location": "QW", "comments": "", "subType": "OCS", "operation": "add" }, { "operation": "modify", "userLabel": "test-dual", "address": "4.2.4.32", "associatedNE": "associatedNE", "neType": "1830PSS", "associatedPHNNEIpAddresses": "testReqResp:55.6.77.71", "supervisionState": "declared", "neGroupId": 101, "neId": 405 }, { "operation": "modify", "userLabel": "finally", "address": "55.4.3.65", "associatedNE": "associatedNE", "neType": "1830PSS", "associatedPHNNEIpAddresses": "testReqResp:55.6.77.71;TEST-IBUG:103.1.2.3;SITE-E-1:135.104.237.10", "supervisionState": "declared", "neGroupId": 100, "neId": 574, "associatedOCSNEIpAddresses": "overrideOCS#OCS:12.33.4.57" } ]

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    [ { "version": "9.0", "address": "55.6.77.71", "secondaryIPAddress": "", "partnerAddress": "55.6.77.7", "userName": "admin", "password": "IYsIiiNKi9s=", "snmpVersion": "V2C", "v2readCommunity": "7bQQKtdLyaIDXPlrbuermA==", "v2writeCommunity": "7bQQKtdLyaIDXPlrbuermA==", "neType": "1830PSS", "neGroupId": "100", "acd": "unknown", "userLabel": "testReqResp", "location": "QW", "comments": "", "subType": "PHN", "operation": "add", "associatedPHNNEIpAddresses": "test-dual:4.2.4.32;finally:55.4.3.65", "associatedOCSNEIpAddresses": "testReqResp#OCS:55.6.77.7", "containsAssociation": "containsAssociation", "listOfNTPIPs": "135.250.70.66", "ntpEnabled": "true", "reachability": "UNREACHABLE", "neId": "674", "id": "100_674", "supervisionState": "DECLARED", "alarmStatus": "CLEARED" }, { "version": "9.0", "TID": "testReqResp", "address": "55.6.77.7", "partnerAddress": "55.6.77.71", "userName": "admin", "password": "IYsIiiNKi9s=", "snmpVersion": "V3", "secuLevel": "authPriv", "usmUser": "v3DefaultUser", "usmAuthPwd": "JNjV/HbYK9qfkWSjIMc5og==", "usmPrivPwd": "Exkja5GumJd9iBzJkWaayw==", "authMethod": "HMAC-MD5", "privMethod": "AES-128", "SecureComm": "SSH2", "ssh2pubKey": "DEFAULT", "neType": "1830PSS", "neGroupId": "100", "acd": "unknown", "userLabel": "testReqResp#OCS", "location": "QW", "comments": "", "subType": "OCS", "operation": "add", "listOfNTPIPs": "135.250.70.66", "ntpEnabled": "true", "reachability": "UNREACHABLE", "neId": "675", "id": "100_675", "supervisionState": "DECLARED", "alarmStatus": "CLEARED" }, { "operation": "modify", "userLabel": "finally", "address": "55.4.3.65", "associatedNE": "associatedNE", "neType": "1830PSS", "associatedPHNNEIpAddresses": "testReqResp:55.6.77.71;TEST-IBUG:103.1.2.3;SITE-E-1:135.104.237.10", "supervisionState": "declared", "neGroupId": "100", "neId": "574", "associatedOCSNEIpAddresses": "overrideOCS#OCS:12.33.4.57", "operationStatus": "success" }, { "operation": "modify", "userLabel": "test-dual", "address": "4.2.4.32", "associatedNE": "associatedNE", "neType": "1830PSS", "associatedPHNNEIpAddresses": "testReqResp:55.6.77.71", "supervisionState": "declared", "neGroupId": "101", "neId": "405", "operationStatus": "success" } ]

    External Docs
    See Also :

    Operation

    post /emlnemgr/NODE
    Add Node (addNode : /emlnemgr/NODE)
    Can add 1830PSS, 1830PSS-4, 1830PSS-1 family, TDMX, TDMXC, 1626-LM, GEN NE, SLTE.
    Can create compound Node as well, including PHN+OCS+TDMX/C, or any combination with these NEs.
    (If trying to create compound node with TDMX/C then either a PHn or an OCS should be present in the node.)
    Can add Cluster Association also.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional nodeInfoMap List[Map«string,string»] ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    REST call: /emlnemgr/NODE Request Payload: [ { "version": "9.0", "address": "55.6.77.71", "secondaryIPAddress": "", "partnerAddress": "55.6.77.7", "userName": "admin", "password": "admin", "snmpVersion": "V2C", "v2readCommunity": "nms_snmp", "v2writeCommunity": "nms_snmp", "neType": "1830PSS", "neGroupId": "100", "acd": "unknown", "userLabel": "testReqResp", "location": "QW", "comments": "", "subType": "PHN", "operation": "add", "associatedPHNNEIpAddresses": "test-dual:4.2.4.32;finally:55.4.3.65", "associatedOCSNEIpAddresses": "testReqResp#OCS:55.6.77.7", "containsAssociation": "containsAssociation" }, { "version": "9.0", "TID": "testReqResp", "address": "55.6.77.7", "partnerAddress": "55.6.77.71", "userName": "admin", "password": "admin", "snmpVersion": "V3", "secuLevel": "authPriv", "usmUser": "v3DefaultUser", "usmAuthPwd": "v3DefAuthPass", "usmPrivPwd": "v3DefPrivPass", "authMethod": "HMAC-MD5", "privMethod": "AES-128", "SecureComm": "SSH2", "ssh2pubKey": "DEFAULT", "neType": "1830PSS", "neGroupId": "100", "acd": "unknown", "userLabel": "testReqResp#OCS", "location": "QW", "comments": "", "subType": "OCS", "operation": "add" }, { "operation": "modify", "userLabel": "test-dual", "address": "4.2.4.32", "associatedNE": "associatedNE", "neType": "1830PSS", "associatedPHNNEIpAddresses": "testReqResp:55.6.77.71", "supervisionState": "declared", "neGroupId": 101, "neId": 405 }, { "operation": "modify", "userLabel": "finally", "address": "55.4.3.65", "associatedNE": "associatedNE", "neType": "1830PSS", "associatedPHNNEIpAddresses": "testReqResp:55.6.77.71;TEST-IBUG:103.1.2.3;SITE-E-1:135.104.237.10", "supervisionState": "declared", "neGroupId": 100, "neId": 574, "associatedOCSNEIpAddresses": "overrideOCS#OCS:12.33.4.57" } ]

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    [ { "version": "9.0", "address": "55.6.77.71", "secondaryIPAddress": "", "partnerAddress": "55.6.77.7", "userName": "admin", "password": "IYsIiiNKi9s=", "snmpVersion": "V2C", "v2readCommunity": "7bQQKtdLyaIDXPlrbuermA==", "v2writeCommunity": "7bQQKtdLyaIDXPlrbuermA==", "neType": "1830PSS", "neGroupId": "100", "acd": "unknown", "userLabel": "testReqResp", "location": "QW", "comments": "", "subType": "PHN", "operation": "add", "associatedPHNNEIpAddresses": "test-dual:4.2.4.32;finally:55.4.3.65", "associatedOCSNEIpAddresses": "testReqResp#OCS:55.6.77.7", "containsAssociation": "containsAssociation", "listOfNTPIPs": "135.250.70.66", "ntpEnabled": "true", "reachability": "UNREACHABLE", "neId": "674", "id": "100_674", "supervisionState": "DECLARED", "alarmStatus": "CLEARED" }, { "version": "9.0", "TID": "testReqResp", "address": "55.6.77.7", "partnerAddress": "55.6.77.71", "userName": "admin", "password": "IYsIiiNKi9s=", "snmpVersion": "V3", "secuLevel": "authPriv", "usmUser": "v3DefaultUser", "usmAuthPwd": "JNjV/HbYK9qfkWSjIMc5og==", "usmPrivPwd": "Exkja5GumJd9iBzJkWaayw==", "authMethod": "HMAC-MD5", "privMethod": "AES-128", "SecureComm": "SSH2", "ssh2pubKey": "DEFAULT", "neType": "1830PSS", "neGroupId": "100", "acd": "unknown", "userLabel": "testReqResp#OCS", "location": "QW", "comments": "", "subType": "OCS", "operation": "add", "listOfNTPIPs": "135.250.70.66", "ntpEnabled": "true", "reachability": "UNREACHABLE", "neId": "675", "id": "100_675", "supervisionState": "DECLARED", "alarmStatus": "CLEARED" }, { "operation": "modify", "userLabel": "finally", "address": "55.4.3.65", "associatedNE": "associatedNE", "neType": "1830PSS", "associatedPHNNEIpAddresses": "testReqResp:55.6.77.71;TEST-IBUG:103.1.2.3;SITE-E-1:135.104.237.10", "supervisionState": "declared", "neGroupId": "100", "neId": "574", "associatedOCSNEIpAddresses": "overrideOCS#OCS:12.33.4.57", "operationStatus": "success" }, { "operation": "modify", "userLabel": "test-dual", "address": "4.2.4.32", "associatedNE": "associatedNE", "neType": "1830PSS", "associatedPHNNEIpAddresses": "testReqResp:55.6.77.71", "supervisionState": "declared", "neGroupId": "101", "neId": "405", "operationStatus": "success" } ]

    External Docs
    See Also :

    Operation

    get /data/eml/secureCheck/{emlID}
    CheckSupportFor Secure Transaction with OCS (checkSupportForSecureTransaction : /data/eml/secureCheck/{emlID})
    Check for the file, if it is present on the EML.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    emlID required EML (e.g. OTNE_X/EML_X) ---

    Return type
  • Boolean
  • Responses

    Response Messages

    Schema

    200success Boolean
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /data/eml/secureCheck/OTNE_1

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    false

    External Docs
    See Also :

    Operation

    get /emlnemgr/secureCheck/{emlID}
    CheckSupportFor Secure Transaction with OCS (checkSupportForSecureTransaction : /emlnemgr/secureCheck/{emlID})
    Check for the file, if it is present on the EML.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    emlID required EML (e.g. OTNE_X/EML_X) ---

    Return type
  • Boolean
  • Responses

    Response Messages

    Schema

    200success Boolean
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /emlnemgr/secureCheck/OTNE_1

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    false

    External Docs
    See Also :

    Operation

    post /data/eml/scheduleGRI
    Crete GRI job (createJob : /data/eml/scheduleGRI)
    createJob

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional Complete job details String ---

    Return type
  • inline_response_200
  • Responses

    Response Messages

    Schema

    200success inline_response_200
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    post /emlnemgr/scheduleGRI
    Crete GRI job (createJob : /emlnemgr/scheduleGRI)
    createJob

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional Complete job details String ---

    Return type
  • inline_response_200
  • Responses

    Response Messages

    Schema

    200success inline_response_200
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    delete /data/eml/NE/{neGroupId_neId}
    Delete NE (deleteNE : /data/eml/NE/{neGroupId_neId})
    Sends request to SNA, to remove the selected NE

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neGroupIdNeId required EmlGroupId_EmlNeId ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    data/eml/NE/100_33

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    Usually we won't get any RESP in case of success

    External Docs
    See Also :

    Operation

    delete /emlnemgr/NE/{neGroupId_neId}
    Delete NE (deleteNE : /emlnemgr/NE/{neGroupId_neId})
    Sends request to SNA, to remove the selected NE

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neGroupIdNeId required EmlGroupId_EmlNeId ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    /emlnemgr/NE/100_33

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    Usually we won't get any RESP in case of success

    External Docs
    See Also :

    Operation

    delete /data/eml/NODE
    Delete Node (deleteNode : /data/eml/NODE)
    To remove selected node(s)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional nodeList array[String] ---

    Return type
  • List[ResponseEntity«Map«string,string»»]
  • Responses

    Response Messages

    Schema

    200success List[ResponseEntity«Map«string,string»»]
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    delete /data/eml/NODE/{nodeId}
    Delete Node (deleteNode : /data/eml/NODE/{nodeId})
    To remove selected node(s)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nodeId required nodeId can be obtained from 'associatedNodeId' attribute of /oms1350/data/npr/nes REST call ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    REST Call : /data/eml/NODE Request Payload: [74,73]

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    [ { "headers": { "OperationMsg": [ "Successful" ], "GuiLabel": [ "Dummy_L2" ] }, "body": null, "statusCode": "OK" }, { "headers": { "OperationMsg": [ "Successful" ], "GuiLabel": [ "dummy_Del" ] }, "body": null, "statusCode": "OK" } ]

    External Docs
    See Also :

    Operation

    delete /emlnemgr/NODE
    Delete Node (deleteNode : /emlnemgr/NODE)
    To remove selected node(s)

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional nodeList array[String] ---

    Return type
  • List[ResponseEntity«Map«string,string»»]
  • Responses

    Response Messages

    Schema

    200success List[ResponseEntity«Map«string,string»»]
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    delete /emlnemgr/NODE/{nodeId}
    Delete Node (deleteNode : /emlnemgr/NODE/{nodeId})
    To remove selected node(s)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nodeId required nodeId can be obtained from 'associatedNodeId' attribute of /oms1350/data/npr/nes REST call ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    REST Call: /emlnemgr/NODE Request Payload: [74,73]

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    [ { "headers": { "OperationMsg": [ "Successful" ], "GuiLabel": [ "Dummy_L2" ] }, "body": null, "statusCode": "OK" }, { "headers": { "OperationMsg": [ "Successful" ], "GuiLabel": [ "dummy_Del" ] }, "body": null, "statusCode": "OK" } ]

    External Docs
    See Also :

    Operation

    post /data/eml/NE/GRI/{totalNes}
    Performs Enhanced GRI (enhancedGri : /data/eml/NE/GRI/{totalNes})
    The 'eml_ID' field value can be obtained by appending the emlInstance to EML, i.e 'EML_'+ emlInstanceId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    totalNes required Number of NEs selected to perform GRI ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional allNEs List[Entry«string,List«string»»] ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    post /emlnemgr/NE/GRI/{totalNes}
    Performs Enhanced GRI (enhancedGri : /emlnemgr/NE/GRI/{totalNes})
    The 'eml_ID' field value can be obtained by appending the emlInstance to EML, i.e 'EML_'+ emlInstanceId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    totalNes required Number of NEs selected to perform GRI ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional allNEs List[Entry«string,List«string»»] ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    get /data/eml/ADG/{eml}
    Alarm Debouncing (getAlarmDebouncingInfo : /data/eml/ADG/{eml})
    Retrieves EML specific Alarm debouncing info

    Path parameters

    Name

    IsRequired

    Description

    Enum

    eml required EML (e.g. OTNE_X/EML_X) ---

    Return type
  • List[Map«string,string»]
  • Responses

    Response Messages

    Schema

    200success List[Map«string,string»]
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /data/eml/ADG/otne_1

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    [ { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.10", "trapName": "dsx1TotSESsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.11", "trapName": "dsx1TotSEFSsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.12", "trapName": "dsx1TotUASsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.13", "trapName": "dsx1TotCSSsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.14", "trapName": "dsx1TotLESsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.15", "trapName": "dsx1TotPCVsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.16", "trapName": "dsx1TotLCVsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.17", "trapName": "dsx1FarEndCurESsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.18", "trapName": "dsx1FarEndCurSESsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.19", "trapName": "dsx1FarEndCurSEFSsTCA" }, { "probableCause": "Link Up", "holdPeriod": "180", "oid": "1.3.6.1.6.3.1.1.5.4", "trapName": "linkUp" }, { "probableCause": "SSFODUEGR", "holdPeriod": "180", "oid": "1.3.6.1.4.1.7483.2.1.2.2.3.1.0.1355", "trapName": "tnServerSignalFailureEgressRaisedNotif" }, { "probableCause": "OCIEGR", "holdPeriod": "180", "oid": "1.3.6.1.4.1.7483.2.1.2.2.3.1.0.1345", "trapName": "tnOpenConnectionIndicationEgressRaisedNotif" }, { "probableCause": "LCKEGR", "holdPeriod": "180", "oid": "1.3.6.1.4.1.7483.2.1.2.2.3.1.0.1343", "trapName": "tnLockedIndicationEgressRaisedNotif" }, { "probableCause": "TIMEGR", "holdPeriod": "180", "oid": "1.3.6.1.4.1.7483.2.1.2.2.3.1.0.1351", "trapName": "tnTrailTraceIdentifierMismatchEgressRaisedNotif" }, { "probableCause": "PLMEGR", "holdPeriod": "180", "oid": "1.3.6.1.4.1.7483.2.1.2.2.3.1.0.1353", "trapName": "tnPayloadTypeMismatchEgressRaisedNotif" }, { "probableCause": "BDIEGR", "holdPeriod": "180", "oid": "1.3.6.1.4.1.7483.2.1.2.2.3.1.0.1349", "trapName": "tnBackwardDefectIndicationEgressRaisedNotif" }, { "probableCause": "SDEGR", "holdPeriod": "180", "oid": "1.3.6.1.4.1.7483.2.1.2.2.3.1.0.1347", "trapName": "tnSignalDegradeEgressRaisedNotif" }, { "probableCause": "Loss of voltage power feed B", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1003.5401", "trapName": "POWBcFLR" }, { "probableCause": "Loss of voltage power feed A", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1003.5400", "trapName": "POWAcFLR" }, { "probableCause": "IPCP Line Connection Failure", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1000.80", "trapName": "IPCPLCONFAIL" }, { "probableCause": "OSINLCP Line Connection Failure", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1000.82", "trapName": "OSINLCPLCONFAIL" }, { "probableCause": "OSINLCP Section Connection Failure", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1000.81", "trapName": "OSINLCPSCONFAIL" }, { "probableCause": "APS Improper K-byte received.", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1000.88", "trapName": "APSCIMP" }, { "probableCause": "APS Default K-byte received.", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1000.87", "trapName": "APSCDFLTK" }, { "probableCause": "APS Inconsistent K-byte received.", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1000.89", "trapName": "APSCINCON" }, { "probableCause": "APS Channel Match Failure", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1000.84", "trapName": "APSCM" }, { "probableCause": "APS Protection Byte Failure", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1000.83", "trapName": "APSB" }, { "probableCause": "APS Mode Mismatch Failure", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1000.85", "trapName": "APSMM" }, { "probableCause": "APS connection Mismatch.", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1000.90", "trapName": "APSCNMIS" }, { "probableCause": "Partner interface not present in assigned slot", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1003.3279", "trapName": "PINTFcUNI" }, { "probableCause": "SSF", "holdPeriod": "180", "oid": "1.3.6.1.4.1.7483.2.1.2.2.3.1.0.301", "trapName": "tnServerSignalFailureRaisedNotif" }, { "probableCause": "Partner interface type mismatch", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1003.3278", "trapName": "PINTFcWFUP" }, { "probableCause": "Local interface power failure", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1003.3277", "trapName": "LINTFPOWcFAIL" }, { "probableCause": "Local interface not present in assigned slot", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1003.3276", "trapName": "LINTFcUNI" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1003.3271", "trapName": "VC12TPcNUAS15" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1003.3270", "trapName": "VC12TPcNSES24" }, { "probableCause": "Local interface type mismatch", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1003.3275", "trapName": "LINTFcWFUP" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1003.3274", "trapName": "VC12TPcNBBE24" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1003.3273", "trapName": "VC12TPcNBBE15" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1003.3272", "trapName": "VC12TPcNUAS24" }, { "probableCause": "OWCM hardware version mismatch", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1003.3266", "trapName": "OWCMcVMIS" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1003.3265", "trapName": "TU12FBBEcTHR24" } ]

    External Docs
    See Also :

    Operation

    get /emlnemgr/ADG/{eml}
    Alarm Debouncing (getAlarmDebouncingInfo : /emlnemgr/ADG/{eml})
    Retrieves EML specific Alarm debouncing info

    Path parameters

    Name

    IsRequired

    Description

    Enum

    eml required EML (e.g. OTNE_X/EML_X) ---

    Return type
  • List[Map«string,string»]
  • Responses

    Response Messages

    Schema

    200success List[Map«string,string»]
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /emlnemgr/ADG/otne_1

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    [ { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.10", "trapName": "dsx1TotSESsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.11", "trapName": "dsx1TotSEFSsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.12", "trapName": "dsx1TotUASsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.13", "trapName": "dsx1TotCSSsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.14", "trapName": "dsx1TotLESsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.15", "trapName": "dsx1TotPCVsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.16", "trapName": "dsx1TotLCVsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.17", "trapName": "dsx1FarEndCurESsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.18", "trapName": "dsx1FarEndCurSESsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.19", "trapName": "dsx1FarEndCurSEFSsTCA" }, { "probableCause": "Link Up", "holdPeriod": "180", "oid": "1.3.6.1.6.3.1.1.5.4", "trapName": "linkUp" }, { "probableCause": "SSFODUEGR", "holdPeriod": "180", "oid": "1.3.6.1.4.1.7483.2.1.2.2.3.1.0.1355", "trapName": "tnServerSignalFailureEgressRaisedNotif" }, { "probableCause": "OCIEGR", "holdPeriod": "180", "oid": "1.3.6.1.4.1.7483.2.1.2.2.3.1.0.1345", "trapName": "tnOpenConnectionIndicationEgressRaisedNotif" }, { "probableCause": "LCKEGR", "holdPeriod": "180", "oid": "1.3.6.1.4.1.7483.2.1.2.2.3.1.0.1343", "trapName": "tnLockedIndicationEgressRaisedNotif" }, { "probableCause": "TIMEGR", "holdPeriod": "180", "oid": "1.3.6.1.4.1.7483.2.1.2.2.3.1.0.1351", "trapName": "tnTrailTraceIdentifierMismatchEgressRaisedNotif" }, { "probableCause": "PLMEGR", "holdPeriod": "180", "oid": "1.3.6.1.4.1.7483.2.1.2.2.3.1.0.1353", "trapName": "tnPayloadTypeMismatchEgressRaisedNotif" }, { "probableCause": "BDIEGR", "holdPeriod": "180", "oid": "1.3.6.1.4.1.7483.2.1.2.2.3.1.0.1349", "trapName": "tnBackwardDefectIndicationEgressRaisedNotif" }, { "probableCause": "SDEGR", "holdPeriod": "180", "oid": "1.3.6.1.4.1.7483.2.1.2.2.3.1.0.1347", "trapName": "tnSignalDegradeEgressRaisedNotif" }, { "probableCause": "Loss of voltage power feed B", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1003.5401", "trapName": "POWBcFLR" }, { "probableCause": "Loss of voltage power feed A", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1003.5400", "trapName": "POWAcFLR" }, { "probableCause": "IPCP Line Connection Failure", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1000.80", "trapName": "IPCPLCONFAIL" }, { "probableCause": "OSINLCP Line Connection Failure", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1000.82", "trapName": "OSINLCPLCONFAIL" }, { "probableCause": "OSINLCP Section Connection Failure", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1000.81", "trapName": "OSINLCPSCONFAIL" }, { "probableCause": "APS Improper K-byte received.", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1000.88", "trapName": "APSCIMP" }, { "probableCause": "APS Default K-byte received.", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1000.87", "trapName": "APSCDFLTK" }, { "probableCause": "APS Inconsistent K-byte received.", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1000.89", "trapName": "APSCINCON" }, { "probableCause": "APS Channel Match Failure", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1000.84", "trapName": "APSCM" }, { "probableCause": "APS Protection Byte Failure", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1000.83", "trapName": "APSB" }, { "probableCause": "APS Mode Mismatch Failure", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1000.85", "trapName": "APSMM" }, { "probableCause": "APS connection Mismatch.", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1000.90", "trapName": "APSCNMIS" }, { "probableCause": "Partner interface not present in assigned slot", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1003.3279", "trapName": "PINTFcUNI" }, { "probableCause": "SSF", "holdPeriod": "180", "oid": "1.3.6.1.4.1.7483.2.1.2.2.3.1.0.301", "trapName": "tnServerSignalFailureRaisedNotif" }, { "probableCause": "Partner interface type mismatch", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1003.3278", "trapName": "PINTFcWFUP" }, { "probableCause": "Local interface power failure", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1003.3277", "trapName": "LINTFPOWcFAIL" }, { "probableCause": "Local interface not present in assigned slot", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1003.3276", "trapName": "LINTFcUNI" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1003.3271", "trapName": "VC12TPcNUAS15" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1003.3270", "trapName": "VC12TPcNSES24" }, { "probableCause": "Local interface type mismatch", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1003.3275", "trapName": "LINTFcWFUP" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1003.3274", "trapName": "VC12TPcNBBE24" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1003.3273", "trapName": "VC12TPcNBBE15" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1003.3272", "trapName": "VC12TPcNUAS24" }, { "probableCause": "OWCM hardware version mismatch", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1003.3266", "trapName": "OWCMcVMIS" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "180", "oid": "1.3.6.1.4.1.1751.1.102.200.11.1003.3265", "trapName": "TU12FBBEcTHR24" } ]

    External Docs
    See Also :

    Operation

    get /data/eml/associations
    To get the Cluster Association of a Node or an NE (getAllAssociations : /data/eml/associations)
    Can get the associations, either with nodeID or with neGrpID_neID.But, at least one of the query parameter is must.
    As this API is being used in different formats, to form the complete REST URL we have to append the query parameters.
    e.g /data/eml/associations?neGrpsID_nesID=xx_xx or /data/eml/associations?associatedNodeId=xx
    or /emlnemgr/associations?neGrpsID_nesID=xx_xx or /emlnemgr/associations?associatedNodeId=xx

    Query parameters

    Name

    IsRequired

    Description

    associatedNodeId optional ---
    neGrpsIDNesID optional ---
    nprNeId optional ---

    Return type
  • List[Map«string,string»]
  • Responses

    Response Messages

    Schema

    200success List[Map«string,string»]
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /data/eml/associations?associatedNodeId=332

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    [ { "associatedToNe": "PSS16II-BA-01", "ipAddress": "192.191.16.169", "neUL": "PSS16II-BA-02" } ]

    External Docs
    See Also :

    Operation

    get /emlnemgr/associations
    To get the Cluster Association of a Node or an NE (getAllAssociations : /emlnemgr/associations)
    Can get the associations, either with nodeID or with neGrpID_neID.But, at least one of the query parameter is must.
    As this API is being used in different formats, to form the complete REST URL we have to append the query parameters.
    e.g /data/eml/associations?neGrpsID_nesID=xx_xx or /data/eml/associations?associatedNodeId=xx
    or /emlnemgr/associations?neGrpsID_nesID=xx_xx or /emlnemgr/associations?associatedNodeId=xx

    Query parameters

    Name

    IsRequired

    Description

    associatedNodeId optional ---
    neGrpsIDNesID optional ---
    nprNeId optional ---

    Return type
  • List[Map«string,string»]
  • Responses

    Response Messages

    Schema

    200success List[Map«string,string»]
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /emlnemgr/associations?neGrpsID_nesID=100_550

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    [ { "associatedToNe": "PSS16II-BA-01", "ipAddress": "192.191.16.169", "neUL": "PSS16II-BA-02" } ]

    External Docs
    See Also :

    Operation

    get /data/eml/lldpPorts
    To get the LLDP enabled ports (getAllLldpPorts : /data/eml/lldpPorts)
    Can get the ports, with nodeIDe.g /data/eml/lldpPorts?associatedNodeId=xx

    Query parameters

    Name

    IsRequired

    Description

    associatedNodeId optional ---

    Return type
  • List[Map«string,string»]
  • Responses

    Response Messages

    Schema

    200success List[Map«string,string»]
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    get /emlnemgr/lldpPorts
    To get the LLDP enabled ports (getAllLldpPorts : /emlnemgr/lldpPorts)
    Can get the ports, with nodeIDe.g /data/eml/lldpPorts?associatedNodeId=xx

    Query parameters

    Name

    IsRequired

    Description

    associatedNodeId optional ---

    Return type
  • List[Map«string,string»]
  • Responses

    Response Messages

    Schema

    200success List[Map«string,string»]
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    post /data/eml/getJobId
    Get the associated job-id for the selected Node/NE id (getAssociatedJobIds : /data/eml/getJobId)
    getAssociatedJobIds

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional mapO ---

    Return type
  • array[Long]
  • Responses

    Response Messages

    Schema

    200success array[Long]
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    post /emlnemgr/getJobId
    Get the associated job-id for the selected Node/NE id (getAssociatedJobIds : /emlnemgr/getJobId)
    getAssociatedJobIds

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---
    body2 optional mapO ---

    Return type
  • array[Long]
  • Responses

    Response Messages

    Schema

    200success array[Long]
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    get /data/eml/NE/AutoDiscovery/{neGroupId_neId_userLabel}
    Auto-Discovery (getAutoDiscoveredNes : /data/eml/NE/AutoDiscovery/{neGroupId_neId_userLabel})
    Sends request to OAM, to find out the neighbouring NEs.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neGroupIdNeIdUserLabel required EmlGroupID_EmlNeId_NeUserLabel ---

    Return type
  • List[Map«string,string»]
  • Responses

    Response Messages

    Schema

    200success List[Map«string,string»]
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /data/eml/NE/AutoDiscovery/101_354_PSS4-100-61.2

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    [ { "userLabel": "PSS32-100-63-124", "supervisionArea": "eth1", "ipAddress": "10.100.63.124", "location": "QW", "neType": "1830PSS-PHN", "version": "9.0" }, { "userLabel": "PSS32-100-63-128", "supervisionArea": "eth1", "ipAddress": "10.100.63.128", "location": "QW", "neType": "1830PSS-PHN", "version": "9.0" }, { "userLabel": "PSS32-100-63-126", "supervisionArea": "eth1", "ipAddress": "10.100.63.126", "location": "QW", "neType": "1830PSS-PHN", "version": "9.0" } ]

    External Docs
    See Also :

    Operation

    get /emlnemgr/NE/AutoDiscovery/{neGroupId_neId_userLabel}
    Auto-Discovery (getAutoDiscoveredNes : /emlnemgr/NE/AutoDiscovery/{neGroupId_neId_userLabel})
    Sends request to OAM, to find out the neighbouring NEs.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neGroupIdNeIdUserLabel required EmlGroupID_EmlNeId_NeUserLabel ---

    Return type
  • List[Map«string,string»]
  • Responses

    Response Messages

    Schema

    200success List[Map«string,string»]
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /emlnemgr/NE/AutoDiscovery/101_354_PSS4-100-61.2

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    [ { "userLabel": "PSS32-100-63-124", "supervisionArea": "eth1", "ipAddress": "10.100.63.124", "location": "QW", "neType": "1830PSS-PHN", "version": "9.0" }, { "userLabel": "PSS32-100-63-128", "supervisionArea": "eth1", "ipAddress": "10.100.63.128", "location": "QW", "neType": "1830PSS-PHN", "version": "9.0" }, { "userLabel": "PSS32-100-63-126", "supervisionArea": "eth1", "ipAddress": "10.100.63.126", "location": "QW", "neType": "1830PSS-PHN", "version": "9.0" } ]

    External Docs
    See Also :

    Operation

    post /data/eml/clusterNode
    get the cluster links on selected NE IDs (getClusterLinks : /data/eml/clusterNode)
    getClusterLinks

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional clusterNodeIds String ---

    Return type
  • List[Entry«string,int»]
  • Responses

    Response Messages

    Schema

    200success List[Entry«string,int»]
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    post /emlnemgr/clusterNode
    get the cluster links on selected NE IDs (getClusterLinks : /emlnemgr/clusterNode)
    getClusterLinks

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional clusterNodeIds String ---

    Return type
  • List[Entry«string,int»]
  • Responses

    Response Messages

    Schema

    200success List[Entry«string,int»]
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    get /data/eml/GENNELIST/{emlID}
    Generic NE List (getGenericNeListForEmls : /data/eml/GENNELIST/{emlID})
    Generic NEs supported to the selected EML.
    Retrieves the list from the SNA (genericNeSNA.properties)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    emlID required EMLs (e.g. EML_1-EML_2) ---

    Return type
  • List[Map«string,string»]
  • Responses

    Response Messages

    Schema

    200success List[Map«string,string»]
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /data/eml/GENNELIST/-otne_1

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    [ { "GenericNE|RamanPump-2.1|SetLocationName": "sysLocation.0", "GenericNE|1621SLE-2.1|ReleaseOnNE": "2.6", "GenericNE|1621SLE-2.1|NTP": "", "GenericNE|RamanPump-2.1|AlarmHandler": "", "GenericNE|RamanPump-2.1|SetNEName": "sysName.0", "GenericNE|1621SLE-2.1|SetNEName": "sysName.0", "GenericNE|RamanPump-2.3|Trap": "", "GenericNE|RamanPump-2.3|NTP": "", "GenericNE|1621SLE-2.1|SetNEName_Supported": "true", "GenericNE|RamanPump-2.1|AlarmPolling_Supported": "true", "GenericNE|RamanPump-2.3|AlarmHandler": "", "GenericNE|RamanPump-2.1|AlarmPolling": "1.3.6.1.4.1.4464.2.2.1.1", "GenericNE|RamanPump-2.3|NTP_Supported": "false", "GenericNE|1621SLE-2.1|Trap": "", "GenericNE|1621SLE-2.1|TypeOnNE": "Linux ASU10", "GenericNE|1621SLE-2.1|NEType_Release_Supported": "true", "GenericNE|RamanPump-2.1|SetNEName_Supported": "true", "GenericNE|RamanPump-2.1|NTP_Supported": "false", "GenericNE|RamanPump-2.3|AlarmPolling_Supported": "true", "GenericNE|1621SLE-2.1|Trap_Supported": "false", "GenericNE|RamanPump-2.3|AlarmPolling": "1.3.6.1.4.1.4464.2.2.1.1", "GenericNE|RamanPump-2.3|PollingForAlive": "1.3.6.1.2.1.1.3", "GenericNE|RamanPump-2.3|NEType_Release": "1.3.6.1.2.1.1", "GenericNE|1621SLE-2.1|NTP_Supported": "false", "GenericNE|1621SLE-2.1|PollingForAlive": "1.3.6.1.2.1.1.3", "GenericNE": "1621SLE-2.1|RamanPump-2.1|RamanPump-2.3", "GenericNE|RamanPump-2.3|SupervisionHandler": "com.lucent.oms.sna.generic.handlers.GenericSupervisionHandler", "GenericNE|RamanPump-2.1|SupervisionHandler": "com.lucent.oms.sna.generic.handlers.GenericSupervisionHandler", "GenericNE|1621SLE-2.1|AlarmPolling_Supported": "true", "GenericNE|RamanPump-2.3|SetNEName": "sysName.0", "GenericNE|RamanPump-2.1|Trap_Supported": "false", "GenericNE|RamanPump-2.3|SetLocationName_Supported": "true", "GenericNE|RamanPump-2.3|ReleaseOnNE": "2.6.29", "GenericNE|RamanPump-2.1|PollingForAlive": "1.3.6.1.2.1.1.3", "GenericNE|RamanPump-2.3|TypeOnNE": "Linux RU-NEM", "GenericNE|RamanPump-2.3|SetNEName_Supported": "true", "GenericNE|RamanPump-2.3|PollingForAlive_Supported": "true", "GenericNE|RamanPump-2.1|NEType_Release": "1.3.6.1.2.1.1", "GenericNE|1621SLE-2.1|NEType_Release": "1.3.6.1.2.1.1", "GenericNE|RamanPump-2.1|NTP": "", "GenericNE|RamanPump-2.3|Trap_Supported": "false", "GenericNE|1621SLE-2.1|SupervisionHandler": "com.lucent.oms.sna.generic.handlers.GenericSupervisionHandler", "GenericNE|RamanPump-2.1|NEType_Release_Supported": "true", "GenericNE|1621SLE-2.1|AlarmPolling": "1.3.6.1.4.1.4464.2.1.1.1", "GenericNE|MeMap": "com.lucent.oms.sna.pss.r010000.features.me.MeMapper", "GenericNE|RamanPump-2.1|SetLocationName_Supported": "true", "GenericNE|RamanPump-2.1|TypeOnNE": "Linux RU-NEM", "GenericNE|RamanPump-2.1|PollingForAlive_Supported": "true", "GenericNE|RamanPump-2.1|ReleaseOnNE": "2.6.29", "GenericNE|RamanPump-2.3|SetLocationName": "sysLocation.0", "GenericNE|1621SLE-2.1|SetLocationName_Supported": "true", "GenericNE|1621SLE-2.1|AlarmHandler": "", "GenericNE|1621SLE-2.1|PollingForAlive_Supported": "true", "GenericNE|RamanPump-2.3|NEType_Release_Supported": "true", "GenericNE|RamanPump-2.1|Trap": "", "GenericNE|1621SLE-2.1|SetLocationName": "sysLocation.0", "GenericNE|MeSync": "com.lucent.oms.sna.pss.r010000.features.me.MeSync" } ]

    External Docs
    See Also :

    Operation

    get /emlnemgr/GENNELIST/{emlID}
    Generic NE List (getGenericNeListForEmls : /emlnemgr/GENNELIST/{emlID})
    Generic NEs supported to the selected EML.
    Retrieves the list from the SNA (genericNeSNA.properties)

    Path parameters

    Name

    IsRequired

    Description

    Enum

    emlID required EMLs (e.g. EML_1-EML_2) ---

    Return type
  • List[Map«string,string»]
  • Responses

    Response Messages

    Schema

    200success List[Map«string,string»]
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /emlnemgr/GENNELIST/-otne_1

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    [ { "GenericNE|RamanPump-2.1|SetLocationName": "sysLocation.0", "GenericNE|1621SLE-2.1|ReleaseOnNE": "2.6", "GenericNE|1621SLE-2.1|NTP": "", "GenericNE|RamanPump-2.1|AlarmHandler": "", "GenericNE|RamanPump-2.1|SetNEName": "sysName.0", "GenericNE|1621SLE-2.1|SetNEName": "sysName.0", "GenericNE|RamanPump-2.3|Trap": "", "GenericNE|RamanPump-2.3|NTP": "", "GenericNE|1621SLE-2.1|SetNEName_Supported": "true", "GenericNE|RamanPump-2.1|AlarmPolling_Supported": "true", "GenericNE|RamanPump-2.3|AlarmHandler": "", "GenericNE|RamanPump-2.1|AlarmPolling": "1.3.6.1.4.1.4464.2.2.1.1", "GenericNE|RamanPump-2.3|NTP_Supported": "false", "GenericNE|1621SLE-2.1|Trap": "", "GenericNE|1621SLE-2.1|TypeOnNE": "Linux ASU10", "GenericNE|1621SLE-2.1|NEType_Release_Supported": "true", "GenericNE|RamanPump-2.1|SetNEName_Supported": "true", "GenericNE|RamanPump-2.1|NTP_Supported": "false", "GenericNE|RamanPump-2.3|AlarmPolling_Supported": "true", "GenericNE|1621SLE-2.1|Trap_Supported": "false", "GenericNE|RamanPump-2.3|AlarmPolling": "1.3.6.1.4.1.4464.2.2.1.1", "GenericNE|RamanPump-2.3|PollingForAlive": "1.3.6.1.2.1.1.3", "GenericNE|RamanPump-2.3|NEType_Release": "1.3.6.1.2.1.1", "GenericNE|1621SLE-2.1|NTP_Supported": "false", "GenericNE|1621SLE-2.1|PollingForAlive": "1.3.6.1.2.1.1.3", "GenericNE": "1621SLE-2.1|RamanPump-2.1|RamanPump-2.3", "GenericNE|RamanPump-2.3|SupervisionHandler": "com.lucent.oms.sna.generic.handlers.GenericSupervisionHandler", "GenericNE|RamanPump-2.1|SupervisionHandler": "com.lucent.oms.sna.generic.handlers.GenericSupervisionHandler", "GenericNE|1621SLE-2.1|AlarmPolling_Supported": "true", "GenericNE|RamanPump-2.3|SetNEName": "sysName.0", "GenericNE|RamanPump-2.1|Trap_Supported": "false", "GenericNE|RamanPump-2.3|SetLocationName_Supported": "true", "GenericNE|RamanPump-2.3|ReleaseOnNE": "2.6.29", "GenericNE|RamanPump-2.1|PollingForAlive": "1.3.6.1.2.1.1.3", "GenericNE|RamanPump-2.3|TypeOnNE": "Linux RU-NEM", "GenericNE|RamanPump-2.3|SetNEName_Supported": "true", "GenericNE|RamanPump-2.3|PollingForAlive_Supported": "true", "GenericNE|RamanPump-2.1|NEType_Release": "1.3.6.1.2.1.1", "GenericNE|1621SLE-2.1|NEType_Release": "1.3.6.1.2.1.1", "GenericNE|RamanPump-2.1|NTP": "", "GenericNE|RamanPump-2.3|Trap_Supported": "false", "GenericNE|1621SLE-2.1|SupervisionHandler": "com.lucent.oms.sna.generic.handlers.GenericSupervisionHandler", "GenericNE|RamanPump-2.1|NEType_Release_Supported": "true", "GenericNE|1621SLE-2.1|AlarmPolling": "1.3.6.1.4.1.4464.2.1.1.1", "GenericNE|MeMap": "com.lucent.oms.sna.pss.r010000.features.me.MeMapper", "GenericNE|RamanPump-2.1|SetLocationName_Supported": "true", "GenericNE|RamanPump-2.1|TypeOnNE": "Linux RU-NEM", "GenericNE|RamanPump-2.1|PollingForAlive_Supported": "true", "GenericNE|RamanPump-2.1|ReleaseOnNE": "2.6.29", "GenericNE|RamanPump-2.3|SetLocationName": "sysLocation.0", "GenericNE|1621SLE-2.1|SetLocationName_Supported": "true", "GenericNE|1621SLE-2.1|AlarmHandler": "", "GenericNE|1621SLE-2.1|PollingForAlive_Supported": "true", "GenericNE|RamanPump-2.3|NEType_Release_Supported": "true", "GenericNE|RamanPump-2.1|Trap": "", "GenericNE|1621SLE-2.1|SetLocationName": "sysLocation.0", "GenericNE|MeSync": "com.lucent.oms.sna.pss.r010000.features.me.MeSync" } ]

    External Docs
    See Also :

    Operation

    post /data/eml/NE/GRI/mergeCSV/
    Gets Last Modified Time of GRI Files (getGriCsvFiles : /data/eml/NE/GRI/mergeCSV/)
    getGriCsvFiles

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional allNEs List[Entry«string,List«string»»] ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    post /emlnemgr/NE/GRI/mergeCSV/
    Gets Last Modified Time of GRI Files (getGriCsvFiles : /emlnemgr/NE/GRI/mergeCSV/)
    getGriCsvFiles

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional allNEs List[Entry«string,List«string»»] ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    post /data/eml/NE/GRI/timeStamp/
    Gets Last Modified Time of GRI Files (getLastModifiedTimestampOfGriFiles : /data/eml/NE/GRI/timeStamp/)
    getLastModifiedTimestampOfGriFiles

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional allNEs List[Entry«string,List«Map«string,string»»»] ---
    Query parameters

    Name

    IsRequired

    Description

    timeFormat optional ---

    Return type
  • List[Map«string,string»]
  • Responses

    Response Messages

    Schema

    200success List[Map«string,string»]
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    post /emlnemgr/NE/GRI/timeStamp/
    Gets Last Modified Time of GRI Files (getLastModifiedTimestampOfGriFiles : /emlnemgr/NE/GRI/timeStamp/)
    getLastModifiedTimestampOfGriFiles

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional allNEs List[Entry«string,List«Map«string,string»»»] ---
    Query parameters

    Name

    IsRequired

    Description

    timeFormat optional ---

    Return type
  • List[Map«string,string»]
  • Responses

    Response Messages

    Schema

    200success List[Map«string,string»]
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    get /data/eml/NE/{neGroupId_neId}
    Retrives all the attributes of a particular NE. (getNEInfo : /data/eml/NE/{neGroupId_neId})
    The output is a list of attributes of the NE.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neGroupIdNeId required EmlGroupID_EmlNeId ---

    Return type
  • List[Map«string,string»]
  • Responses

    Response Messages

    Schema

    200success List[Map«string,string»]
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    data/eml/NE/100_48

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    [ { "neId": "408", "userLabel": "createAnotherSLTE", "acd": "unknown", "tid": "createAnotherSLTE", "alignmentState": "MISALIGNED", "password": null, "connectTime": "1470223370104", "SecureComm": "FALSE", "cardDirection": "Transmit", "reachability": "UNREACHABLE", "id": "100_408", "reportTidBlocked": "true", "listOfNTPIPs": "135.250.70.66", "address": "2.3.4.58", "localAccessControl": "GRANTED", "ntpEnabled": "true", "creationDate": "1467028892", "version": "9.0", "alarmStatus": "CRITICAL", "neSubType": "NOT-APPLICABLE", "neGroupId": "100", "managerList": null, "supervisionState": "SUPERVISED", "location": "QW", "secondaryIPAddress": "2.3.4.58", "neType": "1830SLTE", "user": null } ]

    External Docs
    See Also :

    Operation

    get /emlnemgr/NE/{neGroupId_neId}
    Retrives all the attributes of a particular NE. (getNEInfo : /emlnemgr/NE/{neGroupId_neId})
    The output is a list of attributes of the NE.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neGroupIdNeId required EmlGroupID_EmlNeId ---

    Return type
  • List[Map«string,string»]
  • Responses

    Response Messages

    Schema

    200success List[Map«string,string»]
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    emlnemgr/NE/100_48

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    [ { "neId": "408", "userLabel": "createAnotherSLTE", "acd": "unknown", "tid": "createAnotherSLTE", "alignmentState": "MISALIGNED", "password": null, "connectTime": "1470223370104", "SecureComm": "FALSE", "cardDirection": "Transmit", "reachability": "UNREACHABLE", "id": "100_408", "reportTidBlocked": "true", "listOfNTPIPs": "135.250.70.66", "address": "2.3.4.58", "localAccessControl": "GRANTED", "ntpEnabled": "true", "creationDate": "1467028892", "version": "9.0", "alarmStatus": "CRITICAL", "neSubType": "NOT-APPLICABLE", "neGroupId": "100", "managerList": null, "supervisionState": "SUPERVISED", "location": "QW", "secondaryIPAddress": "2.3.4.58", "neType": "1830SLTE", "user": null } ]

    External Docs
    See Also :

    Operation

    post /data/eml/NE/INVENTORY
    NEInventory (getNEInventory : /data/eml/NE/INVENTORY)
    Remote Inventory of the equuipment.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional neGroupId_neId String ---
    Query parameters

    Name

    IsRequired

    Description

    timeFormat optional ---

    Return type
  • inline_response_200
  • Responses

    Response Messages

    Schema

    200success inline_response_200
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    REST call: /data/eml/NE/INVENTORY Request Payload: [100_624]

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    uploadRemoteInventory started at 2016/08/03 17:00:53 on <PSS8-BA-03> USER LABEL : PSS8-BA-03/11QPA4-1-2 LOCATION NAME : BA-LAB ELEMENT IDENTITIFICATION COMPANY : ashb Unit type : 11QPA4 Unit part number : 8dg60349abaa01 Software part number : -------------- CLEI code : wotrce6taa MANUFACTURING INFORMATION Manufacturing plant : yp Serial number : yp11100fedf Date (00) : 11/03/24 OPERATOR INVENTORY DATA USER LABEL : PSS8-BA-03/11QPA4-1-2-C4 LOCATION NAME : BA-LAB ELEMENT IDENTITIFICATION COMPANY : nok Unit type : XI-64.1 Unit part number : 1ab375380013 Software part number : trf5016fn-gb35 CLEI code : wotrcrjtaa MANUFACTURING INFORMATION Manufacturing plant : - Serial number : allu13--fn67001176 Date (00) : 13/11/23 OPERATOR INVENTORY DATA USER LABEL : PSS8-BA-03/11QPA4-1-2-L4 LOCATION NAME : BA-LAB ELEMENT IDENTITIFICATION COMPANY : nok Unit type : XI-64.1 Unit part number : 1ab214540001 Software part number : trf5012fs-la01 CLEI code : ---------- MANUFACTURING INFORMATION Manufacturing plant : - Serial number : t07e20147 Date (00) : 07/05/14 OPERATOR INVENTORY DATA USER LABEL : PSS8-BA-03/11QPA4-1-3 LOCATION NAME : BA-LAB ELEMENT IDENTITIFICATION COMPANY : aita Unit type : 11QPA4 Unit part number : 8dg60349aaaa01 Software part number : -------------- CLEI code : wotrb1wtaa MANUFACTURING INFORMATION Manufacturing plant : ez Serial number : ez104931029 Date (00) : 10/12/04 OPERATOR INVENTORY DATA USER LABEL : PSS8-BA-03/11QPA4-1-3-C4 LOCATION NAME : BA-LAB ELEMENT IDENTITIFICATION COMPANY : nok Unit type : XL-64TU Unit part number : 1ab375650046 Software part number : ftlx6814mlc-al CLEI code : wotrbsvgaa MANUFACTURING INFORMATION Manufacturing plant : - Serial number : allu14--fa57341958 Date (00) : 14/09/11 OPERATOR INVENTORY DATA USER LABEL : PSS8-BA-03/11QPA4-1-3-L4 LOCATION NAME : BA-LAB ELEMENT IDENTITIFICATION COMPANY : nok Unit type : XI-64.1 Unit part number : 1ab375380013 Software part number : trf5016fn-gb35 CLEI code : wotrcrjtaa MANUFACTURING INFORMATION Manufacturing plant : - Serial number : allu13--fn67001166 Date (00) : 13/11/23 OPERATOR INVENTORY DATA USER LABEL : PSS8-BA-03/11QPA4-1-3-VA1 LOCATION NAME : BA-LAB ELEMENT IDENTITIFICATION COMPANY : nok Unit type : FVOA Unit part number : 1ab396080001 Software part number : 21131722 CLEI code : wotrbvrtaa MANUFACTURING INFORMATION Manufacturing plant : - Serial number : allu10--js10003250 Date (00) : 10/10/20 OPERATOR INVENTORY DATA USER LABEL : PSS8-BA-03/11QPA4-1-3-VA2 LOCATION NAME : BA-LAB ELEMENT IDENTITIFICATION COMPANY : nok Unit type : FVOA Unit part number : 1ab396080001 Software part number : 21131722 CLEI code : wotrbvrtaa MANUFACTURING INFORMATION Manufacturing plant : - Serial number : allu11--js04006435 Date (00) : 11/04/27 OPERATOR INVENTORY DATA USER LABEL : PSS8-BA-03/8EC2-1-6 LOCATION NAME : BA-LAB ELEMENT IDENTITIFICATION COMPANY : ashb Unit type : 8EC2 Unit part number : 3kc48820aaaa01 Software part number : -------------- CLEI code : wocuaspuaa MANUFACTURING INFORMATION Manufacturing plant : yp Serial number : yp14430575f Date (00) : 14/12/04 OPERATOR INVENTORY DATA USER LABEL : PSS8-BA-03/FAN-1-14 LOCATION NAME : BA-LAB ELEMENT IDENTITIFICATION COMPANY : ashb Unit type : FAN Unit part number : 3kc48850aaaa01 Software part number : -------------- CLEI code : wocua6suaa MANUFACTURING INFORMATION Manufacturing plant : yp__ Serial number : lballu-yp1514033d2 Date (00) : 15/05/06 OPERATOR INVENTORY DATA USER LABEL : PSS8-BA-03/PF-1-1 LOCATION NAME : BA-LAB ELEMENT IDENTITIFICATION COMPANY : ashb Unit type : PF Unit part number : 3kc48870aaaa01 Software part number : -------------- CLEI code : ---------- MANUFACTURING INFORMATION Manufacturing plant : yp Serial number : yp14430c801 Date (00) : 14/12/06 OPERATOR INVENTORY DATA USER LABEL : PSS8-BA-03/SFC-1-11 LOCATION NAME : BA-LAB ELEMENT IDENTITIFICATION COMPANY : aita Unit type : SFC4A Unit part number : 8dg59441aaaa01 Software part number : -------------- CLEI code : wotra19taa MANUFACTURING INFORMATION Manufacturing plant : yp Serial number : yp1314ta019 Date (00) : 13/04/03 OPERATOR INVENTORY DATA USER LABEL : PSS8-BA-03/SHFPNL-1-13 LOCATION NAME : BA-LAB ELEMENT IDENTITIFICATION COMPANY : ashb Unit type : SHFPNL Unit part number : 3kc48830aaaa01 Software part number : -------------- CLEI code : wocuamyuaa MANUFACTURING INFORMATION Manufacturing plant : yp Serial number : yp14420925e Date (00) : 14/12/19 OPERATOR INVENTORY DATA

    External Docs
    See Also :

    Operation

    post /emlnemgr/NE/INVENTORY
    NEInventory (getNEInventory : /emlnemgr/NE/INVENTORY)
    Remote Inventory of the equuipment.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional neGroupId_neId String ---
    Query parameters

    Name

    IsRequired

    Description

    timeFormat optional ---

    Return type
  • inline_response_200
  • Responses

    Response Messages

    Schema

    200success inline_response_200
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    REST call: /emlnemgr/NE/INVENTORY Request Payload: [100_624]

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    uploadRemoteInventory started at 2016/08/03 17:00:53 on <PSS8-BA-03> USER LABEL : PSS8-BA-03/11QPA4-1-2 LOCATION NAME : BA-LAB ELEMENT IDENTITIFICATION COMPANY : ashb Unit type : 11QPA4 Unit part number : 8dg60349abaa01 Software part number : -------------- CLEI code : wotrce6taa MANUFACTURING INFORMATION Manufacturing plant : yp Serial number : yp11100fedf Date (00) : 11/03/24 OPERATOR INVENTORY DATA USER LABEL : PSS8-BA-03/11QPA4-1-2-C4 LOCATION NAME : BA-LAB ELEMENT IDENTITIFICATION COMPANY : nok Unit type : XI-64.1 Unit part number : 1ab375380013 Software part number : trf5016fn-gb35 CLEI code : wotrcrjtaa MANUFACTURING INFORMATION Manufacturing plant : - Serial number : allu13--fn67001176 Date (00) : 13/11/23 OPERATOR INVENTORY DATA USER LABEL : PSS8-BA-03/11QPA4-1-2-L4 LOCATION NAME : BA-LAB ELEMENT IDENTITIFICATION COMPANY : nok Unit type : XI-64.1 Unit part number : 1ab214540001 Software part number : trf5012fs-la01 CLEI code : ---------- MANUFACTURING INFORMATION Manufacturing plant : - Serial number : t07e20147 Date (00) : 07/05/14 OPERATOR INVENTORY DATA USER LABEL : PSS8-BA-03/11QPA4-1-3 LOCATION NAME : BA-LAB ELEMENT IDENTITIFICATION COMPANY : aita Unit type : 11QPA4 Unit part number : 8dg60349aaaa01 Software part number : -------------- CLEI code : wotrb1wtaa MANUFACTURING INFORMATION Manufacturing plant : ez Serial number : ez104931029 Date (00) : 10/12/04 OPERATOR INVENTORY DATA USER LABEL : PSS8-BA-03/11QPA4-1-3-C4 LOCATION NAME : BA-LAB ELEMENT IDENTITIFICATION COMPANY : nok Unit type : XL-64TU Unit part number : 1ab375650046 Software part number : ftlx6814mlc-al CLEI code : wotrbsvgaa MANUFACTURING INFORMATION Manufacturing plant : - Serial number : allu14--fa57341958 Date (00) : 14/09/11 OPERATOR INVENTORY DATA USER LABEL : PSS8-BA-03/11QPA4-1-3-L4 LOCATION NAME : BA-LAB ELEMENT IDENTITIFICATION COMPANY : nok Unit type : XI-64.1 Unit part number : 1ab375380013 Software part number : trf5016fn-gb35 CLEI code : wotrcrjtaa MANUFACTURING INFORMATION Manufacturing plant : - Serial number : allu13--fn67001166 Date (00) : 13/11/23 OPERATOR INVENTORY DATA USER LABEL : PSS8-BA-03/11QPA4-1-3-VA1 LOCATION NAME : BA-LAB ELEMENT IDENTITIFICATION COMPANY : nok Unit type : FVOA Unit part number : 1ab396080001 Software part number : 21131722 CLEI code : wotrbvrtaa MANUFACTURING INFORMATION Manufacturing plant : - Serial number : allu10--js10003250 Date (00) : 10/10/20 OPERATOR INVENTORY DATA USER LABEL : PSS8-BA-03/11QPA4-1-3-VA2 LOCATION NAME : BA-LAB ELEMENT IDENTITIFICATION COMPANY : nok Unit type : FVOA Unit part number : 1ab396080001 Software part number : 21131722 CLEI code : wotrbvrtaa MANUFACTURING INFORMATION Manufacturing plant : - Serial number : allu11--js04006435 Date (00) : 11/04/27 OPERATOR INVENTORY DATA USER LABEL : PSS8-BA-03/8EC2-1-6 LOCATION NAME : BA-LAB ELEMENT IDENTITIFICATION COMPANY : ashb Unit type : 8EC2 Unit part number : 3kc48820aaaa01 Software part number : -------------- CLEI code : wocuaspuaa MANUFACTURING INFORMATION Manufacturing plant : yp Serial number : yp14430575f Date (00) : 14/12/04 OPERATOR INVENTORY DATA USER LABEL : PSS8-BA-03/FAN-1-14 LOCATION NAME : BA-LAB ELEMENT IDENTITIFICATION COMPANY : ashb Unit type : FAN Unit part number : 3kc48850aaaa01 Software part number : -------------- CLEI code : wocua6suaa MANUFACTURING INFORMATION Manufacturing plant : yp__ Serial number : lballu-yp1514033d2 Date (00) : 15/05/06 OPERATOR INVENTORY DATA USER LABEL : PSS8-BA-03/PF-1-1 LOCATION NAME : BA-LAB ELEMENT IDENTITIFICATION COMPANY : ashb Unit type : PF Unit part number : 3kc48870aaaa01 Software part number : -------------- CLEI code : ---------- MANUFACTURING INFORMATION Manufacturing plant : yp Serial number : yp14430c801 Date (00) : 14/12/06 OPERATOR INVENTORY DATA USER LABEL : PSS8-BA-03/SFC-1-11 LOCATION NAME : BA-LAB ELEMENT IDENTITIFICATION COMPANY : aita Unit type : SFC4A Unit part number : 8dg59441aaaa01 Software part number : -------------- CLEI code : wotra19taa MANUFACTURING INFORMATION Manufacturing plant : yp Serial number : yp1314ta019 Date (00) : 13/04/03 OPERATOR INVENTORY DATA USER LABEL : PSS8-BA-03/SHFPNL-1-13 LOCATION NAME : BA-LAB ELEMENT IDENTITIFICATION COMPANY : ashb Unit type : SHFPNL Unit part number : 3kc48830aaaa01 Software part number : -------------- CLEI code : wocuamyuaa MANUFACTURING INFORMATION Manufacturing plant : yp Serial number : yp14420925e Date (00) : 14/12/19 OPERATOR INVENTORY DATA

    External Docs
    See Also :

    Operation

    get /data/eml/NE/NETIME/{neGroupId_neId}
    Retrives the equipment time. (getNETime : /data/eml/NE/NETIME/{neGroupId_neId})
    NE Time.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neGroupIdNeId required EmlGroupID_EmlNeId ---
    Query parameters

    Name

    IsRequired

    Description

    timeFormat optional ---

    Return type
  • List[Map«string,string»]
  • Responses

    Response Messages

    Schema

    200success List[Map«string,string»]
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /data/eml/NE/NETIME/100_624

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    [ { "getCrntNETimeUTC": "1470224070000" } ]

    External Docs
    See Also :

    Operation

    get /emlnemgr/NE/NETIME/{neGroupId_neId}
    Retrives the equipment time. (getNETime : /emlnemgr/NE/NETIME/{neGroupId_neId})
    NE Time.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neGroupIdNeId required EmlGroupID_EmlNeId ---
    Query parameters

    Name

    IsRequired

    Description

    timeFormat optional ---

    Return type
  • List[Map«string,string»]
  • Responses

    Response Messages

    Schema

    200success List[Map«string,string»]
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /emlnemgr/NE/NETIME/100_624

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    [ { "getCrntNETimeUTC": "1470224070000" } ]

    External Docs
    See Also :

    Operation

    post /data/eml/NElist
    Retrives all the NE present in the node (getNEsforNode : /data/eml/NElist)
    Lists all the associated NEs list of the node.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional Node List[Map«string,string»] ---

    Return type
  • List[Map«string,string»]
  • Responses

    Response Messages

    Schema

    200success List[Map«string,string»]
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    REST call: data/eml/NElist Request Payload: [ { "id": "410" } ]

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    [ { "emlNeType": "1830PSS-PHN", "primPassword": "IYsIiiNKi9s=", "Label": "PSS8-BA-03", "ipAddress": "135.250.70.95", "id": "100_624", "primLogin": "admin", "version": "9.0", "tid": "" } ]

    External Docs
    See Also :

    Operation

    post /emlnemgr/NElist
    Retrives all the NE present in the node (getNEsforNode : /emlnemgr/NElist)
    Lists all the associated NEs list of the node.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional Node List[Map«string,string»] ---

    Return type
  • List[Map«string,string»]
  • Responses

    Response Messages

    Schema

    200success List[Map«string,string»]
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    REST call: emlnemgr/NElist Request Payload: [ { "id": "410" } ]

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    [ { "emlNeType": "1830PSS-PHN", "primPassword": "IYsIiiNKi9s=", "Label": "PSS8-BA-03", "ipAddress": "135.250.70.95", "id": "100_624", "primLogin": "admin", "version": "9.0", "tid": "" } ]

    External Docs
    See Also :

    Operation

    get /data/eml/getNeList/{nprNodeId}
    Get the associated nprNeIds for the selected nprNodeId (getNprNeIdsForNodeId : /data/eml/getNeList/{nprNodeId})
    getNprNeIdsForNodeId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nprNodeId required nprNodeId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---

    Return type
  • array[Integer]
  • Responses

    Response Messages

    Schema

    200success array[Integer]
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*

    External Docs
    See Also :

    Operation

    get /emlnemgr/getNeList/{nprNodeId}
    Get the associated nprNeIds for the selected nprNodeId (getNprNeIdsForNodeId : /emlnemgr/getNeList/{nprNodeId})
    getNprNeIdsForNodeId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nprNodeId required nprNodeId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---

    Return type
  • array[Integer]
  • Responses

    Response Messages

    Schema

    200success array[Integer]
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*

    External Docs
    See Also :

    Operation

    get /data/eml/ntp/ne/{neGroupId_neId}
    NTP Config (getNtpConfig : /data/eml/ntp/ne/{neGroupId_neId})
    Get Ntp Config

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neGroupIdNeId required EmlGroupId and neID can be obtained from 'emlDomId' and 'emlNeId' attributes respectively of /oms1350/data/npr/nes REST call ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /data/eml/ntp/ne/100_624

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    { "listOfNTPIPs": "135.250.70.144,135.250.70.128,0.0.0.0" }

    External Docs
    See Also :

    Operation

    get /emlnemgr/ntp/ne/{neGroupId_neId}
    NTP Config (getNtpConfig : /emlnemgr/ntp/ne/{neGroupId_neId})
    Get Ntp Config

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neGroupIdNeId required EmlGroupId and neID can be obtained from 'emlDomId' and 'emlNeId' attributes respectively of /oms1350/data/npr/nes REST call ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /emlnemgr/ntp/ne/100_624

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    { "listOfNTPIPs": "135.250.70.144,135.250.70.128,0.0.0.0" }

    External Docs
    See Also :

    Operation

    get /data/eml/scheduleGRI/getNes/{jobId}
    Get the NEs selected for the job (getSelectedNEsForJob : /data/eml/scheduleGRI/getNes/{jobId})
    getSelectedNEsForJob

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobId required jobId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---

    Return type
  • List[Map«string,string»]
  • Responses

    Response Messages

    Schema

    200success List[Map«string,string»]
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*

    External Docs
    See Also :

    Operation

    get /emlnemgr/scheduleGRI/getNes/{jobId}
    Get the NEs selected for the job (getSelectedNEsForJob : /emlnemgr/scheduleGRI/getNes/{jobId})
    getSelectedNEsForJob

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobId required jobId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---

    Return type
  • List[Map«string,string»]
  • Responses

    Response Messages

    Schema

    200success List[Map«string,string»]
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*

    External Docs
    See Also :

    Operation

    get /data/eml/AssociatedNodeId/{nodeID}
    NE Type List of the Compound Node (getTdmxAvailability : /data/eml/AssociatedNodeId/{nodeID})
    Uses this list in the deletion process of the Node,
    As atleast a PHN or an OCS should be there with TDMX/C compound node

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nodeID required NodeId ---

    Return type
  • array[String]
  • Responses

    Response Messages

    Schema

    200success array[String]
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /data/eml/AssociatedNodeId/286

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    **gives the NE Types present on the node ["1830PSS-PHN","1830PSS-OCS","1830PSS-TDMX","1830PSS-TDMXC"]

    External Docs
    See Also :

    Operation

    get /emlnemgr/AssociatedNodeId/{nodeID}
    NE Type List of the Compound Node (getTdmxAvailability : /emlnemgr/AssociatedNodeId/{nodeID})
    Uses this list in the deletion process of the Node,
    As atleast a PHN or an OCS should be there with TDMX/C compound node

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nodeID required NodeId ---

    Return type
  • array[String]
  • Responses

    Response Messages

    Schema

    200success array[String]
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /emlnemgr/AssociatedNodeId/286

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    **gives the NE Types present on the node ["1830PSS-PHN","1830PSS-OCS","1830PSS-TDMX","1830PSS-TDMXC"]

    External Docs
    See Also :

    Operation

    get /data/eml/getTrapStatus/{eml}
    GET Trap Status (getTrapStatusOnEml : /data/eml/getTrapStatus/{eml})
    getTrapStatusOnEml

    Path parameters

    Name

    IsRequired

    Description

    Enum

    eml required eml domain ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    get /emlnemgr/getTrapStatus/{eml}
    GET Trap Status (getTrapStatusOnEml : /emlnemgr/getTrapStatus/{eml})
    getTrapStatusOnEml

    Path parameters

    Name

    IsRequired

    Description

    Enum

    eml required eml domain ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    post /data/eml/NE/LLDP/{totalNes}/{operation}
    Performs LLDP (getlldp : /data/eml/NE/LLDP/{totalNes}/{operation})
    for PHN and PSI-2T NEs

    Path parameters

    Name

    IsRequired

    Description

    Enum

    totalNes required Number of NEs selected to perform GRI ---
    operation required Selected operation Emanled/Disabled ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional allNEs List[Entry«string,List«string»»] ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    post /emlnemgr/NE/LLDP/{totalNes}/{operation}
    Performs LLDP (getlldp : /emlnemgr/NE/LLDP/{totalNes}/{operation})
    for PHN and PSI-2T NEs

    Path parameters

    Name

    IsRequired

    Description

    Enum

    totalNes required Number of NEs selected to perform GRI ---
    operation required Selected operation Emanled/Disabled ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional allNEs List[Entry«string,List«string»»] ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    post /data/eml/NE/GRI/{eml_ID}/{totalNes}
    Performs GRI (griStatus : /data/eml/NE/GRI/{eml_ID}/{totalNes})
    The 'eml_ID' field value can be obtained by appending the emlInstance to EML, i.e 'EML_'+ emlInstanceId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    emlID required EML_ + InstanceId ---
    totalNes required Number of NEs selected to perform GRI ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional allNEs List[Map«string,string»] ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    /data/eml/NE/GRI/EML_1/1 Request Payload: [ { "id": "101_551", "ipAddr": "10.100.64.52", "griStatus": "IN PROGRESS", "userLabel": "fmpm - 64.52" } ]

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    { "csvFile": "/usr/Systems/OTNE_1-14/data/ri/GLOBAL_RI_2016-08-03_17-44-34.csv", "requestId": "5449836574970151", "emlID": "EML_1", "griStatus": "COMPLETED" }

    External Docs
    See Also :

    Operation

    post /emlnemgr/NE/GRI/{eml_ID}/{totalNes}
    Performs GRI (griStatus : /emlnemgr/NE/GRI/{eml_ID}/{totalNes})
    The 'eml_ID' field value can be obtained by appending the emlInstance to EML, i.e 'EML_'+ emlInstanceId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    emlID required EML_ + InstanceId ---
    totalNes required Number of NEs selected to perform GRI ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional allNEs List[Map«string,string»] ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    /emlnemgr/NE/GRI/EML_1/1 Request Payload: [ { "id": "101_551", "ipAddr": "10.100.64.52", "griStatus": "IN PROGRESS", "userLabel": "fmpm - 64.52" } ]

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    { "csvFile": "/usr/Systems/OTNE_1-14/data/ri/GLOBAL_RI_2016-08-03_17-44-34.csv", "requestId": "5449836574970151", "emlID": "EML_1", "griStatus": "COMPLETED" }

    External Docs
    See Also :

    Operation

    put /data/eml/NODE/{nprNodeId}
    Modify Node (modifyNode : /data/eml/NODE/{nprNodeId})
    Can modify any of the node created through Web-UI.
    Only location field value could be modified if the node is Supervised.(we have GUI validation for this)
    You can add Cluster Associations using Modify.
    If the Node consists of Cluster Association, even though if the Node is Un-Supervised, User wont be able to modify the Node User Label(GUI Validtion).

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional nodeInfoMap List[Map«string,string»] ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    ** nprNodeId can be obtained from 'associatedNodeId' attribute of /oms1350/data/npr/nes REST call REST call: /data/eml/NODE/72 Request Payload: [ { "address": "10.100.63.179", "secondaryIPAddress": "", "partnerAddress": "", "userName": "admin", "password": "IYsIiiNKi9s=", "snmpVersion": "V2C", "v2readCommunity": "7bQQKtdLyaIDXPlrbuermA==", "v2writeCommunity": "7bQQKtdLyaIDXPlrbuermA==", "userLabel": "PSS32-100-63-79", "location": "Sim", "comments": "Modified: Comments Added!!", "acd": "unknown", "neGroupId": 101, "neType": "1830PSS", "neId": 244, "associatedNodeId": 72, "operation": "modify", "supervisionState": "declared", "password_PT": false, "v2readCommunity_PT": false, "v2writeCommunity_PT": false, "subType": "PHN" } ]

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    [ { "address": "10.100.63.179", "secondaryIPAddress": "", "partnerAddress": "", "userName": "admin", "password": "IYsIiiNKi9s=", "snmpVersion": "V2C", "v2readCommunity": "7bQQKtdLyaIDXPlrbuermA==", "v2writeCommunity": "7bQQKtdLyaIDXPlrbuermA==", "userLabel": "PSS32-100-63-79", "location": "Sim", "comments": "Modified: Comments Added!!", "acd": "unknown", "neGroupId": "101", "neType": "1830PSS", "neId": "244", "associatedNodeId": "72", "operation": "modify", "supervisionState": "declared", "password_PT": "false", "v2readCommunity_PT": "false", "v2writeCommunity_PT": "false", "subType": "PHN", "listOfNTPIPs": "135.250.70.66", "ntpEnabled": "true", "operationStatus": "success" } ]

    External Docs
    See Also :

    Operation

    put /emlnemgr/NODE/{nprNodeId}
    Modify Node (modifyNode : /emlnemgr/NODE/{nprNodeId})
    Can modify any of the node created through Web-UI.
    Only location field value could be modified if the node is Supervised.(we have GUI validation for this)
    You can add Cluster Associations using Modify.
    If the Node consists of Cluster Association, even though if the Node is Un-Supervised, User wont be able to modify the Node User Label(GUI Validtion).

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional nodeInfoMap List[Map«string,string»] ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    ** nprNodeId can be obtained from 'associatedNodeId' attribute of /oms1350/data/npr/nes REST call REST call: /emlnemgr/NODE/72 Request Payload: [ { "address": "10.100.63.179", "secondaryIPAddress": "", "partnerAddress": "", "userName": "admin", "password": "IYsIiiNKi9s=", "snmpVersion": "V2C", "v2readCommunity": "7bQQKtdLyaIDXPlrbuermA==", "v2writeCommunity": "7bQQKtdLyaIDXPlrbuermA==", "userLabel": "PSS32-100-63-79", "location": "Sim", "comments": "Modified: Comments Added!!", "acd": "unknown", "neGroupId": 101, "neType": "1830PSS", "neId": 244, "associatedNodeId": 72, "operation": "modify", "supervisionState": "declared", "password_PT": false, "v2readCommunity_PT": false, "v2writeCommunity_PT": false, "subType": "PHN" } ]

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    [ { "address": "10.100.63.179", "secondaryIPAddress": "", "partnerAddress": "", "userName": "admin", "password": "IYsIiiNKi9s=", "snmpVersion": "V2C", "v2readCommunity": "7bQQKtdLyaIDXPlrbuermA==", "v2writeCommunity": "7bQQKtdLyaIDXPlrbuermA==", "userLabel": "PSS32-100-63-79", "location": "Sim", "comments": "Modified: Comments Added!!", "acd": "unknown", "neGroupId": "101", "neType": "1830PSS", "neId": "244", "associatedNodeId": "72", "operation": "modify", "supervisionState": "declared", "password_PT": "false", "v2readCommunity_PT": "false", "v2writeCommunity_PT": "false", "subType": "PHN", "listOfNTPIPs": "135.250.70.66", "ntpEnabled": "true", "operationStatus": "success" } ]

    External Docs
    See Also :

    Operation

    post /data/eml/NE/PingNE
    Ping NE (pingNE : /data/eml/NE/PingNE)
    Sends request to OAM, to find out the reachability of the equipment.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional anyObj List[Entry«string,List«Map«string,string»»»] ---
    Query parameters

    Name

    IsRequired

    Description

    type optional ---
    clogTargetObj optional ---

    Return type
  • List[ResponseEntity«Map«string,string»»]
  • Responses

    Response Messages

    Schema

    200success List[ResponseEntity«Map«string,string»»]
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    REST call: /data/eml/NE/PingNE Request Payload: [ { "id": "101_245", "ip": "10.100.63.80", "isNode": "true", "reachabilityStatus": "IN PROGRESS", "userLabel": "PSS32-100-63-80" } ]

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    [ { "headers": { "OperationMsg": [ "Successful" ] }, "body": { "id": "101_245", "userLabel": "PSS32-100-63-80", "ip": "10.100.63.80", "reachabilityStatus": "REACHABLE", "isNode": "true", "requestId": "5450925435575482" }, "statusCode": "OK" } ]

    External Docs
    See Also :

    Operation

    post /emlnemgr/NE/PingNE
    Ping NE (pingNE : /emlnemgr/NE/PingNE)
    Sends request to OAM, to find out the reachability of the equipment.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional anyObj List[Entry«string,List«Map«string,string»»»] ---
    Query parameters

    Name

    IsRequired

    Description

    type optional ---
    clogTargetObj optional ---

    Return type
  • List[ResponseEntity«Map«string,string»»]
  • Responses

    Response Messages

    Schema

    200success List[ResponseEntity«Map«string,string»»]
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    REST call: /emlnemgr/NE/PingNE Request Payload: [ { "id": "101_245", "ip": "10.100.63.80", "isNode": "true", "reachabilityStatus": "IN PROGRESS", "userLabel": "PSS32-100-63-80" } ]

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    [ { "headers": { "OperationMsg": [ "Successful" ] }, "body": { "id": "101_245", "userLabel": "PSS32-100-63-80", "ip": "10.100.63.80", "reachabilityStatus": "REACHABLE", "isNode": "true", "requestId": "5450925435575482" }, "statusCode": "OK" } ]

    External Docs
    See Also :

    Operation

    post /data/eml/PingSweep
    Network Scan / Simplified Add Node (pingNEsDeploy : /data/eml/PingSweep)
    This operation is used to add NE by the templates customized by users and by discovering the NE IP address

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional body List[Map«string,string»] ---

    Responses

    Response Messages

    Schema

    200 ---
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    post /emlnemgr/PingSweep
    Network Scan / Simplified Add Node (pingNEsDeploy : /emlnemgr/PingSweep)
    This operation is used to add NE by the templates customized by users and by discovering the NE IP address

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional body List[Map«string,string»] ---

    Responses

    Response Messages

    Schema

    200 ---
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    delete /data/eml/scheduleGRI/joblist/{jobId}/{jobName}
    Remove entries from DB table (removeEntriesFromScheduledGriTable : /data/eml/scheduleGRI/joblist/{jobId}/{jobName})
    Removes the associated Nes with the JobId in the DB table SCHEDULED_GRI_DATA

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobId required jobId ---
    jobName required jobName ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---

    Return type
  • inline_response_200
  • Responses

    Response Messages

    Schema

    200success inline_response_200
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*

    External Docs
    See Also :

    Operation

    delete /emlnemgr/scheduleGRI/joblist/{jobId}/{jobName}
    Remove entries from DB table (removeEntriesFromScheduledGriTable : /emlnemgr/scheduleGRI/joblist/{jobId}/{jobName})
    Removes the associated Nes with the JobId in the DB table SCHEDULED_GRI_DATA

    Path parameters

    Name

    IsRequired

    Description

    Enum

    jobId required jobId ---
    jobName required jobName ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional httpSession HttpSession ---

    Return type
  • inline_response_200
  • Responses

    Response Messages

    Schema

    200success inline_response_200
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*

    External Docs
    See Also :

    Operation

    put /data/eml/ADG/{eml}
    Alarm Debouncing (setAlarmDebouncingInfo : /data/eml/ADG/{eml})
    Set Alarm Debouncing

    Path parameters

    Name

    IsRequired

    Description

    Enum

    eml required EML (e.g. OTNE_X/EML_X) ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional adgInfo List[Map«string,string»] ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    REST call: /emlnemgr/ADG/eml_2 Request Payload: [ { "probableCause": "Threshold Crossing Alarm", "holdPeriod": 190, "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.10", "trapName": "dsx1TotSESsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "0", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.11", "trapName": "dsx1TotSEFSsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "0", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.12", "trapName": "dsx1TotUASsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "0", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.13", "trapName": "dsx1TotCSSsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "0", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.14", "trapName": "dsx1TotLESsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "0", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.15", "trapName": "dsx1TotPCVsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "0", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.16", "trapName": "dsx1TotLCVsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "0", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.17", "trapName": "dsx1FarEndCurESsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "0", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.18", "trapName": "dsx1FarEndCurSESsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "0", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.19", "trapName": "dsx1FarEndCurSEFSsTCA" }, { "probableCause": "Link Up", "holdPeriod": "0", "oid": "1.3.6.1.6.3.1.1.5.4", "trapName": "linkUp" }, { "probableCause": "SSFODUEGR", "holdPeriod": "0", "oid": "1.3.6.1.4.1.7483.2.1.2.2.3.1.0.1355", "trapName": "tnServerSignalFailureEgressRaisedNotif" }, { "probableCause": "OCIEGR", "holdPeriod": "0", "oid": "1.3.6.1.4.1.7483.2.1.2.2.3.1.0.1345", "trapName": "tnOpenConnectionIndicationEgressRaisedNotif" }, { "probableCause": "LCKEGR", "holdPeriod": "0", "oid": "1.3.6.1.4.1.7483.2.1.2.2.3.1.0.1343", "trapName": "tnLockedIndicationEgressRaisedNotif" } ]

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    "success"

    External Docs
    See Also :

    Operation

    put /emlnemgr/ADG/{eml}
    Alarm Debouncing (setAlarmDebouncingInfo : /emlnemgr/ADG/{eml})
    Set Alarm Debouncing

    Path parameters

    Name

    IsRequired

    Description

    Enum

    eml required EML (e.g. OTNE_X/EML_X) ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional adgInfo List[Map«string,string»] ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    REST call: /emlnemgr/ADG/eml_2 Request Payload: [ { "probableCause": "Threshold Crossing Alarm", "holdPeriod": 190, "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.10", "trapName": "dsx1TotSESsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "0", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.11", "trapName": "dsx1TotSEFSsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "0", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.12", "trapName": "dsx1TotUASsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "0", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.13", "trapName": "dsx1TotCSSsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "0", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.14", "trapName": "dsx1TotLESsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "0", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.15", "trapName": "dsx1TotPCVsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "0", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.16", "trapName": "dsx1TotLCVsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "0", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.17", "trapName": "dsx1FarEndCurESsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "0", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.18", "trapName": "dsx1FarEndCurSESsTCA" }, { "probableCause": "Threshold Crossing Alarm", "holdPeriod": "0", "oid": "1.3.6.1.4.1.1751.2.88.9.5.4.19", "trapName": "dsx1FarEndCurSEFSsTCA" }, { "probableCause": "Link Up", "holdPeriod": "0", "oid": "1.3.6.1.6.3.1.1.5.4", "trapName": "linkUp" }, { "probableCause": "SSFODUEGR", "holdPeriod": "0", "oid": "1.3.6.1.4.1.7483.2.1.2.2.3.1.0.1355", "trapName": "tnServerSignalFailureEgressRaisedNotif" }, { "probableCause": "OCIEGR", "holdPeriod": "0", "oid": "1.3.6.1.4.1.7483.2.1.2.2.3.1.0.1345", "trapName": "tnOpenConnectionIndicationEgressRaisedNotif" }, { "probableCause": "LCKEGR", "holdPeriod": "0", "oid": "1.3.6.1.4.1.7483.2.1.2.2.3.1.0.1343", "trapName": "tnLockedIndicationEgressRaisedNotif" } ]

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    "success"

    External Docs
    See Also :

    Operation

    post /data/eml/NE/NETIME/{neGroupId_neId}
    NETIME (setNETime : /data/eml/NE/NETIME/{neGroupId_neId})
    Sets the time.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neGroupIdNeId required EmlGroupId_EmlNeId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional currOSTime String ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    REST call: /data/eml/NE/NETIME/106_273 Request Payload: "1470228088655"

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    { "setCrntNETimeUTC": "Successful" }

    External Docs
    See Also :

    Operation

    post /emlnemgr/NE/NETIME/{neGroupId_neId}
    NETIME (setNETime : /emlnemgr/NE/NETIME/{neGroupId_neId})
    Sets the time.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neGroupIdNeId required EmlGroupId_EmlNeId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional currOSTime String ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    REST call: /emlnemgr/NE/NETIME/106_273 Request Payload: "1470228088655"

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    { "setCrntNETimeUTC": "Successful" }

    External Docs
    See Also :

    Operation

    put /data/eml/ntp/ne/{neGroupId_neId}
    setNtpConfig (setNtpConfig : /data/eml/ntp/ne/{neGroupId_neId})
    to setNtpConfig

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neGroupIdNeId required neGroupId_neId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required ntpConfigMap Map<String, String> ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    REST call: /data/eml/ntp/ne/106_274 Request Payload: { "listOfNTPIPs": "135.250.70.66,135.250.70.67", "ntpEnabled": "true" }

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    { "STATUS": "SUCCESS" }

    External Docs
    See Also :

    Operation

    put /emlnemgr/ntp/ne/{neGroupId_neId}
    setNtpConfig (setNtpConfig : /emlnemgr/ntp/ne/{neGroupId_neId})
    to setNtpConfig

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neGroupIdNeId required neGroupId_neId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required ntpConfigMap Map<String, String> ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    REST call: /emlnemgr/ntp/ne/106_274 Request Payload: { "listOfNTPIPs": "135.250.70.66,135.250.70.67", "ntpEnabled": "true" }

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    { "STATUS": "SUCCESS" }

    External Docs
    See Also :

    Operation

    put /data/eml/ntp/template
    NTP Template (setNtpTemplate : /data/eml/ntp/template)
    Save NTP templates

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required ntpTemplInfo Map<String, String> ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    REST call: /data/eml/ntp/template Request Payload: { "Template_1": "135.250.70.66,135.250.70.67" }

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    { "Template_1": "135.250.70.66,135.250.70.67" }

    External Docs
    See Also :

    Operation

    put /emlnemgr/ntp/template
    NTP Template (setNtpTemplate : /emlnemgr/ntp/template)
    Save NTP templates

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required ntpTemplInfo Map<String, String> ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    REST call: /emlnemgr/ntp/template Request Payload: { "Template_1": "135.250.70.66,135.250.70.67" }

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    { "Template_1": "135.250.70.66,135.250.70.67" }

    External Docs
    See Also :

    Operation

    post /data/eml/NE/syncProtocol/{totalNes}
    Set Sync Protocol on NE(s) (setSyncProtocol : /data/eml/NE/syncProtocol/{totalNes})
    The 'eml_ID' field value can be obtained by appending the emlInstance to EML, i.e 'EML_'+ emlInstanceId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    totalNes required Number of NEs selected to update Sync Protocol ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional allNEs List[Entry«string,List«string»»] ---
    Query parameters

    Name

    IsRequired

    Description

    setSyncProtocol required ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    post /emlnemgr/NE/syncProtocol/{totalNes}
    Set Sync Protocol on NE(s) (setSyncProtocol : /emlnemgr/NE/syncProtocol/{totalNes})
    The 'eml_ID' field value can be obtained by appending the emlInstance to EML, i.e 'EML_'+ emlInstanceId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    totalNes required Number of NEs selected to update Sync Protocol ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional allNEs List[Entry«string,List«string»»] ---
    Query parameters

    Name

    IsRequired

    Description

    setSyncProtocol required ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    post /data/eml/NE/timeZone/{totalNes}
    Set Time Zone on NE(s) (setTimeZone : /data/eml/NE/timeZone/{totalNes})
    The 'eml_ID' field value can be obtained by appending the emlInstance to EML, i.e 'EML_'+ emlInstanceId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    totalNes required Number of NEs selected to update Time Zone ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional allNEs List[Entry«string,List«string»»] ---
    Query parameters

    Name

    IsRequired

    Description

    setTimeZone required ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    post /emlnemgr/NE/timeZone/{totalNes}
    Set Time Zone on NE(s) (setTimeZone : /emlnemgr/NE/timeZone/{totalNes})
    The 'eml_ID' field value can be obtained by appending the emlInstance to EML, i.e 'EML_'+ emlInstanceId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    totalNes required Number of NEs selected to update Time Zone ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional allNEs List[Entry«string,List«string»»] ---
    Query parameters

    Name

    IsRequired

    Description

    setTimeZone required ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    put /data/eml/superviseNODEs/{supervision_State}
    Supervise Nodes (superviseNodes : /data/eml/superviseNODEs/{supervision_State})
    Node level operation. Takes full node object as request data

    Path parameters

    Name

    IsRequired

    Description

    Enum

    supervisionState required Supervision state ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional nodeInfoMap List[Map«string,string»] ---

    Return type
  • List[ResponseEntity«Map«string,string»»]
  • Responses

    Response Messages

    Schema

    200success List[ResponseEntity«Map«string,string»»]
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    REST call: /data/eml/superviseNODEs/ACTIVATING Request Payload: [ { "emlNeType": "1830PSS-PHN", "primPassword": "IYsIiiNKi9s=", "Label": "PSS32-BA-101-115", "ipAddress": "135.250.101.115", "id": "100_649", "primLogin": "admin", "version": "9.0", "tid": "" }, { "emlNeType": "1830PSS-PHN", "primPassword": "IYsIiiNKi9s=", "Label": "PSS32-BA-101-117", "ipAddress": "135.250.101.117", "id": "100_650", "primLogin": "admin", "version": "9.0", "tid": "" } ]

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    [ { "headers": { "OperationMsg": [ "Successful" ] }, "body": { "requestId": "5453231223685071", "supervisionState": "ACTIVATING", "snaReqId": "4828240004446840071" }, "statusCode": "ACCEPTED" }, { "headers": { "OperationMsg": [ "Successful" ] }, "body": { "requestId": "5453231456239028", "supervisionState": "ACTIVATING", "snaReqId": "-7234314421489047688" }, "statusCode": "ACCEPTED" } ]

    External Docs
    See Also :

    Operation

    put /emlnemgr/superviseNODEs/{supervision_State}
    Supervise Nodes (superviseNodes : /emlnemgr/superviseNODEs/{supervision_State})
    Node level operation. Takes full node object as request data

    Path parameters

    Name

    IsRequired

    Description

    Enum

    supervisionState required Supervision state ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional nodeInfoMap List[Map«string,string»] ---

    Return type
  • List[ResponseEntity«Map«string,string»»]
  • Responses

    Response Messages

    Schema

    200success List[ResponseEntity«Map«string,string»»]
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    REST call: /emlnemgr/superviseNODEs/ACTIVATING Request Payload: [ { "emlNeType": "1830PSS-PHN", "primPassword": "IYsIiiNKi9s=", "Label": "PSS32-BA-101-115", "ipAddress": "135.250.101.115", "id": "100_649", "primLogin": "admin", "version": "9.0", "tid": "" }, { "emlNeType": "1830PSS-PHN", "primPassword": "IYsIiiNKi9s=", "Label": "PSS32-BA-101-117", "ipAddress": "135.250.101.117", "id": "100_650", "primLogin": "admin", "version": "9.0", "tid": "" } ]

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    [ { "headers": { "OperationMsg": [ "Successful" ] }, "body": { "requestId": "5453231223685071", "supervisionState": "ACTIVATING", "snaReqId": "4828240004446840071" }, "statusCode": "ACCEPTED" }, { "headers": { "OperationMsg": [ "Successful" ] }, "body": { "requestId": "5453231456239028", "supervisionState": "ACTIVATING", "snaReqId": "-7234314421489047688" }, "statusCode": "ACCEPTED" } ]

    External Docs
    See Also :

    Operation

    post /data/eml/trapDeploy
    trap based discovery (trapDeploy : /data/eml/trapDeploy)
    This operation is used to enable the trap based discovery template in SNA so that NE can be added using the template provided by user.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional body List[Map«string,string»] ---

    Responses

    Response Messages

    Schema

    200 ---
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    post /emlnemgr/trapDeploy
    trap based discovery (trapDeploy : /emlnemgr/trapDeploy)
    This operation is used to enable the trap based discovery template in SNA so that NE can be added using the template provided by user.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional body List[Map«string,string»] ---

    Responses

    Response Messages

    Schema

    200 ---
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    put /data/eml/NE/{id}
    Update NE (updateNE : /data/eml/NE/{id})
    NE level operation. Handles, supervision + LAC state change + Config SSH/SNMP requests

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required EmlNeGroupid_EmlNeId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required neInfoMap Map<String, String> ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    REST call: /data/eml/NE/100_650 Request Payload: { "supervisionState": "DEACTIVATING" }

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    { "supervisionState": "DEACTIVATING", "snaReqId": "-751401005384014029", "requestId": "5453552651959945" }

    External Docs
    See Also :

    Operation

    put /emlnemgr/NE/{id}
    Update NE (updateNE : /emlnemgr/NE/{id})
    NE level operation. Handles, supervision + LAC state change + Config SSH/SNMP requests

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required EmlNeGroupid_EmlNeId ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required neInfoMap Map<String, String> ---

    Return type
  • Map«string,string»
  • Responses

    Response Messages

    Schema

    200success Map«string,string»
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    REST call: /emlnemgr/NE/100_650 Request Payload: { "supervisionState": "DEACTIVATING" }

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    { "supervisionState": "DEACTIVATING", "snaReqId": "-751401005384014029", "requestId": "5453552651959945" }

    External Docs
    See Also :

    Operation

    post /data/eml/NE/RI
    Remote Inventory (uploadRI : /data/eml/NE/RI)
    Sends the request to SNA, to get Remote Inventory from the NE

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional id String ---
    Query parameters

    Name

    IsRequired

    Description

    timeFormat optional ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    REST call: /data/eml/NE/RI Request Payload: 100_650

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/text
    Example Response Data
    "Success"

    External Docs
    See Also :

    Operation

    post /emlnemgr/NE/RI
    Remote Inventory (uploadRI : /emlnemgr/NE/RI)
    Sends the request to SNA, to get Remote Inventory from the NE

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional id String ---
    Query parameters

    Name

    IsRequired

    Description

    timeFormat optional ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    REST call: /emlnemgr/NE/RI Request Payload: 100_650

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/text
    Example Response Data
    "Success"

    External Docs
    See Also :

    Operation

    post /data/eml/ipValidation
    validateNetworkScanIp (validateNetworkScanIp : /data/eml/ipValidation)
    validateNetworkScanIp

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional body ---

    Return type
  • Long
  • Responses

    Response Messages

    Schema

    200success Long
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*

    External Docs
    See Also :

    Operation

    post /emlnemgr/ipValidation
    validateNetworkScanIp (validateNetworkScanIp : /emlnemgr/ipValidation)
    validateNetworkScanIp

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional body ---

    Return type
  • Long
  • Responses

    Response Messages

    Schema

    200success Long
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*

    External Docs
    See Also :

    DeferredResult«Map«string,string»»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    Entry«string,int»

    Name

    Type

    Description

    Enum

    key Integer integer --- ---

    Entry«string,List«Map«string,string»»»

    Name

    Type

    Description

    Enum

    key array[Map«string,string»] Map«string,string» --- ---

    Entry«string,List«string»»

    Name

    Type

    Description

    Enum

    key array[String] string --- ---

    inline_response_200

    Name

    Type

    Description

    Enum

    Oms1350NE

    Name

    Type

    Description

    Enum

    associatedNodeId Integer integer --- ---
    communicationState String string --- [CommState_available, CommState_partiallyUnavailable, CommState_unavailable, CommState_notProvided]
    confDwldState String string --- [ConfDownloadState_enabled, ConfDownloadState_disabled, ConfDownloadState_enabling, ConfDownloadState_disabling, ConfDownloadState_failToEnable, ConfDownloadState_failToDisable]
    emlDomainId Integer integer --- ---
    version String string --- ---
    ipAddress String string --- ---
    secondaryIpAddress String string --- ---
    activeIpAddress String string --- ---
    partnerNeId Integer integer --- ---
    emlNeId Integer integer --- ---
    otnNeId Integer integer --- ---
    mibAlignmentState String string --- [MibAlignmentState_aligned, MibAlignmentState_misaligned, MibAlignmentState_notProvided, MibAlignmentState_aligningUp, MibAlignmentState_aligningDown, MibAlignmentState_inConfig, MibAlignmentState_auditing, MibAlignmentState_partiallyAligned, MibAlignmentState_transient]
    nadString String string --- ---
    nprNeId Integer integer --- ---
    otnConfDownldState String string --- [GlobConfDwnldSt_enabled, GlobConfDwnldSt_disabled, GlobConfDwnldSt_partiallyDisabled, GlobConfDwnldSt_notMeaningful]
    opState String string --- [OperationalState_disabled, OperationalState_enabled, OperationalState_notMeaningful]
    supervisionState String string --- [SupervisionState_declared, SupervisionState_activating, SupervisionState_supervised, SupervisionState_deactivating, SupervisionState_notProvided, SupervisionState_partiallySupervised, SupervisionState_transient]
    neLabel String string --- ---
    primPassword String string --- ---
    primLogin String string --- ---
    tid String string --- ---
    siteName String string --- ---
    neAlignment String string --- [Alignment_normal, Alignment_failed, Alignment_inProgress, Alignment_unknown]
    neType String string --- ---

    ResponseEntity

    Name

    Type

    Description

    Enum

    headers HttpHeaders HttpHeaders --- ---
    body Object object --- ---
    statusCodeValue Integer integer --- ---
    statusCode String string --- [100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 413, 414, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511]

    Void

    Name

    Type

    Description

    Enum