IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Secrets keystore for secure settings Running Auditbeat on Docker »

› ›

Auditbeat command reference

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Auditbeat command reference

edit

Auditbeat provides a command-line interface for starting Auditbeat and performing common tasks, like testing configuration files and loading dashboards.

The command-line also supports global flags for controlling global behaviors.

Use sudo to run the following commands if:

the config file is owned by root, or
Auditbeat is configured to capture data that requires root access

Commands
`export`	Exports the configuration, index template, or a dashboard to stdout.
`help`	Shows help for any command.
`keystore`	Manages the secrets keystore.
`run`	Runs Auditbeat. This command is used by default if you start Auditbeat without specifying a command.
`setup`	Sets up the initial environment, including the index template and Kibana dashboards (when available).
`test`	Tests the configuration.
`version`	Shows information about the current version.

Also see Global flags.

`export` command

edit

Exports the configuration, index template, or a dashboard to stdout. You can use this command to quickly view your configuration, see the contents of the index template, or export a dashboard from Kibana.

SYNOPSIS

auditbeat export SUBCOMMAND [FLAGS]

SUBCOMMANDS

config

Exports the current configuration to stdout. If you use the -c flag, this command exports the configuration that’s defined in the specified file.

dashboard

Exports a dashboard. You can use this option to store a dashboard on disk in a module and load it automatically. For example, to export the dashboard to a JSON file, run:

auditbeat export dashboard --id="DASHBOARD_ID" > dashboard.json

To find the DASHBOARD_ID, look at the URL for the dashboard in Kibana. By default, export dashboard writes the dashboard to stdout. The example shows how to write the dashboard to a JSON file so that you can import it later. The JSON file will contain the dashboard with all visualizations and searches. You must load the index pattern separately for Auditbeat.

To load the dashboard, copy the generated dashboard.json file into the kibana/6/dashboard directory of Auditbeat, and run auditbeat setup --dashboards to import the dashboard.

If Kibana is not running on localhost:5061, you must also adjust the Auditbeat configuration under setup.kibana.

template

Exports the index template to stdout. You can specify the --es.version and --index flags to further define what gets exported.

ilm-policy: Exports ILM policy to stdout.

FLAGS

--es.version VERSION: When used with template, exports an index template that is compatible with the specified version.
-h, --help: Shows help for the export command.
--index BASE_NAME: When used with template, sets the base name to use for the index template. If this flag is not specified, the default base name is auditbeat.
--id DASHBOARD_ID: When used with dashboard, specifies the dashboard ID.

Also see Global flags.

EXAMPLES

auditbeat export config
auditbeat export template --es.version 7.1.1 --index myindexname
auditbeat export dashboard --id="a7b35890-8baa-11e8-9676-ef67484126fb" > dashboard.json

`help` command

edit

Shows help for any command. If no command is specified, shows help for the run command.

SYNOPSIS

auditbeat help COMMAND_NAME [FLAGS]

COMMAND_NAME: Specifies the name of the command to show help for.

FLAGS

-h, --help: Shows help for the help command.

Also see Global flags.

EXAMPLE

auditbeat help export

`keystore` command

edit

Manages the secrets keystore.

SYNOPSIS

auditbeat keystore SUBCOMMAND [FLAGS]

SUBCOMMANDS

add KEY: Adds the specified key to the keystore. Use the --force flag to overwrite an existing key. Use the --stdin flag to pass the value through stdin.
create: Creates a keystore to hold secrets. Use the --force flag to overwrite the existing keystore.
list: Lists the keys in the keystore.
remove KEY: Removes the specified key from the keystore.

FLAGS

--force: Valid with the add and create subcommands. When used with add, overwrites the specified key. When used with create, overwrites the keystore.
--stdin: When used with add, uses the stdin as the source of the key’s value.
-h, --help: Shows help for the keystore command.

Also see Global flags.

EXAMPLES

auditbeat keystore create
auditbeat keystore add ES_PWD
auditbeat keystore remove ES_PWD
auditbeat keystore list

See Secrets keystore for more examples.

`run` command

edit

Runs Auditbeat. This command is used by default if you start Auditbeat without specifying a command.

SYNOPSIS

auditbeat run [FLAGS]

Or:

auditbeat [FLAGS]

FLAGS

-N, --N: Disables publishing for testing purposes. This option disables all outputs except the File output.
--cpuprofile FILE: Writes CPU profile data to the specified file. This option is useful for troubleshooting Auditbeat.
-h, --help: Shows help for the run command.
--httpprof [HOST]:PORT: Starts an http server for profiling. This option is useful for troubleshooting and profiling Auditbeat.
--memprofile FILE: Writes memory profile data to the specified output file. This option is useful for troubleshooting Auditbeat.

Also see Global flags.

EXAMPLE

auditbeat run -e

Or:

auditbeat -e

`setup` command

edit

Sets up the initial environment, including the index template and Kibana dashboards (when available)

The index template ensures that fields are mapped correctly in Elasticsearch.
The Kibana dashboards make it easier for you to visualize Auditbeat data in Kibana.

Use this command if you want to set up the environment without actually running Auditbeat and ingesting data.

SYNOPSIS

auditbeat setup [FLAGS]

FLAGS

--dashboards: Sets up the Kibana dashboards (when available). This option loads the dashboards from the Auditbeat package. For more options, such as loading customized dashboards, see Importing Existing Beat Dashboards in the Beats Developer Guide.
-h, --help: Shows help for the setup command.
--template: Sets up the index template only.

Also see Global flags.

EXAMPLES

auditbeat setup --dashboards
auditbeat setup --machine-learning
auditbeat setup --template

`test` command

edit

Tests the configuration.

SYNOPSIS

auditbeat test SUBCOMMAND [FLAGS]

SUBCOMMANDS

config: Tests the configuration settings.
output: Tests that Auditbeat can connect to the output by using the current settings.

FLAGS

-h, --help: Shows help for the test command.

Also see Global flags.

EXAMPLE

auditbeat test config

`version` command

edit

Shows information about the current version.

SYNOPSIS

auditbeat version [FLAGS]

FLAGS

-h, --help: Shows help for the version command.

Also see Global flags.

EXAMPLE

auditbeat version

Global flags

edit

These global flags are available whenever you run Auditbeat.

-E, --E "SETTING_NAME=VALUE"

Overrides a specific configuration setting. You can specify multiple overrides. For example:

auditbeat -E "name=mybeat" -E "output.elasticsearch.hosts=['http://myhost:9200']"

This setting is applied to the currently running Auditbeat process. The Auditbeat configuration file is not changed.

-c, --c FILE

Specifies the configuration file to use for Auditbeat. The file you specify here is relative to path.config. If the -c flag is not specified, the default config file, auditbeat.yml, is used.

-d, --d SELECTORS

Enables debugging for the specified selectors. For the selectors, you can specify a comma-separated list of components, or you can use -d "*" to enable debugging for all components. For example, -d "publish" displays all the "publish" related messages.

-e, --e

Logs to stderr and disables syslog/file output.

--path.config

Sets the path for configuration files. See the Directory layout section for details.

--path.data

Sets the path for data files. See the Directory layout section for details.

--path.home

Sets the path for miscellaneous files. See the Directory layout section for details.

--path.logs

Sets the path for log files. See the Directory layout section for details.

--strict.perms

Sets strict permission checking on configuration files. The default is -strict.perms=true. See Config file ownership and permissions in the Beats Platform Reference for more information.

-v, --v

Logs INFO-level messages.

« Secrets keystore for secure settings Running Auditbeat on Docker »

Auditbeat command reference

Auditbeat command reference

export command

help command

keystore command

run command

setup command

test command

version command

Global flags

`export` command

`help` command

`keystore` command

`run` command

`setup` command

`test` command

`version` command