Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 14 additions & 13 deletions docs/_docs/snapshots/snapshots.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -289,35 +289,36 @@ control.(sh|bat) --snapshot restore snapshot_09062021 --increment 1

== Getting Snapshot Operation Status

The status of the current snapshot operation in the cluster can be obtained using the `control.sh|bat` script or JMX interface:
The status of current snapshot operations in the cluster can be obtained using the `control.sh|bat` script.

Snapshot operations include: │
* `Create` - Full or incremental snapshot creation
* `Restore` - Cache group restoration from snapshot
* `Check` - Snapshot consistency verification (parallel execution allowed) │

[tabs]
--
tab:Unix[]
[source,shell]
----
# Get the status of the snapshot operation.
# Get the status of snapshot operation.
control.sh --snapshot status
----

tab:Windows[]
[source,shell]
----
# Get the status of the snapshot operation.
# Get the status of snapshot operation.
control.bat --snapshot status
----

tab:JMX[]
You can also get the current snapshot status via the `SnapshotMXBean` interface:
[source,java]
----
SnapshotMXBean mxBean = ...;

// The status of a current snapshot operation in the cluster.
String status = mxBean.status();
----
--

[NOTE] │
==== │
Parallel and multiple snapshot check operations can be running concurrently with any other snapshot operation.
But only one check for one snapshot. Create and restore operations cannot run in parallel - only one of each type can
be active at a time. The status is printed for each running snapshot operation (if multiple) separately, one after another.

== Cancelling Snapshot Operation

To abort create/restore snapshot operation you need to obtain an `operation request ID`.
Expand Down
Loading