NFSTEST_FCMP(1)

📦 version 3.2, in debian trixie, fedora 43, fedora 44, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 NFSTEST_FCMP 💖

okay bestie, welcome to nfstest_fcmp from the nfstest fam (manual section 1, version 1.0) — the little tool that's gonna make sure your NFS data is actually correct and not just ✨vibing✨. let's get into it 🫶

🌸 NAME 🌸

nfstest_fcmp — NFS file compare, aka the "did my data survive the trip" check 💅

🦋 SYNOPSIS 🦋

nfstest_fcmp --server <server> [options]

✨ DESCRIPTION ✨

so here's the whole plot: you create a file using one set of NFS mount options, then you read that same file back using another set of NFS mount options and verify the data is still correct. it's giving "trust but verify" and honestly? iconic 🔥

💅 OPTIONS 💅

  • --version — show the program's version number and dip out 👋
  • -h, --help — show this help message and exit
  • -f FILE, --file=FILE — the file where options are specified, besides the system wide file /etc/nfstest, the user wide file $HOME/.nfstest, or the .nfstest file in the current directory 🗂️

🌈 NFS specific options 🌈

  • -s SERVER, --server=SERVER — server name or IP address, the main character fr fr
  • -e EXPORT, --export=EXPORT — exported file system to mount [default: '/']
  • --nfsversion=NFSVERSION — NFS version, e.g., 3, 4, 4.1, etc. [default: 4.1]
  • -m MTPOINT, --mtpoint=MTPOINT — mount point [default: '/mnt/t']
  • -p PORT, --port=PORT — NFS server port [default: 2049]
  • --proto=PROTO — NFS protocol name [default: 'tcp']
  • --sec=SEC — security flavor [default: 'sys']
  • --nconnect=NCONNECT — multiple TCP connections option [default: '1']
  • -o MTOPTS, --mtopts=MTOPTS — mount options [default: 'hard']
  • --datadir=DATADIR — data directory where files are created; the directory is created on the mount point [default: '']

🎀 Logging options 🎀

  • -v VERBOSE, --verbose=VERBOSE — verbose level for debug messages [default: 'opts|info|dbg1|dbg2|dbg3']
  • --tverbose=TVERBOSE — verbose level for test messages [default: '1']
  • --createlog — create log file
  • --rexeclog — create rexec log files
  • --warnings — display warnings ⚠️
  • --tag=TAG — informational tag, it is displayed as an INFO message [default: '']
  • --notty — do not use terminal colors on output
  • --isatty — use terminal colors on output — lowkey a lifesaver when you're running with nohup

🧚 Packet trace options 🧚

  • --createtraces — create a packet trace for each test
  • --tbsize=TBSIZE — capture buffer size for tcpdump [default: 192k]
  • --trcdelay=TRCDELAY — seconds to delay before stopping packet trace [default: 2.0]
  • --keeptraces — do not remove any trace files [default: remove trace files if no errors]
  • --rmtraces — remove trace files [default: remove trace files if no errors]
  • -i INTERFACE, --interface=INTERFACE — device interface [default: automatically selected]

💜 File options 💜

  • --nfiles=NFILES — number of files to create [default: 0]
  • --filesize=FILESIZE — file size to use for test files [default: 1m]
  • --rsize=RSIZE — read size to use when reading files [default: 64k]
  • --wsize=WSIZE — write size to use when writing files [default: 64k]
  • --iodelay=IODELAY — seconds to delay I/O operations [default: 0.1]
  • --offset-delta=OFFSET_DELTA — read/write offset delta [default: 4k]

🍓 Path options 🍓

  • --sudo=SUDO — full path of binary for sudo [default: '/usr/bin/sudo']
  • --kill=KILL — full path of binary for kill [default: '/usr/bin/kill']
  • --nfsstat=NFSSTAT — full path of binary for nfsstat [default: '/usr/sbin/nfsstat']
  • --tcpdump=TCPDUMP — full path of binary for tcpdump [default: '/usr/sbin/tcpdump']
  • --iptables=IPTABLES — full path of binary for iptables [default: '/usr/sbin/iptables']
  • --messages=MESSAGES — full path of log messages file [default: '/var/log/messages']
  • --trcevents=TRCEVENTS — full path of tracing events directory [default: '/sys/kernel/debug/tracing/events']
  • --trcpipe=TRCPIPE — full path of trace pipe file [default: '/sys/kernel/debug/tracing/trace_pipe']
  • --tmpdir=TMPDIR — temporary directory [default: '/tmp']

👑 Debug options 👑

  • --nocleanup — do not cleanup created files
  • --notimestamps — do not display timestamps in debug messages
  • --bugmsgs=BUGMSGS — file containing test messages to mark as bugs if they failed
  • --nomount — do not mount server and run the tests on local disk space
  • --basename=BASENAME — base name for all files and logs [default: automatically generated]
  • --nfsdebug=NFSDEBUG — set NFS kernel debug flags and save log messages [default: '']
  • --rpcdebug=RPCDEBUG — set RPC kernel debug flags and save log messages [default: '']
  • --tracepoints=TRACEPOINTS — list of trace points modules to enable [default: '']
  • --nfsstats — get NFS stats [default: 'False']
  • --pktdisp — display main packets related to the given test
  • --nfserrors — fail every NFS error found in the packet trace
  • --client-ipaddr=CLIENT_IPADDR — IP address of localhost

🌟 Reporting options 🌟

  • --xunit-report — generate xUnit compatible test report
  • --xunit-report-file=XUNIT_REPORT_FILE — path to xout report file

🔥 Test options 🔥

  • --runtest=RUNTEST — comma separated list of tests to run; if the list starts with a '^' then all tests are run except the ones listed [default: 'all']
  • --nfsopts=NFSOPTS — NFS options used for comparing test file. NFS mount definition is a list of arguments separated by a ':' given in the following order if positional arguments are used (see examples): ::export:nfsversion:port:proto:sec
  • --cmpopts=CMPOPTS — NFS mount options used for comparing test file other than the ones specified in --nfsopts [default: 'hard']

🌈 TESTS 🌈

test01

verify data read from file is correct ✅

test02

verify data written to file is correct ✅

all

run all tests: test01, test02 — the whole lineup, no skips 💯

🦄 EXAMPLES 🦄

use positional arguments with nfsversion=3 for the second mount:

nfstest_fcmp -s 192.168.0.2 -e /exports --nfsopts :::3

or use named arguments instead:

nfstest_fcmp -s 192.168.0.2 -e /exports --nfsopts nfsversion=3

both ate, pick your fave 🫶

💀 NOTES 💀

the user id on the local host must have access to run commands as root using the 'sudo' command without the need for a password. no cap, that's a hard requirement 🔐

🌸 SEE ALSO 🌸

nfstest.test_util(3), nfstest_alloc(1), nfstest_cache(1), nfstest_delegation(1), nfstest_dio(1), nfstest_file(1), nfstest_interop(1), nfstest_io(1), nfstest_lock(1), nfstest_pkt(1), nfstest_pnfs(1), nfstest_posix(1), nfstest_rdma(1), nfstest_sparse(1), nfstest_ssc(1), nfstest_xattr(1), nfstest_xid(1) — the whole squad, go say hi 💜

🐛 BUGS 🐛

no known bugs. periodt. 💅

👑 AUTHOR 👑

Jorge Mora (mora@netapp.com) — the legend behind the vibes 🫡

and that's a wrap bestie!! this page is brought to you by NFStest 3.2, dated 21 March 2023 ✨ go forth and compare those files, you've got this 💖🦋🎀

📦 where this page comes from