Example use case scenarios for web services that retrieve data from BMC ProactiveNet


This section lists a few use case scenarios for BMC ProactiveNet web services. It can help you to use the BMC ProactiveNet web service APIs effectively. Each scenario is explained using a sample URL and its subsequent response details.

Retrieving monitor instance configuration data from a single device

URL

http://bppmwsserver/bppmws/api/Device/192.168.123.46/
configdata?idType=IP
Address

Response

URI of monitor instances and attributes based on the IP address of the resource

Retrieving monitor type metadata from multiple devices

URL

http://bppmwsserver:80/bppmws/api/Device/192.168.123.46,192.168.123.2/
metad
ata?idType=IPAddress

Response

Metadata information about monitor types and attributes for each device, based on the IP addresses of the resources

Retrieving performance statistics data from multiple devices having multiple monitor types

URL

http://bppmwsserver:80/bppmws/api/Device/192.168.123.1,192.168.123.2,
192.168
.123.3/stats?starttime=2010-06-23T17:00:00&endtime=
2010-07-07T17:00:00&idType=IPAddress&monitor=CPU:CPU_UTILIZATION,
CPU_EXTRA;Processor:CPU_TOTAL_UTIL

Response

Performance statistics data from multiple devices for the specified monitor types, based on the IP addresses of the resources for the specified time period

Retrieving performance statistics data for the monitor instances using their URIs

URL

http://bppmwsserver:80/bppmws/api/MonitorInstance/NGPServ3:1234:345,
NGP
Serv3:1234:346/stats?starttime=2010-06-23T17:00:00&
endtime=2010-07-07T17:00:00&idType=URI

Response

Performance statistics data for the specified monitor instances for the specified time period (grouped by monitor instances) for the attributes that are of type KPI

Retrieving performance statistics data for the monitor instances using their URIs and the specified monitor types and attributes

URL

http://bppmwsserver:80/bppmws/api/MonitorInstance/NGPServ3:1234:345,
NGP
Serv3:1234:346/stats?starttime=2010-06-23T17:00:00&
endtime=2010-07-07T17:00:00&idType=URI&monitor=CPU:CPU_UTILIZATION,
CPU_EXTRA;MEMORY:MEMORY_Utilized,MEMORY_Baloon

Response

Performance statistics data grouped by monitor instances for the specified attributes for the specified time period

Retrieving performance statistics data from multiple devices with multiple monitor types based on the IP addresses of the resources

URL

http://bppmwsserver:80/api/Device/192.168.123.1,192.168.123.2,
192.168.123.3,
192.168.123.4,192.168.123.5/stats?idType=
IPAddress&monitor=CPU:CPU_UTILIZATION,CPU_EXTRA;Processor:CPU_TOTAL_UTIL

Response

Performance statistics data from the specified devices for the specified attributes

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC ProactiveNet 9.6