Operation

post /data/common/sysmon/agents/{ids}
agentActions (agentActions : /data/common/sysmon/agents/{ids})
agentActions

Path parameters

Name

IsRequired

Description

Enum

ids required ids ---
Request body

Name

IsRequired

Description

Data Type

Enum

body optional request ServletWebRequest ---
body2 optional session HttpSession ---
body3 optional bodyForm String ---

Return type
  • NprResponse
  • Responses

    Response Messages

    Schema

    200success NprResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    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.
    • */*

    External Docs
    See Also :

    Operation

    post /data/common/sysmon/apps/{ids}
    appsActions (appsActions : /data/common/sysmon/apps/{ids})
    appsActions

    Path parameters

    Name

    IsRequired

    Description

    Enum

    ids required ids ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---
    body3 optional bodyForm String ---

    Return type
  • NprResponse
  • Responses

    Response Messages

    Schema

    200success NprResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    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.
    • */*

    External Docs
    See Also :

    Operation

    get /data/common/sysmon/agents/{id}/children
    getAgentChilds (getAgentChilds : /data/common/sysmon/agents/{id}/children)
    getAgentChilds

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • array[AgentChild]
  • Responses

    Response Messages

    Schema

    200success array[AgentChild]
    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.
    • */*

    External Docs
    See Also :

    Operation

    get /data/common/sysmon/agents/{ids}
    getAgents (getAgents : /data/common/sysmon/agents/{ids})
    getAgents

    Path parameters

    Name

    IsRequired

    Description

    Enum

    ids required ids ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • array[Agent]
  • Responses

    Response Messages

    Schema

    200success array[Agent]
    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.
    • */*

    External Docs
    See Also :

    Operation

    get /data/common/sysmon/apps/{id}/cpu
    getAppCpus (getAppCpus : /data/common/sysmon/apps/{id}/cpu)
    getAppCpus

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • array[Cpu]
  • Responses

    Response Messages

    Schema

    200success array[Cpu]
    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.
    • */*

    External Docs
    See Also :

    Operation

    get /data/common/sysmon/apps/{id}/fs
    getAppFS (getAppFS : /data/common/sysmon/apps/{id}/fs)
    getAppFS

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • array[FileSystem]
  • Responses

    Response Messages

    Schema

    200success array[FileSystem]
    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.
    • */*

    External Docs
    See Also :

    Operation

    get /data/common/sysmon/apps/{ids}/groups
    getAppGroups (getAppGroups : /data/common/sysmon/apps/{ids}/groups)
    getAppGroups

    Path parameters

    Name

    IsRequired

    Description

    Enum

    ids required ids ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • array[Group]
  • Responses

    Response Messages

    Schema

    200success array[Group]
    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.
    • */*

    External Docs
    See Also :

    Operation

    get /data/common/sysmon/apps/{id}/host
    getAppHost (getAppHost : /data/common/sysmon/apps/{id}/host)
    getAppHost

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • Host
  • Responses

    Response Messages

    Schema

    200success Host
    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.
    • */*

    External Docs
    See Also :

    Operation

    get /data/common/sysmon/apps/{id}/runLevels
    getAppRL (getAppRL : /data/common/sysmon/apps/{id}/runLevels)
    getAppRL

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • array[RunLevel]
  • Responses

    Response Messages

    Schema

    200success array[RunLevel]
    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.
    • */*

    External Docs
    See Also :

    Operation

    get /data/common/sysmon/apps
    Retrieves a list of all NFM-T Application Instances with their overall HA Status and System Monitoring status (getApps : /data/common/sysmon/apps)
    The response contains the list of Application Instances with the following attributes.

    guilabel : the name of the Application Istance (i.e OTNE_1-18, EML_2-18)
    id : Application Instance unique identifier

    haStatus: High Availability Status valid values are
    haUDF (Undefined/Not configured),
    haACT (ACTIVE ),
    haToACT (performing TO ACTIVE transition),
    haToSBY (performing TO STANDBY transition),
    haSBY (Cold StandBY),
    haHotSBY (HotStandby, with the Oracle DB running in ReadOnly Mode),
    haToHotSBY (performing TO HOT STANDBY transition),
    haWRONG (Wrong state, after a failure on Switchover/ToACTIVE/ToSTANDBY/ToHotSTANDBY),
    haUNR (Unreachable),
    haCompanionStatus: the haStatus of the companion Application Instance (applications on NOC have companinons on DRC, and viceversa),
    replicaStatus: replication status valid value are
    replicaUDF (Undefined, HotHA not configured or not working on this application instance),
    replicaON,
    replicaOFF,
    replicaSTARTING1 (starting step 1),
    replicaSTARTING2 (starting step 2),
    replicaSTARTING3 (starting step 3),
    replicaSTARTING4 (starting step 4),
    replicaSTARTING5 (starting step 5),
    replicaSTOPPING,
    replicaERROR,

    status: overall processes status, valid value are
    RUN ( All processes are Running ),
    STOP (All processes are stopped ),
    WRONG (Some processes are not running),
    UNKNOWN (Unknown status, failing in getting process status, the server could be unreacheable),
    WORKING (Process Monitor is working , starting/stopping processes),
    servStatus: overall Services status , same values as status attribute,
    fileSystemStatus: fileSystems usage, possible values are Normal,Warning,Critical
    cpuStatus: cpus usage, possible values are Normal,Warning,Critical
    memStatus: memory usage, possible values aNormal,Warning,Critical

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • App
  • Responses

    Response Messages

    Schema

    200success App
    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.
    • */*

    External Docs
    See Also :

    Operation

    get /data/common/sysmon/apps/{id}
    getAppsId (getAppsId : /data/common/sysmon/apps/{id})
    getAppsId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • App
  • Responses

    Response Messages

    Schema

    200success App
    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.
    • */*

    External Docs
    See Also :

    Operation

    get /data/common/sysmon/groups/{id}
    getGroups (getGroups : /data/common/sysmon/groups/{id})
    getGroups

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • Group
  • Responses

    Response Messages

    Schema

    200success Group
    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.
    • */*

    External Docs
    See Also :

    Operation

    get /data/common/sysmon/groups/{ids}/agents
    getGroupsAgents (getGroupsAgents : /data/common/sysmon/groups/{ids}/agents)
    getGroupsAgents

    Path parameters

    Name

    IsRequired

    Description

    Enum

    ids required ids ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • array[Agent]
  • Responses

    Response Messages

    Schema

    200success array[Agent]
    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.
    • */*

    External Docs
    See Also :

    Operation

    get /data/common/sysmon/apps/{id}/services
    getService (getService : /data/common/sysmon/apps/{id}/services)
    getService

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • Service
  • Responses

    Response Messages

    Schema

    200success Service
    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.
    • */*

    External Docs
    See Also :

    Operation

    get /data/common/sysmon/alarmCurrent
    getSysAlarms (getSysAlarms : /data/common/sysmon/alarmCurrent)
    getSysAlarms

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • array[SystemAlarm]
  • Responses

    Response Messages

    Schema

    200success array[SystemAlarm]
    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.
    • */*

    External Docs
    See Also :

    Operation

    get /data/common/sysmon/sysprop
    getSysProp (getSysProp : /data/common/sysmon/sysprop)
    getSysProp

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    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.
    • */*

    External Docs
    See Also :

    Operation

    post /data/common/sysmon/groups/{ids}
    groupActions (groupActions : /data/common/sysmon/groups/{ids})
    groupActions

    Path parameters

    Name

    IsRequired

    Description

    Enum

    ids required ids ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---
    body3 optional bodyForm String ---

    Return type
  • NprResponse
  • Responses

    Response Messages

    Schema

    200success NprResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    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.
    • */*

    External Docs
    See Also :

    Operation

    post /data/common/sysmon/apps
    HAglobalActions (hAglobalActions : /data/common/sysmon/apps)
    HAglobalActions

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---
    body3 optional bodyForm String ---

    Return type
  • HaResponse
  • Responses

    Response Messages

    Schema

    200success HaResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    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.
    • */*

    External Docs
    See Also :

    Operation

    get /data/common/sysmon/apps/{ids}/reload
    reloadGroups (reloadGroups : /data/common/sysmon/apps/{ids}/reload)
    reloadGroups

    Path parameters

    Name

    IsRequired

    Description

    Enum

    ids required ids ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Return type
  • array[Group]
  • Responses

    Response Messages

    Schema

    200success array[Group]
    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.
    • */*

    External Docs
    See Also :

    Operation

    get /data/common/sysmon/apps/snap
    testsnap (testsnap : /data/common/sysmon/apps/snap)
    testsnap

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional request ServletWebRequest ---
    body2 optional session HttpSession ---

    Responses

    Response Messages

    Schema

    200OK ---
    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.
    • */*

    External Docs
    See Also :

    Agent

    Name

    Type

    Description

    Enum

    ObjectId Integer integer --- ---
    EventType String string --- ---
    ClassType String string --- ---
    IdClass Integer integer --- ---
    guiLabel String string --- ---
    id Integer integer --- ---
    className String string --- ---
    appLabel String string --- ---
    groupLabel String string --- ---
    agentStartWait Integer integer --- ---
    agentShutWait Integer integer --- ---
    agentType String string --- ---
    agentTraceLocation String string --- ---
    agentTraceDefault String string --- ---
    agentTraceList String string --- ---
    agentMaxRestart Integer integer --- ---
    agentRunLevel String string --- ---
    agentCritical String string --- ---
    children Boolean boolean --- ---
    status String string --- ---
    control String string --- ---
    memory Integer integer --- ---
    pid Integer integer --- ---
    statTime String string --- ---
    workInProgress String string --- ---
    serv Boolean boolean --- ---
    controlApp String string --- ---

    AgentChild

    Name

    Type

    Description

    Enum

    ObjectId Integer integer --- ---
    EventType String string --- ---
    ClassType String string --- ---
    IdClass Integer integer --- ---
    guiLabel String string --- ---
    id Integer integer --- ---
    className String string --- ---
    memory Integer integer --- ---
    pid Integer integer --- ---
    childInstance Integer integer --- ---
    chRunLevel String string --- ---
    status String string --- ---
    control Integer integer --- ---
    startTime String string --- ---
    workInProgress String string --- ---

    App

    Name

    Type

    Description

    Enum

    ObjectId Integer integer --- ---
    EventType String string --- ---
    ClassType String string --- ---
    IdClass Integer integer --- ---
    guiLabel String string --- ---
    id Integer integer --- ---
    className String string --- ---
    key String string --- ---
    haStatus String string --- ---
    haCompanionStatus String string --- ---
    replicaStatus String string --- ---
    replicaStatusDB String string --- ---
    replicaStatusFile String string --- ---
    replicaStatusNspFM String string --- ---
    replicaStatusNrct String string --- ---
    license String string --- ---
    sysType String string --- ---
    status String string --- ---
    servStatus String string --- ---
    fileSystemStatus String string --- ---
    cpuStatus String string --- ---
    memStatus String string --- ---
    runLevel String string --- ---
    control String string --- ---
    autoStart String string --- ---
    hostName String string --- ---
    pmcHardDepend Integer integer --- ---
    runLevelList String string --- ---
    pmcimState String string --- ---
    pmcimStateTime String string --- ---
    lastManOpDateTime String string --- ---

    Cpu

    Name

    Type

    Description

    Enum

    ObjectId Integer integer --- ---
    EventType String string --- ---
    ClassType String string --- ---
    IdClass Integer integer --- ---
    guiLabel String string --- ---
    id Integer integer --- ---
    className String string --- ---
    cpuUser String string --- ---
    cpuNice String string --- ---
    cpuSys String string --- ---
    cpuIdle String string --- ---
    cpuIoWait String string --- ---
    cpuIrq String string --- ---
    cpuSoftIrq String string --- ---
    cpuSteal String string --- ---

    FileSystem

    Name

    Type

    Description

    Enum

    ObjectId Integer integer --- ---
    EventType String string --- ---
    ClassType String string --- ---
    IdClass Integer integer --- ---
    guiLabel String string --- ---
    id Integer integer --- ---
    className String string --- ---
    totalSize String string --- ---
    availableSize String string --- ---
    percUsage String string --- ---
    status String string --- ---

    Group

    Name

    Type

    Description

    Enum

    ObjectId Integer integer --- ---
    EventType String string --- ---
    ClassType String string --- ---
    IdClass Integer integer --- ---
    guiLabel String string --- ---
    id Integer integer --- ---
    className String string --- ---
    appLabel String string --- ---
    key String string --- ---
    type String string --- ---
    groupStart String string --- ---
    groupShut String string --- ---
    groupLevel Integer integer --- ---
    groupShutWait Integer integer --- ---
    groupStartWait Integer integer --- ---
    groupFileSt String string --- ---
    status String string --- ---
    controlApp String string --- ---

    HaResponse

    Name

    Type

    Description

    Enum

    HTTPResponse Integer integer --- ---
    ok Boolean boolean --- ---
    id String string --- ---
    responseMessage String string --- ---
    responseList array[Object] object --- ---
    status String string --- ---

    Host

    Name

    Type

    Description

    Enum

    ObjectId Integer integer --- ---
    EventType String string --- ---
    ClassType String string --- ---
    IdClass Integer integer --- ---
    guiLabel String string --- ---
    id Integer integer --- ---
    className String string --- ---
    numPrcAct Integer integer --- ---
    numPrcRun Integer integer --- ---
    numPrcSlp Integer integer --- ---
    numPrcZmb Integer integer --- ---
    totRealMemory Integer integer --- ---
    actRealMemory Integer integer --- ---
    totMemVir Integer integer --- ---
    actMemVir Integer integer --- ---
    freeMemory Integer integer --- ---
    avgCpuGlb String string --- ---

    NprResponse

    Name

    Type

    Description

    Enum

    HTTPResponse Integer integer --- ---
    ok Boolean boolean --- ---
    id String string --- ---
    responseMessage String string --- ---
    responseList array[Object] object --- ---

    RunLevel

    Name

    Type

    Description

    Enum

    guiLabel String string --- ---
    id Integer integer --- ---
    className String string --- ---

    Service

    Name

    Type

    Description

    Enum

    ObjectId Integer integer --- ---
    EventType String string --- ---
    ClassType String string --- ---
    IdClass Integer integer --- ---
    guiLabel String string --- ---
    id Integer integer --- ---
    className String string --- ---
    status String string --- ---
    runLevel String string --- ---
    control String string --- ---
    autoStart String string --- ---
    pmcHardDepend Integer integer --- ---
    pmcimState String string --- ---
    pmcimStateTime String string --- ---
    lastManOpDateTime String string --- ---

    SystemAlarm

    Name

    Type

    Description

    Enum

    ObjectId Integer integer --- ---
    EventType String string --- ---
    ClassType String string --- ---
    IdClass Integer integer --- ---
    guiLabel String string --- ---
    id Integer integer --- ---
    className String string --- ---
    classTag String string --- ---
    alarmTag String string --- ---
    alarmParameters array[String] string --- ---
    raiseDate String string --- ---
    expireDate String string --- ---

    Void

    Name

    Type

    Description

    Enum