aoe-stat.8 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  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 ifname
  29. The network interface name is printed in the second column.
  30. .TP
  31. .BI status
  32. The device status is in the last column. Possible values
  33. are \fI up\fR, \fI down\fR,
  34. and \fI down,closewait\fR. The "up" status means the aoe driver
  35. considers this device ready
  36. for I/O. The "down" status means the opposite. The "down,closewait"
  37. status means that some software still has the device open, and when
  38. this straggler closes the device, it will enter the "down" state.
  39. .SH ENVIRONMENT VARIABLES
  40. If the
  41. .I sysfs_dir
  42. variable is set in the environment, it will override the default
  43. location where
  44. .I aoe-stat
  45. will look for
  46. sysfs, namely \fI /sys\fR.
  47. .SH EXAMPLE
  48. In this example, the root user on a host named
  49. .I nai
  50. loads the aoe driver module and then prints a list of all the
  51. available aoe devices. Then he remembers to bring up the storage
  52. network interfaces, does an AoE discovery, and prints the list again.
  53. This time the list shows all the devices in shelf seven.
  54. .IP
  55. .EX
  56. nai:~# modprobe aoe
  57. nai:~# aoe-stat
  58. nai:~# ifconfig eth3 up
  59. nai:~# aoe-discover
  60. nai:~# aoe-stat
  61. e7.0 eth3 up
  62. e7.1 eth3 up
  63. e7.2 eth3 up
  64. e7.3 eth3 up
  65. e7.4 eth3 up
  66. e7.5 eth3 up
  67. e7.6 eth3 up
  68. e7.7 eth3 up
  69. e7.8 eth3 up
  70. e7.9 eth3 up
  71. nai:~#
  72. .EE
  73. .LP
  74. .SH "SEE ALSO"
  75. .IR aoe-discover (8),
  76. .IR aoe-interfaces (8),
  77. .IR aoe-mkdevs (8),
  78. .IR aoe-mkshelf (8).
  79. .SH AUTHOR
  80. Ed L. Cashin (ecashin@coraid.com)