src/ceph/doc/man/8/rbd-nbd.rst

   1 :orphan:
   2
   3 =========================================
   4  rbd-nbd -- map rbd images to nbd device
   5 =========================================
   6
   7 .. program:: rbd-nbd
   8
   9 Synopsis
  10 ========
  11
  12 | **rbd-nbd** [-c conf] [--read-only] [--device *nbd device*] [--nbds_max *limit*] [--max_part *limit*] [--exclusive] map *image-spec* | *snap-spec*
  13 | **rbd-nbd** unmap *nbd device*
  14 | **rbd-nbd** list-mapped
  15
  16 Description
  17 ===========
  18
  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.
  22
  23 Options
  24 =======
  25
  26 .. option:: -c ceph.conf
  27
  28    Use *ceph.conf* configuration file instead of the default
  29    ``/etc/ceph/ceph.conf`` to determine monitor addresses during startup.
  30
  31 .. option:: --read-only
  32
  33    Map read-only.
  34
  35 .. option:: --nbds_max *limit*
  36
  37    Override the parameter of NBD kernel module when modprobe, used to
  38    limit the count of nbd device.
  39
  40 .. option:: --max_part *limit*
  41
  42     Override for module param nbds_max.
  43
  44 .. option:: --exclusive
  45
  46    Forbid writes by other clients.
  47
  48 Image and snap specs
  49 ====================
  50
  51 | *image-spec* is [*pool-name*]/*image-name*
  52 | *snap-spec*  is [*pool-name*]/*image-name*\ @\ *snap-name*
  53
  54 The default for *pool-name* is "rbd".  If an image name contains a slash
  55 character ('/'), *pool-name* is required.
  56
  57 Availability
  58 ============
  59
  60 **rbd-nbd** is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to
  61 the Ceph documentation at http://ceph.com/docs for more information.
  62
  63
  64 See also
  65 ========
  66
  67 :doc:`rbd <rbd>`\(8)