mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-07 21:48:39 +00:00
c0156cbb5d
* [DOCS] Align with ILM API docs (#48705) * [DOCS] Reconciled with Snapshot/Restore reorg * [DOCS] Split off ILM overview to a separate topic. (#51287) * [DOCS} Split off overview to a separate topic. * [DOCS] Incorporated feedback from @jrodewig. * [DOCS] Edit ILM GS tutorial (#51513) * [DOCS] Edit ILM GS tutorial * [DOCS] Incorporated review feedback from @andreidan. * [DOCS] Removed test link & fixed anchor & title. * Update docs/reference/ilm/getting-started-ilm.asciidoc Co-Authored-By: James Rodewig <james.rodewig@elastic.co> * Fixed glossary merge error. Co-authored-by: James Rodewig <james.rodewig@elastic.co>
48 lines
1.4 KiB
Plaintext
48 lines
1.4 KiB
Plaintext
[[slm-api-stop]]
|
|
=== Stop {slm} API
|
|
|
|
[subs="attributes"]
|
|
++++
|
|
<titleabbrev>Stop {slm}</titleabbrev>
|
|
++++
|
|
|
|
Turn off {slm} ({slm-init}).
|
|
|
|
[[slm-api-stop-request]]
|
|
==== {api-request-title}
|
|
|
|
`POST /_slm/stop`
|
|
|
|
[[slm-api-stop-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
If the {es} {security-features} are enabled, you must have the `manage_slm`
|
|
cluster privilege to use this API. For more information, see
|
|
<<security-privileges>>.
|
|
|
|
[[slm-api-stop-desc]]
|
|
==== {api-description-title}
|
|
|
|
Halts all {slm} ({slm-init}) operations and stops the {slm-init} plugin.
|
|
This is useful when you are performing maintenance on a cluster and need to
|
|
prevent {slm-init} from performing any actions on your indices.
|
|
Stopping {slm-init} does not stop any snapshots that are in progress.
|
|
You can manually trigger snapshots with the <<slm-api-execute-lifecycle>> even if {slm-init} is stopped.
|
|
|
|
The API returns a response as soon as the request is acknowledged, but
|
|
the plugin might continue to run until in-progress operations complete and it can be safely stopped.
|
|
This conversation was marked as resolved by debadair
|
|
Use the <<slm-api-get-status>> to see if {slm-init} is running.
|
|
|
|
==== {api-query-parms-title}
|
|
|
|
include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
|
|
|
[[slm-api-stop-example]]
|
|
==== {api-examples-title}
|
|
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
POST _slm/stop
|
|
-------------------------------------------------- |