mdustats(1)

💖 mdustats(1) — MDU traffic statistics 💖

okay bestie, listen up, because this one is literally in the Qualcomm Atheros Open Powerline Toolkit and it's giving "I collect powerline tea and report back" ✨

🌸 NAME 🌸

mdustats — MDU traffic statistics. yes that's the whole name. short, iconic, does exactly what it says on the tin 💅

🎀 SYNOPSIS 🎀

mdustats [options] [device] [device] [...]

✨ DESCRIPTION ✨

So basically this lil program collects and displays MDU traffic statistics using the Qualcomm Atheros vendor specific VS_MDU_TRAFFIC_STATS message. no cap, that's the whole gig 🦋

This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation instructions — like, go read that one first if you're new here, bestie 🫶

💅 OPTIONS 💅

• -c command — an integer that tells the program which kind of statistics to collect and report. Permitted values are 0 through 255 decimal, but ngl only 4 through 15 are valid at this time. This option is mandatory, because the default value of 0 is invalid — so yeah, you have to say something here, no skipping 👑
  • 4 — retrieve traffic statistics on the slave side
  • 5 — retrieve traffic statistics (master TX/RX) collected on the master side
  • 6 — retrieve traffic statistics (slave TX/RX) collected on the master side
  • 7 — retrieve traffic statistics (master/slave TX/RX) collected on the master side
  • 8 — clear traffic statistics on the slave side
  • 9 — clear traffic statistics (master TX/RX) collected on the master side
  • 10 — clear traffic statistics (slave TX/RX) collected on the master side
  • 11 — clear traffic statistics (master/slave TX/RX) collected on the master side
  • 12 — retrieve then clear traffic statistics collected on the slave side
  • 13 — retrieve then clear traffic statistics (master TX/RX) collected on the master side
  • 14 — retrieve then clear traffic statistics (slave TX/RX) collected on the master side
  • 15 — retrieve then clear traffic statistics (master/slave TX/RX) collected on the master side
• -s session — the session identifier used to associate request/confirm message pairs. valid identifiers are 0 through 255. the default is 0. it's basically the little name tag so the replies know who they belong to 🎀
• -t milliseconds — read timeout in milliseconds, bestie. values range from 0 through UINT_MAX. this is the maximum time allowed for a response. the default is shown in brackets on the program menu. so if your device is being slow, this is the patience setting ⏳
• -u unit — the slave unit number. this is the same as the slave Terminal Equipment Identifier, or TEI. valid unit numbers are 0 through 255. unit 0 is the default. heads up tho: this option is ignored when option -c specified any of the "slave side" commands 4, 8 or 12 🙈
• -v — print additional information on stdout. more yapping, more info, we love that for us 💬
• -x — cause the program to exit on the first error instead of continuing with remaining iterations, operations or devices. normally, the program reports errors and moves on to the next operation, iteration or device depending on the command line. so -x is the "no, we're stopping, this is serious" mode 💀
• -?,--help — print program help summary on stdout. this option takes precedence over other options on the command line. it's the "explain yourself" button 🫶
• -?,--version — print program version information on stdout. this option takes precedence over other options on the command line. use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of the Linux Toolkit you are using. fr fr, do it, they need the receipts 📸

🌈 ARGUMENTS 🌈

• device — the Ethernet hardware address of some powerline device. more than one address may be specified on the command line. if more than one address is specified then operations are performed on each device in turn. the default address is local, as explained in the DEVICES section. so like, you can queue up a whole group chat of devices and it'll handle them one by one 💖

🦋 DEVICES 🦋

Powerline devices use Ethernet hardware, or Media Access Control (MAC), addresses. Device addresses are expressed as 12 hexadecimal digits (0123456789ABCDEFabcdef) in upper, lower or mixed case. Individual octets may be separated by colons, for clarity, but not all octets need to be separated. For example, "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and equivalent. it's giving "same energy, different outfit" ✨

These symbolic addresses are recognized by this program and may be used instead of the actual address value:

• all — equivalent to "broadcast", described next.
• broadcast — a synonym for the standard Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign, will respond to this address. it's the "hey everybody" of addresses 📢
• local — a synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local Atheros devices will recognize this address but remote and foreign devices will not. A remote device is any device at the far end of a powerline connection. A foreign device is any device not manufactured by Atheros. so local is strictly for the home team 💜

👑 REFERENCES 👑

See the Qualcomm Atheros Powerline Firmware Technical Reference Manual for more information about MDU powerline configuration and the VS_MDU_TRAFFIC_STATS message type. it's the deep lore, iykyk 📚

💀 DISCLAIMER 💀

Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify message structure or content in future firmware releases without any obligation to notify or compensate users of this program.

bestie this one is real: it's proprietary, the public docs might not exist, and they can change the message structure in future firmware releases with zero obligation to tell you or compensate you. so don't build your whole personality on it 😭

⭐ EXAMPLES ⭐

The following example collects and displays MDU traffic statistics on the slave side of the local device because option -c is 4. The local device is implicit because no device is specified on the command line.

# mdustats -c 4

The next example collects and displays MDU traffic statistics for slave 2 on the master side of device 00:b0:52:9F:E0:14 because option -c is 5 and option -s is 2. The master device is explicit in this example.

# mdustats -c 5 -u 2 00b0529FE014

🌸 SEE ALSO 🌸

plc(1), int6kstat(1), sada(1) — go read the siblings, they're iconic too 🫶

🧚 CREDITS 🧚

Charles Maier — we stan 🎀

and that's the whole page, bestie!! this was mdustats(1) from the Qualcomm Atheros Open Powerline Toolkit, shipped as part of open-plc-utils-0.0.3, dated November 2013. yes, 2013, it's vintage, it's a classic, it still slays 💅✨