From: Ronen Friedman <rfriedma@redhat.com>
Date: Sun, 14 Dec 2025 14:39:39 +0000 (-0600)
Subject: doc/ceph.rst: scrub-related 'tell pgid' commands
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=8efed0df0c70fb512dda911c862fd7e7b850e766;p=ceph.git

doc/ceph.rst: scrub-related 'tell pgid' commands

Documenting the recently added 'ceph tell <pgid> scrub-abort'
command.

As this is the first command using the 'tell <pgid>' syntax
that is documented, also adding the two other scrub-related ``tell``
commands.

Note that the 'tell <pgid> scrub-abort' is the only available
format of this specific command. The other two commands
also support the 'tell pg <cmd> <pgid>' format.

Signed-off-by: Ronen Friedman <rfriedma@redhat.com>
---

diff --git a/doc/man/8/ceph.rst b/doc/man/8/ceph.rst
index 39830401f3ac..0afc3cbbe266 100644
--- a/doc/man/8/ceph.rst
+++ b/doc/man/8/ceph.rst
@@ -59,6 +59,8 @@ Synopsis
 
 | **ceph** **tell** *<name (type.id)> <command> [options...]*
 
+| **ceph** **tell** *<pgid> <command> [options...]*
+
 | **ceph** **version**
 
 Description
@@ -1564,6 +1566,32 @@ Usage::
 
 	ceph pg stat
 
+A second format for PG-directed commands is the following:
+
+Using the ``tell`` command with a PG identifier. This sends a command to the OSD
+that is currently acting as the primary for the specified PG.
+
+Subcommand ``scrub`` starts a scrub of <pgid>, similar
+to ``ceph pg scrub <pgid>``.
+
+Usage::
+
+	ceph tell <pgid> scrub
+
+Subcommand ``deep-scrub`` starts a deep-scrub of <pgid>, similar
+to ``ceph pg deep-scrub <pgid>``.
+
+Usage::
+
+	ceph tell <pgid> deep-scrub
+
+Subcommand ``scrub-abort`` aborts any ongoing scrub of <pgid>, and removes
+any previous scrub or deep scrub operator request for the PG.
+
+Usage::
+
+	ceph tell <pgid> scrub-abort
+
 
 quorum
 ------