OS Manuals

/usr/bin/ceph-dedup-tool

Ceph test binaries and microbenchmarks

From ceph-18-test 18.2.8-r10 (enterprise-packages), captured 2026-11-08 by running ceph-dedup-tool --help (exit 0). permalink

Usage:
  -h [ --help ]                         : produce help message
  --op estimate --pool <POOL> --chunk-size <CHUNK_SIZE> --chunk-algorithm <ALGO> --fingerprint-algorithm <FP_ALGO>
                                        : estimate how many chunks are
                                        redundant
  --op chunk-scrub --chunk-pool <POOL>  : perform chunk scrub
  --op chunk-get-ref --chunk-pool <POOL> --object <OID> --target-ref <OID> --target-ref-pool-id <POOL_ID>
                                        : get chunk object's reference
  --op chunk-put-ref --chunk-pool <POOL> --object <OID> --target-ref <OID> --target-ref-pool-id <POOL_ID>
                                        : put chunk object's reference
  --op chunk-repair --chunk-pool <POOL> --object <OID> --target-ref <OID> --target-ref-pool-id <POOL_ID>
                                        : fix mismatched references
  --op dump-chunk-refs --chunk-pool <POOL> --object <OID>
                                        : dump chunk object's references
  --op chunk-dedup --pool <POOL> --object <OID> --chunk-pool <POOL> --fingerprint-algorithm <FP> --source-off <OFFSET> --source-length <LENGTH>
                                        : perform a chunk dedup---deduplicate
                                        only a chunk, which is a part of
                                        object.
  --op object-dedup --pool <POOL> --object <OID> --chunk-pool <POOL> --fingerprint-algorithm <FP> --dedup-cdc-chunk-size <CHUNK_SIZE> [--snap]
                                        : perform a object dedup---deduplicate
                                        the entire object, not a chunk. Related
                                        snapshots are also deduplicated if
                                        --snap is given
  --op sample-dedup --pool <POOL> --chunk-pool <POOL> --chunk-algorithm <ALGO> --fingerprint-algorithm <FP> --daemon --loop
                                        : perform a sample dedup---make
                                        crawling threads which crawl objects in
                                        base pool and deduplicate them based on
                                        their deduplication efficiency

Opational arguments:
  --op arg                              : estimate|chunk-scrub|chunk-get-ref|ch
                                        unk-put-ref|chunk-repair|dump-chunk-ref
                                        s|chunk-dedup|object-dedup
  --target-ref arg                      : set target object
  --target-ref-pool-id arg              : set target pool id
  --object arg                          : set object name
  --chunk-size arg                      : chunk size (byte)
  --chunk-algorithm arg                 : <fixed|fastcdc>, set chunk-algorithm
  --fingerprint-algorithm arg           : <sha1|sha256|sha512>, set
                                        fingerprint-algorithm
  --chunk-pool arg                      : set chunk pool name
  --max-thread arg                      : set max thread
  --report-period arg                   : set report-period
  --max-seconds arg                     : set max runtime
  --max-read-size arg                   : set max read size
  --pool arg                            : set pool name
  --min-chunk-size arg                  : min chunk size (byte)
  --max-chunk-size arg                  : max chunk size (byte)
  --source-off arg                      : set source offset
  --source-length arg                   : set source length
  --dedup-cdc-chunk-size arg            : set dedup chunk size for cdc
  --snap                                : deduplciate snapshotted object
  --debug                               : enable debug
  --pgid                                : set pgid
  --chunk-dedup-threshold arg           : set the threshold for chunk dedup
                                        (number of duplication)
  --sampling-ratio arg                  : set the sampling ratio (percentile)
  --daemon                              : execute sample dedup in daemon mode
  --loop                                : execute sample dedup in a loop until
                                        terminated. Sleeps 'wakeup-period'
                                        seconds between iterations
  --wakeup-period arg                   : set the wakeup period of crawler
                                        thread (sec)
Options (27)
OptionDescriptionSource
-h: produce help messagehelp
--op chunk-scrub: perform chunk scrubhelp
--target-ref arg: set target objecthelp
--target-ref-pool-id arg: set target pool idhelp
--object arg: set object namehelp
--chunk-size arg: chunk size (byte)help
--chunk-algorithm arg: <fixed|fastcdc>, set chunk-algorithmhelp
--fingerprint-algorithm arg: <sha1|sha256|sha512>, set fingerprint-algorithmhelp
--chunk-pool arg: set chunk pool namehelp
--max-thread arg: set max threadhelp
--report-period arg: set report-periodhelp
--max-seconds arg: set max runtimehelp
--max-read-size arg: set max read sizehelp
--pool arg: set pool namehelp
--min-chunk-size arg: min chunk size (byte)help
--max-chunk-size arg: max chunk size (byte)help
--source-off arg: set source offsethelp
--source-length arg: set source lengthhelp
--dedup-cdc-chunk-size arg: set dedup chunk size for cdchelp
--snap: deduplciate snapshotted objecthelp
--debug: enable debughelp
--pgid: set pgidhelp
--chunk-dedup-threshold arg: set the threshold for chunk dedup (number of duplication)help
--sampling-ratio arg: set the sampling ratio (percentile)help
--daemon: execute sample dedup in daemon modehelp
--loop: execute sample dedup in a loop until terminated.help
--wakeup-period arg: set the wakeup period of crawler thread (sec)help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.