HOW TO USE THE UIM API CA. ALL RIGHTS RESERVED.

Size: px

Start display at page:

Oscar Sullivan
6 years ago
Views:

3 UIM API OVERVIEW UIM tenet #7: Anything that can be done through a UI, can also be done programmatically API and SDKs available for UIM: REST webservice SOAP webservice Perl SDK Java SDK.Net SDK Command line (PU.EXE) C, C++, C#, VB, VBScript, Lua CA. ALL RIGHTS RESERVED.

5 PDS JAVA NimUtility.displayPDS(pdsVariable); This will print the output of the PDS in a readable format NimRequest req = new NimRequest( probeaddress, callback, arguments) Arguments are in PDS form. PDS args = new PDS(); args.putstring( key, value ); Return values by using pdsvariable.getstring Int( key ); PDS can return tables CA. ALL RIGHTS RESERVED.

6 PDS LUA req = nimbus.request( probeaddress, callback, arguments) Arguments are in PDS form. args = pds.create() Pds.putString(args, key, value ); Return values by looping through returned table for k,v in pairs(req) do print (k.... v) end CA. ALL RIGHTS RESERVED.

7 PROBE UTILITY The Probe Utility accesses callbacks on probes and directly connects to internal hooks to force actions Each probe supports multiple callback actions Exploring these is the best way to learn them CA. ALL RIGHTS RESERVED.

8 PU.EXE COMMAND LINE UTILITY Usage of pu.exe is not only for returning values, but also changing creds, deploying entire probes, or changing behavior Usage: pu [options] <nim-address> [command] [data] -i interactive mode -u user user name -p password NMS passwd -s SID Valid SID -t sec timeout in seconds -H host use probe host -P port use probe port -d level set debug level -L list commands on probe -I show probe info -R restart probe -S stop probe Running these types of commands from within a batch or PERL script and feeding in lists can result in high caliber automation and even touch-less administration CA. ALL RIGHTS RESERVED.

9 RESTART A WINDOWS SERVICE WITH PU.EXE To start a windows service: pu -u <user> -p <password> <Address> start_service <servicename> To stop a windows service: pu -u <user> -p <password> <Address> stop_service <servicename> Where: <user> is a Nimsoft user <password> is the password associated with the Nimsoft user <Address> is the Nimsoft address of the ntservices probe <servicename> is the name of the service Format of Nimsoft address: /domain/hub/robot/ntservices CA. ALL RIGHTS RESERVED.

10 LUA AND THE NAS LUA Basics PDS args nimbus.request() Looping through tables Interact with Alarms alarm.get() alarm.list() Examples: Interacting with Probes Add note/annotation script CA. ALL RIGHTS RESERVED.

11 UMP REST API REST API runs inside Wasp (UMP) Uses Basic HTTP authentication Production Note: Configure Wasp to use HTTPS Respects http accept header returns xml/json/text Endpoint is Wadl describes available services CA. ALL RIGHTS RESERVED.

12 REST API EXAMPLES FOR PROVISIONING Check if a probe is installed Deploy a robot using a callback to ADE Deploy a probe using a callback to distsrv Retrieve current probe configuration Configure a probe Get alarms Get performance data CA. ALL RIGHTS RESERVED.

13 USE REST API TO VERIFY PROBE INSTALLATION /probe/{domain}/{hub}/{robot}/{probe}/info Command: curl -v -u api:cademo123 Monitor/WorldWideHQ/usildodnimms1/cdm/info xmllint Output: <?xml version="1.0" encoding="utf-8" standalone="yes"?> <probeinfo> <company>nimsoft Corporation</company> <connections>506</connections> <libdate>jun </libDate> <libversion>6.01 (64bit)</libVersion> <messages>4</messages> <name>cdm</name> <started> T17:59:41-04:00</started> <version>4.70</version> </probeinfo> CA. ALL RIGHTS RESERVED.

$/probe/{domain}/{hub}/{robot}/{probe}/{callback2}/submit_job 14$

16 USE REST API TO CONFIGURE A PROBE Get current configuration: curl -v -u api:cademo123 Monitor/Worldxxxxxx/usildodnimms1/cdm/config Modify / add configuration: curl -v -u api:caxxxxxxx -X PUT -H "Content-Type: application/xml" -d "<probeconfigkeys><configkey><key>/cpu/alarm/error/threshold </key><value>42</value></configkey><configkey><key>/cpu/alar m/warning/active</key><value>no</value></configkey></probeco nfigkeys>" Monitor/Worldxxxxxx/usixxxxxxxx/cdm/config CA. ALL RIGHTS RESERVED.

Nimsoft Documentation

Nimsoft Documentation Nimsoft Probes Technical Description xmlparser v1.2x Probe Documentation Last Update: 08 December 2010 Copyright 1998-2010, Nimsoft Corporation www.nimsoft.com Nimsoft Documentation: