aoecfg.8 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. .TH aoecfg 8
  2. .SH NAME
  3. aoecfg \- manipulate AoE configuration strings
  4. .SH SYNOPSIS
  5. .B aoecfg
  6. [-c \fIcmd\fR] [-s \fIcfgstr\fR] [-t \fItimeout\fR] [\fIshelf slot\fR] [\fInetif\fR]
  7. .fi
  8. .SH DESCRIPTION
  9. .IR Aoecfg (8)
  10. sends AoE configuration commands that control the retrivial, conditional
  11. or unconditional setting of AoE configuration strings. Since configuration
  12. happens before the MAC address of the target is known, the packet is
  13. broadcast. AoE targets with a matching shelf and slot respond. Since
  14. the default shelf and slot are the wildcard values 0xffff and 0xff,
  15. with no arguments
  16. .IR aoecfg (8)
  17. will return configuration strings from all targets visible
  18. on the default interface,
  19. .IR eth0 .
  20. .SH OPTIONS
  21. .TP 8
  22. .BI \-c " cmd"
  23. specify the AoE configuration command. The default is
  24. .IR read .
  25. The available commands are
  26. .HP 8
  27. .B read
  28. Read the server config string without performing any test and
  29. respond.
  30. .HP 8
  31. .B test
  32. Respond only if the specified string exactly matches the server
  33. configuration string.
  34. .HP 8
  35. .B prefix
  36. Respond only if the specified string is a prefix of the server
  37. configuration string.
  38. .HP 8
  39. .B set
  40. If the current server config string is empty, set the server config
  41. string to the argument string and respond. If the current server
  42. config string is not empty, return a response with Flags bit E set
  43. and Error set to 4.
  44. .HP 8
  45. .B fset
  46. Force set the server config string to the argument string and respond.
  47. .TP
  48. .BI \-c " cfgstr"
  49. specify the config string.
  50. .TP
  51. .BI \-t " timeout"
  52. specify the timeout in seconds. The default is no timeout. If neither the shelf
  53. nor the slot are specified,
  54. .IR aoecfg (8)
  55. will exit after the first result. Otherwise,
  56. .IR aoecfg (8)
  57. will exit only after the timeout has expired since it does not know
  58. how many responses to expect.
  59. .TP
  60. .B shelf slot
  61. specify the shelf and slot used in the query. If unspecified, they
  62. default to broadcast.
  63. .TP
  64. .B netif
  65. specifiy the network interface. The default is
  66. .IR eth0 .
  67. .SH "SEE ALSO"
  68. .IR aoe-discover (8),
  69. .IR aoe-interfaces (8),
  70. .IR aoe-mkdevs (8),
  71. .IR aoe-mkshelf (8),
  72. .IR aoe-stat (8),
  73. .IR aoeping (8),
  74. \fIAoE (ATA over Ethernet)\fP: http://www.coraid.com/documents/AoEr10.txt,
  75. \fIATA specification\fP
  76. .SH AUTHOR
  77. Erik Quanstrom (quanstro@coraid.com)