Type to search.

stack es snapshot repository-verify-integrity cli command

Serverless Preview

Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud.

Availability

  • Preview

    This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply.

Serverless interfaces and procedures might differ from classic Elastic Stack deployments.

Stack Preview

The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.

Availability

  • Preview

    This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply.

Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.

This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Auth required
Shell
elastic stack es snapshot repository-verify-integrity \
  --repository <repository> \
  [options]

Verify the repository integrity.

Behaviour flags:

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

--repository string required

The name of the snapshot repository.

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

--blob-thread-pool-concurrency number
If verify_blob_contents is true, this parameter specifies how many blobs to verify at once.
--index-snapshot-verification-concurrency number
The maximum number of index snapshots to verify concurrently within each index verification.
--index-verification-concurrency number
The number of indices to verify concurrently. The default behavior is to use the entire snapshot_meta thread pool.
--max-bytes-per-sec string
If verify_blob_contents is true, this parameter specifies the maximum amount of data that Elasticsearch will read from the repository every second.
--max-failed-shard-snapshots number
The number of shard snapshot failures to track during integrity verification, in order to avoid excessive resource usage. If your repository contains more than this number of shard snapshot failures, the verification will fail.
--meta-thread-pool-concurrency number
The maximum number of snapshot metadata operations to run concurrently. The default behavior is to use at most half of the snapshot_meta thread pool at once.
--snapshot-verification-concurrency number
The number of snapshots to verify concurrently. The default behavior is to use at most half of the snapshot_meta thread pool at once.
--verify-blob-contents
Indicates whether to verify the checksum of every data blob in the repository. If this feature is enabled, Elasticsearch will read the entire repository contents, which may be extremely slow and expensive.
--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