NAME

ggaoectl - command-line interface for ggaoed

SYNOPSIS

ggaoectl
[-c file | --config file] reload

ggaoectl
[-c file | --config file] monitor [interval] [name]…

ggaoectl
[-c file | --config file] stats [name]…

ggaoectl
[-c file | --config file] show-config [name]…

ggaoectl
[-c file | --config file] show-macmask [name]…

ggaoectl
[-c file | --config file] show-reserve [name]…

ggaoectl
[-c file | --config file] clear-stats [name]…

ggaoectl
[-c file | --config file] clear-config name …

ggaoectl
[-c file | --config file] clear-macmask name …

ggaoectl
[-c file | --config file] clear-reserve name …

ggaoectl
{-h | --help}

ggaoectl
{-V | --version}

DESCRIPTION

ggaoectl is an AoE target. It allows exporting files and block devices over the network using the ATA over Ethernet protocol.

OPTIONS

-c file--config file

Use the specified config file instead of /etc/ggaoed.conf. The location of the daemon's control socket is read from this config file.

-h--help

Show a short help text.

-V--version

Print the version number and exit.

COMMANDS

reload

Tell ggaoed to reload its configuration file. This is the same as sending a SIGHUP signal to ggaoed.

monitor interval name

Monitor the performance of devices and/or network interfaces. If no name parameters are given, all devices and interfaces are monitored; otherwise only the named ones are monitored. If the firt argument is a number, it is interpreted as the time in seconds to wait between measurements.

See below the section about the description of the output.

stats name

Dump the detailed statistics for the specified devices and/or network interfaces. If no name parameters are given, all devices and interfaces are dumped.

See below the section about the description of the output.

show-config name

Dump the AoE configuration info for the specified devices. The AoE configuration info is an arbitrary block of data with a maximum length of 1024. AoE initiators can manipulate and query this data according their needs. This command dumps the current value in both hexadecimal and string format.

show-macmask name

Dump the AoE MAC Mask list for the specified devices. The AoE MAC Mask list is the dynamic equivalent of ggaoed's ACLs. This command shows the MAC addresses currently on the list.

show-reserve name

Dump the AoE Reserve/Release list for the specified devices. The AoE Reserve/Release list can be used by Windows clients to provide cluster fencing support. This command shows the MAC addresses that are on the reserve list.

clear-stats name

Clear the device/interface statistics by setting all the counters to zero.

clear-config name

Clear the AoE configuration space of the specified device(s).

clear-macmask name

Clear the AoE MAC Mask list of the specified device(s).

clear-reserve name

Clear the AoE Reserve list of the specified device(s).

For all the commands mentioned above, name can also contain glob-like metacharacters; if so, make sure to properly escape them from the shell.

MONITOR OUTPUT

The monitor command prints the following output fields for disks:

rrqm/s

Number of read requests per second.

rkB/s

Kilobytes read per second.

wrqm/s

Number of write requests per second.

wkB/s

Kilobytes written per second.

oth

Number of other (not read/write) requests.

avgqsz

Average queue length (number of I/O requests being processed).

qs

Number of queue stalls when the kernel refused to accept more I/O requests.

qf

Number of times the queue was full.

ae

Number of read/write errors.

pe

Number of AoE protocol errors.

svctm

Average request servicing time in milliseconds.

For network interfaces, the following fields are printed:

rrqm/s

Number of read requests per second.

rkB/s

Kilobytes read per second.

wrqm/s

Number of write requests per second.

wkB/s

Kilobytes written per second.

drp

Number of packets dropped by the network stack.

avrun

Average number of packets processed in a batch.

STATISTICS

The stats command prints the following output fields for disks:

read_cnt

Number of read requests.

read_bytes

Total number of bytes read.

read_time

Sum of the servicing time for read requests. Divide by read_cnt to get the average time needed to service a read request.

write_cnt

Number of write requests.

write_bytes

Total number of bytes written.

write_time

Sum of the servicing time for write requests. Divide by write_cnt to get the average time needed to service a write request.

other_cnt

Number of all requests except ATA read/write ones.

other_time

Sum of the servicing time for request times except ATA read/write.

io_slots

Number of I/O slots submitted so far. Dividing the sum of read_cnt and write_cnt by io_slots gives the average number of incoming requests merged into a single I/O request.

io_runs

Number of times any I/O have been submitted.

queue_length

Sum of the queue length at the time a new request was accepted. Divide by the sum of read_cnt, write_cnt and other_cnt to get the average queue length.

queue_stall

Number of queue stalls when the kernel refused to submit more I/O for the device.

queue_over

Number of times the length of the queue was over the configured limit. This can happen if the initiator (client) retransmits requests before ggaoed could process them.

ata_err

Number of read/write errors.

proto_err

Number of AoE protocol errors.

The following information is available for network interfaces:

rx_cnt

Number of packets received.

rx_bytes

Total number of bytes received.

rx_runs

Number of times one or more packets were received in a batch.

tx_cnt

Number of packets sent.

tx_bytes

Total number of bytes sent.

tx_runs

Number of times one or more packets were sent out in a batch.

rx_buffers_full

Number of times the receiving ring buffer was full. If it happens frequently the ring buffer is likely too small.

tx_buffers_full

Number of times the sending ring buffer was full and the request had to be deferred.

dropped

Number of packets dropped by the networking stack.

ignored

Number of packets ignored because either they were not valid AoE requests or were not addressed to us.

broadcast

Number of broadcast requests processed.

FILES

/etc/ggaoed.conf

SEE ALSO

AoEr11 (ATA over Ethernet, revision 11), ggaoed(8), ggaoed.conf(5)

AUTHOR

Gábor Gombás <gombasg@digikabel.hu>