stack es snapshot get cli command

elastic stack es snapshot get \
  --repository <repository> \
  --snapshot <snapshot> \
  [options]
		

Get snapshot information.

Behaviour flags:

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

--repository string required

A comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported.

--snapshot string required

A comma-separated list of snapshot names to retrieve Wildcards (*) are supported. * To get information about all snapshots in a registered repository, use a wildcard (*) or _all.

• To get information about any snapshots that are currently running, use _current.

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

--after string

An offset identifier to start pagination from as returned by the next field in the response body.

--from-sort-value string

The value of the current sort column at which to start retrieval. It can be a string snapshot- or a repository name when sorting by snapshot or repository name. It can be a millisecond time value or a number when sorting by index- or shard count.

--ignore-unavailable

If false, the request returns an error for any snapshots that are unavailable.

--index-details

If true, the response includes additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index. The default is false, meaning that this information is omitted.

--index-names

If true, the response includes the name of each index in each snapshot.

--include-repository

If true, the response includes the repository name in each snapshot.

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

--order enum

The sort order. Valid values are asc for ascending and desc for descending order. The default behavior is ascending order.

Values: asc, desc

--offset number

Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0.

--size number

The maximum number of snapshots to return. The default is -1, which means to return all that match the request without limit.

--slm-policy-filter string

Filter snapshots by a comma-separated list of snapshot lifecycle management (SLM) policy names that snapshots belong to. You can use wildcards (*) and combinations of wildcards followed by exclude patterns starting with -. For example, the pattern *,-policy-a-\* will return all snapshots except for those that were created by an SLM policy with a name starting with policy-a-. Note that the wildcard pattern * matches all snapshots created by an SLM policy but not those snapshots that were not created by an SLM policy. To include snapshots that were not created by an SLM policy, you can use the special pattern _none that will match all snapshots without an SLM policy.

--sort enum

The sort order for the result. The default behavior is sorting by snapshot start time stamp.

Values: start_time, duration, name, index_count, repository, shard_count, failed_shard_count

--state enum

Only return snapshots with a state found in the given comma-separated list of snapshot states. The default is all snapshot states.

Values: IN_PROGRESS, SUCCESS, FAILED, PARTIAL, INCOMPATIBLE

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

--verbose

If true, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. NOTE: The parameters size, order, after, from_sort_value, offset, slm_policy_filter, and sort are not supported when you set verbose=false and the sort order for requests with verbose=false is undefined.

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

--json

output as JSON