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*] [--snap-id *snap-id*] [--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*
  17
  18 Description
  19 ===========
  20
  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.
  24
  25 Options
  26 =======
  27
  28 .. option:: -c ceph.conf
  29
  30    Use *ceph.conf* configuration file instead of the default
  31    ``/etc/ceph/ceph.conf`` to determine monitor addresses during startup.
  32
  33 .. option:: --read-only
  34
  35    Map read-only.
  36
  37 .. option:: --nbds_max *limit*
  38
  39    Override the parameter nbds_max of NBD kernel module when modprobe, used to
  40    limit the count of nbd device.
  41
  42 .. option:: --max_part *limit*
  43
  44     Override for module param max_part.
  45
  46 .. option:: --exclusive
  47
  48    Forbid writes by other clients.
  49
  50 .. option:: --notrim
  51
  52    Turn off trim/discard.
  53
  54 .. option:: --encryption-format
  55
  56    Image encryption format.
  57    Possible values: *luks1*, *luks2*
  58
  59 .. option:: --encryption-passphrase-file
  60
  61    Path of file containing a passphrase for unlocking image encryption.
  62
  63 .. option:: --io-timeout *seconds*
  64
  65    Override device timeout. Linux kernel will default to a 30 second request timeout.
  66    Allow the user to optionally specify an alternate timeout.
  67
  68 .. option:: --reattach-timeout *seconds*
  69
  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
  72    second.
  73
  74 .. option:: --snap-id *snapid*
  75
  76    Specify a snapshot to map/unmap/attach/detach by ID instead of by name.
  77
  78 Image and snap specs
  79 ====================
  80
  81 | *image-spec* is [*pool-name*]/*image-name*
  82 | *snap-spec*  is [*pool-name*]/*image-name*\ @\ *snap-name*
  83
  84 The default for *pool-name* is "rbd".  If an image name contains a slash
  85 character ('/'), *pool-name* is required.
  86
  87 Availability
  88 ============
  89
  90 **rbd-nbd** is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to
  91 the Ceph documentation at https://docs.ceph.com/ for more information.
  92
  93
  94 See also
  95 ========
  96
  97 :doc:`rbd <rbd>`\(8)