﻿---
title: Filebeat command reference
description: Filebeat provides a command-line interface for starting Filebeat and performing common tasks, like testing configuration files and loading dashboards...
url: https://www.elastic.co/elastic/docs-builder/docs/2679/reference/beats/filebeat/command-line-options
products:
  - Beats
  - Filebeat
applies_to:
  - Elastic Cloud Serverless: Generally available
  - Elastic Stack: Generally available
---

# Filebeat command reference
Filebeat provides a command-line interface for starting Filebeat and performing common tasks, like testing configuration files and loading dashboards.
The command-line also supports [global flags](#global-flags) for controlling global behaviors.
<tip>
  Use `sudo` to run the following commands if:
  - the config file is owned by `root`, or
  - Filebeat is configured to capture data that requires `root` access
</tip>

Some of the features described here require an Elastic license. For more information, see [[https://www.elastic.co/subscriptions](https://www.elastic.co/subscriptions)](https://www.elastic.co/subscriptions) and [License Management](https://docs-v3-preview.elastic.dev/elastic/docs-builder/docs/2679/deploy-manage/license/manage-your-license-in-self-managed-cluster).

| Commands                        |                                                                                                                                                                            |
|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`export`](#export-command)     | Exports the configuration, index template, ILM policy, or a dashboard to stdout.                                                                                           |
| [`help`](#help-command)         | Shows help for any command.                                                                                                                                                |
| [`keystore`](#keystore-command) | Manages the [secrets keystore](https://www.elastic.co/elastic/docs-builder/docs/2679/reference/beats/filebeat/keystore).                                                   |
| [`modules`](#modules-command)   | Manages configured modules.                                                                                                                                                |
| [`run`](#run-command)           | Runs Filebeat. This command is used by default if you start Filebeat without specifying a command.                                                                         |
| [`setup`](#setup-command)       | Sets up the initial environment, including the index template, ILM policy and write alias, Kibana dashboards (when available), and machine learning jobs (when available). |
| [`test`](#test-command)         | Tests the configuration.                                                                                                                                                   |
| [`version`](#version-command)   | Shows information about the current version.                                                                                                                               |

Also see [Global flags](#global-flags).

## `export` command

Exports the configuration, index template, ILM policy, or a dashboard to stdout. You can use this command to quickly view your configuration, see the contents of the index template and the ILM policy, or export a dashboard from Kibana.
**SYNOPSIS**
```sh
filebeat export SUBCOMMAND [FLAGS]
```

**SUBCOMMANDS**
<definitions>
  <definition term="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.
  </definition>
  <definition term="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:
    ```shell
    filebeat 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 Filebeat.
    To load the dashboard, copy the generated `dashboard.json` file into the `kibana/6/dashboard` directory of Filebeat, and run `filebeat setup --dashboards` to import the dashboard.
    If Kibana is not running on `localhost:5061`, you must also adjust the Filebeat configuration under `setup.kibana`.
  </definition>
  <definition term="template">
    Exports the index template to stdout. You can specify the `--es.version` flag to further define what gets exported. Furthermore you can export the template to a file instead of `stdout` by defining a directory via `--dir`.
  </definition>
</definitions>


<definitions>
  <definition term="ilm-policy">
    Exports the index lifecycle management policy to stdout. You can specify the `--es.version` and a `--dir` to which the policy should be exported as a file rather than exporting to `stdout`.
  </definition>
</definitions>

**FLAGS**
<definitions>
  <definition term="--es.version VERSION">
    When used with [`template`](#template-subcommand), exports an index template that is compatible with the specified version.  When used with [`ilm-policy`](#ilm-policy-subcommand), exports the ILM policy if the specified ES version is enabled for ILM.
  </definition>
  <definition term="-h, --help">
    Shows help for the `export` command.
  </definition>
  <definition term="--dir DIRNAME">
    Define a directory to which the template, pipelines, and ILM policy should be exported to as files instead of printing them to `stdout`.
  </definition>
  <definition term="--id DASHBOARD_ID">
    When used with [`dashboard`](#dashboard-subcommand), specifies the dashboard ID.
  </definition>
</definitions>

Also see [Global flags](#global-flags).
**EXAMPLES**
```sh
filebeat export config
filebeat export template --es.version 9.3.0
filebeat export dashboard --id="a7b35890-8baa-11e8-9676-ef67484126fb" > dashboard.json
```


## `help` command

Shows help for any command. If no command is specified, shows help for the `run` command.
**SYNOPSIS**
```sh
filebeat help COMMAND_NAME [FLAGS]
```

<definitions>
  <definition term="COMMAND_NAME">
    Specifies the name of the command to show help for.
  </definition>
</definitions>

**FLAGS**
<definitions>
  <definition term="-h, --help">
    Shows help for the `help` command.
  </definition>
</definitions>

Also see [Global flags](#global-flags).
**EXAMPLE**
```sh
filebeat help export
```


## `keystore` command

Manages the [secrets keystore](https://www.elastic.co/elastic/docs-builder/docs/2679/reference/beats/filebeat/keystore).
**SYNOPSIS**
```sh
filebeat keystore SUBCOMMAND [FLAGS]
```

**SUBCOMMANDS**
<definitions>
  <definition term="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`.
  </definition>
  <definition term="create">
    Creates a keystore to hold secrets. Use the `--force` flag to overwrite the existing keystore.
  </definition>
  <definition term="list">
    Lists the keys in the keystore.
  </definition>
  <definition term="remove KEY">
    Removes the specified key from the keystore.
  </definition>
</definitions>

**FLAGS**
<definitions>
  <definition term="--force">
    Valid with the `add` and `create` subcommands. When used with `add`, overwrites the specified key. When used with `create`, overwrites the keystore.
  </definition>
  <definition term="--stdin">
    When used with `add`, uses the stdin as the source of the key’s value.
  </definition>
  <definition term="-h, --help">
    Shows help for the `keystore` command.
  </definition>
</definitions>

Also see [Global flags](#global-flags).
**EXAMPLES**
```sh
filebeat keystore create
filebeat keystore add ES_PWD
filebeat keystore remove ES_PWD
filebeat keystore list
```

See [Secrets keystore](https://www.elastic.co/elastic/docs-builder/docs/2679/reference/beats/filebeat/keystore) for more examples.

## `modules` command

Manages configured modules. You can use this command to enable and disable specific module configurations defined in the `modules.d` directory. The changes you make with this command are persisted and used for subsequent runs of Filebeat.
To see which modules are enabled and disabled, run the `list` subcommand.
**SYNOPSIS**
```sh
filebeat modules SUBCOMMAND [FLAGS]
```

**SUBCOMMANDS**
<definitions>
  <definition term="disable MODULE_LIST">
    Disables the modules specified in the space-separated list.
  </definition>
  <definition term="enable MODULE_LIST">
    Enables the modules specified in the space-separated list.
  </definition>
  <definition term="list">
    Lists the modules that are currently enabled and disabled.
  </definition>
</definitions>

**FLAGS**
<definitions>
  <definition term="-h, --help">
    Shows help for the `modules` command.
  </definition>
</definitions>

Also see [Global flags](#global-flags).
**EXAMPLES**
```sh
filebeat modules list
filebeat modules enable apache2 auditd mysql
```


## `run` command

Runs Filebeat. This command is used by default if you start Filebeat without specifying a command.
**SYNOPSIS**
```sh
filebeat run [FLAGS]
```

Or:
```sh
filebeat [FLAGS]
```

**FLAGS**
<definitions>
  <definition term="-N, --N">
    Disables publishing for testing purposes. This option disables all outputs except the [File output](https://www.elastic.co/elastic/docs-builder/docs/2679/reference/beats/filebeat/file-output).
  </definition>
  <definition term="--cpuprofile FILE">
    Writes CPU profile data to the specified file. This option is useful for troubleshooting Filebeat.
  </definition>
  <definition term="-h, --help">
    Shows help for the `run` command.
  </definition>
  <definition term="--httpprof [HOST]:PORT">
    Starts an http server for profiling. This option is useful for troubleshooting and profiling Filebeat.
  </definition>
  <definition term="--memprofile FILE">
    Writes memory profile data to the specified output file. This option is useful for troubleshooting Filebeat.
  </definition>
  <definition term="--modules MODULE_LIST">
    Specifies a comma-separated list of modules to run. For example:
    ```sh
    filebeat run --modules nginx,mysql,system
    ```
    Rather than specifying the list of modules every time you run Filebeat, you can use the [`modules`](#modules-command) command to enable and disable specific modules. Then when you run Filebeat, it will run any modules that are enabled.
  </definition>
  <definition term="--once">
    When the `--once` flag is used, Filebeat starts all configured harvesters and inputs, and runs each input until the harvesters are closed. If you set the `--once` flag, you should also set `close_eof` so the harvester is closed when the end of the file is reached. By default harvesters are closed after `close_inactive` is reached.
    The `--once` option is not currently supported with the [`filestream`](https://www.elastic.co/elastic/docs-builder/docs/2679/reference/beats/filebeat/filebeat-input-filestream) input type.
  </definition>
  <definition term="--system.hostfs MOUNT_POINT">
    Specifies the mount point of the host’s filesystem for use in monitoring a host. This flag is depricated, and an alternate hostfs should be specified via the `hostfs` module config value.
  </definition>
</definitions>

Also see [Global flags](#global-flags).
**EXAMPLE**
```sh
filebeat run -e
```

Or:
```sh
filebeat -e
```


## `setup` command

Sets up the initial environment, including the index template, ILM policy and write alias, Kibana dashboards (when available), and machine learning jobs (when available)
- The index template ensures that fields are mapped correctly in Elasticsearch. If index lifecycle management is enabled it also ensures that the defined ILM policy and write alias are connected to the indices matching the index template. The ILM policy takes care of the lifecycle of an index, when to do a rollover, when to move an index from the hot phase to the next phase, etc.
- The Kibana dashboards make it easier for you to visualize Filebeat data in Kibana.
- The machine learning jobs contain the configuration information and metadata necessary to analyze data for anomalies.

This command sets up the environment without actually running Filebeat and ingesting data. Specify optional flags to set up a subset of assets.
**SYNOPSIS**
```sh
filebeat setup [FLAGS]
```

**FLAGS**
<definitions>
  <definition term="--dashboards">
    Sets up the Kibana dashboards (when available). This option loads the dashboards from the Filebeat package. For more options, such as loading customized dashboards, see [Importing Existing Beat Dashboards](https://www.elastic.co/elastic/docs-builder/docs/2679/extend/beats/import-dashboards).
  </definition>
  <definition term="-h, --help">
    Shows help for the `setup` command.
  </definition>
  <definition term="--modules MODULE_LIST">
    Specifies a comma-separated list of modules. Use this flag to avoid errors when there are no modules defined in the `filebeat.yml` file.
  </definition>
  <definition term="--pipelines">
    Sets up ingest pipelines for configured filesets. Filebeat looks for enabled modules in the `filebeat.yml` file. If you used the [`modules`](#modules-command) command to enable modules in the `modules.d` directory, also specify the `--modules` flag.
  </definition>
  <definition term="--enable-all-filesets">
    Enables all modules and filesets. This is useful with `--pipelines` if you want to load all ingest pipelines. Without this option you would have to list every module with the [`modules`](#modules-command) command and enable every fileset within the module with a `-M` option, to load all of the ingest pipelines.
  </definition>
  <definition term="--force-enable-module-filesets">
    Enables all filesets in the enabled modules. This is useful with `--pipelines` if you want to load ingest pipelines. Without this option you enable every fileset within the module with a `-M` option, to load the ingest pipelines.
  </definition>
  <definition term="--index-management">
    Sets up components related to Elasticsearch index management including template, ILM policy, and write alias (if supported and configured).
  </definition>
</definitions>

Also see [Global flags](#global-flags).
**EXAMPLES**
```sh
filebeat setup --dashboards
filebeat setup --pipelines
filebeat setup --pipelines --modules system,nginx,mysql 
filebeat setup --index-management
```


## `test` command

Tests the configuration.
**SYNOPSIS**
```sh
filebeat test SUBCOMMAND [FLAGS]
```

**SUBCOMMANDS**
<definitions>
  <definition term="config">
    Tests the configuration settings.
  </definition>
  <definition term="output">
    Tests that Filebeat can connect to the output by using the current settings.
  </definition>
</definitions>

**FLAGS**
<definitions>
  <definition term="-h, --help">
    Shows help for the `test` command.
  </definition>
</definitions>

Also see [Global flags](#global-flags).
**EXAMPLE**
```sh
filebeat test config
```


## `version` command

Shows information about the current version.
**SYNOPSIS**
```sh
filebeat version [FLAGS]
```

**FLAGS**
<definitions>
  <definition term="-h, --help">
    Shows help for the `version` command.
  </definition>
</definitions>

Also see [Global flags](#global-flags).
**EXAMPLE**
```sh
filebeat version
```


## Global flags

These global flags are available whenever you run Filebeat.
<definitions>
  <definition term="-E, --E "SETTING_NAME=VALUE"">
    Overrides a specific configuration setting. You can specify multiple overrides. For example:
    ```sh
    filebeat -E "name=mybeat" -E "output.elasticsearch.hosts=['http://myhost:9200']"
    ```
    This setting is applied to the currently running Filebeat process. The Filebeat configuration file is not changed.
  </definition>
  <definition term="-M, --M "VAR_NAME=VALUE"">
    Overrides the default configuration for a Filebeat module. You can specify multiple variable overrides. For example:
    ```sh
    filebeat --modules=nginx -M "nginx.access.var.paths=['/var/log/nginx/access.log*']" -M "nginx.access.var.pipeline=no_plugins"
    ```
  </definition>
  <definition term="-c, --c FILE">
    Specifies the configuration file to use for Filebeat. The file you specify here is relative to `path.config`. If the `-c` flag is not specified, the default config file, `filebeat.yml`, is used.
  </definition>
  <definition term="-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 "publisher"` displays all the publisher-related messages.
  </definition>
  <definition term="-e, --e">
    Logs to stderr and disables syslog/file output.
  </definition>
  <definition term="--environment">
    For logging purposes, specifies the environment that Filebeat is running in. This setting is used to select a default log output when no log output is configured. Supported values are: `systemd`, `container`, `macos_service`, and `windows_service`. If `systemd` or `container` is specified, Filebeat will log to stdout and stderr by default.
  </definition>
  <definition term="--path.config">
    Sets the path for configuration files. See the [Directory layout](https://www.elastic.co/elastic/docs-builder/docs/2679/reference/beats/filebeat/directory-layout) section for details.
  </definition>
  <definition term="--path.data">
    Sets the path for data files. See the [Directory layout](https://www.elastic.co/elastic/docs-builder/docs/2679/reference/beats/filebeat/directory-layout) section for details.
  </definition>
  <definition term="--path.home">
    Sets the path for miscellaneous files. See the [Directory layout](https://www.elastic.co/elastic/docs-builder/docs/2679/reference/beats/filebeat/directory-layout) section for details.
  </definition>
  <definition term="--path.logs">
    Sets the path for log files. See the [Directory layout](https://www.elastic.co/elastic/docs-builder/docs/2679/reference/beats/filebeat/directory-layout) section for details.
  </definition>
  <definition term="--strict.perms">
    Sets strict permission checking on configuration files. The default is `--strict.perms=true`. See [Config file ownership and permissions](https://www.elastic.co/elastic/docs-builder/docs/2679/reference/beats/libbeat/config-file-permissions) for more information.
  </definition>
  <definition term="-v, --v">
    Logs INFO-level messages.
  </definition>
</definitions>