Configuring ports

After you have installed the PATROL for Light Weight Protocols, you must configure a monitoring policy.

This topic includes the following information:

Before you begin

You must download and install the PATROL for Light Weight Protocols.

To configure the monitor type

In the Add Monitoring Configuration panel, select the following parameters for the Port monitor profile:

Parameter	Selection
Monitoring Solution	Light Weight Protocols
Monitor Profile	TCP/IP (Port)
Monitor Type	Ports

To configure a Port

Click Add and enter the device details

Field	Description
Device details
Device name/IP	Enter the alias name, hostname or IP address of the network device you want to monitor. Enter the Forced IP address if the alias name cannot get resolved to a valid IP address.
Forced IP Address	Enter the IP address of the network device you want to monitor. You can leave this field blank if you have provided the actual hostname or IP address as the alias name.
Category	Enter the category name of the configured device.
Timeout (sec)	Specify the time interval to map the device name to an IP address. The default value is 10 seconds.
Poll interval (sec)	Select the poll interval time in seconds to ping the device. The default value is 300 seconds. The minimum value you can select is 10 seconds. The maximum value you can select is 3600 seconds.
Ports
Port details
Name	Specify the Port display name. It is recommended to use a name associated with the port. This field supports regex.
Port	Specify the port number.
Timeout (sec)	Specify the time interval to wait for the port to respond. The default value is 30 seconds.
Poll interval (sec)	Select the poll interval time in seconds to ping the device. The default value is 300 seconds.
Content match configuration
Condition name	Specify the condition name.
Text to write	Specify the text to write on the socket. For example: To open a web page, 'GET HTTP/1.1\r\n\r\nHost:www.bmc.com\r\n\r\n'
Text to read	Read the command output. Set the relative read command output by using one of the following options: Empty - read will not occur for the relative command. A string - read will occur until a match is found. Read all - enter .* to read all of the relative command output.
String to scan	Enter a string to search for the text. It supports regex. Use semicolon to separate multiple regular expressions or strings.
SSH Ports
Use default credentials	Select this option only if you want to take the credentials from the default port configuration and configure SSH port.
Username	Enter the username to connect to the remote host.
Password	Specify the password for authentication. Note: Leave this field blank if you use Key-based authentication for configuration.
Key based authentication
Public key file path	Enter the full path of the public key file. For example: /home/ptest/.ssh/id_rsa.pub
Private key file path	Enter the full path of the private key file. For example: /home/ptest/.ssh/id_rsa
Passphrase	Enter the passphrase to access public and private keys.
Known ports
Load known ports	Select this option to load known ports from a file. If you make any changes in the file, restart the PATROL Agent.
File location	Enter the location of the known ports file. The default file path is %PATROL_HOME%/PIM/Conf/Port/KnownPorts/KnownPorts.txt. If left blank, common ports will be used. Imput value must not contain any characters from the set '*?><\|'.

Configuring file-based monitoring

Field	Description
Import devices from file	Enable this option to configure devices to be pinged automatically from files. All the files must be located at %PATROL_HOME%\PIM\Conf\ImportDevices\ directory. You can have multiple files for configuring devices and should specify an appropriate name for the files. The devices are grouped below the file names. By default, this option is disabled. For more information, see Configuring ports using file-based configuration. If you have multiple PATROL Agents with different port numbers running on the same computer and each PATROL Agent wants to load a different file, then you can create subdirectories under the file location with the port number.
Files location	Specify the location to load the configured files based configuration. If it is not specified then by default it considers *%PATROL_HOME%\PIM\Conf\ImportDevices*.

Field

Description

Import devices from file

Enable this option to configure devices to be pinged automatically from files. All the files must be located at %PATROL_HOME%\PIM\Conf\ImportDevices\ directory. You can have multiple files for configuring devices and should specify an appropriate name for the files. The devices are grouped below the file names. By default, this option is disabled. For more information, see Configuring ports using file-based configuration.

If you have multiple PATROL Agents with different port numbers running on the same computer and each PATROL Agent wants to load a different file, then you can create subdirectories under the file location with the port number.

Files location

Specify the location to load the configured files based configuration. If it is not specified then by default it considers %PATROL_HOME%\PIM\Conf\ImportDevices.

Default Configuration Settings

Default device configuration
Field	Description
Timeout (sec)	Specify the time interval to map the device name to an IP address. The default value is 10 seconds.
Poll interval (sec)	Select the poll interval time in seconds to ping the device. The default value is 300 seconds. The minimum value you can select is 10 seconds. The maximum value you can select is 3600 seconds.
Default port configuration
Timeout (sec)	Specify the time interval to map the device name to an IP address. The default value is 10 seconds.
Poll interval (sec)	Select the poll interval time in seconds to ping the device. The default value is 300 seconds. The minimum value you can select is 10 seconds. The maximum value you can select is 3600 seconds.
SSH Ports
Username	Enter the username to connect to the remote host.
Password	Specify the password for authentication. Note If you use Key based authentication, the password field should be left blank.
Key based authentication
Public key file path	Enter the full path of the public key file. For example: /home/ptest/.ssh/id_rsa.pub
Private key file path	Enter the full path of the private key file. For example: /home/ptest/.ssh/id_rsa
Passphrase	Enter the passphrase to access public and private keys.

Administration

Field	Description
Root display name	Enter a display name for the monitor type to display a meaningful location name for the target agent. The target agent pings the configured destination devices. The default root display name is Port.
Device Mapping	Select any of the following monitoring modes: FQDN — Monitors are created within a device according to the discovered FQDN of the monitored system. If the configured Device name/IP set with an alias name and the force IP address is configured, the device gets mapped to the TrueSight with the Device name/IP instead of the device FQDN although this option was selected. User defined — Monitors are created within a monitored device using the name provided by the user (alias name). Disable — Monitors are created within the device of the PATROL Agent(s).
Java path	Specify the path of the JRE directory ($JAVA_HOME environment variable) on the PATROL Agent host which is used by the KM. If the JAVA_HOME environment variable of the PATROL Agent is set, you can use the default value $JAVA_HOME as the Java path. If the feild is left blank, the KM uses the Java path installed on the PATROL Agent home directory in the following format: $PATROL_HOME/openjdk or $PATROL_HOME/jre64. For example: Windows - C:\Program Files\Java\jdk-11.
Enable logging	Select this option to enable logging. The log files are created at *%PATROL_HOME%\PIM\logs*. By default, this option is disabled.