xref: /linux/Documentation/ABI/testing/sysfs-block-rnbd (revision 8be98d2f2a0a262f8bf8a0bc1fdf522b3c7aab17)
1What:		/sys/block/rnbd<N>/rnbd/unmap_device
2Date:		Feb 2020
3KernelVersion:	5.7
4Contact:	Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
5Description:	To unmap a volume, "normal" or "force" has to be written to:
6		/sys/block/rnbd<N>/rnbd/unmap_device
7
8		When "normal" is used, the operation will fail with EBUSY if any process
9		is using the device.  When "force" is used, the device is also unmapped
10		when device is in use.  All I/Os that are in progress will fail.
11
12		Example::
13
14		  # echo "normal" > /sys/block/rnbd0/rnbd/unmap_device
15
16What:		/sys/block/rnbd<N>/rnbd/state
17Date:		Feb 2020
18KernelVersion:	5.7
19Contact:	Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
20Description:	The file contains the current state of the block device. The state file
21		returns "open" when the device is successfully mapped from the server
22		and accepting I/O requests. When the connection to the server gets
23		disconnected in case of an error (e.g. link failure), the state file
24		returns "closed" and all I/O requests submitted to it will fail with -EIO.
25
26What:		/sys/block/rnbd<N>/rnbd/session
27Date:		Feb 2020
28KernelVersion:	5.7
29Contact:	Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
30Description:	RNBD uses RTRS session to transport the data between client and
31		server.  The entry "session" contains the name of the session, that
32		was used to establish the RTRS session.  It's the same name that
33		was passed as server parameter to the map_device entry.
34
35What:		/sys/block/rnbd<N>/rnbd/mapping_path
36Date:		Feb 2020
37KernelVersion:	5.7
38Contact:	Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
39Description:	Contains the path that was passed as "device_path" to the map_device
40		operation.
41
42What:		/sys/block/rnbd<N>/rnbd/access_mode
43Date:		Feb 2020
44KernelVersion:	5.7
45Contact:	Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
46Description:	Contains the device access mode: ro, rw or migration.
47
48What:		/sys/block/rnbd<N>/rnbd/resize
49Date:		Feb 2020
50KernelVersion:	5.7
51Contact:	Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
52Description:	Write the number of sectors to change the size of the disk.
53
54What:		/sys/block/rnbd<N>/rnbd/remap_device
55Date:		Feb 2020
56KernelVersion:	5.7
57Contact:	Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
58Description:	Remap the disconnected device if the session is not destroyed yet.
59
60What:		/sys/block/rnbd<N>/rnbd/nr_poll_queues
61Date:		Feb 2020
62KernelVersion:	5.7
63Contact:	Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
64Description:	Contains the number of poll-mode queues
65