UIM RESTMon starter guide
search cancel

UIM RESTMon starter guide

book

Article ID: 244146

calendar_today

Updated On:

Products

DX Unified Infrastructure Management (Nimsoft / UIM) CA Unified Infrastructure Management On-Premise (Nimsoft / UIM) CA Unified Infrastructure Management SaaS (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: RESTMON

Cause

  • Guidance

Resolution

Main tech docs page for RESTMon



REST API Monitoring

Sample json files are in restmon_sample_schemas.

Navigate to http://support.nimosft.com



It is a standard zip, download to your laptop and extract, it will not import into the Nimsoft 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 working as expected and then 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 

Development Guide


This article is meant for the developer:
DX UIM Restmon Development Guide

Additional Information

Additional KB Articles docs with examples

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

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