Environment
Situation
Using Agent_CLI to start or stop an individual collector from the command line.
Resolution
How to use it:
On Windows:
1. Go to %workbench_home%
2. Run Agent_CLI.exe with specified parameters (see usage below)
On Solaris and Linux:
1. Go to $WORKBENCH_HOME
2. Run ./Agent_CLI with specified parameters (see usage below)
Usage:
Agent_CLI --version
Agent_CLI {--start|--stop|--restart}
Agent_CLI --sendEvents <#Events> [--debug]
Flags:
--version: shows the version of Agent_CLI
--start: starts the specified collector port
--stop: stops the specified collector port
--restart: restarts the specified collector port
--debug: optional argument that enables debug mode of this utility. This flags turns on debugging of the Agent_CLI utility, not the target collector port.
--sendEvents: send the specified number of events into Sentinel. This is for Sentinel troubleshooting purposes.
Parameters:
Collector_Port_Name: the collector port name as specified in collector builder.
IP_or_Hostname: the IP address or Hostname (case sensitive) of the collector manager server, where the collector port is deployed.
Example:
You want to start a collector port named "SendMultipleEvents", which is deployed on a collector manager machine with IP=172.16.0.20 and hostname=test
1. To start a particular collector port
Agent_CLI --start SendMultipleEvents:172.16.0.20
or
Agent_CLI --start SendMultipleEvents:test
2. To stop a particular collector port
Agent_CLI --stop SendMultipleEvents:172.16.0.20
or
Agent_CLI --stop SendMultipleEvents:test
3. To restart particular collector port
Agent_CLI --restart SendMultipleEvents:172.16.0.20
or
Agent_CLI --restart SendMultipleEvents:test
4. To send in 10 events in Sentinel (for troubleshooting purposes)
Agent_CLI --sendEvents 10
5. To start a particular collector port and have the Agent_CLI print debug messages
Agent_CLI --start SendMultipleEvents:172.16.0.20 --debug
or
Agent_CLI --start SendMultipleEvents:test --debug
6. To stop a particular collector port and have the Agent_CLI print debug messages
Agent_CLI --stop SendMultipleEvents:172.16.0.20 --debug
or
Agent_CLI --stop SendMultipleEvents:test --debug
7. To restart a particular collector port and have the Agent_CLI print debug messages
Agent_CLI --restart SendMultipleEvents:172.16.0.20 --debug
or
Agent_CLI --restart SendMultipleEvents:test --debug
8. To send in 10 events into Sentinel (for troubleshooting purposes) and have the Agent_CLI print debug messages
Agent_CLI --sendEvents 10 --debug
9. To view Agent_CLI version
Agent_CLI --version