mirror of
https://git.proxmox.com/git/mirror_iproute2
synced 2025-10-05 17:15:45 +00:00
486fe5f03c
Implement an option (-b) to execute RDMAtool commands from supplied file. This follows the same model as in use for ip and devlink tools, by expecting every new command to be on new line. These commands are expected to be without any -* (e.g. -d, -j, e.t.c) global flags, which should be called externally. Signed-off-by: Leon Romanovsky <leonro@mellanox.com> Signed-off-by: David Ahern <dsahern@gmail.com>
119 lines
2.2 KiB
Groff
119 lines
2.2 KiB
Groff
.TH RDMA 8 "28 Mar 2017" "iproute2" "Linux"
|
|
.SH NAME
|
|
rdma \- RDMA tool
|
|
.SH SYNOPSIS
|
|
.sp
|
|
.ad l
|
|
.in +8
|
|
.ti -8
|
|
.B rdma
|
|
.RI "[ " OPTIONS " ] " OBJECT " { " COMMAND " | "
|
|
.BR help " }"
|
|
.sp
|
|
|
|
.ti -8
|
|
.B rdma
|
|
.RB "[ " -force " ] "
|
|
.BI "-batch " filename
|
|
.sp
|
|
|
|
.ti -8
|
|
.IR OBJECT " := { "
|
|
.BR dev " | " link " }"
|
|
.sp
|
|
|
|
.ti -8
|
|
.IR OPTIONS " := { "
|
|
\fB\-V\fR[\fIersion\fR] |
|
|
\fB\-d\fR[\fIetails\fR] }
|
|
\fB\-j\fR[\fIson\fR] }
|
|
\fB\-p\fR[\fIretty\fR] }
|
|
|
|
.SH OPTIONS
|
|
|
|
.TP
|
|
.BR "\-V" , " -Version"
|
|
Print the version of the
|
|
.B rdma
|
|
tool and exit.
|
|
|
|
.TP
|
|
.BR "\-b", " \-batch " <FILENAME>
|
|
Read commands from provided file or standard input and invoke them.
|
|
First failure will cause termination of rdma.
|
|
|
|
.TP
|
|
.BR "\-force"
|
|
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.
|
|
|
|
.TP
|
|
.BR "\-d" , " --details"
|
|
Otuput detailed information.
|
|
|
|
.TP
|
|
.BR "\-p" , " --pretty"
|
|
When combined with -j generate a pretty JSON output.
|
|
|
|
.TP
|
|
.BR "\-j" , " --json"
|
|
Generate JSON output.
|
|
|
|
.SS
|
|
.I OBJECT
|
|
|
|
.TP
|
|
.B dev
|
|
- RDMA device.
|
|
|
|
.TP
|
|
.B link
|
|
- RDMA port related.
|
|
|
|
.PP
|
|
The names of all objects may be written in full or
|
|
abbreviated form, for example
|
|
.B stats
|
|
can be abbreviated as
|
|
.B stat
|
|
or just
|
|
.B s.
|
|
|
|
.SS
|
|
.I COMMAND
|
|
|
|
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
|
|
(or
|
|
.B list
|
|
) objects, but some objects do not allow all of these operations
|
|
or have some additional commands. The
|
|
.B help
|
|
command is available for all objects. It prints
|
|
out a list of available commands and argument syntax conventions.
|
|
.sp
|
|
If no command is given, some default command is assumed.
|
|
Usually it is
|
|
.B list
|
|
or, if the objects of this class cannot be listed,
|
|
.BR "help" .
|
|
|
|
.SH EXIT STATUS
|
|
Exit status is 0 if command was successful or a positive integer upon failure.
|
|
|
|
.SH SEE ALSO
|
|
.BR rdma-dev (8),
|
|
.BR rdma-link (8),
|
|
.br
|
|
|
|
.SH REPORTING BUGS
|
|
Report any bugs to the Linux RDMA mailing list
|
|
.B <linux-rdma@vger.kernel.org>
|
|
where the development and maintenance is primarily done.
|
|
You do not have to be subscribed to the list to send a message there.
|
|
|
|
.SH AUTHOR
|
|
Leon Romanovsky <leonro@mellanox.com>
|