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 " | " resource " | " system " | " statistic " }"
  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 Output detailed information.  Adding a second \-d includes driver-specific details.
  53
  54 .TP
  55 .BR "\-r" , " --raw"
  56 Output includes driver-specific details in raw format.
  57
  58 .TP
  59 .BR "\-p" , " --pretty"
  60 When combined with -j generate a pretty JSON output.
  61
  62 .TP
  63 .BR "\-j" , " --json"
  64 Generate JSON output.
  65
  66 .SS
  67 .I OBJECT
  68
  69 .TP
  70 .B dev
  71 - RDMA device.
  72
  73 .TP
  74 .B link
  75 - RDMA port related.
  76
  77 .TP
  78 .B resource
  79 - RDMA resource configuration.
  80
  81 .TP
  82 .B sys
  83 - RDMA subsystem related.
  84
  85 .TP
  86 .B statistic
  87 - RDMA counter statistic related.
  88
  89 .PP
  90 The names of all objects may be written in full or
  91 abbreviated form, for example
  92 .B stats
  93 can be abbreviated as
  94 .B stat
  95 or just
  96 .B s.
  97
  98 .SS
  99 .I COMMAND
 100
 101 Specifies the action to perform on the object.
 102 The set of possible actions depends on the object type.
 103 As a rule, it is possible to
 104 .B show
 105 (or
 106 .B list
 107 ) objects, but some objects do not allow all of these operations
 108 or have some additional commands. The
 109 .B help
 110 command is available for all objects. It prints
 111 out a list of available commands and argument syntax conventions.
 112 .sp
 113 If no command is given, some default command is assumed.
 114 Usually it is
 115 .B list
 116 or, if the objects of this class cannot be listed,
 117 .BR "help" .
 118
 119 .SH EXIT STATUS
 120 Exit status is 0 if command was successful or a positive integer upon failure.
 121
 122 .SH SEE ALSO
 123 .BR rdma-dev (8),
 124 .BR rdma-link (8),
 125 .BR rdma-resource (8),
 126 .BR rdma-system (8),
 127 .BR rdma-statistic (8),
 128 .br
 129
 130 .SH REPORTING BUGS
 131 Report any bugs to the Linux RDMA mailing list
 132 .B <linux-rdma@vger.kernel.org>
 133 where the development and maintenance is primarily done.
 134 You do not have to be subscribed to the list to send a message there.
 135
 136 .SH AUTHOR
 137 Leon Romanovsky <leonro@mellanox.com>