OS Manuals

/usr/bin/ceph-objectstore-tool

Ceph OSD (Object Storage Daemon)

From ceph-18-osd 18.2.8-r10 (enterprise-packages), captured 2026-11-08 by running ceph-objectstore-tool --help (exit 1). permalink

Allowed options:
  --help                      produce help message
  --type arg                  Arg is one of [bluestore (default), memstore]
  --data-path arg             path to object store, mandatory
  --journal-path arg          path to journal, use if tool can't find it
  --pgid arg                  PG id, mandatory for info, log, remove, export,
                              export-remove, mark-complete, trim-pg-log,
                              trim-pg-log-dups
  --pool arg                  Pool name
  --op arg                    Arg is one of [info, log, remove, mkfs, fsck,
                              repair, fuse, dup, export, export-remove, import,
                              list, list-slow-omap, fix-lost, list-pgs,
                              dump-super, meta-list, get-osdmap, set-osdmap,
                              get-superblock, set-superblock, get-inc-osdmap,
                              set-inc-osdmap, mark-complete,
                              reset-last-complete, update-mon-db, dump-export,
                              trim-pg-log, trim-pg-log-dups statfs]
  --epoch arg                 epoch# for get-osdmap and get-inc-osdmap, the
                              current epoch in use if not specified
  --file arg                  path of file to export, export-remove, import,
                              get-osdmap, set-osdmap, get-superblock,
                              set-superblock, get-inc-osdmap or set-inc-osdmap
  --mon-store-path arg        path of monstore to update-mon-db
  --fsid arg                  fsid for new store created by mkfs
  --target-data-path arg      path of target object store (for --op dup)
  --mountpoint arg            fuse mountpoint
  --format arg (=json-pretty) Output format which may be json, json-pretty,
                              xml, xml-pretty
  --debug                     Enable diagnostic output to stderr
  --no-mon-config             Do not contact mons for config
  --no-superblock             Do not read superblock
  --force                     Ignore some types of errors and proceed with
                              operation - USE WITH CAUTION: CORRUPTION POSSIBLE
                              NOW OR IN THE FUTURE
  --skip-journal-replay       Disable journal replay
  --skip-mount-omap           Disable mounting of omap
  --head                      Find head/snapdir when searching for objects by
                              name
  --dry-run                   Don't modify the objectstore
  --tty                       Treat stdout as a tty (no binary data)
  --namespace arg             Specify namespace when searching for objects
  --rmtype arg                Specify corrupting object removal 'snapmap' or
                              'nosnapmap' - TESTING USE ONLY
  --slow-omap-threshold arg   Threshold (in seconds) to consider omap listing
                              slow (for op=list-slow-omap)


Positional syntax:

ceph-objectstore-tool ... <object> (get|set)-bytes [file]
ceph-objectstore-tool ... <object> set-(attr|omap) <key> [file]
ceph-objectstore-tool ... <object> (get|rm)-(attr|omap) <key>
ceph-objectstore-tool ... <object> get-omaphdr
ceph-objectstore-tool ... <object> set-omaphdr [file]
ceph-objectstore-tool ... <object> list-attrs
ceph-objectstore-tool ... <object> list-omap
ceph-objectstore-tool ... <object> remove|removeall
ceph-objectstore-tool ... <object> dump
ceph-objectstore-tool ... <object> set-size
ceph-objectstore-tool ... <object> clear-data-digest
ceph-objectstore-tool ... <object> remove-clone-metadata <cloneid>

<object> can be a JSON object description as displayed
by --op list.
<object> can be an object name which will be looked up in all
the OSD's PGs.
<object> can be the empty string ('') which with a provided pgid
specifies the pgmeta object

The optional [file] argument will read stdin or write stdout
if not specified or if '-' specified.
Options (25)
OptionDescriptionSource
--helpproduce help messagehelp
--type argArg is one of [bluestore (default), memstore]help
--data-path argpath to object store, mandatoryhelp
--journal-path argpath to journal, use if tool can't find ithelp
--pgid argPG id, mandatory for info, log, remove, export, export-remove, mark-complete, trim-pg-log, trim-pg-log-dupshelp
--pool argPool namehelp
--op argArg is one of [info, log, remove, mkfs, fsck, repair, fuse, dup, export, export-remove, import, list, list-slow-omap, fix-lost, list-pgs, dump-super, meta-list, get-osdmap, set-osdmap,…help
--epoch argepoch# for get-osdmap and get-inc-osdmap, the current epoch in use if not specifiedhelp
--file argpath of file to export, export-remove, import, get-osdmap, set-osdmap, get-superblock, set-superblock, get-inc-osdmap or set-inc-osdmaphelp
--mon-store-path argpath of monstore to update-mon-dbhelp
--fsid argfsid for new store created by mkfshelp
--target-data-path argpath of target object store (for --op dup)help
--mountpoint argfuse mountpointhelp
--debugEnable diagnostic output to stderrhelp
--no-mon-configDo not contact mons for confighelp
--no-superblockDo not read superblockhelp
--forceIgnore some types of errors and proceed with operation - USE WITH CAUTION: CORRUPTION POSSIBLE NOW OR IN THE FUTUREhelp
--skip-journal-replayDisable journal replayhelp
--skip-mount-omapDisable mounting of omaphelp
--headFind head/snapdir when searching for objects by namehelp
--dry-runDon't modify the objectstorehelp
--ttyTreat stdout as a tty (no binary data)help
--namespace argSpecify namespace when searching for objectshelp
--rmtype argSpecify corrupting object removal 'snapmap' or 'nosnapmap' - TESTING USE ONLYhelp
--slow-omap-threshold argThreshold (in seconds) to consider omap listing slow (for op=list-slow-omap)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.