1dfc5606dSYehuda SadehWhat:		/sys/bus/rbd/
2dfc5606dSYehuda SadehDate:		November 2010
355b00baeSSage WeilContact:	Yehuda Sadeh <yehuda@newdream.net>,
4dfc5606dSYehuda Sadeh		Sage Weil <sage@newdream.net>
5dfc5606dSYehuda SadehDescription:
6dfc5606dSYehuda Sadeh
7dfc5606dSYehuda SadehBeing used for adding and removing rbd block devices.
8dfc5606dSYehuda Sadeh
9dfc5606dSYehuda SadehUsage: <mon ip addr> <options> <pool name> <rbd image name> [snap name]
10dfc5606dSYehuda Sadeh
11dfc5606dSYehuda Sadeh $ echo "192.168.0.1 name=admin rbd foo" > /sys/bus/rbd/add
12dfc5606dSYehuda Sadeh
13dfc5606dSYehuda SadehThe snapshot name can be "-" or omitted to map the image read/write. A <dev-id>
14dfc5606dSYehuda Sadehwill be assigned for any registered block device. If snapshot is used, it will
15dfc5606dSYehuda Sadehbe mapped read-only.
16dfc5606dSYehuda Sadeh
17dfc5606dSYehuda SadehRemoval of a device:
18dfc5606dSYehuda Sadeh
19dfc5606dSYehuda Sadeh  $ echo <dev-id> > /sys/bus/rbd/remove
20dfc5606dSYehuda Sadeh
21dfc5606dSYehuda SadehEntries under /sys/bus/rbd/devices/<dev-id>/
22dfc5606dSYehuda Sadeh--------------------------------------------
23dfc5606dSYehuda Sadeh
24dfc5606dSYehuda Sadehclient_id
25dfc5606dSYehuda Sadeh
26dfc5606dSYehuda Sadeh	The ceph unique client id that was assigned for this specific session.
27dfc5606dSYehuda Sadeh
28dfc5606dSYehuda Sadehmajor
29dfc5606dSYehuda Sadeh
30dfc5606dSYehuda Sadeh	The block device major number.
31dfc5606dSYehuda Sadeh
32dfc5606dSYehuda Sadehname
33dfc5606dSYehuda Sadeh
34dfc5606dSYehuda Sadeh	The name of the rbd image.
35dfc5606dSYehuda Sadeh
36*589d30e0SAlex Elderimage_id
37*589d30e0SAlex Elder
38*589d30e0SAlex Elder	The unique id for the rbd image.  (For rbd image format 1
39*589d30e0SAlex Elder	this is empty.)
40*589d30e0SAlex Elder
41dfc5606dSYehuda Sadehpool
42dfc5606dSYehuda Sadeh
439bb2f334SAlex Elder	The name of the storage pool where this rbd image resides.
449bb2f334SAlex Elder	An rbd image name is unique within its pool.
459bb2f334SAlex Elder
469bb2f334SAlex Elderpool_id
479bb2f334SAlex Elder
489bb2f334SAlex Elder	The unique identifier for the rbd image's pool.  This is
499bb2f334SAlex Elder	a permanent attribute of the pool.  A pool's id will never
509bb2f334SAlex Elder	change.
51dfc5606dSYehuda Sadeh
52dfc5606dSYehuda Sadehsize
53dfc5606dSYehuda Sadeh
54dfc5606dSYehuda Sadeh	The size (in bytes) of the mapped block device.
55dfc5606dSYehuda Sadeh
56dfc5606dSYehuda Sadehrefresh
57dfc5606dSYehuda Sadeh
58dfc5606dSYehuda Sadeh	Writing to this file will reread the image header data and set
59dfc5606dSYehuda Sadeh	all relevant datastructures accordingly.
60dfc5606dSYehuda Sadeh
61dfc5606dSYehuda Sadehcurrent_snap
62dfc5606dSYehuda Sadeh
63dfc5606dSYehuda Sadeh	The current snapshot for which the device is mapped.
64dfc5606dSYehuda Sadeh
65dfc5606dSYehuda Sadehcreate_snap
66dfc5606dSYehuda Sadeh
67dfc5606dSYehuda Sadeh	Create a snapshot:
68dfc5606dSYehuda Sadeh
69dfc5606dSYehuda Sadeh	 $ echo <snap-name> > /sys/bus/rbd/devices/<dev-id>/snap_create
70dfc5606dSYehuda Sadeh
71dfc5606dSYehuda Sadehsnap_*
72dfc5606dSYehuda Sadeh
73dfc5606dSYehuda Sadeh	A directory per each snapshot
74dfc5606dSYehuda Sadeh
75dfc5606dSYehuda Sadeh
76dfc5606dSYehuda SadehEntries under /sys/bus/rbd/devices/<dev-id>/snap_<snap-name>
77dfc5606dSYehuda Sadeh-------------------------------------------------------------
78dfc5606dSYehuda Sadeh
79b7f6519eSJosh Durginsnap_id
80dfc5606dSYehuda Sadeh
81dfc5606dSYehuda Sadeh	The rados internal snapshot id assigned for this snapshot
82dfc5606dSYehuda Sadeh
83b7f6519eSJosh Durginsnap_size
84dfc5606dSYehuda Sadeh
85dfc5606dSYehuda Sadeh	The size of the image when this snapshot was taken.
86dfc5606dSYehuda Sadeh
87dfc5606dSYehuda Sadeh
88