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 Packetbeat on Docker »
Elastic Docs ›Packetbeat Reference [6.5] ›Setting up and running Packetbeat

Packetbeat command reference

edit

Packetbeat command reference

edit

Packetbeat provides a command-line interface for starting Packetbeat 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
  • Packetbeat 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 Packetbeat. This command is used by default if you start Packetbeat without specifying a command.

setup

Sets up the initial environment, including the index template, Kibana dashboards (when available), and machine learning jobs (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

packetbeat 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: 

packetbeat 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 Packetbeat.

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

If Kibana is not running on localhost:5061, you must also adjust the Packetbeat 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.

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 packetbeat.
--id DASHBOARD_ID
When used with dashboard, specifies the dashboard ID.

Also see Global flags.

EXAMPLES

packetbeat export config
packetbeat export template --es.version 6.5.4 --index myindexname
packetbeat 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

packetbeat 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

packetbeat help export

keystore command

edit

Manages the secrets keystore.

SYNOPSIS

packetbeat 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

packetbeat keystore create
packetbeat keystore add ES_PWD
packetbeat keystore remove ES_PWD
packetbeat keystore list

See Secrets keystore for more examples.

run command

edit

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

SYNOPSIS

packetbeat run [FLAGS]

Or:

packetbeat [FLAGS]

FLAGS

-I, --I FILE

Reads packet data from the specified file instead of reading packets from the network. This option is useful only for testing Packetbeat. 

packetbeat run -I ~/pcaps/network_traffic.pcap
-N, --N
Disables publishing for testing purposes. This option disables all outputs except the File output.
-O, --O
Read packets one by one by pressing Enter after each. This option is useful only for testing Packetbeat.
--cpuprofile FILE
Writes CPU profile data to the specified file. This option is useful for troubleshooting Packetbeat.
-devices
Prints the list of devices that are available for sniffing and then exits.
-dump FILE
Writes all captured packets to the specified file. This option is useful for troubleshooting Packetbeat.
-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 Packetbeat.
-l N
Reads the pcap file N number of times. The default is 1. Use this option in combination with the -I option. For an infinite loop, use 0. The -l option is useful only for testing Packetbeat.
--memprofile FILE
Writes memory profile data to the specified output file. This option is useful for troubleshooting Packetbeat.
--setup

Loads the initial setup, including Elasticsearch template, Kibana index pattern, Kibana dashboards (when available), and Machine learning jobs. If you want to use the command without running Packetbeat, use the setup command instead.

-t
Reads packets from the pcap file as fast as possible without sleeping. Use this option in combination with the -I option. The -t option is useful only for testing Packetbeat.

Also see Global flags.

EXAMPLE

packetbeat run -e --setup

Or:

packetbeat -e --setup

setup command

edit

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

  • The index template ensures that fields are mapped correctly in Elasticsearch.
  • The Kibana dashboards make it easier for you to visualize Packetbeat data in Kibana.
  • The machine learning jobs contain the configuration information and metadata necessary to analyze data for anomalies.

Use this command instead of run --setup when you want to set up the environment without actually running Packetbeat and ingesting data.

SYNOPSIS

packetbeat setup [FLAGS]

FLAGS

--dashboards
Sets up the Kibana dashboards (when available). This option loads the dashboards from the Packetbeat 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.
--machine-learning
Sets up machine learning job configurations only.
--template
Sets up the index template only.

Also see Global flags.

EXAMPLES

packetbeat setup --dashboards
packetbeat setup --machine-learning
packetbeat setup --template

test command

edit

Tests the configuration.

SYNOPSIS

packetbeat test SUBCOMMAND [FLAGS]

SUBCOMMANDS

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

FLAGS

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

Also see Global flags.

EXAMPLE

packetbeat test config

version command

edit

Shows information about the current version.

SYNOPSIS

packetbeat version [FLAGS]

FLAGS

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

Also see Global flags.

EXAMPLE

packetbeat version

Global flags

edit

These global flags are available whenever you run Packetbeat.

-E, --E "SETTING_NAME=VALUE"

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

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

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

-c, --c FILE
Specifies the configuration file to use for Packetbeat. The file you specify here is relative to path.config. If the -c flag is not specified, the default config file, packetbeat.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 Packetbeat on Docker »