coqos_mod(1)

💖 coqos_mod(1) — Qualcomm Atheros Open Powerline Toolkit 💖

okay bestie, sit down, hydrate, because we're talking about coqos_mod — the little icon that suspends or resumes a managed data stream. it lives in the Qualcomm Atheros Open Powerline Toolkit, so you already know it's giving ✨niche networking excellence✨.

---

🌸 NAME 🌸

coqos_mod — suspend or resume a managed data stream. that's it, that's the whole job. she does one thing and she eats 💅

---

🎀 SYNOPSIS 🎀

coqos_mod [options] action cid [device] [...]

---

✨ DESCRIPTION ✨

so. this page is under construction 🚧 — yes, fr fr, the original literally says that, we're not hiding it.

here's the tea: coqos_mod suspends or resumes a stream through the bandwidth manager using an Atheros vendor specific VS_MOD_CONN message. this is the proper way to stop a stream flowing if the data rate exceeds the available bandwidth. like, if your stream is being a lil bandwidth gremlin, this is the move 🫶

and if you wanna actually set stream bandwidth, go bother coqos_man for that, okay?

this program is part of the Qualcomm Atheros Powerline Toolkit. see the plc man page for an overview and installation instructions — it's the mothership, iykyk.

---

🌈 OPTIONS 🌈

• -e — redirects stderr messages to stdout. by convention, status and error messages get printed on stderr while the primary program output goes to stdout. this option prints all output on stdout, for the cases where that's what you want. one stream to rule them all ✨
• -i interface — select the host Ethernet interface. all requests are sent via this host interface, and only responses received via this host interface are recognized. the default interface is eth1, because most people use eth0 as their principle network connection. however — if environment string PLC is defined, then it takes precedence over the default interface. and this option takes precedence over either default. it's a whole hierarchy, bestie, respect the chain of command 👑
• -q — suppresses status messages on stderr. quiet queen energy 🤫
• -r — display relative memory offsets on output. this option is the default. so like, you're already doing it 💅
• -v — prints additional information on stdout. in particular, this option dumps outgoing Ethernet packets on stdout. nosy in the best way 🔍
• -?, --help — displays program help information on stderr. this option takes precedence over all other options on the command line except version information.
• -!, --version — displays program version information on stderr. this option takes precedence over all other options on the command line except help information. use this option when sending screen dumps to Atheros technical staff. like, they asked for it, so give them the receipts 📸

---

🦋 ARGUMENTS 🦋

• action — a symbol indicating the action to be performed on the stream identified by argument cid. valid actions are "suspend" and "resume". see ACTIONS for an explanation of each action.
• cid — a connection identifier. (Charlie, expand on this.) Connection ID. 2 byte number to identify the stream to delete. Byte 0 is the OrigTEI and byte one is the LLID-F. yes, the "(Charlie, expand on this.)" is really in there, we're keeping the lore intact 🙈
• device — the MAC 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". see DEVICES for more information.

---

💜 ACTIONS 💜

• suspend — suspend the identified stream. see argument cid for more information.
• resume — resume the identified stream. see argument cid for more information.

---

🌟 DEVICES 🌟

Ethernet MAC addresses are expressed as six hexadecimal octets, optionally separated by colon. for example, the Qualcomm Atheros Local Management Address (LMA) of "00b052000001" may also be entered as "00:b0:52:00:00:01" or "00b052:000001". addresses are case insensitive and quotes are optional. plus, some special addresses may be entered by name rather than number — and those names are case sensitive, so don't get cute with the capitalization 🎀

• all — a synonym for the "broadcast" address, described next.
• broadcast — a synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. all devices, whether local, remote or foreign, will respond to this address. everybody gets the message, no exclusions 📢
• local — a synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. all local Atheros devices recognize this address, but remote and foreign devices do 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.

---

🌸 DEVICES 🌸

(yes, this section shows up twice in the original — and we keep it twice, because every detail stays. consider it a remix 💅)

Ethernet MAC addresses are six hexadecimal octets, optionally separated by colon. for example, the addresses "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are all valid and equivalent. certain Ethernet device addresses are special and may be entered by name rather than number.

• all — a synonym for "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.
• local — a synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. all local Atheros devices recognize this address, but remote and foreign devices do 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.

---

📚 REFERENCES 📚

see the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information. yes, actual reading, bestie, go get it 📖

---

💀 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 and content in future firmware releases without any obligation to notify or compensate users of this program.

okay so that last part is genuinely important — they can change stuff under you and don't owe you a text back. not me being dramatic, that's literally what it says 😭

---

🍓 EXAMPLES 🍓

the following example suspends a stream 805. all data in this cid will be discarded and not sent over the channel.

# coqos_mod SPND 805 00:B0:52:BA:BE:01

(and yes, SPND — that's exactly how it's written up there. copy it character for character, don't get creative 🌈)

---

👑 SEE ALSO 👑

coqos_add(1), coqos_info(1), coqos_man(1), coqos_rel(1)

the whole friend group, go say hi 🫶

---

🧚 CREDITS 🧚

• Bill Wike
• Nathaniel Houghton
• Charles Maier

icons, every single one 💜

---

okay that's the whole page, you ate it, you understood it, you're a powerline networking main character now. this was open-plc-utils-0.0.3, dated November 2013 — so go forth, suspend some streams, resume some streams, and remember: the vibe changes, the facts never do. periodt 💅✨🦋