name

This setting is used by the alias, create_index and snapshot, actions.

The value of this setting is the name of the alias, snapshot, or index, depending on which action makes use of name.

This setting may contain a valid Python strftime string. Curator will extract the strftime identifiers and replace them with the corresponding values.

The identifiers that Curator currently recognizes include:

Unit	Value
`%Y`	4 digit year
`%y`	2 digit year
`%m`	2 digit month
`%W`	2 digit week of the year
`%d`	2 digit day of the month
`%H`	2 digit hour of the day, in 24 hour notation
`%M`	2 digit minute of the hour
`%S`	2 digit second of the minute
`%j`	3 digit day of the year

alias

edit

action: alias
description: "Add/Remove selected indices to or from the specified alias"
options:
  name: alias_name
add:
  filters:
  - filtertype: ...
remove:
  filters:
  - filtertype: ...

This option is required by the alias action, and has no default setting in that context.

create_index

edit

For the create_index action, there is no default setting, but you can use strftime:

action: create_index
description: "Create index as named"
options:
  name: 'myindex-%Y.%m'
  # ...

or use Elasticsearch date math

action: create_index
description: "Create index as named"
options:
  name: '<logstash-{now/d+1d}>'
  # ...

to name your indices. See more in the create_index documenation.

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:
  include_global_state: True
  wait_for_completion: True
  max_wait: 3600
  wait_interval: 10
filters:
- filtertype: ...

For the snapshot action, the default value of this setting is curator-%Y%m%d%H%M%S

« max_num_segments partial »