]> git.openfabrics.org - ~shefty/rdma-dev.git/blob - Documentation/ABI/testing/sysfs-bus-rbd
rbd: replace the rbd sysfs interface
[~shefty/rdma-dev.git] / Documentation / ABI / testing / sysfs-bus-rbd
1 What:           /sys/bus/rbd/
2 Date:           November 2010
3 Contact:        Yehuda Sadeh <yehuda@hq.newdream.net>,
4                 Sage Weil <sage@newdream.net>
5 Description:
6
7 Being used for adding and removing rbd block devices.
8
9 Usage: <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
13 The snapshot name can be "-" or omitted to map the image read/write. A <dev-id>
14 will be assigned for any registered block device. If snapshot is used, it will
15 be mapped read-only.
16
17 Removal of a device:
18
19   $ echo <dev-id> > /sys/bus/rbd/remove
20
21 Entries under /sys/bus/rbd/devices/<dev-id>/
22 --------------------------------------------
23
24 client_id
25
26         The ceph unique client id that was assigned for this specific session.
27
28 major
29
30         The block device major number.
31
32 name
33
34         The name of the rbd image.
35
36 pool
37
38         The pool where this rbd image resides. The pool-name pair is unique
39         per rados system.
40
41 size
42
43         The size (in bytes) of the mapped block device.
44
45 refresh
46
47         Writing to this file will reread the image header data and set
48         all relevant datastructures accordingly.
49
50 current_snap
51
52         The current snapshot for which the device is mapped.
53
54 create_snap
55
56         Create a snapshot:
57
58          $ echo <snap-name> > /sys/bus/rbd/devices/<dev-id>/snap_create
59
60 rollback_snap
61
62         Rolls back data to the specified snapshot. This goes over the entire
63         list of rados blocks and sends a rollback command to each.
64
65          $ echo <snap-name> > /sys/bus/rbd/devices/<dev-id>/snap_rollback
66
67 snap_*
68
69         A directory per each snapshot
70
71
72 Entries under /sys/bus/rbd/devices/<dev-id>/snap_<snap-name>
73 -------------------------------------------------------------
74
75 id
76
77         The rados internal snapshot id assigned for this snapshot
78
79 size
80
81         The size of the image when this snapshot was taken.
82
83