Agent CLI
This page provides an overview of the Agent's CLI, as well as it's subcommands and options.
beacon-agent [subcommand] [options]
Global options
| Option | Description |
|---|---|
--help | Provides information about optional flags. |
Subcommands
| Subcommand | Description |
|---|---|
(no subcommand) | Runs the Agent and establishes a connection to the external database (and, if specified, to the Hybrid Manager). |
setup | Creates a basic Agent configuration file. |
version | Prints the version of the Agent and exits. |
config | Validates the parameters set in beacon_agent.yaml and performs a test connection. |
(no subcommand)
When no subcommand is specified, beacon-agent runs the Agent process. This process collects data ingestions. If configured, it sends the collected data to a Hybrid Manager instance for monitoring, or to an EDB-managed bucket for usage reporting.
beacon-agent [-file=<configuration_file_path>]
| Option | Description |
|---|---|
-file=<configuration_file_path> | Specifies which configuration file the Agent should use for configuration. |
If no configuration file is specified with the -file=<configuration_file_path> flag, the Agent looks for a beacon_agent.yaml file in /etc/beacon, $HOME/.beacon, and in the current directory.
setup
The setup subcommand creates the Agent configuration file and, by default, authenticates the Agent with the Hybrid Manager.
Note
While the setup subcommand generates a basic configuration file, EDB recommends using the documented beacon_agent.yaml templates. These templates offer use-case specific configurations designed to help you leverage the full range of Agent functionality.
Verification of credentials requires the environment variables BEACON_AGENT_ACCESS_KEY and BEACON_AGENT_PROJECT_ID to be set.
beacon-agent setup [-file=<configuration_file_path>] [-verify=<boolean>]
| Options | Description | Default |
|---|---|---|
-file=<configuration_file_path> | Sets the path and filename for the configuration file setup creates for the Agent. | |
-verify=<boolean> | Verifies the Agent's project credentials with the Hybrid Manager. |
Examples:
To create a configuration file without authentication:
beacon-agent setup -verify=false
To create a configuration file with a different name:
beacon-agent setup -file my_beacon_config.yaml
version
The version subcommand prints the version of the Agent and exits.
Example:
beacon-agent version
config
The config subcommand validates the parameters set in beacon_agent.yaml and performs a test connection to the Hybrid Manager. It prints a summary of the configuration details and flags errors.
Example:
beacon-agent config
Could this page be better? Report a problem or suggest an addition!