Rule set files for Windows

The following table lists the rule set files, which are available at $PATROL_HOME\..\pconfmgr\rulesets\Shipped\TROMS\km_version_number\Script for configuring scripts.

Files

Descrption

Administration.cfg

Contains configuration variables to provide additional information related to network devices, such as, display name, debug enabling and so on.

All.cfg

Consolidated file containing all the configuration variables available in Administration.cfg, DefaultConfiguration.cfg, ConfigurationFilesBasedMonitoring.cfg, Script.cfg.

ConfigurationFilesBasedMonitoring.cfg

Contains configuration variables to configure scripts from a text file. the text file is located at %PATROL_HOME%\TROMS\Conf\ImportDevices.

Script.cfg

Contains configuration variables to configure scripts located on a remote device.

DefaultConfiguration.cfg

Contains configuration variables to set pre-defined or default values for the configuration fields to monitor the scripts.

You can set up default configuration for the following configuration fields:

  • Port
  • Device Poll Interval
  • Device Timeout (sec)
  • User name
  • Password
  • Script Poll Interval
  • Script Timeout

Following template of the All.cfg file contains configuration variables to configure the scripts in Linux environment.

Click here to see the list of configuration variables in Windows environment

"/TROMS/txn_id" = { REPLACE = "1"},
"/TROMS/TROMS_Root/Devices/<<MyDevice>>/DeviceName" = { REPLACE = "<<MyDevice>>"},
"/TROMS/TROMS_Root/Devices/<<MyDevice>>/ipAddress" = { REPLACE = "<<ip>>"},
"/TROMS/TROMS_Root/Devices/<<MyDevice>>/Category" = { REPLACE = "<<Network>>"},
"/TROMS/TROMS_Root/Devices/<<MyDevice>>/DevicePollInterval" = { REPLACE = "<<300>>"},
"/TROMS/TROMS_Root/Devices/<<MyDevice>>/DeviceTimeout" = { REPLACE = "<<120>>"},
"/TROMS/TROMS_Root/Devices/<<MyDevice>>/portNumber" = { REPLACE = "<<5985>>"},
"/SecureStore/TROMS/TROMS_Root/Devices/<<MyDevice>>/AuthorizationCred" = { REPLACE = "TROMS_Root/<<username/password>>"},
"/TROMS/TROMS_Root/Devices/<<MyDevice>>/authentication" = { REPLACE = "<<0=Kerberos,1=Negotiate,2=Use shared authentication>>"},
"/TROMS/TROMS_Root/Devices/<<MyDevice>>/connectionProtocol" = { REPLACE = "<<0=HTTP,1=HTTPS,2=Use shared protocol>>"},
"/TROMS/TROMS_Root/Devices/<<MyDevice>>/Scripts/<<MyScript1>>/ScriptName" = { REPLACE = "<<MyScript1>>" },
"/TROMS/TROMS_Root/Devices/<<MyDevice>>/Scripts/<<MyScript1>>/Path" = { REPLACE = "<<Full path contains the script name locate on the remote device(e.g: C:/BMC/apps/TSPS_CPU.bat) or a shell command.
The script will be copied automatically if it does not exist on the remote device but exist on the monitoring system(%PATROL_HOME%/TROMS/Conf/Scripts/ScriptFileTransfer/Devices/DeviceName or %PATROL_HOME%/TROMS/Conf/Scripts/ScriptFileTransfer or %PATROL_HOME%/TROMS/Conf/Scripts/Samples)>>" },
"/TROMS/TROMS_Root/Devices/<<MyDevice>>/Scripts/<<MyScript1>>/Arguments" = { REPLACE = "<<MyScript1Args>>" },
"/TROMS/TROMS_Root/Devices/<<MyDevice>>/Scripts/<<MyScript1>>/ScriptPollInterval" = { REPLACE = "300" },
"/TROMS/TROMS_Root/Devices/<<MyDevice>>/Scripts/<<MyScript1>>/ScriptTimeout" = { REPLACE = "120" },
"/TROMS/TROMS_Root/Devices/<<MyDevice>>/Scripts/<<MyScript1>>/RegEx" = { REPLACE = "<<regular expression>>" },
"/TROMS/TROMS_Root/Devices/<<MyDevice>>/Scripts/<<MyScript2>>/ScriptName" = { REPLACE = "<<MyScript2>>" },
"/TROMS/TROMS_Root/Devices/<<MyDevice>>/Scripts/<<MyScript2>>/Path" = { REPLACE = "<<Full path contains the script name locate on the remote device(e.g: C:/BMC/apps/TSPS_CPU.bat) or a shell command.
The script will be copied automatically if it does not exist on the remote device but exist on the monitoring system(%PATROL_HOME%/TROMS/Conf/Scripts/ScriptFileTransfer/Devices/DeviceName or %PATROL_HOME%/TROMS/Conf/Scripts/ScriptFileTransfer or %PATROL_HOME%/TROMS/Conf/Scripts/Samples)>>" },
"/TROMS/TROMS_Root/Devices/<<MyDevice>>/Scripts/<<MyScript2>>/Arguments" = { REPLACE = "<<MyScript2Args>>" },
"/TROMS/TROMS_Root/Devices/<<MyDevice>>/Scripts/<<MyScript2>>/ScriptPollInterval" = { REPLACE = "300" },
"/TROMS/TROMS_Root/Devices/<<MyDevice>>/Scripts/<<MyScript2>>/ScriptTimeout" = { REPLACE = "120" },
"/TROMS/TROMS_Root/Devices/<<MyDevice>>/Scripts/<<MyScript2>>/RegEx" = { REPLACE = "<<regular expression>>"},
"/TROMS/TROMS_Root/Shared_portNumber" = { REPLACE = "<<5985>>"},
"/TROMS/TROMS_Root/Shared_DevicePollInterval" = { REPLACE = "<<300>>"},
"/TROMS/TROMS_Root/Shared_DeviceTimeout" = { REPLACE = "<<120>>"},
"/SecureStore/TROMS/TROMS_Root/Shared_AuthorizationCred" = { REPLACE = "TROMS_Root/<<username/password>>"},
"/TROMS/TROMS_Root/Shared_authentication" = { REPLACE = "<<0=Kerberos,1=Negotiate>>"},
"/TROMS/TROMS_Root/Shared_connectionProtocol" = { REPLACE = "<<0=HTTP,1=HTTPS>>"},
"/TROMS/TROMS_Root/Shared_ScriptPollInterval" = { REPLACE = "<<300>>"},
"/TROMS/TROMS_Root/Shared_ScriptTimeout" = { REPLACE = "<<120>>"},
"/TROMS/TROMS_Root/RootDisplayName" = { REPLACE = "<<Script>>"},
"/TROMS/TROMS_Root/DeviceMapping" = { REPLACE = "<<0(No) or 1(Yes: FQDN) or 2(Yes: User defined)>>"},
"/TROMS/TROMS_Root/CustomMonitorTypesCleanup" = { REPLACE = "<<0=Disable,1=Daily,2=Weekly,3=Monthly>>"},
"/TROMS/TROMS_Root/TrustedHosts" = { REPLACE = "<<0=Disable,1=All,2=Device>>"},
"/TROMS/TROMS_Root/ReadFromFile" = { REPLACE = "<<1>>"},
"/TROMS/TROMS_Root/Debug" = { REPLACE = "<<1(Yes) or 0(No)>>"}

Configuration variables for Scripts configuration

The following table provides information about the configuration variables for configuring the scripts you want monitor. You can use PATROL Configuration Manager to add values to the variable for configuring scripts. 

Note

The value Manual in the value column of the table indicates that there is no predefined value for the configuration variable and you must manually enter a value for those variables.

Click here to see the variables used in Windows monitoring profile

Variable

Description

Operation

Value

Device configuration details

/TROMS/txn_id

Activates the device configuration.

Replace

1

/TROMS/TROMS_Root/Devices/<<MyDevice>>/DeviceName

Alias name or a real host name or IP address of the device.

Replace

Manual

/TROMS/TROMS_Root/Devices/<<MyDevice>>/ipAddress

IP address of the device you want to monitor, if you have not provided the actual host name or IP address.

Replace

Manual

/TROMS/TROMS_Root/Devices/<<MyDevice>>/Category

Category name to group the devices.

Replace

Manual

/TROMS/TROMS_Root/Devices/<<MyDevice>>/DevicePollInterval

Poll interval time in seconds.

Replace

Manual

/TROMS/TROMS_Root/Devices/<<MyDevice>>/DeviceTimeout

Connection timeout in seconds.

Replace

Manual

/TROMS/TROMS_Root/Devices/<<MyDevice>>/portNumber

PowerShell number to connect to the configured device.

Replace

Manual

/SecureStore/TROMS/TROMS_Root/Devices/<<MyDevice>>/AuthorizationCred

Authorization user credentials.

 

 

/TROMS/TROMS_Root/Devices/<<MyDevice>>/authentication

Authentication type: Negotiate or Kerberos. 

 

 

/TROMS/TROMS_Root/Devices/<<MyDevice>>/connectionProtocol

Connection protocol: 0 (HTTP) or 1 (HTTPS) or 2 (Use shared protocol)

 

 

Script details

/TROMS/txn_id

Activates the remote script configuration.

Replace

1

/TROMS/TROMS_Root/Devices/<<MyDevice>>/Scripts/<<MyScript1>>/ScriptName

Script display name that can be used to identify the script.

Replace

Manual

/TROMS/TROMS_Root/Devices/<<MyDevice>>/Scripts/<<MyScript1>>/Path

Full path to the script file located on the local device. For example: C:\DATA\Scripts\TopProcesses.bat) or a PowerShell command.

The script gets copied automatically if it does not exist on the remote device but exist on the monitoring system:
 %PATROL_HOME%/TROMS/Conf/Scripts/ScriptFileTransfer/Devices/DeviceName or 
%PATROL_HOME%/TROMS/Conf/Scripts/ScriptFileTransfer or 
%PATROL_HOME%/TROMS/Conf/Scripts/Samples.

Replace

Manual

/TROMS/TROMS_Root/Devices/<<MyDevice>>/Scripts/<<MyScript1>>/Arguments

Script arguments that will be passed during the script execution. The arguments must be separated by a space character.

Replace

Manual

/TROMS/TROMS_Root/Devices/<<MyDevice>>/Scripts/<<MyScript1>>/ScriptPollInterval

Script execution frequency in seconds. The minimum value is 10 seconds and the maximum value is 3600 seconds.

Replace

Manual

/TROMS/TROMS_Root/Devices/<<MyDevice>>/Scripts/<<MyScript1>>/ScriptTimeout

Script timeout in seconds.

Replace

Manual

/TROMS/TROMS_Root/Devices/<<MyDevice>>/Scripts/<<MyScript1>>/RegEx

A regular expression to search on the script results. Use a semicolon to separate multiple regular expressions. For example, expressionA;expressionB;expressionC

Replace

Manual

/TROMS/TROMS_Root/Devices/<<MyDevice>>/Scripts/<<MyScript2>>/ScriptName

Script display name that can be used to identify the script.

Replace

Manual

/TROMS/TROMS_Root/Devices/<<MyDevice>>/Scripts/<<MyScript2>>/Path

Full path to the script file located on the local device. For example: C:\DATA\Scripts\TopProcesses.bat) or a PowerShell command.

The script gets copied automatically if it does not exist on the remote device but exist on the monitoring system:
 %PATROL_HOME%/TROMS/Conf/Scripts/ScriptFileTransfer/Devices/DeviceName or 
%PATROL_HOME%/TROMS/Conf/Scripts/ScriptFileTransfer or 
%PATROL_HOME%/TROMS/Conf/Scripts/Samples.

Replace

Manual

/TROMS/TROMS_Root/Devices/<<MyDevice>>/Scripts/<<MyScript2>>/Arguments

Arguments that will be passed during the script execution. The arguments must be separated by a space character.

Replace

Manual

/TROMS/TROMS_Root/Devices/<<MyDevice>>/Scripts/<<MyScript2>>/ScriptPollInterval

Script execution frequency in seconds. The minimum value is 10 seconds and the maximum value is 3600 seconds.

Replace

Manual

/TROMS/TROMS_Root/Devices/<<MyDevice>>/Scripts/<<MyScript2>>/ScriptTimeout

Script timeout in seconds.

Replace

Manual

/TROMS/TROMS_Root/Devices/<<MyDevice>>/Scripts/<<MyScript2>>/RegEx

A regular expression to search on the script results. Use a semicolon to separate multiple regular expressions. For example, expressionA;expressionB;expressionC

Replace

Manual

Configuration file based monitoring

 

 

 

/TROMS/txn_id

Activates the file based script configuration.

Replace

1

/TROMS/TROMS_Root/ReadFromFile

Enable this option to configure devices to be monitored automatically from file-based configuration.

Place the files at $PATROL_HOME\TROMS\Conf\ImportDevices\

You can have multiple files for configuring devices and must specify an appropriate name to the files. These devices will be grouped under these files.

Replace

  • 0: No
  • 1: Yes

Default configuration

/TROMS/txn_id

Activates the shared script configuration.

Replace

1

/TROMS/TROMS_Root/Shared_portNumber

Port number to connect to the configured device.

Replace

Manual

/TROMS/TROMS_Root/Shared_DevicePollInterval

Poll interval time in seconds.

Replace

Manual

/TROMS/TROMS_Root/Shared_DeviceTimeout

Connection timeout in seconds. The minimum value is 1 second and the maximum value is 600 seconds.

Replace

Manual

/SecureStore/TROMS/TROMS_Root/Shared_AuthorizationCred

Authorization user credentials.

Replace

Manual

 /TROMS/TROMS_Root/Shared_authentication

Authentication type: Negotiate or Kerberos.

Replace

Manual

/TROMS/TROMS_Root/Shared_connectionProtocol

Connection protocol: HTTP or HTTPS.

Replace

Manual

/TROMS/TROMS_Root/Shared_ScriptPollInterval

Script frequency in seconds. The minimum value is 10 seconds and the maximum value is 3600 seconds.

Replace

Manual

/TROMS/TROMS_Root/Shared_ScriptTimeout

Script timeout in seconds. The minimum value is 1 second and the maximum value is 600 seconds.

Replace

Manual

Administration

/TROMS/txn_id

Activates the configuration.

Replace

1

/TROMS/TROMS_Root/RootDisplayName

Root application class display name that can be used to identify the location of the device.

Replace

Manual

/TROMS/TROMS_Root/DeviceMapping

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 alias name and the force IP address configured, the device will mapped to 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 alias name provided with the end user
  • Disable - Monitors are created within the device of the PATROL Agent(s)

Replace

  • 0: Disable
  • 1: Displays FQDN as the device name of the network device in the Operations Console
  • 2: Displays user defined name (alias name) as the device name of the network device in the Operations Console.

/TROMS/TROMS_Root/CustomMonitorTypesCleanup

Option to set automatic clean up of the old monitor types that are not in use. 

Replace

  • 0: Disable
  • 1: Daily
  • 2: Weekly
  • 3: Monthly

/TROMS/TROMS_Root/TrustedHosts

Add the remote device to the list of trusted hosts for monitoring in WinRM. Trusted host options:

  • Disable - Disables addition of devices to the trusted hosts. By default, this option is enabled
  • All - Allows connection to all of the remote hosts by setting the value to * to the WinRM trusted hosts
  • Device - Adds the remote device to the WinRM trusted hosts

 

 

/TROMS/TROMS_Root/Debug

Enable logging. Log files will be created in the $PATROL_HOME\TROMS\logs directory.

0: Debug off

1: Debug on

Replace

Manual

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*