WARNING: Version 6.2 of Elasticsearch has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
The syskeygen
command creates a system key file in ES_PATH_CONF/x-pack
.
bin/x-pack/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.
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/x-pack
directory:
bin/x-pack/syskeygen