Command line arguments for starting the PATROL Agent

This section lists the command line arguments for the PATROL Agent. It also explains about the RTServers configuration and environment variables.

The following table lists command line arguments for the PATROL Agent:

Command line arguments for starting PATROL Agent

Argument

Function

-config <changefile> <name> -batch

Processes a pconfig-style configuration file
Multiple files are specified by separating them with commas (no intervening spaces). Use standard input if "-" is specified instead of a file name.
The -batch argument causes the agent to exit after processing configuration options instead of starting up. It is optional.

-help

Displays a list of command line arguments

-i

Disables heartbeat

-id <name>

The -id option enables you to override the agent service name that is registered with the RTserver. By default, PATROL Agents register with the RTserver as hostname_portno. For example, starting a PATROL Agent on host nebula with the following command:

PatrolAgent -p 3181 -rtserver tcp:nebula:2059 registers the agent with the service nameNEBULA_3181.

If you use the -id option, for example the command PATROLAgent -p 3181 -id newhost registers the agent with the name newhost.

Use this feature if you have several hosts with the same name in different domains that are all running PATROL Agents and using the same RTserver. If each host tried to register with the same RTserver using the default service name, only one host could register. The -id option enables you to register an agent with the RTserver under a different name than the default.

-install

Installs the agent as a service on Microsoft Windows platforms.

You can add one or both of the following options:
-llognode directs the agent to create a custom Windows Event Log with the name lognode to receive agent error log messages. This command creates the log node. To begin writing events to the custom Windows Event Log, the /AgentSetup/auditLog configuration variable needs to be set to 2 (log to Windows Event Log only) or 3 (log to Windows Event Log and to regular agent error log file). You must restart the agent for the changes to the /AgentSetup/auditLog variable to take effect.
-rcosServiceName specifies a custom agent name to identify itself in the PATROL Central Infrastructure.
Restart your computer for the -l option to take effect, unless you are installing the agent as a service for the first time.

-km <KM name>

Loads initial KM; to load multiple KMs, you must specify -km for each KM you want to load. For example:
 ./PatrolAgent -p 1234 -km UNIX3.kml -km BASE3.kml
Specifying the .kml extension ensures that a .kml file with the same name as a .km file is loaded.

-O <LMP>

PSL Optimizer Options: -O[L#][M#][P#]

Optimization level [L#]
0–no optimization
1–enable level 1 optimization
2–enable level 2 plus level 1 optimization
3–enable level 3 plus level 2 optimization

Maximum Level Allowed [M#]
0-3 –maximum allowable optimization level

Optimization print level [P#]
0–disable optimization printing
1–print optimization statistics
2–level 1 plus print process instruction execution count
3–level 2 plus print program flowgraph

-p <portNo> or -port <portNo>

Agent connection port (default port is 3181)

-profiling [<logfile>]

Activates PSL profiling Data is only written to the file at agent termination.

-integrationservice <protocol>:<host>:<portNumber>, <protocol2>:<host2>:<portNumber2>

Tells the agent which Integration Service(s) to connect to, for example: PatrolAgent -integrationservice tcp:houperfms318:3183.
You can provide multiple Integration Service(s) by providing a comma-separated list.
The agent connects to the first Integration Service in the list. If the connection breaks, the agent connects to the next Integration Service in the list.
You can also use the integrationService configuration variable or the INTEGRATIONSERVICES environment variable for this purpose.
You must define an Integration Service if you want to add an agent through auto workflow to the ProactiveNet console. If you do not start the agent with the -integrationservice option, the IntegrationService configuration variable set, or the INTEGRATIONSERVICES environment variable set, the PATROL Agent cannot communicate with the Integration Service and vice versa.

-remove

Removes the agent as a service

-rtserver <protocol>:<host>:<portNo>, <protocol2>:<host2>:<portNo2>

Tells the agent which RTserver(s) to connect to, for example: PatrolAgent -rtserver 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 can also use RTServers configuration variablethe or RTSERVERS environment variablethe for this purpose.
You must define an RTserver if you want to view agent data from PATROL Central Operator - Microsoft Windows Edition or PATROL Central Operator - Web Edition (PATROL 7.x Consoles). If you do not start the agent with the -rtserver option, the RTServers configuration variable set, or the RTSERVERS environment variable set, PATROL 7.x Consoles and the PATROL Console Server cannot communicate with the PATROL Agent.

-share-sys-output

Shows the same system output window for all consoles that connect to the agent

-v

  • Reports the OS version number of the computer that the patrolagent.exe is built

  • Shows the version number of the PATROL Agent executable

    This argument accepts both the upper and lower case ‘v'.

-RegServer

Registers COM server and exits

-UnregServer

Unregisters COM server and exits (the PATROL installation automatically registers COM server)

 RTServers configuration variable

The /AgentSetup/rtServers variable tells the PATROL Agent to which RTserver(s) to connect. The advantage of setting the RTServers configuration variable is that you can reconfigure the RTserver connection(s) from a central point. If you change this variable, the change will not take effect until you restart the PATROL Agent.

Format and type of data

Text string, RTserver

Default value

None

Minimum and maximum

Not applicable

Dependencies

None

Recommendation

Use commas to separate multiple RTServers

 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.

RTServer precedence

The PATROL Agent can be told to which RTserver to connect using three different methods: command line argument, configuration variable, and environment variable. If you use more than one method to specify RTserver connections, then the PATROL Agent uses the RTserver connection methods in the following order:

  1. Command line argument
  2. Configuration variable
  3. Environment variable

When a value is undefined, the next value is tried. When a value is defined but has no valid RTserver in the list (example unparseable syntax or unresolvable hostname), the next value is not tried. The PATROL Agent will start without using COS/RTserver. The PATROL Agent will also start without using COS/RTserver if none of the values are defined.

 

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