RDMA(8)

📦
version 7.3.0 · 4 versions
, in alpine 3.24, arch rolling, centos-stream 10, nixos 26.05, nixpkgs unstable, ubuntu stonking

💖 RDMA(8) 💖

okay bestie, so this is the manual page for the rdma tool — the Linux RDMA tool, section 8 of the man pages. yes it's a whole vibe. let's get into it 🦋

✨ NAME ✨

rdma — the RDMA tool. that's it, that's the name, and it's iconic for it 💅

🌸 SYNOPSIS 🌸

the way you actually call this thing:

rdma [ OPTIONS ] OBJECT { COMMAND | help }

rdma [ -force ] -batch filename

OBJECT := { dev | link | resource | system | statistic | monitor }

OPTIONS := { -V[ersion] | -d[etails] | -j[son] | -o[neline] | -p[retty] }

like, you pick an OBJECT, you give it a COMMAND or just ask for help, and if you're being fancy with batch mode there's a whole separate shape for that. no cap ✨

💅 OPTIONS 💅

  • -V, -Version — prints out which version of the rdma tool you're running, then dips out immediately. short and sweet, we love a queen who knows when to leave 🫶
  • -b, -batch <FILENAME> — reads commands from the file you point at, or from standard input, and runs them all. heads up bestie: the first failure will terminate rdma. one strike and she's out 😭
  • -force — the "we don't stop, we keep going" flag. it stops rdma from terminating on errors while in batch mode. but lowkey there's a catch: if any errors happened during the commands, the application return code will be non-zero. so like, she finished the job but she's telling on you 💀
  • -d, --details — outputs detailed information. and here's the tea: adding a second -d includes driver-specific details. yes, -d -d. double the d, double the drama 👑
  • -r, --raw — output includes driver-specific details, but in raw format. no glow-up, no styling, just the unfiltered truth 🍓
  • -p, --pretty — when you combine this with -j, you get pretty JSON output. it's giving main character formatting energy ✨
  • -j, --json — generate JSON output. for when you want your data in the universally beloved curly-brace language 🌈
  • -o, -oneline — outputs each record on a single line, replacing line feeds with the '\' character. compact queen behavior 💜

OBJECT — pick your fighter 🎀

  • dev — RDMA device.
  • link — RDMA port related.
  • resource — RDMA resource configuration.
  • sys — RDMA subsystem related.
  • statistic — RDMA counter statistic related.
  • monitor — RDMA events monitor.

and the cute part: the names of all objects may be written in full or abbreviated form. for example stats can be abbreviated as stat or just s. bestie said "I don't have time for vowels" and honestly? valid 🙈

COMMAND — what are we doing today 💫

this is the action you want to perform on the object. the set of possible actions depends on the object type. as a rule, it's possible to show (or list) objects, but some objects do not allow all of these operations, or they have some additional commands. every single object has the help command available — it prints out a list of available commands and argument syntax conventions. so if you're lost, just ask for help, she'll never judge you 🫶

if no command is given, some default command is assumed. usually it's list or, if the objects of this class cannot be listed, help. the tool is literally holding your hand, we stan a supportive icon 😭

👑 EXIT STATUS 👑

exit status is 0 if the command was successful, or a positive integer upon failure. slay when it works, number when it doesn't. that's the whole system 💯

🌈 SEE ALSO 🌈

go read these too, they're all connected, it's a whole cinematic universe:

🐛 REPORTING BUGS 🐛

found a bug? report it to the Linux RDMA mailing list: linux-rdma@vger.kernel.org — that's where the development and maintenance is primarily done. and the best part: you do not have to be subscribed to the list to send a message there. no gatekeeping, we love to see it 🫶✨

💜 AUTHOR 💜

Leon Romanovsky <leonro@mellanox.com> — thank you for your service king 👑

and that's the whole page bestie!! this one ships as part of iproute2, dated 28 Mar 2017. it's giving vintage but the RDMA tool is still out here thriving. go forth and rdma responsibly 💅✨🦋

📦 where this page comes from