1aoeping(8) System Manager's Manual aoeping(8)
2
6 aoeping - simple communication with AoE device
7
9 aoeping [options] {shelf} {slot} {netif}
10
12 The aoeping(8) program performs simple one or two-round-trip communica‐
13 tion with an ATA over Ethernet (AoE) device.
14 Running aoeping(8) without command line arguments will result in a
16 short usage summary being displayed.
17 The aoeping(8) program will wait forever if if doesn't receive an
19 expected response. The caller should use a time out to catch this sit‐
20 uation.
21 Arguments
23 shelf This should be the shelf address (major AoE address) of the AoE
24 device to communicate with.
25 slot This should be the slot address (minor AoE address) of the AoE
27 device to communicate with.
28 netif The name of the ethernet network interface to use for AoE commu‐
30 nications, e.g., eth1.
31 Options
33 -i Issue an ATA "identify device" command after receiving the AoE
34 device's Config Query response. The "ident" response will be
35 printed on standard output as a hexidecimal dump.
36 -I Issue an ATA "identify device" command after receiving the AoE
38 device's Config Query response. The "ident" response will be
39 pretty-printed on standard output as selected human-readable
40 fields.
41 -v Turn on more copious output, including a hexidecimal dump of the
43 Config Query response from the AoE device (see AoE spec at URL
44 below).
45 -s This option takes an argument. The argument is a decimal inte‐
47 ger that specifies the number of seconds that aoeping(8) will
48 wait for a response before timing out and exiting with a non-
49 zero status.
50 -S This option takes an argument. The argument is the name of a
52 SMART command to send to the disk. The SMART commands in the
53 list below are supported. If the command requires data trans‐
54 fer, one sector (512 bytes) of data is always the amount trans‐
55 fered. If the command takes a parameter (for the Low LBA regis‐
56 ter), then the name of the SMART command is immediately followed
57 by a colon and then a number, the value of the parameter, e.g.,
58 "-S read_log:1".
59 read_data
61 offline_immediate
62 read_log
63 write_log
64 enable
65 disable
66 return_status
67 For write_log, aoeping(8) reads from standard input the one sec‐
69 tor of data to be written to the specified log.
70 The aoeping(8) command just sends and receives SMART commands,
72 without interpreting them. See the ATA specification for more
73 information on using SMART.
74 -t (This is an advanced feature.) This option has an argument.
76 The argument is a decimal integer that is used as the initial
77 tag, with the highest bit set, as the first tag in ATA commands.
78 Tags for subsequent ATA commands will be incremented by one.
79 -h Show a usage summary.
81
83 In this example, the root user uses aoeping(8) to check for the pres‐
84 ence of aoe device e10.9 on network interface eth0.
85 bash# aoeping -v 10 9 eth0 | head
87 tag: 80000000
88 eth: eth0
89 shelf: 10
90 slot: 9
91 config query response:
92 00 0d 87 aa c9 00 00 10 04 00 11 1f 88 a2 18 00
93 00 0a 09 01 00 00 00 00 00 03 30 08 00 10 00 04
94 66 6f 6f 0a 00 ff ff ff ff ff ff ff ff ff ff ff
95 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff
96 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff
97 The next example shows root making sure the disk on the e10.9 is still
99 responsive by issuing an ATA device identify command with a 20-second
100 timeout.
101 bash# aoeping -i -s 20 \
103 10 9 eth0 > /dev/null \
104 && echo ok
105 ok
106 The next example uses SMART to determine whether the disk on e10.9
108 thinks it has exceeded its error threshold. The ATA spec says that the
109 LBA Mid register will be 0x4f when the disk has not exceeded its error
110 threshold.
111 bash# aoeping -S return_status \
113 10 9 eth0 | grep 'LBA Mid: 0x4f' \
114 > /dev/null \
115 && echo ok
116 ok
117 Note that in a script, it would be prudent to specify and handle a
119 timeout. Also, a good script would make sure the Status register does
120 not have the error bit (bit zero) or the device fault bit (bit 5) set.
121
123 aoe-discover(8), aoe-interfaces(8), aoe-mkdevs(8), aoe-mkshelf(8), aoe-
124 stat(8),
125 AoE (ATA over Ethernet): http://www.coraid.com/documents/AoEr10.txt,
127 ATA specification
129
131 Ed L. Cashin (ecashin@coraid.com)
132 aoeping(8)