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