sysfs-bus-rbd 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122
  1. What: /sys/bus/rbd/
  2. Date: November 2010
  3. Contact: Yehuda Sadeh <yehuda@newdream.net>,
  4. Sage Weil <sage@newdream.net>
  5. Description:
  6. Being used for adding and removing rbd block devices.
  7. Usage: <mon ip addr> <options> <pool name> <rbd image name> [<snap name>]
  8. $ echo "192.168.0.1 name=admin rbd foo" > /sys/bus/rbd/add
  9. The snapshot name can be "-" or omitted to map the image read/write. A <dev-id>
  10. will be assigned for any registered block device. If snapshot is used, it will
  11. be mapped read-only.
  12. Usage: <dev-id> [force]
  13. $ echo 2 > /sys/bus/rbd/remove
  14. Optional "force" argument which when passed will wait for running requests and
  15. then unmap the image. Requests sent to the driver after initiating the removal
  16. will be failed. (August 2016, since 4.9.)
  17. What: /sys/bus/rbd/add_single_major
  18. Date: December 2013
  19. KernelVersion: 3.14
  20. Contact: Sage Weil <sage@inktank.com>
  21. Description: Available only if rbd module is inserted with single_major
  22. parameter set to true.
  23. Usage is the same as for /sys/bus/rbd/add. If present,
  24. should be used instead of the latter: any attempts to use
  25. /sys/bus/rbd/add if /sys/bus/rbd/add_single_major is
  26. available will fail for backwards compatibility reasons.
  27. What: /sys/bus/rbd/remove_single_major
  28. Date: December 2013
  29. KernelVersion: 3.14
  30. Contact: Sage Weil <sage@inktank.com>
  31. Description: 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/remove. If present,
  34. should be used instead of the latter: any attempts to use
  35. /sys/bus/rbd/remove if /sys/bus/rbd/remove_single_major is
  36. available will fail for backwards compatibility reasons.
  37. Entries under /sys/bus/rbd/devices/<dev-id>/
  38. --------------------------------------------
  39. client_addr
  40. The ceph unique client entity_addr_t (address + nonce).
  41. The format is <address>:<port>/<nonce>: '1.2.3.4:1234/5678' or
  42. '[1:2:3:4:5:6:7:8]:1234/5678'. (August 2016, since 4.9.)
  43. client_id
  44. The ceph unique client id that was assigned for this specific session.
  45. cluster_fsid
  46. The ceph cluster UUID. (August 2016, since 4.9.)
  47. config_info
  48. The string written into /sys/bus/rbd/add{,_single_major}. (August
  49. 2016, since 4.9.)
  50. features
  51. A hexadecimal encoding of the feature bits for this image.
  52. major
  53. The block device major number.
  54. minor
  55. The block device minor number. (December 2013, since 3.14.)
  56. name
  57. The name of the rbd image.
  58. image_id
  59. The unique id for the rbd image. (For rbd image format 1
  60. this is empty.)
  61. pool
  62. The name of the storage pool where this rbd image resides.
  63. An rbd image name is unique within its pool.
  64. pool_id
  65. The unique identifier for the rbd image's pool. This is
  66. a permanent attribute of the pool. A pool's id will never
  67. change.
  68. size
  69. The size (in bytes) of the mapped block device.
  70. refresh
  71. Writing to this file will reread the image header data and set
  72. all relevant datastructures accordingly.
  73. current_snap
  74. The current snapshot for which the device is mapped.
  75. snap_id
  76. The current snapshot's id. (August 2016, since 4.9.)
  77. parent
  78. Information identifying the chain of parent images in a layered rbd
  79. image. Entries are separated by empty lines.