1NFSTEST_PNFS(1)                nfstest_pnfs 1.5                NFSTEST_PNFS(1)
2
3
4

NAME

6       nfstest_pnfs - Basic pNFS functional tests
7

SYNOPSIS

9       nfstest_pnfs --server <server> [options]
10

DESCRIPTION

12       Verify basic pNFS functionality for file (both READ and WRITE), includ‐
13       ing opening a second file within the same mount and having  a  lock  on
14       the  file.  Also, verify basic pNFS functionality for a file opened for
15       both READ and WRITE while reading the file first and then writing to it
16       or  the  other  way around by writing to the file fist and then reading
17       the file. These tests verify proper functionality of pNFS  and  NFSv4.1
18       as well.
19
20
21

OPTIONS

23       --version
24              show program's version number and exit
25
26       -h, --help
27              show this help message and exit
28
29       -f FILE, --file=FILE
30              File  where  options  are specified besides the system wide file
31              /etc/nfstest, user wide file $HOME/.nfstest or  in  the  current
32              directory .nfstest file
33
34
35   NFS specific options:
36       -s SERVER, --server=SERVER
37              Server name or IP address
38
39       -e EXPORT, --export=EXPORT
40              Exported file system to mount [default: '/']
41
42       --nfsversion=NFSVERSION
43              NFS version, e.g., 3, 4, 4.1, etc. [default: 4.1]
44
45       -m MTPOINT, --mtpoint=MTPOINT
46              Mount point [default: '/mnt/t']
47
48       -p PORT, --port=PORT
49              NFS server port [default: 2049]
50
51       --proto=PROTO
52              NFS protocol name [default: 'tcp']
53
54       --sec=SEC
55              Security flavor [default: 'sys']
56
57       --nconnect=NCONNECT
58              Multiple TCP connections option [default: '1']
59
60       -o MTOPTS, --mtopts=MTOPTS
61              Mount options [default: 'hard,rsize=4096,wsize=4096']
62
63       --datadir=DATADIR
64              Data  directory where files are created, directory is created on
65              the mount point [default: '']
66
67
68   Logging options:
69       -v VERBOSE, --verbose=VERBOSE
70              Verbose     level     for     debug      messages      [default:
71              'opts|info|dbg1|dbg2|dbg3']
72
73       --tverbose=TVERBOSE
74              Verbose level for test messages [default: '1']
75
76       --createlog
77              Create log file
78
79       --rexeclog
80              Create rexec log files
81
82       --warnings
83              Display warnings
84
85       --tag=TAG
86              Informational  tag, it is displayed as an INFO message [default:
87              '']
88
89       --notty
90              Do not use terminal colors on output
91
92       --isatty
93              Use terminal colors on output -- useful when running with nohup
94
95
96   Packet trace options:
97       --createtraces
98              Create a packet trace for each test
99
100       --tbsize=TBSIZE
101              Capture buffer size for tcpdump [default: 192k]
102
103       --trcdelay=TRCDELAY
104              Seconds to delay before stopping packet trace [default: 2.0]
105
106       --keeptraces
107              Do not remove any trace files [default: remove trace files if no
108              errors]
109
110       --rmtraces
111              Remove trace files [default: remove trace files if no errors]
112
113       -i INTERFACE, --interface=INTERFACE
114              Device interface [default: automatically selected]
115
116
117   File options:
118       --nfiles=NFILES
119              Number of files to create [default: 2]
120
121       --filesize=FILESIZE
122              File size to use for test files [default: 64k]
123
124       --rsize=RSIZE
125              Read size to use when reading files [default: 4k]
126
127       --wsize=WSIZE
128              Write size to use when writing files [default: 4k]
129
130       --iodelay=IODELAY
131              Seconds to delay I/O operations [default: 0.1]
132
133       --offset-delta=OFFSET_DELTA
134              Read/Write offset delta [default: 4k]
135
136
137   Path options:
138       --sudo=SUDO
139              Full path of binary for sudo [default: '/usr/bin/sudo']
140
141       --kill=KILL
142              Full path of binary for kill [default: '/usr/bin/kill']
143
144       --nfsstat=NFSSTAT
145              Full path of binary for nfsstat [default: '/usr/sbin/nfsstat']
146
147       --tcpdump=TCPDUMP
148              Full path of binary for tcpdump [default: '/usr/sbin/tcpdump']
149
150       --iptables=IPTABLES
151              Full path of binary for iptables [default: '/usr/sbin/iptables']
152
153       --messages=MESSAGES
154              Full path of log messages file [default: '/var/log/messages']
155
156       --trcevents=TRCEVENTS
157              Full path of tracing events directory [default: '/sys/kernel/de‐
158              bug/tracing/events']
159
160       --trcpipe=TRCPIPE
161              Full path of trace pipe file [default:  '/sys/kernel/debug/trac‐
162              ing/trace_pipe']
163
164       --tmpdir=TMPDIR
165              Temporary directory [default: '/tmp']
166
167
168   Debug options:
169       --nocleanup
170              Do not cleanup created files
171
172       --notimestamps
173              Do not display timestamps in debug messages
174
175       --bugmsgs=BUGMSGS
176              File containing test messages to mark as bugs if they failed
177
178       --nomount
179              Do not mount server and run the tests on local disk space
180
181       --basename=BASENAME
182              Base  name for all files and logs [default: automatically gener‐
183              ated]
184
185       --nfsdebug=NFSDEBUG
186              Set NFS kernel debug flags and save log messages [default: '']
187
188       --rpcdebug=RPCDEBUG
189              Set RPC kernel debug flags and save log messages [default: '']
190
191       --tracepoints=TRACEPOINTS
192              List of trace points modules to enable [default: '']
193
194       --nfsstats
195              Get NFS stats [default: 'False']
196
197       --pktdisp
198              Display main packets related to the given test
199
200       --nfserrors
201              Fail every NFS error found in the packet trace
202
203       --client-ipaddr=CLIENT_IPADDR
204              IP address of localhost
205
206
207   Reporting options:
208       --xunit-report
209              Generate xUnit compatible test report
210
211       --xunit-report-file=XUNIT_REPORT_FILE
212              Path to xout report file
213
214
215   Test options:
216       --runtest=RUNTEST
217              Comma separated list of tests to run, if list starts with a  '^'
218              then all tests are run except the ones listed [default: 'all']
219

TESTS

221   read
222       Verify basic pNFS functionality on a couple of files opened for
223       reading within the same mount.
224
225   write
226       Verify basic pNFS functionality on a couple of files opened for
227       writing and then re-opening the first file for writing within
228       the same mount.
229
230   read_write
231       Verify basic pNFS functionality on a couple of files opened for
232       reading and then re-opening the first file for writing within
233       the same mount.
234
235   write_read
236       Verify basic pNFS functionality on a couple of files opened for
237       writing and then re-opening the first file for reading within
238       the same mount.
239
240   read_lock
241       Verify traffic for locked file opened for reading using pNFS.
242
243   write_lock
244       Verify traffic for locked file opened for writing using pNFS.
245
246   setattr
247       Verify setattr traffic for file using pNFS.
248
249   setattr_lock
250       Verify setattr traffic for locked file using pNFS.
251
252   rw_read
253       Verify traffic for file opened for read and write: reading file first.
254
255   rw_write
256       Verify traffic for file opened for read and write: writing file first.
257
258   one_ds
259       Verify client only connects to the DS with I/O.
260
261   rsize
262       Verify traffic for file using pNFS when mount option rsize < 4096.
263
264   wsize
265       Verify traffic for file using pNFS when mount option wsize < 4096.
266
267   rwsize
268       Verify traffic for file using pNFS when mount option rsize < 4096 and wsize < 4096.
269
270   nfsvers
271       Verify file created with pNFS is read correctly from different versions
272       of NFS. Also, verify files created with different versions of NFS are
273       read correctly from pNFS
274
275   all
276       Run all tests: read, write, read_write, write_read, read_lock,
277       write_lock, setattr, setattr_lock, rw_read, rw_write, one_ds, rsize,
278       wsize, rwsize, nfsvers
279

EXAMPLES

281       The only required option is --server
282       $ nfstest_pnfs --server 192.168.0.11
283

NOTES

285       The  user id in the local host must have access to run commands as root
286       using the 'sudo' command without the need for a password.
287

SEE ALSO

289       formatstr(3), nfstest.test_util(3), nfstest_alloc(1), nfstest_cache(1),
290       nfstest_delegation(1),     nfstest_dio(1),     nfstest_fcmp(1),     nf‐
291       stest_file(1), nfstest_interop(1), nfstest_io(1), nfstest_lock(1),  nf‐
292       stest_pkt(1), nfstest_posix(1), nfstest_rdma(1), nfstest_sparse(1), nf‐
293       stest_ssc(1),             nfstest_xattr(1),             nfstest_xid(1),
294       packet.nfs.nfs4_const(3)
295
296

BUGS

298       No known bugs.
299

AUTHOR

301       Jorge Mora (mora@netapp.com)
302
303
304
305NFStest 3.2                      21 March 2023                 NFSTEST_PNFS(1)
Impressum