[[alias]]
== alias

[float]
Summary
~~~~~~~

Add indices to or remove them from aliases.

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

[float]
Flags
~~~~~

-------------------------------------------------------------------
$ 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.
-------------------------------------------------------------------

&nbsp;

IMPORTANT: This command requires the <<indices-subcommand,indices>>
<<subcommand,subcommand>> for <<index-selection,index selection>>.

[float]
Examples
~~~~~~~~

Add indices to `alias_name`:

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

&nbsp;

Remove indices from `alias_name`:

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

&nbsp;

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