OS Manuals

/usr/bin/temporal-elasticsearch-tool

Command-line tool for managing Temporal's Elasticsearch integration

From temporal-elasticsearch-tool-1.31 1.31.5-r0 (enterprise-packages), captured 2026-11-08 by running temporal-elasticsearch-tool --help (exit 0). permalink

NAME:
   temporal-elasticsearch-tool - Command line tool for temporal elasticsearch operations (EXPERIMENTAL)

USAGE:
   temporal-elasticsearch-tool [global options] command [command options] [arguments...]

VERSION:
   0.0.1

COMMANDS:
   setup-schema   setup elasticsearch cluster settings and index template
   update-schema  update elasticsearch index template, and index mappings if --index is specified
   create-index   create elasticsearch visibility index
   drop-index     delete elasticsearch visibility index
   ping           pings the elasticsearch host
   help, h        Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --endpoint value, --ep value          hostname or ip address of elasticsearch server (default: "http://127.0.0.1:9200") [$ES_SERVER]
   --user value, -u value                username for elasticsearch or aws_access_key_id if using static aws credentials [$ES_USER]
   --password value, --pw value          password for elasticsearch or aws_secret_access_key if using static aws credentials [$ES_PWD]
   --aws-credentials value, --aws value  AWS credentials provider (supported ['static', 'environment', 'aws-sdk-default']) [$AWS_CREDENTIALS]
   --aws-session-token value             AWS sessiontoken for use with 'static' AWS credentials provider [$AWS_SESSION_TOKEN]
   --quiet                               don't log errors to stderr
   --tls                                 enable TLS for elasticsearch connection [$ES_TLS]
   --tls-cert-file value                 path to TLS certificate file (tls must be enabled) [$ES_TLS_CERT_FILE]
   --tls-key-file value                  path to TLS key file (tls must be enabled) [$ES_TLS_KEY_FILE]
   --tls-ca-file value                   path to TLS CA certificate file (tls must be enabled) [$ES_TLS_CA_FILE]
   --tls-disable-host-verification       disable TLS host name verification (tls must be enabled) [$ES_TLS_DISABLE_HOST_VERIFICATION]
   --tls-server-name value               TLS server name for host name verification (tls must be enabled) [$ES_TLS_SERVER_NAME]
   --help, -h                            show help
   --version, -v                         print the version
Options (14)
OptionDescriptionSource
--endpoint, --ep valuehostname or ip address of elasticsearch server (default: "http://127.0.0.1:9200") [$ES_SERVER]help
--user, -u valueusername for elasticsearch or aws_access_key_id if using static aws credentials [$ES_USER]help
--password, --pw valuepassword for elasticsearch or aws_secret_access_key if using static aws credentials [$ES_PWD]help
--aws-credentials, --aws valueAWS credentials provider (supported ['static', 'environment', 'aws-sdk-default']) [$AWS_CREDENTIALS]help
--aws-session-token valueAWS sessiontoken for use with 'static' AWS credentials provider [$AWS_SESSION_TOKEN]help
--quietdon't log errors to stderrhelp
--tlsenable TLS for elasticsearch connection [$ES_TLS]help
--tls-cert-file valuepath to TLS certificate file (tls must be enabled) [$ES_TLS_CERT_FILE]help
--tls-key-file valuepath to TLS key file (tls must be enabled) [$ES_TLS_KEY_FILE]help
--tls-ca-file valuepath to TLS CA certificate file (tls must be enabled) [$ES_TLS_CA_FILE]help
--tls-disable-host-verificationdisable TLS host name verification (tls must be enabled) [$ES_TLS_DISABLE_HOST_VERIFICATION]help
--tls-server-name valueTLS server name for host name verification (tls must be enabled) [$ES_TLS_SERVER_NAME]help
--help, -hshow helphelp
--version, -vprint the versionhelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.