PATROL Agent configuration variables for BMC PATROL for BMC Server Automation

The variables described in this section are BMC PATROL for BMC Server Automation variables that are set in the PATROL Agent configuration file.
 You can use the PATROL Configuration Manager or the wpconfig utility or xpconfig utility to view variable settings or to deploy them to other computers.
 See the PATROL Configuration Manager User Guide or the PATROL Agent Reference Manual for more information at PDF product guides.

Note

Some of the variables described in this section may not appear in your environment. Some variables exist only when their corresponding features are enabled or when non-default performance options are selected.

Warning
  • Do not make changes to any variable that does not appear in the following table. Doing so might prevent some functions from working correctly and can affect your entire installation.
  • BMC recommends that you use a console to set agent configuration variables to configure the product.

Table of agent configuration variables

Note

The password is not stored in the pconfig configuration file. To configure a password, enter it under the following path /ZXY/<SID of the instance name>_Pass


Variable

Description

Location

ComponentsToMonitor

This variable is not configurable. Do not make changes

/ZXY/Default/Filters/ComponentsToMonitor

Exist

This variable is not configurable. Do not make changes

/ZXY/ServerAutomation/Exist

AllOSTypes

This variable is not configurable. Do not make changes

/ZXY/Servers/<SID>/Filters/AllOSTypes

The following variables are used to configure an application server. The Server ID (SID) is usually hostname_port

hostName

Host name or IP of an Automation server that you want to monitor.

/ZXY/Servers/<SID>/hostName

port

Port used by an application server on this host

/ZXY/Servers/<SID>/port

instanceName

The instanceName must be identical to the SID)

/ZXY/Servers/<SID>/instanceName

AuthenticationServerName

name of the authentication server

/ZXY/Servers/<SID>/AuthenticationServerName

AuthenticationServerPor

Port used by the authentication server

/ZXY/Servers/<SID>/AuthenticationServerPort

userName

User name of the account used to access the application server

/ZXY/Servers/<SID>/userName

protocol

protocol used for communication with the application server

/ZXY/Servers/<SID>/protocol

role

Role asigned to this user

/ZXY/Servers/<SID>/role

The following variables are used to configure filtering.

ComponentsToMonitor

defines which components to monitor, With "|" separated values containing the component's name (case insensitive), as in the following example:
|ClientConnections|ConnectionPool|Threads|JVM|FileManager|Events|

/ZXY/Servers/<SIDt>/Filters/ComponentsToMonitor

OSTypesToMonitor

sets managed hosts OS type filtering. In order to configure managed hosts OS type filtering, allow for one cycle of managed hosts collection to run, in order for the OS type list to be discovered, and then set the following variable according to the desired OS. The discovered OS values are displayed in the following variable /ZXY/Servers/<SID>/Filters/AllOSTypes

/ZXY/Servers/<SID>/Filters/OSTypesToMonitor

ManagedHostsDisplayNam

sets the managed hosts display name The valid values are (case insensitive):
IP, FQDN, Name

/ZXY/Servers/<SID>/Filters/OSTypesToMonitor

UpdateManagedHostsStatus

update the managed hosts' statuses (0 - disabled, 1 - enabled)

/ZXY/Servers/<SID>/Filters/UpdateManagedHostsStatus

The following variables are used to set the global values of the KM

debugEnabled

enables the PSL debug (0 - disabled, 1 - enabled). Default value is 0.

/ZXY/Default/Debug/debugEnabled

RCP_CLIENT_ENV_VAR_NAME

sets RCP Home. Default value is blank.

/ZXY/Default/RCP_CLIENT_ENV_VAR_NAME

JAVA_HOME

sets Java Home. Default value is blank.

/ZXY/Default/JAVA_HOME

The following variables are used to configure the external Java Collector settings.

CommandTimeout

Timeout (seconds) if no response is received in the defined time. Default value is 120.

/ZXY/Default/ExternalCollectorSetting/CommandTimeout

ConnectionPoolMax

Maximum number of connections permitted for each application server. Default value is 2.

/ZXY/Default/ExternalCollectorSetting/ConnectionPoolMax

ConnectionPoolMin

Mimimum number of connections permitted for each application server. Default value is 1.

/ZXY/Default/ExternalCollectorSetting/ConnectionPoolMin

ConnectionTimeout

sTimeout (Seconds) if no connection is made. Default value is 120.

/ZXY/Default/ExternalCollectorSetting/ConnectionTimeout

debug

Enable to commence debug and create a debug file. The debug file is saved to ..\BMC Software\Patrol3\ZXY_JavaCollector.txt

/ZXY/Default/ExternalCollectorSetting/debug

DebugFileNam

You can use the default file name or enter a new name.

/ZXY/Default/ExternalCollectorSetting/DebugFileName

OperationTimeout_InSec

Not configurable

/ZXY/Default/ExternalCollectorSetting/OperationTimeout_InSec

SetMaxThreads

Maximum number of threads created for the Java collector process. Default value is 1000.

/ZXY/Default/ExternalCollectorSetting/SetMaxThreads

SetMinThreads

Minimum number of threads created for the Java collector process. Default value is 100.

/ZXY/Default/ExternalCollectorSetting/SetMinThreads

 

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