stack es open-point-in-time cli command

elastic stack es open-point-in-time \
  --keep-alive <keep-alive> \
  --index <index> \
  [options]

Open a point in time.

Behaviour flags:

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

--keep-alive string required

Extend the length of time that the point in time persists.

--index string required

A comma-separated list of index names to open point in time; use _all or empty string to perform the operation on all indices

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

--ignore-unavailable

If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored.

--preference string

The node or shard the operation should be performed on. By default, it is random.

--routing string

A custom value that is used to route operations to a specific shard.

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

--expand-wildcards enum

The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as open,hidden.

Values: all, open, closed, hidden, none

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

--allow-partial-search-results

Indicates whether the point in time tolerates unavailable shards or shard failures when initially creating the PIT. If false, creating a point in time request when a shard is missing or unavailable will throw an exception. If true, the point in time will contain all the shards that are available at the time of the request.

--max-concurrent-shard-requests number

Maximum number of concurrent shard requests that each sub-search request executes per node.

--index-filter string

Filter indices if the provided query rewrites to match_none on every shard.

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