stack es cluster health cli command

elastic stack es cluster health [options]

Get the cluster health status.

Behaviour flags:

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

--expand-wildcards enum

Expand wildcard expression to concrete indices that are open, closed or both.

Values: all, open, closed, hidden, none

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

--level enum

Return health information at a specific level of detail.

Values: cluster, indices, shards

--local

If true, retrieve information from the local node only. If false, retrieve information from the master node.

--master-timeout string

The 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

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

--wait-for-active-shards string

Wait for the specified number of active shards. Use all to wait for all shards in the cluster to be active. Use 0 to not wait.

--wait-for-events enum

Wait until all currently queued events with the given priority are processed.

Values: immediate, urgent, high, normal, low, languid

--wait-for-nodes string

Wait until the specified number (N) of nodes is available. It also accepts >=N, <=N, >N and <N. Alternatively, use the notations ge(N), le(N), gt(N), and lt(N).

--wait-for-no-initializing-shards

Wait (until the timeout expires) for the cluster to have no shard initializations. If false, the request does not wait for initializing shards.

--wait-for-no-relocating-shards

Wait (until the timeout expires) for the cluster to have no shard relocations. If false, the request not wait for relocating shards.

--wait-for-status enum

Wait (until the timeout expires) for the cluster to reach a specific health status (or a better status). A green status is better than yellow and yellow is better than red. By default, the request does not wait for a particular status.

Values: green, yellow, red, unknown, unavailable

--index string

A comma-separated list of data streams, indices, and index aliases that limit the request. Wildcard expressions (*) are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or *.

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

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