174 lines · plain
1What: /sys/bus/rbd/add2Date: Oct, 20103KernelVersion: v2.6.374Contact: Sage Weil <sage@newdream.net>5Description: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/add13 14 The snapshot name can be "-" or omitted to map the image15 read/write. A <dev-id> will be assigned for any registered block16 device. If snapshot is used, it will be mapped read-only.17 18 19What: /sys/bus/rbd/remove20Date: Oct, 201021KernelVersion: v2.6.3722Contact: Sage Weil <sage@newdream.net>23Description:24 (WO) Remove rbd block device.25 26 Usage: <dev-id> [force]27 28 Example::29 30 $ echo 2 > /sys/bus/rbd/remove31 32 Optional "force" argument which when passed will wait for33 running requests and then unmap the image. Requests sent to the34 driver after initiating the removal will be failed. (August35 2016, since 4.9.)36 37 38What: /sys/bus/rbd/add_single_major39Date: Dec, 201340KernelVersion: v3.1441Contact: Sage Weil <sage@newdream.net>42Description:43 (WO) Available only if rbd module is inserted with single_major44 parameter set to true.45 46 Usage is the same as for /sys/bus/rbd/add. If present, this47 should be used instead of the latter: any attempts to use48 /sys/bus/rbd/add if /sys/bus/rbd/add_single_major is available49 will fail for backwards compatibility reasons.50 51 52What: /sys/bus/rbd/remove_single_major53Date: Dec, 201354KernelVersion: v3.1455Contact: Sage Weil <sage@newdream.net>56Description:57 (WO) Available only if rbd module is inserted with single_major58 parameter set to true.59 60 Usage is the same as for /sys/bus/rbd/remove. If present, this61 should be used instead of the latter: any attempts to use62 /sys/bus/rbd/remove if /sys/bus/rbd/remove_single_major is63 available will fail for backwards compatibility reasons.64 65 66What: /sys/bus/rbd/supported_features67Date: Mar, 201768KernelVersion: v4.1169Contact: Sage Weil <sage@newdream.net>70Description:71 (RO) Displays the features supported by the rbd module so that72 userspace can generate meaningful error messages and spell out73 unsupported features that need to be disabled.74 75 76What: /sys/bus/rbd/devices/<dev-id>/size77What: /sys/bus/rbd/devices/<dev-id>/major78What: /sys/bus/rbd/devices/<dev-id>/client_id79What: /sys/bus/rbd/devices/<dev-id>/pool80What: /sys/bus/rbd/devices/<dev-id>/name81What: /sys/bus/rbd/devices/<dev-id>/refresh82What: /sys/bus/rbd/devices/<dev-id>/current_snap83Date: Oct, 201084KernelVersion: v2.6.3785Contact: Sage Weil <sage@newdream.net>86Description:87 88 ============== ================================================89 size (RO) The size (in bytes) of the mapped block90 device.91 92 major (RO) The block device major number.93 94 client_id (RO) The ceph unique client id that was assigned95 for this specific session.96 97 pool (RO) The name of the storage pool where this rbd98 image resides. An rbd image name is unique99 within its pool.100 101 name (RO) The name of the rbd image.102 103 refresh (WO) Writing to this file will reread the image104 header data and set all relevant data structures105 accordingly.106 107 current_snap (RO) The current snapshot for which the device108 is mapped.109 ============== ================================================110 111 112What: /sys/bus/rbd/devices/<dev-id>/pool_id113Date: Jul, 2012114KernelVersion: v3.6115Contact: Sage Weil <sage@newdream.net>116Description:117 (RO) The unique identifier for the rbd image's pool. This is a118 permanent attribute of the pool. A pool's id will never change.119 120 121What: /sys/bus/rbd/devices/<dev-id>/image_id122What: /sys/bus/rbd/devices/<dev-id>/features123Date: Oct, 2012124KernelVersion: v3.7125Contact: Sage Weil <sage@newdream.net>126Description:127 ========= ===============================================128 image_id (RO) The unique id for the rbd image. (For rbd129 image format 1 this is empty.)130 131 features (RO) A hexadecimal encoding of the feature bits132 for this image.133 ========= ===============================================134 135 136What: /sys/bus/rbd/devices/<dev-id>/parent137Date: Nov, 2012138KernelVersion: v3.8139Contact: Sage Weil <sage@newdream.net>140Description:141 (RO) Information identifying the chain of parent images in a142 layered rbd image. Entries are separated by empty lines.143 144 145What: /sys/bus/rbd/devices/<dev-id>/minor146Date: Dec, 2013147KernelVersion: v3.14148Contact: Sage Weil <sage@newdream.net>149Description:150 (RO) The block device minor number.151 152 153What: /sys/bus/rbd/devices/<dev-id>/snap_id154What: /sys/bus/rbd/devices/<dev-id>/config_info155What: /sys/bus/rbd/devices/<dev-id>/cluster_fsid156What: /sys/bus/rbd/devices/<dev-id>/client_addr157Date: Aug, 2016158KernelVersion: v4.9159Contact: Sage Weil <sage@newdream.net>160Description:161 ============ ================================================162 snap_id (RO) The current snapshot's id.163 164 config_info (RO) The string written into165 /sys/bus/rbd/add{,_single_major}.166 167 cluster_fsid (RO) The ceph cluster UUID.168 169 client_addr (RO) The ceph unique client170 entity_addr_t (address + nonce). The format is171 <address>:<port>/<nonce>: '1.2.3.4:1234/5678' or172 '[1:2:3:4:5:6:7:8]:1234/5678'.173 ============ ================================================174