slm-settings.asciidoc 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. [role="xpack"]
  2. [[slm-settings]]
  3. === {slm-cap} settings in {es}
  4. [subs="attributes"]
  5. ++++
  6. <titleabbrev>{slm-cap} settings</titleabbrev>
  7. ++++
  8. These are the settings available for configuring
  9. <<snapshot-lifecycle-management, {slm}>> ({slm-init}).
  10. ==== Cluster-level settings
  11. [[slm-history-index-enabled]]
  12. `slm.history_index_enabled`::
  13. (<<static-cluster-setting,Static>>, boolean)
  14. Controls whether {slm-init} records the history of actions taken as part of {slm-init} policies
  15. to the `slm-history-*` indices. Defaults to `true`.
  16. [[slm-retention-schedule]]
  17. `slm.retention_schedule`::
  18. (<<dynamic-cluster-setting,Dynamic>>, <<schedule-cron,cron scheduler value>>)
  19. Controls when the <<slm-retention,retention task>> runs.
  20. Can be a periodic or absolute time schedule.
  21. Supports all values supported by the <<schedule-cron,cron scheduler>>.
  22. Defaults to daily at 1:30am UTC: `0 30 1 * * ?`.
  23. [[slm-retention-duration]]
  24. `slm.retention_duration`::
  25. (<<dynamic-cluster-setting,Dynamic>>, <<time-units,time value>>)
  26. Limits how long {slm-init} should spend deleting old snapshots.
  27. Defaults to one hour: `1h`.
  28. [[repositories-url-allowed]]
  29. // tag::repositories-url-allowed[]
  30. `repositories.url.allowed_urls` {ess-icon}::
  31. (<<static-cluster-setting,Static>>)
  32. Specifies the <<snapshots-read-only-repository,read-only URL repositories>> that snapshots can be restored from.
  33. // end::repositories-url-allowed[]