man/man8/rdma.8

   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 " }"
  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\-p\fR[\fIretty\fR] }
  31
  32 .SH OPTIONS
  33
  34 .TP
  35 .BR "\-V" , " -Version"
  36 Print the version of the
  37 .B rdma
  38 tool and exit.
  39
  40 .TP
  41 .BR "\-b", " \-batch " <FILENAME>
  42 Read commands from provided file or standard input and invoke them.
  43 First failure will cause termination of rdma.
  44
  45 .TP
  46 .BR "\-force"
  47 Don't terminate rdma on errors in batch mode.
  48 If there were any errors during execution of the commands, the application return code will be non zero.
  49
  50 .TP
  51 .BR "\-d" , " --details"
  52 Otuput detailed information.
  53
  54 .TP
  55 .BR "\-p" , " --pretty"
  56 When combined with -j generate a pretty JSON output.
  57
  58 .TP
  59 .BR "\-j" , " --json"
  60 Generate JSON output.
  61
  62 .SS
  63 .I OBJECT
  64
  65 .TP
  66 .B dev
  67 - RDMA device.
  68
  69 .TP
  70 .B link
  71 - RDMA port related.
  72
  73 .PP
  74 The names of all objects may be written in full or
  75 abbreviated form, for example
  76 .B stats
  77 can be abbreviated as
  78 .B stat
  79 or just
  80 .B s.
  81
  82 .SS
  83 .I COMMAND
  84
  85 Specifies the action to perform on the object.
  86 The set of possible actions depends on the object type.
  87 As a rule, it is possible to
  88 .B show
  89 (or
  90 .B list
  91 ) objects, but some objects do not allow all of these operations
  92 or have some additional commands. The
  93 .B help
  94 command is available for all objects. It prints
  95 out a list of available commands and argument syntax conventions.
  96 .sp
  97 If no command is given, some default command is assumed.
  98 Usually it is
  99 .B list
 100 or, if the objects of this class cannot be listed,
 101 .BR "help" .
 102
 103 .SH EXIT STATUS
 104 Exit status is 0 if command was successful or a positive integer upon failure.
 105
 106 .SH SEE ALSO
 107 .BR rdma-dev (8),
 108 .BR rdma-link (8),
 109 .br
 110
 111 .SH REPORTING BUGS
 112 Report any bugs to the Linux RDMA mailing list
 113 .B <linux-rdma@vger.kernel.org>
 114 where the development and maintenance is primarily done.
 115 You do not have to be subscribed to the list to send a message there.
 116
 117 .SH AUTHOR
 118 Leon Romanovsky <leonro@mellanox.com>