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.

Related topics

PATROL-Agent-components

Key-concepts

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

 

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
C7 — PATROL 7.x consoles only
CS — PATROL Console Server only
U — UNIX
W — Windows
ALL — All platforms

RTSERVERS environment variable

The RTSERVERS environment variable tells the agent which RTserver(s) to connect to, for example: tcp:nebula:2059. 

The agent connects to the first RTserver in the list. If the connection breaks, the agent connects to the next RTserver in the list. 

You must set the RTSERVERS environment variable in either of the following situations:

  • You want to view PATROL Agent data from a PATROL 7.x console.
  • There is no RTserver installed on a computer in the same subnet.
  • The RTserver is not using the default port number of 2059.

The PATROL Console Server, PATROL Agent, and PATROL 7.x consoles can detect RTservers within their own subnets, but they cannot detect RTservers outside of their own subnets. If you have installed one of those components in a subnet that has no RTserver, the only way it can communicate with an RTserver is if you define the RTSERVERS environment variable. 

The format of the RTSERVERS environment variable is as follows:
tcp: computer_name: port_number 

where computer_name is the name of a computer running an RTserver (a member of the RTserver cloud), and port_number is the port number that it is using to broadcast.