| 1 |
.TH RDMA 8 "28 Mar 2017" "iproute2" "Linux" |
| 2 |
.SH NAME |
| 3 |
rdma \- RDMA tool |
| 4 |
.SH SYNOPSIS |
| 5 |
.sp |
| 6 |
.ad l |
| 7 |
.in +8 |
| 8 |
.ti -8 |
| 9 |
.B rdma |
| 10 |
.RI "[ " OPTIONS " ] " OBJECT " { " COMMAND " | " |
| 11 |
.BR help " }" |
| 12 |
.sp |
| 13 |
|
| 14 |
.ti -8 |
| 15 |
.B rdma |
| 16 |
.RB "[ " -force " ] " |
| 17 |
.BI "-batch " filename |
| 18 |
.sp |
| 19 |
|
| 20 |
.ti -8 |
| 21 |
.IR OBJECT " := { " |
| 22 |
.BR dev " | " link " | " resource " | " system " | " statistic " | " monitor " }" |
| 23 |
.sp |
| 24 |
|
| 25 |
.ti -8 |
| 26 |
.IR OPTIONS " := { " |
| 27 |
\fB\-V\fR[\fIersion\fR] | |
| 28 |
\fB\-d\fR[\fIetails\fR] | |
| 29 |
\fB\-j\fR[\fIson\fR] | |
| 30 |
\fB\-o\fR[\fIneline\fR] | |
| 31 |
\fB\-p\fR[\fIretty\fR] } |
| 32 |
|
| 33 |
.SH OPTIONS |
| 34 |
|
| 35 |
.TP |
| 36 |
.BR "\-V" , " -Version" |
| 37 |
Print the version of the |
| 38 |
.B rdma |
| 39 |
tool and exit. |
| 40 |
|
| 41 |
.TP |
| 42 |
.BR "\-b", " \-batch " <FILENAME> |
| 43 |
Read commands from provided file or standard input and invoke them. |
| 44 |
First failure will cause termination of rdma. |
| 45 |
|
| 46 |
.TP |
| 47 |
.BR "\-force" |
| 48 |
Don't terminate rdma on errors in batch mode. |
| 49 |
If there were any errors during execution of the commands, the application return code will be non-zero. |
| 50 |
|
| 51 |
.TP |
| 52 |
.BR "\-d" , " --details" |
| 53 |
Output detailed information. Adding a second \-d includes driver-specific details. |
| 54 |
|
| 55 |
.TP |
| 56 |
.BR "\-r" , " --raw" |
| 57 |
Output includes driver-specific details in raw format. |
| 58 |
|
| 59 |
.TP |
| 60 |
.BR "\-p" , " --pretty" |
| 61 |
When combined with -j generate pretty JSON output. |
| 62 |
|
| 63 |
.TP |
| 64 |
.BR "\-j" , " --json" |
| 65 |
Generate JSON output. |
| 66 |
|
| 67 |
.TP |
| 68 |
.BR "\-o" , " \-oneline" |
| 69 |
Output each record on a single line, replacing line feeds |
| 70 |
with the |
| 71 |
.B '\e' |
| 72 |
character. |
| 73 |
|
| 74 |
.SS |
| 75 |
.I OBJECT |
| 76 |
|
| 77 |
.TP |
| 78 |
.B dev |
| 79 |
- RDMA device. |
| 80 |
|
| 81 |
.TP |
| 82 |
.B link |
| 83 |
- RDMA port related. |
| 84 |
|
| 85 |
.TP |
| 86 |
.B resource |
| 87 |
- RDMA resource configuration. |
| 88 |
|
| 89 |
.TP |
| 90 |
.B sys |
| 91 |
- RDMA subsystem related. |
| 92 |
|
| 93 |
.TP |
| 94 |
.B statistic |
| 95 |
- RDMA counter statistic related. |
| 96 |
|
| 97 |
.TP |
| 98 |
.B monitor |
| 99 |
- RDMA events monitor. |
| 100 |
|
| 101 |
.PP |
| 102 |
The names of all objects may be written in full or |
| 103 |
abbreviated form, for example |
| 104 |
.B stats |
| 105 |
can be abbreviated as |
| 106 |
.B stat |
| 107 |
or just |
| 108 |
.B s. |
| 109 |
|
| 110 |
.SS |
| 111 |
.I COMMAND |
| 112 |
|
| 113 |
Specifies the action to perform on the object. |
| 114 |
The set of possible actions depends on the object type. |
| 115 |
As a rule, it is possible to |
| 116 |
.B show |
| 117 |
(or |
| 118 |
.B list |
| 119 |
) objects, but some objects do not allow all of these operations |
| 120 |
or have some additional commands. The |
| 121 |
.B help |
| 122 |
command is available for all objects. It prints |
| 123 |
out a list of available commands and argument syntax conventions. |
| 124 |
.sp |
| 125 |
If no command is given, some default command is assumed. |
| 126 |
Usually it is |
| 127 |
.B list |
| 128 |
or, if the objects of this class cannot be listed, |
| 129 |
.BR "help" . |
| 130 |
|
| 131 |
.SH EXIT STATUS |
| 132 |
Exit status is 0 if command was successful or a positive integer upon failure. |
| 133 |
|
| 134 |
.SH SEE ALSO |
| 135 |
.BR rdma-dev (8), |
| 136 |
.BR rdma-link (8), |
| 137 |
.BR rdma-resource (8), |
| 138 |
.BR rdma-system (8), |
| 139 |
.BR rdma-statistic (8), |
| 140 |
.BR rdma-monitor (8), |
| 141 |
.br |
| 142 |
|
| 143 |
.SH REPORTING BUGS |
| 144 |
Report any bugs to the Linux RDMA mailing list |
| 145 |
.B <[email protected]> |
| 146 |
where the development and maintenance is primarily done. |
| 147 |
You do not have to be subscribed to the list to send a message there. |
| 148 |
|
| 149 |
.SH AUTHOR |
| 150 |
Leon Romanovsky <[email protected]> |