Type to search.

elasticsearch-syskeygen

Self-managed

Self-managed deployments are Elastic Stack deployments managed without the assistance of an orchestrator.

Availability

  • Generally available

    This functionality is generally available and ready for production usage.

This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

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

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

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.

Important

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

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

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

Shell
bin/elasticsearch-syskeygen