Important This documentation space contains information about PATROL Agents when deployed in a BMC Helix Operations Management environment. If you are a TrueSight Operations Management user, see PATROL Agent 23.1

Environment variables

PATROL uses environment variables to control the environment in which the PATROL Agent runs. 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.

Related topics

PATROL Agent components

Key-concepts

List of environment variables

The following table lists alphabetically environment variables that affect the agent. 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 the PATROL Agent

 

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 the 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
U — UNIX
W — Windows
ALL — All platforms