4 Contact: Sage Weil <sage@newdream.net>
6 (WO) Add rbd block device.
8 Usage: <mon ip addr> <options> <pool name> <rbd image name> [<snap name>]
10 $ echo "192.168.0.1 name=admin rbd foo" > /sys/bus/rbd/add
12 The snapshot name can be "-" or omitted to map the image
13 read/write. A <dev-id> will be assigned for any registered block
14 device. If snapshot is used, it will be mapped read-only.
17 What: /sys/bus/rbd/remove
19 KernelVersion: v2.6.37
20 Contact: Sage Weil <sage@newdream.net>
22 (WO) Remove rbd block device.
24 Usage: <dev-id> [force]
26 $ echo 2 > /sys/bus/rbd/remove
28 Optional "force" argument which when passed will wait for
29 running requests and then unmap the image. Requests sent to the
30 driver after initiating the removal will be failed. (August
34 What: /sys/bus/rbd/add_single_major
37 Contact: Sage Weil <sage@newdream.net>
39 (WO) Available only if rbd module is inserted with single_major
40 parameter set to true.
42 Usage is the same as for /sys/bus/rbd/add. If present, this
43 should be used instead of the latter: any attempts to use
44 /sys/bus/rbd/add if /sys/bus/rbd/add_single_major is available
45 will fail for backwards compatibility reasons.
48 What: /sys/bus/rbd/remove_single_major
51 Contact: Sage Weil <sage@newdream.net>
53 (WO) Available only if rbd module is inserted with single_major
54 parameter set to true.
56 Usage is the same as for /sys/bus/rbd/remove. If present, this
57 should be used instead of the latter: any attempts to use
58 /sys/bus/rbd/remove if /sys/bus/rbd/remove_single_major is
59 available will fail for backwards compatibility reasons.
62 What: /sys/bus/rbd/supported_features
65 Contact: Sage Weil <sage@newdream.net>
67 (RO) Displays the features supported by the rbd module so that
68 userspace can generate meaningful error messages and spell out
69 unsupported features that need to be disabled.
72 What: /sys/bus/rbd/devices/<dev-id>/size
73 What: /sys/bus/rbd/devices/<dev-id>/major
74 What: /sys/bus/rbd/devices/<dev-id>/client_id
75 What: /sys/bus/rbd/devices/<dev-id>/pool
76 What: /sys/bus/rbd/devices/<dev-id>/name
77 What: /sys/bus/rbd/devices/<dev-id>/refresh
78 What: /sys/bus/rbd/devices/<dev-id>/current_snap
80 KernelVersion: v2.6.37
81 Contact: Sage Weil <sage@newdream.net>
83 size: (RO) The size (in bytes) of the mapped block
86 major: (RO) The block device major number.
88 client_id: (RO) The ceph unique client id that was assigned
89 for this specific session.
91 pool: (RO) The name of the storage pool where this rbd
92 image resides. An rbd image name is unique
95 name: (RO) The name of the rbd image.
97 refresh: (WO) Writing to this file will reread the image
98 header data and set all relevant data structures
101 current_snap: (RO) The current snapshot for which the device
105 What: /sys/bus/rbd/devices/<dev-id>/pool_id
108 Contact: Sage Weil <sage@newdream.net>
110 (RO) The unique identifier for the rbd image's pool. This is a
111 permanent attribute of the pool. A pool's id will never change.
114 What: /sys/bus/rbd/devices/<dev-id>/image_id
115 What: /sys/bus/rbd/devices/<dev-id>/features
118 Contact: Sage Weil <sage@newdream.net>
120 image_id: (RO) The unique id for the rbd image. (For rbd
121 image format 1 this is empty.)
123 features: (RO) A hexadecimal encoding of the feature bits
127 What: /sys/bus/rbd/devices/<dev-id>/parent
130 Contact: Sage Weil <sage@newdream.net>
132 (RO) Information identifying the chain of parent images in a
133 layered rbd image. Entries are separated by empty lines.
136 What: /sys/bus/rbd/devices/<dev-id>/minor
139 Contact: Sage Weil <sage@newdream.net>
141 (RO) The block device minor number.
144 What: /sys/bus/rbd/devices/<dev-id>/snap_id
145 What: /sys/bus/rbd/devices/<dev-id>/config_info
146 What: /sys/bus/rbd/devices/<dev-id>/cluster_fsid
147 What: /sys/bus/rbd/devices/<dev-id>/client_addr
150 Contact: Sage Weil <sage@newdream.net>
152 snap_id: (RO) The current snapshot's id.
154 config_info: (RO) The string written into
155 /sys/bus/rbd/add{,_single_major}.
157 cluster_fsid: (RO) The ceph cluster UUID.
159 client_addr: (RO) The ceph unique client
160 entity_addr_t (address + nonce). The format is
161 <address>:<port>/<nonce>: '1.2.3.4:1234/5678' or
162 '[1:2:3:4:5:6:7:8]:1234/5678'.