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
|
---
mapped_pages:
- https://www.elastic.co/guide/en/elasticsearch/client/curator/current/fe_key.html
---
# key [fe_key]
::::{note}
This setting is required when using the [allocated filtertype](/reference/filtertype_allocated.md).
::::
```yaml
- filtertype: allocated
key: ...
value: ...
allocation_type:
exclude: True
```
The value of this setting should correspond to a node setting on one or more nodes in your cluster.
For example, you might have set
```sh
node.tag: myvalue
```
in your `elasticsearch.yml` file for one or more of your nodes. To match allocation in this case, set key to `tag`.
These special attributes are also supported:
| attribute | description |
| --- | --- |
| `_name` | Match nodes by node name |
| `_host_ip` | Match nodes by host IP address (IP associated with hostname) |
| `_publish_ip` | Match nodes by publish IP address |
| `_ip` | Match either `_host_ip` or `_publish_ip` |
| `_host` | Match nodes by hostname |
There is no default value. This setting must be set by the user or an exception will be raised, and execution will halt.
|