blob: 0a306476424ef06cf6222e6e13541804bc546333 [file] [log] [blame]
Yehuda Sadehdfc56062010-11-19 14:51:04 -08001What: /sys/bus/rbd/
2Date: November 2010
Sage Weil55b00ba2011-03-21 15:06:50 -07003Contact: Yehuda Sadeh <yehuda@newdream.net>,
Yehuda Sadehdfc56062010-11-19 14:51:04 -08004 Sage Weil <sage@newdream.net>
5Description:
6
7Being used for adding and removing rbd block devices.
8
9Usage: <mon ip addr> <options> <pool name> <rbd image name> [snap name]
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
17Removal of a device:
18
19 $ echo <dev-id> > /sys/bus/rbd/remove
20
21Entries under /sys/bus/rbd/devices/<dev-id>/
22--------------------------------------------
23
24client_id
25
26 The ceph unique client id that was assigned for this specific session.
27
Alex Elder34b13182012-07-13 20:35:12 -050028features
29
30 A hexadecimal encoding of the feature bits for this image.
31
Yehuda Sadehdfc56062010-11-19 14:51:04 -080032major
33
34 The block device major number.
35
36name
37
38 The name of the rbd image.
39
Alex Elder589d30e2012-07-10 20:30:11 -050040image_id
41
42 The unique id for the rbd image. (For rbd image format 1
43 this is empty.)
44
Yehuda Sadehdfc56062010-11-19 14:51:04 -080045pool
46
Alex Elder9bb2f332012-07-12 10:46:35 -050047 The name of the storage pool where this rbd image resides.
48 An rbd image name is unique within its pool.
49
50pool_id
51
52 The unique identifier for the rbd image's pool. This is
53 a permanent attribute of the pool. A pool's id will never
54 change.
Yehuda Sadehdfc56062010-11-19 14:51:04 -080055
56size
57
58 The size (in bytes) of the mapped block device.
59
60refresh
61
62 Writing to this file will reread the image header data and set
63 all relevant datastructures accordingly.
64
65current_snap
66
67 The current snapshot for which the device is mapped.
68
Alex Elder86b00e02012-10-25 23:34:42 -050069parent
70
71 Information identifying the pool, image, and snapshot id for
72 the parent image in a layered rbd image (format 2 only).