Operation
get /nodeCache/ne/{groupId}/{neId}
To get the basic information of the ne with grpID and neID passed as path variable (getNE : /nodeCache/ne/{groupId}/{neId})
getNE
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
groupId | required | groupId | --- |
neId | required | neId | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Oms1350NE
|
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 /nodeCache/nes
To get the basic information of all the nes (getNesMap : /nodeCache/nes)
getNesMap
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
List[Entry«int,Oms1350NE»]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
oms1350/nodeCache/nes
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
{ 3: { associatedNodeId: 5, communicationState: "CommState_available", confDwldState: "ConfDownloadState_enabled", emlDomainId: 103, version: "9.0", ipAddress: "10.100.59.210", secondaryIpAddress: null, activeIpAddress: null, partnerNeId: 0, emlNeId: 3, otnNeId: 18, mibAlignmentState: "MibAlignmentState_aligned", nadString: "unknown", nprNeId: 3, otnConfDownldState: "GlobConfDwnldSt_enabled", opState: "OperationalState_enabled", supervisionState: "SupervisionState_supervised", neLabel: "Site1-1", primPassword: "IYsIiiNKi9s=", primLogin: "admin", tid: "", neType: "1830PSS-PHN" }, 6: { associatedNodeId: 8, communicationState: "CommState_available", confDwldState: "ConfDownloadState_enabled", emlDomainId: 101, version: "9.0", ipAddress: "135.250.16.150", secondaryIpAddress: null, activeIpAddress: null, partnerNeId: 62, emlNeId: 62, otnNeId: 24, mibAlignmentState: "MibAlignmentState_aligned", nadString: "unknown", nprNeId: 6, otnConfDownldState: "GlobConfDwnldSt_enabled", opState: "OperationalState_enabled", supervisionState: "SupervisionState_supervised", neLabel: "PSS64-BA-02#OCS", primPassword: "9T07v6JgdpBgfRd7svsj6g==", primLogin: "EML001", tid: "PSS64-BA-02", neType: "1830PSS-OCS" }, 8: { associatedNodeId: 10, communicationState: "CommState_available", confDwldState: "ConfDownloadState_enabled", emlDomainId: 100, version: "9.0", ipAddress: "135.250.185.9", secondaryIpAddress: null, activeIpAddress: null, partnerNeId: 450, emlNeId: 72, otnNeId: 29, mibAlignmentState: "MibAlignmentState_aligned", nadString: "unknown", nprNeId: 8, otnConfDownldState: "GlobConfDwnldSt_enabled", opState: "OperationalState_enabled", supervisionState: "SupervisionState_supervised", neLabel: "PSS16-BA-01", primPassword: "IYsIiiNKi9s=", primLogin: "admin", tid: "", neType: "1830PSS-PHN" } }
External Docs
See Also :
Operation
get /nodeCache/nes/{userLabel}
To get the basic information of the ne with userLabel passed as path variable (getNesMap : /nodeCache/nes/{userLabel})
getNesMap
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
userLabel | required | userLabel | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Set[Oms1350NE]
|
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 /nodeCache/nodes
To get the basic information of all the nodes (getNodesMap : /nodeCache/nodes)
getNodesMap
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
List[Entry«int,Oms1350Node»]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
oms1350/nodeCache/nodes
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
{ 5: { nodeId: 5, commState: "CommState_available", mibAlignmentState: "MibAlignmentState_aligned", nodeLabel: "Site1-1", parentId: 11, confDownloadState: "ConfDownloadState_enabled", nadString: "unknown", reachable: "Boolean_true", supervisionState: "SupervisionState_supervised", neList: [3], external: false }, 8: { nodeId: 8, commState: "CommState_available", mibAlignmentState: "MibAlignmentState_aligned", nodeLabel: "PSS64-BA-02", parentId: 1, confDownloadState: "ConfDownloadState_enabled", nadString: "unknown", reachable: "Boolean_true", supervisionState: "SupervisionState_supervised", neList: [6], external: false }, 10: { nodeId: 10, commState: "CommState_available", mibAlignmentState: "MibAlignmentState_aligned", nodeLabel: "PSS16-BA-01", parentId: 8, confDownloadState: "ConfDownloadState_enabled", nadString: "unknown", reachable: "Boolean_true", supervisionState: "SupervisionState_supervised", neList: [8], external: false } }
External Docs
See Also :
Entry«int,Oms1350NE»
Name |
Type |
Description |
Enum |
---|---|---|---|
key | Oms1350NE Oms1350NE |
--- | --- |
Entry«int,Oms1350Node»
Name |
Type |
Description |
Enum |
---|---|---|---|
key | Oms1350Node Oms1350Node |
--- | --- |
NeState
Name |
Type |
Description |
Enum |
---|---|---|---|
neId | Integer integer |
--- | --- |
nodeId | Integer integer |
--- | --- |
communicationState | String string |
--- | [COMMUNICATION_STATE_UNKNOWN, COMMUNICATION_STATE_UP, COMMUNICATION_STATE_DOWN, COMMUNICATION_STATE_PARTIAL, COMMUNICATION_STATE_NA] |
supervisionState | String string |
--- | [SUPERVISION_STATE_NOT_SUPERVISED, SUPERVISION_STATE_SUPERVISING, SUPERVISION_STATE_SUPERVISION_FAILED, SUPERVISION_STATE_SUPERVISED, SUPERVISION_STATE_UNSUPERVISING, SUPERVISION_STATE_PARTIAL, SUPERVISION_STATE_NA] |
alignmentState | String string |
--- | [ALIGNMENT_STATE_UNKNOWN, ALIGNMENT_STATE_MISALIGNED, ALIGNMENT_STATE_READY_TO_ALIGN, ALIGNMENT_STATE_ALIGNING_UP, ALIGNMENT_STATE_ALIGNED, ALIGNMENT_STATE_PARTIAL, ALIGNMENT_STATE_NA] |
NodeState
Name |
Type |
Description |
Enum |
---|---|---|---|
nodeId | Integer integer |
--- | --- |
communicationState | String string |
--- | [COMMUNICATION_STATE_UNKNOWN, COMMUNICATION_STATE_UP, COMMUNICATION_STATE_DOWN, COMMUNICATION_STATE_PARTIAL, COMMUNICATION_STATE_NA] |
supervisionState | String string |
--- | [SUPERVISION_STATE_NOT_SUPERVISED, SUPERVISION_STATE_SUPERVISING, SUPERVISION_STATE_SUPERVISION_FAILED, SUPERVISION_STATE_SUPERVISED, SUPERVISION_STATE_UNSUPERVISING, SUPERVISION_STATE_PARTIAL, SUPERVISION_STATE_NA] |
alignmentState | String string |
--- | [ALIGNMENT_STATE_UNKNOWN, ALIGNMENT_STATE_MISALIGNED, ALIGNMENT_STATE_READY_TO_ALIGN, ALIGNMENT_STATE_ALIGNING_UP, ALIGNMENT_STATE_ALIGNED, ALIGNMENT_STATE_PARTIAL, ALIGNMENT_STATE_NA] |
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] |
neState | NeState NeState |
--- | --- |
newCommunicationState | String string |
--- | [COMMUNICATION_STATE_UNKNOWN, COMMUNICATION_STATE_UP, COMMUNICATION_STATE_DOWN, COMMUNICATION_STATE_PARTIAL, COMMUNICATION_STATE_NA] |
newSupervisionState | String string |
--- | [SUPERVISION_STATE_NOT_SUPERVISED, SUPERVISION_STATE_SUPERVISING, SUPERVISION_STATE_SUPERVISION_FAILED, SUPERVISION_STATE_SUPERVISED, SUPERVISION_STATE_UNSUPERVISING, SUPERVISION_STATE_PARTIAL, SUPERVISION_STATE_NA] |
alignmentState | String string |
--- | [ALIGNMENT_STATE_UNKNOWN, ALIGNMENT_STATE_MISALIGNED, ALIGNMENT_STATE_READY_TO_ALIGN, ALIGNMENT_STATE_ALIGNING_UP, ALIGNMENT_STATE_ALIGNED, ALIGNMENT_STATE_PARTIAL, ALIGNMENT_STATE_NA] |
neType | String string |
--- | --- |
Oms1350Node
Name |
Type |
Description |
Enum |
---|---|---|---|
nodeId | Integer integer |
--- | --- |
commState | String string |
--- | [CommState_available, CommState_partiallyUnavailable, CommState_unavailable, CommState_notProvided] |
mibAlignmentState | String string |
--- | [MibAlignmentState_aligned, MibAlignmentState_misaligned, MibAlignmentState_notProvided, MibAlignmentState_aligningUp, MibAlignmentState_aligningDown, MibAlignmentState_inConfig, MibAlignmentState_auditing, MibAlignmentState_partiallyAligned, MibAlignmentState_transient] |
nodeLabel | String string |
--- | --- |
parentId | Integer integer |
--- | --- |
confDownloadState | String string |
--- | [ConfDownloadState_enabled, ConfDownloadState_disabled, ConfDownloadState_enabling, ConfDownloadState_disabling, ConfDownloadState_failToEnable, ConfDownloadState_failToDisable] |
nadString | String string |
--- | --- |
reachable | String string |
--- | [Boolean_false, Boolean_true] |
supervisionState | String string |
--- | [SupervisionState_declared, SupervisionState_activating, SupervisionState_supervised, SupervisionState_deactivating, SupervisionState_notProvided, SupervisionState_partiallySupervised, SupervisionState_transient] |
neList | array[Integer] integer |
--- | --- |
nodeState | NodeState NodeState |
--- | --- |
newCommunicationState | String string |
--- | [COMMUNICATION_STATE_UNKNOWN, COMMUNICATION_STATE_UP, COMMUNICATION_STATE_DOWN, COMMUNICATION_STATE_PARTIAL, COMMUNICATION_STATE_NA] |
newSupervisionState | String string |
--- | [SUPERVISION_STATE_NOT_SUPERVISED, SUPERVISION_STATE_SUPERVISING, SUPERVISION_STATE_SUPERVISION_FAILED, SUPERVISION_STATE_SUPERVISED, SUPERVISION_STATE_UNSUPERVISING, SUPERVISION_STATE_PARTIAL, SUPERVISION_STATE_NA] |
alignmentState | String string |
--- | [ALIGNMENT_STATE_UNKNOWN, ALIGNMENT_STATE_MISALIGNED, ALIGNMENT_STATE_READY_TO_ALIGN, ALIGNMENT_STATE_ALIGNING_UP, ALIGNMENT_STATE_ALIGNED, ALIGNMENT_STATE_PARTIAL, ALIGNMENT_STATE_NA] |
external | Boolean boolean |
--- | --- |