0001 What: /sys/bus/rbd/add
0002 Date: Oct, 2010
0003 KernelVersion: v2.6.37
0004 Contact: Sage Weil <sage@newdream.net>
0005 Description:
0006 (WO) Add rbd block device.
0007
0008 Usage: <mon ip addr> <options> <pool name> <rbd image name> [<snap name>]
0009
0010 Example::
0011
0012 $ echo "192.168.0.1 name=admin rbd foo" > /sys/bus/rbd/add
0013
0014 The snapshot name can be "-" or omitted to map the image
0015 read/write. A <dev-id> will be assigned for any registered block
0016 device. If snapshot is used, it will be mapped read-only.
0017
0018
0019 What: /sys/bus/rbd/remove
0020 Date: Oct, 2010
0021 KernelVersion: v2.6.37
0022 Contact: Sage Weil <sage@newdream.net>
0023 Description:
0024 (WO) Remove rbd block device.
0025
0026 Usage: <dev-id> [force]
0027
0028 Example::
0029
0030 $ echo 2 > /sys/bus/rbd/remove
0031
0032 Optional "force" argument which when passed will wait for
0033 running requests and then unmap the image. Requests sent to the
0034 driver after initiating the removal will be failed. (August
0035 2016, since 4.9.)
0036
0037
0038 What: /sys/bus/rbd/add_single_major
0039 Date: Dec, 2013
0040 KernelVersion: v3.14
0041 Contact: Sage Weil <sage@newdream.net>
0042 Description:
0043 (WO) Available only if rbd module is inserted with single_major
0044 parameter set to true.
0045
0046 Usage is the same as for /sys/bus/rbd/add. If present, this
0047 should be used instead of the latter: any attempts to use
0048 /sys/bus/rbd/add if /sys/bus/rbd/add_single_major is available
0049 will fail for backwards compatibility reasons.
0050
0051
0052 What: /sys/bus/rbd/remove_single_major
0053 Date: Dec, 2013
0054 KernelVersion: v3.14
0055 Contact: Sage Weil <sage@newdream.net>
0056 Description:
0057 (WO) Available only if rbd module is inserted with single_major
0058 parameter set to true.
0059
0060 Usage is the same as for /sys/bus/rbd/remove. If present, this
0061 should be used instead of the latter: any attempts to use
0062 /sys/bus/rbd/remove if /sys/bus/rbd/remove_single_major is
0063 available will fail for backwards compatibility reasons.
0064
0065
0066 What: /sys/bus/rbd/supported_features
0067 Date: Mar, 2017
0068 KernelVersion: v4.11
0069 Contact: Sage Weil <sage@newdream.net>
0070 Description:
0071 (RO) Displays the features supported by the rbd module so that
0072 userspace can generate meaningful error messages and spell out
0073 unsupported features that need to be disabled.
0074
0075
0076 What: /sys/bus/rbd/devices/<dev-id>/size
0077 What: /sys/bus/rbd/devices/<dev-id>/major
0078 What: /sys/bus/rbd/devices/<dev-id>/client_id
0079 What: /sys/bus/rbd/devices/<dev-id>/pool
0080 What: /sys/bus/rbd/devices/<dev-id>/name
0081 What: /sys/bus/rbd/devices/<dev-id>/refresh
0082 What: /sys/bus/rbd/devices/<dev-id>/current_snap
0083 Date: Oct, 2010
0084 KernelVersion: v2.6.37
0085 Contact: Sage Weil <sage@newdream.net>
0086 Description:
0087
0088 ============== ================================================
0089 size (RO) The size (in bytes) of the mapped block
0090 device.
0091
0092 major (RO) The block device major number.
0093
0094 client_id (RO) The ceph unique client id that was assigned
0095 for this specific session.
0096
0097 pool (RO) The name of the storage pool where this rbd
0098 image resides. An rbd image name is unique
0099 within its pool.
0100
0101 name (RO) The name of the rbd image.
0102
0103 refresh (WO) Writing to this file will reread the image
0104 header data and set all relevant data structures
0105 accordingly.
0106
0107 current_snap (RO) The current snapshot for which the device
0108 is mapped.
0109 ============== ================================================
0110
0111
0112 What: /sys/bus/rbd/devices/<dev-id>/pool_id
0113 Date: Jul, 2012
0114 KernelVersion: v3.6
0115 Contact: Sage Weil <sage@newdream.net>
0116 Description:
0117 (RO) The unique identifier for the rbd image's pool. This is a
0118 permanent attribute of the pool. A pool's id will never change.
0119
0120
0121 What: /sys/bus/rbd/devices/<dev-id>/image_id
0122 What: /sys/bus/rbd/devices/<dev-id>/features
0123 Date: Oct, 2012
0124 KernelVersion: v3.7
0125 Contact: Sage Weil <sage@newdream.net>
0126 Description:
0127 ========= ===============================================
0128 image_id (RO) The unique id for the rbd image. (For rbd
0129 image format 1 this is empty.)
0130
0131 features (RO) A hexadecimal encoding of the feature bits
0132 for this image.
0133 ========= ===============================================
0134
0135
0136 What: /sys/bus/rbd/devices/<dev-id>/parent
0137 Date: Nov, 2012
0138 KernelVersion: v3.8
0139 Contact: Sage Weil <sage@newdream.net>
0140 Description:
0141 (RO) Information identifying the chain of parent images in a
0142 layered rbd image. Entries are separated by empty lines.
0143
0144
0145 What: /sys/bus/rbd/devices/<dev-id>/minor
0146 Date: Dec, 2013
0147 KernelVersion: v3.14
0148 Contact: Sage Weil <sage@newdream.net>
0149 Description:
0150 (RO) The block device minor number.
0151
0152
0153 What: /sys/bus/rbd/devices/<dev-id>/snap_id
0154 What: /sys/bus/rbd/devices/<dev-id>/config_info
0155 What: /sys/bus/rbd/devices/<dev-id>/cluster_fsid
0156 What: /sys/bus/rbd/devices/<dev-id>/client_addr
0157 Date: Aug, 2016
0158 KernelVersion: v4.9
0159 Contact: Sage Weil <sage@newdream.net>
0160 Description:
0161 ============ ================================================
0162 snap_id (RO) The current snapshot's id.
0163
0164 config_info (RO) The string written into
0165 /sys/bus/rbd/add{,_single_major}.
0166
0167 cluster_fsid (RO) The ceph cluster UUID.
0168
0169 client_addr (RO) The ceph unique client
0170 entity_addr_t (address + nonce). The format is
0171 <address>:<port>/<nonce>: '1.2.3.4:1234/5678' or
0172 '[1:2:3:4:5:6:7:8]:1234/5678'.
0173 ============ ================================================
