Blame man/man8/rdma-system.8

Packit d3f73b
.TH RDMA\-SYSTEM 8 "06 Jul 2017" "iproute2" "Linux"
Packit d3f73b
.SH NAME
Packit d3f73b
rdma-system \- RDMA subsystem configuration
Packit d3f73b
.SH SYNOPSIS
Packit d3f73b
.sp
Packit d3f73b
.ad l
Packit d3f73b
.in +8
Packit d3f73b
.ti -8
Packit d3f73b
.B rdma
Packit d3f73b
.RI "[ " OPTIONS " ]"
Packit d3f73b
.B sys
Packit d3f73b
.RI  " { " COMMAND " | "
Packit d3f73b
.BR help " }"
Packit d3f73b
.sp
Packit d3f73b
Packit d3f73b
.ti -8
Packit d3f73b
.IR OPTIONS " := { "
Packit d3f73b
\fB\-V\fR[\fIersion\fR] |
Packit d3f73b
\fB\-d\fR[\fIetails\fR] }
Packit d3f73b
Packit d3f73b
.ti -8
Packit d3f73b
.B rdma system show
Packit d3f73b
Packit d3f73b
.ti -8
Packit d3f73b
.B rdma system set
Packit d3f73b
.BR netns
Packit d3f73b
.BR NEWMODE
Packit d3f73b
Packit d3f73b
.ti -8
Packit d3f73b
.B rdma system help
Packit d3f73b
Packit d3f73b
.SH "DESCRIPTION"
Packit d3f73b
.SS rdma system set - set RDMA subsystem network namespace mode
Packit d3f73b
Packit d3f73b
.SS rdma system show - display RDMA subsystem network namespace mode
Packit d3f73b
Packit d3f73b
.PP
Packit d3f73b
.I "NEWMODE"
Packit d3f73b
- specifies the RDMA subsystem mode. Either exclusive or shared.
Packit d3f73b
When user wants to assign dedicated RDMA device to a particular
Packit d3f73b
network namespace, exclusive mode should be set before creating
Packit d3f73b
any network namespace. If there are active network namespaces and if
Packit d3f73b
one or more RDMA devices exist, changing mode from shared to
Packit d3f73b
exclusive returns error code EBUSY.
Packit d3f73b
Packit d3f73b
When RDMA subsystem is in shared mode, RDMA device is accessible in
Packit d3f73b
all network namespace. When RDMA device isolation among multiple
Packit d3f73b
network namespaces is not needed, shared mode can be used.
Packit d3f73b
Packit d3f73b
It is preferred to not change the subsystem mode when there is active
Packit d3f73b
RDMA traffic running, even though it is supported.
Packit d3f73b
Packit d3f73b
.SH "EXAMPLES"
Packit d3f73b
.PP
Packit d3f73b
rdma system show
Packit d3f73b
.RS 4
Packit d3f73b
Shows the state of RDMA subsystem network namespace mode on the system.
Packit d3f73b
.RE
Packit d3f73b
.PP
Packit d3f73b
rdma system set netns exclusive
Packit d3f73b
.RS 4
Packit d3f73b
Sets the RDMA subsystem in network namespace exclusive mode. In this mode RDMA devices
Packit d3f73b
are visible only in single network namespace.
Packit d3f73b
.RE
Packit d3f73b
.PP
Packit d3f73b
rdma system set netns shared
Packit d3f73b
.RS 4
Packit d3f73b
Sets the RDMA subsystem in network namespace shared mode. In this mode RDMA devices
Packit d3f73b
are shared among network namespaces.
Packit d3f73b
.RE
Packit d3f73b
.PP
Packit d3f73b
Packit d3f73b
.SH SEE ALSO
Packit d3f73b
.BR rdma (8),
Packit d3f73b
.BR rdma-link (8),
Packit d3f73b
.BR rdma-resource (8),
Packit d3f73b
.BR network_namespaces (7),
Packit d3f73b
.BR namespaces (7),
Packit d3f73b
.br
Packit d3f73b
Packit d3f73b
.SH AUTHOR
Packit d3f73b
Parav Pandit <parav@mellanox.com>