1nfslog.conf(4) File Formats nfslog.conf(4)
2
6 nfslog.conf - NFS server logging configuration file
7
9 /etc/nfs/nfslog.conf
10
13 The nfslog.conf file specifies the location of the NFS server logs, as
14 well as the location of the private work files used by the NFS server
15 and nfslogd(1M) daemon during logging. Each entry in the file consists
16 of a mandatory tag identifier and one or more parameter identifiers.
17 The parameter identifier specifies the value or location of the spe‐
18 cific parameter. For instance, the parameter identifier
19 "log=/var/nfs/logs/serverLog" specifies the location of the NFS server
20 activity log. The mandatory tag identifier serves as an index into the
21 /etc/nfs/nfslog.conf file to identify the various parameters to be
22 used. At export time, the share_nfs(1M) command specifies the NFS
23 server logging parameters to use by associating a tag from the
24 /etc/nfs/nfslog.conf file to the exported file system. It is legal for
25 more than one file system to be exported using the same logging tag
26 identifier.
27 NFS server logging is not supported on Solaris machines that are using
30 NFS Version 4.
31 A "global" tag identifier is included in /etc/nfs/nfslog.conf. It spec‐
34 ifies the default set of values to be used during logging. If no tag
35 identifier is specified at export time, then the values in the "global"
36 entry are used. The "global" values can be modified by updating this
37 entry in /etc/nfs/nfslog.conf.
38 Each entry in the file must contain a mandatory tag identifier and at
41 least one parameter/value pair. If a parameter is not specified in a
42 given entry, the global value of the parameter will be used. The exact
43 entry syntax follows:
44 <tag> [defaultdir=<path>] [log=<path><file>] \
46 [fhtable=<path><file>] [buffer=<path><file>] [logformat=basic|extended]
47 defaultdir=<path> Specifies the directory where the logging
50 files and working files will be placed.
51 This path is prepended to all relative
52 paths specified in other parameters.
53 log=<path><file> Specifies the location of the user-readable
56 log file. The log will be located in the
57 defaultdir, unless <path> is an absolute
58 path.
59 fhtable=<path><file> Specifies the location of the private file
62 handle to path mapping database files.
63 These database files are for the private
64 use of the NFS server kernel module and the
65 nfslogd daemon. These files will be located
66 in the defaultdir, unless <path> is an
67 absolute path. These database files are
68 permanently stored in the file system. Con‐
69 sult nfslogd(1M) for information on pruning
70 the database files.
71 buffer=<path><file> Specifies the location of the private work
74 buffer file used by the NFS server kernel
75 module to record raw RPC information. This
76 file is later processed by the nfslog dae‐
77 mon, which in turn generates the user-read‐
78 able log file. This work buffer file will
79 be located in the defaultdir, unless <path>
80 is an absolute path.
81 logformat=basic|extended Sets the format of the user-readable log
84 file. If not specified, the basic format is
85 used. The basic format is compatible with
86 log files generated by the Washington Uni‐
87 versity FTPd. The extended format provides
88 a more detailed log, which includes direc‐
89 tory modification operations not included
90 in the basic format, such as mkdir, rmdir
91 and remove. Note that the extended format
92 is not compatible with Washington Univer‐
93 sity's FTPd log format.
94
97 Example 1 Using the global Tag
98 The "global" tag may be modified so that all exported file systems that
101 enabled logging use a common set of parameters that conform to the spe‐
102 cific needs of the user. These values are used until a specific tag
103 identifier overrides them.
104 global defaultdir=/var/nfs log=logs/nfslog \
107 fhtable=tables/fhtable buffer=buffers/nfslog_workbuffer \
108 logformat=basic
109 Example 2 Overriding the Global defaultdir and logformat
112 Because log files can become very large, it may be desirable to store
115 the logs and working files in separate file systems. This can be easily
116 accomplished by simply specifying a different defaultdir for every file
117 system exported by means of a unique tag:
118 engineering defaultdir=/engineering/logging \
121 logformat=extended
122 accounting defaultdir=/accounting/logging
123 marketing defaultdir=/marketing/logging
124 File systems shared with the engineering identifier will have their
128 logs and workfiles located in /engineering/logging. For instance, the
129 log file will be located at /engineering/logging/logs/nfslog. Note that
130 the engineering log file will be stored in the extended format, while
131 the rest of the log files will remain in the basic format.
132 Any of the parameters can be updated in a tag identifier, which over‐
136 rides the global settings.
137
140 See attributes(5) for descriptions of the following attributes:
141 ┌─────────────────────────────┬─────────────────────────────┐
146 │ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
147 ├─────────────────────────────┼─────────────────────────────┤
148 │Availability │SUNWnfssr │
149 └─────────────────────────────┴─────────────────────────────┘
150
152 nfslogd(1M), share_nfs(1M), attributes(5)
153
155 Logs, work files, and file handle to path mapping database can become
156 very large. Be aware of appropriate placement within the file system
157 name space. See nfslogd(1M)) for information on pruning the database
158 files and cycling logs.
159SunOS 5.11 2 Dec 2004 nfslog.conf(4)