Blame man/man8/rdma.8

Packit Service 3880ab
.TH RDMA 8 "28 Mar 2017" "iproute2" "Linux"
Packit Service 3880ab
.SH NAME
Packit Service 3880ab
rdma \- RDMA tool
Packit Service 3880ab
.SH SYNOPSIS
Packit Service 3880ab
.sp
Packit Service 3880ab
.ad l
Packit Service 3880ab
.in +8
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.B rdma
Packit Service 3880ab
.RI "[ " OPTIONS " ] " OBJECT " { " COMMAND " | "
Packit Service 3880ab
.BR help " }"
Packit Service 3880ab
.sp
Packit Service 3880ab
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.B rdma
Packit Service 3880ab
.RB "[ " -force " ] "
Packit Service 3880ab
.BI "-batch " filename
Packit Service 3880ab
.sp
Packit Service 3880ab
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.IR OBJECT " := { "
Packit Service 3880ab
.BR dev " | " link " | " resource " | " system " | " statistic " }"
Packit Service 3880ab
.sp
Packit Service 3880ab
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.IR OPTIONS " := { "
Packit Service 3880ab
\fB\-V\fR[\fIersion\fR] |
Packit Service 3880ab
\fB\-d\fR[\fIetails\fR] }
Packit Service 3880ab
\fB\-j\fR[\fIson\fR] }
Packit Service 3880ab
\fB\-p\fR[\fIretty\fR] }
Packit Service 3880ab
Packit Service 3880ab
.SH OPTIONS
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.BR "\-V" , " -Version"
Packit Service 3880ab
Print the version of the
Packit Service 3880ab
.B rdma
Packit Service 3880ab
tool and exit.
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.BR "\-b", " \-batch " <FILENAME>
Packit Service 3880ab
Read commands from provided file or standard input and invoke them.
Packit Service 3880ab
First failure will cause termination of rdma.
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.BR "\-force"
Packit Service 3880ab
Don't terminate rdma on errors in batch mode.
Packit Service 3880ab
If there were any errors during execution of the commands, the application return code will be non zero.
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.BR "\-d" , " --details"
Packit Service 3880ab
Output detailed information.  Adding a second \-d includes driver-specific details.
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.BR "\-r" , " --raw"
Packit Service 3880ab
Output includes driver-specific details in raw format.
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.BR "\-p" , " --pretty"
Packit Service 3880ab
When combined with -j generate a pretty JSON output.
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.BR "\-j" , " --json"
Packit Service 3880ab
Generate JSON output.
Packit Service 3880ab
Packit Service 3880ab
.SS
Packit Service 3880ab
.I OBJECT
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.B dev
Packit Service 3880ab
- RDMA device.
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.B link
Packit Service 3880ab
- RDMA port related.
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.B resource
Packit Service 3880ab
- RDMA resource configuration.
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.B sys
Packit Service 3880ab
- RDMA subsystem related.
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.B statistic
Packit Service 3880ab
- RDMA counter statistic related.
Packit Service 3880ab
Packit Service 3880ab
.PP
Packit Service 3880ab
The names of all objects may be written in full or
Packit Service 3880ab
abbreviated form, for example
Packit Service 3880ab
.B stats
Packit Service 3880ab
can be abbreviated as
Packit Service 3880ab
.B stat
Packit Service 3880ab
or just
Packit Service 3880ab
.B s.
Packit Service 3880ab
Packit Service 3880ab
.SS
Packit Service 3880ab
.I COMMAND
Packit Service 3880ab
Packit Service 3880ab
Specifies the action to perform on the object.
Packit Service 3880ab
The set of possible actions depends on the object type.
Packit Service 3880ab
As a rule, it is possible to
Packit Service 3880ab
.B show
Packit Service 3880ab
(or
Packit Service 3880ab
.B list
Packit Service 3880ab
) objects, but some objects do not allow all of these operations
Packit Service 3880ab
or have some additional commands. The
Packit Service 3880ab
.B help
Packit Service 3880ab
command is available for all objects. It prints
Packit Service 3880ab
out a list of available commands and argument syntax conventions.
Packit Service 3880ab
.sp
Packit Service 3880ab
If no command is given, some default command is assumed.
Packit Service 3880ab
Usually it is
Packit Service 3880ab
.B list
Packit Service 3880ab
or, if the objects of this class cannot be listed,
Packit Service 3880ab
.BR "help" .
Packit Service 3880ab
Packit Service 3880ab
.SH EXIT STATUS
Packit Service 3880ab
Exit status is 0 if command was successful or a positive integer upon failure.
Packit Service 3880ab
Packit Service 3880ab
.SH SEE ALSO
Packit Service 3880ab
.BR rdma-dev (8),
Packit Service 3880ab
.BR rdma-link (8),
Packit Service 3880ab
.BR rdma-resource (8),
Packit Service 3880ab
.BR rdma-system (8),
Packit Service 3880ab
.BR rdma-statistic (8),
Packit Service 3880ab
.br
Packit Service 3880ab
Packit Service 3880ab
.SH REPORTING BUGS
Packit Service 3880ab
Report any bugs to the Linux RDMA mailing list
Packit Service 3880ab
.B <linux-rdma@vger.kernel.org>
Packit Service 3880ab
where the development and maintenance is primarily done.
Packit Service 3880ab
You do not have to be subscribed to the list to send a message there.
Packit Service 3880ab
Packit Service 3880ab
.SH AUTHOR
Packit Service 3880ab
Leon Romanovsky <leonro@mellanox.com>