This is an automated email from the ASF dual-hosted git repository.
weichiu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ozone.git
The following commit(s) were added to refs/heads/master by this push:
new 1de5c2f77aa HDDS-13755. Add doc for ozone sh snapshot listDiff command
(#9238)
1de5c2f77aa is described below
commit 1de5c2f77aa5558c7aa88cab3e57b0204abbea82
Author: rich7420 <[email protected]>
AuthorDate: Mon Nov 3 01:47:45 2025 +0800
HDDS-13755. Add doc for ozone sh snapshot listDiff command (#9238)
---
hadoop-hdds/docs/content/feature/Snapshot.md | 26 ++++++++++++++++++++++++++
1 file changed, 26 insertions(+)
diff --git a/hadoop-hdds/docs/content/feature/Snapshot.md
b/hadoop-hdds/docs/content/feature/Snapshot.md
index d6dcf7ea8da..2e013e3a3c4 100644
--- a/hadoop-hdds/docs/content/feature/Snapshot.md
+++ b/hadoop-hdds/docs/content/feature/Snapshot.md
@@ -100,6 +100,32 @@ Manage snapshots using `ozone sh` or `ozone fs`
(Hadoop-compatible) commands:
Output prefixes: `+` (add), `-` (delete), `M` (modify), `R` (rename). Use
`-p`, `-t` for pagination.
Manage diff jobs: `ozone sh snapshot listDiff /vol1/bucket1`, `ozone sh
snapshot cancelDiff <jobId>`.
+* **List Snapshot Diff Jobs:** Lists snapshot diff jobs for a bucket.
+ ```shell
+ ozone sh snapshot listDiff /vol1/bucket1
+ ```
+ By default, lists jobs with `in_progress` status. Use `--job-status` to
filter by specific status:
+ ```shell
+ # List jobs with specific status (queued, in_progress, done, failed,
rejected)
+ ozone sh snapshot listDiff /vol1/bucket1 --job-status done
+ ```
+ Use `--all-status` to list all jobs regardless of status:
+ ```shell
+ # List all snapshot diff jobs regardless of status
+ ozone sh snapshot listDiff /vol1/bucket1 --all-status
+ ```
+ **Note:** The difference between `--all-status` and `-all` (or `-a`):
+ * `--all-status`: Controls which jobs to show based on status (lists all
jobs regardless of status)
+ * `-all` (or `-a`): Controls the number of results returned (pagination
option, removes pagination limit, **not related to snapshot diff job status**)
+
+ For example:
+ ```shell
+ # List all jobs regardless of status, with pagination limit removed
+ ozone sh snapshot listDiff /vol1/bucket1 --all-status -all
+ # Or limit results to 10 items
+ ozone sh snapshot listDiff /vol1/bucket1 --all-status -l 10
+ ```
+
* **Rename Snapshot:**
```shell
ozone sh snapshot rename /vol1/bucket1 <oldName> <newName>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
