Agent executable command-line commands

These are the command-lines that compact agent executable file accepts. The agent executables are the UNIX script or the Windows executable file.

Command Description
run

Runs the agent from the console.

start [<pidfile>]

Runs the agent in the background.

UNIX: The pidfile argument is optional but is typically used when it runs from an init script.

Windows: The pidfile argument is not used.

stop

Stops the agent.

It creates the "var/shutdown" file. The agent itself monitors for the existence of this file and terminates itself if it is detected. This means the user must have sufficient permission to write that file.

install-service

Windows-only command. This command installs the windows service. It must be run as an administrator with elevated privileges.

uninstall-service Windows-only command. This command uninstalls the windows service. It must be run as an administrator with elevated privileges.
start-service Windows-only command. This command starts the windows service. It must be run as an administrator with elevated privileges.
stop-service Windows-only command. This command stops the windows service. It must be run as an administrator with elevated privileges. This command does not directly use the mechanism of the "stop" command. It requests the Windows service control manager (SCM) for the service to stop.