› ›

include_global_state

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

include_global_state

This setting is used by the snapshot and restore actions.

This setting must be either True or False.

The value of this setting determines whether Elasticsearch should include the global cluster state with the snapshot or restore.

When performing a snapshot, the default value of this setting is True.

When performing a restore, the default value of this setting is False.

restore

edit

actions:
  1:
    action: restore
    description: Restore my_index from my_snapshot in my_repository
    options:
      repository: my_repository
      name: my_snapshot
      indices: my_index
      include_global_state: False
      wait_for_completion: True
      max_wait: 3600
      wait_interval: 10
    filters:
    - filtertype: state
      state: SUCCESS
      exclude:
    - filtertype: ...

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

« include_aliases indices »