aoe-stat.8 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  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 UNAVAILABLE TARGETS
  48. If a discovered AoE target will not respond to I/O commands, some
  49. of the information needed to allow Linux to use the device is not
  50. available. The
  51. .I aoe-stat
  52. command shows the missing information as "(NA)" fields.
  53. .PP
  54. It is normal for "(NA)" fields to appear during the brief
  55. time between the time that an AoE target is detected and the
  56. time the Linux kernel finishes reading its partition table.
  57. .SH ENVIRONMENT VARIABLES
  58. If the
  59. .I sysfs_dir
  60. variable is set in the environment, it will override the default
  61. location where
  62. .I aoe-stat
  63. will look for
  64. sysfs, namely \fI /sys\fR.
  65. .SH WARNINGS
  66. If the minor device number of a device node does not match that of its
  67. namesake, \fIaoe-stat\fP will print a warning as shown below.
  68. .IP
  69. .EX
  70. .nf
  71. nai:~# aoe-stat
  72. e0.3 0.104GB eth0 up
  73. e0.4 4398.046GB eth0 up
  74. e20.0 1000.215GB eth0 up
  75. e42.0 2000.431GB eth0 up
  76. aoe-stat Warning: device node /dev/etherd/e45.1 has wrong minor device number
  77. e45.1 1152.874GB eth0 up
  78. .fi
  79. .EE
  80. .PP
  81. Using such a device node is dangerous, because its name doesn't match
  82. the actual device that you would be reading from and writing to. Such
  83. a broken device node should be removed. Device nodes are created by
  84. \fIudev\fP or (on systems without \fIudev\fP) by \fIaoe-mkdevs\fP.
  85. .SH EXAMPLE
  86. In this example, the root user on a host named
  87. .I nai
  88. loads the aoe driver module and then prints a list of all the
  89. available aoe devices. Then he remembers to bring up the storage
  90. network interfaces, does an AoE discovery, and prints the list again.
  91. This time the list shows all the devices in shelf seven.
  92. .IP
  93. .EX
  94. .nf
  95. nai:~# modprobe aoe
  96. nai:~# aoe-stat
  97. nai:~# ifconfig eth3 up
  98. nai:~# aoe-discover
  99. nai:~# aoe-stat
  100. e0.0 10995.116GB eth3 up
  101. e0.1 10995.116GB eth3 up
  102. e0.2 10995.116GB eth3 up
  103. e1.0 1152.874GB eth3 up
  104. e7.0 370.566GB eth3 up
  105. nai:~#
  106. .fi
  107. .EE
  108. .SH "SEE ALSO"
  109. .IR aoe-discover (8),
  110. .IR aoe-interfaces (8),
  111. .IR aoe-mkdevs (8),
  112. .IR aoe-mkshelf (8),
  113. .IR aoetools (8),
  114. .IR udev (7).
  115. .SH AUTHOR
  116. Ed L. Cashin (ecashin@coraid.com)