3 =========================================
4 rbd-nbd -- map rbd images to nbd device
5 =========================================
12 | **rbd-nbd** [-c conf] [--read-only] [--device *nbd device*] [--nbds_max *limit*] [--max_part *limit*] [--exclusive] [--notrim] [--encryption-format *format*] [--encryption-passphrase-file *passphrase-file*] [--io-timeout *seconds*] [--reattach-timeout *seconds*] map *image-spec* | *snap-spec*
13 | **rbd-nbd** unmap *nbd device* | *image-spec* | *snap-spec*
14 | **rbd-nbd** list-mapped
15 | **rbd-nbd** attach --device *nbd device* *image-spec* | *snap-spec*
16 | **rbd-nbd** detach *nbd device* | *image-spec* | *snap-spec*
21 **rbd-nbd** is a client for RADOS block device (rbd) images like rbd kernel module.
22 It will map a rbd image to a nbd (Network Block Device) device, allowing access it
23 as regular local block device.
28 .. option:: -c ceph.conf
30 Use *ceph.conf* configuration file instead of the default
31 ``/etc/ceph/ceph.conf`` to determine monitor addresses during startup.
33 .. option:: --read-only
37 .. option:: --nbds_max *limit*
39 Override the parameter nbds_max of NBD kernel module when modprobe, used to
40 limit the count of nbd device.
42 .. option:: --max_part *limit*
44 Override for module param max_part.
46 .. option:: --exclusive
48 Forbid writes by other clients.
52 Turn off trim/discard.
54 .. option:: --encryption-format
56 Image encryption format.
57 Possible values: *luks1*, *luks2*
59 .. option:: --encryption-passphrase-file
61 Path of file containing a passphrase for unlocking image encryption.
63 .. option:: --io-timeout *seconds*
65 Override device timeout. Linux kernel will default to a 30 second request timeout.
66 Allow the user to optionally specify an alternate timeout.
68 .. option:: --reattach-timeout *seconds*
70 Specify timeout for the kernel to wait for a new rbd-nbd process is
71 attached after the old process is detached. The default is 30
77 | *image-spec* is [*pool-name*]/*image-name*
78 | *snap-spec* is [*pool-name*]/*image-name*\ @\ *snap-name*
80 The default for *pool-name* is "rbd". If an image name contains a slash
81 character ('/'), *pool-name* is required.
86 **rbd-nbd** is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to
87 the Ceph documentation at https://docs.ceph.com/ for more information.