| 1 |
.\" |
| 2 |
.\" rpcctl(8) |
| 3 |
.\" |
| 4 |
.TH rpcctl 8 "15 Feb 2022" |
| 5 |
.SH NAME |
| 6 |
rpcctl \- Displays SunRPC connection information |
| 7 |
.SH SYNOPSIS |
| 8 |
.nf |
| 9 |
.BR rpcctl " [ \fB\-h \fR| \fB\-\-help \fR] { \fBclient \fR| \fBswitch \fR| \fBxprt \fR}" |
| 10 |
.P |
| 11 |
.BR "rpcctl client" " \fR[ \fB\-h \fR| \fB\-\-help \fR] { \fBshow \fR}" |
| 12 |
.BR "rpcctl client show " "\fR[ \fB\-h \f| \fB\-\-help \fR] [ \fIXPRT \fR]" |
| 13 |
.P |
| 14 |
.BR "rpcctl switch" " \fR[ \fB\-h \fR| \fB\-\-help \fR] { \fBset \fR| \fBshow \fR}" |
| 15 |
.BR "rpcctl switch add-xprt" " \fR[ \fB\-h \fR| \fB\-\-help \fR] [ \fISWITCH \fR]" |
| 16 |
.BR "rpcctl switch set" " \fR[ \fB\-h \fR| \fB\-\-help \fR] \fISWITCH \fBdstaddr \fINEWADDR" |
| 17 |
.BR "rpcctl switch show" " \fR[ \fB\-h \fR| \fB\-\-help \fR] [ \fISWITCH \fR]" |
| 18 |
.P |
| 19 |
.BR "rpcctl xprt" " \fR[ \fB\-h \fR| \fB\-\-help \fR] { \fBremove \fR| \fBset \fR| \fBshow \fR}" |
| 20 |
.BR "rpcctl xprt remove" " \fR[ \fB\-h \fR| \fB\-\-help \fR] \fIXPRT" |
| 21 |
.BR "rpcctl xprt set" " \fR[ \fB\-h \fR| \fB\-\-help \fR] \fIXPRT \fR{ \fBdstaddr \fINEWADDR \fR| \fBoffline \fR| \fBonline \fR}" |
| 22 |
.BR "rpcctl xprt show" " \fR[ \fB\-h \fR| \fB\-\-help \fR] [ \fIXPRT \fR]" |
| 23 |
.fi |
| 24 |
.SH DESCRIPTION |
| 25 |
.RB "The " rpcctl " command displays information collected in the SunRPC sysfs files about the system's SunRPC objects. |
| 26 |
.P |
| 27 |
.SS rpcctl client \fR- \fBCommands operating on RPC clients |
| 28 |
.IP "\fBshow \fR[ \fICLIENT \fR] \fB(default)" |
| 29 |
Show detailed information about the RPC clients on this system. |
| 30 |
If \fICLIENT \fRwas provided, then only show information about a single RPC client. |
| 31 |
.P |
| 32 |
.SS rpcctl switch \fR- \fBCommands operating on groups of transports |
| 33 |
.IP "\fBadd-xprt \fISWITCH" |
| 34 |
Add an additional transport to the \fISWITCH\fR. |
| 35 |
Note that the new transport will take its values from the "main" transport. |
| 36 |
.IP "\fBset \fISWITCH \fBdstaddr \fINEWADDR" |
| 37 |
Change the destination address of all transports in the \fISWITCH \fRto \fINEWADDR\fR. |
| 38 |
\fINEWADDR \fRcan be an IP address, DNS name, or anything else resolvable by \fBgethostbyname\fR(3). |
| 39 |
.IP "\fBshow \fR[ \fISWITCH \fR] \fB(default)" |
| 40 |
Show detailed information about groups of transports on this system. |
| 41 |
If \fISWITCH \fRwas provided, then only show information about a single transport group. |
| 42 |
.P |
| 43 |
.SS rpcctl xprt \fR- \fBCommands operating on individual transports |
| 44 |
.IP "\fBremove \fIXPRT" |
| 45 |
Removes the specified \fIXPRT \fRfrom the system. |
| 46 |
Note that "main" transports cannot be removed. |
| 47 |
.P |
| 48 |
.IP "\fBset \fIXPRT \fBdstaddr \fINEWADDR" |
| 49 |
Change the destination address of the specified \fIXPRT \fR to \fINEWADDR\fR. |
| 50 |
\fINEWADDR \fRcan be an IP address, DNS name, or anything else resolvable by \fBgethostbyname\fR(3). |
| 51 |
.P |
| 52 |
.IP "\fBset \fIXPRT \fBoffline" |
| 53 |
Sets the specified \fIXPRT\fR's state to offline. |
| 54 |
.P |
| 55 |
.IP "\fBset \fIXPRT \fBonline" |
| 56 |
Sets the specified \fIXPRT\fR's state to online. |
| 57 |
.IP "\fBshow \fR[ \fIXPRT \fR] \fB(default)" |
| 58 |
Show detailed information about this system's transports. |
| 59 |
If \fIXPRT \fRwas provided, then only show information about a single transport. |
| 60 |
.SH EXAMPLES |
| 61 |
.IP "\fBrpcctl switch show switch-2" |
| 62 |
Show details about the RPC switch named "switch-2". |
| 63 |
.IP "\fBrpcctl xprt remove xprt-4" |
| 64 |
Remove the xprt named "xprt-4" from the system. |
| 65 |
.IP "\fBrpcctl xprt set xprt-3 dstaddr https://linux-nfs.org |
| 66 |
Change the dstaddr of the xprt named "xprt-3" to point to linux-nfs.org |
| 67 |
.SH DIRECTORY |
| 68 |
.TP |
| 69 |
.B /sys/kernel/sunrpc/ |
| 70 |
.SH AUTHOR |
| 71 |
Anna Schumaker <[email protected]> |