Documentation/ABI/testing/sysfs-block-rnbd

   1 What:           /sys/block/rnbd<N>/rnbd/unmap_device
   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:    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
  16 What:           /sys/block/rnbd<N>/rnbd/state
  17 Date:           Feb 2020
  18 KernelVersion:  5.7
  19 Contact:        Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  20 Description:    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
  26 What:           /sys/block/rnbd<N>/rnbd/session
  27 Date:           Feb 2020
  28 KernelVersion:  5.7
  29 Contact:        Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  30 Description:    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
  35 What:           /sys/block/rnbd<N>/rnbd/mapping_path
  36 Date:           Feb 2020
  37 KernelVersion:  5.7
  38 Contact:        Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  39 Description:    Contains the path that was passed as "device_path" to the map_device
  40                 operation.
  41
  42 What:           /sys/block/rnbd<N>/rnbd/access_mode
  43 Date:           Feb 2020
  44 KernelVersion:  5.7
  45 Contact:        Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  46 Description:    Contains the device access mode: ro, rw or migration.
  47
  48 What:           /sys/block/rnbd<N>/rnbd/resize
  49 Date:           Feb 2020
  50 KernelVersion:  5.7
  51 Contact:        Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  52 Description:    Write the number of sectors to change the size of the disk.
  53
  54 What:           /sys/block/rnbd<N>/rnbd/remap_device
  55 Date:           Feb 2020
  56 KernelVersion:  5.7
  57 Contact:        Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  58 Description:    Remap the disconnected device if the session is not destroyed yet.
  59
  60 What:           /sys/block/rnbd<N>/rnbd/nr_poll_queues
  61 Date:           Feb 2020
  62 KernelVersion:  5.7
  63 Contact:        Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
  64 Description:    Contains the number of poll-mode queues