Commit 67d9f847 authored by Ed L Cashin's avatar Ed L Cashin Committed by Greg KH
Browse files

[PATCH] aoe: update the documentation to mention aoetools

update the documentation to mention aoetools
Signed-off-by: default avatarEd L. Cashin <>
Signed-off-by: default avatarGreg Kroah-Hartman <>
parent c59a24dc
......@@ -4,6 +4,16 @@ The EtherDrive (R) HOWTO for users of 2.6 kernels is found at ...
It has many tips and hints!
The aoetools are userland programs that are designed to work with this
driver. The aoetools are on sourceforge.
The scripts in this Documentation/aoe directory are intended to
document the use of the driver and are not necessary if you install
the aoetools.
Users of udev should find the block device nodes created
......@@ -33,19 +43,17 @@ USING DEVICE NODES
"cat /dev/etherd/err" blocks, waiting for error diagnostic output,
like any retransmitted packets.
The /dev/etherd/interfaces special file is obsoleted by the
aoe_iflist boot option and module option (and its sysfs entry
described in the next section).
"echo eth2 eth4 > /dev/etherd/interfaces" tells the aoe driver to
limit ATA over Ethernet traffic to eth2 and eth4. AoE traffic from
untrusted networks should be ignored as a matter of security.
untrusted networks should be ignored as a matter of security. See
also the aoe_iflist driver option described below.
"echo > /dev/etherd/discover" tells the driver to find out what AoE
devices are available.
These character devices may disappear and be replaced by sysfs
counterparts, so distribution maintainers are encouraged to create
scripts that use these devices.
counterparts. Using the commands in aoetools insulates users from
these implementation details.
The block devices are named like this:
......@@ -69,7 +77,8 @@ USING SYSFS
through which we are communicating with the remote AoE device.
There is a script in this directory that formats this information
in a convenient way.
in a convenient way. Users with aoetools can use the aoe-stat
root@makki root# sh Documentation/aoe/
e10.0 eth3 up
......@@ -100,9 +109,9 @@ USING SYSFS
sysfs entry can be read from as well as written to.
It's helpful to trigger discovery after setting the list of allowed
interfaces. If your distro provides an aoe-discover script, you can
use that. Otherwise, you can directly use the /dev/etherd/discover
file described above.
interfaces. The aoetools package provides an aoe-discover script
for this purpose. You can also directly use the
/dev/etherd/discover special file described above.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment