ignore_unavailable

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

ignore_unavailable

edit

This setting is used by the snapshot, restore, and index_settings actions.

This setting must be either True or False.

The default value of this setting is False

restore

edit

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

When the ignore_unavailable option is False and an index is missing the restore request will fail.

snapshot

edit

action: snapshot
description: >-
  Snapshot selected indices to 'repository' with the snapshot name or name
  pattern in 'name'.  Use all other options as assigned
options:
  repository: my_repository
  name: my_snapshot
  ignore_unavailable: False
  wait_for_completion: True
  max_wait: 3600
  wait_interval: 10
filters:
- filtertype: ...

When the ignore_unavailable option is False and an index is missing, the snapshot request will fail. This is not frequently a concern in Curator, as it should only ever find indices that exist.

index_settings

edit

action: index_settings
description: "Change settings for selected indices"
options:
  index_settings:
    index:
      refresh_interval: 5s
  ignore_unavailable: False
  preserve_existing: False
filters:
- filtertype: ...

When the ignore_unavailable option is False and an index is missing, or if the request is to apply a static setting and the index is opened, the index setting request will fail. The ignore_unavailable option allows these indices to be skipped, when set to True.

Dynamic index settings can be applied to either open or closed indices.

« ignore_empty_list include_aliases »