Environment variables
PATROL uses environment variables to control the environment in which the PATROL Agent and PATROL Console run. The following sections list all PATROL environment variables, describes the purpose of each, provides a default value, and indicates which PATROL components and which platforms the variable affects.
List of environment variables
The following table lists alphabetically environment variables that affect the agent, the console, or both. In the Default column, the table uses UNIX naming conventions: a dollar sign to indicate a variable and a forward slash (/) to delimit directories. These default values, after making the appropriate platform substitutions, apply to all platforms listed in the C\P column for the respective environment variable. For the values of the components listed in the "C/P" column, see Supported components and platforms for environment variables.
Environment variables used by PATROL Console and PATROL Agent
Environment variable | Default | Description | C\P |
|---|---|---|---|
BMC_PATROL_DEBUG_ PEMAPI | none | Variable that redirects the PEM application debug log messages | |
BMC_ROOT | /opt/bmc | Top level directory for all BMC products | ALL |
COMSPEC | c:\command.com | COMMAND Interpreter used for Windows | W |
DUMP_CORE_ON_XT _ERROR | Dump core due to malloc errors | ||
ETC_HOSTS_SCRIPT | NULL | ||
GETHOSTENT_WORK AROUND | NULL | ||
HOME | $HOME | Environment variable where the PATROL Console writes its customizations | U |
PATROL_ADMIN | patrol | Set to user that is to own log files that the PATROL Agent writes | A, |
PATROL_ARCHIVE | $PATROL_HOME/../ archives | TOC files stored here | ALL |
PATROL_BIN | $PATROL_HOME/bin | Location of the PATROL binary files | B, |
PATROL_CACHE | $HOME/patrol | Console directory for KM customizations | C, |
PATROL_CFG | $HOME/patrol/config | Console directory where xpconfig stores agent configuration files | ALL |
PATROL_CONFIG | $PATROL_HOME/config | Directory where the agent configuration database is stored | A, |
PATROL_CONFIG_ PORT | none | A, | |
PATROL_DEBUG | none | Variable that sets the debug level when the | ALL |
PATROL_DESKTOP | $HOME/patrol/desktop | Local directory where desktop configurations are stored | C, |
PATROL_GLOBAL _LIB | $PATROL_HOME/lib | Global PATROL library directory | B, |
PATROL_HEARTBEAT_ | 4000 (milliseconds) | Sets the timeout retry interval, in | ALL |
PATROL_HELP | $PATROL_GLOBAL_LIB/ app-defaults/help | Directory containing help files | C, |
PATROL_HISTORY | $PATROL_LOG/history | Location of parameter history data files | A, |
PATROL_HISTORY_ PORT | none | A, | |
PATROL_HOME | $PATROL_HOME/ platform | Main install directory for PATROL platform-specific files | B, |
PATROL_KM | $PATROL_GLOBAL_LIB/ knowledge | Global KM directory | B, |
PATROL_LOCAL_CHART | $PATROL_CACHE/chart | Location where the Chart Utility stores preferences | |
PATROL_LOCAL_KM | $PATROL_CACHE/ knowledge | Local KM directory | C |
PATROL_LOCAL_PSL _APPS | $PATROL_CACHE/psl | Local PSL directory | C |
PATROL_LOG | $PATROL_HOME/log | PATROL Agent log directory | A |
PATROL_LOG_PORT | $PATROL_HOME/log | Location of the PATROL Agent error log file | A |
PATROL_MACHINE _TYPE | 'platform' | Override for the PATROL Machine Type response. Useful on SVR4 machines that need a different icon. | U |
PATROL_MAXLOG | 5 | limits the number of error log backup files | A |
PATROL_MAX_FILE _DESCRIPTORS | 1024 | B, | |
PATROL_MIBFILE | none | MIB file name for SNMP support (used only if not set in agent's configuration). | |
PATROL_PORT | 3181 | See Setting the default port number on UNIX Only. | A, |
PATROL_PSL_APPS | $PATROL_GLOBAL_LIB/ psl | Global PSL directory | B, |
PATROL_QRY | $HOME/query | Local directory where query results are stored from Agent Query | C, |
PATROL_REMOTE | $PATROL_HOME/remote | Directory where received remote file transfers are written | A, |
PATROL_SOUNDS | $PATROL_GLOBAL_LIB/ sounds | Location of PATROL Sounds directory | C, |
PATROL_TMP | $PATROL_CACHE/tmp | Override for $TMP | C, |
PATROL_ VIRTUALNAME | none | Cluster-specific variable for history and configuration | |
PATROL_ VIRTUALNAME_PORT | none | Cluster-specific variable for history and configuration | |
SPEAKER | $PATROL_HOME/bin/ player | Executable location to play sounds | |
TMP | $TMP | Override for /tmp | |
TMP_PATROL | $PATROL_HOME/log | On NFS mounted file systems, this variable | A, |
XBMLANGPATH | $PATROL_GLOBAL_LIB/images | Images subdirectory | C, |
XKEYSYMDB | $PATROL_GLOBAL_LIB/ | File with X defaults | C, |
YPCAT_HOSTS_SCRIPT | NULL |
Supported components and platforms for environment variables
Environment variables can affect one or both of the PATROL components. Most of the variables created for PATROL run on all platforms, but not all variables do.
For each variable, the C\P column in Environment variables used by PATROL Console and PATROL Agent lists which components the variables affect and on which platforms they are valid. The values are as follows:
A — PATROL Agent only
B — Both PATROL Console and PATROL Agent
C — PATROL Console only
U — UNIX
W — Windows
ALL — All platforms
Comments
Log in or register to comment.