Snapshot

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:
  # Leaving name blank will result in the default 'curator-%Y%m%d%H%M%S'
  name:
  ignore_unavailable: False
  include_global_state: True
  partial: False
  wait_for_completion: True
  skip_repo_fs_check: False
  timeout_override:
  continue_if_exception: False
  disable_action: False
filters:
- 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 snapshot indices to the indicated repository, with a name, or name pattern, as 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.

Required settings

edit

repository (required)

Optional settings

edit

name (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)
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.

« Restore Options »