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 21.3.

Command line arguments for starting the PATROL Agent

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

-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 load balancer(s) to connect to, for example,

PatrolAgent -<load balancer>: 3183.

You can provide multiple load balancer(s) by providing a comma-separated list. The agent connects to the first load balancer in the list. If the connection breaks, the agent connects to the next load balancer in the list.
You can also use the load balancer configuration variable environment variable for this purpose.

If you do not start the agent with the -load balancer option, the load balancerconfiguration variable set, or the INTEGRATIONSERVICES environment variable set, the PATROL Agent cannot communicate with the load balancer and vice versa.

-remove

Removes the agent as a service

-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'.

 

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