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

# setting [option_setting]

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


```yaml
action: cluster_routing
description: "Apply routing rules to the entire cluster"
options:
  routing_type:
  value: ...
  setting: enable
  wait_for_completion: True
  max_wait: 300
  wait_interval: 10
```

The value of this must be `enable` at present.  It is a placeholder for future expansion.

There is no default value. This setting must be set by the user or an exception will be raised, and execution will halt.