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 Usage: <dev-id> [force]
18 18
19 What: /sys/bus/rbd/remove !! 19 $ echo 2 > /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 20
>> 21 Optional "force" argument which when passed will wait for running requests and
>> 22 then unmap the image. Requests sent to the driver after initiating the removal
>> 23 will be failed. (August 2016, since 4.9.)
37 24
38 What: /sys/bus/rbd/add_single_major 25 What: /sys/bus/rbd/add_single_major
39 Date: Dec, 2013 !! 26 Date: December 2013
40 KernelVersion: v3.14 !! 27 KernelVersion: 3.14
41 Contact: Sage Weil <sage@newdream.net> !! 28 Contact: Sage Weil <sage@inktank.com>
42 Description: !! 29 Description: Available only if rbd module is inserted with single_major
43 (WO) Available only if rbd mod <<
44 parameter set to true. 30 parameter set to true.
45 !! 31 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 32 should be used instead of the latter: any attempts to use
48 /sys/bus/rbd/add if /sys/bus/r !! 33 /sys/bus/rbd/add if /sys/bus/rbd/add_single_major is
49 will fail for backwards compat !! 34 available will fail for backwards compatibility reasons.
50 <<
51 35
52 What: /sys/bus/rbd/remove_single_maj 36 What: /sys/bus/rbd/remove_single_major
53 Date: Dec, 2013 !! 37 Date: December 2013
54 KernelVersion: v3.14 !! 38 KernelVersion: 3.14
55 Contact: Sage Weil <sage@newdream.net> !! 39 Contact: Sage Weil <sage@inktank.com>
56 Description: !! 40 Description: Available only if rbd module is inserted with single_major
57 (WO) Available only if rbd mod <<
58 parameter set to true. 41 parameter set to true.
59 !! 42 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 43 should be used instead of the latter: any attempts to use
62 /sys/bus/rbd/remove if /sys/bu 44 /sys/bus/rbd/remove if /sys/bus/rbd/remove_single_major is
63 available will fail for backwa 45 available will fail for backwards compatibility reasons.
64 46
>> 47 Entries under /sys/bus/rbd/devices/<dev-id>/
>> 48 --------------------------------------------
65 49
66 What: /sys/bus/rbd/supported_feature !! 50 client_addr
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 51
>> 52 The ceph unique client entity_addr_t (address + nonce).
>> 53 The format is <address>:<port>/<nonce>: '1.2.3.4:1234/5678' or
>> 54 '[1:2:3:4:5:6:7:8]:1234/5678'. (August 2016, since 4.9.)
75 55
76 What: /sys/bus/rbd/devices/<dev-id>/ !! 56 client_id
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 57
88 ============== ============== !! 58 The ceph unique client id that was assigned for this specific session.
89 size (RO) The size <<
90 device. <<
91 59
92 major (RO) The block !! 60 cluster_fsid
93 61
94 client_id (RO) The ceph !! 62 The ceph cluster UUID. (August 2016, since 4.9.)
95 for this speci <<
96 63
97 pool (RO) The name !! 64 config_info
98 image resides. <<
99 within its poo <<
100 65
101 name (RO) The name !! 66 The string written into /sys/bus/rbd/add{,_single_major}. (August
>> 67 2016, since 4.9.)
102 68
103 refresh (WO) Writing t !! 69 features
104 header data an <<
105 accordingly. <<
106 70
107 current_snap (RO) The curre !! 71 A hexadecimal encoding of the feature bits for this image.
108 is mapped. <<
109 ============== ============== <<
110 72
>> 73 major
111 74
112 What: /sys/bus/rbd/devices/<dev-id>/ !! 75 The block device major number.
113 Date: Jul, 2012 <<
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 76
>> 77 minor
120 78
121 What: /sys/bus/rbd/devices/<dev-id>/ !! 79 The block device minor number. (December 2013, since 3.14.)
122 What: /sys/bus/rbd/devices/<dev-id>/ <<
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 80
>> 81 name
135 82
136 What: /sys/bus/rbd/devices/<dev-id>/ !! 83 The name of the rbd image.
137 Date: Nov, 2012 <<
138 KernelVersion: v3.8 <<
139 Contact: Sage Weil <sage@newdream.net> <<
140 Description: <<
141 (RO) Information identifying t <<
142 layered rbd image. Entries are <<
143 84
>> 85 image_id
144 86
145 What: /sys/bus/rbd/devices/<dev-id>/ !! 87 The unique id for the rbd image. (For rbd image format 1
146 Date: Dec, 2013 !! 88 this is empty.)
147 KernelVersion: v3.14 <<
148 Contact: Sage Weil <sage@newdream.net> <<
149 Description: <<
150 (RO) The block device minor nu <<
151 89
>> 90 pool
152 91
153 What: /sys/bus/rbd/devices/<dev-id>/ !! 92 The name of the storage pool where this rbd image resides.
154 What: /sys/bus/rbd/devices/<dev-id>/ !! 93 An rbd image name is unique within its pool.
155 What: /sys/bus/rbd/devices/<dev-id>/ !! 94
156 What: /sys/bus/rbd/devices/<dev-id>/ !! 95 pool_id
157 Date: Aug, 2016 !! 96
158 KernelVersion: v4.9 !! 97 The unique identifier for the rbd image's pool. This is
159 Contact: Sage Weil <sage@newdream.net> !! 98 a permanent attribute of the pool. A pool's id will never
160 Description: !! 99 change.
161 ============ ============== !! 100
162 snap_id (RO) The curre !! 101 size
>> 102
>> 103 The size (in bytes) of the mapped block device.
>> 104
>> 105 refresh
>> 106
>> 107 Writing to this file will reread the image header data and set
>> 108 all relevant datastructures accordingly.
>> 109
>> 110 current_snap
>> 111
>> 112 The current snapshot for which the device is mapped.
>> 113
>> 114 snap_id
163 115
164 config_info (RO) The strin !! 116 The current snapshot's id. (August 2016, since 4.9.)
165 /sys/bus/rbd/a <<
166 117
167 cluster_fsid (RO) The ceph !! 118 parent
168 119
169 client_addr (RO) The ceph !! 120 Information identifying the chain of parent images in a layered rbd
170 entity_addr_t !! 121 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.