OS Manuals

/usr/bin/rbd-nbd

Ceph FUSE client and rbd FUSE/NBD adapters

From ceph-fips-19-fuse 19.2.7-r4 (enterprise-packages), captured 2026-11-08 by running rbd-nbd --help (exit 0). permalink

Usage: rbd-nbd [options] map <image-or-snap-spec>    Map image to nbd device
               detach <device|image-or-snap-spec>    Detach image from nbd device
               [options] attach <image-or-snap-spec> Attach image to nbd device
               unmap <device|image-or-snap-spec>     Unmap nbd device
               [options] list-mapped                 List mapped nbd devices
Map and attach options:
  --device <device path>        Specify nbd device path (/dev/nbd{num})
  --encryption-format luks|luks1|luks2
                                Image encryption format (default: luks)
  --encryption-passphrase-file  Path of file containing passphrase for unlocking image encryption
  --exclusive                   Forbid writes by other clients
  --notrim                      Turn off trim/discard
  --io-timeout <sec>            Set nbd IO timeout
  --max_part <limit>            Override for module param max_part
  --nbds_max <limit>            Override for module param nbds_max
  --quiesce                     Use quiesce callbacks
  --quiesce-hook <path>         Specify quiesce hook path
                                (default: libexec/rbd-nbd/rbd-nbd_quiesce)
  --read-only                   Map read-only
  --reattach-timeout <sec>      Set nbd re-attach timeout
                                (default: 30)
  --show-cookie                 Show device cookie
  --cookie                      Specify device cookie
  --snap-id <snap-id>           Specify snapshot by ID instead of by name

Unmap and detach options:
  --device <device path>        Specify nbd device path (/dev/nbd{num})
  --snap-id <snap-id>           Specify snapshot by ID instead of by name

List options:
  --format plain|json|xml Output format (default: plain)
  --pretty-format         Pretty formatting (json and xml)

  --conf/-c FILE    read configuration from the given configuration file
  --id/-i 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

  -d                run in foreground, log to stderr
  -f                run in foreground, log to usual location

  --debug_ms N      set message debug level (e.g. 1)
Options (24)
OptionDescriptionSource
--device deviceSpecify nbd device path (/dev/nbd{num})help
--encryption-format luks|luks1|luks2Image encryption format (default: luks)help + man
--encryption-passphrase-filePath of file containing a passphrase for unlocking image encryption.help + man
--exclusiveForbid writes by other clients.help + man
--notrimTurn off trim/discard.help + man
--io-timeout secOverride device timeout.help + man
--max_part limitOverride for module param max_part.help + man
--nbds_max limitOverride the parameter nbds_max of NBD kernel module when modprobe, used to limit the count of nbd device.help + man
--quiesceUse quiesce callbackshelp
--quiesce-hook pathSpecify quiesce hook path (default: libexec/rbd-nbd/rbd-nbd_quiesce)help
--read-onlyMap read-only.help + man
--reattach-timeout secSpecify timeout for the kernel to wait for a new rbd-nbd process is attached after the old process is detached.help + man
--show-cookieShow device cookiehelp
--cookieSpecify device cookiehelp
--snap-id snap-idSpecify a snapshot to map/unmap/attach/detach by ID instead of by name.help + man
--pretty-formatPretty formatting (json and xml)help
--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
-drun in foreground, log to stderrhelp
-frun in foreground, log to usual locationhelp
--debug_ms Nset message debug level (e.g. 1)help
-c ceph.confUse ceph.conf configuration file instead of the default /etc/ceph/ceph.conf to determine monitor addresses during startup. (in the manual page but not in --help)man

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