New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
« Shrink Options »
Elastic Docs ›Curator Reference [8.0] ›Actions

Snapshot

edit

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: ...
  # Leaving name blank will result in the default 'curator-%Y%m%d%H%M%S'
  name:
  wait_for_completion: True
  max_wait: 3600
  wait_interval: 10
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

Optional settings

edit

See an example of this action in an actionfile here.

« Shrink Options »
Was this helpful?
Feedback