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