CURATOR(1)

💖 CURATOR(1) 💖

bestie… welcome to curator, the Elasticsearch time-series index manager. yes it's a User Commands moment, yes it's iconic, and yes i'm about to explain every single flag like we're texting at 2am 🫶

---

✨ NAME ✨

curator — Elasticsearch time-series index manager. that's it. that's the whole vibe. 👑

---

🌸 SYNOPSIS 🌸

curator_cli [-h] [-v] [--host HOST] [--url_prefix URL_PREFIX] [--port
PORT] [--use_ssl] [--http_auth AUTH] [--timeout TIMEOUT] [--master-only]
[--dry-run] [--loglevel LOG_LEVEL] [--logfile LOG_FILE] [--logformat
LOGFORMAT] COMMAND [COMMAND_OPTS] ARGUMENTS

okay so literally just read it left to right, it's giving "flags first, then the command, then that command's own stuff" ✨

---

🦋 DESCRIPTION 🦋

curator helps you manage Elasticsearch time-series indices. it's the easy way to do all your index admin tasks — managing aliases, optimizing indices, changing the replica count, and modifying index allocation using routing tags. no cap, it's the main character of index maintenance. 💅

---

🎀 OPTIONS 🎀

• -h, --help — show program usage and then dip out. 🙈
• -v, --version — show the program's version number and exit.
• --host HOST — the Elasticsearch host. Default: localhost
• --url_prefix URL_PREFIX — the Elasticsearch HTTP url prefix. Default: none
• --port PORT — the Elasticsearch port. Default: 9200
• --use_ssl — connect to Elasticsearch through SSL. Default: false
• --certificate — path to the certificate to use for SSL validation.
• --client-cert — path to the file containing the SSL certificate for client auth.
• --ssl-no-validate — do not validate the SSL certificate.
• --http_auth AUTH — use Basic Authentication, ex: user:pass. Default: None
• --timeout TIMEOUT — connection timeout in seconds.
• --master-only — verify that the node is the elected master before continuing.
• --dry-run — if true, it does not perform any changes to the Elasticsearch indices.
• --loglevel LOG_LEVEL — log level.
• --logfile LOG_FILE — log file.
• --logformat LOGFORMAT — log output format [default|logstash]. Default: default

---

🌈 COMMANDS 🌈

every single one of these commands takes its own pile of options and positional arguments. wanna see them? run curator COMMAND --help for command-specific help, bestie. 🔥

here are all the available commands:

• allocation — apply the required index routing allocation rule.
• close — close indices.
• delete_indices — delete indices.
• delete_snapshots — delete snapshots.
• forcemerge — forceMerge index/shard segments.
• open — open indices.
• replicas — change the replica count of indices.
• show_indices — show indices.
• show_snapshots — show snapshots.
• snapshot — take snapshots of indices.

---

💀 EXIT CODES 💀

the exit codes will tell you whether it slayed or flopped. success or failure, that's the whole story.

• 0 — Success ✨
• 1 — Failure 😭
• -1 — an exception was raised that does not result in an exit code of 1

---

🌟 SEE ALSO 🌟

es_repo_mgr(1), curator(1)

additional documentation for curator_cli lives at the project's wiki at https://github.com/elasticsearch/curator/wiki and — on Debian systems — under /usr/share/doc/elasticsearch-curator/reference.txt.gz. 📚

---

💜 AUTHOR 💜

curator was originally written by Aaron Mildenstein <aaron@mildensteins.com>. it is currently maintained by Elasticsearch <http://www.elasticsearch.org/>.

this manual page was written by Apollon Oikonomopoulos <apoikos@debian.org> for the Debian project (but may be used by others). 🫶

---

👑 LICENSE 👑

this software is released under the Apache License, Version 2.0. see /usr/share/doc/elasticsearch-curator/copyright for more details.

Copyright 2011-2016 Elasticsearch and contributors.

---

and that's a wrap bestie!! this was curator version 4.2, from December 2016, served to you with love by your local CURATOR(1) man page. mwah 💋✨