This commit was manufactured by cvs2svn to create branch 'vserver'.
[linux-2.6.git] / Documentation / aoe / aoe.txt
1 The EtherDrive (R) HOWTO for users of 2.6 kernels is found at ...
2
3   http://www.coraid.com/support/linux/EtherDrive-2.6-HOWTO.html
4
5   It has many tips and hints!
6
7 CREATING DEVICE NODES
8
9   Users of udev should find device nodes created automatically.  Two
10   scripts are provided in Documentation/aoe as examples of static
11   device node creation for using the aoe driver.
12
13     rm -rf /dev/etherd
14     sh Documentation/aoe/mkdevs.sh /dev/etherd
15
16   ... or to make just one shelf's worth of block device nodes ...
17
18     sh Documentation/aoe/mkshelf.sh /dev/etherd 0
19
20   There is also an autoload script that shows how to edit
21   /etc/modprobe.conf to ensure that the aoe module is loaded when
22   necessary.
23
24 USING DEVICE NODES
25
26   "cat /dev/etherd/err" blocks, waiting for error diagnostic output,
27   like any retransmitted packets.
28
29   "echo eth2 eth4 > /dev/etherd/interfaces" tells the aoe driver to
30   limit ATA over Ethernet traffic to eth2 and eth4.  AoE traffic from
31   untrusted networks should be ignored as a matter of security.
32
33   "echo > /dev/etherd/discover" tells the driver to find out what AoE
34   devices are available.
35
36   These character devices may disappear and be replaced by sysfs
37   counterparts, so distribution maintainers are encouraged to create
38   scripts that use these devices.
39
40   The block devices are named like this:
41
42         e{shelf}.{slot}
43         e{shelf}.{slot}p{part}
44
45   ... so that "e0.2" is the third blade from the left (slot 2) in the
46   first shelf (shelf address zero).  That's the whole disk.  The first
47   partition on that disk would be "e0.2p1".
48
49 USING SYSFS
50
51   Each aoe block device in /sys/block has the extra attributes of
52   state, mac, and netif.  The state attribute is "up" when the device
53   is ready for I/O and "down" if detected but unusable.  The
54   "down,closewait" state shows that the device is still open and
55   cannot come up again until it has been closed.
56
57   The mac attribute is the ethernet address of the remote AoE device.
58   The netif attribute is the network interface on the localhost
59   through which we are communicating with the remote AoE device.
60
61   There is a script in this directory that formats this information
62   in a convenient way.
63
64   root@makki root# sh Documentation/aoe/status.sh 
65      e10.0            eth3              up
66      e10.1            eth3              up
67      e10.2            eth3              up
68      e10.3            eth3              up
69      e10.4            eth3              up
70      e10.5            eth3              up
71      e10.6            eth3              up
72      e10.7            eth3              up
73      e10.8            eth3              up
74      e10.9            eth3              up
75       e4.0            eth1              up
76       e4.1            eth1              up
77       e4.2            eth1              up
78       e4.3            eth1              up
79       e4.4            eth1              up
80       e4.5            eth1              up
81       e4.6            eth1              up
82       e4.7            eth1              up
83       e4.8            eth1              up
84       e4.9            eth1              up