RDMA-SYSTEM(8)

๐Ÿ’– RDMA-SYSTEM(8) โ€” the rdma-system girlies' guide ๐Ÿ’–

okay so bestie, welcome to the RDMA-SYSTEM(8) manual page, she's a Linux one, and she's literally all about RDMA subsystem configuration ๐Ÿ‘‘ no cap.


โœจ NAME โœจ

rdma-system โ€” RDMA subsystem configuration. that's it, that's the whole vibe ๐Ÿฆ‹


๐ŸŒธ SYNOPSIS ๐ŸŒธ

rdma [ OPTIONS ] sys  { COMMAND | help }

OPTIONS := { -V[ersion] | -d[etails] }

rdma system show

rdma system set netns NEWMODE

rdma system set privileged-qkey NEWSTATE

rdma system help

๐ŸŽ€ DESCRIPTION ๐ŸŽ€

๐Ÿ’… rdma system set โ€” set RDMA subsystem network namespace mode or privileged qkey mode

๐ŸŒˆ rdma system show โ€” display RDMA subsystem network namespace mode, privileged qkey state and whether RDMA monitoring is supported

okay so now the details, because this is the part where you actually need to pay attention, bestie ๐Ÿซถ

NEWMODE โ€” this one specifies the RDMA subsystem mode. it's either exclusive or shared. when a user wants to assign a dedicated RDMA device to a particular network namespace, exclusive mode should be set before creating any network namespace. and here's the tea โ˜•: if there are active network namespaces and if one or more RDMA devices exist, changing mode from shared to exclusive returns error code EBUSY. so yeah, that's gonna fail on you, plan accordingly ๐Ÿ˜ญ

when the RDMA subsystem is in shared mode, the RDMA device is accessible in all network namespaces. so when you don't need RDMA device isolation among multiple network namespaces, shared mode can be used. it's giving "we all share, we're all besties" energy โœจ

it is preferred to not change the subsystem mode when there is active RDMA traffic running, even though it is supported. like, you can, but... girl. don't. ๐Ÿ™ˆ

NEWSTATE โ€” specifies the new state of the privileged-qkey parameter, either on or off. this parameter determines whether a non-privileged user is allowed to specify a controlled QKEY or not. periodt. ๐Ÿ’…


๐Ÿ”ฅ EXAMPLES ๐Ÿ”ฅ

  • rdma system show shows the state of RDMA subsystem network namespace mode on the system, the state of the privileged qkey parameter and whether RDMA monitor is supported. the whole status check, one command, iconic โญ
  • rdma system set netns exclusive sets the RDMA subsystem in network namespace exclusive mode. in this mode RDMA devices are visible only in single network namespace. it's giving main character only, no sharing ๐Ÿ‘‘
  • rdma system set netns shared sets the RDMA subsystem in network namespace shared mode. in this mode RDMA devices are shared among network namespaces. communal slay ๐Ÿ’–
  • rdma system set privileged-qkey on sets the privileged-qkey parameter to on. in this state non-privileged user is allowed to specify a controlled QKEY ๐ŸŽ‰
  • rdma system set privileged-qkey off sets the privileged-qkey parameter to off. in this state non-privileged user is not allowed to specify a controlled QKEY. sorry babe, locked down ๐Ÿ”’

๐Ÿ’œ SEE ALSO ๐Ÿ’œ

rdma(8), rdma-link(8), rdma-resource(8), rdma-monitor(8), network_namespaces(7), namespaces(7), โ€” go read those next, bestie, they're all part of the same little friend group ๐Ÿงš


๐Ÿ‘‘ AUTHOR ๐Ÿ‘‘

Parav Pandit <parav@mellanox.com> โ€” thank you for your service, king ๐Ÿซก


and that's the whole page, bestie!! this one came from iproute2, dated 06 Jul 2017, and it lives in the RDMA-SYSTEM(8) section of the manual. go forth and configure those RDMA subsystems responsibly, mwah ๐Ÿ’‹๐ŸŒธ

๐Ÿ“ฆ where this page comes from