NFSTEST_PNFS(1)

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

💖 NFSTEST_PNFS 💖

okay bestie, welcome to nfstest_pnfs — it's part of the nfstest fam, version 1.5, and it's the girl who checks that your pNFS setup is actually doing the thing. pull up a chair, grab a strawberry 🍓, and let's get into it.

✨ NAME ✨

nfstest_pnfs — basic pNFS functional tests. that's it, that's the vibe. it runs the tests, it tells you if pNFS is slaying or flopping.

🌸 SYNOPSIS 🌸

nfstest_pnfs --server <server> [options]

🦋 DESCRIPTION 🦋

okay so here's the whole point of her: she verifies basic pNFS functionality for a file — and yes, that means both READ and WRITE, no picking favorites. 💅

she also checks what happens when you open a second file within the same mount and when you have a lock on the file. because pNFS gotta behave even when things get complicated, you know?

and then — this is the part I'm obsessed with — she verifies basic pNFS functionality for a file opened for both READ and WRITE at the same time, while reading the file first and then writing to it, or the other way around: writing to the file first and then reading the file. both directions, both orders, no cap. 🫶

all of these tests verify that pNFS and NFSv4.1 are functioning properly. so like, if something's broken, she WILL find it. main character energy fr fr.

💅 OPTIONS 💅

general girly options

  • --version — shows the program's version number and dips. bye! 👋
  • -h, --help — shows this help message and exits. iconic of her tbh.
  • -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. so many places to spill your settings ✨

🌈 NFS specific options 🌈

  • -s SERVER, --server=SERVER — server name or IP address. the whole reason we're here bestie.
  • -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,rsize=4096,wsize=4096']
  • --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 — useful when 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: 2]
  • --filesize=FILESIZE — file size to use for test files [default: 64k]
  • --rsize=RSIZE — read size to use when reading files [default: 4k]
  • --wsize=WSIZE — write size to use when writing files [default: 4k]
  • --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']

👑 TESTS 👑

read

verify basic pNFS functionality on a couple of files opened for reading within the same mount. 📖

write

verify basic pNFS functionality on a couple of files opened for writing and then re-opening the first file for writing within the same mount. ✍️

read_write

verify basic pNFS functionality on a couple of files opened for reading and then re-opening the first file for writing within the same mount. 🔁

write_read

verify basic pNFS functionality on a couple of files opened for writing and then re-opening the first file for reading within the same mount. 🔄

read_lock

verify traffic for locked file opened for reading using pNFS. 🔒

write_lock

verify traffic for locked file opened for writing using pNFS. 🔐

setattr

verify setattr traffic for file using pNFS. 💫

setattr_lock

verify setattr traffic for locked file using pNFS. 💫🔒

rw_read

verify traffic for file opened for read and write: reading file first. 📖➡️✍️

rw_write

verify traffic for file opened for read and write: writing file first. ✍️➡️📖

one_ds

verify client only connects to the DS with I/O. 🎯

rsize

verify traffic for file using pNFS when mount option rsize < 4096. 📏

wsize

verify traffic for file using pNFS when mount option wsize < 4096. 📐

rwsize

verify traffic for file using pNFS when mount option rsize < 4096 and wsize < 4096. 📏📐

nfsvers

verify file created with pNFS is read correctly from different versions of NFS. also, verify files created with different versions of NFS are read correctly from pNFS. 🌐

all

run all tests: read, write, read_write, write_read, read_lock, write_lock, setattr, setattr_lock, rw_read, rw_write, one_ds, rsize, wsize, rwsize, nfsvers. the full lineup bestie, she's doing ALL of it. 🏆

🍓 EXAMPLES 🍓

the only required option is --server. that's the one thing you can't skip, periodt.

$ nfstest_pnfs --server 192.168.0.11

look at her go. 💅

⚠️ NOTES ⚠️

the user id in the local host must have access to run commands as root using the 'sudo' command without the need for a password. like, it has to just work, no password prompt, no drama. set that up first or she's gonna be stuck at the door. 😭

💜 SEE ALSO 💜

formatstr(3), nfstest.test_util(3), nfstest_alloc(1), nfstest_cache(1), nfstest_delegation(1), nfstest_dio(1), nfstest_fcmp(1), nfstest_file(1), nfstest_interop(1), nfstest_io(1), nfstest_lock(1), nfstest_pkt(1), nfstest_posix(1), nfstest_rdma(1), nfstest_sparse(1), nfstest_ssc(1), nfstest_xattr(1), nfstest_xid(1), packet.nfs.nfs4_const(3)

the whole friend group, all linked up. 🫶✨

💀 BUGS 💀

no known bugs. she said she's flawless and honestly? we believe her. 💅✨

🎀 AUTHOR 🎀

jorge mora (mora@netapp.com) — the legend who wrote her. 👑

and that's the whole page bestie!! this is NFStest 3.2, dated 21 March 2023 — go run some pNFS tests, you're gonna eat. 🍽️💖🦋 no cap.

📦 where this page comes from