OS Manuals

/usr/bin/cephfs-journal-tool

Common utilities to mount and interact with a Ceph storage cluster

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

Usage:
  cephfs-journal-tool [options] journal <command>
    <command>:
      inspect
      import <path> [--force]
      export <path>
      reset [--force] <--yes-i-really-really-mean-it>
  cephfs-journal-tool [options] header <get|set> <field> <value>
    <field>: [trimmed_pos|expire_pos|write_pos|pool_id]
  cephfs-journal-tool [options] event <effect> <selector> <output> [special options]
    <selector>:
      --range=<start>..<end>
      --path=<substring>
      --inode=<integer>
      --type=<UPDATE|OPEN|SESSION...><
      --frag=<ino>.<frag> [--dname=<dentry string>]
      --client=<session id integer>
    <effect>: [get|recover_dentries|splice]
    <output>: [summary|list|binary|json] [--path <path>]

General options:
  --rank=filesystem:{mds-rank|all} journal rank or "all" ranks (mandatory)
  --journal=<mdlog|purge_queue>  Journal type (purge_queue means
                                 this journal is used to queue for purge operation,
                                 default is mdlog, and only mdlog support event mode)

Special options
  --alternate-pool <name>     Alternative metadata pool to target
                              when using recover_dentries.
  --conf/-c FILE    read configuration from the given configuration file
  --id ID           set ID portion of my name
  --name/-n TYPE.ID set name
  --cluster NAME    set cluster name (default: ceph)
  --setuser USER    set uid to user or uid (and gid to user's gid)
  --setgroup GROUP  set gid to group or gid
  --version         show version and quit
Options (11)
OptionDescriptionSource
--range start>..<endhelp
--path substringhelp
--inode integerhelp
--type UPDATE|OPEN|SESSION...help
--journal mdlog|purge_queueJournal type (purge_queue means this journal is used to queue for purge operation, default is mdlog, and only mdlog support event mode)help
--alternate-pool nameAlternative metadata pool to target when using recover_dentries.help
--id IDset ID portion of my namehelp
--cluster NAMEset cluster name (default: ceph)help
--setuser USERset uid to user or uid (and gid to user's gid)help
--setgroup GROUPset gid to group or gidhelp
--versionshow version and quithelp

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