Configuring LINUX-UNIX shell scripts monitor type

Device name/IP

Enter a host name or an IP address. The name can be short or long. The KM uses this value when it sets up the SSH connection with the target device.

You can also enter an alias name. If you enter an alias name in the field, you must enter the device IP address in the Forced IP Address field. By using an alias and not a real direct name is useful when forcing access to the remote target device on a non-resolvable name and IP address (for example, when devices have multiple network adapters). The name must match the following regular expression pattern - ^[0-9a-zA-Z._%:-]+$.

Enter the name or IP address of the host where PATROL Agent and the KM are installed to run the script that generates multiple output instances and runs on a local host, 

Forced IP Address

Enter the IP address of the device that you want to monitor. If you enter the real host name or IP address in the Device name/IP field, leave this field blank. The input in the field must match the following regular expression pattern: - [^(?:(^((?:[0-9A-Fa-f]{1,4}(?::[0-9A-Fa-f]{1,4})*)?):{1,2}((?:[0-9A-Fa-f]{1,4}(?::[0-9A-Fa-f]{1,4})*)?)$)|(^(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}$))]]>

Category

Enter a category name to group the devices. A container is created with the category name.

Do not enter the following characters in the field: - <>\/|":*?]].

Port

Enter the SSH port number to connect to the device. The default port number is 22.

You can leave the field blank to run the script that generates multiple output instances and runs on a local host.

Timeout (sec)

Enter the connection timeout period in seconds. A target device might not be available or might be very slow to respond. In such scenarios, make sure that the KM does not wait for it and stop responding. You can define the maximum time to allow to establish a connection. If the time elapses, the KM understands that there is a failure to monitor by using the script. If the network or target host is slow, you can still get the KM to work properly by allowing a longer time out period. The minimum value is 1 second, and the maximum value is 3600 seconds. The default value is 5 seconds.

Poll interval (sec)

The PATROL Agent maintains a set of SSH connections with all target hosts. If a connection breaks, the PATROL Agent can reconnect smoothly. The KM checks the status of the SSH connection at the interval set in this field. By default, the KM checks the connection status every 300 seconds. The minimum value is 10 seconds, and the maximum value is 100,000 seconds.

Scripts

Click the Add to configure the script details.

Name

Enter a display name for the script. A container is created with the script display name. This container holds the attributes for the script instance.

Input in the field must match the following regular expression pattern - ^[0-9a-zA-Z._%:-]+$.

Example of the display name: cron-monitor.sh, ping3rdParty.sh.

Arguments

Enter the arguments that are passed during the script execution. Separate multiple arguments with a space.

For example, a script file that returns the log file size must include the log file name as an argument.

Content match

In addition to monitoring numeric values, the KM can monitor a specific text pattern returned by the script during execution. This is useful when you need to enable a certain value where the actual numeric value is the same. The KM scans for the value defined in this field. It returns an annotation text with the value and the text defined in this field. You can use a single regular expression or a list separated by semicolons.

The syntax of regular expression must be considered valid for using Oracle Java (java.util.regex).

Timeout (sec)

Poll interval (sec)

The PATROL Agent maintains a set of SSH connections to all target hosts. If a connection breaks, the PATROL Agent can reconnect smoothly. The KM checks the status of the SSH connection at the interval set in this field. By default, the KM checks the connection status every 300 seconds. The minimum value is 10 seconds, and the maximum value is 100,000 seconds.

Independent monitor view

Select this check box to configure the Scripting KM to create a monitor showing independently within the associated device.

Enable events for single value script annotation

Select this check box to enable events for single-value script annotation.

For more details about single value, see Defining the script output (Linux).

Scheduling Script monitoring

Enable Scheduling for above Script

Date of the month (regex supported)

Day

Start Time (HH:MM)

End Time (HH:MM)

Credentials configuration

Enter the credentials to connect to the remote host. If this field is left blank, the PATROL Agent default account user name is used for the connection. If you can access all the devices that you are configuring by using one user's credentials, you can leave this section blank with the device and script details and enter it one time in the Default configurations > Default device configuration section.

You can leave the fields in this section blank to run the script that generates multiple output instances and runs on a local host.

User name

Enter the user name used to connect to the remote host.

Password based authentication

Password

Enter the password corresponding to the user name (enter $ character to modify the password and leave it blank).

Key based authentication

Public key file path

Enter the absolute path of the file that will hold the public key.

Private key file path

Enter the absolute path of the file that will hold the private key.

Passphrase

Enter the passphrase to access public and private keys (enter $ character if you want to modify the password and leave it blank).