Moogsoft Docs

Generic Server Tools

Introduction

Generic Server Tools are tools that allow a user to execute a utility on a remote host.

These tools specify a command that is run using the Tool Runner servlet (which is configured to connect to the remote host). The command can be anything you can run on the host in a Linux terminal command line, such as an inbuilt part of the OS (ping, cat etc) or your own script.

Note

In Moogsoft AIOps, the Generic Server Tools managed here are only available from Situation Room ChatOps feature. See "Take Additional Actions" in the Operator Guide .

The steps below describe how to create a Generic Server Tool and its command. Any arguments required are defined by the user when the tool is run.

Configuration

Go to System Settings > Tools and then Generic Server Tools to open the configuration window:


Button
Description

This can be used to add a new Generic Server Tool

This can be used to delete any selected Generic Server Tool

This can be used to copy any selected Generic Server Tool

Create a new Generic Server Tool

1. Click the to create a new tool.

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

Field
Input
Description
Name String (Mandatory) The name for the Generic Server Tool (up to 100 characters). This appears in ChatOps when accessing the tool
Description String
(Optional)
The text description of the tool
Command String

This is the file path of the command

Note

Please note : This command must be an accessible path on the host system. The host system and access information is defined in the Tool Runner servlet.

Run For Boolean +
String
Select a duration in with the spin box (minimum of 5 seconds). This sets how long to allow the tool to run for before it is stopped. If no time is set, the tool will run until it completes (or indefinitely)

3. Click Save Changes to create the tool which will appear in the list on the left.

4. Alternatively, click Revert Changes to discard your changes and confirm when prompted.

Edit a Generic Server Tool

1. To edit a Generic Server Tool, click the required tool you want from the list on the left. Alternatively, type in the search box in the top left corner to search for the tool you want to edit.

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 .

Examples

The picture above shows a Generic Server Tool with the command:

   /home/moog/bin/myTests.sh

This tool runs the script myTests.sh which is located on the remote host at the path /home/moog/bin/, using remote host access information defined in the Tool Runner servlet.