• 入门
  • 告警
     
  • 可用性
     
  • 业务视图
     
  • 仪表板
     
  • 设备
     
  • 发现
  • 企业版
  • 事件
     
  •  
  • 接口
     
  • 监视器
     
  • 通知
     
  • 报表
     
  • 设置
     
  • 无线
     

OpManager REST API

OpManager提供REST api,用于从OpManager中添加和获取数据。使用这些api,您可以将OpManager与第三方IT管理/服务台软件集成。

OpManager REST API是如何工作的?

API使用API密钥。API密钥对于每个OpManager帐户是唯一的,并且对于所有API请求都是必需的。 了解如何启用或禁用Rest API密钥

如何查看API密钥?

要查看或复制API密钥,请转到OpManager Web客户端中的快速链接>Rest API Key选项。(快速链接选项是右上角的齿轮图标)

​怎样发送api密钥?

​基于请求参数的 apiKey 身份验证功能已弃用。在版本 128100 之前,可以通过 request 参数发送 apiKey。从版本 128100 开始,apiKey 现在可以在请求标头中发送,也可以作为请求参数发送。

注意: 对基于请求参数的 apiKey 身份验证的支持即将结束。以下 URL 列表应仅通过请求标头使用 apiKey 调用。基于请求参数的 ApiKey 身份验证不适用于这些 URL。

API
/api/json/alarm/listAlarms
/api/json/admin/addLinuxCredential
/api/json/discovery/addDiscoveryProfile
/api/json/discovery/editDiscoveryProfile
/api/json/v2/discovery/addDiscoveryProfile
/api/json/v2/discovery/editDiscoveryProfile
/api/json/ncmsettings/importSSHKey
/api/json/ncmsettings/importDevices
/api/json/ncmsettings/uploadConfigletFile
/api/json/ncmsettings/uploadConfigletPreView
/api/json/ncmsettings/importConfiglets
/api/json/ncmdevice/updateHostNamefromFileImp
/api/json/ncmdevice/editCustomColfromFileImp
/api/json/ncmdevice/importDG
/api/json/ipam/addSubnet
/api/json/spm/addSwitch

一个头文件的配置示例: api_header

启用/禁用 Rest API 访问

从版本 127131 开始,添加了启用/禁用 Rest API 的选项。

哪里改变了?

  • 默认情况下,对于在“用户管理”下创建的新用户,将禁用 Rest API 访问。对所有模块和设备具有完全访问权限的管理员将能够在“用户管理”下编辑用户,并在需要时提供 Rest API 访问权限。
  • enable-api-1

  • 如果已为用户启用了 RestApikey 访问,则“快速链接”下的“Rest API”菜单将显示 RestApikey,并且仅当为用户启用了 Rest API 访问时,才允许外部 Rest API 调用。
  • enable-api-2

  • 如果禁用了 Rest API 访问,则“快速链接”下的“Rest API”菜单将显示“联系管理员用户”。
  • enable-api-3

注意:

企业版用户同步: Rest API访问将不会从中心服务器同步到探针服务器。probe中的同步用户将没有永久的Rest API访问权限。然而,对于在探针服务器中创建的用户,可以根据需要更新Rest API访问。

TFA: 如果配置了双因素身份验证,则必须进行 TFA OTP 验证才能启用 Rest API 访问。

重新生成API密钥:要生成API密钥,请在OpManager Web客户端中转到设置>REST API>基本设置,然后单击重新生成密钥。

告警

列出告警

方法: GET

描述: 列出OpManager中产生的所有告警。

示例 URL: http://localhost:8060/api/json/alarm/listAlarms?apiKey=********&deviceName=test1.zoho.com&severity=1&category=Device_Category&entity=sample_entity&alertType=ActiveAlarms&fromTime=2022-05-02 08:00:00&toTime=2022-06-02 18:30:00

示例响应: { "categoryVsCount": [ { "category": "Desktop", "title": "Desktop", "value": 3 }, { "category": "Security settings", "title": "Security settings", "value": 1 } ], "total": 1, "alarmPresent": true, "Details": { "Trouble": [ { "label": "Desktop", "value": 1, "status": "Desktop" } ], "Attention": [ { "label": "Desktop", "value": 1, "status": "Desktop" } ], "Critical": [ { "label": "Desktop", "value": 1, "status": "Desktop" }, { "label": "Security settings", "value": 1, "status": "Security settings" } ] }, "pageLength": 100, "records": 4, "Acknowledge": "0", "Unacknowledge": "4", "page": "1", "rows": [ { "statusStr": "Critical", "prettyTime": "26 Seconds ago", "displayName": "opm-server1", "lastNote": -1, "technician": "UnAssigned", "message": "Disk Utilization is 44%, threshold value for this monitor is 5%", "deviceName": "opm-server1", "statusNum": 1, "modTime": "26 Oct 2022 05:27:50 PM IST", "alarmId": 5, "eventtype": "Threshold Down", "category": "Desktop", "entity": "37_DiskUtilization", "who": "Unacknowledge", "totalNotes": 0 }, { "statusStr": "Trouble", "prettyTime": "46 Seconds ago", "displayName": "opm-server1", "lastNote": -1, "technician": "UnAssigned", "message": "Memory Utilization is 75%, threshold value for this monitor is 4%: Top 3 Processes:-java.exe - 7.247%;CynetMS.exe - 3.791%;explorer.exe - 3.216%", "deviceName": "opm-server1", "statusNum": 2, "modTime": "26 Oct 2022 05:27:30 PM IST", "alarmId": 4, "eventtype": "Threshold Down", "category": "Desktop", "entity": "38_PhysicalMemUtilization", "who": "Unacknowledge", "totalNotes": 0 }, { "statusStr": "Attention", "prettyTime": "1 minute ago", "displayName": "opm-server1", "lastNote": -1, "technician": "UnAssigned", "message": "CPU Utilization is 21%, threshold value for this monitor is 2%: Top 3 Processes:-svchost#25 - 12.362%;MEARWService - 6.266%;msedge#7 - 2.371%", "deviceName": "opm-server1", "statusNum": 3, "modTime": "26 Oct 2022 05:27:09 PM IST", "alarmId": 3, "eventtype": "Threshold Down", "category": "Desktop", "entity": "36_CPUUSAGE", "who": "Unacknowledge", "totalNotes": 0 }, { "statusStr": "Critical", "prettyTime": "8 days ago", "displayName": "System", "lastNote": -1, "technician": "UnAssigned", "message": "File Integrity : New files were found during the last scan.", "deviceName": "System", "statusNum": 1, "modTime": "18 Oct 2022 04:37:01 PM IST", "alarmId": 2, "eventtype": "FileIntegrityEvents", "category": "Security settings", "entity": "localhost_FILEINTEGRITY_BLACKLISTED", "who": "Unacknowledge", "totalNotes": 0 } ], "notificationEnabled": false }

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
deviceName
告警的设备名称。设备名称可以取自设备快照页面的URL。
severity
告警的严重级别. 严重程度可能在1到5之间1=严重,2=故障,3=注意,4=服务中断,5=正常
category
告警的设备类别
alertType:
alert告警的类型。告警类型可以是以下任意一种:ActiveAlarms、EventLogAlarms、SyslogAlarms、TrapAlarms、NCMAlarms、NFAAlarms、WebAlarms、FWAAlarms和StorageAlarms。。
fromTime
自定义时间段范围的开始时间。它的格式可以是 yyyy-mm-dd 或 yyyy-mm-dd hh:mm:ss。如果未指定时间(即 yyyy-mm-dd 格式),则默认时间将设置为凌晨 12 点(一天的开始)。
toTime
自定义时间段范围的结束时间。它的格式可以是 yyyy-mm-dd 或 yyyy-mm-dd hh:mm:ss。如果未指定时间(即 yyyy-mm-dd 格式),则默认时间将设置为凌晨 12 点(一天的开始)。
probename
探针的名称。探针名称可以通过执行listProbes API来获取,其中响应中的参数名称引用 probeName。[仅适用于中央服务器]

告警属性

方法: GET

描述: 列出特定告警的告警属性

示例 URL: https://localhost:8060/api/json/alarm/alarmProperties?apiKey=***************&entity=sample_entity

示例响应: { "statusStr": "Critical", "displayName": "opm-server1", "PRIORITY": "0", "workflows": [ { "logSeverity": 5, "moDispName": "opm-server1", "logMessage": "Workflow has been executed successfully.", "rbName": "workflow1", "taskList": [ { "logSeverity": 5, "logMessage": "Ping command used was : C:\\WINDOWS\\System32\\ping -n 4 -w 1000 -l 32 127.0.0.1", "logSeverityStr": "Info", "taskName": "Ping Device", "logTimeLong": "2022-10-26 17:34:18.481", "logTime": "26 Oct 2022 05:34:18 PM IST" }, { "logSeverity": 5, "logMessage": "Ping output : \nPinging 127.0.0.1 with 32 bytes of data:\nReply from 127.0.0.1: bytes=32 time<1ms TTL=128\nReply from 127.0.0.1: bytes=32 time<1ms TTL=128\nReply from 127.0.0.1: bytes=32 time<1ms TTL=128\nReply from 127.0.0.1: bytes=32 time<1ms TTL=128\n\nPing statistics for 127.0.0.1:\n Packets: Sent = 4, Received = 4, Lost = 0 (0% loss),\nApproximate round trip times in milli-seconds:\n Minimum = 0ms, Maximum = 0ms, Average = 0ms\n", "logSeverityStr": "Info", "taskName": "Ping Device", "logTimeLong": "2022-10-26 17:34:18.481", "logTime": "26 Oct 2022 05:34:18 PM IST" }, { "logSeverity": 5, "logMessage": "Ping was successful.", "logSeverityStr": "Info", "taskName": "Ping Device", "logTimeLong": "2022-10-26 17:34:18.481", "logTime": "26 Oct 2022 05:34:18 PM IST" } ], "rbID": 301, "moID": 302, "logTime": "26 Oct 2022 05:34:18 PM IST" } ], "source": "opm-server1", "stringseverity": "Critical", "GROUPNAME": "", "strCreateTime": "26 Oct 2022 05:27:50 PM IST", "id": "5", "events": [ { "severity": "Critical", "statusStr": "Critical", "source": "opm-server1", "id": "5", "time": "26 Oct 2022 05:27:50 PM IST", "text": "Disk Utilization is 44%, threshold value for this monitor is 5%", "category": "Desktop", "imgsrc": "/images/devices/status1.gif", "entity": "37_DiskUtilization", "statusNum": "1" } ], "severity": "/images/devices/status1.gif", "WEBNMS": "", "strModTime": "26 Oct 2022 05:27:50 PM IST", "ALARMCODE": "THRESHOLD-DOWN_WMI-DiskUtilization", "message": "Disk Utilization is 44%, threshold value for this monitor is 5%", "previousSeverity": "-1", "priority": "0", "deviceID": 302, "OWNERNAME": "", "statusNum": "1", "MAPNAME": "", "EVENTTYPE": "Threshold Down", "stage": "0", "modTime": "1666785470844", "createTime": "1666785470844", "pollid": "37", "category": "Desktop", "entity": "37_DiskUtilization", "stringpreviousseverity": "", "who": "Unacknowledge" }

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
entity
告警的实体
deviceID
告警的MOID

添加备注

方法: POST

描述: 该接口用于为告警添加注释

示例 URL: https://localhost:8060/api/json/alarm/addNotes?apiKey=***************&entity=sample_entity

示例响应: { "result": { "message": "Successfully Added" } }

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
entity*
告警的实体
notes*
描述待添加的备注
type:
提及是选择单个告警还是多个告警

确认告警

方法: POST

描述: 此接口用于确认告警

示例 URL: https://localhost:8060/api/json/alarm/acknowledgeAlarm?apiKey=***************&entity=sample_entity

示例响应: { "result": { "message": "Alarm has been successfully Acknowledged" } }

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
entity*
告警的实体
type:
提及是选择单个告警还是多个告警

未确认告警

方法: POST

描述: 此API用于非确认告警。

示例 URL: http://localhost:8060/api/json/alarm/unAcknowledgeAlarm?apiKey=********&entity=sample_entity

示例响应: { "result": { "message": "Alarm has been successfully UnAcknowledged" } }

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
entity*
告警的实体
type:
提及是选择单个告警还是多个告警

清除告警

方法: POST

描述: 该接口用于清除告警。

示例 URL: https://localhost:8060/api/json/alarm/clearAlarm?apiKey=***************&entity=sample_entity

示例响应: { "result": { "message": "Alarm has been successfully Cleared!" } }

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
entity*
告警的实体
type:
提及是选择单个告警还是多个告警

删除告警

方法: POST

描述: 此API用于删除告警。

示例 URL: https://localhost:8060/api/json/alarm/deleteAlarm?apiKey=***************&entity=sample_entity

示例响应: { "result": { "message": "Alarm has been successfully Deleted!" } }

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
entity*
告警的实体
type:
提及是选择单个告警还是多个告警

按照告警排名靠前的设备

方法: GET

描述: 按照告警排名靠前的设备

示例 URL: https://localhost:8060/api/json/alarm/getTopDevicesByAlarms?apiKey=***************&entity=sample_entity

示例响应: [ { "ipaddress": "127.0.0.1", "moname": "opm-server1", "devicename": "opm-server1", "alarmcount": 162, "type": "Windows 10", "category": "Desktop", "mapname": "Desktops_Map.netmap", "status": 1 }, { "ipaddress": "127.0.0.1", "moname": "opm-server2", "devicename": "opm-server2", "alarmcount": 2, "type": "Windows 2019", "category": "Server", "mapname": "Servers_Map.netmap", "status": 1 } ]

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
eventType*
告警事件类型

获取备注

方法: GET

描述: 这个API是用来获取告警的注释

示例 URL: https://localhost:8060/api/json/alarm/getAnnotation?apiKey=***************&entity=sample_entity

示例响应: [ { "notes": "This is a test note", "modTime": 1666786020066, "noteID": 1, "modTimeStr": "26 Oct 2022 05:37:00 PM IST", "entity": "37_DiskUtilization", "who": "admin" } ]

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
entity*
告警的实体

可用性

获取可用性响应

方法: POST

描述: 给定设备的ICMP/Ping 响应。

示例 URL: https://localhost:8060/api/json/device/getPingResponse?apiKey=***************&deviceName=xxx.xxx.xx.x

示例响应: {"PingResponse":{"Details":"\nPinging 127.0.0.1 with 32 bytes of data:\nReply from 127.0.0.1: bytes=32 time=21ms TTL=251\n\nPing statistics for 127.0.0.1:\n Packets: Sent = 1, Received = 1, Lost = 0 (0% loss),\nApproximate round trip times in milli-seconds:\n Minimum = 21ms, Maximum = 21ms, Average = 21ms\n"}}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
deviceName*
设备名称-被管理实体名称,在设备快照页面的URL或listDevices API响应中的'deviceName'属性值中看到。

获取跟踪响应

方法: POST

描述: 跟踪给定设备的路由命令响应

示例 URL: https://localhost:8060/api/json/device/getTraceResponse?apiKey=***************&deviceName=xxx.xxx.xx.x

示例响应: {"TraceResponse":{"Details":"\nTracing route to 127.0.0.1 over a maximum of 30 hops\n\n 1 8 ms 9 ms 3 ms 127.0.0.1 \n 2 1 ms 1 ms 1 ms 127.0.0.1 \n 3 20 ms 20 ms 20 ms 127.0.0.1 \n 4 22 ms 21 ms 22 ms 127.0.0.1 \n 5 21 ms 20 ms 20 ms 127.0.0.1 \n\nTrace complete.\n"}}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
deviceName*
设备名称 - 设备快照页面的 URL 中显示的托管实体名称,或 listDevices API 响应中的“deviceName”属性值。

停机设备

方法: GET

描述: 列出当前处于关闭状态且设备状态为“严重”的设备

示例 URL: https://localhost:8060/api/json/discovery/getDownDevices?apiKey=******************

示例响应: {"DownDevices":{"Details":[{"name":"127.0.0.1","type":"HPSwitch 3900X","category":"Switch","displayName":"SwitchDevice_SP"},{"name":"127.0.0.2","type":"Windows Server 2018","category":"Server","displayName":"AppServer-04"},{"name":"UserPC_Michael","type":"Linux RedHat","category":"Server","displayName":"127.0.0.3"}]}}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。

获取可用性数据

方法: GET

描述: 获取给定设备或接口的可用性图表。

示例 URL: https://localhost:8060/api/json/device/getAvailabilityGraphData?apiKey=******************&isFluidic=true&name=opmserver.mydomain.com

示例响应: {"uptimeData":{"Today":100,"This week":100,"Last week":99,"Last 30 days":99,"Last month":0,"This month":99,"Last 24 hours":100,"Yesterday":100,"Last 7 days":99,"Last 12 hours":100},"graphData":[{"seriesname":"Up","data":[["Last 12 hours",100],["Today",100],["Last 24 hours",100],["Yesterday",100],["This week",100],["Last 7 days",99.093],["Last week",98.867],["This month",99.269],["Last 30 days",99.093],["Last month",0]]},{"seriesname":"On Maintenance","data":[["Last 12 hours",0],["Today",0],["Last 24 hours",0],["Yesterday",0],["This week",0],["Last 7 days",0],["Last week",0],["This month",0],["Last 30 days",0],["Last month",0]]},{"seriesname":"Dependent Unavailable","data":[["Last 12 hours",0],["Today",0],["Last 24 hours",0],["Yesterday",0],["This week",0],["Last 7 days",0],["Last week",0],["This month",0],["Last 30 days",0],["Last month",0]]},{"seriesname":"On Hold","data":[["Last 12 hours",0],["Today",0],["Last 24 hours",0],["Yesterday",0],["This week",0],["Last 7 days",0],["Last week",0],["This month",0],["Last 30 days",0],["Last month",0]]},{"seriesname":"Down","data":[["Last 12 hours",0],["Today",0],["Last 24 hours",0],["Yesterday",0],["This week",0],["Last 7 days",0],["Last week",0],["This month",0],["Last 30 days",0],["Last month",0]]},{"seriesname":"Not Monitored","data":[["Last 12 hours",0],["Today",0],["Last 24 hours",0],["Yesterday",0],["This week",0],["Last 7 days",0.907],["Last week",1.133],["This month",0.731],["Last 30 days",0.907],["Last month",100]]}]}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
设备或接口的名称—从设备/接口快照页面的URL或listDevices API的'deviceName'属性值或listDevices API响应中的'interfaceName'属性值中查看的被管理实体名称[示例:opmserver.mydomain.com or IF-xx.xx.24.223-115]
instance
如果为接口请求可用性图,则设置instance=Interface。如果要获取接口数据,必选字段。该API还可用于获取其他监视器的可用性。(例:Interface|URL|winService|service|process]
isFluidic*
默认设置值为TRUE(用于内部目的)

列出停机时间计划

方法: GET

描述: 提供在OpManager中创建的停机时间表列表。

示例 URL: https://localhost:8060/api/json/admin/listDownTimeSchedules?apiKey=****************

示例响应: [{"name":"Test","id":"1","type":"Once","nextscheduledtime":"Mon, Nov 28, 2022 13:00:00","statusNum":"1","status":"Enabled"}]

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。

集合管理

方法: POST

描述: 管理或取消管理当前在OpManager中添加的设备、接口或URL监视器。

示例 URL: https://localhost:8060/api/json/device/setManaged?manage=true&apiKey=***************

示例响应: {"result":{"message":"Device is being managed."}}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
manage*
如果manage=true,则启用对设备或接口的监控;如果manage=false,则禁用监控
name*
设备或接口名称。(在设备/接口快照页面的URL或listDevices API响应中的'deviceName'属性值中看到的被管理实体名称)
type
如果被管理实体是接口,则将type设置为“INTERFACE”。如果被管理实体是URL监视器,则将type设置为“URL”。
isInterface
只有当值'INTERFACE'提供给type参数时,此参数才会生效。如果被管理实体是接口,则将此参数的值设置为“true”。缺省情况下,实体将被假定为设备,因此管理设备时不需要传递此参数。

业务视图

获取业务视图

方法: GET

描述: 列出在OpManager中创建的所有业务视图。

示例 URL: https://localhost:8060/api/json/businessview/getBusinessView?apiKey=***************

示例响应: {"BusinessView":{"Details":[{"name":"New BusinessView_bv","total":"3","error":"0","displayName":"New BusinessView","status":"5","alarms":"0"}]}}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。

获取业务视图详细信息

方法: GET

描述: 列出给定业务视图中可用的所有设备

示例 URL: https://localhost:8060/api/json/businessview/getBusinessDetailsView?apiKey=***************&bvName=ProductionSite_bv

示例响应: {"BusinessDetailsView":{"Details":[{"severity":"5","MemUtilization":0,"CPUUtilization":0,"displayName":"OPMSwitch_TeamA","name":"OPMSwitch","IpAddress":"127.0.0.1","type":"Unknown","status":"Clear"},{"severity":"5","MemUtilization":0,"CPUUtilization":0,"displayName":"OPMRouter_TeamA","name":"OPMRouter","IpAddress":"127.0.0.1","type":"Unknown","status":"Clear"},{"severity":"5","MemUtilization":0,"CPUUtilization":0,"displayName":"OPMServer_AD","name":"OPMServer_Domaincontroller","IpAddress":"127.0.0.1","type":"Unknown","status":"Clear"}],"TotalRecords":"3"}}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
bvName*
以“_bv”文本为后缀的业务视图的名称。

仪表板

获取小窗件数据

方法: GET

描述: 该API用于获取要为给定小窗件id加载的数据。

示例 URL: https://localhost:8060/api/json/v2/dashboard/getWidgetData?apiKey=***************&widgetID=495

示例响应: {"623": {"WidgetName": "Devices by Availability","WidgetForwardPage": "availDetails","WidgetAdditionalData": {},"WidgetData": [{"parentKey":"NULL","onHold":"0s","displayName":"OPM-Firewall1","dependentUnavailable":"0s","ipAddress":"y.y.y.y","availability":"100","downPercent":"0","deviceName":"y.y.y.y","maintenance":"0s","down":"0s","NOTMONITORED":"0s","uptime":"1d"},{"parentKey":"NULL","onHold":"0s","displayName":"OPM-Firewall2","dependentUnavailable":"0s","ipAddress":"x.x.x.x","availability":"100","downPercent":"0","deviceName":"x.x.x.x","maintenance":"0s","down":"0s","NOTMONITORED":"0s","uptime":"1d"}],"Period": "twfourhours","WidgetType": "Grid","WidgetHeaders": ["Name","IPAddress","Up","On Hold","Maintenance","Dependent Unavailable","Down","Not Monitored","Availability(%)"],"Name": "widget.name.topnavail"}}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
widgetID**
要为其获取数据的小窗件ID。
widgetName
小窗件的名称。
widgetType
小窗件类型。

获取小窗件列表

方法: GET

描述: 此API用于列出要为给定指示板加载的小窗件。

示例 URL: https://localhost:8060/api/json/dashboard/getWidgetsList?apiKey=***************&dashboardName=dashboardname

示例响应: {"dashName": "Enterprise Dashboard","dashboardID": "31","isDashPropsAvailable": true,"isDefaultDashboard": true,"dashDesc": "contains widgets from all products","noOfCols": "4","colWidths": [{"colWidth": "50","colID": "1"},{"colWidth": "50","colID": "2"}],"configureWidget": true,"editDashboard": false,"widgetList": [{"widgetID": "277","name": "Infrastructure Snapshot","width": "2","x": "0","y": "15","id": "619","type": "Grid","desc": "Infrastructure Snapshot","widgetUniqueName": "widget.name.infrasnap","height": "43"},{"widgetID":"9006","name":"Tree View","width":"2","x":"0","y":"58","id":"9007","type":"DeviceTree","desc":"Tree view of elements","widgetUniqueName":"widget.name.treeView","height":"48"},{"widgetID":"266","name":"HeatMap","width":"2","x":"2","y":"0","id":"618","type":"Heatmap","desc":"HeatMap","widgetUniqueName":"widget.name.heatmap","height":"15"},//and other widget data in above format]}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
dashboardName*
仪表板名称

设备

列出设备

方法: GET

描述: 列出OpManager中添加的所有设备。

示例 URL: https://localhost:8060/api/json/device/listDevices?apiKey=****************&

示例响应: {"total":1,"page":1,"rows":[{"isSNMP":true,"ipaddress":"127.0.0.1","statusStr":"Critical","prettyTime":"10 minutes ago","displayName":"OPMRouterDevice","isNew":false,"type":"Cisco 2900 IS Series","vendorName":"Cisco","deviceName":"127.0.0.1","statusNum":"1","addedTime":"28 Nov 2022 01:08:41 PM IST","interfaceCount":14,"category":"Router"},{"isSNMP":false,"ipaddress":"127.0.0.1","statusStr":"Clear","prettyTime":"50 minutes ago","displayName":"OPMSwitch_Site1","isNew":false,"type":"Unknown","vendorName":"Unknown","deviceName":"127.0.0.1","statusNum":"5","addedTime":"28 Nov 2022 12:29:06 PM IST","interfaceCount":0,"category":"Unknown"}],"records":2}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
isFluidic
默认设置值为“true”。(内部用途)
type:
获取属于给定设备类型的设备列表。[例:type = Cisco2081]
category
获取属于给定设备类别的设备列表[示例:服务器,交换机等]
app
获取在OpManager中监控的具有给定应用程序的设备列表[示例:MSSQL, Exchange, Domain Controller]
bvName
获取给定业务视图映射名称下的设备列表
vendor
获取具有给定厂商名称的设备列表。
protocol
按协议过滤设备[示例: all|SNMP|WMI|CLI|VIWebService|VIWMI|CLI|XenService|PrismAPI|NetAppAPI|SMI]
severity
按严重程度过滤设备[示例: 1 (Critical), 2 (Trouble), 3 (Attention), 4 (service down), 5 (Clear), 7 (Unmanaged)]
selectedVTypes
按虚拟设备类型过滤设备。[示例:VMware-VM|VMware-Host|HyperV-VM|Xen-VM|VMware-vCenter|Xen-Host|HyperV-Host]
groupName
根据“组名”过滤设备
customFields
获取与设备关联的自定义字段值。如果您使用的是适用于OpManager 12.x以上版本的v2 API,则设置为“true”。[例如: /api/json/v2/device/listDevices]
getInterfaces
获取具有关联接口的设备。布尔值:TRUE/FALSE
page
批量获取设备。这应该与'rows'参数结合使用。[示例:page=1, rows=200, page=2, rows=200]
rows
批量获取设备。这应该与'page'参数结合使用[示例:page=1, rows=200, page=2, rows=200]
sortBytype:
定义排序类型升序或降序 [示例, sortByType=asc Or sortByType=desc]
sortByColumn
按列排序设备列表[示例:displayName、interfaceCount、ipaddress、type等]

获取设备说明

方法: GET

描述: 提供与给定设备相关的自定义字段值,如建筑物,机柜,序列号等。

示例 URL: https://localhost:8060/api/json/device/getDeviceNotes?apiKey=***************&name=xxx.xxx.xx.x

示例响应: [{"FIELDVALUE":"","DATATYPE":"Text","ISEDITABLE":true,"DESCRIPTION":"Building where the device is present","FIELDNAME":"Building","ALIASNAME":"UDF2","FIELDLENGTH":100},{"FIELDVALUE":"","DATATYPE":"Text","ISEDITABLE":true,"DESCRIPTION":"Cabinet where the device is located","FIELDNAME":"Cabinet","ALIASNAME":"UDF4","FIELDLENGTH":100},{"FIELDVALUE":"","DATATYPE":"Text","ISEDITABLE":true,"DESCRIPTION":"Comments about the device","FIELDNAME":"Comments","ALIASNAME":"UDF8","FIELDLENGTH":800},{"FIELDVALUE":"user-DevTeam","DATATYPE":"Text","ISEDITABLE":true,"DESCRIPTION":"Contact person for the device","FIELDNAME":"Contact Name","ALIASNAME":"UDF6","FIELDLENGTH":100},{"FIELDVALUE":"","DATATYPE":"Text","ISEDITABLE":true,"DESCRIPTION":"Department for which the device services","FIELDNAME":"Department","ALIASNAME":"UDF5","FIELDLENGTH":100},{"FIELDVALUE":"","DATATYPE":"Text","ISEDITABLE":true,"DESCRIPTION":"Floor where the device is located","FIELDNAME":"Floor","ALIASNAME":"UDF3","FIELDLENGTH":100},{"FIELDVALUE":"FGL120A10AY","DATATYPE":"Text","ISEDITABLE":true,"DESCRIPTION":"Serial Number of the device","FIELDNAME":"SerialNumber","ALIASNAME":"UDF1","FIELDLENGTH":100},{"FIELDVALUE":"","DATATYPE":"Text","ISEDITABLE":true,"DESCRIPTION":"Contact number for this device","FIELDNAME":"Telephone Number","ALIASNAME":"UDF7","FIELDLENGTH":100}]

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
name*
设备名称-被管理实体名称,如设备快照页面的URL或listDevices API响应中的'deviceName'属性值所示。

获取基础设施详细信息

方法: GET

描述: 提供设备的分类详细信息,如设备名称、设备显示名称、状态、IP地址、设备类型和相关的性能监控值。

示例 URL: https://localhost:8060/api/json/discovery/getInfrastructureDetailsView?apiKey=**************&categoryName=Server

示例响应: {"InfrastructureDetailsView":{"Details":[{"intfCount":"0","severity":"5","displayName":"127.0.0.1","name":"127.0.0.1","IpAddress":"127.0.0.1","type":"Unknown","monitors":{"DiskUtilization":0,"CPUUtilization":0,"MemoryUtilization":0},"status":"Clear"},{"intfCount":"0","severity":"5","displayName":"127.0.0.1","name":"127.0.0.1","IpAddress":"127.0.0.1","type":"Windows 2016","monitors":{"DiskUtilization":0,"CPUUtilization":0,"MemoryUtilization":0},"status":"Clear"}],"TotalRecords":"2"}}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
categoryName*
设备类别名称。[示例:服务器、桌面等]

获取设备摘要

方法: GET

描述: 提供与“设备快照”页面相同的设备详细信息

示例 URL: https://localhost:8060/api/json/device/getDeviceSummary?apiKey=**************&name=opmserver.testdomain.com

示例响应: {"NFA_ID":"","recBandwidth":"1","IntfIpaddress":"127.0.0.1","instance":"101","displayName":"ciscostackswitchdevice874","Util":"5","availability":{"Down":0,"Dependent Unavailable":0,"On Hold":0,"Not Monitored":0,"Parent Down":98.34,"On Maintenance":0,"Up":1.66},"avgOutPackets":"500 ","outTraffic":"0.008 ","moID":"10000000310","isIPAvailable":true,"inSpeedDisplayValue":"1 bps","intfDisplayName":"GigabitEthernet1/0/1","txUtil":"0.89","typeIdDescr":"Ethernet (6)","operStateImg":"","isSubInterface":"false","managed":"true","snapDetails":{"snapList":[{"indexCount":0,"ondemandWidget":false,"refresh":false,"type":"IntfSummary","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceSummary","rowNum":1,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.summary","header":false,"id":10000000081,"snapid":10000000081,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[],"sizey":12,"timeSelection":false,"desc":"dashboard.name.nwconfig"},{"indexCount":1,"ondemandWidget":false,"refresh":false,"type":"IntfGraphs","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceGraphs","rowNum":13,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.graphs","header":true,"id":10000000082,"snapid":10000000082,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[{"param":"graphName","paramData":[],"value":"totalPackets"},{"param":"isFluidic","paramData":[],"value":"true"},{"paramType":"opmtime","param":"period","paramData":[],"value":"Today"}],"sizey":13,"timeSelection":true,"desc":"webclient.devices.details.totalbytes"},{"indexCount":2,"ondemandWidget":false,"refresh":false,"type":"IntfGraphs","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceGraphs","rowNum":15,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.graphs","header":true,"id":10000000083,"snapid":10000000083,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[{"param":"graphName","paramData":[],"value":"traffic"},{"param":"isFluidic","paramData":[],"value":"true"},{"paramType":"opmtime","param":"period","paramData":[],"value":"Today"}],"sizey":13,"timeSelection":true,"desc":"webclient.snapshot.name.Interface.Traffic"},{"indexCount":3,"ondemandWidget":false,"refresh":false,"type":"IntfGraphs","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceGraphs","rowNum":17,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.graphs","header":true,"id":10000000084,"snapid":10000000084,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[{"param":"graphName","paramData":[],"value":"utilization"},{"param":"isFluidic","paramData":[],"value":"true"},{"paramType":"opmtime","param":"period","paramData":[],"value":"Today"}],"sizey":13,"timeSelection":true,"desc":"webclient.snapshot.name.Interface.Utilization"},{"indexCount":4,"ondemandWidget":false,"refresh":false,"type":"IntfGraphs","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceGraphs","rowNum":19,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.graphs","header":true,"id":10000000085,"snapid":10000000085,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[{"param":"graphName","paramData":[],"value":"errors"},{"param":"isFluidic","paramData":[],"value":"true"},{"paramType":"opmtime","param":"period","paramData":[],"value":"Today"}],"sizey":13,"timeSelection":true,"desc":"webclient.devices.details.errndiscards"},{"indexCount":5,"ondemandWidget":false,"refresh":false,"type":"IntfGraphs","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceGraphs","rowNum":21,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.graphs","header":true,"id":10000000086,"snapid":10000000086,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[{"param":"graphName","paramData":[],"value":"discardRate"},{"param":"isFluidic","paramData":[],"value":"true"},{"paramType":"opmtime","param":"period","paramData":[],"value":"Today"}],"sizey":13,"timeSelection":true,"desc":"webclient.snapshot.name.Discard.Rate"},{"indexCount":6,"ondemandWidget":false,"refresh":false,"type":"IntfGraphs","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceGraphs","rowNum":23,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.graphs","header":true,"id":10000000087,"snapid":10000000087,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[{"param":"graphName","paramData":[],"value":"packets"},{"param":"isFluidic","paramData":[],"value":"true"},{"paramType":"opmtime","param":"period","paramData":[],"value":"Today"}],"sizey":13,"timeSelection":true,"desc":"opu.views.PACKETS"},{"indexCount":7,"ondemandWidget":false,"refresh":false,"type":"IntfGraphs","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceGraphs","rowNum":25,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.graphs","header":true,"id":10000000088,"snapid":10000000088,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[{"param":"graphName","paramData":[],"value":"errorRate"},{"param":"isFluidic","paramData":[],"value":"true"},{"paramType":"opmtime","param":"period","paramData":[],"value":"Today"}],"sizey":13,"timeSelection":true,"desc":"webclient.snapshot.name.Error.Rate"},{"indexCount":8,"ondemandWidget":false,"refresh":false,"type":"Grid","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceMonitors","rowNum":50,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.monitors","header":true,"id":10000000089,"snapid":10000000089,"snapshotData":{"colModelList":[{"name":"monitorName","index":"monitorName"},{"name":"interval","index":"interval"},{"name":"collectionTime","index":"collectionTime"},{"formatter":"intfValuesWithUnits","name":"value","index":"value"},{"hidden":true,"name":"displayName","index":"displayName"},{"hidden":true,"name":"unit","index":"unit"}],"colNamesList":["webclient.devices.details.monitors","webclient.map.edit.interval","webclient.devices.details.lastpoll","webclient.action.currVal","",""],"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[],"sizey":14,"timeSelection":false,"desc":"webclient.admin.url.monitors"},{"indexCount":9,"ondemandWidget":false,"refresh":false,"type":"Grid","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceMonitors","rowNum":50,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.monitors","header":true,"id":10000000971,"snapid":10000000971,"snapshotData":{"colModelList":[{"name":"monitorName","index":"monitorName"},{"name":"interval","index":"interval"},{"name":"collectionTime","index":"collectionTime"},{"formatter":"intfValuesWithUnits","name":"value","index":"value"},{"hidden":true,"name":"displayName","index":"displayName"},{"hidden":true,"name":"unit","index":"unit"}],"colNamesList":["webclient.devices.details.monitors","webclient.map.edit.interval","webclient.devices.details.lastpoll","webclient.action.currVal","",""],"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[],"sizey":14,"timeSelection":false,"desc":"webclient.admin.url.monitors"},{"indexCount":10,"ondemandWidget":false,"refresh":false,"type":"Grid","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceNotes","rowNum":64,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.notes","header":true,"id":10000000090,"snapid":10000000090,"snapshotData":{"colModelList":[{"hidden":true,"classes":"GridColHidden","name":"ALIASNAME","width":"0","index":"ALIASNAME","key":true},{"hidden":true,"classes":"GridColHidden","name":"DATATYPE","width":"0","index":"DATATYPE","key":true},{"formatter":"custField_escapeHtmlTags","name":"FIELDNAME","index":"FIELDNAME"},{"formatter":"custField_escapeHtmlTags","name":"DESCRIPTION","index":"DESCRIPTION"},{"formatter":"custField_escapeHtmlTags","name":"FIELDVALUE","index":"FIELDVALUE"}],"actionurls":[{"name":"Edit","url":"InterfaceNotes"}],"colNamesList":["","","webclient.devices.customfields.fieldname","webclient.devices.customfields.description","webclient.widget.value"]},"expandtime":false,"parameters":[],"sizey":14,"timeSelection":false,"desc":"webclient.commontext.customfields"}],"snapshotID":"10000000005","snapshotDesc":"snapshot.desc.Interface","snapshotName":"OPMInterface","tabs":{"tabs":[{"tabid":10000000026,"name":"webclient.snapshot.testlinks.summary","order":1},{"tabid":10000000027,"name":"webclient.snapshot.name.Interface.Graphs","order":2},{"tabid":10000000028,"name":"webclient.admin.url.monitors","order":3}],"tabWidgets":{"10000000028":[{"ROW":50,"ASSOCIATIONID":10000000089}],"10000000027":[{"ROW":13,"ASSOCIATIONID":10000000082},{"ROW":15,"ASSOCIATIONID":10000000083},{"ROW":17,"ASSOCIATIONID":10000000084},{"ROW":19,"ASSOCIATIONID":10000000085},{"ROW":21,"ASSOCIATIONID":10000000086},{"ROW":23,"ASSOCIATIONID":10000000087},{"ROW":25,"ASSOCIATIONID":10000000088}],"10000000026":[{"ROW":1,"ASSOCIATIONID":10000000081},{"ROW":64,"ASSOCIATIONID":10000000090}]}},"timeSelectionNeeded":true,"yScale":25,"maxColumns":10},"ifPhysAddr":"20","adminState":"Up","transBandwidth":"1","statusPolledVia":"SNMP","outSpeedDisplayValue":"1 bps","rstime":"1 bps","availabilityTimeLine":["ParentDown,1670178610981,1670233674317","ParentDown,1670234394000,1670234514150","UP,1670234514150,1670237050981","UP,1670233674317,1670234394000"],"rxPackets":"0.005 ","ifAdminStatus":"1","rxUtil":"0.89","ifSpeedIn":"1","isAddedToNFA":"false","Discards":"2","stringStatus":"Down","txPackets":"0.002 ","Errors":"2","ifSpeedOut":"1","inTraffic":"0.008 ","operState":"Up","intfmanaged":"true","name":"xxx.xxx.x.xx.10000000001","typeId":"6","ifOperStatus":"1","category":"Switch","adminStateImg":"","avgInPackets":"200 ","status":"2","desc":"GigabitEthernet1/0/1","trafficCounter":"32 bit"}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
name*
设备名称-被管理实体名称,在设备快照页面的URL或listDevices API响应中的'deviceName'属性值中看到。
isFluidic
默认设置为TRUE。(内部用途)
snaptype:
设备快照的类型。如果该设备仅在OpManager中监控,则设置为“MonitoringDevice”。如果此设备启用了流量监控,则将值设置为“FlowDevice”。
RouterID
当snapType设置为FlowDevice时,设备的Router ID。

获取设备完整详细信息

方法: GET

描述: 列出设备的基本详细信息和可用性

示例 URL: https://localhost:8060/api/json/v2/device/getDeviceCompleteDetails?apiKey=***************&name=devicename

示例响应: { "nfadetails":{"NFAStatus":"Not Added"}, "statusStr":"Critical", "responseTime":"001ms", "format":"dd-MM-yy HH:mm:ss", "dnsName":"xxx.xxx.xxx.xx", "timeZone":"Asia/Calcutta", "availability":["DownTime,1672597848117,1672654248117"], "todayTimeAvail":{"todayStartTime":"1672597848132","endTimeVal":"1672654248132"}, "type":"Cisco 2800 Series", "vendorName":"Cisco", "statusNum":"1", "isStorage":false, "ncmdetails":{"SUMMARY_NOT_AVAILABLE":true}, "packetLoss":"11", "configBackup":{"RunningConfig":{},"StartupConfig":{}}, "opmdetails":{ "Type":"Cisco 2800 Series", "dependentDisplayName":"None", "Category":"Server", "hardwareInfo":{"HW_MANUFACTURER":"Cisco","HW_SERIALNUMBER":"FHK1112F402","IS_ALARM_SUPPRESSED":"false","ISPDPresent":false,"HW_MODEL":"CISCO2801","LAST_UPDATED_TIME":"May 10, 2018 05:39 AM","MOID":8438,"IS_MONITORED":"true"}, "displayCategory":"Servers", "PollInterval":"7", "IPAddress":"xxx.xxx.xx.xx", "DNSName":"xxx.xxx.xx.xx", "SysDescription":"Cisco IOS Software, 2801 Software (C2801-ADVENTERPRISEK9-M), Version 15.1(3)T1, RELEASE SOFTWARE (fc2)\r\nTechnical Support: http://www.cisco.com/techsupport\r\nCopyright (c) 1986-2011 by Cisco Systems, Inc.\r\nCompiled Sun 27-Mar-11 07:15 by prod_rel_team", "Monitoring":"ICMP", "UpLinkDependency":"None" }, "state":"2", "availdata":{"Down":100,"Dependent Unavailable":0,"On Hold":0,"Not Monitored":0,"Parent Down":0,"On Maintenance":0,"Up":0} }

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
name*
设备名称

虚拟设备

列出虚拟设备

方法: GET

描述: 列出所选虚拟类型的所有实体。

示例 URL: https://localhost:8060/api/json/device/listVirtualDevices?apiKey=***************&virtualDeviceType=VM

示例响应: {"VENDOR_NAME":"VMware, Inc.","BUILD_INFO":"VMware ESXi 6.7.0 build-8169922","CPU_PACKAGES":2,"TotalDataStores":2,"NUM_PNIC":2,"OS_TYPE":"vmnix-x86","CPU_MODEL":"Intel(R) Xeon(R) Silver 4114 CPU @ 2.20GHz","MAINTENANCE_MODE":false,"TotalVms":11,"VCENTERDISPLAYNAME":"opm-user-vc","SYSUPTIME":"2021-09-19 21:24:17.745","CONNECTION_STATUS":"connected","CPU_THREADS":40,"CPU_SPEED_MHZ":2194,"HARDWARE_VENDOR":"Dell Inc.","NUM_HBA":3,"CPU_CORES":"20 x 2.20GHz","LASTUPDATEDTIME":"2023-01-09 17:47:25.159","MEM_CAPACITY_MB":"127 GB ","VCENTERNAME":"opm-user-vc.xxx.usercorpin.com","UUID":"4c4c4544-0047-4b10-8043-c4c04f305432","HARDWARE_MODEL":"PowerEdge C6420","ENTITYNAME":"xxx.xx.xxx.xx","POWER_STATE":"On"}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
virtualDeviceType*
要列出的虚拟实体类型。(取值范围:VHOST、VDATASTORE、VM、VCENTER、HyperV-Host、HyperV-VM、HyperV-Disk、Xen-Host、Xen-VM、Xen-SR、Xen-Pool、Nutanix-Cluster、Nutanix-Host、Nutanix-VM)

获取VMWare主机

方法: GET

描述: 列出特定vCenter的所有VMware ESX主机

示例 URL: http://localhost:8060/api/json/device/getVMWareHosts?apiKey=***************&name=vCenter-1

示例响应: [{"DISPLAYNAME":"ESXHost-2","STATUS_STR":"Critical","NUM_PNIC":2,"OS":"ESXServer","OS_TYPE":"vmnix-x86","SYSUPTIME":"Apr 22, 2023 21:52 PM","CONNECTION_STATUS":"connected","NAME":"ESXHost-2","VHOST_ID":23703,"STATUS":"1","CPU_SPEED_MHZ":2195,"MEM_CAPACITY_MB":130698,"POWER_STATE":"On"},{"DISPLAYNAME":"ESXHost-1","STATUS_STR":"Clear","NUM_PNIC":2,"OS":"ESXServer","OS_TYPE":"vmnix-x86","SYSUPTIME":"Apr 23, 2023 01:53 AM","CONNECTION_STATUS":"connected","NAME":"ESXHost-1","VHOST_ID":22505,"STATUS":"5","CPU_SPEED_MHZ":2195,"MEM_CAPACITY_MB":130698,"POWER_STATE":"On"}]

参数名称
描述
name
vCenter设备名称—被管理实体名称(从设备快照页面的URL或listDevices API响应中的'deviceName'属性值中查看)。

获取数据中心详细信息

方法: GET

描述: 列出特定vCenter中存在的所有数据中心

示例 URL: http://localhost:8060/api/json/device/getDataCenterDetails?apiKey=***************&moID=13

示例响应: [{"NO_OF_DATASTORES":5,"STATUS_STR":"Unknown","STATUS":"7","NO_OF_NETWORKS":3,"ENTITY_NAME":"Datacenter"},{"NO_OF_DATASTORES":0,"STATUS_STR":"Unknown","STATUS":"7","NO_OF_NETWORKS":0,"ENTITY_NAME":"Datacenter 2"},{"NO_OF_DATASTORES":0,"STATUS_STR":"Unknown","STATUS":"7","NO_OF_NETWORKS":0,"ENTITY_NAME":"Datacenter 1"}]

参数名称
描述
moID
vCenter设备的唯一ID - getDeviceSummary API响应中的“moID”属性值。

获取集群详细信息

方法: GET

描述: 列出特定vCenter中存在的所有集群

示例 URL: http://localhost:8060/api/json/device/getClusterDetails?apiKey=***************&moID=13

示例响应: [{"NO_OF_DATASTORES":5,"STATUS_STR":"Clear","STATUS":"5","NO_OF_NETWORKS":2,"EFFECTIVE_CPU":76780,"NO_OF_HOSTS":2,"TOTAL_CPU_GHZ":86,"DRS_ENABLED":false,"DAS_ENABLED":true,"EFFECTIVE_MEMORY":208229,"ENTITY_NAME":"VSANLab","TOTAL_MEMORY_GB":255}]

参数名称
描述
moID
vCenter设备的唯一ID - getDeviceSummary API响应中的“moID”属性值。

获取VMWareVM

方法: GET

描述: 列出给定实体类型中存在的所有虚拟机

示例 URL: http://localhost:8060/api/json/device/getVMWareVMs?apiKey=***************&name=esx2&type=HOST

示例响应: [{"VM_CONNECTIONSTATE":"connected","DISPLAYNAME":"VMware-vm1","VM_ID":33002,"VIRTUAL_TYPE":"VMware-VM","NUM_ETHERNET":1,"VM_POWERSTATE":"Off","OS_NAME":"CentOS 4/5 or later (32-bit)","NUM_VDISK":1,"VHOST_ID":22505,"MEMORY_MB":1024,"MOID":-4,"IS_ORPHANED":"false","NUM_VCPU":1},{"VM_CONNECTIONSTATE":"connected","DISPLAYNAME":"VMware-VM2","STATUS_STR":"Trouble","VM_ID":23716,"VIRTUAL_TYPE":"VMware-VM","NUM_ETHERNET":1,"VM_POWERSTATE":"On","MAX_CPU_MHZ":17560,"IPADDRESS":"172.24.141.242","OS_NAME":"Microsoft Windows Server 2016 (64-bit)","NUM_VDISK":1,"NAME":"VMware-VM-3","VHOST_ID":23703,"MEMORY_MB":16384,"STATUS":"2","MOID":27302,"MAX_MEMORY_MB":16384,"IS_ORPHANED":"false","NUM_VCPU":8}]

参数名称
描述
name
所选实体类型的名称-管理实体名称,参见设备快照页面的URL或listDevices API响应中的'deviceName'属性值。
type
要列出的虚拟实体类型。(取值范围:VCENTER、HOST、DATASTORE)

 

获取VMWare数据存储

方法: GET

描述: 列出给定实体类型中存在的所有数据存储

示例 URL: http://localhost:8060/api/json/device/getVMWareDataStores?apiKey=***************&name=esxHost2&type=HOST

示例响应: [{"HostCount":1,"DATASTORENAME":"VMDatastorage (1)","Datastore_ID":23719,"FILESYSTEM_TYPE":"VMFS","CAPACITY_MB":3224,"DATASTORE_URL":"ds:///vmfs/volumes/442ec0fc-67dad2ec-386f-b496913ce490/","MOID":48373,"FREESPACE_MB":615,"deviceName":"device1_com_datastore-1923","IS_ACCESSIBLE":"5"},{"HostCount":1,"DATASTORENAME":"VMFSdatastore (3)","Datastore_ID":23718,"FILESYSTEM_TYPE":"VMFS","CAPACITY_MB":492,"DATASTORE_URL":"ds:///vmfs/volumes/342ebecc-2b289b6a-dd6e-b496913ce490/","MOID":48372,"FREESPACE_MB":427,"deviceName":"device2_datastore-1922","IS_ACCESSIBLE":"5"},{"HostCount":2,"DATASTORENAME":"VSANDatastore","Datastore_ID":32101,"FILESYSTEM_TYPE":"vsan","CAPACITY_MB":1862,"DATASTORE_URL":"ds:///vmfs/volumes/vsan:56f4a7b4df993895-66fa8c0ed80efd32/","MOID":61801,"FREESPACE_MB":1840,"deviceName":"device3_datastore-2718","IS_ACCESSIBLE":"5"}]

参数名称
描述
name
所选实体类型的名称-管理实体名称,参见设备快照页面的URL或listDevices API响应中的'deviceName'属性值。
type
要列出的虚拟实体类型。(取值范围:VCENTER、HOST、VM)

获取Nutanix磁盘

方法: GET

描述: 列出给定实体类型中存在的所有虚拟磁盘

示例 URL: http://localhost:8060/api/json/device/getNutanixVDisks?apiKey=***************&name=Nutanix-VM-8

示例响应: [{"CAPACITY":"150","NFSFILEPATH":"/General/.acropolis/vmdisk/343e6469-b11d-e321-b30a-1598371a20f8","VDISK_ID":1,"DISKADDRESS":"scsi.0","UUID":"343e6469-b11d-e321-b30a-1598371a20f8"}]

参数名称
描述
name
所选实体类型的名称 - 设备快照页面的 URL 中显示的托管实体名称,或 listDevices API 响应中的“deviceName”属性值。

获取Nutanix详细信息

方法: GET

描述: 列出给定实体类型中存在的所有虚拟磁盘

示例 URL: http://localhost:8060/api/json/device/getNutanixDetails?apiKey=***************&deviceName=Nutanix-VM8&entityType=Nutanix-VM

示例响应: {"DISPLAYNAME":"NutanixVM2","clusterMoName":"Nutanix-Cluster-1","hostName":"Nutanix-Host-1","VCPUCOUNT":2,"VM_ID":21,"statusStr":"Clear","TOOLSMOUNTED":false,"TOOLSVERSION":"1.2.0.3","VM_POWERSTATE":"Powered On","DISKCAPACITY":"150","IPADDRESS":"172.24.151.114","uuid":"3af940cd-b453-485d-89ab-2cab95aba188","deviceName":"Nutanix-VM-1","MEMORYCAPACITY":"6","statusNum":5,"ISCONTROLLERVM":"False","STATUS":" Clear","NOOFNETWORKADAPTERS":1,"clusterName":"Nutanix-Cluster-1","hostMoName":"Nutanix-Host-1","MOID":307,"MEMRESERVEDCAPACITY":"6","ENTITYNAME":"Nutanix-VM-2"}

参数名称
描述
deviceName
所选实体类型的名称 - 设备快照页面的 URL 中显示的托管实体名称,或 listDevices API 响应中的“deviceName”属性值。
entitytrpe:
要列出的虚拟实体的类型。允许的值为 Nutanix-Cluster , Nutanix-Host , Nutanix-VM

发现

添加设备

方法: POST

描述: 允许您将单个设备添加到 OpManager 以进行监控。

示例 URL: https://localhost:8060/api/json/discovery/addDevice?apiKey=***************&name=opmserver.mydomain.com

示例响应: {"device":{"deviceIp":"127.0.0.1","message":"Device added successfully.","deviceName":"127.0.0.1","moid":365}}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
deviceName*
设备的主机名、FQDN 名称或 IP 地址
credentialName
用于访问设备以获取设备信息的凭据名称。

企业版

列出探针

方法: GET

描述: 这个 API 是为了列出所有的探针

示例 URL: https://localhost:8060/api/json/admin/listProbes?apiKey=***************

示例响应: [ { "severity": "1", "serverMode": "PRIMARY", "serverStatus": "Server down", "contactEmail": "opm@user1.com", "deviceCount": "1", "natProtocol": "http", "probeID": "10000000001", "isConnected": "false", "contactPerson": "OpmUser1", "statusImg": "images/status1.gif", "ipslaCount": "0", "lastContact": "26 Oct 2022 12:42:59 PM IST", "natName": "opm-probe1", "name": "Probe1", "probeDisplayName": "Probe1", "ncmCount": "-1", "attr": { "deviceCount": { "rowspan": "1" }, "name": { "rowspan": "1" }, "lastContact": { "rowspan": "1" } }, "natPort": "8062", "status": "Critical" } ]

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。

事件

列出事件

方法: GET

描述: 列出事件历史。

示例 URL: https://localhost:8060/api/json/events/listEvents?apiKey=***************

示例响应: { "severityVsCount": { "Trouble": 1, "Critical": 2, "Attention": 3 }, "List": [ { "modTimeLong": "1666786290075", "statusStr": "Attention", "prettyTime": "5 minutes ago", "displayname": "opm-server1", "text": "CPU Utilization is 12%, threshold value for this monitor is 2%: Top 3 Processes:-WmiPrvSE#4 - 1.467%;CynetMS - 1.381%;Code#4 - 0.69%", "category": "Desktop", "statusNum": "3" }, { "modTimeLong": "1666785470844", "statusStr": "Critical", "prettyTime": "19 minutes ago", "displayname": "opm-server1", "text": "Disk Utilization is 44%, threshold value for this monitor is 5%", "category": "Desktop", "statusNum": "1" }, { "modTimeLong": "1666785450689", "statusStr": "Trouble", "prettyTime": "19 minutes ago", "displayname": "opm-server1", "text": "Memory Utilization is 75%, threshold value for this monitor is 4%: Top 3 Processes:-java.exe - 7.247%;CynetMS.exe - 3.791%;explorer.exe - 3.216%", "category": "Desktop", "statusNum": "2" }, { "modTimeLong": "1666785429095", "statusStr": "Attention", "prettyTime": "20 minutes ago", "displayname": "opm-server1", "text": "CPU Utilization is 21%, threshold value for this monitor is 2%: Top 3 Processes:-svchost#25 - 12.362%;MEARWService - 6.266%;msedge#7 - 2.371%", "category": "Desktop", "statusNum": "3" }, { "modTimeLong": "1666091221235", "statusStr": "Critical", "prettyTime": "8 days ago", "displayname": "System", "text": "File Integrity : New files were found during the last scan.", "category": "Security settings", "statusNum": "1" }, { "modTimeLong": "1666090716359", "statusStr": "Attention", "prettyTime": "8 days ago", "displayname": "opm-server1", "text": "CPU Utilization is 9%, threshold value for this monitor is 2%: Top 3 Processes:-java - 6.377%;svchost#21 - 6.207%;msedge#6 - 1.616%", "category": "Desktop", "statusNum": "3" } ], "Details": { "Desktop": [ { "value": 3, "status": 3, "label": "Attention" }, { "value": 1, "status": 2, "label": "Trouble" }, { "value": 1, "status": 1, "label": "Critical" } ], "Security settings": [ { "value": 1, "status": 1, "label": "Critical" } ] } }

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
deviceName
要为其列出事件的设备名称
entity
事件实体
period
应列出事件的时间段
severity
告警的严重级别
category
告警的设备类别
eventtype:
告警事件类型

添加事件

方法: POST

描述: 此 API 可用于生成可以触发告警的新事件

示例 URL: https://localhost:8060/api/json/events/addEvent?source=Test_Device_MoName&severity=1&message=Sample_Critical_Message&alarmCode=Sample_AlarmCode&entity=Sample_Entity&apiKey=***

示例响应: {"result":{"message":"Event has been successfully generated."}}

Parameter 名称
Description
apiKey*
用于访问OpManager服务器的API密钥
source*
告警的源设备。
severity*
告警的严重级别. 严重程度可能在1到5之间1=严重,2=故障,3=注意,4=服务中断,5=正常
message*
告警消息。
alarmCode*
告警的代码。
entity*
生成告警的唯一值
event类型:
告警的 EventType。它将用于识别告警组。

列出逻辑组

方法: GET

描述: 列出OpManager中可用的所有组。还提供基本的组信息,例如成员计数和组运行状况。

示例 URL: https://localhost:8060/api/json/admin/listAllLogicalGroups?apiKey=***************

示例响应: [{"groupDisplayName":"Devices","groupType":"Device","groupName":"devices-363","device_Count":"2","groupID":"363","count":"2","description":"No Description","availability":"NA","statusImg":"/images/devices/status1.gif","displayGroupType":"Device","statusLabel":"Critical","status":"1"}]

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。

获取逻辑组信息

方法: GET

描述: 列出OpManager中可用的所有组。还提供基本的组信息,例如成员计数和组运行状况。

示例 URL: https://localhost:8060/api/json/admin/getLogicalGroupInfo?apiKey=***************&groupName=NorthBayRegion-4201&period=3&snapType=LogicalDeviceGroup

示例响应: {"GroupDetails":{"groupType":"Device","groupID":"363","count":"2","description":"No Description","statusImg":"/images/devices/status1.gif","deviceDevice_Count":"2","statusLabel":"Critical","groupDisplayName":"Devices","groupName":"devices-363","alertCount":3,"statusChangeCount":2,"displayGroupType":"Device","status":"1"},"snapDetails":{"snapList":[{"indexCount":0,"ondemandWidget":false,"refresh":false,"type":"GroupSummary","sizex":10,"expand":false,"apiurl":"/client/api/json/admin/getLogicalGroupInfo","rowNum":1,"parameter":"groupName","isEnabled":true,"colNum":1,"name":"opm.intfGroup.Summary","header":true,"id":884,"snapid":884,"expandtime":false,"parameters":[{"param":"period","paramData":[],"value":"3"}],"sizey":9,"timeSelection":false,"desc":"webclient.storage.summary"},{"indexCount":1,"ondemandWidget":false,"refresh":false,"type":"Grid","sizex":5,"expand":false,"apiurl":"/client/api/json/admin/getLogicalGroupAlerts","rowNum":12,"parameter":"groupName","isEnabled":true,"colNum":1,"name":"opm.devicegrouping.Alarms","header":true,"id":885,"snapid":885,"snapshotData":{"colModelList":[{"formatter":"opm_linkToElementAlarmSnapshot","classes":"pointer","name":"message","index":"message"},{"hidden":true,"name":"severity","index":"severity"},{"formatter":"opm_gElemAlarmToElemSnap","classes":"pointer","name":"displayName","index":"displayName"},{"hidden":true,"name":"groupType","index":"groupType"},{"hidden":true,"name":"name","index":"name"},{"hidden":true,"name":"entity","index":"entity"},{"hidden":true,"name":"status","index":"status"},{"name":"modTime","index":"modTime"},{"hidden":true,"name":"alarmId","index":"alarmId"}],"colNamesList":["webclient.admin.traps.message","","webclient.fault.event.displayName","","","","","webclient.fault.details.properties.modttime","alarmid"],"onselectfunction":"opm_groupsAlert"},"expandtime":false,"parameters":[],"sizey":2,"timeSelection":false,"desc":"webclient.logicDevfGroup.deviceAlarms"},{"indexCount":2,"ondemandWidget":false,"refresh":false,"type":"Grid","sizex":5,"expand":false,"apiurl":"/client/api/json/admin/listLogicalGroupMembers","rowNum":12,"parameter":"groupName","isEnabled":true,"colNum":6,"name":"opm.grouping.devices","header":true,"id":886,"snapid":886,"snapshotData":{"colModelList":[{"formatter":"opm_linkToGroupSnap","classes":"pointer","name":"displayname","index":"displayname"},{"hidden":true,"name":"statusNum","index":"statusNum"},{"name":"type","index":"type"},{"hidden":true,"name":"name","index":"name"},{"hidden":true,"name":"moid","index":"moid"},{"hidden":true,"name":"groupType","index":"groupType"}],"colNamesList":["webclient.fault.addnotes.device_name","","webclient.topo.objectdetails.type","","",""],"onselectfunction":"opm_groupsElements"},"expandtime":false,"parameters":[],"sizey":2,"timeSelection":false,"desc":"webclient.grouping.device.list"}],"snapshotID":"89","snapshotDesc":"snapshot.desc.groupsummary","snapshotName":"LogicalDeviceGroup","tabs":{"tabs":[{"tabid":383,"name":"webclient.group.summary","order":1}],"tabWidgets":{"383":[{"ROW":1,"ASSOCIATIONID":884},{"ROW":12,"ASSOCIATIONID":885},{"ROW":12,"ASSOCIATIONID":886}]}},"timeSelectionNeeded":false,"yScale":25,"maxColumns":10}}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
groupname*
带MOID后缀的组名。如 -
period
获取可用性数据的时间。[示例:十二小时(16),今天(6),24小时(3),昨天(7),本周(8),最近7天(4),上周(9),本月(10),最近30天(5),上个月(11),自定义(23)]
snapType
组快照类型。[例: LogicalGroup|LogicalIntfGroup|LogicalDeviceGroup]

获取逻辑组告警

方法: GET

描述: 获取从给定组的成员(设备/接口)产生的告警。

示例 URL: https://localhost:8060/api/json/admin/getLogicalGroupAlerts?apiKey=***************&groupName=bvgcty-4201

示例响应: [{"severity":"Critical","groupType":"device","severityString":"/images/devices/status1.gif","modTime":"25 Nov 2022 02:27:11 PM IST","displayName":"Pradh","name":"opm-server","alarmId":1,"type":"device","message":"Device Down: No response from device for last 5 polls","entity":"opm-server_Poll","status":1},{"severity":"Attention","groupType":"device","severityString":"/images/devices/status3.gif","modTime":"25 Nov 2022 07:17:49 PM IST","displayName":"HPswitch9","name":"127.0.0.1","alarmId":33,"type":"device","message":"Device not responding: Probably down or busy","entity":"127.0.0.1_Poll","status":3},{"severity":"Attention","groupType":"device","severityString":"/images/devices/status3.gif","modTime":"25 Nov 2022 02:50:59 PM IST","displayName":"HPswitch9","name":"127.0.0.1","alarmId":26,"type":"device","message":"Response Time is 21 ms, threshold value for this device is 10 ms","entity":"154_Device","status":3}]

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
groupName
组名称

获取逻辑组成员

方法: GET

描述: 提供给定组中可用成员的信息。

示例 URL: https://localhost:8060/api/json/admin/listLogicalGroupMembers?apiKey=***************&groupName=NorthBayRegion-4201

示例响应: [{"groupType":"Device","statusStr":"Clear","displayname":"OPMServer","name":"OPMServer","type":"Device","moid":"10","statusNum":"5"},{"groupType":"Device","statusStr":"Attention","displayname":"HPswitch","name":"127.0.0.1","type":"Device","moid":"362","statusNum":"3"}]

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
groupName
后缀为'- '的设备/接口组的名称。[例:- ]

添加组

方法: POST

描述: 将设备添加到指定的组中。

示例 URL: https://localhost:8060/api/json/device/addToGroup?apiKey=***************&groupType=device&selectedMembers=10.1.1.20,opmserver

示例响应: {"result":{"message":"The Device(s) have been associated to the group successfully."}}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
groupName*
以MOID为后缀的设备/接口组名称。[例:- ]
groupType*
组类型[示例:device|interface]
selectedMembers*
设备名称以逗号分隔的字符串形式提供。设备名称是一个托管实体名称,可以在设备快照页面URL或listDevices API响应的'deviceName'属性中看到

列出接口

方法: GET

描述: 列出OpManager监控的所有接口

示例 URL: https://localhost:8060/api/json/device/listInterfaces?apiKey=***************&isFluidic=true&rows=100&page=1&sortByColumn=statusNum&sortByType=desc

示例响应: {"total":"1","records":"5","page":"1","rows":[{"interfaceDisplayName":"Loopback55-\"Loop Back 55\"","statusStr":"Clear","displayName":"OPMRouterDevice","ipAddress":"","outSpeed":"8 Gbps","inSpeed":"8 Gbps","type":"Software Loopback","deviceName":"127.0.0.1","interfaceStatus":5,"statusNum":5,"adminStatus":"Up","operStatus":"Up","id":"1","interfaceName":"IF-127.0.0.1-415"},{"interfaceDisplayName":"Loopback51-Lo51","statusStr":"Clear","displayName":"OPMRouterDevice","ipAddress":"","outSpeed":"8 Gbps","inSpeed":"8 Gbps","type":"Software Loopback","deviceName":"127.0.0.1","interfaceStatus":5,"statusNum":5,"adminStatus":"Up","operStatus":"Up","id":"2","interfaceName":"IF-127.0.0.1-417"}]}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
isFluidic
默认设置值为“true”(用于内部用途)
rows
批量获取接口列表。这应该与'page'参数结合使用[示例:page=1, rows=200, page=2, rows=200]
page
批量获取接口列表。这应该与'rows'参数结合使用[示例:page=1, rows=200, page=2, rows=200]
sortByColumn
按列排序接口列表[示例:inSpeed, displayName, ipaddress, outSpeed, statusNum, severity - 1 (Critical), 2 (Trouble), 3 (Attention), 4 (service down), 5 (Clear), 7 (Unmanaged)]
sortByType:
定义升序或降序排序接口列表[示例,sortByType=asc或sortByType=desc]
severity
根据严重程度过滤接口。[示例:1 (Critical), 2 (Trouble), 3 (Attention), 4 (service down), 5 (Clear), 7 (Unmanaged)]
type:
使用接口类型过滤接口。[示例:以太网、软件环回等]
intfProps
获取额外的接口属性,如ifName(接口ifName), moid(用于接口/设备的内部管理对象标识符),physAddress

获取接口汇总

方法: GET

描述: 提供接口的基本信息,如ifIndex, ifName, ifDesc, ifAlias,父设备,Rx/Tx流量等。

示例 URL: https://localhost:8060/api/json/device/getInterfaceSummary?apiKey=***************&interfaceName=IF-172.24.146.225-4429

示例响应: {"NFA_ID":"","recBandwidth":"1","IntfIpaddress":"127.0.0.1","instance":"101","displayName":"ciscostackswitchdevice874","Util":"5","availability":{"Down":0,"Dependent Unavailable":0,"On Hold":0,"Not Monitored":0,"Parent Down":98.34,"On Maintenance":0,"Up":1.66},"avgOutPackets":"500 ","outTraffic":"0.008 ","moID":"10000000310","isIPAvailable":true,"inSpeedDisplayValue":"1 bps","intfDisplayName":"GigabitEthernet1/0/1","txUtil":"0.89","typeIdDescr":"Ethernet (6)","operStateImg":"","isSubInterface":"false","managed":"true","snapDetails":{"snapList":[{"indexCount":0,"ondemandWidget":false,"refresh":false,"type":"IntfSummary","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceSummary","rowNum":1,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.summary","header":false,"id":10000000081,"snapid":10000000081,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[],"sizey":12,"timeSelection":false,"desc":"dashboard.name.nwconfig"},{"indexCount":1,"ondemandWidget":false,"refresh":false,"type":"IntfGraphs","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceGraphs","rowNum":13,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.graphs","header":true,"id":10000000082,"snapid":10000000082,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[{"param":"graphName","paramData":[],"value":"totalPackets"},{"param":"isFluidic","paramData":[],"value":"true"},{"paramType":"opmtime","param":"period","paramData":[],"value":"Today"}],"sizey":13,"timeSelection":true,"desc":"webclient.devices.details.totalbytes"},{"indexCount":2,"ondemandWidget":false,"refresh":false,"type":"IntfGraphs","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceGraphs","rowNum":15,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.graphs","header":true,"id":10000000083,"snapid":10000000083,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[{"param":"graphName","paramData":[],"value":"traffic"},{"param":"isFluidic","paramData":[],"value":"true"},{"paramType":"opmtime","param":"period","paramData":[],"value":"Today"}],"sizey":13,"timeSelection":true,"desc":"webclient.snapshot.name.Interface.Traffic"},{"indexCount":3,"ondemandWidget":false,"refresh":false,"type":"IntfGraphs","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceGraphs","rowNum":17,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.graphs","header":true,"id":10000000084,"snapid":10000000084,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[{"param":"graphName","paramData":[],"value":"utilization"},{"param":"isFluidic","paramData":[],"value":"true"},{"paramType":"opmtime","param":"period","paramData":[],"value":"Today"}],"sizey":13,"timeSelection":true,"desc":"webclient.snapshot.name.Interface.Utilization"},{"indexCount":4,"ondemandWidget":false,"refresh":false,"type":"IntfGraphs","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceGraphs","rowNum":19,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.graphs","header":true,"id":10000000085,"snapid":10000000085,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[{"param":"graphName","paramData":[],"value":"errors"},{"param":"isFluidic","paramData":[],"value":"true"},{"paramType":"opmtime","param":"period","paramData":[],"value":"Today"}],"sizey":13,"timeSelection":true,"desc":"webclient.devices.details.errndiscards"},{"indexCount":5,"ondemandWidget":false,"refresh":false,"type":"IntfGraphs","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceGraphs","rowNum":21,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.graphs","header":true,"id":10000000086,"snapid":10000000086,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[{"param":"graphName","paramData":[],"value":"discardRate"},{"param":"isFluidic","paramData":[],"value":"true"},{"paramType":"opmtime","param":"period","paramData":[],"value":"Today"}],"sizey":13,"timeSelection":true,"desc":"webclient.snapshot.name.Discard.Rate"},{"indexCount":6,"ondemandWidget":false,"refresh":false,"type":"IntfGraphs","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceGraphs","rowNum":23,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.graphs","header":true,"id":10000000087,"snapid":10000000087,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[{"param":"graphName","paramData":[],"value":"packets"},{"param":"isFluidic","paramData":[],"value":"true"},{"paramType":"opmtime","param":"period","paramData":[],"value":"Today"}],"sizey":13,"timeSelection":true,"desc":"opu.views.PACKETS"},{"indexCount":7,"ondemandWidget":false,"refresh":false,"type":"IntfGraphs","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceGraphs","rowNum":25,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.graphs","header":true,"id":10000000088,"snapid":10000000088,"snapshotData":{"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[{"param":"graphName","paramData":[],"value":"errorRate"},{"param":"isFluidic","paramData":[],"value":"true"},{"paramType":"opmtime","param":"period","paramData":[],"value":"Today"}],"sizey":13,"timeSelection":true,"desc":"webclient.snapshot.name.Error.Rate"},{"indexCount":8,"ondemandWidget":false,"refresh":false,"type":"Grid","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceMonitors","rowNum":50,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.monitors","header":true,"id":10000000089,"snapid":10000000089,"snapshotData":{"colModelList":[{"name":"monitorName","index":"monitorName"},{"name":"interval","index":"interval"},{"name":"collectionTime","index":"collectionTime"},{"formatter":"intfValuesWithUnits","name":"value","index":"value"},{"hidden":true,"name":"displayName","index":"displayName"},{"hidden":true,"name":"unit","index":"unit"}],"colNamesList":["webclient.devices.details.monitors","webclient.map.edit.interval","webclient.devices.details.lastpoll","webclient.action.currVal","",""],"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[],"sizey":14,"timeSelection":false,"desc":"webclient.admin.url.monitors"},{"indexCount":9,"ondemandWidget":false,"refresh":false,"type":"Grid","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceMonitors","rowNum":50,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.monitors","header":true,"id":10000000971,"snapid":10000000971,"snapshotData":{"colModelList":[{"name":"monitorName","index":"monitorName"},{"name":"interval","index":"interval"},{"name":"collectionTime","index":"collectionTime"},{"formatter":"intfValuesWithUnits","name":"value","index":"value"},{"hidden":true,"name":"displayName","index":"displayName"},{"hidden":true,"name":"unit","index":"unit"}],"colNamesList":["webclient.devices.details.monitors","webclient.map.edit.interval","webclient.devices.details.lastpoll","webclient.action.currVal","",""],"EE_PROBE_REQ":"true"},"expandtime":false,"parameters":[],"sizey":14,"timeSelection":false,"desc":"webclient.admin.url.monitors"},{"indexCount":10,"ondemandWidget":false,"refresh":false,"type":"Grid","sizex":10,"expand":false,"apiurl":"/client/api/json/device/getInterfaceNotes","rowNum":64,"parameter":"interfaceName","isEnabled":true,"colNum":1,"name":"opm.interface.notes","header":true,"id":10000000090,"snapid":10000000090,"snapshotData":{"colModelList":[{"hidden":true,"classes":"GridColHidden","name":"ALIASNAME","width":"0","index":"ALIASNAME","key":true},{"hidden":true,"classes":"GridColHidden","name":"DATATYPE","width":"0","index":"DATATYPE","key":true},{"formatter":"custField_escapeHtmlTags","name":"FIELDNAME","index":"FIELDNAME"},{"formatter":"custField_escapeHtmlTags","name":"DESCRIPTION","index":"DESCRIPTION"},{"formatter":"custField_escapeHtmlTags","name":"FIELDVALUE","index":"FIELDVALUE"}],"actionurls":[{"name":"Edit","url":"InterfaceNotes"}],"colNamesList":["","","webclient.devices.customfields.fieldname","webclient.devices.customfields.description","webclient.widget.value"]},"expandtime":false,"parameters":[],"sizey":14,"timeSelection":false,"desc":"webclient.commontext.customfields"}],"snapshotID":"10000000005","snapshotDesc":"snapshot.desc.Interface","snapshotName":"OPMInterface","tabs":{"tabs":[{"tabid":10000000026,"name":"webclient.snapshot.testlinks.summary","order":1},{"tabid":10000000027,"name":"webclient.snapshot.name.Interface.Graphs","order":2},{"tabid":10000000028,"name":"webclient.admin.url.monitors","order":3}],"tabWidgets":{"10000000028":[{"ROW":50,"ASSOCIATIONID":10000000089}],"10000000027":[{"ROW":13,"ASSOCIATIONID":10000000082},{"ROW":15,"ASSOCIATIONID":10000000083},{"ROW":17,"ASSOCIATIONID":10000000084},{"ROW":19,"ASSOCIATIONID":10000000085},{"ROW":21,"ASSOCIATIONID":10000000086},{"ROW":23,"ASSOCIATIONID":10000000087},{"ROW":25,"ASSOCIATIONID":10000000088}],"10000000026":[{"ROW":1,"ASSOCIATIONID":10000000081},{"ROW":64,"ASSOCIATIONID":10000000090}]}},"timeSelectionNeeded":true,"yScale":25,"maxColumns":10},"ifPhysAddr":"20","adminState":"Up","transBandwidth":"1","statusPolledVia":"SNMP","outSpeedDisplayValue":"1 bps","rstime":"1 bps","availabilityTimeLine":["ParentDown,1670178610981,1670233674317","ParentDown,1670234394000,1670234514150","UP,1670234514150,1670237050981","UP,1670233674317,1670234394000"],"rxPackets":"0.005 ","ifAdminStatus":"1","rxUtil":"0.89","ifSpeedIn":"1","isAddedToNFA":"false","Discards":"2","stringStatus":"Down","txPackets":"0.002 ","Errors":"2","ifSpeedOut":"1","inTraffic":"0.008 ","operState":"Up","intfmanaged":"true","name":"xxx.xxx.x.xx.10000000001","typeId":"6","ifOperStatus":"1","category":"Switch","adminStateImg":"","avgInPackets":"200 ","status":"2","desc":"GigabitEthernet1/0/1","trafficCounter":"32 bit"}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
interfaceName*
从接口快照页面的URL中查看接口的ManagedObject名称。

获取一览报表详细信息

方法: GET

描述: 为给定接口提供统一的可用性和性能监视健康状况报表数据。

示例 URL: https://localhost:8060/api/json/v2/device/getIntfAtAGlanceReportDetails?apiKey=***************&InterfaceName=IF-xxx.xxx.xx.4-3820&period=Today

示例响应: {"intfDisplayName":"VLAN555-VLAN555","InterfaceCategory":"LAN","Details":{"Parent Name":"HPswitch9","IfDescr":"VLAN555","IfAlias":"VLAN555","IfIndex":"1132","Receive Bandwidth":"0 bps","IfName":"VLAN555","Transmit Bandwidth":"0 bps","Circuit ID":"-"},"repType":7,"graphData":{"Errors":[{"seriesname":"inErrors","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Errors/sec"],"yaxiscolumnorder":[0],"suffix":""},{"seriesname":"outErrors","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Errors/sec"],"yaxiscolumnorder":[0],"suffix":""}],"Unicast":[{"seriesname":"broadcast","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","%"],"yaxiscolumnorder":[0],"suffix":""},{"seriesname":"unicast","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","%"],"yaxiscolumnorder":[0],"suffix":""}],"outBytes":[{"seriesname":"outBytes","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time",""],"yaxiscolumnorder":[0],"suffix":""}],"inTraffic":[{"seriesname":"inTraffic","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","bps"],"yaxiscolumnorder":[0],"suffix":""}],"inBytes":[{"seriesname":"inBytes","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Bytes/sec"],"yaxiscolumnorder":[0],"suffix":""}],"inUtilization":[{"seriesname":"inUtilization","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Percentage"],"yaxiscolumnorder":[0],"suffix":""}],"outUtilization":[{"seriesname":"outUtilization","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Percentage"],"yaxiscolumnorder":[0],"suffix":""}],"Discards":[{"seriesname":"inDiscards","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Discards/sec"],"yaxiscolumnorder":[0],"suffix":""},{"seriesname":"outDiscards","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Discards/sec"],"yaxiscolumnorder":[0],"suffix":""}],"totalUtilization":[{"seriesname":"totalUtilization","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Percentage"],"yaxiscolumnorder":[0],"suffix":""}],"inFrames":[{"seriesname":"inFrames","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Frames/sec"],"yaxiscolumnorder":[0],"suffix":""}],"outFrames":[{"seriesname":"outFrames","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Frames/sec"],"yaxiscolumnorder":[0],"suffix":""}],"outTraffic":[{"seriesname":"outTraffic","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","bps"],"yaxiscolumnorder":[0],"suffix":""}]}}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
InterfaceName*
接口名称-被管理实体名称,从接口快照页面的URL或listInterfaces API响应中的'interfaceName'属性值中查看。
period*
需要接口数据的周期。[例:12小时,今天,24小时,昨天,这个星期,最近7天,上一周,本月, 最近30天, 上个与,自定义]
startDate
从当前开始。当周期参数值中选择了'custom time '时,此参数才适用
endDate
到目前为止。当period参数值中选择了'custom time '时,此参数才适用

获取接口中断报表详情

方法: GET

描述: 为给定接口的合并带宽报表(Rx/Tx流量)提供数据。

示例 URL: https://localhost:8060/api/json/v2/device/getIntfBWOutageReportDetails?apiKey=***************&interfaceName=IF-xxx.xxx.xx.x-3836&period=Today

示例响应: {"InSpeed":"0 bps","IfDesc":"VLAN555","repType":9,"consolidatedValues":{"Total":{"95thpercentileValue":"0 ( 0.0 % )","minCollectionTime":"1669619780249","maxVal":"0 ( 0.0 % )","currVal":"0 ( 0.0 % )","minVal":"0 ( 0.0 % )","seriesName":"Total","95thpercRawVal":"0.0","avgVal":"0 ( 0.0 % )","95thperc":"0 ( 0.0 % )","maxCollectionTime":"1669619780249","95thpercVal":"0.0"},"InTraffic":{"95thpercentileValue":"0 ( 0.0 % )","minCollectionTime":"1669619780249","maxVal":"0 ( 0.0 % )","currVal":"0 ( 0.0 % )","minVal":"0 ( 0.0 % )","seriesName":"InTraffic","95thpercRawVal":"0.0","avgVal":"0 ( 0.0 % )","95thperc":"0 ( 0.0 % )","maxCollectionTime":"1669619780249","95thpercVal":"0.0"},"OutTraffic":{"95thpercentileValue":"0 ( 0.0 % )","minCollectionTime":"1669619780249","maxVal":"0 ( 0.0 % )","currVal":"0 ( 0.0 % )","minVal":"0 ( 0.0 % )","seriesName":"OutTraffic","95thpercRawVal":"0.0","avgVal":"0 ( 0.0 % )","95thperc":"0 ( 0.0 % )","maxCollectionTime":"1669619780249","95thpercVal":"0.0"}},"seriesNames":["OutTraffic","OutTraffic-95th","Total","Total-95th","InTraffic","InTraffic-95th"],"bwChartData":[{"seriesname":"OutTraffic","isRaw":true,"data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Bits per Second"]},{"seriesname":"OutTraffic-95th","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Bits per Second"]},{"seriesname":"Total","isRaw":true,"data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Bits per Second"]},{"seriesname":"Total-95th","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Bits per Second"]},{"seriesname":"InTraffic","isRaw":true,"data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Bits per Second"]},{"seriesname":"InTraffic-95th","data":[[1669619780249,0,"0 "],[1669620680708,0,"0 "]],"xyTitles":["Time","Bits per Second"]}],"InterfaceDisplayName":"VLAN555-VLAN555","IfAlias":"VLAN555","suffix":"","availData":{"Down":100,"Dependent Unavailable":0,"On Hold":0,"Not Monitored":0,"Parent Down":0,"On Maintenance":0,"Up":0},"deviceName":"IF-127.0.0.1-353","interfaceDetails":{"Parent Name":"HPswitch9","IfDescr":"VLAN555","IfIndex":"1132","IfAlias":"VLAN555","IfName":"VLAN555","Circuit ID":"-"},"OutSpeed":"0 bps","name":"HPswitch9","CircuitID":"-","IfIndex":"1132","InterfaceName":"IF-127.0.0.1-353","IfName":"VLAN555"}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
interfaceName*
接口名称-被管理实体名称,从接口快照页面的URL或listInterfaces API响应中的'interfaceName'属性值中查看
period*
需要绘制接口图的周期。[例:12小时,今天,24小时,昨天,这个星期,最近7天,上一周,本月, 最近30天, 上个月,自定义]
startDate
从当前开始。只有在period参数值中选择了'custom time'时,此参数才适用
endDate
到目前为止。此参数仅在period参数值中选择了'custom time'时才适用

获取接口

方法: GET

描述: 提供设备中监控的接口列表。

示例 URL: https://localhost:8060/api/json/device/getInterfaces?apiKey=***************&name=opmserver.testdomain.com

示例响应: {"downCount":"0","interfaces":[{"ifIndex":"1","ifAdminStatus":"1","ifIndexNum":1,"statusStr":"Clear","ifType":"Ethernet","displayName":"Backplane-GigabitEthernet0/3-Ba0/3","imagePath":"/apiclient/ember/images/intfTypes/ifType6.gif","RouterPortType":"","trimmedDispName":"Backplane-GigabitEtherne...","outSpeed":"1 G","inSpeed":"1 G","type":"Interface","moid":"301","outTraffic":"0 (0.0%)","nfEnabled":"false","statusNum":"5","bgColor":"00ff00","inTraffic":"0 (0.0%)","isSubInterface":"false","statusString":"Clear","name":"IF-http://127.0.0.1-301","ifOperStatus":"1","errors":"0","status":"5"},{"ifIndex":"4","ifAdminStatus":"1","ifIndexNum":4,"statusStr":"Clear","ifType":"Ethernet","displayName":"GigabitEthernet0/2-Gi0/2","imagePath":"/apiclient/ember/images/intfTypes/ifType6.gif","RouterPortType":"","trimmedDispName":"GigabitEthernet0/2-Gi0/2","outSpeed":"1 G","inSpeed":"1 G","type":"Interface","moid":"305","outTraffic":"160.279 K (0.02%)","nfEnabled":"false","statusNum":"5","bgColor":"00ff00","inTraffic":"32.239 K (0.0%)","isSubInterface":"false","statusString":"Clear","name":"IF-http://127.0.0.1-305","ifOperStatus":"1","errors":"0","status":"5"}],"interfaceCount":"2"}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
name*
父设备的名称-父设备的被管理实体名称,在设备快照页面的URL或listDevices API响应中的'deviceName'属性值中看到

获取接口备注

方法: GET

描述: 获取与给定接口关联的自定义字段值。

示例 URL: https://opmserver:8060/api/json/device/getInterfaceNotes?apiKey=************&interfaceName=IF-opmserver.testdomain.com-4505

示例响应: [{"CUSTOMFIELDID":"16","DATATYPE":"Text","DESCRIPTION":"Circuit ID","FIELDNAME":"Circuit ID","ALIASNAME":"UDF1","FIELDLENGTH":250},{"CUSTOMFIELDID":"20","DATATYPE":"Text","DESCRIPTION":"Any comments about the interface","FIELDNAME":"Comments","ALIASNAME":"UDF5","FIELDLENGTH":800},{"CUSTOMFIELDID":"21","DATATYPE":"Text","DESCRIPTION":"Contact person","FIELDNAME":"Contact Name","ALIASNAME":"UDF3","FIELDLENGTH":100},{"CUSTOMFIELDID":"18","DATATYPE":"Text","DESCRIPTION":"SLA related details","FIELDNAME":"SLA","ALIASNAME":"UDF2","FIELDLENGTH":250},{"CUSTOMFIELDID":"22","DATATYPE":"Text","DESCRIPTION":"Contact number","FIELDNAME":"Telephone Number","ALIASNAME":"UDF4","FIELDLENGTH":100}]

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
interfaceName*
接口名称-被管理实体名称,从接口快照页面的URL或listInterfaces API响应中的'interfaceName'属性值中查看

getInterfaceGraphs

方法: GET

描述: 获取收集到的数据(如流量,错误/丢包等)对于给定的接口。

示例 URL: https://localhost:8060/api/json/device/getInterfaceGraphs?apiKey=***************&interfaceName=IF-xxx.xxx.xx.xxx-329&graphName=rxutilization

示例响应: {"interfaceDetails":{"Parent Name":"OPMRouter1","IfDescr":"GigabitEthernet0/2","IfIndex":"4","IfAlias":"-","IfName":"Gi0/2","Circuit ID":"-"},"displayName":"Total Bytes Transfered","consolidatedValues":{"Total Bytes":{"95thpercentileValue":"61.616 M","minCollectionTime":"1669383479403","maxVal":"61.616 M","currVal":"21.658 M","minVal":"21.658 M","seriesName":"Total Bytes","95thpercRawVal":"5.02440515E7","avgVal":"51.868 M","95thperc":"50.244 M","maxCollectionTime":"1669371779404","95thpercVal":"50.2440515"},"Rx Bytes":{"95thpercentileValue":"14.783 M","minCollectionTime":"1669383479403","maxVal":"14.783 M","currVal":"3.626 M","minVal":"3.626 M","seriesName":"Rx Bytes","95thpercRawVal":"1.1226045333333334E7","avgVal":"11.734 M","95thperc":"11.226 M","maxCollectionTime":"1669364579398","95thpercVal":"11.226045333333333"},"Tx Bytes":{"95thpercentileValue":"48.097 M","minCollectionTime":"1669383479403","maxVal":"48.097 M","currVal":"18.031 M","minVal":"18.031 M","seriesName":"Tx Bytes","95thpercRawVal":"3.8807332333333336E7","avgVal":"40.134 M","95thperc":"38.807 M","maxCollectionTime":"1669371779404","95thpercVal":"38.807332333333335"}},"seriesNames":["Rx Bytes","Tx Bytes","Total Bytes"],"xyTitles":["Time","Bytes"],"graphData":[{"seriesname":"Rx Bytes","data":[[1669364579398,14.783359,"14.783 M"],[1669368179398,11.846604,"11.846 M"],[1669371779404,13.519316,"13.519 M"],[1669375379404,12.7214,"12.721 M"],[1669378979402,13.057771,"13.057 M"],[1669382579404,12.584193,"12.584 M"],[1669383479403,3.626988,"3.626 M"]]},{"seriesname":"Tx Bytes","data":[[1669364579398,46.577838,"46.577 M"],[1669368179398,38.532922,"38.532 M"],[1669371779404,48.097261,"48.097 M"],[1669375379404,41.533208,"41.533 M"],[1669378979402,44.321489,"44.321 M"],[1669382579404,43.847161,"43.847 M"],[1669383479403,18.031376,"18.031 M"]]},{"seriesname":"Total Bytes","data":[[1669364579398,61.361197,"61.361 M"],[1669368179398,50.379526,"50.379 M"],[1669371779404,61.616577,"61.616 M"],[1669375379404,54.254608,"54.254 M"],[1669378979402,57.37926,"57.379 M"],[1669382579404,56.431354,"56.431 M"],[1669383479403,21.658364,"21.658 M"]]}],"suffix":"M"}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
interfaceName*
接口名称-被管理实体名称,从接口快照页面的URL或listInterfaces API响应中的'interfaceName'属性值中查看
graphname
接口图名称[示例: totalPackets|traffic|utilization|errors|discardRate|packets|errorRate]
isFluidic
默认设置为“true”(用于内部用途)
period
需要绘制接口图的周期。[例:十二小时(16),今天(6),二十四小时(3),昨天(7),本周(8),最近7天(4),上周(9),本月(10),最近30天(5),上月(11),自定义(23)]
startDate
从当前开始。当period参数值中选择了'custom time '时,此参数才适用
endDate
到目前为止。当period参数值中选择了'custom time '时,此参数才适用

获取设备关联监视器

方法: GET

描述: 列出与设备关联的所有监视器

示例 URL: https://localhost:8060/api/json/device/getDeviceAssociatedMonitors?apiKey=***************&name=devicename

示例响应: {"performanceMonitors":{"total":6,"statusIcon":"images/servicestatus5.gif","down":0,"monitors":[{"DISPLAYNAME":"CPU Utilization","YAXISTEXT":"Percentage","graphType":"multiple","checkNumeric":"true","data":[{"instance":"-1","value":98}],"policyName":"WMI-CPUUtilization","Instance":"","THRESHOLDENABLED":"true","GRAPHID":"203","thresholdStatus":"Normal","isMultiple":"true","sSave":"true","type":"multiple","thresholdImg":"images/thresholdConOK.gif","lastCollectedTime":"16 Nov 2022 12:27:48 PM IST","DisplayColumn":"","pollId":"124","name":"WMI-CPUUtilization","numericType":"1","interval":"15","Protocol":"WMI"},{"DISPLAYNAME":"Memory Utilization","YAXISTEXT":"Percentage","graphType":"multiple","checkNumeric":"true","data":[{"instance":"-1","value":85}],"policyName":"WMI-MemoryUtilization","Instance":"","THRESHOLDENABLED":"true","GRAPHID":"204","thresholdStatus":"Normal","isMultiple":"true","sSave":"true","type":"multiple","thresholdImg":"images/thresholdConOK.gif","lastCollectedTime":"16 Nov 2022 12:27:33 PM IST","DisplayColumn":"","pollId":"125","name":"WMI-MemoryUtilization","numericType":"1","interval":"15","Protocol":"WMI"},{"DISPLAYNAME":"Partition Details of the Device(%)-C:","YAXISTEXT":"Percentage","graphType":"multiplenode","checkNumeric":"true","data":[{"instance":"-1","value":99}],"policyName":"WMI-PartitionDetails","Instance":"","THRESHOLDENABLED":"false","GRAPHID":"304","thresholdStatus":"Not Enabled","isMultiple":"false","sSave":"true","type":"node","thresholdImg":"images/thresholdNonConfigured.gif","lastCollectedTime":"16 Nov 2022 11:57:16 AM IST","DisplayColumn":"","pollId":"123","name":"C:","numericType":"1","interval":"60","Protocol":"WMI"},{"DISPLAYNAME":"Disk Utilization","YAXISTEXT":"Percentage","graphType":"multiple","checkNumeric":"true","data":[{"instance":"-1","value":99}],"policyName":"WMI-DiskUtilization","Instance":"","THRESHOLDENABLED":"false","GRAPHID":"205","thresholdStatus":"Not Enabled","isMultiple":"true","sSave":"true","type":"multiple","thresholdImg":"images/thresholdNonConfigured.gif","lastCollectedTime":"16 Nov 2022 11:57:16 AM IST","DisplayColumn":"","pollId":"122","name":"WMI-DiskUtilization","numericType":"1","interval":"60","Protocol":"WMI"}]},"deviceProtocol":"WMI","ntServiceMonitors":{"total":2,"statusIcon":"images/servicestatus1.gif","down":1,"monitors":[{"statusStr":"Clear","name":"DNS Server","serviceName":"DNS","serviceID":"4","moid":"405","status":"/images/devices/status5.gif","statusNum":"5"},{"statusStr":"Critical","name":"Telnet","serviceName":"TlntSvr","serviceID":"12","moid":"404","status":"/images/devices/status4.gif","statusNum":"1"}]},"fileMonitors":{"total":0,"statusIcon":"images/servicestatus5.gif","down":0,"monitors":[]},"adMonitors":{"total":39,"statusIcon":"images/servicestatus5.gif","down":0,"monitors":[{"YAXISTEXT":"Sessions","checkNumeric":"true","Description":"This monitor shows the number of connected Address Book client sessions.","data":[{"instance":"-1","value":0}],"statusStr":"Clear","severityIcon":"images/thresholdNonConfigured.gif","displayName":"AB Client Sessions","THRESHOLDENABLED":"false","GRAPHID":"605","groupingName":"Network","oid":"AD.Perf.ABClientSessions","PREVIOUSSEVERITY":"5","ID":"129","Protocol":"WMI","DISPLAYNAME":"AB Client Sessions","graphType":"node","thresholdFontColor":"#999999","policyName":"ABClientSessions","encodedName":"ABClientSessions","thresholdStatus":"Not Enabled","sSave":"true","statusNum":"5","lastCollectedTime":"16 Nov 2022 12:32:33 PM IST","name":"ABClientSessions","numericType":"1","interval":"15"}]},"folderMonitors":{"total":1,"statusIcon":"images/servicestatus5.gif","down":0,"monitors":[{"foldermonitorid":"259","folderpath":"C:\\Program Files","monitorname":"Local Directory","statusStr":"Clear","statusIcon":"/webclient/devices/images/servicestatus5.gif","state":"1","status":"5","statusNum":5}]},"isVM":false,"isHost":false,"serverMonitors":{"total":1,"down":0,"monitors":[{"portNo":"53","failureThreshold":1,"statusStr":"Clear","responseTime":"50","statusText":"Up","name":"DNS","THRESHOLDENABLED":"false","thresholdStatus":"Not Enabled","moid":"402","statusNum":"5"}]},"urlMonitors":{"total":1,"statusIcon":"images/servicestatus5.gif","down":0,"monitors":[{"compactURL":"http://localhost:8060/","availPercentage":"100.0","urlName":"localhost","stringstatus":"Clear","name":"localhost_URL","RESPONSETIME":"NA","completeURL":"http://localhost:8060/","deviceName":"localhost","url":"http://localhost:8060/","statusNum":"5"}]},"processMonitors":{"total":2,"statusIcon":"images/servicestatus5.gif","down":0,"monitors":[{"path":"C:\\Windows\\system32\\svchost.exe","statusStr":"Clear","cmdLineArgs":"-k UnistackSvcGroup","statusIcon":"/webclient/devices/images/servicestatus5.gif","name":"svchost.exe","state":"1","id":"407","proName":"svchost.exe","trimName":"svchost.exe","status":"5","statusNum":"5"},{"path":"C:\\Windows\\system32\\winlogon.exe","statusStr":"Clear","cmdLineArgs":"winlogon.exe","statusIcon":"/webclient/devices/images/servicestatus5.gif","name":"winlogon.exe","state":"1","id":"408","proName":"winlogon.exe","trimName":"winlogon.exe","status":"5","statusNum":"5"}]},"exchangeMonitors":{"total":30,"exchangeVersion":"Exchange 2016","statusIcon":"images/servicestatus5.gif","down":0,"monitors":[{"YAXISTEXT":"Calls","checkNumeric":"true","Description":"This monitor shows the number of calls disconnected after an internal system error occurred.","data":[{"instance":"-1","value":0}],"statusStr":"Clear","severityIcon":"images/thresholdNonConfigured.gif","displayName":"Calls Disconnected on Irrecoverable Internal Error","THRESHOLDENABLED":"false","GRAPHID":"1030","groupingName":"Unified Messaging Performance","oid":"Exchange.UMAvailability.CallsDisconnectedonIrrecoverableInternalError","PREVIOUSSEVERITY":"5","ID":"194","Protocol":"WMI","DISPLAYNAME":"Calls Disconnected on Irrecoverable Internal Error","graphType":"node","thresholdFontColor":"#999999","policyName":"CallsDisconnectedonIrrecoverableInternalError","encodedName":"CallsDisconnectedonIrrecoverableInternalError","thresholdStatus":"Not Enabled","sSave":"true","statusNum":"5","lastCollectedTime":"16 Nov 2022 12:27:39 PM IST","name":"CallsDisconnectedonIrrecoverableInternalError","numericType":"1","interval":"15"},{"YAXISTEXT":"%","checkNumeric":"true","Description":"This monitor shows the percentage of mailbox connection attempts that have failed in the last hour.","data":[{"instance":"-1","value":0}],"statusStr":"Clear","severityIcon":"images/thresholdNonConfigured.gif","displayName":"Percent of Failed Mailbox Connection Attempts Over the Last Hour","THRESHOLDENABLED":"false","GRAPHID":"1028","groupingName":"Unified Messaging Performance","oid":"Exchange.UMAvailability.PercentofFailedMailboxConnectionAttemptsOvertheLastHour","PREVIOUSSEVERITY":"5","ID":"185","Protocol":"WMI","DISPLAYNAME":"Percent of Failed Mailbox Connection Attempts Over the Last Hour","graphType":"node","thresholdFontColor":"#999999","policyName":"PercentofFailedMailboxConnectionAttemptsOvertheLastHour","encodedName":"PercentofFailedMailboxConnectionAttemptsOvertheLastHour","thresholdStatus":"Not Enabled","sSave":"true","statusNum":"5","lastCollectedTime":"16 Nov 2022 12:27:41 PM IST","name":"PercentofFailedMailboxConnectionAttemptsOvertheLastHour","numericType":"1","interval":"15"}]},"exchangeServices":{"total":15,"statusIcon":"images/servicestatus1.gif","down":14,"monitors":[{"displayName":"Microsoft Exchange Compliance Audit","description":"The Microsoft Exchange Compliance Audit service.","serviceMOID":368,"state":2,"serviceName":"MSComplianceAudit","serviceID":22,"status":4},{"displayName":"Microsoft Exchange Compliance Service","description":"Host for Compliance Services.","serviceMOID":369,"state":2,"serviceName":"MSExchangeCompliance","serviceID":23,"status":4},{"displayName":"Microsoft Exchange Health Manager Recovery","description":"Recovery Service for Health Manager","serviceMOID":370,"state":2,"serviceName":"MSExchangeHMRecovery","serviceID":24,"status":4},{"displayName":"Microsoft Exchange Mailbox Assistants","description":"Performs background processing of mailboxes in the Exchange store.","serviceMOID":361,"state":2,"serviceName":"MSExchangeMailboxAssistants","serviceID":15,"status":4},{"displayName":"Microsoft Exchange Monitoring","description":"Allows applications to call the Exchange diagnostic cmdlets.","serviceMOID":362,"state":2,"serviceName":"MSExchangeMonitoring","serviceID":16,"status":4},{"displayName":"Microsoft Exchange Notifications Broker","description":"The Microsoft Exchange Notifications Broker service provides generation and routing of Exchange notifications to local and remote Exchange processes.","serviceMOID":371,"state":2,"serviceName":"MSExchangeNotificationsBroker","serviceID":25,"status":4},{"displayName":"Microsoft Exchange Service Host","description":"Provides a host for several Exchange services.","serviceMOID":364,"state":2,"serviceName":"MSExchangeServiceHost","serviceID":18,"status":4},{"displayName":"Microsoft Exchange Throttling","description":"Limits the rate of user operations.","serviceMOID":365,"state":2,"serviceName":"MSExchangeThrottling","serviceID":19,"status":4},{"displayName":"Microsoft Exchange Unified Messaging Service","description":"Enables Microsoft Exchange Unified Messaging features.","serviceMOID":367,"state":2,"serviceName":"MSExchangeUM","serviceID":21,"status":4},{"displayName":"Microsoft Filtering Management Service","description":"Manages the queuing and dispatching of scan requests.","serviceMOID":372,"state":1,"serviceName":"FMS","serviceID":26,"status":5},{"displayName":"MS Exchange Active Directory Topology Service","description":"Provides Active Directory topology information to Exchange services.","serviceMOID":359,"state":2,"serviceName":"MSExchangeADTopology","serviceID":13,"status":4},{"displayName":"MS Exchange IMAP4","description":"Provides IMAP4 service to clients.","serviceMOID":360,"state":2,"serviceName":"MSExchangeImap4","serviceID":14,"status":4},{"displayName":"MS Exchange Information Store","description":"Information Store service - Stores all the user information, documents, messages and other informations. It contains user mail boxes where it stores user mails.","serviceMOID":358,"state":2,"serviceName":"MSExchangeIS","serviceID":12,"status":4},{"displayName":"MS Exchange POP3","description":"Provides POP3 service to clients.","serviceMOID":363,"state":2,"serviceName":"MSExchangePop3","serviceID":17,"status":4},{"displayName":"MS Exchange Transport","description":"The Microsoft Exchange Transport Service.","serviceMOID":366,"state":2,"serviceName":"MSExchangeTransport","serviceID":20,"status":4}]},"eventlogMonitors":{"period":"300","total":2,"statusIcon":"images/servicestatus5.gif","isActive":"true","down":0,"monitors":[{"ruleName":"Any Application failure","id":"2"},{"ruleName":"Any Directory Service failure","id":"45"}]},"scriptMonitors":{"total":1,"statusIcon":"images/servicestatus5.gif","down":0,"monitors":[{"checkNumeric":"true","data":[{"instance":"count","value":"17"}],"statusStr":"Clear","displayName":"Instance Count","thresholdSeverity":"Not Enabled","OID":"301","sSave":"true","statusNum":"5","lastCollectedTime":"16 Nov 2022 12:37:36 PM IST","pollid":"258","interval":"15","thresholdSevFont":"#999999","numericType":"1"}]},"adServices":{"total":11,"statusIcon":"images/servicestatus1.gif","down":1,"monitors":[{"displayName":"DFS Replication","description":"This service enables synchronizing folders on multiple servers across local or WAN network","serviceMOID":"346","serviceName":"DFSR","serviceID":"1","status":"5"},{"displayName":"DNS Client Service","description":"This service resolves and caches (Domain Name Server) DNS names.","serviceMOID":"347","serviceName":"Dnscache","serviceID":"2","status":"5"},{"displayName":"File Replication Service","description":"This service maintains file synchronization of file directory contents among multiple servers.","serviceMOID":"348","serviceName":"NtFrs","serviceID":"3","status":"4"},{"displayName":"Intersite Messaging Service","description":"This service is used for mail-based replication between sites. Active Directory includes support for replication between sites by using SMTP over IP transport.","serviceMOID":"349","serviceName":"IsmServ","serviceID":"4","status":"5"},{"displayName":"Kerberos Key Distribution Center Service","description":"This service enables users to log on to the network using the Kerberos version 5 authentication protocol.","serviceMOID":"350","serviceName":"kdc","serviceID":"5","status":"5"},{"displayName":"Net Logon Service","description":"This service supports pass-through authentication of account logon events for computers in a domain. ","serviceMOID":"351","serviceName":"Netlogon","serviceID":"6","status":"5"},{"displayName":"Remote Procedure Call (RPC) Service","description":"This service provides the name services for RPC clients.","serviceMOID":"352","serviceName":"RpcSs","serviceID":"7","status":"5"},{"displayName":"Security Accounts Manager Service","description":"This service signals other services that the Security Accounts Manager subsystem is ready to accept requests.","serviceMOID":"353","serviceName":"SamSs","serviceID":"8","status":"5"},{"displayName":"Server Service","description":"This service enables the computer to connect to other computers on the network based on the SMB protocol.","serviceMOID":"354","serviceName":"lanmanserver","serviceID":"9","status":"5"},{"displayName":"Windows Time service","description":"The service synchronizes the time between domain controllers, which prevents time skews from occurring.","serviceMOID":"355","serviceName":"W32Time","serviceID":"10","status":"5"},{"displayName":"Workstation Service","description":"This service provides network connections and communications.","serviceMOID":"356","serviceName":"lanmanworkstation","serviceID":"11","status":"5"}]}}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
name*
设备名称

性能监视器

获取性能监视器

方法: GET

描述: 列出特定设备的所有可用性能监视器(基于设备的类别和类型)

示例 URL: https://localhost:8060/api/json/device/getPerformanceMonitors?apiKey=***************&deviceName=devicename&category=Desktop&type=Windows 2008 R2

示例响应: {"General Monitors":[{"DISPLAYNAME":"SysUpTime","Description":"The time (in hundredths of a second) since the network management portion of the system was last re-initialized","name":"SysUpTime","isSelected":"false","GRAPHID":1166,"interval":"900","Protocol":"SNMP","thresholdEnabled":"false","STANDARDNAME":"General Monitors"},{"DISPLAYNAME":"Network Interfaces","Description":"The number of network interfaces (regardless of their current state) present on this system","name":"Number of Network Interfaces","isSelected":"false","GRAPHID":1167,"interval":"3600","Protocol":"SNMP","thresholdEnabled":"false","STANDARDNAME":"General Monitors"},{"DISPLAYNAME":"IP Routing discards","Description":"The number of routing entries which were chosen to be discarded even though they are valid","name":"ipRoutingDiscards","isSelected":"false","GRAPHID":1168,"interval":"3600","Protocol":"SNMP","thresholdEnabled":"false","STANDARDNAME":"General Monitors"}],"Performance Monitors":[{"DISPLAYNAME":"File Access Violations","Description":"Monitors the number of access permission violations encountered on this server.","name":"Win-FileAccessViolations","isSelected":"false","GRAPHID":4604,"interval":"900","Protocol":"SNMP","thresholdEnabled":"false","isCustomGraph":"false"},{"DISPLAYNAME":"Number of System Errors","Description":"Monitors the number of system errors encountered on the server.","name":"Win-NumberOfSystemErrors","isSelected":"false","GRAPHID":4605,"interval":"900","Protocol":"SNMP","thresholdEnabled":"false","isCustomGraph":"false"},{"DISPLAYNAME":"Number of installed services","Description":"Monitors the number of network services installed on this server.","name":"Win-NumberOfInstalledServices","isSelected":"false","GRAPHID":4606,"interval":"3600","Protocol":"SNMP","thresholdEnabled":"false","isCustomGraph":"false"},{"DISPLAYNAME":"Number of Shared Resources","Description":"Monitors the number of shared resources on this server.","name":"Win-NumberOfSharedResources","isSelected":"false","GRAPHID":4607,"interval":"900","Protocol":"SNMP","thresholdEnabled":"false","isCustomGraph":"false"},{"DISPLAYNAME":"Number of Print Queued Jobs","Description":"Monitors the total number of print jobs that have been spooled on the server.","name":"Win-NumberOfPrintQueuedJobs","isSelected":"false","GRAPHID":4609,"interval":"900","Protocol":"SNMP","thresholdEnabled":"false","isCustomGraph":"false"},{"DISPLAYNAME":"Logical Drive status","Description":"Monitors the status of logical drives. KEY: 2 - Ok, 3 - Failed, 10 - Overheating, 11 - Shutdown, 13 - notAvailable","name":"Win-LogicalDriveStatus","isSelected":"false","GRAPHID":4603,"interval":"900","Protocol":"SNMP","thresholdEnabled":"false","isCustomGraph":"false"},{"DISPLAYNAME":"Number of Opened Files","Description":"Monitors the total number of files that have been opened on the server.","name":"Win-NumberOfOpenedFiles","isSelected":"false","GRAPHID":4608,"interval":"900","Protocol":"SNMP","thresholdEnabled":"false","isCustomGraph":"false"},{"DISPLAYNAME":"Number of Failed Logins","Description":"Monitors the number of password violations encountered on the server.","name":"WinFailedLogins","isSelected":"false","GRAPHID":4610,"interval":"900","Protocol":"SNMP","thresholdEnabled":"false","isCustomGraph":"false"}],"HOST-RESOURCES Monitors":[{"DISPLAYNAME":"CPU Utilization","Description":"Monitors the CPU Utilization based on HOSTRESOURCE MIB","name":"Win-CPUUtilization","isSelected":"false","GRAPHID":35,"interval":"900","Protocol":"SNMP","thresholdEnabled":"false","STANDARDNAME":"HOST-RESOURCES Monitors"},{"DISPLAYNAME":"Memory Utilization","Description":"Monitors the Memory Utilization","name":"Win-MemoryUtilization","isSelected":"false","GRAPHID":36,"interval":"900","Protocol":"SNMP","thresholdEnabled":"false","STANDARDNAME":"HOST-RESOURCES Monitors"},{"DISPLAYNAME":"Disk Utilization","Description":"Monitors the Disk Utilization","name":"DiskUtilization","isSelected":"false","GRAPHID":37,"interval":"3600","Protocol":"SNMP","thresholdEnabled":"false","STANDARDNAME":"HOST-RESOURCES Monitors"},{"DISPLAYNAME":"Free Disk Space in GB","Description":"Monitors the free disk space in GB using SNMP","name":"Win-FreeDiskSpaceInGB","isSelected":"false","GRAPHID":276,"interval":"3600","Protocol":"SNMP","thresholdEnabled":"false","STANDARDNAME":"HOST-RESOURCES Monitors"},{"DISPLAYNAME":"Free Disk Space in MB","Description":"Monitors the Free disk space in MB using SNMP","name":"Win-FreeDiskSpaceInMB","isSelected":"false","GRAPHID":277,"interval":"3600","Protocol":"SNMP","thresholdEnabled":"false","STANDARDNAME":"HOST-RESOURCES Monitors"},{"DISPLAYNAME":"Used Disk Space in GB","Description":"Monitors the used disk space in GB","name":"Win-UsedDiskSpaceInGB","isSelected":"false","GRAPHID":278,"interval":"3600","Protocol":"SNMP","thresholdEnabled":"false","STANDARDNAME":"HOST-RESOURCES Monitors"},{"DISPLAYNAME":"Used Disk Space in MB","Description":"Monitors the used disk space in MB using SNMP","name":"Win-UsedDiskSpaceInMB","isSelected":"false","GRAPHID":279,"interval":"3600","Protocol":"SNMP","thresholdEnabled":"false","STANDARDNAME":"HOST-RESOURCES Monitors"},{"DISPLAYNAME":"Partition Details of the Device (%)","Description":"Monitoring the usage in each partition of the Device.","name":"PartitionWiseDiskDetails","isSelected":"false","GRAPHID":280,"interval":"3600","Protocol":"SNMP","thresholdEnabled":"false","STANDARDNAME":"HOST-RESOURCES Monitors"},{"DISPLAYNAME":"CPU Utilization(UCD SNMP MIB)","Description":"Monitors the CPU Utilization based on UCD SNMP MIB","name":"Lin-CPUUtilization","isSelected":"false","GRAPHID":330,"interval":"900","Protocol":"SNMP","thresholdEnabled":"false","STANDARDNAME":"HOST-RESOURCES Monitors"},{"DISPLAYNAME":"Process Count","Description":"Monitors the Number of Processes running in a machine.","name":"ProcessCount","isSelected":"false","GRAPHID":375,"interval":"900","Protocol":"SNMP","thresholdEnabled":"false","STANDARDNAME":"HOST-RESOURCES Monitors"},{"DISPLAYNAME":"Memory Utilization(UCD SNMP MIB)","Description":"Monitors the Memory utilization based on UCD SNMP MIB","name":"Lin-MemoryUtilization","isSelected":"false","GRAPHID":549,"interval":"900","Protocol":"SNMP","thresholdEnabled":"false","STANDARDNAME":"HOST-RESOURCES Monitors"}],"Custom Monitor":[{"DISPLAYNAME":"ifSpeed","Description":"ifSpeed","name":"ifSpeed","isSelected":"false","GRAPHID":4646,"interval":"900","Protocol":"SNMP","thresholdEnabled":"false","isCustomGraph":"true"}]}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
deviceName*
设备名称
category*
设备类别
type*
设备类别

获取性能监视器详细信息

方法: GET

描述: 列出来自特定设备的关联性能监视器的详细信息

示例 URL: https://localhost:8060/api/json/device/getPerformanceMonitorDetails?apiKey=***************&name=devicename&policyName=WMI-CPUUtilization&graphName=WMI-CPUUtilization&checkNumeric=true

示例响应: {"statsList":[{"minimumValue":"84","averageValue":"85","instance":"PhysicalMemUtilization","percentile":"85","lastPolledValue":"86","maximumValue":"86"}],"monitors":{"YAXISTEXT":"Percentage","checkNumeric":"true","Description":"Monitors the Memory Utilization using WMI","Instance":"","THRESHOLDENABLED":"true","GRAPHID":"204","oid":"Memory Utilization","type":"multiple","PREVIOUSSEVERITY":"5","defaultMessage_AT":"$MONITOR is $CURRENTVALUE $UNITS,Expected value for this monitor is $EXPECTEDVALUE $UNITS, current adaptive threshold is $THRESHOLDVALUE $UNITS","defaultMessage":"$MONITOR is $CURRENTVALUE%, threshold value for this monitor is $THRESHOLDVALUE%","id":"125","Protocol":"WMI","FAILURETHRESHOLD":"1","DISPLAYNAME":"Memory Utilization","thresholdSet":[{"severity":"2","clrMessage":"$MONITOR is now back to normal, current value is $CURRENTVALUE $UNITS","troubleThresholdType":"max","troubleThresholdName":"1668514350868814042","troubleMessage":"$MONITOR is $CURRENTVALUE $UNITS,Expected value for this monitor is $EXPECTEDVALUE $UNITS, current adaptive threshold is $THRESHOLDVALUE $UNITS","oidType":"","rearmValue":"0","troubleThresholdValue":"15"},{"severity":"1","clrMessage":"$MONITOR is now back to normal, current value is $CURRENTVALUE $UNITS","criticalThresholdName":"1668514350869567781","criticalMessage":"$MONITOR is $CURRENTVALUE $UNITS,Expected value for this monitor is $EXPECTEDVALUE $UNITS, current adaptive threshold is $THRESHOLDVALUE $UNITS","criticalThresholdValue":"20","oidType":"","rearmValue":"0","isAtEnabled":true,"criticalThresholdType":"max"},{"severity":"3","clrMessage":"$MONITOR is now back to normal, current value is $CURRENTVALUE $UNITS","warningThresholdName":"1668514350867431743","warningMessage":"$MONITOR is $CURRENTVALUE $UNITS,Expected value for this monitor is $EXPECTEDVALUE $UNITS, current adaptive threshold is $THRESHOLDVALUE $UNITS","warningThresholdType":"max","oidType":"","warningThresholdValue":"10","rearmValue":"0","isAtEnabled":true}],"graphType":"multiple","policyName":"WMI-MemoryUtilization","agentName":"localhost","isMultiple":"true","sSave":"true","defaultClrMessage":"$MONITOR is now back to normal, current value is $CURRENTVALUE%","DisplayColumn":"","name":"WMI-MemoryUtilization","numericType":"1","interval":"15","Id":"125","isAtEnabled":true}}

参数名称
描述
备注
apiKey*
访问OpManager服务器的API密钥。
-
设备名称
-
policyName*
性能监视器的策略名称
-
groupName*
性能监视器的图形名称。
“policyName”和“graphName”值可以getDeviceAssociatedMonitors获取
checkNumeric*
true (或者) false。
-

添加性能监视器

方法: POST

描述: 向设备添加一个新的性能监视器(或多个性能监视器)

示例 URL: https://localhost:8060/api/json/device/addPerformanceMonitors?apiKey=***************&name=devicename&selectedMonitors=1166,3337,304,204,205,203,3327

示例响应: {"result":{"message":"Monitor added successfully"}}

参数名称
描述
备注
apiKey*
访问OpManager服务器的API密钥。
-
name*
设备名称
-
selectedMonitors*
要添加的性能监视器的图形(多个值用逗号分隔)。
GraphID值可以从获取性能监视器 API获得

删除性能监视器

方法: POST

描述: 从设备中删除性能监视器

示例 URL: https://localhost:8060/api/json/device/deletePerformanceMonitors?apiKey=***************&name=devicename&pollId=332,213

示例响应: {"result":{"message":"The monitor(s) will be deleted. Please check after sometime."}}

参数名称
描述
备注
apiKey*
访问OpManager服务器的API密钥。
-
name*
设备名称
-
pollId*
性能监视器的pollId(多个值,用逗号分隔)。
pollId值可以从获取设备关联监视器 API获取

测试监视器

方法: POST

描述: 测试特定设备中的性能监视器

示例 URL: https://localhost:8060/api/json/device/TestMonitor?apiKey=***************&name=devicename&policyName=WMI-MemoryUtilization&graphName=WMI-MemoryUtilization

示例响应: {"protocol":"SNMP","checkNumeric":"true","reasons":[],"monitorname":"Win-MemoryUtilization","data":[89],"displayName":"Memory Utilization","isMultiple":"false","oid":".1.3.6.1.2.1.25.5.1.1.2","units":"Percentage","deviceName":"localhost"}

参数名称
描述
备注
apiKey*
访问OpManager服务器的API密钥。
-
name*
设备名称
-
policyName*
监视器的策略名称
-
graphName*
监视器图表名称
可以从getDeviceAssociatedMonitors API获取
instanceName
实例名(仅适用于MSSQL监视器).
-

进程监视器

获取关联进程监视器

方法: GET

描述: 获取已关联到设备的进程监视器列表

示例 URL: https://localhost:8060/api/json/device/getAssociatedProcessMonitors?apiKey=***************&deviceName=devicename

示例响应: {"protocol":"WMI","Templates":[{"protocol":"CLI","associatedDeviceCount":"0","templateName":"httpd","displayName":"httpd","description":"Process Template for httpd","templateId":"2"},{"protocol":"WMI","associatedDeviceCount":"2","templateName":"sqlservr.exe","displayName":"MSSQL","description":"Process Template for MSSQL","templateId":"1"}],"AssignedMonitors":[{"path":"C:\\Program Files\\Microsoft SQL Server\\MSSQL\\Binn\\sqlservr.exe","statusStr":"Clear","cmdLineArgs":"","statusIcon":"/webclient/devices/images/servicestatus5.gif","name":"MSSQL","state":"1","id":"611","proName":"sqlservr.exe","trimName":"MSSQL","status":"5","statusNum":"5"}],"ActiveProcesses":{"7244":{"path":"C:\\Windows\\System32\\msdtc.exe","trimArgs":"","trimPath":"C:\\Windows\\System32\\msdtc.exe","cmdLineArgs":"","name":"msdtc.exe","trimName":"msdtc.exe"},"3680":{"path":"C:\\Windows\\system32\\SearchIndexer.exe","trimArgs":"/Embedding","trimPath":"C:\\Windows\\system32\\SearchIndexer.exe","cmdLineArgs":"/Embedding","name":"SearchIndexer.exe","trimName":"SearchIndexer.exe"},"4692":{"path":"-","trimArgs":"","trimPath":"-","cmdLineArgs":"","name":"csrss.exe","trimName":"csrss.exe"},"1473196":{"path":"C:\\Program Files (x86)\\DesktopCentral_Agent\\appctrl\\bin\\DriverCtrl.exe","trimArgs":" ","trimPath":"C:\\Program Files (x86)\\DesktopCentral_Ag...","cmdLineArgs":" ","name":"DriverCtrl.exe","trimName":"DriverCtrl.exe"},"4652":{"path":"C:\\Windows\\system32\\winlogon.exe","trimArgs":"winlogon.exe","trimPath":"C:\\Windows\\system32\\winlogon.exe","cmdLineArgs":"winlogon.exe","name":"winlogon.exe","trimName":"winlogon.exe"},"1473196":{"path":"C:\\Program Files (x86)\\DesktopCentral_Agent\\appctrl\\bin\\DriverCtrl.exe","trimArgs":" ","trimPath":"C:\\Program Files (x86)\\DesktopCentral_Ag...","cmdLineArgs":" ","name":"DriverCtrl.exe","trimName":"DriverCtrl.exe"},"4652":{"path":"C:\\Windows\\system32\\winlogon.exe","trimArgs":"winlogon.exe","trimPath":"C:\\Windows\\system32\\winlogon.exe","cmdLineArgs":"winlogon.exe","name":"winlogon.exe","trimName":"winlogon.exe"}},"deviceName":"localhost"}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
deviceName*
设备名称

关联进程监视器

方法: POST

描述: 将进程监视器关联到一个设备

示例 URL: https://localhost:8060/api/json/device/associateProcessMonitor?apiKey=***************&deviceName=devicename&processId=408,8,68&protocol=WMI

示例响应: {"result":{"message":"Process monitor(s) associated successfully."}}

参数名称
描述
备注
apiKey*
访问OpManager服务器的API密钥。
-
deviceName*
设备名称
-
processId*
需要关联的进程ID
processId值可以从获取关联进程监视器 API获取

获取关联服务监视器

方法: GET

描述: 获取已关联到设备的服务监视器列表

示例 URL: https://localhost:8060/api/json/device/getAssociatedServiceMonitors?apiKey=***************&name=devicename

示例响应: {"remainingServices":["DNS(53)","Echo(7)","FTP(21)","HTTPS(443)","IMAP(143)","LDAP(389)","MSSQL(1433)","MySQL(3306)","NNTP(119)","Oracle(1521)","POP(110)","SMTP(25)","Telnet(23)","Web(80)","WebLogic(7001)"],"selectedServices":["MSSQL(1433)"]}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
name*
设备名称

关联服务监视器

方法: POST

描述: 将服务监视器关联到设备

示例 URL: https://localhost:8060/api/json/admin/associateServiceMonitor?apiKey=***************&deviceName=devicename&serviceName=DNS,FTP,Echo

示例响应: {"result":{"message":"Service Monitor associated successfully"}}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
deviceName*
要关联服务的设备名称。以逗号分隔名称,以便批量关联
serviceName*
服务名称(多个值,以逗号分隔)。

Windows服务监视器

获取设备关联Windows服务监视器

方法: GET

描述: 列出设备关联的Windows服务监视器

示例 URL: https://localhost:8060/api/json/device/getDeviceAssociatedWindowsServiceMonitors?apiKey=***************&name=devicename

示例响应: [{"displayName": "Diagnostic Service Host","serviceName": "WdiServiceHost","serviceID": "349","status": "Critical"},{"displayName": "Diagnostic System Host","serviceName": "WdiSystemHost","serviceID": "350","status": "Critical"},{"displayName": "Print Spooler","serviceName": "Spooler","serviceID": "1","status": "Clear"}]

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
name*
设备名称

URL监视器

获取URL监视器

方法: GET

描述: 列出OpManager中可用的所有全局URL监视器

示例 URL: https://localhost:8060/api/json/admin/listURLMonitors?apiKey=***************

示例响应: {"List":[{"availPercentage":0,"urlName":"Google","statusStr":"Service Down","name":"Google_URL","RESPONSETIME":"No Response","url":"http://www.google.com","moID":961,"statusNum":4},{"availPercentage":0,"urlName":"HTTP Url","statusStr":"Service Down","name":"HTTP Url_URL","RESPONSETIME":"No Response","url":"http://localhost:8060","moID":996,"statusNum":4},{"availPercentage":0,"urlName":"HTTPS Url","statusStr":"Service Down","name":"HTTPS Url_URL","RESPONSETIME":"No Response","url":"https://www.zoho.com","moID":997,"statusNum":4}],"Details":{"00-10%":[{"Status":4,"Label":"Service Down","Count":6}]},"DialCounter":[{"title":"Service Down","value":6,"status":4}]}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。

URL监视器

所有设备指定的url列表

方法: GET

描述: 列出OpManager中可用的所有特定于设备的URL监视器

示例 URL: https://localhost:8061/api/json/admin/listAllDevicesSpecificURLs?apiKey=***************

示例响应: {"List":[{"parentName":"localhost","urlName":"URL_1","stringstatus":"Clear","parentDispName":"localhost","name":"URL_1_URL","url":"https://google.com","status":"5","statusNum":"5"},{"parentName":"localhost","urlName":"URL_2","stringstatus":"Clear","parentDispName":"localhost","name":"URL_2_URL","url":"https://google.com","status":"5","statusNum":"5"}]

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。

脚本监视器

脚本监视器列表

方法: GET

描述: 列出OpManager中所有可用的脚本模板

示例 URL: https://localhost:8060/api/json/admin/listScriptMonitors?apiKey=***************

示例响应: [{"graphName":"Cache Memory","scriptID":"102","executeFrom":"1","graphDesc":"Perl Script to get cache memory of a linux system","graphID":"1207"},{"graphName":"File Size","scriptID":"103","executeFrom":"1","graphDesc":"Shell script to get memory size of a file in linux system","graphID":"1208"},{"graphName":"Instance Count","scriptID":"101","executeFrom":"0","graphDesc":"VBScript to get number of instances running for a given process","graphID":"1206"},{"graphName":"Thread Count","scriptID":"104","executeFrom":"0","graphDesc":"Powershell script to get thread count of a process","graphID":"1209"}]

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。

通知配置文件列表

方法: GET

描述: 这个API用于列出OpManager中创建的所有通知配置文件。

示例 URL: https://localhost:8060/api/json/admin/listNotificationProfiles?apiKey=***************&isGlobal=true&profileFilter=All&deviceName=devicename

示例响应: [{"profileName":"Play Sound","hasSubProfiles":false,"profileType":"Run Program","profileLabel":"Run Program","profileID":"1","hasCriteria":false,"isDevice":false,"status":"true"}, {"profileName":"testProfile","hasSubProfiles":false,"profileType":"Send Email","profileLabel":"Send Email","profileID":"301","isDevice":false,"hasAssociated":true,"status":"true"}]

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
isGlobal
false -列出所有设备特定配置文件
profileFilter
全部 - 对于全局配置文件和其他类型的配置文件(发送+电子邮件,发送+短信,发送+调制解调器+短信,运行+系统+命令等,工单,web告警,发送syslog,发送trap, Chat, SDPOnDemand,Webhook (全部 - 列出所有全局概要文件 / 其他值中的任何一个 -列出特定类型的全局概要文件)
deviceName*
设备名称-列出包含设备关联提示的所有全局配置文件。(如果特定的通知配置文件与给定的设备名称相关联,则API响应中的hasAssociated键的值将为“true”)

注意:

  1. API只选择了两个参数,就会给出预期的结果。参数apiKey是一个必选参数,选择剩下的三个参数之一,并根据您的需求使用它。
  2. 资源清单->设备->设备快照页面创建的通知配置文件->单击右上方的邮件图标->添加选项称为设备特定配置文件
  3. 设置->通知配置->添加选项创建的通知配置文件称为全局配置文件

关联通知配置文件

方法: POST

描述: 此API用于将通知配置文件关联到设备。

示例 URL: https://localhost:8060/api/json/admin/associateNotificationProfiles?apiKey=***************&deviceName=devicename&profiles=501

示例响应: {"result":{"message":"Notification Profile has been associated successfully"}}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
deviceName*
需要关联的设备名称
profiles*
要关联的概要文件的ProfileID。

更新通知配置文件状态

方法: POST

描述: 此API用于启用/禁用通知配置文件。该API将从OpManager版本127189中提供

示例 URL: https://localhost:8060/api/json/admin/updateNotificationProfileStatus?apiKey=***************&profileName=testprofile&profileId=301&status=disable

示例响应:{"message":"Notification Profile(s) enabled successfully"} or {"message":"Notification Profile(s) disabled successfully"}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
profileName*
必须启用/禁用的配置文件的名称
profileId*
必须启用/禁用的配置文件的ID
status*
启用或禁用
deviceName
创建通知配置文件的设备名称。[仅用于设备特定通知配置文件,不需要全局通知配置文件]

获取通知配置文件

方法: GET

描述: 此API用于列出特定于设备的通知配置文件。

示例 URL: https://localhost:8060/api/json/device/getNotificationProfiles?apiKey=***************&name=devicename

示例响应:[{"profileName":"Default Notification Profile","actionDisplayName":"Send Email","profileLabel":"Send Email","criteriaId":"301","profileId":"601","isGlobal":true,"actionName":"Send Email","status":"true"}]

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
name*
必须列出配置文件的设备名称

获取高级报表数据

方法: GET

描述: 获取高级报表数据函数基于延迟加载。当进行第一个API调用时,它将给出报表中显示的行数作为响应。随后的API调用将基于指定的参数带来适当的响应。

例:
调用高级报表列表API来获取reporttid数据。然后进行获取高级报表数据 API调用。

First API Call: https://<Host>:<port>/api/json/reports/getAdvancedReportData?getColumnDetails=true&reportID=901&apiKey=***********************************

Params: getColumnDetails=true, reportID=901, apiKey=**********************************************

示例响应: { "headers": [ "Availability (%)", "Up time", "On Hold time", "Maintenance Time", "Parent Down Time", "Dependent Down Time", "Down time" ], "total": 1, "groupByCount": 0, "reportID": "6903", "reportName": "sdfsf", "records": 1, "totalColumns": 7, "groupHeader": [] }

Response:
{
deviceNameIndex: 0
groupByCount: 0
groupHeader: []
headers: ["Device Name", "Status", "Availability (%)"]
moduleId: "1"
records: 4289
total: 86
totalColumns: 3
}

注意: 记录表示报表中显示的行总数。根据记录(行数),您可以决定要进行的API调用的数量。在单个API调用中,您最多可以获得1000行。因此,如果您的报表总共有5000行,则必须连续调用5次API才能获得完整的数据。

连续调用API

https://<Host>:<port>/api/json/reports/getAdvancedReportData?fetchFromRowNumber=1&rowsToFetch=1000&reportId=901&apiKey=***********************************
https://<Host>:<port>/api/json/reports/getAdvancedReportData?fetchFromRowNumber=1001&rowsToFetch=1000&reportId=901&apiKey=***********************************
https://<Host>:<port>/api/json/reports/getAdvancedReportData?fetchFromRowNumber=2001&rowsToFetch=1000&reportId=901&apiKey=***********************************
https://<Host>:<port>/api/json/reports/getAdvancedReportData?fetchFromRowNumber=3001&rowsToFetch=1000&reportId=901&apiKey=***********************************
https://<Host>:<port>/api/json/reports/getAdvancedReportData?fetchFromRowNumber=4001&rowsToFetch=289&reportId=901&apiKey=***********************************

示例响应: { "total": 1, "reportID": "6903", "reportName": "Report 1", "records": 1, "page": "1", "rows": [ { "Maintenance Time": "0 seconds", "Maintenance Time": "0 seconds", "Availability (%)": "0", "name": "Ground Floor ADServer", "On Hold time": "0 seconds", "Down time": "23 hours 0 minutes 0 seconds", "Dependent Down Time": "0 seconds", "Up time": "0 seconds", "moName": "xxx.xx.xxx.xxx.x0000000001", "moid": 20000049227 } ], "headerKeyVsTypeMap": { "Maintenance Time": 2, "Parent Down Time": 2, "Availability (%)": 2, "name": 12, "On Hold time": 2, "Down time": 2, "Dependent Down Time": 2, "Up time": 2, "moid": -5 } }

参数名称
描述
rowsToFetch
要获取的行数——范围从1到1000
fetchFromRowNumber
指定要获取数据的起始行数。
getOnlyColumnDetails
指定true或false。如果为true,则返回Report MetaData,如果为false,则将强制发送其余参数。
reportId
每个报表都是唯一的
apiKey
通过api密钥可以访问OpManager服务器。

获取报表列表

方法: GET

描述: 该API用于列出所有报表

示例 URL: https://localhost:8060/api/json/reports/getReportsList?apiKey=***************&isFavouriteNeeded=true&hideintegratedReports=true&hideHardwareReport=true

示例响应: [ { "displayName": "System", "list": [ { "list": [ { "customStatus": "False", "displayName": "Notification Profiles Triggered", "isCustom": "false", "id": 6, "url": "/reports/GenerateReports.do?firstTime=true&reportID=6", "Name": "Notification Profiles Triggered", "desc": "Get report of notification profiles triggered" }, { "customStatus": "False", "displayName": "Downtime Scheduler Log", "isCustom": "false", "id": 7, "url": "/reports/GenerateReports.do?firstTime=true&reportID=7", "Name": "Downtime Scheduler Log", "desc": "Get report of downtime scheduler log" }, { "customStatus": "False", "displayName": "Schedule Reports Log", "isCustom": "false", "id": 8, "url": "/reports/GenerateReports.do?firstTime=true&reportID=8", "Name": "Schedule Reports Log", "desc": "Get report of schedule reports log" }, { "customStatus": "False", "displayName": "All Down Events", "isCustom": "false", "id": 2, "url": "/reports/GenerateReports.do?firstTime=true&reportID=2", "Name": "All Down Events", "desc": "Get report for all down events" }, { "customStatus": "False", "displayName": "All Alerts", "isCustom": "false", "id": 84, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=84", "Name": "All Alerts", "desc": "Get report for all alerts" }, { "customStatus": "False", "displayName": "All Events", "isCustom": "false", "id": 1, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=1", "Name": "All Events", "desc": "Get report for all events" }, { "customStatus": "False", "displayName": "All Down Alerts", "isCustom": "false", "id": 85, "url": "/reports/GenerateReports.do?firstTime=true&reportID=85", "Name": "All Down Alerts", "desc": "Get report for all down alerts" }, { "customStatus": "False", "displayName": "SNMP Trap Log", "isCustom": "false", "id": 3, "url": "/reports/GenerateReports.do?firstTime=true&reportID=3", "Name": "SNMP Trap Log", "desc": "Get SNMP trap log report" }, { "customStatus": "False", "displayName": "Windows Event Log", "isCustom": "false", "id": 4, "url": "/reports/GenerateReports.do?firstTime=true&reportID=4", "Name": "Windows Event Log", "desc": "Get windows event log report" }, { "customStatus": "False", "displayName": "Performance Monitor Error Log", "isCustom": "false", "id": 5, "url": "/reports/GenerateReports.do?firstTime=true&reportID=5", "Name": "Performance Monitor Error Log", "desc": "Get performance monitor error log report" }, { "customStatus": "False", "displayName": "All Alerts with Notes", "isCustom": "false", "id": 721, "url": "/reports/GenerateReports.do?firstTime=true&reportID=721", "Name": "All Alerts with Notes", "desc": "Get report for all alerts with Notes" }, { "customStatus": "False", "displayName": "Top SysLog Count by Source", "isCustom": "false", "id": 95, "url": "/reports/GenerateReports.do?firstTime=true&reportID=95", "Name": "webclient.top.syslog.reports", "desc": "Top N devices with most number of SysLogs" }, { "customStatus": "False", "displayName": "Top EventLog Count by Source", "isCustom": "false", "id": 94, "url": "/reports/GenerateReports.do?firstTime=true&reportID=94", "Name": "webclient.top.eventlog.reports", "desc": "Top N devices with most number of EventLogs" }, { "customStatus": "False", "displayName": "Top Trap Count by Source", "isCustom": "false", "id": 93, "url": "/reports/GenerateReports.do?firstTime=true&reportID=93", "Name": "webclient.top.trap.reports", "desc": "Top N devices with most number of Traps" }, { "customStatus": "False", "displayName": "Suppressed Devices", "isCustom": "false", "id": 92, "url": "/reports/GenerateReports.do?firstTime=true&reportID=92", "Name": "webclient.suppress.devices.reports", "desc": "Get report for suppressed devices" }, { "customStatus": "False", "displayName": "DataCollection Error Logs", "isCustom": "false", "id": 151, "url": "/reports/GenerateReports.do?firstTime=true&reportID=151", "Name": "widget.name.dataCollectionLog", "desc": "Get datacollection failure details" }, { "customStatus": "False", "displayName": "Active Alerts", "isCustom": "false", "id": 149, "url": "/reports/GenerateReports.do?firstTime=true&reportID=149", "Name": "webclient.report.name.activealarms", "desc": "Get report for active alerts" }, { "customStatus": "False", "displayName": "Workflow Logs", "isCustom": "false", "id": 90, "url": "/reports/GenerateReports.do?firstTime=true&reportID=90", "Name": "Workflow Logs", "desc": "Workflow logs report" }, { "customStatus": "False", "displayName": "Syslog Events", "isCustom": "false", "id": 88, "url": "/reports/GenerateReports.do?firstTime=true&reportID=88", "Name": "Syslog Events", "desc": "Get Syslog events report " }, { "displayName": "DataCollection Error Logs for N Consecutive Time(s)", "id": "ServerHealthReport", "desc": "Get datacollection failure details for N consecutive times" }, { "displayName": "Audit Report", "id": "Audit", "url": "/reports/AuditReport.do", "desc": "Audit Report" } ], "title": "" } ], "Name": "System" }, { "displayName": "Health and Performance", "list": [ { "list": [ { "customStatus": "True", "displayName": "Servers by Rx Utilization", "isCustom": "true", "id": 28, "url": "/reports/GenerateReports.do?firstTime=true&reportID=28", "Name": "Servers by Rx Utilization", "desc": "Identify servers with heavy incoming traffic utilization" }, { "customStatus": "True", "displayName": "Servers by Tx Utilization", "isCustom": "true", "id": 29, "url": "/reports/GenerateReports.do?firstTime=true&reportID=29", "Name": "Servers by Tx Utilization", "desc": "Identify servers with heavy outgoing traffic utilization" }, { "customStatus": "True", "displayName": "Volumes with Least Free Space", "isCustom": "true", "id": 30, "url": "/reports/GenerateReports.do?firstTime=true&reportID=30", "Name": "Volumes with Least Free Space", "desc": "Identify disk partitions with least free space" }, { "customStatus": "True", "displayName": "Volumes with Most Free Space", "isCustom": "true", "id": 31, "url": "/reports/GenerateReports.do?firstTime=true&reportID=31", "Name": "Volumes with Most Free Space", "desc": "Identify disk partitions with most free space" }, { "customStatus": "True", "displayName": "All Servers Disk Usage Report", "isCustom": "true", "id": 32, "url": "/reports/GenerateReports.do?firstTime=true&reportID=32", "Name": "All Servers Disk Usage Report", "desc": "Get partition wise disk usage report for all servers" }, { "customStatus": "True", "displayName": "Routers Health Report", "isCustom": "true", "id": 33, "url": "/reports/GenerateReports.do?firstTime=true&reportID=33", "Name": "Routers Health Report", "desc": "Get health report of routers" }, { "customStatus": "True", "displayName": "Routers by CPU Utilization", "isCustom": "true", "id": 34, "url": "/reports/GenerateReports.do?firstTime=true&reportID=34", "Name": "Routers by CPU Utilization", "desc": "Identify busy routers with high CPU Utilization" }, { "customStatus": "True", "displayName": "Routers by Memory Utilization", "isCustom": "true", "id": 35, "url": "/reports/GenerateReports.do?firstTime=true&reportID=35", "Name": "Routers by Memory Utilization", "desc": "Identify overloaded routers with high Memory Utilization" }, { "customStatus": "True", "displayName": "Router Interfaces by Rx Traffic", "isCustom": "true", "id": 36, "url": "/reports/GenerateReports.do?firstTime=true&reportID=36", "Name": "Router Interfaces by Rx Traffic", "desc": "Identify interfaces with heavy incoming traffic" }, { "customStatus": "True", "displayName": "Router Interfaces by Tx Traffic", "isCustom": "true", "id": 37, "url": "/reports/GenerateReports.do?firstTime=true&reportID=37", "Name": "Router Interfaces by Tx Traffic", "desc": "Identify interfaces with heavy outgoing traffic" }, { "customStatus": "True", "displayName": "Router Interfaces by Rx Errors", "isCustom": "true", "id": 38, "url": "/reports/GenerateReports.do?firstTime=true&reportID=38", "Name": "Router Interfaces by Rx Errors", "desc": "Identify interfaces with high incoming errors" }, { "customStatus": "True", "displayName": "Router Interfaces by Tx Errors", "isCustom": "true", "id": 39, "url": "/reports/GenerateReports.do?firstTime=true&reportID=39", "Name": "Router Interfaces by Tx Errors", "desc": "Identify interfaces with high incoming errors" }, { "customStatus": "True", "displayName": "Router Interfaces by Rx Utilization", "isCustom": "true", "id": 40, "url": "/reports/GenerateReports.do?firstTime=true&reportID=40", "Name": "Router Interfaces by Rx Utilization", "desc": "Identify interfaces with high % Receive utilization" }, { "customStatus": "True", "displayName": "Router Interfaces by Tx Utilization", "isCustom": "true", "id": 41, "url": "/reports/GenerateReports.do?firstTime=true&reportID=41", "Name": "Router Interfaces by Tx Utilization", "desc": "Identify interfaces with high % Transmit utilization" }, { "customStatus": "True", "displayName": "Switches Health Report", "isCustom": "true", "id": 42, "url": "/reports/GenerateReports.do?firstTime=true&reportID=42", "Name": "Switches Health Report", "desc": "Get health report of switches" }, { "customStatus": "True", "displayName": "Ports by Rx Traffic", "isCustom": "true", "id": 43, "url": "/reports/GenerateReports.do?firstTime=true&reportID=43", "Name": "Ports by Rx Traffic", "desc": "Identify ports with heavy incoming traffic" }, { "customStatus": "True", "displayName": "Ports by Tx Traffic", "isCustom": "true", "id": 44, "url": "/reports/GenerateReports.do?firstTime=true&reportID=44", "Name": "Ports by Tx Traffic", "desc": "Identify ports with heavy outgoing traffic" }, { "customStatus": "True", "displayName": "Ports by Rx Errors", "isCustom": "true", "id": 45, "url": "/reports/GenerateReports.do?firstTime=true&reportID=45", "Name": "Ports by Rx Errors", "desc": "Identify ports with most Receive errors" }, { "customStatus": "True", "displayName": "Ports by Tx Errors", "isCustom": "true", "id": 46, "url": "/reports/GenerateReports.do?firstTime=true&reportID=46", "Name": "Ports by Tx Errors", "desc": "Identify ports with most Transmit errors" }, { "customStatus": "True", "displayName": "Ports by Tx Utilization", "isCustom": "true", "id": 48, "url": "/reports/GenerateReports.do?firstTime=true&reportID=48", "Name": "Ports by Tx Utilization", "desc": "Identify ports with high % Transmit utilization" }, { "customStatus": "True", "displayName": "DCs by CPU Utilization", "isCustom": "true", "id": 49, "url": "/reports/GenerateReports.do?firstTime=true&reportID=49", "Name": "DCs by CPU Utilization", "desc": "Identify busy DCs with high CPU Utilization" }, { "customStatus": "True", "displayName": "DCs by Memory Utilization", "isCustom": "true", "id": 50, "url": "/reports/GenerateReports.do?firstTime=true&reportID=50", "Name": "DCs by Memory Utilization", "desc": "Identify overloaded DCs with high Memory Utilization" }, { "customStatus": "True", "displayName": "DCs by Disk Utilization", "isCustom": "true", "id": 51, "url": "/reports/GenerateReports.do?firstTime=true&reportID=51", "Name": "DCs by Disk Utilization", "desc": "Identify overloaded DCs with high Disk Utilization" }, { "customStatus": "True", "displayName": "Ports by Rx Utilization", "isCustom": "true", "id": 47, "url": "/reports/GenerateReports.do?firstTime=true&reportID=47", "Name": "Ports by Rx Utilization", "desc": "Identify ports with high % Receive utilization" }, { "customStatus": "False", "displayName": "Health Report", "isCustom": "false", "id": 9, "url": "/reports/GenerateReports.do?firstTime=true&reportID=9", "Name": "Health Report", "desc": "Get health report of all devices" }, { "customStatus": "False", "displayName": "Devices by CPU Utilization", "isCustom": "false", "id": 10, "url": "/reports/GenerateReports.do?firstTime=true&reportID=10", "Name": "Devices by CPU Utilization", "desc": "Identify overloaded devices with high CPU Utilization" }, { "customStatus": "False", "displayName": "Devices by Memory Utilization", "isCustom": "false", "id": 11, "url": "/reports/GenerateReports.do?firstTime=true&reportID=11", "Name": "Devices by Memory Utilization", "desc": "Identify overloaded devices with high Memory Utilization" }, { "customStatus": "False", "displayName": "Devices by Disk Utilization", "isCustom": "false", "id": 12, "url": "/reports/GenerateReports.do?firstTime=true&reportID=12", "Name": "Devices by Disk Utilization", "desc": "Identify overloaded devices with high Disk Utilization" }, { "customStatus": "False", "displayName": "Disk Usage by Drives", "isCustom": "false", "id": 13, "url": "/reports/GenerateReports.do?firstTime=true&reportID=13", "Name": "Disk Usage by Drives", "desc": "Identify overloaded devices with high Disk Utilization by drives" }, { "customStatus": "False", "displayName": "All Interfaces by Utilization", "isCustom": "false", "id": 14, "url": "/reports/GenerateReports.do?firstTime=true&reportID=14", "Name": "All Interfaces by Utilization", "desc": "Identify devices with heavy traffic utilization" }, { "customStatus": "False", "displayName": "WAN Links by Utilization", "isCustom": "false", "id": 15, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=15", "Name": "WAN Links by Utilization", "desc": "Identify WAN links with heavy traffic utilization" }, { "customStatus": "False", "displayName": "Interfaces by Rx Traffic", "isCustom": "false", "id": 16, "url": "/reports/GenerateReports.do?firstTime=true&reportID=16", "Name": "Interfaces by Rx Traffic", "desc": "Identify devices with heavy incoming traffic" }, { "customStatus": "False", "displayName": "Interfaces by Tx Traffic", "isCustom": "false", "id": 17, "url": "/reports/GenerateReports.do?firstTime=true&reportID=17", "Name": "Interfaces by Tx Traffic", "desc": "Identify devices with heavy outgoing traffic" }, { "customStatus": "False", "displayName": "Interfaces by Rx Utilization", "isCustom": "false", "id": 18, "url": "/reports/GenerateReports.do?firstTime=true&reportID=18", "Name": "Interfaces by Rx Utilization", "desc": "Identify devices with heavy incoming traffic utilization" }, { "customStatus": "False", "displayName": "Interfaces by Tx Utilization", "isCustom": "false", "id": 19, "url": "/reports/GenerateReports.do?firstTime=true&reportID=19", "Name": "Interfaces by Tx Utilization", "desc": "Identify devices with heavy outgoing traffic utilization" }, { "customStatus": "False", "displayName": "Interfaces by Rx Errors", "isCustom": "false", "id": 20, "url": "/reports/GenerateReports.do?firstTime=true&reportID=20", "Name": "Interfaces by Rx Errors", "desc": "Identify interfaces with high incoming errors" }, { "customStatus": "False", "displayName": "Interfaces by Tx Errors", "isCustom": "false", "id": 21, "url": "/reports/GenerateReports.do?firstTime=true&reportID=21", "Name": "Interfaces by Tx Errors", "desc": "Identify interfaces with high outgoing errors" }, { "customStatus": "True", "displayName": "Servers Health Report", "isCustom": "true", "id": 22, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=22", "Name": "Servers Health Report", "desc": "Get health report of servers" }, { "customStatus": "True", "displayName": "Servers by CPU Utilization", "isCustom": "true", "id": 23, "url": "/reports/GenerateReports.do?firstTime=true&reportID=23", "Name": "Servers by CPU Utilization", "desc": "Identify busy servers with high CPU Utilization" }, { "customStatus": "True", "displayName": "Servers by Memory Utilization", "isCustom": "true", "id": 24, "url": "/reports/GenerateReports.do?firstTime=true&reportID=24", "Name": "Servers by Memory Utilization", "desc": "Identify overloaded servers with high Memory Utilization" }, { "customStatus": "True", "displayName": "Servers by Disk Utilization", "isCustom": "true", "id": 25, "url": "/reports/GenerateReports.do?firstTime=true&reportID=25", "Name": "Servers by Disk Utilization", "desc": "Identify overloaded servers with high Disk Utilization" }, { "customStatus": "True", "displayName": "Servers by Rx Traffic", "isCustom": "true", "id": 26, "url": "/reports/GenerateReports.do?firstTime=true&reportID=26", "Name": "Servers by Rx Traffic", "desc": "Identify servers with heavy incoming traffic" }, { "customStatus": "True", "displayName": "Servers by Tx Traffic", "isCustom": "true", "id": 27, "url": "/reports/GenerateReports.do?firstTime=true&reportID=27", "Name": "Servers by Tx Traffic", "desc": "Identify servers with heavy outgoing traffic" }, { "customStatus": "True", "displayName": "All Interfaces By Traffic", "isCustom": "true", "id": 81, "url": "/reports/GenerateReports.do?firstTime=true&reportID=81", "Name": "All Interfaces By Traffic", "desc": "Get traffic report of all interfaces" }, { "customStatus": "True", "displayName": "Volumes With Low Disk Utilization", "isCustom": "true", "id": 82, "url": "/reports/GenerateReports.do?firstTime=true&reportID=82", "Name": "Volumes With Low Disk Utilization", "desc": "Identify volumes with low disk utilization" }, { "customStatus": "True", "displayName": "Volumes With High Disk Utilization", "isCustom": "true", "id": 83, "url": "/reports/GenerateReports.do?firstTime=true&reportID=83", "Name": "Volumes With High Disk Utilization", "desc": "Identify volumes with high disk utilization" }, { "customStatus": "False", "displayName": "Top N Errors And Discards", "isCustom": "false", "id": 86, "url": "/reports/GenerateReports.do?firstTime=true&reportID=86", "Name": "Top N Errors And Discards", "desc": "Identify interfaces with high errors and discards" }, { "customStatus": "False", "displayName": "Interfaces By TotalBytes Transfered", "isCustom": "false", "id": 89, "url": "/reports/GenerateReports.do?firstTime=true&reportID=89", "Name": "Interfaces By TotalBytes Transfered", "desc": "Identify interfaces with high total bytes transfered" }, { "customStatus": "False", "displayName": "Hardware Health Report", "isCustom": "false", "id": 142, "url": "/reports/GenerateReports.do?firstTime=true&reportID=142", "Name": "webclient.reports.hardware.title", "desc": "Get Hardware Health Report" }, { "customStatus": "True", "displayName": "Processes by CPU Utilization", "isCustom": "true", "id": 144, "url": "/reports/GenerateReports.do?firstTime=true&reportID=144", "Name": "Processes by CPU Utilization", "desc": "Identify processes with high CPU Utilization" }, { "customStatus": "True", "displayName": "Processes by Memory Utilization", "isCustom": "true", "id": 145, "url": "/reports/GenerateReports.do?firstTime=true&reportID=145", "Name": "Processes by Memory Utilization", "desc": "Identify processes with high Memory Utilization" }, { "customStatus": "True", "displayName": "Processes by Absolute Memory", "isCustom": "true", "id": 148, "url": "/reports/GenerateReports.do?firstTime=true&reportID=148", "Name": "Processes by Absolute Memory", "desc": "Identify absolute memory value of the Process" }, { "customStatus": "False", "displayName": "Flap Count Summary", "isCustom": "false", "id": 768, "url": "/reports/GenerateReports.do?firstTime=true&reportID=768", "Name": "webclient.bgp.title.flapCount", "desc": "Get Flap Count Summary for BGP Peers" }, { "customStatus": "False", "displayName": "Flap Summary", "isCustom": "false", "id": 769, "url": "/reports/GenerateReports.do?firstTime=true&reportID=769", "Name": "webclient.bgp.title.flapSummary", "desc": "Flap Summary for each BGP Peers" }, { "customStatus": "False", "displayName": "Devices with Performance Monitors", "isCustom": "false", "id": 772, "url": "/reports/GenerateReports.do?firstTime=true&reportID=772", "Name": "webclient.perf.monitors.report", "desc": "Get report for devices with Perforamance monitors" }, { "customStatus": "False", "displayName": "Devices with File Monitors", "isCustom": "false", "id": 773, "url": "/reports/GenerateReports.do?firstTime=true&reportID=773", "Name": "webclient.file.monitors.report", "desc": "Get report for devices with File monitors" }, { "customStatus": "False", "displayName": "Devices with Folder Monitors", "isCustom": "false", "id": 774, "url": "/reports/GenerateReports.do?firstTime=true&reportID=774", "Name": "webclient.folder.monitors.report", "desc": "Get report for devices with Folder monitors" }, { "customStatus": "False", "displayName": "Devices with Process Monitors", "isCustom": "false", "id": 775, "url": "/reports/GenerateReports.do?firstTime=true&reportID=775", "Name": "webclient.process.monitors.report", "desc": "Get report for devices with Process monitors" }, { "customStatus": "False", "displayName": "Devices with AD Monitors", "isCustom": "false", "id": 776, "url": "/reports/GenerateReports.do?firstTime=true&reportID=776", "Name": "webclient.AD.monitors.report", "desc": "Get report for devices with AD monitors" }, { "customStatus": "False", "displayName": "Devices with Exchange Monitors", "isCustom": "false", "id": 777, "url": "/reports/GenerateReports.do?firstTime=true&reportID=777", "Name": "webclient.exchange.monitors.report", "desc": "Get report for devices with Exchange monitors" }, { "customStatus": "False", "displayName": "Devices with MSSQL Monitors", "isCustom": "false", "id": 778, "url": "/reports/GenerateReports.do?firstTime=true&reportID=778", "Name": "webclient.mssql.monitors.report", "desc": "Get report for devices with MSSQL monitors" }, { "customStatus": "False", "displayName": "Devices with AD Service Monitors", "isCustom": "false", "id": 779, "url": "/reports/GenerateReports.do?firstTime=true&reportID=779", "Name": "webclient.ADService.monitors.report", "desc": "Get report for devices with AD Service monitors" }, { "customStatus": "False", "displayName": "Devices with MSSQL Service Monitors", "isCustom": "false", "id": 780, "url": "/reports/GenerateReports.do?firstTime=true&reportID=780", "Name": "webclient.mssqlservice.monitors.report", "desc": "Get report for devices with MSSQL Service monitors" }, { "customStatus": "False", "displayName": "Devices with Exchange Service Monitors", "isCustom": "false", "id": 781, "url": "/reports/GenerateReports.do?firstTime=true&reportID=781", "Name": "webclient.exchangeservice.monitors.report", "desc": "Get report for devices with Exchange Service monitors" }, { "customStatus": "False", "displayName": "Devices with NT Service Monitors", "isCustom": "false", "id": 782, "url": "/reports/GenerateReports.do?firstTime=true&reportID=782", "Name": "webclient.ntservice.monitors.report", "desc": "Get report for devices with NT Service monitors" }, { "customStatus": "False", "displayName": "Devices with URL Monitors", "isCustom": "false", "id": 783, "url": "/reports/GenerateReports.do?firstTime=true&reportID=783", "Name": "webclient.url.monitors.report", "desc": "Get report for devices with URL monitors" }, { "customStatus": "False", "displayName": "Devices with Service Monitors", "isCustom": "false", "id": 784, "url": "/reports/GenerateReports.do?firstTime=true&reportID=784", "Name": "webclient.service.monitors.report", "desc": "Get report for devices with Service monitors" }, { "customStatus": "False", "displayName": "VPN Summary", "isCustom": "false", "id": 895, "url": "/reports/GenerateReports.do?firstTime=true&reportID=895", "Name": "webclient.opm.reports.vpnSummary", "desc": "Get summary report for Site-to-Site VPN devices." } ], "title": "" } ], "Name": "Health and Performance" }, { "displayName": "Availability and Response", "list": [ { "list": [ { "customStatus": "True", "displayName": "SMTP Servers by Response Time", "isCustom": "true", "id": 65, "url": "/reports/GenerateReports.do?firstTime=true&reportID=65", "Name": "SMTP Servers by Response Time", "desc": "Identify SMTP servers with high Response Time" }, { "customStatus": "True", "displayName": "Process Monitors Availability", "isCustom": "true", "id": 146, "url": "/reports/GenerateReports.do?firstTime=true&reportID=146", "Name": "Process Monitors Availability", "desc": "Get availability report for all process monitors" }, { "customStatus": "True", "displayName": "Windows Service Monitors Availability", "isCustom": "true", "id": 147, "url": "/reports/GenerateReports.do?firstTime=true&reportID=147", "Name": "Windows Service Monitors Availability", "desc": "Get availability report for all windows service monitors" }, { "customStatus": "True", "displayName": "HTTP Servers by Response Time", "isCustom": "true", "id": 64, "url": "/reports/GenerateReports.do?firstTime=true&reportID=64", "Name": "HTTP Servers by Response Time", "desc": "Identify Web servers with high Response Time" }, { "customStatus": "False", "displayName": "Devices by Packet Loss", "isCustom": "false", "id": 58, "url": "/reports/GenerateReports.do?firstTime=true&reportID=58", "Name": "Devices by Packet Loss", "desc": "Identify devices with high packet loss" }, { "customStatus": "False", "displayName": "Devices by Response Time", "isCustom": "false", "id": 57, "url": "/reports/GenerateReports.do?firstTime=true&reportID=57", "Name": "Devices by Response Time", "desc": "Identify devices with high response time" }, { "customStatus": "True", "displayName": "Web Servers Availability", "isCustom": "true", "id": 63, "url": "/reports/GenerateReports.do?firstTime=true&reportID=63", "Name": "Web Servers Availability", "desc": "Get availability report for all web servers" }, { "customStatus": "False", "displayName": "WAN Links Availability", "isCustom": "false", "id": 54, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=54", "Name": "WAN Links Availability", "desc": "Get availability report for all interfaces" }, { "customStatus": "False", "displayName": "All Interfaces Availability", "isCustom": "false", "id": 87, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=87", "Name": "All Interfaces Availability", "desc": "Get availability report for all interfaces" }, { "customStatus": "False", "displayName": "URLs Availability", "isCustom": "false", "id": 55, "url": "/reports/GenerateReports.do?firstTime=true&reportID=55", "Name": "URLs Availability", "desc": "Get availability report for all URLs" }, { "customStatus": "False", "displayName": "Service Monitors Availability", "isCustom": "false", "id": 56, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=56", "Name": "Service Monitors Availability", "desc": "Get availability report for all service monitors" }, { "customStatus": "True", "displayName": "DCs Availability Report", "isCustom": "true", "id": 62, "url": "/reports/GenerateReports.do?firstTime=true&reportID=62", "Name": "DCs Availability Report", "desc": "Get availability report for all DCs" }, { "customStatus": "True", "displayName": "Servers Availability Report", "isCustom": "true", "id": 61, "url": "/reports/GenerateReports.do?firstTime=true&reportID=61", "Name": "Servers Availability Report", "desc": "Get availability report for all services" }, { "customStatus": "False", "displayName": "Devices Availability", "isCustom": "false", "id": 52, "url": "/reports/GenerateReports.do?firstTime=true&reportID=52", "Name": "Devices Availability", "desc": "Get availability report for all devices" }, { "customStatus": "False", "displayName": "Devices Availability Dashboard", "isCustom": "false", "id": 53, "url": "/reports/GenerateReports.do?firstTime=true&reportID=53", "Name": "Devices Availability Dashboard", "desc": "Get availability report for all devices" }, { "customStatus": "False", "displayName": "DownTime Report For Interfaces", "isCustom": "false", "id": 724, "url": "/reports/GenerateReports.do?firstTime=true&reportID=724", "Name": "DownTime Report For Interfaces", "desc": "DownTime history for all interfaces" }, { "customStatus": "False", "displayName": "Services by Response Time", "isCustom": "false", "id": 60, "url": "/reports/GenerateReports.do?firstTime=true&reportID=60", "Name": "Services by Response Time", "desc": "Identify services with high response time" }, { "customStatus": "False", "displayName": "URLs by Response Time", "isCustom": "false", "id": 59, "url": "/reports/GenerateReports.do?firstTime=true&reportID=59", "Name": "URLs by Response Time", "desc": "Identify URLs with high response time" }, { "customStatus": "True", "displayName": "Telnet Servers by Response Time", "isCustom": "true", "id": 68, "url": "/reports/GenerateReports.do?firstTime=true&reportID=68", "Name": "Telnet Servers by Response Time", "desc": "Identify Telnet servers with high Response Time" }, { "customStatus": "False", "displayName": "DownTime Report", "isCustom": "false", "id": 91, "url": "/reports/GenerateReports.do?firstTime=true&reportID=91", "Name": "DownTime Report", "desc": "DownTime history for all devices" }, { "customStatus": "True", "displayName": "FTP Servers by Response Time", "isCustom": "true", "id": 67, "url": "/reports/GenerateReports.do?firstTime=true&reportID=67", "Name": "FTP Servers by Response Time", "desc": "Identify FTP servers with high Response Time" }, { "customStatus": "True", "displayName": "MySQL Servers by Response Time", "isCustom": "true", "id": 66, "url": "/reports/GenerateReports.do?firstTime=true&reportID=66", "Name": "MySQL Servers by Response Time", "desc": "Identify MySQL servers with high Response Time" } ], "title": "" } ], "Name": "Availability and Response" }, { "displayName": "Inventory", "list": [ { "list": [ { "customStatus": "True", "displayName": "Devices Down", "isCustom": "true", "id": 722, "url": "/reports/GenerateReports.do?firstTime=true&reportID=722", "Name": "widget.name.devicesdown", "desc": "Get report for all devices down" }, { "customStatus": "False", "displayName": "Notification Profiles Applied by Type", "isCustom": "false", "id": 72, "url": "/reports/GenerateReports.do?firstTime=true&reportID=72", "Name": "Notification Profiles Applied by Type", "desc": "Get report of all notification profiles applied by profile type" }, { "customStatus": "False", "displayName": "Notification Profiles Applied", "isCustom": "false", "id": 71, "url": "/reports/GenerateReports.do?firstTime=true&reportID=71", "Name": "Notification Profiles Applied", "desc": "Get report of all notification profiles applied" }, { "customStatus": "False", "displayName": "Devices by Category", "isCustom": "false", "id": 70, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=70", "Name": "Devices by Category", "desc": "Get inventory report of devices by device category" }, { "customStatus": "False", "displayName": "Devices by Device Type", "isCustom": "false", "id": 69, "url": "/reports/GenerateReports.do?firstTime=true&reportID=69", "Name": "Devices by Device Type", "desc": "Get inventory report of devices by device type" }, { "customStatus": "False", "displayName": "Hardware Information", "isCustom": "false", "id": 155, "url": "/reports/GenerateReports.do?firstTime=true&reportID=155", "Name": "webclient.reports.hardwareinfo.title", "desc": "Get report of Hardware Information" }, { "customStatus": "True", "displayName": "Non SNMP Devices", "isCustom": "true", "id": 80, "url": "/reports/GenerateReports.do?firstTime=true&reportID=80", "Name": "Non SNMP Devices", "desc": "Get inventory report of all SNMP not enabled devices" }, { "customStatus": "True", "displayName": "SNMP Enabled Devices", "isCustom": "true", "id": 79, "url": "/reports/GenerateReports.do?firstTime=true&reportID=79", "Name": "SNMP Enabled Devices", "desc": "Get inventory report of all SNMP enabled devices" }, { "customStatus": "True", "displayName": "Desktop", "isCustom": "true", "id": 78, "url": "/reports/GenerateReports.do?firstTime=true&reportID=78", "Name": "Desktops", "desc": "Get inventory report of desktops" }, { "customStatus": "True", "displayName": "Server", "isCustom": "true", "id": 77, "url": "/reports/GenerateReports.do?firstTime=true&reportID=77", "Name": "Servers", "desc": "Get inventory report of servers" }, { "customStatus": "False", "displayName": "Threshold Details of Devices", "isCustom": "false", "id": 150, "url": "/reports/GenerateReports.do?firstTime=true&reportID=150", "Name": "webclient.report.name.thresholdreports", "desc": "Get report of all thresholds configured" }, { "customStatus": "True", "displayName": "All Devices", "isCustom": "true", "id": 76, "url": "/reports/GenerateReports.do?firstTime=true&reportID=76", "Name": "All Devices", "desc": "Get inventory report of all devices" }, { "customStatus": "False", "displayName": "Interfaces by Type", "isCustom": "false", "id": 75, "url": "/reports/GenerateReports.do?firstTime=true&reportID=75", "Name": "Interfaces by Type", "desc": "Get report of all interfaces by type" }, { "customStatus": "False", "displayName": "Interface Speed Report", "isCustom": "false", "id": 74, "url": "/reports/GenerateReports.do?firstTime=true&reportID=74", "Name": "Interface Speed Report", "desc": "Get report of interface bandwidth" }, { "customStatus": "False", "displayName": "Notification Profiles Applied by Device", "isCustom": "false", "id": 73, "url": "/reports/GenerateReports.do?firstTime=true&reportID=73", "Name": "Notification Profiles Applied by Device", "desc": "Get report of all notification profiles applied by device" }, { "customStatus": "False", "displayName": "Devices by Added Time", "isCustom": "false", "id": 725, "url": "/reports/GenerateReports.do?firstTime=true&reportID=725", "Name": "Devices by Added Time", "desc": "Get Devices with its Added Time" }, { "customStatus": "False", "displayName": "Uplink Dependency Devices", "isCustom": "false", "id": 727, "url": "/reports/GenerateReports.do?firstTime=true&reportID=727", "Name": "Up Link Dependency Devices", "desc": "Get inventory report of all dependent devices" }, { "customStatus": "False", "displayName": "Credentials Associated Devices", "isCustom": "false", "id": 761, "url": "/reports/GenerateReports.do?firstTime=true&reportID=761", "Name": "webclient.credential.devices.report", "desc": "Get report of credentials associated to devices" }, { "customStatus": "False", "displayName": "Agent-monitored devices", "isCustom": "false", "id": 862, "url": "/reports/GenerateReports.do?firstTime=true&reportID=862", "Name": "Agent Devices", "desc": "Get an Inventory report of all agent-monitored devices" }, { "customStatus": "False", "displayName": "IPMI Information", "isCustom": "false", "id": 723, "url": "/reports/GenerateReports.do?firstTime=true&reportID=723", "Name": "webclient.reports.ipmi.info.title", "desc": "Get a report of your IPMI devices and related hardware" } ], "title": "" } ], "Name": "Inventory" }, { "displayName": "WAN RTT Monitors", "list": [ { "list": [ { "customStatus": "False", "displayName": "Top N Paths with Maximum RTT", "isCustom": "false", "id": 101, "url": "/reports/GenerateReports.do?firstTime=true&reportID=101", "Name": "Top N Paths with Maximum RTT", "desc": "Top paths with maximum Round Trip Time" }, { "customStatus": "False", "displayName": "Round Trip Time History Report", "isCustom": "false", "id": 97, "url": "/reports/GenerateReports.do?firstTime=true&reportID=97", "Name": "Round Trip Time Trend Report", "desc": "Show RTT of icmp packets between source and destination host" }, { "customStatus": "False", "displayName": "Availability History", "isCustom": "false", "id": 98, "url": "/reports/GenerateReports.do?firstTime=true&reportID=98", "Name": "Link Availability and Error Statistics", "desc": "Show availability of destination also show type of errors in case of failed operation" }, { "customStatus": "False", "displayName": "RTT Threshold Violation Report", "isCustom": "false", "id": 96, "url": "/reports/GenerateReports.do?firstTime=true&reportID=96", "Name": "RTT Threshold Violation Report", "desc": "Shows threshold violation of icmp packets between source and destination host" }, { "customStatus": "False", "displayName": "Top N Least Available Paths", "isCustom": "false", "id": 99, "url": "/reports/GenerateReports.do?firstTime=true&reportID=99", "Name": "Top N Least Available Paths", "desc": "Top paths with least availability" }, { "customStatus": "False", "displayName": "Top N Paths with Maximum Threshold Violation", "isCustom": "false", "id": 100, "url": "/reports/GenerateReports.do?firstTime=true&reportID=100", "Name": "Top N Paths with Maximum Threshold Violation", "desc": "Top paths with maximum threshold violation" } ], "title": "" } ], "Name": "WAN RTT Monitors" }, { "displayName": "VoIP Monitors", "list": [ { "list": [ { "customStatus": "False", "displayName": "Round Trip Time History Report", "isCustom": "false", "id": 107, "url": "/reports/GenerateReports.do?firstTime=true&reportID=107", "Name": "Round Trip Time History Report", "desc": "Shows RTT (Round Trip Time) of VoIP packets in both directions" }, { "customStatus": "False", "displayName": "Top N Call Paths by Jitter", "isCustom": "false", "id": 110, "url": "/reports/GenerateReports.do?firstTime=true&reportID=110", "Name": "Top N Call Paths by Jitter", "desc": "Top call paths with maximum Jitter" }, { "customStatus": "False", "displayName": "Top N Call Paths by Packet Loss", "isCustom": "false", "id": 109, "url": "/reports/GenerateReports.do?firstTime=true&reportID=109", "Name": "Top N Call Paths by Packet Loss", "desc": "Top call paths with maximum Packet Loss" }, { "customStatus": "False", "displayName": "Top N Call Paths by MOS", "isCustom": "false", "id": 108, "url": "/reports/GenerateReports.do?firstTime=true&reportID=108", "Name": "Top N Call Paths by MOS", "desc": "Top call paths with minimum MOS" }, { "customStatus": "False", "displayName": "Top N Call Paths by Latency", "isCustom": "false", "id": 111, "url": "/reports/GenerateReports.do?firstTime=true&reportID=111", "Name": "Top N Call Paths by Latency", "desc": "Top call paths with maximum Latency" }, { "customStatus": "False", "displayName": "Latency History Report", "isCustom": "false", "id": 102, "url": "/reports/GenerateReports.do?firstTime=true&reportID=102", "Name": "Latency History Report", "desc": "Shows latency of VoIP packets in both directions" }, { "customStatus": "False", "displayName": "Jitter History Report", "isCustom": "false", "id": 103, "url": "/reports/GenerateReports.do?firstTime=true&reportID=103", "Name": "Jitter History Report", "desc": "Shows jitter (inter packet delay) of VoIP packets in bonfa.overview.Qos=QoS" }, { "customStatus": "False", "displayName": "Packet Loss History Report", "isCustom": "false", "id": 104, "url": "/reports/GenerateReports.do?firstTime=true&reportID=104", "Name": "Packet Loss History Report", "desc": "Shows packetloss of VoIP packets in both directions" }, { "customStatus": "False", "displayName": "VoIP Errors History Report", "isCustom": "false", "id": 105, "url": "/reports/GenerateReports.do?firstTime=true&reportID=105", "Name": "VoIP Errors History Report", "desc": "Shows various errors (timeout, tail drop,MIA etc.,) generated in the VoIP traffic" }, { "customStatus": "False", "displayName": "MOS History Report", "isCustom": "false", "id": 106, "url": "/reports/GenerateReports.do?firstTime=true&reportID=106", "Name": "MOS History Report", "desc": "Report shows MOS (Mean Opinion Score) of VoIP traffic. MOS is the key quality indicator of VoIP traffic" } ], "title": "" } ], "Name": "VoIP Monitors" }, { "displayName": "Virtual Servers Report", "list": [ { "list": [ { "customStatus": "False", "displayName": "HyperV-Host vs Disk Mapping", "isCustom": "false", "id": 154, "url": "/reports/GenerateReports.do?firstTime=true&reportID=154", "Name": "webclient.virtual.hyperv.hostdisk.report", "desc": "Get report for all Monitored HyperV-Host Vs Disk Mappings" }, { "customStatus": "False", "displayName": "Datastore vs VMware-Host Mapping", "isCustom": "false", "id": 153, "url": "/reports/GenerateReports.do?firstTime=true&reportID=153", "Name": "webclient.virtual.vmware.datastorehost.report", "desc": "Get report for all Datastore Vs Monitored VMware-Host Mappings" }, { "customStatus": "False", "displayName": "Datastore vs VMware-VM Mapping", "isCustom": "false", "id": 152, "url": "/reports/GenerateReports.do?firstTime=true&reportID=152", "Name": "webclient.virtual.vmware.datastorevm.report", "desc": "Get report for all Datastore Vs Monitored VMware-VM Mappings" }, { "customStatus": "False", "displayName": "VMware Idle VMs", "isCustom": "false", "id": 156, "url": "/reports/GenerateReports.do?firstTime=true&reportID=156", "Name": "widget.name.vmware.idleVms", "desc": "List of Idle VMs" }, { "customStatus": "False", "displayName": "Top VMware VMs by CPU Under Allocated", "isCustom": "false", "id": 157, "url": "/reports/GenerateReports.do?firstTime=true&reportID=157", "Name": "widget.name.vmware.vmUnderAllocatedCPU", "desc": "vms with under allocated CPU" }, { "customStatus": "False", "displayName": "Top VMware VMs by CPU Over Allocated", "isCustom": "false", "id": 158, "url": "/reports/GenerateReports.do?firstTime=true&reportID=158", "Name": "widget.name.vmware.vmOverAllocatedCPU", "desc": "VMs with CPU over allocated" }, { "customStatus": "False", "displayName": "Top VMware VMs by Memory Under Allocated", "isCustom": "false", "id": 159, "url": "/reports/GenerateReports.do?firstTime=true&reportID=159", "Name": "widget.name.vmware.vmUnderAllocatedMemory", "desc": "VMs with memory under allocated" }, { "customStatus": "False", "displayName": "Top VMware VMs by Memory Over Allocated", "isCustom": "false", "id": 160, "url": "/reports/GenerateReports.do?firstTime=true&reportID=160", "Name": "widget.name.vmware.vmOverAllocatedMemory", "desc": "VMs with memory over allocated" }, { "customStatus": "False", "displayName": "All Virtual Machines", "isCustom": "false", "id": 726, "url": "/reports/GenerateReports.do?firstTime=true&reportID=726", "Name": "widget.name.vmware.vmsList", "desc": "List of virtual machines based on virtual type" } ], "title": "" } ], "Name": "Virtual Servers Report" }, { "displayName": "Storage Reports", "list": [ { "list": [ { "customStatus": "False", "displayName": "Growth Trend", "isCustom": "false", "id": 174, "url": "/reports/GenerateReports.do?firstTime=true&reportID=174", "Name": "webclient.reports.growthtrend.title", "desc": "Growth Trend" }, { "customStatus": "False", "displayName": "Storage Summary", "isCustom": "false", "id": 161, "url": "/reports/GenerateReports.do?firstTime=true&reportID=161", "Name": "webclient.reports.storagesummary.title", "desc": "Storage Summary" }, { "customStatus": "False", "displayName": "RAID Capacity Utilization", "isCustom": "false", "id": 162, "url": "/reports/GenerateReports.do?firstTime=true&reportID=162", "Name": "webclient.reports.topncapacity", "desc": "RAID Capacity Utilization" }, { "customStatus": "False", "displayName": "RAID IOPS ", "isCustom": "false", "id": 163, "url": "/reports/GenerateReports.do?firstTime=true&reportID=163", "Name": "webclient.reports.topnraidiops", "desc": "RAID IOPS " }, { "customStatus": "False", "displayName": "RAID Reads/Sec", "isCustom": "false", "id": 164, "url": "/reports/GenerateReports.do?firstTime=true&reportID=164", "Name": "webclient.reports.topnraidreads", "desc": "RAID Reads/Sec" }, { "customStatus": "False", "displayName": "RAID Writes/Sec", "isCustom": "false", "id": 165, "url": "/reports/GenerateReports.do?firstTime=true&reportID=165", "Name": "webclient.reports.topnraidwrites", "desc": "RAID Writes/Sec" }, { "customStatus": "False", "displayName": "RAID Latency", "isCustom": "false", "id": 166, "url": "/reports/GenerateReports.do?firstTime=true&reportID=166", "Name": "webclient.reports.topnraidlatency", "desc": "RAID Latency" }, { "customStatus": "False", "displayName": "RAID Controller IOPS", "isCustom": "false", "id": 167, "url": "/reports/GenerateReports.do?firstTime=true&reportID=167", "Name": "webclient.reports.topnraidcontrolleriops", "desc": "RAID Controller IOPS" }, { "customStatus": "False", "displayName": "RAID Controller Reads/Sec", "isCustom": "false", "id": 168, "url": "/reports/GenerateReports.do?firstTime=true&reportID=168", "Name": "webclient.reports.topnraidcontrollerreads", "desc": "RAID Controller Reads/Sec" }, { "customStatus": "False", "displayName": "RAID Controller Writes/Sec", "isCustom": "false", "id": 169, "url": "/reports/GenerateReports.do?firstTime=true&reportID=169", "Name": "webclient.reports.topnraidcontrollerwrites", "desc": "RAID Controller Writes/Sec" }, { "customStatus": "False", "displayName": "Disk IOPS", "isCustom": "false", "id": 170, "url": "/reports/GenerateReports.do?firstTime=true&reportID=170", "Name": "webclient.reports.topndiskiops", "desc": "Disk IOPS" }, { "customStatus": "False", "displayName": "Disk Reads/Sec", "isCustom": "false", "id": 171, "url": "/reports/GenerateReports.do?firstTime=true&reportID=171", "Name": "webclient.reports.topndiskreads", "desc": "Disk Reads/Sec" }, { "customStatus": "False", "displayName": "Disk Writes/Sec", "isCustom": "false", "id": 172, "url": "/reports/GenerateReports.do?firstTime=true&reportID=172", "Name": "webclient.reports.topndiskwrites", "desc": "Disk Writes/Sec" }, { "customStatus": "False", "displayName": "RAID Forecast By Utilization", "isCustom": "false", "id": 173, "url": "/reports/GenerateReports.do?firstTime=true&reportID=173", "Name": "webclient.reports.forecast.title", "desc": "RAID Forecast By Utilization" } ], "title": "" } ], "Name": "Storage Reports" }, { "displayName": "Forecast Reports", "list": [ { "list": [ { "customStatus": "False", "displayName": "Memory Forecast", "isCustom": "false", "id": 177, "url": "/reports/GenerateReports.do?firstTime=true&reportID=177", "Name": "Memory Forecast", "desc": "Forecasts the Memory Utilization" }, { "customStatus": "False", "displayName": "Disk Forecast By Usage", "isCustom": "false", "id": 175, "url": "/reports/GenerateReports.do?firstTime=true&reportID=175", "Name": "Disk Forecast By Usage", "desc": "Disk Forecast By Usage" }, { "customStatus": "False", "displayName": "CPU Forecast", "isCustom": "false", "id": 178, "url": "/reports/GenerateReports.do?firstTime=true&reportID=178", "Name": "CPU Forecast", "desc": "Forecasts the CPU utilization" } ], "title": "" } ], "Name": "Forecast Reports" }, { "displayName": "Nutanix Reports", "list": [ { "list": [ { "customStatus": "False", "displayName": "Top N Hosts by IOPS", "isCustom": "false", "id": 740, "url": "/reports/GenerateReports.do?firstTime=true&reportID=740", "Name": "webclient.nutanix.hostsUnderIOPS.report", "desc": "Get report for Top Hosts with IOPS rate" }, { "customStatus": "False", "displayName": "Disk Inventory", "isCustom": "false", "id": 739, "url": "/reports/GenerateReports.do?firstTime=true&reportID=739", "Name": "webclient.nutanix.disk.report", "desc": "Get report for all Disk Inventory Details" }, { "customStatus": "False", "displayName": "Storage Containers", "isCustom": "false", "id": 738, "url": "/reports/GenerateReports.do?firstTime=true&reportID=738", "Name": "webclient.nutanix.storagecontainers", "desc": "Get report for all Storage Container Details" }, { "customStatus": "False", "displayName": "Cluster Latency", "isCustom": "false", "id": 736, "url": "/reports/GenerateReports.do?firstTime=true&reportID=736", "Name": "webclient.nutanix.cluster.latency.report", "desc": "Get report for all Cluster Latency Data" }, { "customStatus": "False", "displayName": "Cluster IOPS", "isCustom": "false", "id": 735, "url": "/reports/GenerateReports.do?firstTime=true&reportID=735", "Name": "webclient.nutanix.cluster.iops.report", "desc": "Get report for all Cluster IOPS Data" }, { "customStatus": "False", "displayName": "Cluster Inventory", "isCustom": "false", "id": 734, "url": "/reports/GenerateReports.do?firstTime=true&reportID=734", "Name": "webclient.nutanix.cluster.report", "desc": "Get report for all Cluster details" }, { "customStatus": "False", "displayName": "VM Summary by Host", "isCustom": "false", "id": 733, "url": "/reports/GenerateReports.do?firstTime=true&reportID=733", "Name": "webclient.nutanix.hostToVmMap.report", "desc": "Get report for VMs Details based on its Host" }, { "customStatus": "False", "displayName": "VM Summary by Cluster", "isCustom": "false", "id": 732, "url": "/reports/GenerateReports.do?firstTime=true&reportID=732", "Name": "webclient.nutanix.clusterToVMMap.report", "desc": "Get report for VM Details based on its Cluster" }, { "customStatus": "False", "displayName": "Host Summary", "isCustom": "false", "id": 737, "url": "/reports/GenerateReports.do?firstTime=true&reportID=737", "Name": "webclient.nutanix.clusterToHostMap.report", "desc": "Get report for all Host Details based on its Cluster" }, { "customStatus": "False", "displayName": "Top N Hosts by IO Bandwidth", "isCustom": "false", "id": 743, "url": "/reports/GenerateReports.do?firstTime=true&reportID=743", "Name": "webclient.nutanix.hostUnderBandwidth.report", "desc": "Get report for Top Disks with IO Bandwidth rate" }, { "customStatus": "False", "displayName": "Top N Hosts by Latency", "isCustom": "false", "id": 742, "url": "/reports/GenerateReports.do?firstTime=true&reportID=742", "Name": "webclient.nutanix.hostUnderLatency.report", "desc": "Get report for Top Hosts with Latency" }, { "customStatus": "False", "displayName": "Top N Disks by free space", "isCustom": "false", "id": 741, "url": "/reports/GenerateReports.do?firstTime=true&reportID=741", "Name": "webclient.nutanix.diskUnderFreespace.report", "desc": "Get report for Top Disks with Free space" } ], "title": "" } ], "Name": "Nutanix Reports" }, { "displayName": "WLC Reports", "list": [ { "list": [ { "customStatus": "False", "displayName": "AP Availability", "isCustom": "false", "id": 837, "url": "/reports/GenerateReports.do?firstTime=true&reportID=837", "Name": "webclient.availability.accessPoints.report", "desc": "Get availability report for Access points" }, { "customStatus": "False", "displayName": "Rogue SSID Details", "isCustom": "false", "id": 839, "url": "/reports/GenerateReports.do?firstTime=true&reportID=839", "Name": "webclient.inventory.RougeAP.report", "desc": "Get inventory report of Rogue SSIDs" }, { "customStatus": "False", "displayName": "AP Details", "isCustom": "false", "id": 838, "url": "/reports/GenerateReports.do?firstTime=true&reportID=838", "Name": "webclient.inventory.accessPoints.report", "desc": "Get inventory report of Access points" } ], "title": "" } ], "Name": "WLC Reports" }, { "displayName": "Meraki Reports", "list": [ { "list": [ { "customStatus": "False", "displayName": "Meraki MS Details", "isCustom": "false", "id": 855, "url": "/reports/GenerateReports.do?firstTime=true&reportID=855", "Name": "webclient.opm.reports.meraki.msdetails", "desc": "Get summary reports of Meraki Switch devices." }, { "customStatus": "False", "displayName": "Meraki AP Details", "isCustom": "false", "id": 860, "url": "/reports/GenerateReports.do?firstTime=true&reportID=860", "Name": "webclient.opm.reports.meraki.apDetails", "desc": "Get inventory reports of Meraki Access Points." }, { "customStatus": "False", "displayName": "Meraki Rogue SSID Details", "isCustom": "false", "id": 859, "url": "/reports/GenerateReports.do?firstTime=true&reportID=859", "Name": "webclient.opm.reports.meraki.rogue", "desc": "Get inventory reports of Meraki Rogue SSIDs." }, { "customStatus": "False", "displayName": "Meraki Cellular Gateway Details", "isCustom": "false", "id": 858, "url": "/reports/GenerateReports.do?firstTime=true&reportID=858", "Name": "webclient.opm.reports.meraki.mgdetails", "desc": "Get summary reports of Meraki Gateway devices." }, { "customStatus": "False", "displayName": "Meraki MV Details", "isCustom": "false", "id": 857, "url": "/reports/GenerateReports.do?firstTime=true&reportID=857", "Name": "webclient.opm.reports.meraki.mvdetails", "desc": "Get summary reports of Meraki Vision devices." }, { "customStatus": "False", "displayName": "Meraki MR Details", "isCustom": "false", "id": 856, "url": "/reports/GenerateReports.do?firstTime=true&reportID=856", "Name": "webclient.opm.reports.meraki.mrdetails", "desc": "Get summary reports of Meraki Radio devices." }, { "customStatus": "False", "displayName": "Meraki Organization Summary", "isCustom": "false", "id": 853, "url": "/reports/GenerateReports.do?firstTime=true&reportID=853", "Name": "webclient.opm.reports.meraki.orgSummary", "desc": "Get inventory reports of devices in each organization" }, { "customStatus": "False", "displayName": "Meraki MX Details", "isCustom": "false", "id": 854, "url": "/reports/GenerateReports.do?firstTime=true&reportID=854", "Name": "webclient.opm.reports.meraki.mxdetails", "desc": "Get summary reports of Meraki Security appliances." }, { "customStatus": "False", "displayName": "Down Meraki Devices", "isCustom": "false", "id": 861, "url": "/reports/GenerateReports.do?firstTime=true&reportID=861", "Name": "webclient.opm.reports.meraki.down", "desc": "Get reports for all Meraki devices that are down." } ], "title": "" } ], "Name": "Meraki Reports" }, { "displayName": "My Favorites", "list": [ { "list": [ { "customStatus": "False", "displayName": "All Alerts", "isCustom": "false", "id": 84, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=84", "Name": "All Alerts", "desc": "Get report for all alerts" }, { "customStatus": "False", "displayName": "All Events", "isCustom": "false", "id": 1, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=1", "Name": "All Events", "desc": "Get report for all events" }, { "customStatus": "False", "displayName": "WAN Links by Utilization", "isCustom": "false", "id": 15, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=15", "Name": "WAN Links by Utilization", "desc": "Identify WAN links with heavy traffic utilization" }, { "customStatus": "True", "displayName": "Servers Health Report", "isCustom": "true", "id": 22, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=22", "Name": "Servers Health Report", "desc": "Get health report of servers" }, { "customStatus": "False", "displayName": "WAN Links Availability", "isCustom": "false", "id": 54, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=54", "Name": "WAN Links Availability", "desc": "Get availability report for all interfaces" }, { "customStatus": "False", "displayName": "All Interfaces Availability", "isCustom": "false", "id": 87, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=87", "Name": "All Interfaces Availability", "desc": "Get availability report for all interfaces" }, { "customStatus": "False", "displayName": "Service Monitors Availability", "isCustom": "false", "id": 56, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=56", "Name": "Service Monitors Availability", "desc": "Get availability report for all service monitors" }, { "customStatus": "False", "displayName": "Devices by Category", "isCustom": "false", "id": 70, "isFavourite": "True", "url": "/reports/GenerateReports.do?firstTime=true&reportID=70", "Name": "Devices by Category", "desc": "Get inventory report of devices by device category" } ], "title": "" } ], "Name": "My Favorites" }, { "ScheduleReports": true, "FavoriteReports": false, "CustomReports": true } ]

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
isFavouriteNeeded
布尔值显示收藏夹报表或不显示。
hideintegratedReports
布尔值以显示高级报表或不显示。
hideHardwareReport
是否显示硬件报表的布尔值。

获取报表数据

方法: GET

描述: 获取所需报表数据的API。

示例 URL: https://localhost:8060/api/json/reports/getReportsData?apiKey=***************&reportID=84&isExcludeDays=true&excludedDays=Monday,Tuesday&category=Desktop&bview=All&time=Last_Month&timeWindow=8-20&isBusinessHour=false&showType=0&top=1000&viewAs=json

示例响应: [ { "clientParams": { "top": 0, "genAt": "15 May 2022 02:26:08 AM IST", "showType": 0, "time": "Last_7_Days", "isFavourite": true, "genAtMilliseconds": 1652561768907 }, "additionalRespData": { "RECORDS": "1", "SKIPCOLUMNS": [ 1, 6 ] }, "graphDetails": [ [ "xxx.xxx.xxx.xx", "xxx.xxx.xxx.xx", "Device Active and Responding", "Clear", "Server", "13 May 2022 09:47:16 AM IST", 1652415436543 ], [ "xxx.xxx.xxx.xx", "xxx.xxx.xxx.xx", "Device Active and Responding", "Clear", "Server", "13 May 2022 09:47:16 AM IST", 1652415436543 ] ], "forward": "eventList", "graphHeaders": [ "Device Name", "Message", "Severity", "Category", "Alert Time", "" ], "vmClientParams": { "RECORDS": 1, "SKIPCOLUMNS": [ 1, 6 ] }, "ReportGraphName": "All Alerts", "graphDispName": "All Alerts" } ]

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
reportID
单个报表的唯一ID。
viewAs
格式化以查看生成的报表数据。
time
获取报表数据的时间段。
isExcludeDays
是否排除天数的布尔值。
excludedDays
要在报表数据中排除的日期。
category
查看报表数据的类别。
logicalGroup
用于查看报表数据的逻辑组。
bview
查看报表数据的业务视图。
timeWindow
获取报表数据的时间窗口。
showType:
显示报表数据的顶部或底部内容。
top
显示报表数据峰值。
startTime
自定义时间段的起始时间。
endTime
自定义时间段的结束时间
startHour
自定义时间段的开始小时。
endHour
自定义时间的结束小时
customerId
要过滤的探针Id。
customerName
要过滤的探针名称。
fromEmailid
从要发送的报表的邮件id。
toEmailid
要发送的报表的邮件id。
emailSubject
邮箱主题
isBusinessHour
是否显示工作时间数据的布尔值。
businessRuleID
前面创建的业务规则的ID。

业务规则列表

方法: GET

描述: 该api可用于列出所有已创建的工作时间规则。

示例 URL: https://localhost:8060//api/json/admin/listBusinessRules?apiKey=***************

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。

添加业务规则

方法: POST

描述: 此api用于配置周一到周日的工作时间规则。

示例 URL: https://localhost:8060/api/json/admin/addBusinessRules?apiKey=***************&businessRuleName=Rule1&description=Indian standard time shift 1.&timeSettings={"monday":"1-5","tuesday":"3-6","wednesday":"3-5","thursday":"2-5","friday":"5-13"}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
描述
业务规则的描述。
业务规则名称
业务时间规则的名称。
时间设置
星期一到星期日的时间配置。

删除业务规则

方法: POST

描述: 此api用于删除已创建的业务时间规则。

示例 URL: https://localhost:8060//api/json/admin/deleteBusinessRules?apiKey=***************&businessRuleId=1

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
业务规则Id
业务时间规则ID。

业务规则视图

方法: GET

描述: 该api用于查看已经创建的工作时间规则。

示例 URL: https://localhost:8060//api/json/admin/viewBusinessRules?apiKey=***************&businessRuleId=1

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
业务规则Id
业务时间规则ID。

更新业务规则

方法: POST

描述: 此api用于从星期一到星期日更新已配置的业务时间规则。

示例 URL: https://localhost:8060/api/json/admin/updateBusinessRules?apiKey=***************&businessRuleName=Rule1&description=Indian standard time shift 1.&timeSettings={"monday":"1-5","tuesday":"3-6","wednesday":"3-5","thursday":"2-5","friday":"5-13"}&businessRuleId=1

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
描述
业务规则的描述。
业务规则名称
业务时间规则的名称。
时间设置
时间配置从周一到周日。
业务规则Id
业务时间规则ID。

获取报表数据

方法: POST

描述: 获取报表构建器报表数据的api。

示例 URL: https://localhost:8060/api/json/v2/device/getReportData?apiKey=***************&deviceList=moname1,moname2&monitorList=DevicesAvailability,ResponseTime,WMI-CPUUtilization,MSSQLDataFilesSizeKB&timePeriod=Last_Month&view=table&timeWindow=0-24&startDate=2020-11-09&endDate=2020-11-18-18

示例响应: { "DevicesAvailability - Percentage": [ { "seriesname": "Ground Floor AD Server", "data": [ [ 1667759400000, 0, "DevicesAvailability" ], [ 1667763000000, 0, "DevicesAvailability" ], [ 1667766600000, 0, "DevicesAvailability" ], [ 1667770200000, 0, "DevicesAvailability" ], [ 1667773800000, 0, "DevicesAvailability" ], [ 1667777400000, 0, "DevicesAvailability" ], [ 1667781000000, 0, "DevicesAvailability" ], [ 1667784600000, 0, "DevicesAvailability" ], [ 1667788200000, 0, "DevicesAvailability" ], [ 1667791800000, 0, "DevicesAvailability" ], [ 1667795400000, 0, "DevicesAvailability" ], [ 1667799000000, 0, "DevicesAvailability" ] ], "yaxiscolumnorder": [ 0 ], "id": "20000049227" } ], "Packet Loss - Percentage": [ { "seriesname": "Ground Floor AD Server", "data": [ [ 1667759400000, 100, "Packet_Loss" ], [ 1667763000000, 100, "Packet_Loss" ], [ 1667766600000, 100, "Packet_Loss" ], [ 1667770200000, 100, "Packet_Loss" ], [ 1667773800000, 100, "Packet_Loss" ], [ 1667777400000, 100, "Packet_Loss" ], [ 1667781000000, 100, "Packet_Loss" ], [ 1667784600000, 100, "Packet_Loss" ], [ 1667788200000, 100, "Packet_Loss" ], [ 1667791800000, 100, "Packet_Loss" ], [ 1667795400000, 100, "Packet_Loss" ], [ 1667799000000, 100, "Packet_Loss" ] ], "id": "20000001078" } ] }

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
deviceList
获取报表数据的设备列表。
monitorList
监视器列表以获取报表数据。
timePeriod
获取报表数据的时间段。
view
查看表格/图表格式的报表。
tableView
以实例/监视器的方式显示报表数据。
combinedTable
显示合并表结果的布尔值。
startDate
报表数据的开始日期。
endDate
报表数据的结束日期。
startHour
报表数据的起始小时。
endHour
报表数据的结束小时
timeWindow
获取报表数据的时间窗口。

列出所有高级报表

方法: GET

描述: 该api可用于获取所有已创建的高级报表。

示例 URL: https://: /api/json/reports/listAllAdvancedReports?apiKey=***********************************

示例响应: [ { "Description": "Interfaces Availability report", "ReportId": 6903, "Name": "Intf Rep" }, { "Description": "Availbility reports for servers", "ReportId": 6904, "Name": "Device Avail" }, { "Description": "Report one for interfaces", "ReportId": 16201, "Name": "Report 1" }, { "Description": "Report two for devices", "ReportId": 16806, "Name": "Report 2" } ]

参数名称
描述
api密钥
通过api密钥可以访问OpManager服务器。

设置

获取类别列表

方法: POST

描述: 列出所有可用的设备类别

示例 URL: https://localhost:8060/api/json/device/getCategoryList?apiKey=***************

示例响应: {"Wireless":"Wireless","Server":"Server","UCS":"UCS","WirelessLANController":"Wireless LAN Controller","DomainController":"DomainController","Printer":"Printer","IoT":"IoT","MerakiRadio":"Meraki Radio","Unknown":"Unknown","MerakiCellularGateway":"Meraki Cellular Gateway","UPS":"UPS","WirelessAccessPoint":"Wireless Access Point","MerakiVision":"Meraki Vision","SDN":"SDN","TapeLibrary":"TapeLibrary","PDU":"PDU","IPMI":"IPMI","MerakiSwitch":"Meraki Switch","FCSwitch":"FCSwitch","LoadBalancer":"Load Balancer","Router":"Router","RAID":"RAID","Firewall":"Firewall","Storage":"Storage","Desktop":"Desktop","Switch":"Switch","MerakiController":"Meraki Controller","MerakiSecurity":"Meraki Security","WANAccelerator":"WAN Accelerator"}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。

子网

子网列表

方法: GET

描述: 列出OpManager监控的所有子网

示例 URL: https://localhost:8060/api/json/device/listSubnets?apiKey=***************

示例响应: {"127.0.0.0.10000000001":{"data":[{"Status":"7","Label":"Unknown","Count":"25"}],"displayName":"127.0.0.0","subnetDisplayName":"ProductionSite"},"xxx.xxx.xxx.x.10000000001":{"data":[{"Status":"1","Label":"Critical","Count":"147"}],"displayName":"xxx.xxx.xxx.x","subnetDisplayName":"TestingPlant"}}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。

无线

获取无线网络详细信息

方法: GET

描述: 列出了无线局域网控制器中每个SSID的无线AP、客户端计数和网络使用情况

示例 URL: https://localhost:8060/api/json/wireless/getWirelessNetworkDetails?apiKey=***************&deviceName=CiscoWirelessController

示例响应: [{"ClientCount":"40","TotalBytes":"224.548 MBps","SSIDName":"Mobile-Connect","APCount":"20"},{"ClientCount":"20","TotalBytes":"224.546 MBps","SSIDName":"Machine-Connect","APCount":"20"},{"ClientCount":"20","TotalBytes":"196.161 MBps","SSIDName":"Free-Connect","APCount":"20"}]

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
deviceName*
WLC设备的名称(在设备快照页面的URL中看到的被管理实体名称或listDevices API响应中的'deviceName'属性值)

获取无线AP列表

方法: GET

描述: 列出WLC设备中的所有无线AP。

示例 URL: https://localhost:8060/api/json/wireless/getWirelessAPList?apiKey=***************&deviceName=CiscoWirelessController

示例响应: [{"macAddress":"1:50:bf:7:xx:xx","channels":"53,64","statusStr":"Clear","ipAddress":"127.0.0.1","apDisplayName":"South-0011","advanceMonitoringEnabled":"true","apName":"ap-127.0.0.1-1.80.191.7.xxx.xx","statusNum":"5"},{"macAddress":"1:50:bf:7:xx:xx","channels":"53,64","statusStr":"Not Monitored","ipAddress":"127.0.0.1","apDisplayName":"North021","advanceMonitoringEnabled":"false","apName":"ap-127.0.0.1-1.80.191.7.xxx.xx","statusNum":"7"},{"macAddress":"1:50:bf:7:xx:xx","channels":"53,64","statusStr":"Not Monitored","ipAddress":"127.0.0.1","apDisplayName":"South0021","advanceMonitoringEnabled":"false","apName":"ap-127.0.0.1-1.80.191.7.xxx.xx","statusNum":"7"},{"macAddress":"1:50:bf:7:xx:xx","channels":"53,64","statusStr":"Not Monitored","ipAddress":"127.0.0.1","apDisplayName":"North0031","advanceMonitoringEnabled":"false","apName":"ap-127.0.0.1-1.80.191.7.xxx.xx","statusNum":"7"}]

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
deviceName*
WLC设备的名称(在设备快照页面的URL中看到的被管理实体名称或listDevices API响应中的'deviceName'属性值)

获取SSID客户端列表

方法: GET

描述: 列出与给定WLC设备关联的所有SSID客户机。

示例 URL: https://localhost:8060/api/json/wireless/getSSIDClientList?apiKey=***************&deviceName=CiscoWirelessController

示例响应: {"clientData":[{"displayName":"Mobile-Connect","ClientCount":"40"},{"displayName":"Free-Connect","ClientCount":"20"},{"displayName":"Machine-Connect","ClientCount":"20"}],"clientCount":80}

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
deviceName*
WLC设备的名称(在设备快照页面的URL中看到的被管理实体名称或listDevices API响应中的'deviceName'属性值)

获取客户端详细信息

方法: GET

描述: 客户端设备连接到WLC设备的给定SSID。

示例 URL: https://localhost:8060/api/json/wireless/getClientDetails?apiKey=***************&deviceName=CiscoWirelessController&ssidName=WorkstationNetwork

示例响应:[{"ClientCount":"2","TotalBytes":"28.156 MBps","APMOName":"ap-127.0.0.1-1.80.191.7.xxx.xx","advanceMonitoringEnabled":"false","apName":"North0041"},{"ClientCount":"2","TotalBytes":"28.154 MBps","APMOName":"ap-127.0.0.1-1.80.191.7.xxx.xx","advanceMonitoringEnabled":"false","apName":"North0031"},{"ClientCount":"2","TotalBytes":"14.079 MBps","APMOName":"ap-127.0.0.1-1.80.191.7.xxx.xx","advanceMonitoringEnabled":"false","apName":"North0101"},{"ClientCount":"2","TotalBytes":"14.079 MBps","APMOName":"ap-127.0.0.1-1.80.191.7.xxx.xx","advanceMonitoringEnabled":"false","apName":"South0081"},{"ClientCount":"2","TotalBytes":"14.079 MBps","APMOName":"ap-127.0.0.1-1.80.191.7.xxx.xx","advanceMonitoringEnabled":"false","apName":"North0061"},{"ClientCount":"2","TotalBytes":"14.078 MBps","APMOName":"ap-127.0.0.1-1.80.191.7.xxx.xx","advanceMonitoringEnabled":"false","apName":"North0091"},{"ClientCount":"2","TotalBytes":"14.078 MBps","APMOName":"ap-127.0.0.1-1.80.191.7.xxx.xx","advanceMonitoringEnabled":"false","apName":"North0071"},{"ClientCount":"2","TotalBytes":"14.077 MBps","APMOName":"ap-127.0.0.1-1.80.191.7.xxx.xx","advanceMonitoringEnabled":"false","apName":"South0031"},{"ClientCount":"2","TotalBytes":"14.077 MBps","APMOName":"ap-127.0.0.1-1.80.191.7.xxx.xx","advanceMonitoringEnabled":"false","apName":"North0051"}]

参数名称
描述
apiKey*
访问OpManager服务器的API密钥。
deviceName*
WLC设备的名称(在设备快照页面的URL中看到的被管理实体名称或listDevices API响应中的'deviceName'属性值)
ssidName*
WLC关联的无线网络的SSID名称