stack es indices put-alias cli command

elastic stack es indices put-alias --index <index> --name <name> [options]

Create or update an alias.

Behaviour flags:

--dry-run — validate all inputs and exit without performing any action

--index string required

Comma-separated list of data streams or indices to add. Supports wildcards (*). Wildcard patterns that match both data streams and indices return an error.

Repeatable: pass --index multiple times to supply more than one value

--name string required

Alias to update. If the alias doesn’t exist, the request creates it. Index alias names support date math.

--master-timeout string

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

--timeout string

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

--filter string

Query used to limit documents the alias can access.

--index-routing string

Value used to route indexing operations to a specific shard. If specified, this overwrites the routing value for indexing operations. Data stream aliases don’t support this parameter.

--is-write-index

If true, sets the write index or data stream for the alias. If an alias points to multiple indices or data streams and is_write_index isn’t set, the alias rejects write requests. If an index alias points to one index and is_write_index isn’t set, the index automatically acts as the write index. Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream.

--routing string

Value used to route indexing and search operations to a specific shard. Data stream aliases don’t support this parameter.

--search-routing string

Value used to route search operations to a specific shard. If specified, this overwrites the routing value for search operations. Data stream aliases don’t support this parameter.

--error-trace

When set to true Elasticsearch will include the full stack trace of errors when they occur.

--filter-path string

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.

Repeatable: pass --filter-path multiple times to supply more than one value

--human

When set to true will return statistics in a format suitable for humans. For example "exists_time": "1h" for humans and "exists_time_in_millis": 3600000 for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.

--pretty

If set to true the returned JSON will be "pretty-formatted". Only use this option for debugging only.

--input-file string

path to a JSON file to use as command input

--dry-run

validate all inputs and exit without performing any action (preview changes without applying them)

--no-validate

skip input validation and send the request as-is

--output-fields string

comma-separated list of fields to include in output (dot-notation supported)

--output-template string

Mustache-like template for custom text output (e.g. "{{id}}: {{name}}")

--json

output as JSON