search cancel

UIM RESTMon starter guide.

book

Article ID: 244146

calendar_today

Updated On:

Products

DX Unified Infrastructure Management (Nimsoft / UIM)

Issue/Introduction

Thinking of creating a custom probe to monitor something via REST, this will provide the info to get started. 

Environment

Release : 20.4

Component : UIM - WEBSERVICEMON

Resolution

Here is the main page for RESTMon:
Monitor Technologies Using RESTMon
https://techdocs.broadcom.com/us/en/ca-enterprise-software/it-operations-management/unified-infrastructure-management/20-4/configuring-and-viewing-monitoring-data/monitor-technologies-using-restmon.html

It links to this page which has the steps to use RESTMon. 
Monitor Technologies Using RESTmon Probe
https://techdocs.broadcom.com/us/en/ca-enterprise-software/it-operations-management/ca-unified-infrastructure-management-probes/GA/alphabetical-probe-articles/monitor-technologies-using-restmon-probe.html

Sample json files are in restmon_sample_schemas-1.13.zip
http://support.nimsoft.com/Files/Archive/00476/restmon_sample_schemas-1.13.zip
It is a standard zip, download to your laptop and extract, it will not import into the archive. 

Helpful websites for working with json:
https://www.json.org/
https://www.tutorialspoint.com/json/json_schema.htm
https://www.jsonquerytool.com/
put code in json, enter sample code in extraction query

It is highly recommended that all work be done in your development environment and only after you are sure it's good import it into production. 

This YouTube video has a very good explanation of RESTMon although it is for RESTMon in general and not specific to UIM. 
https://www.youtube.com/watch?v=U7hTmQryXPM&feature=youtu.be

This KB explains it from the perspective of the UIM Admin:
Basic restmon configuration
Article Id: 219068
https://knowledge.broadcom.com/external/article?articleId=219068
 
This KB will be for the developer:
DX RESTMon Schema Development Guide
Article Id: 216284
https://knowledge.broadcom.com/external/article?articleId=216284

Additional Information

Additional KB docs:

Example restmon probe connection to an endpoint that requires bearer authentication
Article Id: 218100
https://knowledge.broadcom.com/external/article?articleId=218100

How to generate change_events using RE
Article Id: 220058
https://knowledge.broadcom.com/external/article?articleId=220058