Debian Codegraph @

upstream/debian-trixie/man8/rpcctl.8

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