sysfs-bus-rbd 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
  1. What: /sys/bus/rbd/add
  2. Date: Oct, 2010
  3. KernelVersion: v2.6.37
  4. Contact: Sage Weil <sage@newdream.net>
  5. Description:
  6. (WO) Add rbd block device.
  7. Usage: <mon ip addr> <options> <pool name> <rbd image name> [<snap name>]
  8. Example::
  9. $ echo "192.168.0.1 name=admin rbd foo" > /sys/bus/rbd/add
  10. The snapshot name can be "-" or omitted to map the image
  11. read/write. A <dev-id> will be assigned for any registered block
  12. device. If snapshot is used, it will be mapped read-only.
  13. What: /sys/bus/rbd/remove
  14. Date: Oct, 2010
  15. KernelVersion: v2.6.37
  16. Contact: Sage Weil <sage@newdream.net>
  17. Description:
  18. (WO) Remove rbd block device.
  19. Usage: <dev-id> [force]
  20. Example::
  21. $ echo 2 > /sys/bus/rbd/remove
  22. Optional "force" argument which when passed will wait for
  23. running requests and then unmap the image. Requests sent to the
  24. driver after initiating the removal will be failed. (August
  25. 2016, since 4.9.)
  26. What: /sys/bus/rbd/add_single_major
  27. Date: Dec, 2013
  28. KernelVersion: v3.14
  29. Contact: Sage Weil <sage@newdream.net>
  30. Description:
  31. (WO) Available only if rbd module is inserted with single_major
  32. parameter set to true.
  33. Usage is the same as for /sys/bus/rbd/add. If present, this
  34. should be used instead of the latter: any attempts to use
  35. /sys/bus/rbd/add if /sys/bus/rbd/add_single_major is available
  36. will fail for backwards compatibility reasons.
  37. What: /sys/bus/rbd/remove_single_major
  38. Date: Dec, 2013
  39. KernelVersion: v3.14
  40. Contact: Sage Weil <sage@newdream.net>
  41. Description:
  42. (WO) Available only if rbd module is inserted with single_major
  43. parameter set to true.
  44. Usage is the same as for /sys/bus/rbd/remove. If present, this
  45. should be used instead of the latter: any attempts to use
  46. /sys/bus/rbd/remove if /sys/bus/rbd/remove_single_major is
  47. available will fail for backwards compatibility reasons.
  48. What: /sys/bus/rbd/supported_features
  49. Date: Mar, 2017
  50. KernelVersion: v4.11
  51. Contact: Sage Weil <sage@newdream.net>
  52. Description:
  53. (RO) Displays the features supported by the rbd module so that
  54. userspace can generate meaningful error messages and spell out
  55. unsupported features that need to be disabled.
  56. What: /sys/bus/rbd/devices/<dev-id>/size
  57. What: /sys/bus/rbd/devices/<dev-id>/major
  58. What: /sys/bus/rbd/devices/<dev-id>/client_id
  59. What: /sys/bus/rbd/devices/<dev-id>/pool
  60. What: /sys/bus/rbd/devices/<dev-id>/name
  61. What: /sys/bus/rbd/devices/<dev-id>/refresh
  62. What: /sys/bus/rbd/devices/<dev-id>/current_snap
  63. Date: Oct, 2010
  64. KernelVersion: v2.6.37
  65. Contact: Sage Weil <sage@newdream.net>
  66. Description:
  67. ============== ================================================
  68. size (RO) The size (in bytes) of the mapped block
  69. device.
  70. major (RO) The block device major number.
  71. client_id (RO) The ceph unique client id that was assigned
  72. for this specific session.
  73. pool (RO) The name of the storage pool where this rbd
  74. image resides. An rbd image name is unique
  75. within its pool.
  76. name (RO) The name of the rbd image.
  77. refresh (WO) Writing to this file will reread the image
  78. header data and set all relevant data structures
  79. accordingly.
  80. current_snap (RO) The current snapshot for which the device
  81. is mapped.
  82. ============== ================================================
  83. What: /sys/bus/rbd/devices/<dev-id>/pool_id
  84. Date: Jul, 2012
  85. KernelVersion: v3.6
  86. Contact: Sage Weil <sage@newdream.net>
  87. Description:
  88. (RO) The unique identifier for the rbd image's pool. This is a
  89. permanent attribute of the pool. A pool's id will never change.
  90. What: /sys/bus/rbd/devices/<dev-id>/image_id
  91. What: /sys/bus/rbd/devices/<dev-id>/features
  92. Date: Oct, 2012
  93. KernelVersion: v3.7
  94. Contact: Sage Weil <sage@newdream.net>
  95. Description:
  96. ========= ===============================================
  97. image_id (RO) The unique id for the rbd image. (For rbd
  98. image format 1 this is empty.)
  99. features (RO) A hexadecimal encoding of the feature bits
  100. for this image.
  101. ========= ===============================================
  102. What: /sys/bus/rbd/devices/<dev-id>/parent
  103. Date: Nov, 2012
  104. KernelVersion: v3.8
  105. Contact: Sage Weil <sage@newdream.net>
  106. Description:
  107. (RO) Information identifying the chain of parent images in a
  108. layered rbd image. Entries are separated by empty lines.
  109. What: /sys/bus/rbd/devices/<dev-id>/minor
  110. Date: Dec, 2013
  111. KernelVersion: v3.14
  112. Contact: Sage Weil <sage@newdream.net>
  113. Description:
  114. (RO) The block device minor number.
  115. What: /sys/bus/rbd/devices/<dev-id>/snap_id
  116. What: /sys/bus/rbd/devices/<dev-id>/config_info
  117. What: /sys/bus/rbd/devices/<dev-id>/cluster_fsid
  118. What: /sys/bus/rbd/devices/<dev-id>/client_addr
  119. Date: Aug, 2016
  120. KernelVersion: v4.9
  121. Contact: Sage Weil <sage@newdream.net>
  122. Description:
  123. ============ ================================================
  124. snap_id (RO) The current snapshot's id.
  125. config_info (RO) The string written into
  126. /sys/bus/rbd/add{,_single_major}.
  127. cluster_fsid (RO) The ceph cluster UUID.
  128. client_addr (RO) The ceph unique client
  129. entity_addr_t (address + nonce). The format is
  130. <address>:<port>/<nonce>: '1.2.3.4:1234/5678' or
  131. '[1:2:3:4:5:6:7:8]:1234/5678'.
  132. ============ ================================================