Debian Codegraph @

upstream/debian-trixie/man8/rdma-dev.8

raw
1 .TH RDMA\-DEV 8 "06 Jul 2017" "iproute2" "Linux"
2 .SH NAME
3 rdma-dev \- RDMA device configuration
4 .SH SYNOPSIS
5 .sp
6 .ad l
7 .in +8
8 .ti -8
9 .B rdma
10 .RI "[ " OPTIONS " ]"
11 .B dev
12 .RI " { " COMMAND " | "
13 .BR help " }"
14 .sp
15
16 .ti -8
17 .IR OPTIONS " := { "
18 \fB\-V\fR[\fIersion\fR] |
19 \fB\-d\fR[\fIetails\fR] }
20
21 .ti -8
22 .B rdma dev show
23 .RI "[ " DEV " ]"
24
25 .ti -8
26 .B rdma dev set
27 .RI "[ " DEV " ]"
28 .BR name
29 .BR NEWNAME
30
31 .ti -8
32 .B rdma dev set
33 .RI "[ " DEV " ]"
34 .BR netns
35 .BR NSNAME
36
37 .ti -8
38 .B rdma dev set
39 .RI "[ " DEV " ]"
40 .BR adaptive-moderation
41 .BR [on/off]
42
43 .ti -8
44 .B rdma dev add
45 .RI "[ " NAME " ]"
46 .B type
47 .RI "[ " TYPE " ]"
48 .B parent
49 .RI "[ " PARENT_DEV " ]"
50
51 .ti -8
52 .B rdma dev delete
53 .RI "[ " NAME " ]"
54
55 .ti -8
56 .B rdma dev help
57
58 .SH "DESCRIPTION"
59 .SS rdma dev set - rename RDMA device or set network namespace or set RDMA device adaptive-moderation
60
61 .SS rdma dev show - display RDMA device attributes
62
63 .PP
64 .I "DEV"
65 - specifies the RDMA device to show.
66 If this argument is omitted all devices are listed.
67
68 .SS rdma dev add - Add a RDMA device with a specific type and parent IB device; This new device provides subset of functionalities defined in IBTA spec.
69 .SS rdma dev delete - Delete a RDMA device which is created with the "add" command.
70 .I NAME
71 - The name of the device being added/deleted.
72
73 .I TYPE
74 - The type of the device being added; It specifies which functionalities it provides. Supported device type:
75 .sp
76 .in +8
77 .B SMI
78 - A device with this type provides SMI (QP0) interface. This device and it's parent associates with the same HCA port and shares the physical link, so when the parent doesn't support SMI, then this type of device can be created to allow the subnet manager to configure the link.
79 .in -8
80
81 .I PARENT_DEV
82 - The name of its parent IB device.
83
84 .SH "EXAMPLES"
85 .PP
86 rdma dev
87 .RS 4
88 Shows the state of all RDMA devices on the system.
89 .RE
90 .PP
91 rdma dev show mlx5_3
92 .RS 4
93 Shows the state of specified RDMA device.
94 .RE
95 .PP
96 rdma dev set mlx5_3 name rdma_0
97 .RS 4
98 Renames the mlx5_3 device to rdma_0.
99 .RE
100 .PP
101 rdma dev set mlx5_3 netns foo
102 .RS 4
103 Changes the network namespace of RDMA device to foo where foo is
104 previously created using iproute2 ip command.
105 .RE
106 .PP
107 rdma dev set mlx5_3 adaptive-moderation [on/off]
108 .RS 4
109 Sets the state of adaptive interrupt moderation for the RDMA device.
110 .RE
111 .RS 4
112 This is a global setting for the RDMA device but the value is printed for each CQ individually because the state is constant from CQ allocation.
113 .RE
114 .PP
115 rdma dev add smi1 type SMI parent ibp8s0f1
116 .RS 4
117 Add a new IB device with name "smi1", type "SMI", and "ibp8s0f1" as its parent device.
118 .RE
119 .PP
120 rdma dev delete smi1
121 .RS 4
122 Delete the IB device "smi1".
123 .RE
124 .PP
125
126 .SH SEE ALSO
127 .BR ip (8),
128 .BR rdma (8),
129 .BR rdma-link (8),
130 .BR rdma-resource (8),
131 .BR rdma-system (8),
132 .BR rdma-statistic (8),
133 .br
134
135 .SH AUTHOR
136 Leon Romanovsky <[email protected]>
137 .br
138 Mark Zhang <[email protected]>