This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
« elasticsearch-shard elasticsearch-users »
Elastic Docs ›Elasticsearch Guide [master] ›Command line tools

elasticsearch-syskeygen

edit

elasticsearch-syskeygen

edit

The elasticsearch-syskeygen command creates a system key file in the elasticsearch config directory.

Synopsis

edit
bin/elasticsearch-syskeygen
[-E <KeyValuePair>] [-h, --help]
([-s, --silent] | [-v, --verbose])

Description

edit

The command generates a system_key file, which you can use to symmetrically encrypt sensitive data. For example, you can use this key to prevent Watcher from returning and storing information that contains clear text credentials. See Encrypting sensitive data in Watcher.

The system key is a symmetric key, so the same key must be used on every node in the cluster.

Parameters

edit
-E <KeyValuePair>
Configures a setting. For example, if you have a custom installation of Elasticsearch, you can use this parameter to specify the ES_PATH_CONF environment variable.
-h, --help
Returns all of the command parameters.
-s, --silent
Shows minimal output.
-v, --verbose
Shows verbose output.

Examples

edit

The following command generates a system_key file in the default $ES_HOME/config directory:

bin/elasticsearch-syskeygen
« elasticsearch-shard elasticsearch-users »