Agent setup variables

In the PATROL Agent Configuration Utility, the variables listed in the following table are located in /AgentSetup.

Variable	Description	Format	Reference
_name_	PATROL Agent Setup	Text string (without spaces)	Cannot be changed
_trailing_comma_	Need for internal operations	Text string (without spaces)	Cannot be changed
_type_	PATROL Agent Setup type	Text string (without spaces)	Cannot be changed
accessControlList	Determines which users can access the agent from which hosts in which connection mode	User/host/mode	Controlling access to the agent
accessDenyList	Denies access to any user, host, or connection mode and takes precedence over the accessControlList	User/host/mode	Denying access to the agent
aclGrpCacheExpirationTime	Sets the interval, in seconds, after which group membership will be rechecked; variable is turned off by default	Numeric	Not applicable
<application>.filterList	Specifies a set of application instances that you want to include or exclude from monitoring, depending upon the type of filter	Text string (no spaces)	Choosing an inclusive or exclusive filter
<application>.filterType	Determines the type of filter for a corresponding filter list You must create this variable.	Text string (no spaces)	Editing list to filter by application or regular expression
<appl>.OSdefaultAccount	Specifies an account under which the agent runs all parameter and recovery actions for the application	Text string (no spaces)	Setting the PATROL Agent account for applications
<appl.instName>.OSdefault Account	Specifies an account under which the agent runs all parameter and recovery actions for the application instance	Text string (no spaces)	Setting the PATROL Agent account for instances
<appl.instName>.OSdefault AccountAppliesToCmds	Determines whether commands issued from the console run under the console log-in account or the <appl>.OSdefaultAccount	Boolean (yes, no)	Using the application-specific account for commands
auditLog	Enables audit logging and restricts the number of messages	See Changing the UNIX display environment.	Agent audit log
BindToAddress	Specifies which IP Address the PATROL Agent uses to communicate in a system with multiple network cards	Numeric	Connecting to systems having multiple network cards
Blackout	Configures blackouts for PATROL objects	Text string	Configuring a blackout by using pconfig
comSecurityLevel	Controls the level of information provided by the PATROL Agent to the DCOM client	Alphabetic range	Setting PATROL Agent configuration variables
comUserAllowed	Controls who can access the PATROL Agent DCOM server based upon group names and user names	Text string	Setting PATROL Agent configuration variables
defaultAccountShell	Allows you to specify which shell the PATROL Agent uses for the process spawned by the PATROL Agent default account.	Text string (shell name)	Setting the PATROL Agent default account shell
defaultDisplay	Controls where UNIX applications display their output	Text string (no spaces)	Changing the UNIX display environment
disabledKMs	Prevents KMs from being loaded for all operating systems and computer types specified	Text string (comma-separated list)	Disabling applications based on application name
disabledKMsArch	Prevents KMs from being loaded for a particular operating system and computer type	Text string (comma-separated list)	Disabling applications based on architecture
EnableSysOutputAclCheck	Allows you to use the S option in an ACL to restrict or allow display of the system output window and command task creation	Boolean (0/1) Disable=0 Enable=1	Controlling the system output window display
ExternalOverride	Determines which file to use for parameter override values	Text string indicating a file name The string can contain macro variables.	External override file names
ExternalOverridePolltime	Determines how often the PATROL Agent checks the external file for parameter override changes	Integer, seconds	External override file poll cycle
fixHistFlag	Sets backup and repair options for the history files	Text string (comma-separated list)	Overview of the fixHistFlag configuration variable
historyRetentionPeriod	Determines number of days that collected parameter values are kept	Numeric (days)	Setting the number of days that history is retained in the history database
hostDomainName	Set this variable to the FQDN of the monitored host computer. This configuration variable has the highest priority. PATROL Agent sets the domain name of the monitored device in the following sequence: From the /AgentSetup/hostDomainName configuration variable. From the `BMC_PATROL_HOST_DOMAIN_NAME` environment variable, if the /AgentSetup/hostDomainName configuration variable is not set. Note: In a UNIX environment, this environment variable is set by the patrolrc.sh script. From the FQDN returned by System API, if the `BMC_PATROL_HOST_DOMAIN_NAME` environment variable is not set.	Text string	Not applicable
IPAddresses	Lists all the possible IP addresses through which the agent can communicate	Numeric (IP Address)	Recognize additional IP addresses
loadOnlyPreloadedKMs	Disables all KMs except those that are preloaded	Boolean (yes, no)	Disabling applications based on exclusion
maxAgentMessageLimit	Determines the number of messages written to the PATROL Agent error log	Numeric	Limiting size by restricting the number of messages
maxEventSize	Sets the maximum acceptable event size in bytes; the default value is 48000	Numeric	Not applicable
maxProcessLimit	Limits the number of processes that can run simultaneously	Numeric	Limit the number of processes run simultaneously
pconfigRequires Authentication	Controls pconfig access to the agent	Boolean (yes, no)	Controlling pconfig access to the agent
pemCacheSize	Sets the size of the cache used by the agent for event management	Numeric	Setting the cache size
pemCommands_default Account	Establishes an account under which all PEM commands are run	Text string (no spaces)	Setting the default account for PEM commands
pemCommands_policy	Specifies which account PEM commands will run under: Agent default, User, or PEM	Alphabetic	Setting the default account for PEM commands
pemEvMemRetention	Sets the number of events the PEM engine keeps in memory for each object	Numeric	Extracting event data from the PEM log
pemIssueV30traps	Determines whether PATROL uses PATROL Version 3.0 formats to issue SNMP traps	Boolean (yes, no)	Set SNMP trap format
pemIssueV31traps	Determines whether PATROL uses PATROL Version 3.1 formats to issue SNMP traps	Boolean (yes, no)	Set SNMP trap format
pemLogName	Sets the name of the event log repository	Text string (no spaces)	Naming the event log file
pemLogSize	Sets the maximum size of the event log	Numeric	Setting the event log file size
pemPFSnmpPattern	Establishes the pattern you want to filter for in the description of the event	Text string	Filter events based on PATROL event description
pemPFSnmpStatusMask	Sets the event statuses you want to filter	Alphabetic range	Filter traps based on PATROL event status
pemPFSnmpTypeMask	Sets the event types you want to filter	Alphabetic range	Filter traps based on PATROL event type
pemPFSnmpEidRange	Sets the range of event IDs you want to filter	Numeric	Filter traps based on PATROL event ID
pemPFSnmpEndTime	Sets the end time	MMDDhhmm[yy] (date, time, and year, which is optional)	Specify a time period to send traps based on PATROL Events
pemPFSnmpEvClass	Sets the event class you want to filter	Text string (event class name)	Filter traps based on PATROL Event class
pemPFSnmpNSeverity	Sets the severity level that triggers SNMP traps	Numeric (range 0-5)	Filter traps based on PATROL Event severity level
pemPFSnmpNode	Specifies the node where the event occurred	Text string	This variable is reserved for future use.
pemPFSnmpOrigin	Specifies the application where the event occurred	Text string	Specify application that issued the trap
pemPFSnmpStartTime	Sets the start time	MMDDhhmm[yy]	Specify a time period to send traps based on PATROL Events
pemSnmpSupport	Determines whether PEM triggers SNMP events	Boolean (yes, no)	SNMP support based on PATROL Event Manager
PerfGetDebugFile	Specifies debug file for the persistent data collection program	Text string	Specifying the debug file
PerfGetMaxTimes	Determines the number of data points collected by the persistent data collection program before it restarts	Numeric	Retries
PerfGetTimeout	Determines how long the agent waits for a response from the persistent data collection program	Numeric (milliseconds)	Timeout
PerfMaxRestartCount	Limits the number of patrolperf instances the PATROL Agent can spawn.	Numeric (number of processes)	Controlling the number of processes
PortConnectType	Specifies which network card (NIC) the PATROL Agent uses to communicate	Text string	Connecting to systems having multiple network cards
preloadedKMs	Specifies which KMs are preloaded for all operating systems and computer types	Text string (comma-separated, item list)	Preloading applications based on application name
preloadedKMsArch	Specifies which KMs are preloaded for particular operating system and computer types	Text string (comma-separated, item list)	Preloading applications based on architecture
prmHistCacheFlushTimer	Sets the period of time (interval at which) that the cache is flushed to the history database	Numeric	Flushing the agent cache based on a time interval
prmHistCacheSize	Sets the number of data points kept in cache	Numeric	Flushing the agent cache based on the number of data points
PslDebug	Sets the run-time error level for PSL	Numeric	Set PSL run time error level
requiresconfigauthentication	Restricts access to the agent configuration database from the pconfig, wpconfig, xpconfig, and PATROL Configuration Manager (PCM) clients		Securing PATROL Agent from the pconfig clients
sessionsInitMayFail	Determines whether the PATROL Agent will run if no sessions to the PATROL Console can be established	Boolean (yes, no)	Setting the agent to run without a console connection
snmpConfigAccess	Determines whether SNMP support can write to the configuration database	Boolean (0/1)	Debugging PSL functions for SNMP
staticApplication	Specifies a list of static applications. The applications are marked as static if they are dynamically loaded	Text string (comma-separated, item list)	Designating applications as static
suppressConsoleInfoMsg Mask	Controls whether PEM messages are logged in the agent error log and are displayed in the PEM Console or excluded from the log and not displayed in the PEM Console	Alpha character (ACDOP)	Setting the PATROL Agent default account
suppressSystemOutput MsgMask	Suppresses or allows the display of KM-related messages in the system output window	Boolean (yes, no) Default value is no.	Controlling the display of messages in the system output window
timeZone	Allows you to define time zones that do not exist in the PATROL Agent time zone table	TimeZone/Offset Value	Adding time zones to PATROL
textParameterLength	Limits the length of text parameter data that is streamed from the PATROL Agent to the TrueSight Infrastructure Management.	Numeric	Limiting the length of the PATROL Agent data

Agent setup variables

Comments