Debian Codegraph @

upstream/debian-unstable/man8/rdma-system.8

raw
1 .TH RDMA\-SYSTEM 8 "06 Jul 2017" "iproute2" "Linux"
2 .SH NAME
3 rdma-system \- RDMA subsystem configuration
4 .SH SYNOPSIS
5 .sp
6 .ad l
7 .in +8
8 .ti -8
9 .B rdma
10 .RI "[ " OPTIONS " ]"
11 .B sys
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 system show
23
24 .ti -8
25 .B rdma system set
26 .BR netns
27 .BR NEWMODE
28
29 .ti -8
30 .B rdma system set
31 .BR privileged-qkey
32 .BR NEWSTATE
33
34 .ti -8
35 .B rdma system help
36
37 .SH "DESCRIPTION"
38 .SS rdma system set - set RDMA subsystem network namespace mode or
39 privileged qkey mode
40
41 .SS rdma system show - display RDMA subsystem network namespace mode,
42 privileged qkey state and whether RDMA monitoring is supported.
43
44 .PP
45 .I "NEWMODE"
46 - specifies the RDMA subsystem mode. Either exclusive or shared.
47 When user wants to assign dedicated RDMA device to a particular
48 network namespace, exclusive mode should be set before creating
49 any network namespace. If there are active network namespaces and if
50 one or more RDMA devices exist, changing mode from shared to
51 exclusive returns error code EBUSY.
52
53 When RDMA subsystem is in shared mode, RDMA device is accessible in
54 all network namespaces. When RDMA device isolation among multiple
55 network namespaces is not needed, shared mode can be used.
56
57 It is preferred to not change the subsystem mode when there is active
58 RDMA traffic running, even though it is supported.
59 .PP
60 .I "NEWSTATE"
61 - Specifies the new state of the privileged-qkey parameter, either on or off.
62 This parameter determines whether a non-privileged user is allowed to specify a
63 controlled QKEY or not.
64
65 .SH "EXAMPLES"
66 .PP
67 rdma system show
68 .RS 4
69 Shows the state of RDMA subsystem network namespace mode on the system,
70 the state of privileged qkey parameter and whether RDMA monitor is supported.
71 .RE
72 .PP
73 rdma system set netns exclusive
74 .RS 4
75 Sets the RDMA subsystem in network namespace exclusive mode. In this mode RDMA devices
76 are visible only in single network namespace.
77 .RE
78 .PP
79 rdma system set netns shared
80 .RS 4
81 Sets the RDMA subsystem in network namespace shared mode. In this mode RDMA devices
82 are shared among network namespaces.
83 .RE
84 .PP
85 rdma system set privileged-qkey on
86 .RS 4
87 Sets the privileged-qkey parameter to on. In this state non-privileged user
88 is allowed to specify a controlled QKEY.
89 .RE
90 .PP
91 rdma system set privileged-qkey off
92 .RS 4
93 Sets the privileged-qkey parameter to off. In this state non-privileged user
94 is *not* allowed to specify a controlled QKEY.
95 .RE
96 .PP
97
98 .SH SEE ALSO
99 .BR rdma (8),
100 .BR rdma-link (8),
101 .BR rdma-resource (8),
102 .BR rdma-monitor (8),
103 .BR network_namespaces (7),
104 .BR namespaces (7),
105 .br
106
107 .SH AUTHOR
108 Parav Pandit <[email protected]>