Documentation/ABI/testing/sysfs-bus-rbd

   1 What:           /sys/bus/rbd/
   2 Date:           November 2010
   3 Contact:        Yehuda Sadeh <yehuda@newdream.net>,
   4                 Sage Weil <sage@newdream.net>
   5 Description:
   6
   7 Being used for adding and removing rbd block devices.
   8
   9 Usage: <mon ip addr> <options> <pool name> <rbd image name> [snap name]
  10
  11  $ echo "192.168.0.1 name=admin rbd foo" > /sys/bus/rbd/add
  12
  13 The snapshot name can be "-" or omitted to map the image read/write. A <dev-id>
  14 will be assigned for any registered block device. If snapshot is used, it will
  15 be mapped read-only.
  16
  17 Removal of a device:
  18
  19   $ echo <dev-id> > /sys/bus/rbd/remove
  20
  21 What:           /sys/bus/rbd/add_single_major
  22 Date:           December 2013
  23 KernelVersion:  3.14
  24 Contact:        Sage Weil <sage@inktank.com>
  25 Description:    Available only if rbd module is inserted with single_major
  26                 parameter set to true.
  27                 Usage is the same as for /sys/bus/rbd/add.  If present,
  28                 should be used instead of the latter: any attempts to use
  29                 /sys/bus/rbd/add if /sys/bus/rbd/add_single_major is
  30                 available will fail for backwards compatibility reasons.
  31
  32 What:           /sys/bus/rbd/remove_single_major
  33 Date:           December 2013
  34 KernelVersion:  3.14
  35 Contact:        Sage Weil <sage@inktank.com>
  36 Description:    Available only if rbd module is inserted with single_major
  37                 parameter set to true.
  38                 Usage is the same as for /sys/bus/rbd/remove.  If present,
  39                 should be used instead of the latter: any attempts to use
  40                 /sys/bus/rbd/remove if /sys/bus/rbd/remove_single_major is
  41                 available will fail for backwards compatibility reasons.
  42
  43 Entries under /sys/bus/rbd/devices/<dev-id>/
  44 --------------------------------------------
  45
  46 client_id
  47
  48         The ceph unique client id that was assigned for this specific session.
  49
  50 features
  51
  52         A hexadecimal encoding of the feature bits for this image.
  53
  54 major
  55
  56         The block device major number.
  57
  58 minor
  59
  60         The block device minor number.  (December 2013, since 3.14.)
  61
  62 name
  63
  64         The name of the rbd image.
  65
  66 image_id
  67
  68         The unique id for the rbd image.  (For rbd image format 1
  69         this is empty.)
  70
  71 pool
  72
  73         The name of the storage pool where this rbd image resides.
  74         An rbd image name is unique within its pool.
  75
  76 pool_id
  77
  78         The unique identifier for the rbd image's pool.  This is
  79         a permanent attribute of the pool.  A pool's id will never
  80         change.
  81
  82 size
  83
  84         The size (in bytes) of the mapped block device.
  85
  86 refresh
  87
  88         Writing to this file will reread the image header data and set
  89         all relevant datastructures accordingly.
  90
  91 current_snap
  92
  93         The current snapshot for which the device is mapped.
  94
  95 parent
  96
  97         Information identifying the pool, image, and snapshot id for
  98         the parent image in a layered rbd image (format 2 only).