Documentation/ABI/testing/sysfs-bus-rbd

   1 What:           /sys/bus/rbd/add
   2 Date:           Oct, 2010
   3 KernelVersion:  v2.6.37
   4 Contact:        Sage Weil <sage@newdream.net>
   5 Description:
   6                 (WO) Add rbd block device.
   7
   8                 Usage: <mon ip addr> <options> <pool name> <rbd image name> [<snap name>]
   9
  10                 Example::
  11
  12                  $ echo "192.168.0.1 name=admin rbd foo" > /sys/bus/rbd/add
  13
  14                 The snapshot name can be "-" or omitted to map the image
  15                 read/write. A <dev-id> will be assigned for any registered block
  16                 device. If snapshot is used, it will be mapped read-only.
  17
  18
  19 What:           /sys/bus/rbd/remove
  20 Date:           Oct, 2010
  21 KernelVersion:  v2.6.37
  22 Contact:        Sage Weil <sage@newdream.net>
  23 Description:
  24                 (WO) Remove rbd block device.
  25
  26                 Usage: <dev-id> [force]
  27
  28                 Example::
  29
  30                  $ echo 2 > /sys/bus/rbd/remove
  31
  32                 Optional "force" argument which when passed will wait for
  33                 running requests and then unmap the image. Requests sent to the
  34                 driver after initiating the removal will be failed. (August
  35                 2016, since 4.9.)
  36
  37
  38 What:           /sys/bus/rbd/add_single_major
  39 Date:           Dec, 2013
  40 KernelVersion:  v3.14
  41 Contact:        Sage Weil <sage@newdream.net>
  42 Description:
  43                 (WO) Available only if rbd module is inserted with single_major
  44                 parameter set to true.
  45
  46                 Usage is the same as for /sys/bus/rbd/add. If present, this
  47                 should be used instead of the latter: any attempts to use
  48                 /sys/bus/rbd/add if /sys/bus/rbd/add_single_major is available
  49                 will fail for backwards compatibility reasons.
  50
  51
  52 What:           /sys/bus/rbd/remove_single_major
  53 Date:           Dec, 2013
  54 KernelVersion:  v3.14
  55 Contact:        Sage Weil <sage@newdream.net>
  56 Description:
  57                 (WO) Available only if rbd module is inserted with single_major
  58                 parameter set to true.
  59
  60                 Usage is the same as for /sys/bus/rbd/remove. If present, this
  61                 should be used instead of the latter: any attempts to use
  62                 /sys/bus/rbd/remove if /sys/bus/rbd/remove_single_major is
  63                 available will fail for backwards compatibility reasons.
  64
  65
  66 What:           /sys/bus/rbd/supported_features
  67 Date:           Mar, 2017
  68 KernelVersion:  v4.11
  69 Contact:        Sage Weil <sage@newdream.net>
  70 Description:
  71                 (RO) Displays the features supported by the rbd module so that
  72                 userspace can generate meaningful error messages and spell out
  73                 unsupported features that need to be disabled.
  74
  75
  76 What:           /sys/bus/rbd/devices/<dev-id>/size
  77 What:           /sys/bus/rbd/devices/<dev-id>/major
  78 What:           /sys/bus/rbd/devices/<dev-id>/client_id
  79 What:           /sys/bus/rbd/devices/<dev-id>/pool
  80 What:           /sys/bus/rbd/devices/<dev-id>/name
  81 What:           /sys/bus/rbd/devices/<dev-id>/refresh
  82 What:           /sys/bus/rbd/devices/<dev-id>/current_snap
  83 Date:           Oct, 2010
  84 KernelVersion:  v2.6.37
  85 Contact:        Sage Weil <sage@newdream.net>
  86 Description:
  87
  88                 ==============  ================================================
  89                 size            (RO) The size (in bytes) of the mapped block
  90                                 device.
  91
  92                 major           (RO) The block device major number.
  93
  94                 client_id       (RO) The ceph unique client id that was assigned
  95                                 for this specific session.
  96
  97                 pool            (RO) The name of the storage pool where this rbd
  98                                 image resides. An rbd image name is unique
  99                                 within its pool.
 100
 101                 name            (RO) The name of the rbd image.
 102
 103                 refresh         (WO) Writing to this file will reread the image
 104                                 header data and set all relevant data structures
 105                                 accordingly.
 106
 107                 current_snap    (RO) The current snapshot for which the device
 108                                 is mapped.
 109                 ==============  ================================================
 110
 111
 112 What:           /sys/bus/rbd/devices/<dev-id>/pool_id
 113 Date:           Jul, 2012
 114 KernelVersion:  v3.6
 115 Contact:        Sage Weil <sage@newdream.net>
 116 Description:
 117                 (RO) The unique identifier for the rbd image's pool. This is a
 118                 permanent attribute of the pool. A pool's id will never change.
 119
 120
 121 What:           /sys/bus/rbd/devices/<dev-id>/image_id
 122 What:           /sys/bus/rbd/devices/<dev-id>/features
 123 Date:           Oct, 2012
 124 KernelVersion:  v3.7
 125 Contact:        Sage Weil <sage@newdream.net>
 126 Description:
 127                 =========       ===============================================
 128                 image_id        (RO) The unique id for the rbd image. (For rbd
 129                                 image format 1 this is empty.)
 130
 131                 features        (RO) A hexadecimal encoding of the feature bits
 132                                 for this image.
 133                 =========       ===============================================
 134
 135
 136 What:           /sys/bus/rbd/devices/<dev-id>/parent
 137 Date:           Nov, 2012
 138 KernelVersion:  v3.8
 139 Contact:        Sage Weil <sage@newdream.net>
 140 Description:
 141                 (RO) Information identifying the chain of parent images in a
 142                 layered rbd image. Entries are separated by empty lines.
 143
 144
 145 What:           /sys/bus/rbd/devices/<dev-id>/minor
 146 Date:           Dec, 2013
 147 KernelVersion:  v3.14
 148 Contact:        Sage Weil <sage@newdream.net>
 149 Description:
 150                 (RO) The block device minor number.
 151
 152
 153 What:           /sys/bus/rbd/devices/<dev-id>/snap_id
 154 What:           /sys/bus/rbd/devices/<dev-id>/config_info
 155 What:           /sys/bus/rbd/devices/<dev-id>/cluster_fsid
 156 What:           /sys/bus/rbd/devices/<dev-id>/client_addr
 157 Date:           Aug, 2016
 158 KernelVersion:  v4.9
 159 Contact:        Sage Weil <sage@newdream.net>
 160 Description:
 161                 ============    ================================================
 162                 snap_id         (RO) The current snapshot's id.
 163
 164                 config_info     (RO) The string written into
 165                                 /sys/bus/rbd/add{,_single_major}.
 166
 167                 cluster_fsid    (RO) The ceph cluster UUID.
 168
 169                 client_addr     (RO) The ceph unique client
 170                                 entity_addr_t (address + nonce). The format is
 171                                 <address>:<port>/<nonce>: '1.2.3.4:1234/5678' or
 172                                 '[1:2:3:4:5:6:7:8]:1234/5678'.
 173                 ============    ================================================