﻿---
title: value option
description: For the allocation action, the value of this setting should correspond to a node setting on one or more nodes in your cluster For example, you might have...
url: https://www.elastic.co/elastic/docs-builder/docs/3016/reference/elasticsearch/curator/option_value
products:
  - Elasticsearch
  - Elasticsearch Curator
---

# value option
<note>
  This setting is optional when using the [allocation action](https://www.elastic.co/elastic/docs-builder/docs/3016/reference/elasticsearch/curator/allocation) and required when using the [cluster_routing action](https://www.elastic.co/elastic/docs-builder/docs/3016/reference/elasticsearch/curator/cluster_routing).
</note>


## [allocation](https://www.elastic.co/elastic/docs-builder/docs/3016/reference/elasticsearch/curator/allocation)

For the [allocation action](https://www.elastic.co/elastic/docs-builder/docs/3016/reference/elasticsearch/curator/allocation), 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 value to `myvalue`. Additonally, if you used one of the special attribute names `_ip`, `_name`, `_id`, or `_host` for [key](https://www.elastic.co/elastic/docs-builder/docs/3016/reference/elasticsearch/curator/option_key), value can match the one of the node ip addresses, names, ids, or host names, respectively.
<note>
  To remove a routing allocation, the value of this setting should be left empty, or the `value` setting not even included as an option.
</note>

For example, you might have set
```sh
PUT test/_settings
{
  "index.routing.allocation.exclude.size": "small"
}
```

to keep index `test` from allocating shards on nodes that have `node.tag: small`. To remove this shard routing allocation setting, you might use an action file similar to this:
```yaml
---
  actions:
    1:
      action: allocation
      description: ->
        Unset 'index.routing.allocation.exclude.size' for index 'test' by
        passing an empty value.
      options:
        key: size
        value: ...
        allocation_type: exclude
      filters:
      - filtertype: pattern
        kind: regex
        value: '^test$'
```


## [cluster_routing](https://www.elastic.co/elastic/docs-builder/docs/3016/reference/elasticsearch/curator/cluster_routing)

For the [cluster_routing action](https://www.elastic.co/elastic/docs-builder/docs/3016/reference/elasticsearch/curator/cluster_routing), the acceptable values for this setting depend on the value of [routing_type](https://www.elastic.co/elastic/docs-builder/docs/3016/reference/elasticsearch/curator/option_routing_type).
```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
```

Acceptable values when [routing_type](https://www.elastic.co/elastic/docs-builder/docs/3016/reference/elasticsearch/curator/option_routing_type) is either `allocation` or `rebalance` are `all`, `primaries`, and  `none` (string, not `NoneType`).
If `routing_type` is `allocation`, this can also be `new_primaries`. If `routing_type` is `rebalance`, then the value can also be `replicas`.
There is no default value. This setting must be set by the user or an exception will be raised, and execution will halt.