Allocation

		action: allocation
description: "Apply shard allocation filtering rules to the specified indices"
options:
  key: ...
  value: ...
  allocation_type: ...
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 changes the shard routing allocation for the selected indices.

See http://www.elastic.co/guide/en/elasticsearch/reference/8.15/shard-allocation-filtering.html for more information.

You can optionally set wait_for_completion to True to have Curator wait for the shard routing to complete before continuing:

		action: allocation
description: "Apply shard allocation filtering rules to the specified indices"
options:
  key: ...
  value: ...
  allocation_type: ...
  wait_for_completion: True
  max_wait: 300
  wait_interval: 10
filters:
- filtertype: ...

	

This configuration will wait for a maximum of 300 seconds for shard routing and reallocation to complete before giving up. A max_wait value of -1 will wait indefinitely. Curator will poll for completion at 10 second intervals, as defined by wait_interval.

Required settings

Optional settings

Tip

See an example of this action in an actionfile here.