Moogsoft Docs

Implement 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).

Manage Alert Server Tools

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

To create a new Alert Server Tool:

  • Click the + icon. This opens a clear configuration window.

  • Fill the available fields to define the tool:

    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 is available.

    Note: Enter .* to make it available for all alert types.

    Filter using Regex

    Boolean

    If enabled, the Alert Type filter uses regular expression.

    Command

    String (Mandatory)

    This is the command to carry out using alert information

    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 runs for. The minimum value for this field is 5 seconds.

Example

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

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

AlertServer1.JPG

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