Operation

get /esmBrowser/RMDDiscovery/getAllFilteredPorts/{nodeName}/{portName}
getAllFilteredPorts (getAllFilteredPorts : /esmBrowser/RMDDiscovery/getAllFilteredPorts/{nodeName}/{portName})
return All Filtered Ports

Path parameters

Name

IsRequired

Description

Enum

nodeName required NE Name, The value for Node Name can get using GetAllL2CardsList/{localTimeZoneOffset} ---
portName required Port Name, The value for Port Name can get using getAllLinks/{localTimeZoneOffset} ---

Return type
  • UIMapperRMD
  • Responses

    Response Messages

    Schema

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

    /esmBrowser/RMDDiscovery/getAllFilteredPorts/REST-K/0?request.preventCache=1457950471421

    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
    { "supportedNe": null, "portData": [ { "tpid": 514, "tpName": "11QCE12X-2-7-C1", "portState": "Not In Service", "portActualState": "Out of Service - Autonomous" }, { "tpid": 506, "tpName": "11QCE12X-2-7-C10", "portState": "Not In Service", "portActualState": "Out of Service - Autonomous and Management" }, { "tpid": 504, "tpName": "11QCE12X-2-7-C11", "portState": "Not In Service", "portActualState": "Out of Service - Autonomous and Management" }, { "tpid": 533, "tpName": "11QCE12X-2-7-C12", "portState": "Not In Service", "portActualState": "Out of Service - Autonomous and Management" }, { "tpid": 531, "tpName": "11QCE12X-2-7-C13", "portState": "Not In Service", "portActualState": "Out of Service - Autonomous and Management" }, { "tpid": 535, "tpName": "11QCE12X-2-7-C14", "portState": "Not In Service", "portActualState": "Out of Service - Autonomous and Management" }, { "tpid": 534, "tpName": "11QCE12X-2-7-C15", "portState": "Not In Service", "portActualState": "Out of Service - Autonomous and Management" }, { "tpid": 539, "tpName": "11QCE12X-2-7-C16", "portState": "Not In Service", "portActualState": "Out of Service - Autonomous and Management" }, { "tpid": 536, "tpName": "11QCE12X-2-7-C17", "portState": "Not In Service", "portActualState": "Out of Service - Autonomous and Management" }, { "tpid": 545, "tpName": "11QCE12X-2-7-C18", "portState": "Not In Service", "portActualState": "Out of Service - Autonomous and Management" }, { "tpid": 542, "tpName": "11QCE12X-2-7-C19", "portState": "Not In Service", "portActualState": "Out of Service - Autonomous and Management" }, { "tpid": 513, "tpName": "11QCE12X-2-7-C2", "portState": "Not In Service", "portActualState": "Out of Service - Autonomous and Management" }, { "tpid": 523, "tpName": "11QCE12X-2-7-C20", "portState": "Not In Service", "portActualState": "Out of Service - Autonomous and Management" }, { "tpid": 520, "tpName": "11QCE12X-2-7-C21", "portState": "Not In Service", "portActualState": "Out of Service - Autonomous and Management" }, { "tpid": 521, "tpName": "11QCE12X-2-7-C22", "portState": "Not In Service", "portActualState": "Out of Service - Autonomous and Management" }, { "tpid": 512, "tpName": "11QCE12X-2-7-C3", "portState": "Not In Service", "portActualState": "Out of Service - Autonomous" }, { "tpid": 511, "tpName": "11QCE12X-2-7-C4", "portState": "Not In Service", "portActualState": "Out of Service - Autonomous" }, { "tpid": 510, "tpName": "11QCE12X-2-7-C5", "portState": "Not In Service", "portActualState": "Out of Service - Autonomous" }, { "tpid": 509, "tpName": "11QCE12X-2-7-C6", "portState": "Not In Service", "portActualState": "Out of Service - Autonomous and Management" }, { "tpid": 526, "tpName": "11QCE12X-2-7-C7", "portState": "Not In Service", "portActualState": "Out of Service - Autonomous and Management" }, { "tpid": 525, "tpName": "11QCE12X-2-7-C8", "portState": "Not In Service", "portActualState": "Out of Service - Autonomous and Management" }, { "tpid": 524, "tpName": "11QCE12X-2-7-C9", "portState": "Not In Service", "portActualState": "Out of Service - Autonomous and Management" }, { "tpid": 2729, "tpName": "11QCE12X-3-7-C1", "portState": "Not In Service", "portActualState": "Out of Service - Autonomous and Management" }, { "tpid": 2733, "tpName": "11QCE12X-3-7-C2", "portState": "Not In Service", "portActualState": "Out of Service - Autonomous and Management" }, { "tpid": 2735, "tpName": "11QCE12X-3-7-C5", "portState": "Not In Service", "portActualState": "Out of Service - Autonomous" } ] }

    External Docs
    See Also :

    Operation

    get /esmBrowser/RMDDiscovery/getAllSupportedNE
    getAllSupportedNE (getAllSupportedNEs : /esmBrowser/RMDDiscovery/getAllSupportedNE)
    return All Supported NEs


    Return type
  • UIMapperRMD
  • Responses

    Response Messages

    Schema

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

    /esmBrowser/RMDDiscovery/getAllSupportedNE?request.preventCache=1457950471324

    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
    { "supportedNe": [ { "neId": 7, "neName": "REST-K" }, { "neId": 17, "neName": "REST-N" }, { "neId": 13, "neName": "REST-O" } ], "portData": null }

    External Docs
    See Also :

    Operation

    post /esmBrowser/RMDDiscovery/schedRMDDiscovery
    schedRMDDiscovery (scheduleRMDDiscovery : /esmBrowser/RMDDiscovery/schedRMDDiscovery)

    It is used for discovering Remote managed devices on the network elements.Discovery can be trigged on multiple ports of same or different NEs.

    Validation and Restriction
    RMD discovery is allowed only on 11QCE12X and 11QPE24 cards.
    RMD discovery is allowed only on ports with "1GbE" rate.
    This is a scheduled operation in ESM. Only schedule now is supported for RMD discovery.

    Access Interface Id and RMD instance entries are saved in ESM DB.The Ids from Access Interface and RMD are generated from ID pool.

    Entries created/updated on the NE during RMD discovery
    1. Access Interface Id
    2. Remote managed device

    Steps:
    1. Access Interface Id and Remote managed device details are synced and updated in ESM.
    2. If there is any CFM device present in the ESM, CFM device details are also synced.
    3. Discovery steps:
    Discovery can be triggered on multiple ports of the same or different NE. In case of multiple ports, Discovery steps mentioned below will be executed once of every port.
    a. Access Interface id will be created on the port.
    b. RMD discovery will be triggered on network element for the access interface created in step a.
    c. On discovery completion, if it is successful, the discovered information will be retrieved from network element.
    d. RMD instance will be created from the information retrieved in step c.
    4. Details of the device discovered in step 3 will be synced in ESM. And will be updated in ESM DB.
    5. All the commands executed and their status along with error reason if failed, will be logged in ESM job list.
    6. On successful discovery, RMD instance will be available under Operate->RMD with device state "normal".
    7. If there is no remote managed device discovered for a given port, respective ESM entries for AID and RMD will be cleaned up in ESM.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional dataHolder N_RMDDiscoveryDataHolder ---

    Return type
  • RMDDiscoveryRespHolder
  • Responses

    Response Messages

    Schema

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

    <RMDDiscoveryDataHolder> <reqId> <reqId>4</reqId> <clientName>testUser</clientName> </reqId> <scheduler> <jobName>RMDDiscovery</jobName> <jobDescription/> <username>alcatel</username> <trigger> <name>NetworkDiscovery</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> <portDataDiscoveryList> <portData> <tpid>2498</tpid> <tpName>11QPE24-1-7-C15</tpName> <neName>PSS4-BA-03</neName> <ouid>00:0F:25</ouid> </portData> </portDataDiscoveryList> </RMDDiscoveryDataHolder>

    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/xml
    Example Response Data
    <RMDDiscoveryRespHolder> <responseId> <cmdStatus>Success</cmdStatus> <errorReason/> <msgCode>RMD_DISCOVERY_SUCCESS_0001</msgCode> <opMsg/> <paramCount>0</paramCount> </responseId> </RMDDiscoveryRespHolder>

    External Docs
    See Also :

    EsmRequestHeaderMapper

    Name

    Type

    Description

    Enum

    reqId String string Request ID ---
    clientName String string Client name ---

    ESMSchedulerDataModel

    Name

    Type

    Description

    Enum

    jobName String string Job Name ---
    jobDescription String string Job description ---
    username String string User name ---
    trigger ESMSchedulerTriggerDataModel ESMSchedulerTriggerDataModel Job Trigger data model ---

    ESMSchedulerTriggerDataModel

    Name

    Type

    Description

    Enum

    name String string Trigger Name ---
    deployNow String string Deploy Now [Yes]
    type String string Job Type ---
    expression String string Job trigger expression ---
    timeOffset String string User PC time zone offset ---

    N_PortData

    Name

    Type

    Description

    Enum

    tpid Integer integer --- ---
    tpName String string --- ---
    portState String string --- ---
    portActualState String string --- ---

    N_PortDataDiscovery

    Name

    Type

    Description

    Enum

    tpid Integer integer --- ---
    tpName String string --- ---
    neName String string --- ---
    ouid String string --- ---

    N_RMDDiscoveryDataHolder

    Name

    Type

    Description

    Enum

    sessionId String string --- ---
    requestURI String string --- ---
    logReqId String string --- ---
    operator String string --- ---
    client String string --- ---
    reqId EsmRequestHeaderMapper EsmRequestHeaderMapper --- ---
    scheduler ESMSchedulerDataModel ESMSchedulerDataModel --- ---
    portDataDiscovery array[N_PortDataDiscovery] N_PortDataDiscovery --- ---
    activate Boolean boolean --- ---

    N_SupportedNEData

    Name

    Type

    Description

    Enum

    neId Integer integer --- ---
    neName String string --- ---
    neReachability String string NeReachability [Yes, No]

    Request Header

    Name

    Type

    Description

    Enum

    reqId String string ReqId ---
    respBeanRef String string --- ---
    clientName String string ClientName ---
    selectiveSyncViaPolling Boolean boolean --- ---

    Response Header Model

    Name

    Type

    Description

    Enum

    req Request Header Request Header req ---
    errorReason String string errorReason [Error reason]
    errorCode String string --- ---
    message String string --- ---
    cmdStatus String string cmdStatus [Success, Failure, Timed-Out, Unknown]
    opMsg String string Operation message ---
    msgCode String string msgCode [Message code]
    parameters array[String] string --- ---
    paramCount Integer integer parameter count returned in the response ---
    objectId Integer integer Object Id ---
    jobName String string Job Name ---
    objectType Integer integer Job Object TYpe ---

    RMDDiscoveryRespHolder

    Name

    Type

    Description

    Enum

    responseId Response Header Model Response Header Model RMDDiscoveryRespHolder ---

    UIMapperRMD

    Name

    Type

    Description

    Enum

    supportedNe array[N_SupportedNEData] N_SupportedNEData getSupportedNe ---
    portData array[N_PortData] N_PortData getPortData ---