nfstest_fcmp(1)

1NFSTEST_FCMP(1)                nfstest_fcmp 1.0                NFSTEST_FCMP(1)
2
3
4

NAME

6       nfstest_fcmp - NFS file compare
7

SYNOPSIS

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

DESCRIPTION

12       Create  a  file  using one set of NFS mount options and then verify the
13       data is correct by reading the file using another set of NFS mount  op‐
14       tions.
15
16
17

OPTIONS

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

TESTS

227   test01
228       Verify data read from file is correct
229
230   test02
231       Verify data written to file is correct
232
233   all
234       Run all tests: test01, test02
235

EXAMPLES

237       Use positional arguments with nfsversion=3 for second mount:
238           nfstest_fcmp -s 192.168.0.2 -e /exports --nfsopts :::3
239
240       Use named arguments instead:
241           nfstest_fcmp -s 192.168.0.2 -e /exports --nfsopts nfsversion=3
242

NOTES

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

BUGS

256       No known bugs.
257

AUTHOR

259       Jorge Mora (mora@netapp.com)
260
261
262
263NFStest 3.2                      21 March 2023                 NFSTEST_FCMP(1)