Operation

get /esmDiscovery/GetIsDiscoveryInProgress
getIsDiscoveryInProgress (getIsDiscoveryInProgress : /esmDiscovery/GetIsDiscoveryInProgress)
getIsDiscoveryInProgress


Return type
  • Boolean
  • Responses

    Response Messages

    Schema

    200success Boolean
    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 /esmDiscovery/GetIsSyncInProgress/{localTimeZoneOffset}
    Gets boolean value if Sync is in progress (getIsSyncInProgress : /esmDiscovery/GetIsSyncInProgress/{localTimeZoneOffset})
    getIsSyncInProgress

    Path parameters

    Name

    IsRequired

    Description

    Enum

    localTimeZoneOffset required clientZoneOffset ---

    Return type
  • Boolean
  • Responses

    Response Messages

    Schema

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

    /esmDiscovery/GetIsSyncInProgress/{localTimeZoneOffset}

    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
    true

    External Docs
    See Also :

    Operation

    get /esmDiscovery/GetIsSyncOrDiscoveryInProgress/{localTimeZoneOffset}
    Gets boolean value if Sync or discovery is in progress (getIsSyncOrDiscoveryInProgress : /esmDiscovery/GetIsSyncOrDiscoveryInProgress/{localTimeZoneOffset})
    getIsSyncOrDiscoveryInProgress

    Path parameters

    Name

    IsRequired

    Description

    Enum

    localTimeZoneOffset required clientZoneOffset ---

    Return type
  • Boolean
  • Responses

    Response Messages

    Schema

    200success Boolean
    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 /esmDiscovery/schedNetworkDiscovery
    Schedules a Network Discovery (scheduleNetworkDiscovery : /esmDiscovery/schedNetworkDiscovery)
    This operation Syncs all elements present on NE to ESM,Dsicovers Services, ERP, LAG, MCLAG, NPA and Tunnels. It also updates inconsistencies as and when it discovers a service if any of the elementary or network level entities are missing.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional dataHolder N_NetworkDiscoveryDataHolder ---

    Return type
  • Lag Response Data Holder
  • Responses

    Response Messages

    Schema

    200success Lag Response Data Holder
    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

    <N_NetworkDiscoveryDataHolder> <reqId> <reqId>7</reqId> <clientName>testUser</clientName> </reqId> <scheduler> <jobName>NetworkDiscovery_Fri Jan 15 2016 13:45:35 IST</jobName> <jobDescription/> <username/> <trigger> <name>NetworkDiscovery_Fri Jan 15 2016 13:45:35 IST</name> <deployNow>Yes</deployNow> <type/> <expression/> <timeOffset/> </trigger> </scheduler> </N_NetworkDiscoveryDataHolder>

    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
    <N_NetworkDiscoveryRespHolder> <req> <clientName>testUser</clientName> <selectiveSyncViaPolling>false</selectiveSyncViaPolling> </req> <errorReason>null</errorReason> <errorCode>null</errorCode> <message>null</message> <cmdStatus>Success </cmdStatus> <opMsg>null</opMsg> <msgCode>NETWORK_DISCOVERY_SUCCESS_0001</msgCode> <parameters>null</parameters> <paramCount>0</paramCount> </N_NetworkDiscoveryRespHolder>

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

    Lag Response Data Holder

    Name

    Type

    Description

    Enum

    responseId Response Header Model Response Header Model responseId ---
    rsp N_LagId N_LagId response ---

    N_LagId

    Name

    Type

    Description

    Enum

    managementState String string LAG management state ---
    targetManagementState String string --- ---
    vsId String string --- ---
    lagId String string Unique ID used to identify a LAG. ---
    neName String string NE name on which LAG is created. ---
    packName String string Pack name on the NE on which LAG is created. ---
    adminState String string Used to denote whether the LAG is active on NE or not. ---
    lagSequence Long long --- ---
    jobTaskId Long long --- ---

    N_NetworkDiscoveryDataHolder

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

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