Operation

get /nodeCache/ne/{groupId}/{neId}
getNE (getNE : /nodeCache/ne/{groupId}/{neId})
getNE

Path parameters

Name

IsRequired

Description

Enum

groupId required groupId ---
neId required neId ---

Return type
  • Oms1350NE
  • 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
    getNesMap (getNesMap : /nodeCache/nes)
    getNesMap


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

    Response Messages

    Schema

    200success List[Entry«int,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/{userLabel}
    getNesMap (getNesMap : /nodeCache/nes/{userLabel})
    getNesMap

    Path parameters

    Name

    IsRequired

    Description

    Enum

    userLabel required userLabel ---

    Return type
  • Set[Oms1350NE]
  • 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
    getNodesMap (getNodesMap : /nodeCache/nodes)
    getNodesMap


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

    Response Messages

    Schema

    200success List[Entry«int,Oms1350Node»]
    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 :

    Entry«int,Oms1350NE»

    Name

    Type

    Description

    Enum

    key Oms1350NE Oms1350NE --- ---

    Entry«int,Oms1350Node»

    Name

    Type

    Description

    Enum

    key Oms1350Node Oms1350Node --- ---

    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 --- ---

    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 --- ---
    external Boolean boolean --- ---