Operation
get /networkinventory/networkelements
Retrieves a list of all Network Elements stored in OMS. (getAllNEs : /networkinventory/networkelements)
The response returns the HTTP URL where the inventory data files can be accessed.
Using the response URL, the inventory data can be retrieved.
Note: By Default, no of files generated = no of EML instances.
If all data needs to be merged to single file, Then execute below commands.
cd /usr/Systems/OTNE_1_*/report/data_extraction/npt/inventory/
touch EPT_MERGE_FILE
The inventory data contains the attributes listed below for each Network Element:
userLabel : NE Name
version : NE Release Number.Two Digit Number e.g. 8.2
productName : Shelf Type of Main Shelf. Valid values are PSS64, UNV ,UNV4, UNV8, UNV16, UNV16II, UNV32, UNV96
nodeType : Valid values are 1830PSS-1-AHP, 1830PSS-1-GBEH, 1830PSS-1-MD4H, 1830PSS-1-MSAH, 1830PSS-32, 1830PSS-4, 1830PSS-OCS
location
communicationState : Valid values are ENABLED , DISABLED
supervisionState : Valid values are SUPERVISED, DECLARED
nodeName : For PHN NEs nodeName is the same as the userLabel.For standalone OCS NEs nodeName is the same as the userLabel.For compound PHN/OCS nodes the nodeName of the OCS NE is the userLabel of the PHN NE.
attributeNameValue :
TID - NE TID
IpAddress - Format XXX.XXX.XXX.XXX
neTypeDescription - Mandatory for SNMP NEs ,MIB attribute sysDescr
EMLNeId - Integer
EMLNeGroupId - Integer
neType
neTypeDescription
GMREConfigured : Valid value is YES
AsonFeasibilityLastTransferredVersion
clusterNEs : Header
ClusterNEName : NE TID
ClusterNEIPAddress : Format XXX.XXX.XXX.XXX
Type : Valid Values are OCS, PHN
Using the response URL, the inventory data can be retrieved.
Note: By Default, no of files generated = no of EML instances.
If all data needs to be merged to single file, Then execute below commands.
cd /usr/Systems/OTNE_1_*/report/data_extraction/npt/inventory/
touch EPT_MERGE_FILE
The inventory data contains the attributes listed below for each Network Element:
userLabel : NE Name
version : NE Release Number.Two Digit Number e.g. 8.2
productName : Shelf Type of Main Shelf. Valid values are PSS64, UNV ,UNV4, UNV8, UNV16, UNV16II, UNV32, UNV96
nodeType : Valid values are 1830PSS-1-AHP, 1830PSS-1-GBEH, 1830PSS-1-MD4H, 1830PSS-1-MSAH, 1830PSS-32, 1830PSS-4, 1830PSS-OCS
location
communicationState : Valid values are ENABLED , DISABLED
supervisionState : Valid values are SUPERVISED, DECLARED
nodeName : For PHN NEs nodeName is the same as the userLabel.For standalone OCS NEs nodeName is the same as the userLabel.For compound PHN/OCS nodes the nodeName of the OCS NE is the userLabel of the PHN NE.
attributeNameValue :
TID - NE TID
IpAddress - Format XXX.XXX.XXX.XXX
neTypeDescription - Mandatory for SNMP NEs ,MIB attribute sysDescr
EMLNeId - Integer
EMLNeGroupId - Integer
neType
neTypeDescription
GMREConfigured : Valid value is YES
AsonFeasibilityLastTransferredVersion
clusterNEs : Header
ClusterNEName : NE TID
ClusterNEIPAddress : Format XXX.XXX.XXX.XXX
Type : Valid Values are OCS, PHN
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
array[String]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
REST call : /networkinventory/networkelements
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 for getting the list of HTTP URLs: [1] 0: "https://{{serverIp}}:8443/oms1350/data_report/data_extraction/EQM/data/1589180853857GetAllNEResponse.json" Response with inventory details using the above HTTP URL : [ { "userLabel": "10.43.24.145", "version": "11.0", "productName": "UNV32", "nodeType": "1830PSS-32", "location": "BA", "communicationState": "ENABLED", "supervisionState": "SUPERVISED", "nodeName": "10.43.24.145", "attributeNameValue": { "TID": "10.43.24.145#PHN", "IpAddress": "10.43.24.145", "EMLNeId": "118", "EMLNeGroupId": "101", "neType": "1830 PSS-32", "neTypeDescription": "Nokia 1830 PSS v11.0 SDH ADM (Simulator)", "GMREConfigured": "", "AsonFeasibilityLastTransferredVersion": null, "ACD": "unknown", "clusterNEs": [ { "ClusterNEName": "10.43.24.144", "ClusterNEIPAddress": "10.43.24.144", "Type": "PHN" } ] }, "ObjectIdentifier": "101-118" } ]
Tags
[ EQM ]
Operation
get /networkinventory/networkelements/{neType}
Retrieves a list of only Network Elements stored in OMS of the specified type(s). (getAllNEs : /networkinventory/networkelements/{neType})
The 'neType' attribute can take a list of one or more NE Types separated by a comma.
The response returns the HTTP URL where the inventory data files can be accessed.
Using the response URL, the inventory data can be retrieved.
Note: By Default, no of files generated = no of EML instances.
If all data needs to be merged to single file, Then execute below commands.
cd /usr/Systems/OTNE_1_*/report/data_extraction/npt/inventory/
touch EPT_MERGE_FILE
The inventory data contains the attributes listed below for each Network Element:
userLabel : NE Name
version : NE Release Number.Two Digit Number e.g. 8.2
productName : Shelf Type of Main Shelf .Valid values are PSS64, UNV ,UNV4, UNV8, UNV16, UNV16II, UNV32, UNV96
nodeType : Valid values are 1830PSS-1-AHP, 1830PSS-1-GBEH, 1830PSS-1-MD4H, 1830PSS-1-MSAH, 1830PSS-32, 1830PSS-4, 1830PSS-OCS
location
communicationState : Valid values are ENABLED , DISABLED
supervisionState : Valid values are SUPERVISED, DECLARED
nodeName : For PHN NEs nodeName is the same as the userLabel.For standalone OCS NEs nodeName is the same as the userLabel.For compound PHN/OCS nodes the nodeName of the OCS NE is the userLabel of the PHN NE.
attributeNameValue :
TID - NE TID
IpAddress - Format XXX.XXX.XXX.XXX
EMLNeId - Integer
EMLNeGroupId - Integer
neType
neTypeDescription - Mandatory for SNMP NEs ,MIB attribute sysDescr
GMREConfigured : Valid value is YES
AsonFeasibilityLastTransferredVersion
clusterNEs : Header
ClusterNEName : NE TID
ClusterNEIPAddress : Format XXX.XXX.XXX.XXX
Type : Valid Values are OCS, PHN
The response returns the HTTP URL where the inventory data files can be accessed.
Using the response URL, the inventory data can be retrieved.
Note: By Default, no of files generated = no of EML instances.
If all data needs to be merged to single file, Then execute below commands.
cd /usr/Systems/OTNE_1_*/report/data_extraction/npt/inventory/
touch EPT_MERGE_FILE
The inventory data contains the attributes listed below for each Network Element:
userLabel : NE Name
version : NE Release Number.Two Digit Number e.g. 8.2
productName : Shelf Type of Main Shelf .Valid values are PSS64, UNV ,UNV4, UNV8, UNV16, UNV16II, UNV32, UNV96
nodeType : Valid values are 1830PSS-1-AHP, 1830PSS-1-GBEH, 1830PSS-1-MD4H, 1830PSS-1-MSAH, 1830PSS-32, 1830PSS-4, 1830PSS-OCS
location
communicationState : Valid values are ENABLED , DISABLED
supervisionState : Valid values are SUPERVISED, DECLARED
nodeName : For PHN NEs nodeName is the same as the userLabel.For standalone OCS NEs nodeName is the same as the userLabel.For compound PHN/OCS nodes the nodeName of the OCS NE is the userLabel of the PHN NE.
attributeNameValue :
TID - NE TID
IpAddress - Format XXX.XXX.XXX.XXX
EMLNeId - Integer
EMLNeGroupId - Integer
neType
neTypeDescription - Mandatory for SNMP NEs ,MIB attribute sysDescr
GMREConfigured : Valid value is YES
AsonFeasibilityLastTransferredVersion
clusterNEs : Header
ClusterNEName : NE TID
ClusterNEIPAddress : Format XXX.XXX.XXX.XXX
Type : Valid Values are OCS, PHN
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
neType | required | Network Element Type | [1830PSS_OCS, 1830pss-1-ahp, 1830pss, 1830PSS_32, 1830PSS_4, 1830pss-1-md4h, 1830pss-1-msah, 1830pss-1-gbeh, 1830pss-4] |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
array[String]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
REST call : /networkinventory/networkelements/1830PSS-32
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 for getting the list of HTTP URLs: [1] 0: "https://{{serverIp}}:8443/oms1350/data_report/data_extraction/EQM/data/1589180853857GetAllNEResponse.json" Response with inventory details using the above HTTP URL : [ { "userLabel": "R14_AUTO_NODE_02", "version": "9.0", "productName": "UNV32", "nodeType": "1830PSS-32", "location": "ba", "communicationState": "ENABLED", "supervisionState": "SUPERVISED", "nodeName": "R14_AUTO_NODE_02", "attributeNameValue": { "TID": "R14_AUTO_NODE_02", "IpAddress": "10.100.61.234", "EMLNeId": "26", "EMLNeGroupId": "1201", "neTypeDescription": "Nokia 1830 PSS v9.0 SDH ADM (Simulator)", "GMREConfigured": "", "clusterNEs": [ { "ClusterNEName": "R14_AUTO_NODE_02#OCS", "ClusterNEIPAddress": "10.100.61.221", "Type": "OCS" }, { "ClusterNEName": "R14_AUTO_NODE_04#OCS", "ClusterNEIPAddress": "10.100.61.227", "Type": "OCS" }, { "ClusterNEName": "R14_AUTO_NODE_01#OCS", "ClusterNEIPAddress": "10.100.61.218", "Type": "OCS" }, { "ClusterNEName": "R14_AUTO_NODE_03", "ClusterNEIPAddress": "10.100.61.235", "Type": "PHN" }, { "ClusterNEName": "R14_AUTO_NODE_04", "ClusterNEIPAddress": "10.100.61.236", "Type": "PHN" }, { "ClusterNEName": "R14_AUTO_NODE_01", "ClusterNEIPAddress": "10.100.61.233", "Type": "PHN" } ] } } ]