1aoeping(8)                  System Manager's Manual                 aoeping(8)
2
3
4

NAME

6       aoeping - simple communication with AoE device
7

SYNOPSIS

9       aoeping [options] {shelf} {slot} {netif}
10

DESCRIPTION

12       The aoeping program performs simple one or two-round-trip communication
13       with an ATA over Ethernet (AoE) device.
14
15       Running aoeping without command line arguments will result in  a  short
16       usage summary being displayed.
17
18       The aoeping program will wait forever if if doesn't receive an expected
19       response.  The caller should use a time out to catch this situation.
20
21   Arguments
22       shelf  This should be the shelf address (major AoE address) of the  AoE
23              device to communicate with.
24
25       slot   This  should  be the slot address (minor AoE address) of the AoE
26              device to communicate with.
27
28       netif  The name of the ethernet network interface to use for AoE commu‐
29              nications, e.g., eth1.
30
31   Options
32       -i     Issue  an  ATA "identify device" command after receiving the AoE
33              device's Config Query response.  The "ident"  response  will  be
34              printed on standard output as a hexidecimal dump.
35
36       -v     Turn on more copious output, including a hexidecimal dump of the
37              Config Query response from the AoE device (see AoE spec  at  URL
38              below).
39
40       -s     This  option takes an argument.  The argument is a decimal inte‐
41              ger that specifies the number of seconds that aoeping will  wait
42              for  a  response  before  timing out and exiting with a non-zero
43              status.
44
45       -S     This option takes an argument.  The argument is the  name  of  a
46              SMART  command  to  send to the disk.  The SMART commands in the
47              list below are supported.  If the command requires  data  trans‐
48              fer,  one sector (512 bytes) of data is always the amount trans‐
49              fered.  If the command takes a parameter (for the Low LBA regis‐
50              ter), then the name of the SMART command is immediately followed
51              by a colon and then a number, the value of the parameter,  e.g.,
52              "-S read_log:1".
53
54                read_data
55                offline_immediate
56                read_log
57                write_log
58                enable
59                disable
60                return_status
61
62              For  write_log, aoeping reads from standard input the one sector
63              of data to be written to the specified log.
64
65              The aoeping command just  sends  and  receives  SMART  commands,
66              without  interpreting  them.  See the ATA specification for more
67              information on using SMART.
68
69       -t     (This is an advanced feature.)  This  option  has  an  argument.
70              The  argument  is  a decimal integer that is used as the initial
71              tag, with the highest bit set, as the first tag in ATA commands.
72              Tags for subsequent ATA commands will be incremented by one.
73
74       -h     Show a usage summary.
75

EXAMPLE

77       In  this  example, the root user uses aoeping to check for the presence
78       of aoe device e10.9 on network interface eth0.
79
80              bash# aoeping -v 10 9 eth0 | head
81              tag: 80000000
82              eth: eth0
83              shelf: 10
84              slot: 9
85              config query response:
86              00 0d 87 aa c9 00 00 10 04 00 11 1f 88 a2 18 00
87              00 0a 09 01 00 00 00 00 00 03 30 08 00 10 00 04
88              66 6f 6f 0a 00 ff ff ff ff ff ff ff ff ff ff ff
89              ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff
90              ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff
91
92       The next example shows root making sure the disk on the e10.9 is  still
93       responsive  by  issuing an ATA device identify command with a 20-second
94       timeout.
95
96              bash# aoeping -i -s 20 \
97                10 9 eth0 > /dev/null \
98                && echo ok
99              ok
100
101       The next example uses SMART to determine  whether  the  disk  on  e10.9
102       thinks it has exceeded its error threshold.  The ATA spec says that the
103       LBA Mid register will be 0x4f when the disk has not exceeded its  error
104       threshold.
105
106              bash# aoeping -S return_status \
107                10 9 eth0 | grep 'LBA Mid: 0x4f' \
108                > /dev/null \
109                && echo ok
110              ok
111
112       Note  that  in  a  script,  it would be prudent to specify and handle a
113       timeout.  Also, a good script would make sure the Status register  does
114       not have the error bit (bit zero) or the device fault bit (bit 5) set.
115

SEE ALSO

117       aoe-discover(8), aoe-interfaces(8), aoe-mkdevs(8), aoe-mkshelf(8), aoe-
118       stat(8),
119
120       AoE (ATA over Ethernet): http://www.coraid.com/documents/AoEr8.txt,
121
122       ATA specification
123

AUTHOR

125       Ed L. Cashin (ecashin@coraid.com)
126
127
128
129                                                                    aoeping(8)
Impressum