Reference

curator(1)

Elasticsearch time-series index manager

NAME

curator - Elasticsearch time-series index manager

SYNOPSIS

curator [--config CONFIG.YML] [--dry-run] ACTION_FILE.YML

DESCRIPTION

curator helps manage Elasticsearch time-series indices. It provides an easy way to perform index administration tasks, such as managing aliases, optimizing indices, changing the replica count and modifying index allocation using routing tags.

OPTIONS

-h, --help

show program usage and exit

-v, --version

show program's version number and exit

--config PATH

Path to configuration file. Default: ~/.curator/curator.yml

--dry-run

Do not perform any changes.

ACTION_FILE is a YAML curator action file. For more information on action files, consult /usr/share/doc/elasticsearch-curator/reference.txt.gz.

EXIT CODES

Exit codes will indicate success or failure.

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_cli(1)

Additional documentation for curator can be found 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 <[email protected]>. It is currently maintained by Elasticsearch <http://www.elasticsearch.org/>.

This manual page was written by Apollon Oikonomopoulos <[email protected]> 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.

History

--config since Debian 9 (Stretch); --dry-run since Debian 9 (Stretch).

--attrext until Debian 4.0 (Etch); --check-thumb-size until Debian 3.0 (Woody); --clean until Debian 4.0 (Etch); --copyright until Debian 4.0 (Etch); --fast until Debian 4.0 (Etch); --force until Debian 3.0 (Woody); --force-html until Debian 3.0 (Woody); --force-imagepage until Debian 3.0 (Woody); --force-index until Debian 3.0 (Woody); --force-thumbgen until Debian 3.0 (Woody); --help-script until Debian 4.0 (Etch); --htmlext until Debian 4.0 (Etch); --ignore-errors until Debian 4.0 (Etch); --ignore-pattern until Debian 3.0 (Woody); --magick-path until Debian 4.0 (Etch); --new-magick until Debian 4.0 (Etch); --newthumbext until Debian 3.0 (Woody); --no-html until Debian 3.0 (Woody); --no-imagepage until Debian 3.0 (Woody); --no-index until Debian 3.0 (Woody); --no-links until Debian 4.0 (Etch); --no-magick until Debian 4.0 (Etch); --no-meta until Debian 4.0 (Etch); --no-thumbgen until Debian 3.0 (Woody); --old-magick until Debian 4.0 (Etch); --out-along until Debian 4.0 (Etch); --out-onedir until Debian 4.0 (Etch); --out-subdirs until Debian 4.0 (Etch); --pil until Debian 4.0 (Etch); --quiet until Debian 4.0 (Etch); --rc until Debian 4.0 (Etch); --rccode until Debian 4.0 (Etch); --repn-affinity until Debian 4.0 (Etch); --save-templates until Debian 4.0 (Etch); --separator until Debian 4.0 (Etch); --silent until Debian 3.0 (Woody); --templates until Debian 4.0 (Etch); --thumb-force until Debian 4.0 (Etch); --thumb-quality until Debian 4.0 (Etch); --thumb-sfx until Debian 4.0 (Etch); --thumb-size until Debian 4.0 (Etch); --use-repn until Debian 4.0 (Etch); --verbose until Debian 4.0 (Etch); -C until Debian 4.0 (Etch); -D until Debian 4.0 (Etch); -F until Debian 4.0 (Etch); -I until Debian 3.0 (Woody); -M until Debian 4.0 (Etch); -O until Debian 4.0 (Etch); -Q until Debian 4.0 (Etch); -S until Debian 4.0 (Etch); -V until Debian 4.0 (Etch); -X until Debian 4.0 (Etch); -i until Debian 3.0 (Woody); -j until Debian 3.0 (Woody); -k until Debian 4.0 (Etch); -n until Debian 3.0 (Woody); -p until Debian 4.0 (Etch); -q until Debian 4.0 (Etch); -s until Debian 4.0 (Etch); -t until Debian 4.0 (Etch).