rpcctl(8) — Linux manual page

NAME \| SYNOPSIS \| DESCRIPTION \| EXAMPLES \| DIRECTORY \| AUTHOR \| COLOPHON

rpcctl(8)                System Manager's Manual                rpcctl(8)

NAME top

       rpcctl - Displays SunRPC connection information

SYNOPSIS top

       rpcctl [ -h | --help ] { client | switch | xprt }

       rpcctl client [ -h | --help ] { show }
       rpcctl client show [ -h  --help ] [ XPRT ]

       rpcctl switch [ -h | --help ] { set | show }
       rpcctl switch add-xprt [ -h | --help ] [ SWITCH ]
       rpcctl switch set [ -h | --help ] SWITCH dstaddr NEWADDR
       rpcctl switch show [ -h | --help ] [ SWITCH ]

       rpcctl xprt [ -h | --help ] { remove | set | show }
       rpcctl xprt remove [ -h | --help ] XPRT
       rpcctl xprt set [ -h | --help ] XPRT { dstaddr NEWADDR | offline | online }
       rpcctl xprt show [ -h | --help ] [ XPRT ]

DESCRIPTION top

       The rpcctl command displays information collected in the SunRPC
       sysfs files about the system's SunRPC objects.

   rpcctl client - Commands operating on RPC clients
       show [ CLIENT ] (default)
              Show detailed information about the RPC clients on this
              system.  If CLIENT was provided, then only show information
              about a single RPC client.

   rpcctl switch - Commands operating on groups of transports
       add-xprt SWITCH
              Add an aditional transport to the SWITCH.  Note that the
              new transport will take its values from the "main"
              transport.

       set SWITCH dstaddr NEWADDR
              Change the destination address of all transports in the
              SWITCH to NEWADDR.  NEWADDR can be an IP address, DNS name,
              or anything else resolvable by gethostbyname(3).

       show [ SWITCH ] (default)
              Show detailed information about groups of transports on
              this system.  If SWITCH was provided, then only show
              information about a single transport group.

   rpcctl xprt - Commands operating on individual transports
       remove XPRT
              Removes the specified XPRT from the system.  Note that
              "main" transports cannot be removed.

       set XPRT dstaddr NEWADDR
              Change the destination address of the specified XPRT  to
              NEWADDR.  NEWADDR can be an IP address, DNS name, or
              anything else resolvable by gethostbyname(3).

       set XPRT offline
              Sets the specified XPRT's state to offline.

       set XPRT online
              Sets the specified XPRT's state to online.

       show [ XPRT ] (default)
              Show detailed information about this system's transports.
              If XPRT was provided, then only show information about a
              single transport.

EXAMPLES top

       rpcctl switch show switch-2
              Show details about the RPC switch named "switch-2".

       rpcctl xprt remove xprt-4
              Remove the xprt named "xprt-4" from the system.

       rpcctl xprt set xprt-3 dstaddr https://linux-nfs.org
              Change the dstaddr of the xprt named "xprt-3" to point to
              linux-nfs.org

DIRECTORY top

       /sys/kernel/sunrpc/

AUTHOR top

       Anna Schumaker <[email protected]>

COLOPHON top

       This page is part of the nfs-utils (NFS utilities) project.
       Information about the project can be found at 
       ⟨http://linux-nfs.org/wiki/index.php/Main_Page⟩.  If you have a bug
       report for this manual page, see
       ⟨http://linux-nfs.org/wiki/index.php/Main_Page⟩.  This page was
       obtained from the project's upstream Git repository
       ⟨git://git.linux-nfs.org/projects/steved/nfs-utils.git⟩ on
       2025-08-11.  (At that time, the date of the most recent commit
       that was found in the repository was 2025-06-27.)  If you discover
       any rendering problems in this HTML version of the page, or you
       believe there is a better or more up-to-date source for the page,
       or you have corrections or improvements to the information in this
       COLOPHON (which is not part of the original manual page), send a
       mail to [email protected]

                               15 Feb 2022                      rpcctl(8)