aoe-stat.8 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  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 status
  35. The device status is in the last column. Possible values
  36. are \fI up\fR, \fI down\fR,
  37. and \fI down,closewait\fR. The "up" status means the aoe driver
  38. considers this device ready
  39. for I/O. The "down" status means the opposite. The "down,closewait"
  40. status means that some software still has the device open, and when
  41. this straggler closes the device, it will enter the "down" state.
  42. .SH ENVIRONMENT VARIABLES
  43. If the
  44. .I sysfs_dir
  45. variable is set in the environment, it will override the default
  46. location where
  47. .I aoe-stat
  48. will look for
  49. sysfs, namely \fI /sys\fR.
  50. .SH WARNINGS
  51. If the minor device number of a device node does not match that of its
  52. namesake, \fIaoe-stat\fP will print a warning as shown below.
  53. .IP
  54. .EX
  55. .nf
  56. nai:~# aoe-stat
  57. e0.3 0.104GB eth0 up
  58. e0.4 4398.046GB eth0 up
  59. e20.0 1000.215GB eth0 up
  60. e42.0 2000.431GB eth0 up
  61. aoe-stat Warning: device node /dev/etherd/e45.1 has wrong minor device number
  62. e45.1 1152.874GB eth0 up
  63. .fi
  64. .EE
  65. .PP
  66. Using such a device node is dangerous, because its name doesn't match
  67. the actual device that you would be reading from and writing to. Such
  68. a broken device node should be removed. Device nodes are created by
  69. \fIudev\fP or (on systems without \fIudev\fP) by \fIaoe-mkdevs\fP.
  70. .SH EXAMPLE
  71. In this example, the root user on a host named
  72. .I nai
  73. loads the aoe driver module and then prints a list of all the
  74. available aoe devices. Then he remembers to bring up the storage
  75. network interfaces, does an AoE discovery, and prints the list again.
  76. This time the list shows all the devices in shelf seven.
  77. .IP
  78. .EX
  79. .nf
  80. nai:~# modprobe aoe
  81. nai:~# aoe-stat
  82. nai:~# ifconfig eth3 up
  83. nai:~# aoe-discover
  84. nai:~# aoe-stat
  85. e0.0 10995.116GB eth0 up
  86. e0.1 10995.116GB eth0 up
  87. e0.2 10995.116GB eth0 up
  88. e1.0 1152.874GB eth0 up
  89. e7.0 370.566GB eth0 up
  90. nai:~#
  91. .fi
  92. .EE
  93. .SH "SEE ALSO"
  94. .IR aoe-discover (8),
  95. .IR aoe-interfaces (8),
  96. .IR aoe-mkdevs (8),
  97. .IR aoe-mkshelf (8),
  98. .IR aoetools (8),
  99. .IR udev (7).
  100. .SH AUTHOR
  101. Ed L. Cashin (ecashin@coraid.com)