1RDMA(8)                              Linux                             RDMA(8)
2
3
4

NAME

6       rdma - RDMA tool
7

SYNOPSIS

9       rdma [ OPTIONS ] OBJECT { COMMAND | help }
10
11
12       rdma [ -force ] -batch filename
13
14
15       OBJECT := { dev | link }
16
17
18       OPTIONS := { -V[ersion] | -d[etails] } -j[son] } -p[retty] }
19
20

OPTIONS

22       -V, -Version
23              Print the version of the rdma tool and exit.
24
25
26       -b, -batch <FILENAME>
27              Read commands from provided file or standard input and invoke
28              them.  First failure will cause termination of rdma.
29
30
31       -force Don't terminate rdma on errors in batch mode.  If there were any
32              errors during execution of the commands, the application return
33              code will be non zero.
34
35
36       -d, --details
37              Output detailed information.  Adding a second -d includes
38              driver-specific details.
39
40
41       -p, --pretty
42              When combined with -j generate a pretty JSON output.
43
44
45       -j, --json
46              Generate JSON output.
47
48
49   OBJECT
50       dev    - RDMA device.
51
52
53       link   - RDMA port related.
54
55
56       The names of all objects may be written in full or abbreviated form,
57       for example stats can be abbreviated as stat or just s.
58
59
60   COMMAND
61       Specifies the action to perform on the object.  The set of possible
62       actions depends on the object type.  As a rule, it is possible to show
63       (or list ) objects, but some objects do not allow all of these opera‐
64       tions or have some additional commands. The help command is available
65       for all objects. It prints out a list of available commands and argu‐
66       ment syntax conventions.
67
68       If no command is given, some default command is assumed.  Usually it is
69       list or, if the objects of this class cannot be listed, help.
70
71

EXIT STATUS

73       Exit status is 0 if command was successful or a positive integer upon
74       failure.
75
76

SEE ALSO

78       rdma-dev(8), rdma-link(8), rdma-resource(8),
79
80

REPORTING BUGS

82       Report any bugs to the Linux RDMA mailing list <linux-rdma@vger.ker‐
83       nel.org> where the development and maintenance is primarily done.  You
84       do not have to be subscribed to the list to send a message there.
85
86

AUTHOR

88       Leon Romanovsky <leonro@mellanox.com>
89
90
91
92iproute2                          28 Mar 2017                          RDMA(8)