Documentation/ABI/testing/sysfs-class-rnbd-server

   1 What:           /sys/class/rnbd-server
   2 Date:           Feb 2020
   3 KernelVersion:  5.7
   4 Contact:        Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
   5 Description:    provide information about RNBD-server.
   6
   7 What:           /sys/class/rnbd-server/ctl/
   8 Date:           Feb 2020
   9 KernelVersion:  5.7
  10 Contact:        Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  11 Description:    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
  14 What:           /sys/class/rnbd-server/ctl/devices/<device_name>/block_dev
  15 Date:           Feb 2020
  16 KernelVersion:  5.7
  17 Contact:        Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  18 Description:    Is a symlink to the sysfs entry of the exported device.
  19
  20                 Example:
  21                 block_dev -> ../../../../class/block/ram0
  22
  23 What:           /sys/class/rnbd-server/ctl/devices/<device_name>/sessions/
  24 Date:           Feb 2020
  25 KernelVersion:  5.7
  26 Contact:        Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  27 Description:    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
  34 What:           /sys/class/rnbd-server/ctl/devices/<device_name>/sessions/<session-name>/read_only
  35 Date:           Feb 2020
  36 KernelVersion:  5.7
  37 Contact:        Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  38 Description:    Contains '1' if device is mapped read-only, otherwise '0'.
  39
  40 What:           /sys/class/rnbd-server/ctl/devices/<device_name>/sessions/<session-name>/mapping_path
  41 Date:           Feb 2020
  42 KernelVersion:  5.7
  43 Contact:        Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  44 Description:    Contains the relative device path provided by the user during mapping.
  45
  46 What:           /sys/class/rnbd-server/ctl/devices/<device_name>/sessions/<session-name>/access_mode
  47 Date:           Feb 2020
  48 KernelVersion:  5.7
  49 Contact:        Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  50 Description:    Contains the device access mode: ro, rw or migration.
  51
  52 What:           /sys/class/rnbd-server/ctl/devices/<device_name>/sessions/<session-name>/force_close
  53 Date:           Nov 2020
  54 KernelVersion:  5.10
  55 Contact:        Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  56 Description:    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.