xref: /linux/Documentation/ABI/testing/sysfs-class-rnbd-server (revision 3d0fe49454652117522f60bfbefb978ba0e5300b)
1What:		/sys/class/rnbd-server
2Date:		Feb 2020
3KernelVersion:	5.7
4Contact:	Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
5Description:	provide information about RNBD-server.
6
7What:		/sys/class/rnbd-server/ctl/
8Date:		Feb 2020
9KernelVersion:	5.7
10Contact:	Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
11Description:	When a client maps a device, a directory entry with the name of the
12		block device is created under /sys/class/rnbd-server/ctl/devices/.
13
14What:		/sys/class/rnbd-server/ctl/devices/<device_name>/block_dev
15Date:		Feb 2020
16KernelVersion:	5.7
17Contact:	Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
18Description:	Is a symlink to the sysfs entry of the exported device.
19
20		Example:
21		block_dev -> ../../../../class/block/ram0
22
23What:		/sys/class/rnbd-server/ctl/devices/<device_name>/sessions/
24Date:		Feb 2020
25KernelVersion:	5.7
26Contact:	Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
27Description:	For each client a particular device is exported to, following directory will be
28		created:
29
30		/sys/class/rnbd-server/ctl/devices/<device_name>/sessions/<session-name>/
31
32		When the device is unmapped by that client, the directory will be removed.
33
34What:		/sys/class/rnbd-server/ctl/devices/<device_name>/sessions/<session-name>/read_only
35Date:		Feb 2020
36KernelVersion:	5.7
37Contact:	Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
38Description:	Contains '1' if device is mapped read-only, otherwise '0'.
39
40What:		/sys/class/rnbd-server/ctl/devices/<device_name>/sessions/<session-name>/mapping_path
41Date:		Feb 2020
42KernelVersion:	5.7
43Contact:	Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
44Description:	Contains the relative device path provided by the user during mapping.
45
46What:		/sys/class/rnbd-server/ctl/devices/<device_name>/sessions/<session-name>/access_mode
47Date:		Feb 2020
48KernelVersion:	5.7
49Contact:	Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
50Description:	Contains the device access mode: ro, rw or migration.
51
52What:		/sys/class/rnbd-server/ctl/devices/<device_name>/sessions/<session-name>/force_close
53Date:		Nov 2020
54KernelVersion:	5.10
55Contact:	Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
56Description:	Write "1" to the file to close the device on server side. Please
57		note that the client side device will not be closed, read or
58		write to the device will get -ENOTCONN.
59