Endpoint
/api/v2/tenants/{tenantId}/resourceMonitors
Path Parameters
tenantId
string

Describes the clientId or mspId of tenant

clientId

create_ts

desc
string

disc_freq_min
string

disc_lookup_Oid

disc_metric

disc_type
string

discoveryFilters

dynamicMetrics
array

dynamicMetrics.alertBody
dynamicMetrics.alertState
dynamicMetrics.alertSub
dynamicMetrics.consolFunc
dynamicMetrics.crc
dynamicMetrics.criticalOperatorChecked
dynamicMetrics.critical_oper
dynamicMetrics.ct
dynamicMetrics.cth
dynamicMetrics.customParams
dynamicMetrics.desc
dynamicMetrics.displayUnit
dynamicMetrics.dn
dynamicMetrics.dpe
dynamicMetrics.dprange
dynamicMetrics.dpt
dynamicMetrics.dpunit
dynamicMetrics.enumMap
dynamicMetrics.fac
dynamicMetrics.formattedDataUsage
dynamicMetrics.frmt
dynamicMetrics.gn
dynamicMetrics.gp
dynamicMetrics.intermediateMetric
dynamicMetrics.kbArticleUrl
dynamicMetrics.ma
dynamicMetrics.mc
dynamicMetrics.metric
dynamicMetrics.metricCollectorType
dynamicMetrics.metricDefType
dynamicMetrics.metric_oper
dynamicMetrics.ms
dynamicMetrics.mt
dynamicMetrics.mtn
dynamicMetrics.name
dynamicMetrics.oidExp
dynamicMetrics.operand
dynamicMetrics.operator
dynamicMetrics.re
dynamicMetrics.recommended
dynamicMetrics.resourceType
dynamicMetrics.st
dynamicMetrics.state
dynamicMetrics.type
dynamicMetrics.unit
dynamicMetrics.unitLabel
dynamicMetrics.useExpression
dynamicMetrics.uuid
dynamicMetrics.warnOperatorChecked
dynamicMetrics.warn_oper
dynamicMetrics.wrc
dynamicMetrics.wth
instanceIds

instanceType
string

monitorScope
integer

mspId

mulInst
boolean

name
string

resourceMonAdditionalParams
array

resourceMonAdditionalParams.enumMap
resourceMonAdditionalParams.expression
resourceMonAdditionalParams.format
resourceMonAdditionalParams.lookupOID
resourceMonAdditionalParams.name
resourceMonAdditionalParams.oid
resourceMonAdditionalParams.oidType
resourceMonAdditionalParams.operand
resourceMonAdditionalParams.operator
resourceMonAdditionalParams.propertyMode
resourceMonAdditionalParams.unit
resourceMonAdditionalParams.useExpression
serviceProviderId

staticMetrics

update_ts

uuid
string

[
  {
    "clientId": null,
    "collectorType": "SNMP",
    "create_ts": null,
    "cred_type": null,
    "customParams": null,
    "desc": "Monitorsthememorypoolutilizationbyapplicationsonthemanageddeviceandalsomonitorsthelargestcontiguousfreememory.[OID:1.3.6.1.4.1.9.9.48.1.1.1.2,1.3.6.1.4.1.9.9.48.1.1.1.4,1.3.6.1.4.1.9.9.48.1.1.1.5,1.3.6.1.4.1.9.9.48.1.1.1.6,1.3.6.1.4.1.9.9.48.1.1.1.7]",
    "disc_freq_min": "480",
    "disc_lookup_Oid": null,
    "disc_metric": null,
    "disc_type": "VALUE",
    "discoveryFilters": null,
    "dynamicMetrics": [
      {
        "alertBody": "Hostname:${resource.name}\nIP:${resource.ip}\nMetricName:${metric.name}\nMemoryPoolName:${component.name}\nSeverity:${severity}\nMemoryUsed:${ciscoMemoryPoolUsed}bytes\nMemoryFree:${ciscoMemoryPoolFree}bytes\nMemoryUtilization:${metric.value}\nReason:Ciscomemoryutilizationof${component.name}poolis${metric.value}(${threshold})",
        "alertState": "CRITICALANDWARNING",
        "alertSub": "${severity}-Ciscomemoryutilizationof${component.name}poolis${metric.value}(${threshold})",
        "consolFunc": "AVERAGE",
        "crc": 1,
        "criticalOperatorChecked": false,
        "critical_oper": "GREATER_THAN_EQUAL",
        "ct": null,
        "cth": "90",
        "customParams": null,
        "desc": "Monitorsthememoryutilizationofallmemorypoolslikeprocessorpool,I/Opool,Fastpooletc.[OID:1.3.6.1.4.1.9.9.48.1.1.1.2,1.3.6.1.4.1.9.9.48.1.1.1.4,1.3.6.1.4.1.9.9.48.1.1.1.5,1.3.6.1.4.1.9.9.48.1.1.1.6]",
        "displayUnit": null,
        "dn": "MemoryUtilization",
        "dpe": "if(ciscoMemoryPoolValid==1,(ciscoMemoryPoolUsed/(ciscoMemoryPoolUsed+ciscoMemoryPoolFree))*100,0)",
        "dprange": null,
        "dpt": "Gauge",
        "dpunit": null,
        "enumMap": "[{'0':'AdminDown'},{'1':'up'},{'2':'down'},{'3':'testing'},{'4':'unknown'},{'5':'dormant'},{'6':'notPresent'},{'7':'lowerLinkDown'}]",
        "fac": 1,
        "formattedDataUsage": "NONE",
        "frmt": "NONE",
        "gn": null,
        "gp": "HISTORICAL",
        "intermediateMetric": [
          {
            "dataTypes": "UINTEGER32",
            "formula": "None",
            "id": null,
            "name": "ciscoMemoryPoolValid",
            "oid": "1.3.6.1.4.1.9.9.48.1.1.1.4",
            "oidType": "TABULAROID",
            "pollFrequency": "NORMAL"
          },
          {
            "dataTypes": "GUAGE32",
            "formula": "None",
            "id": null,
            "name": "ciscoMemoryPoolUsed",
            "oid": "1.3.6.1.4.1.9.9.48.1.1.1.5",
            "oidType": "TABULAROID",
            "pollFrequency": "NORMAL"
          },
          {
            "dataTypes": "GUAGE32",
            "formula": "None",
            "id": null,
            "name": "ciscoMemoryPoolFree",
            "oid": "1.3.6.1.4.1.9.9.48.1.1.1.6",
            "oidType": "TABULAROID",
            "pollFrequency": "NORMAL"
          }
        ],
        "kbArticleUrl": null,
        "ma": null,
        "mc": null,
        "metric": "1.3.6.1.4.1.9.9.48.1.1.1.4",
        "metricCollectorType": null,
        "metricDefType": "DYNAMIC",
        "metric_oper": "VALUE",
        "ms": null,
        "mt": "RESOURCE",
        "mtn": null,
        "name": "cisco.memory.pool.util.percent",
        "oidExp": null,
        "operand": null,
        "operator": "NONE",
        "re": null,
        "recommended": 0,
        "resourceType": null,
        "st": null,
        "state": "Active",
        "type": null,
        "unit": "%",
        "unitLabel": "Percentage(%)",
        "useExpression": false,
        "uuid": "d03832e7-003c-4aae-b490-32f337691b49",
        "warnOperatorChecked": false,
        "warn_oper": "GREATER_THAN_EQUAL",
        "wrc": 1,
        "wth": "80"
      },
      {
        "alertBody": "Hostname:${resource.name}\nIP:${resource.ip}\nMetricName:${metric.name}\nMemoryPoolName:${component.name}\nSeverity:${severity}\nLargestMemoryFree:${metric.value}\nReason:Largestmemoryfreeof${component.name}poolis${metric.value}(${threshold})",
        "alertState": "CRITICALANDWARNING",
        "alertSub": "${severity}-Largestmemoryfreeof${component.name}poolis${metric.value}(${threshold})",
        "consolFunc": "AVERAGE",
        "crc": 1,
        "criticalOperatorChecked": false,
        "critical_oper": "LESS_THAN_EQUAL",
        "ct": null,
        "cth": "500",
        "customParams": null,
        "desc": "Monitorsthelargestcontiguousblockofmemoryfree.[OID:1.3.6.1.4.1.9.9.48.1.1.1.2,1.3.6.1.4.1.9.9.48.1.1.1.7]",
        "displayUnit": null,
        "dn": "LargestMemoryFree",
        "dpe": "(ciscoMemoryPoolLargestFree)/1024",
        "dprange": null,
        "dpt": "Gauge",
        "dpunit": null,
        "enumMap": "[{'0':'AdminDown'},{'1':'up'},{'2':'down'},{'3':'testing'},{'4':'unknown'},{'5':'dormant'},{'6':'notPresent'},{'7':'lowerLinkDown'}]",
        "fac": 1,
        "formattedDataUsage": "NONE",
        "frmt": "NONE",
        "gn": null,
        "gp": "HISTORICAL",
        "intermediateMetric": [
          {
            "dataTypes": "GUAGE32",
            "formula": "None",
            "id": null,
            "name": "ciscoMemoryPoolLargestFree",
            "oid": "1.3.6.1.4.1.9.9.48.1.1.1.7",
            "oidType": "TABULAROID",
            "pollFrequency": "NORMAL"
          }
        ],
        "kbArticleUrl": null,
        "ma": null,
        "mc": null,
        "metric": "1.3.6.1.4.1.9.9.48.1.1.1.7",
        "metricCollectorType": null,
        "metricDefType": "DYNAMIC",
        "metric_oper": "VALUE",
        "ms": null,
        "mt": "RESOURCE",
        "mtn": null,
        "name": "cisco.memory.pool.largest.free",
        "oidExp": null,
        "operand": null,
        "operator": "NONE",
        "re": null,
        "recommended": 0,
        "resourceType": null,
        "st": null,
        "state": "Active",
        "type": null,
        "unit": "Kb",
        "unitLabel": "KiloBits(Kb)",
        "useExpression": false,
        "uuid": "5cdccfa8-6767-40b9-aa50-e82f566862c6",
        "warnOperatorChecked": false,
        "warn_oper": "LESS_THAN_EQUAL",
        "wrc": 1,
        "wth": "600"
      }
    ],
    "instanceIds": null,
    "instanceType": "ALL",
    "monitorScope": 0,
    "mspId": null,
    "mulInst": true,
    "name": "CiscoMemory",
    "resourceMonAdditionalParams": [
      {
        "enumMap": null,
        "expression": null,
        "format": "OCTETSTRING",
        "lookupOID": null,
        "name": "Name",
        "oid": "1.3.6.1.4.1.9.9.48.1.1.1.2",
        "oidType": "SCALAROID",
        "operand": null,
        "operator": "NONE",
        "propertyMode": "VALUE",
        "unit": null,
        "useExpression": false
      }
    ],
    "serviceProviderId": null,
    "staticMetrics": null,
    "update_ts": null,
    "uuid": "bc6649b9-6f6e-4256-9bca-66669b177cde"
  }
]

Responses

OK

createdCount
integer

failedCount
integer

failedList
object

updatedCount
integer

{
  "createdCount": 1,
  "failedCount": 0,
  "failedList": {},
  "updatedCount": 0
}