A newer version is available. For the latest information, see the
current release documentation.
Restore
editRestore
editactions: 1: action: restore description: >- Restore all indices in the most recent snapshot with state SUCCESS. Wait for the restore to complete before continuing. Do not skip the repository filesystem access check. Use the other options to define the index/shard settings for the restore. options: repository: # Leaving name blank will result in restoring the most recent snapshot by age name: # Leaving indices blank will result in restoring all indices in the snapshot indices: include_aliases: False ignore_unavailable: False include_global_state: True partial: False rename_pattern: rename_replacement: extra_settings: wait_for_completion: True skip_repo_fs_check: False timeout_override: continue_if_exception: False disable_action: False filters: - filtertype: state state: SUCCESS exclude: - filtertype: ...
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 will restore indices from the indicated repository, from the most recent snapshot identified by the applied filters, or the snapshot identified by name.
The other options are usually okay to leave at the defaults, but feel free to read about them and change them accordingly.
The extra_settings option allows the addition of extra settings, such as index settings and mappings. An example of how these settings can be used to change settings for an index being restored might be:
extra_settings: settings: number_of_shards: 1 number_of_replicas: 0 mappings: type1 : properties: field1: type: string index: not_analyzed
Required settings
edit- repository (required)
Optional settings
edit- name (has no default value)
- include_aliases (has a default value which can optionally be changed)
- indices (has a default value which can optionally be changed)
- ignore_unavailable (has a default value which can optionally be changed)
- include_global_state (has a default value which can optionally be changed)
- partial (has a default value which can optionally be changed)
- rename_pattern (has no default value)
- rename_replacement (has no default value)
- extra_settings (has no default value.)
- wait_for_completion (has a default value which can optionally be changed)
- skip_repo_fs_check (has a default value which can optionally be changed)
- ignore_empty_list (can override the default)
- timeout_override (can override the default timeout)
- continue_if_exception (has a default value which can optionally be changed)
- disable_action (has a default value which can optionally be changed)
See an example of this action in an actionfile here.