Configuring Windows PowerShell 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 while setting up a remote PowerShell connection with the target device. For a remote host, a remote PowerShell connection is used. For a local host, a local PowerShell connection is used, and therefore, a user name and password to access it are not required.

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. Using an alias and not a real direct name is useful when you want to force access to the remote target device on a nonresolvable 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._%:-]+$.

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

Forced IP Address

Enter the IP address of the device that you want to monitor. If you entered the 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 - <>\/|":*?]].

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, ensure that the KM does not wait for it and stops 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 using the script. If the network or target host is slow, you can still get the KM to work properly by allowing a longer timeout 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 remote PowerShell connections with all target hosts. If a connection breaks, the PATROL Agent can reconnect smoothly. The KM checks the status of the PowerShell 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 button to configure 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 - FileSizeMonitor.ps1, GetServiceStatus.ps1.

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 have the argument of the log file name.

Content match

In addition to monitoring numeric values, the KM is capable of monitoring 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 along with the value and the text defined in this field. A single or a semicolon separated list of regular expressions is supported.

The syntax of regular expression has to be considered valid for usage with Oracle Java (java.util.regex).

Timeout (sec)

Poll interval (sec)

The PATROL Agent maintains a set of connections to all target hosts. If a connection breaks, the PATROL Agent can reconnect smoothly. The KM checks the status of the 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 username is used for the connection.

If you want to run the script that generates multiple output instances and runs on a local host, you can leave the fields in the section blank.

Username

Enter the username used to connect to the remote host.

Password

Enter the password corresponding to the username.

Confirm Password

Re-enter the password.

Authentication Type

Select the one of the following authentication methods:

• Kerberos
• Negotiate
• Use shared authentication

Connection Protocol

Select one of the following protocols:

• HTTP
• HTTPS
• Use shared protocol

Port Number

Enter the PowerShell port number to connect to the configured device. The default port number is 5985.

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