Scroll to navigation

CURATOR(1) User Commands CURATOR(1)

NAME

curator - Elasticsearch time-series index manager

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

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

show program usage and exit
show program's version number and exit
Elasticsearch host. Default: localhost
Elasticsearch HTTP url prefix. Default: none
Elasticsearch port. Default: 9200
Connect to Elasticsearch through SSL. Default: false
Path to certificate to use for SSL validation.
Path to file containing SSL certificate for client auth.
Do not validate SSL certificate
Use Basic Authentication ex: user:pass Default: None
Connection timeout in seconds.
Verify that the node is the elected master before continuing
If true, does not perform any changes to the Elasticsearch indices.
Log level
log file
Log output format [default|logstash]. Default: default

COMMANDS

Each of the following commands accepts a number of options and positional arguments. Run curator COMMAND --help for command-specific help. Available commands are:

Apply required index routing allocation rule
Close indices
Delete indices
Delete snapshots
forceMerge index/shard segments
Open indices
Change replica count of indices
Show indices
Show snapshots
Take snapshots of indices

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

Additional documentation for curator_cli 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 <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.

December 2016 curator 4.2