1 .\" Copyright (c) 2009 Rick Macklem, University of Guelph
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .Nd load user and group information into the kernel for
32 services plus support manage-gids for all NFS versions
35 .Op Fl domain Ar domain_name
36 .Op Fl usertimeout Ar minutes
37 .Op Fl usermax Ar max_cache_size
44 loads user and group information into the kernel for NFSv4.
45 For Kerberized NFSv4 mounts, it must be running on both client(s) and
46 server for correct operation.
47 For non-Kerberized NFSv4 mounts, this daemon must be running unless all
48 client(s) plus the server are configured to put uid/gid numbers in the
49 owner and owner_group strings.
51 It also provides support for manage-gids and must be running on the server if
52 this is being used for any version of NFS.
54 Upon startup, it loads the machine's DNS domain name, plus timeout and cache size
55 limit into the kernel.
56 It then preloads the cache with group and user information, up to the cache size
59 (default 4) children which are the servers
60 that service requests from the kernel
62 The master is there for the sole purpose of terminating the
64 To stop the nfsuserd, send a SIGUSR1 to the master.
66 The following options are available:
68 .It Fl domain Ar domain_name
69 This option allows you to override the default DNS domain name, which
70 is acquired by taking either the suffix on the machine's hostname or,
71 if that name is not a fully qualified host name, the canonical name as
74 .It Fl usertimeout Ar minutes
75 Overrides the default timeout for cache entries, in minutes.
77 time out, the better the performance, but the longer it takes for replaced
79 If your user/group database management system almost never re-uses the same names
80 or id numbers, a large timeout is recommended.
81 The default is 1 minute.
82 .It Fl usermax Ar max_cache_size
83 Overrides the default upper bound on the cache size.
84 The larger the cache, the more kernel memory is used, but the better the performance.
85 If your system can afford the memory use, make this the sum of the number of
86 entries in your group and password databases.
87 The default is 200 entries.
89 When set, the server logs a bunch of information to syslog.
91 This flag option must be set to restart the daemon after it has gone away
92 abnormally and refuses to start, because it thinks nfsuserd is already
95 This flag enables manage-gids for the NFS server
97 When this is enabled, all NFS requests using
98 AUTH_SYS authentication take the uid from the RPC request
99 and uses the group list for that uid provided by
101 on the server instead of the list of groups provided in the RPC authenticator.
102 This can be used to avoid the 16 group limit for AUTH_SYS.
104 Specifies how many servers to create (max 20).
105 The default of 4 may be sufficient.
106 You should run enough servers, so that
108 shows almost no running time for one or two of the servers after the system
109 has been running for a long period.
110 Running too few will have a major performance impact, whereas running too many
111 will only tie up some resources, such as a process table entry and swap space.
124 utility was introduced with the NFSv4 experimental subsystem in 2009.
133 library calls to resolve requests and will hang if the servers handling
134 those requests fail and the library functions don't return.
139 for more information on how the databases are accessed.