IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

alias

edit

Summary

edit

Add indices to or remove them from aliases.

For Curator versions older than 3.2.0, the alias must already be in existence.

Flags

edit
$ curator alias --help
Usage: curator alias [OPTIONS] COMMAND [ARGS]...

  Index Aliasing

Options:
  --name TEXT  Alias name
  --remove     Remove from alias rather than add.  [default: False]
  --help       Show this message and exit.

Commands:
  indices  Index selection.

 

This command requires the indices subcommand for index selection.

Examples

edit

Add indices to alias_name:

curator alias --name alias_name indices <<index selection parameters>>

 

Remove indices from alias_name:

curator alias --name alias_name --remove indices <<index selection parameters>>

 

There are currently no safety checks to preserve an alias. If you remove the last index from an alias, it will be deleted immediately.