aboutsummaryrefslogtreecommitdiff
path: root/Documentation/ABI/testing/sysfs-bus-rbd
blob: cd9213ccf3dc263ba2e87ff2ecc660ef370c1f1a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
What:		/sys/bus/rbd/
Date:		November 2010
Contact:	Yehuda Sadeh <yehuda@newdream.net>,
		Sage Weil <sage@newdream.net>
Description:

Being used for adding and removing rbd block devices.

Usage: <mon ip addr> <options> <pool name> <rbd image name> [snap name]

 $ echo "192.168.0.1 name=admin rbd foo" > /sys/bus/rbd/add

The snapshot name can be "-" or omitted to map the image read/write. A <dev-id>
will be assigned for any registered block device. If snapshot is used, it will
be mapped read-only.

Removal of a device:

  $ echo <dev-id> > /sys/bus/rbd/remove

Entries under /sys/bus/rbd/devices/<dev-id>/
--------------------------------------------

client_id

	The ceph unique client id that was assigned for this specific session.

features

	A hexadecimal encoding of the feature bits for this image.

major

	The block device major number.

name

	The name of the rbd image.

image_id

	The unique id for the rbd image.  (For rbd image format 1
	this is empty.)

pool

	The name of the storage pool where this rbd image resides.
	An rbd image name is unique within its pool.

pool_id

	The unique identifier for the rbd image's pool.  This is
	a permanent attribute of the pool.  A pool's id will never
	change.

size

	The size (in bytes) of the mapped block device.

refresh

	Writing to this file will reread the image header data and set
	all relevant datastructures accordingly.

current_snap

	The current snapshot for which the device is mapped.

snap_*

	A directory per each snapshot

parent

	Information identifying the pool, image, and snapshot id for
	the parent image in a layered rbd image (format 2 only).

Entries under /sys/bus/rbd/devices/<dev-id>/snap_<snap-name>
-------------------------------------------------------------

snap_id

	The rados internal snapshot id assigned for this snapshot

snap_size

	The size of the image when this snapshot was taken.

snap_features

	A hexadecimal encoding of the feature bits for this snapshot.