2 .\"@(#)nfsidmap(8) - The NFS idmapper upcall program
4 .\" Copyright (C) 2010 Bryan Schumaker <bjschuma@netapp.com>
5 .TH nfsidmap 5 "1 October 2010"
7 nfsidmap \- The NFS idmapper upcall program
9 .B "nfsidmap [-v] [-t timeout] key desc"
13 is used by the NFS idmapper to translate user and group ids into names, and to
14 translate user and group names into ids. Idmapper uses request-key to perform
15 the upcall and cache the result.
17 should only be called by request-key, and will perform the translation and
18 initialize a key with the resulting information.
22 Set the expiration timer, in seconds, on the key.
23 The default is 600 seconds (10 mins).
26 Increases the verbosity of the output to syslog
27 (can be specified multiple times).
30 .I /etc/request-key.conf
31 will need to be modified so
33 can properly direct the upcall. The following line should be added before a call
36 create id_resolver * * /usr/sbin/nfsidmap -t 600 %k %d
38 This will direct all id_resolver requests to the program
39 .I /usr/sbin/nfsidmap.
42 defines how many seconds into the future the key will
43 expire. This is an optional parameter for
45 and will default to 600 seconds when not specified.
47 The idmapper system uses four key descriptions:
49 uid: Find the UID for the given user
51 gid: Find the GID for the given group
53 user: Find the user name for the given UID
55 group: Find the group name for the given GID
57 You can choose to handle any of these individually, rather than using the
58 generic upcall program. If you would like to use your own program for a uid
59 lookup then you would edit your request-key.conf so it looks similar to this:
61 create id_resolver uid:* * /some/other/program %k %d
63 create id_resolver * * /usr/sbin/nfsidmap %k %d
65 Notice that the new line was added above the line for the generic program.
66 request-key will find the first matching line and run the corresponding program.
67 In this case, /some/other/program will handle all uid lookups, and
68 /usr/sbin/nfsidmap will handle gid, user, and group lookups.
70 Bryan Schumaker, <bjschuma@netapp.com>