229 lines
4.3 KiB
HTML
229 lines
4.3 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of RDMA</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>RDMA</H1>
|
|
Section: Linux (8)<BR>Updated: 28 Mar 2017<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
rdma - RDMA tool
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<P>
|
|
|
|
|
|
<BR>
|
|
|
|
<B>rdma</B>
|
|
|
|
[ <I>OPTIONS</I> ] <I>OBJECT</I> { <I>COMMAND</I> |
|
|
|
|
<B>help</B> }
|
|
|
|
<P>
|
|
<P>
|
|
<BR>
|
|
|
|
<B>rdma</B>
|
|
|
|
[ <B>-force</B> ]
|
|
|
|
<B>-batch </B><I>filename</I>
|
|
|
|
<P>
|
|
<P>
|
|
<BR>
|
|
|
|
<I>OBJECT</I> := {
|
|
|
|
<B>dev</B> | <B>link</B> | <B>system</B> | <B>statistic</B> }
|
|
|
|
<P>
|
|
<P>
|
|
<BR>
|
|
|
|
<I>OPTIONS</I> := {
|
|
|
|
<B>-V</B>[<I>ersion</I>] |
|
|
<B>-d</B>[<I>etails</I>] }
|
|
<B>-j</B>[<I>son</I>] }
|
|
<B>-p</B>[<I>retty</I>] }
|
|
<P>
|
|
<A NAME="lbAD"> </A>
|
|
<H2>OPTIONS</H2>
|
|
|
|
<P>
|
|
<DL COMPACT>
|
|
<DT id="1"><B>-V</B>,<B> -Version</B>
|
|
|
|
<DD>
|
|
Print the version of the
|
|
<B>rdma</B>
|
|
|
|
tool and exit.
|
|
<P>
|
|
<DT id="2"><B>-b,</B> -batch <B><FILENAME></B>
|
|
|
|
<DD>
|
|
Read commands from provided file or standard input and invoke them.
|
|
First failure will cause termination of rdma.
|
|
<P>
|
|
<DT id="3"><B>-force</B>
|
|
|
|
<DD>
|
|
Don't terminate rdma on errors in batch mode.
|
|
If there were any errors during execution of the commands, the application return code will be non zero.
|
|
<P>
|
|
<DT id="4"><B>-d</B>,<B> --details</B>
|
|
|
|
<DD>
|
|
Output detailed information. Adding a second -d includes driver-specific details.
|
|
<P>
|
|
<DT id="5"><B>-p</B>,<B> --pretty</B>
|
|
|
|
<DD>
|
|
When combined with -j generate a pretty JSON output.
|
|
<P>
|
|
<DT id="6"><B>-j</B>,<B> --json</B>
|
|
|
|
<DD>
|
|
Generate JSON output.
|
|
<P>
|
|
</DL>
|
|
<A NAME="lbAE"> </A>
|
|
<H3><I>OBJECT</I>
|
|
|
|
</H3>
|
|
|
|
<P>
|
|
<DL COMPACT>
|
|
<DT id="7"><B>dev</B>
|
|
|
|
<DD>
|
|
- RDMA device.
|
|
<P>
|
|
<DT id="8"><B>link</B>
|
|
|
|
<DD>
|
|
- RDMA port related.
|
|
<P>
|
|
<DT id="9"><B>sys</B>
|
|
|
|
<DD>
|
|
- RDMA subsystem related.
|
|
<P>
|
|
<DT id="10"><B>statistic</B>
|
|
|
|
<DD>
|
|
- RDMA counter statistic related.
|
|
<P>
|
|
</DL>
|
|
<P>
|
|
|
|
The names of all objects may be written in full or
|
|
abbreviated form, for example
|
|
<B>stats</B>
|
|
|
|
can be abbreviated as
|
|
<B>stat</B>
|
|
|
|
or just
|
|
<B>s.</B>
|
|
|
|
<P>
|
|
<A NAME="lbAF"> </A>
|
|
<H3><I>COMMAND</I>
|
|
|
|
</H3>
|
|
|
|
<P>
|
|
Specifies the action to perform on the object.
|
|
The set of possible actions depends on the object type.
|
|
As a rule, it is possible to
|
|
<B>show</B>
|
|
|
|
(or
|
|
<B>list</B>
|
|
|
|
) objects, but some objects do not allow all of these operations
|
|
or have some additional commands. The
|
|
<B>help</B>
|
|
|
|
command is available for all objects. It prints
|
|
out a list of available commands and argument syntax conventions.
|
|
<P>
|
|
If no command is given, some default command is assumed.
|
|
Usually it is
|
|
<B>list</B>
|
|
|
|
or, if the objects of this class cannot be listed,
|
|
<B>help</B>.
|
|
|
|
<P>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>EXIT STATUS</H2>
|
|
|
|
Exit status is 0 if command was successful or a positive integer upon failure.
|
|
<P>
|
|
<A NAME="lbAH"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?8+rdma-dev">rdma-dev</A></B>(8),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?8+rdma-link">rdma-link</A></B>(8),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?8+rdma-resource">rdma-resource</A></B>(8),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?8+rdma-system">rdma-system</A></B>(8),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?8+rdma-statistic">rdma-statistic</A></B>(8),
|
|
|
|
<BR>
|
|
|
|
<P>
|
|
<A NAME="lbAI"> </A>
|
|
<H2>REPORTING BUGS</H2>
|
|
|
|
Report any bugs to the Linux RDMA mailing list
|
|
<B><<A HREF="mailto:linux-rdma@vger.kernel.org">linux-rdma@vger.kernel.org</A>></B>
|
|
|
|
where the development and maintenance is primarily done.
|
|
You do not have to be subscribed to the list to send a message there.
|
|
<P>
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>AUTHOR</H2>
|
|
|
|
Leon Romanovsky <<A HREF="mailto:leonro@mellanox.com">leonro@mellanox.com</A>>
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="11"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="12"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="13"><A HREF="#lbAD">OPTIONS</A><DD>
|
|
<DL>
|
|
<DT id="14"><A HREF="#lbAE"><I>OBJECT</I>
|
|
|
|
</A><DD>
|
|
<DT id="15"><A HREF="#lbAF"><I>COMMAND</I>
|
|
|
|
</A><DD>
|
|
</DL>
|
|
<DT id="16"><A HREF="#lbAG">EXIT STATUS</A><DD>
|
|
<DT id="17"><A HREF="#lbAH">SEE ALSO</A><DD>
|
|
<DT id="18"><A HREF="#lbAI">REPORTING BUGS</A><DD>
|
|
<DT id="19"><A HREF="#lbAJ">AUTHOR</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:06:15 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|