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