File: delete_snapshots.md

package info (click to toggle)
elasticsearch-curator 8.0.21-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 2,716 kB
  • sloc: python: 17,838; makefile: 159; sh: 156
file content (45 lines) | stat: -rw-r--r-- 1,458 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
---
mapped_pages:
  - https://www.elastic.co/guide/en/elasticsearch/client/curator/current/delete_snapshots.html
---

# Delete Snapshots [delete_snapshots]

```yaml
action: delete_snapshots
description: "Delete selected snapshots from 'repository'"
options:
  repository: ...
  retry_interval: 120
  retry_count: 3
filters:
- filtertype: ...
```

::::{note}
Empty values and commented lines will result in the default value, if any, being selected.  If a setting is set, but not used by a given action, it will be ignored.
::::


This action deletes the selected snapshots from the selected [repository](/reference/option_repository.md).  If a snapshot is currently underway, Curator will retry up to [retry_count](/reference/option_retry_count.md) times, with a delay of [retry_interval](/reference/option_retry_interval.md) seconds between retries.

## Required settings [_required_settings_5]

* [repository](/reference/option_repository.md)


## Optional settings [_optional_settings_8]

* [retry_interval](/reference/option_retry_interval.md)
* [retry_count](/reference/option_retry_count.md)
* [ignore_empty_list](/reference/option_ignore_empty.md)
* [timeout_override](/reference/option_timeout_override.md)
* [continue_if_exception](/reference/option_continue.md)
* [disable_action](/reference/option_disable.md)

::::{tip}
See an example of this action in an [actionfile](/reference/actionfile.md) [here](/reference/ex_delete_snapshots.md).
::::