File: close.md

package info (click to toggle)
elasticsearch-curator 9.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,740 kB
  • sloc: python: 18,836; makefile: 159; sh: 156
file content (41 lines) | stat: -rw-r--r-- 1,160 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
---
mapped_pages:
  - https://www.elastic.co/guide/en/elasticsearch/client/curator/current/close.html
navigation_title: Close
---

# Curator close action for {{es}} indices [close]

```yaml
action: close
description: "Close selected indices"
options:
  delete_aliases: false
  skip_flush: false
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 closes the selected indices, and optionally deletes associated aliases beforehand.

## Optional settings [_optional_settings_3]

* [search_pattern](/reference/option_search_pattern.md)
* [delete_aliases](/reference/option_delete_aliases.md)
* [skip_flush](/reference/option_skip_flush.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_close.md).
::::