ignore_unavailableedit

Note

This setting is used by the snapshot and restore actions.

This setting must be either True or False.

The default value of this setting is False

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.

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.