File: option_include_aliases.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 (38 lines) | stat: -rw-r--r-- 880 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
---
mapped_pages:
  - https://www.elastic.co/guide/en/elasticsearch/client/curator/current/option_include_aliases.html
---

# include_aliases [option_include_aliases]

::::{note}
This setting is only used by the [restore](/reference/restore.md) action.
::::


```yaml
actions:
  1:
    action: restore
    description: Restore my_index from my_snapshot in my_repository
    options:
      repository: my_repository
      name: my_snapshot
      indices: my_index
      include_aliases: True
      wait_for_completion: True
      max_wait: 3600
      wait_interval: 10
    filters:
    - filtertype: state
      state: SUCCESS
      exclude:
    - filtertype: ...
```

This setting must be either `True` or `False`.

The value of this setting determines whether Elasticsearch should include index aliases when restoring the snapshot.

The default value of this setting is `False`