Merge remote-tracking branch 'sound-asoc/for-next'
[deliverable/linux.git] / Documentation / ABI / testing / sysfs-bus-rbd
CommitLineData
dfc5606d
YS
1What: /sys/bus/rbd/
2Date: November 2010
55b00bae 3Contact: Yehuda Sadeh <yehuda@newdream.net>,
dfc5606d
YS
4 Sage Weil <sage@newdream.net>
5Description:
6
7Being used for adding and removing rbd block devices.
8
0276dca6 9Usage: <mon ip addr> <options> <pool name> <rbd image name> [<snap name>]
dfc5606d
YS
10
11 $ echo "192.168.0.1 name=admin rbd foo" > /sys/bus/rbd/add
12
13The snapshot name can be "-" or omitted to map the image read/write. A <dev-id>
14will be assigned for any registered block device. If snapshot is used, it will
15be mapped read-only.
16
0276dca6 17Usage: <dev-id> [force]
dfc5606d 18
0276dca6
MC
19 $ echo 2 > /sys/bus/rbd/remove
20
21Optional "force" argument which when passed will wait for running requests and
22then unmap the image. Requests sent to the driver after initiating the removal
23will be failed. (August 2016, since 4.9.)
dfc5606d 24
9b60e70b
ID
25What: /sys/bus/rbd/add_single_major
26Date: December 2013
27KernelVersion: 3.14
28Contact: Sage Weil <sage@inktank.com>
29Description: Available only if rbd module is inserted with single_major
30 parameter set to true.
31 Usage is the same as for /sys/bus/rbd/add. If present,
32 should be used instead of the latter: any attempts to use
33 /sys/bus/rbd/add if /sys/bus/rbd/add_single_major is
34 available will fail for backwards compatibility reasons.
35
36What: /sys/bus/rbd/remove_single_major
37Date: December 2013
38KernelVersion: 3.14
39Contact: Sage Weil <sage@inktank.com>
40Description: Available only if rbd module is inserted with single_major
41 parameter set to true.
42 Usage is the same as for /sys/bus/rbd/remove. If present,
43 should be used instead of the latter: any attempts to use
44 /sys/bus/rbd/remove if /sys/bus/rbd/remove_single_major is
45 available will fail for backwards compatibility reasons.
46
dfc5606d
YS
47Entries under /sys/bus/rbd/devices/<dev-id>/
48--------------------------------------------
49
005a07bf
ID
50client_addr
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.)
55
dfc5606d
YS
56client_id
57
58 The ceph unique client id that was assigned for this specific session.
59
267fb90b
MC
60cluster_fsid
61
62 The ceph cluster UUID. (August 2016, since 4.9.)
63
0d6d1e9c
MC
64config_info
65
66 The string written into /sys/bus/rbd/add{,_single_major}. (August
67 2016, since 4.9.)
68
34b13184
AE
69features
70
71 A hexadecimal encoding of the feature bits for this image.
72
dfc5606d
YS
73major
74
75 The block device major number.
76
dd82fff1
ID
77minor
78
79 The block device minor number. (December 2013, since 3.14.)
80
dfc5606d
YS
81name
82
83 The name of the rbd image.
84
589d30e0
AE
85image_id
86
87 The unique id for the rbd image. (For rbd image format 1
88 this is empty.)
89
dfc5606d
YS
90pool
91
9bb2f334
AE
92 The name of the storage pool where this rbd image resides.
93 An rbd image name is unique within its pool.
94
95pool_id
96
97 The unique identifier for the rbd image's pool. This is
98 a permanent attribute of the pool. A pool's id will never
99 change.
dfc5606d
YS
100
101size
102
103 The size (in bytes) of the mapped block device.
104
105refresh
106
107 Writing to this file will reread the image header data and set
108 all relevant datastructures accordingly.
109
110current_snap
111
112 The current snapshot for which the device is mapped.
113
92a58671
MC
114snap_id
115
116 The current snapshot's id. (August 2016, since 4.9.)
117
86b00e0d
AE
118parent
119
ff96128f
ID
120 Information identifying the chain of parent images in a layered rbd
121 image. Entries are separated by empty lines.
This page took 0.655516 seconds and 5 git commands to generate.