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] [--timeout *seconds*] map *image-spec* | *snap-spec*
13 | **rbd-nbd** unmap *nbd device*
14 | **rbd-nbd** list-mapped
19 **rbd-nbd** is a client for RADOS block device (rbd) images like rbd kernel module.
20 It will map a rbd image to a nbd (Network Block Device) device, allowing access it
21 as regular local block device.
26 .. option:: -c ceph.conf
28 Use *ceph.conf* configuration file instead of the default
29 ``/etc/ceph/ceph.conf`` to determine monitor addresses during startup.
31 .. option:: --read-only
35 .. option:: --nbds_max *limit*
37 Override the parameter of NBD kernel module when modprobe, used to
38 limit the count of nbd device.
40 .. option:: --max_part *limit*
42 Override for module param nbds_max.
44 .. option:: --exclusive
46 Forbid writes by other clients.
48 .. option:: --timeout *seconds*
50 Override device timeout. Linux kernel will default to a 30 second request timeout.
51 Allow the user to optionally specify an alternate timeout.
56 | *image-spec* is [*pool-name*]/*image-name*
57 | *snap-spec* is [*pool-name*]/*image-name*\ @\ *snap-name*
59 The default for *pool-name* is "rbd". If an image name contains a slash
60 character ('/'), *pool-name* is required.
65 **rbd-nbd** is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to
66 the Ceph documentation at http://ceph.com/docs for more information.