aoe-stat.8 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106
  1. .TH aoe-stat 8
  2. .SH NAME
  3. aoe-stat \- print aoe device status report
  4. .SH SYNOPSIS
  5. .nf
  6. .B modprobe aoe
  7. .B aoe-stat
  8. .B env sysfs_dir=/sys aoe-stat
  9. .fi
  10. .SH DESCRIPTION
  11. The
  12. .I aoe-stat
  13. script collects information on ATA over Ethernet devices from sysfs.
  14. .PP
  15. For each AoE device the kernel has discovered, there is one row in the
  16. script's output. Each row has
  17. the following columns.
  18. .TP
  19. .BI devicename
  20. The device name is of the form
  21. .I eX.Y,
  22. with
  23. .I X
  24. being the AoE device shelf address, and
  25. .I Y
  26. being the AoE slot address.
  27. .TP
  28. .BI size
  29. The size of the AoE device is in gigabytes (billions of bytes).
  30. .TP
  31. .BI ifname
  32. The network interface name is printed in the third column.
  33. .TP
  34. .BI payload
  35. The number of bytes read from or written to the storage target in
  36. each AoE packet appears in the fourth column, unless the aoe driver
  37. does not export this information.
  38. .TP
  39. .BI status
  40. The device status is in the last column. Possible values
  41. are \fI up\fR, \fI down\fR,
  42. and \fI down,closewait\fR. The "up" status means the aoe driver
  43. considers this device ready
  44. for I/O. The "down" status means the opposite. The "down,closewait"
  45. status means that some software still has the device open, and when
  46. this straggler closes the device, it will enter the "down" state.
  47. .SH ENVIRONMENT VARIABLES
  48. If the
  49. .I sysfs_dir
  50. variable is set in the environment, it will override the default
  51. location where
  52. .I aoe-stat
  53. will look for
  54. sysfs, namely \fI /sys\fR.
  55. .SH WARNINGS
  56. If the minor device number of a device node does not match that of its
  57. namesake, \fIaoe-stat\fP will print a warning as shown below.
  58. .IP
  59. .EX
  60. .nf
  61. nai:~# aoe-stat
  62. e0.3 0.104GB eth0 up
  63. e0.4 4398.046GB eth0 up
  64. e20.0 1000.215GB eth0 up
  65. e42.0 2000.431GB eth0 up
  66. aoe-stat Warning: device node /dev/etherd/e45.1 has wrong minor device number
  67. e45.1 1152.874GB eth0 up
  68. .fi
  69. .EE
  70. .PP
  71. Using such a device node is dangerous, because its name doesn't match
  72. the actual device that you would be reading from and writing to. Such
  73. a broken device node should be removed. Device nodes are created by
  74. \fIudev\fP or (on systems without \fIudev\fP) by \fIaoe-mkdevs\fP.
  75. .SH EXAMPLE
  76. In this example, the root user on a host named
  77. .I nai
  78. loads the aoe driver module and then prints a list of all the
  79. available aoe devices. Then he remembers to bring up the storage
  80. network interfaces, does an AoE discovery, and prints the list again.
  81. This time the list shows all the devices in shelf seven.
  82. .IP
  83. .EX
  84. .nf
  85. nai:~# modprobe aoe
  86. nai:~# aoe-stat
  87. nai:~# ifconfig eth3 up
  88. nai:~# aoe-discover
  89. nai:~# aoe-stat
  90. e0.0 10995.116GB eth0 up
  91. e0.1 10995.116GB eth0 up
  92. e0.2 10995.116GB eth0 up
  93. e1.0 1152.874GB eth0 up
  94. e7.0 370.566GB eth0 up
  95. nai:~#
  96. .fi
  97. .EE
  98. .SH "SEE ALSO"
  99. .IR aoe-discover (8),
  100. .IR aoe-interfaces (8),
  101. .IR aoe-mkdevs (8),
  102. .IR aoe-mkshelf (8),
  103. .IR aoetools (8),
  104. .IR udev (7).
  105. .SH AUTHOR
  106. Ed L. Cashin (ecashin@coraid.com)