What are the options for the nimalarm utility?

Document ID : KB000034377
Last Modified Date : 14/02/2018
Show Technical Document Details

Introduction:

The nimalarm utility can be used to send UIM alarms via the command line.  This can have uses for getting alarms into UIM from systems that are not necessarily UIM integrated.  For example, a batch file could be configured to call the nimalarm utility when it encounters an error during runtime. 

 

The nimalarm utility is found in the UIM installation directory.  In a standard Windows installation it can be found in C:\Program Files (x86)\Nimsoft\bin

 

Question:

What do the various command line options do?

 

Answer:

ALL options are optional. More detailed explanations below:

-l:

Sets the alarm severity.

-s:

Sets the subsystem ID.

-c:

Sets the suppression key.

-d:

Sets the internal debug level (ie. loglevel) of the utility.

-S:

Sets the source/hostname alarm fields.

-i:

Makes the utility print the nimid of the generated alarm.

-[1-5]:

Sets the custom fields 1 through 5.

-t,n:

Needs to be set together, decides the CI device ID.

-m:

The CI metric ID.

-a:

The alarm token, fills the udata->token field in the alarm PDS. Used for e.g. UMP for fetching internationalized alarm messages.

-V:

Sets values to be used in above mentioned internationalized alarm messages. See the properties files in the wasp/i18n directory for examples on how these are used.

 

Additional Information:

Here are some examples for usage

Simplest usage is:

nimalarm <message> 

 

Complex usage:

nimalarm -l 5 -c test-0512-01 -S server1 -i "This is a TEST alarm"

Sets an alarm severity, sets a suppression key, sets an alarm source and returns the unique nimid of the alarm.