Moogsoft Docs

Alert Server Tools

Alert Server Tools are tools that allow a user to execute a utility. The tools available are relevant to the Alert selected. Each tool executes on a remote host, which is defined when it is running.

The arguments passed to the utilities are extracted from the Alert attributes. For example, testing the reachability (ping) of hardware using the source attribute of the Alert.

The configuration steps described below define the Alert Server Tool (its command and argument).

Configuration

Go to System Settings > Tools > Alert Server Tools to open the configuration window.


Button Description

This can be used to add a new Alert Server Tool

This can be used to delete any selected Alert Server Tool

This can be used to copy any selected Alert Server Tool

Creating a new Alert Server Tool

To create a new Alert Server Tool, follow the steps outlined below:

1. Click the icon. This will open a clear configuration window.

2. Fill the available fields to define the tool. These are listed in the table:

Field Input Description
Name String (Mandatory) The name for the Alert Server Tool (up to 100 characters)
Description String The text description of the Alert Server Tool
Alert Type filter String

The Alert Types for which the Alert Server Tool will be available

Note

Please note : Enter .* to make it available for all Alert Types.

Filter using Regex Boolean If enabled, the Alert Type filter will use regular expression
Command String
(Mandatory)

This is the command to carry out using Alert information

Note

Please note : This command must be an accessible path on the host system. This is defined when you run the tool.

Arguments String This is the specific input for the command
Run for Boolean +
Integer
If enabled, you can define the number of seconds the tool will run for. The minimum value for this field is 5 seconds.

Edit an Alert Server Tool

1. Select the Alert Server Tool you want to edit from the list on the left. Alternatively type in the search box in the top left to search for the required tool.

2. Edit fields as described above.

Note

Please note : You cannot edit the tool Name. If you need to do this, create a duplicate with the name you want. You can then delete the original

3. Click Save Changes .

4. If you want to discard your changes, click Revert Changes .

Example

The screenshot below shows a Alert Server Tool that tests the reachability of the source the Alert and returns the results.

The Command ping is used with Arguments $source and -c5 which specify the source (from the Alert attribute) and the number of times to ping (five).

The Alert Type Filter uses a regular expression ' .* ' to make the tool available for all Alerts.