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