.\" DO NOT MODIFY THIS FILE! It was generated by setup.py 1.2. .TH NFSTEST_PNFS 1 "21 March 2023" "NFStest 3.2" "nfstest_pnfs 1.5" .SH NAME nfstest_pnfs - Basic pNFS functional tests .SH SYNOPSIS nfstest_pnfs --server [options] .SH DESCRIPTION Verify basic pNFS functionality for file (both READ and WRITE), including opening a second file within the same mount and having a lock on the file. Also, verify basic pNFS functionality for a file opened for both READ and WRITE while reading the file first and then writing to it or the other way around by writing to the file fist and then reading the file. These tests verify proper functionality of pNFS and NFSv4.1 as well. .SH OPTIONS .IP "--version" show program's version number and exit .IP "-h, --help" show this help message and exit .IP "-f FILE, --file=FILE" File where options are specified besides the system wide file /etc/nfstest, user wide file $HOME/.nfstest or in the current directory .nfstest file .SS NFS specific options: .IP "-s SERVER, --server=SERVER" Server name or IP address .IP "-e EXPORT, --export=EXPORT" Exported file system to mount [default: '/'] .IP "--nfsversion=NFSVERSION" NFS version, e.g., 3, 4, 4.1, etc. [default: 4.1] .IP "-m MTPOINT, --mtpoint=MTPOINT" Mount point [default: '/mnt/t'] .IP "-p PORT, --port=PORT" NFS server port [default: 2049] .IP "--proto=PROTO" NFS protocol name [default: 'tcp'] .IP "--sec=SEC" Security flavor [default: 'sys'] .IP "--nconnect=NCONNECT" Multiple TCP connections option [default: '1'] .IP "-o MTOPTS, --mtopts=MTOPTS" Mount options [default: 'hard,rsize=4096,wsize=4096'] .IP "--datadir=DATADIR" Data directory where files are created, directory is created on the mount point [default: ''] .SS Logging options: .IP "-v VERBOSE, --verbose=VERBOSE" Verbose level for debug messages [default: \t'opts|info|dbg1|dbg2|dbg3'] .IP "--tverbose=TVERBOSE" Verbose level for test messages [default: '1'] .IP "--createlog" Create log file .IP "--rexeclog" Create rexec log files .IP "--warnings" Display warnings .IP "--tag=TAG" Informational tag, it is displayed as an INFO message [default: ''] .IP "--notty" Do not use terminal colors on output .IP "--isatty" Use terminal colors on output -- useful when running with nohup .SS Packet trace options: .IP "--createtraces" Create a packet trace for each test .IP "--tbsize=TBSIZE" Capture buffer size for tcpdump [default: 192k] .IP "--trcdelay=TRCDELAY" Seconds to delay before stopping packet trace [default: 2.0] .IP "--keeptraces" Do not remove any trace files [default: remove trace files if no errors] .IP "--rmtraces" Remove trace files [default: remove trace files if no errors] .IP "-i INTERFACE, --interface=INTERFACE" Device interface [default: automatically selected] .SS File options: .IP "--nfiles=NFILES" Number of files to create [default: 2] .IP "--filesize=FILESIZE" File size to use for test files [default: 64k] .IP "--rsize=RSIZE" Read size to use when reading files [default: 4k] .IP "--wsize=WSIZE" Write size to use when writing files [default: 4k] .IP "--iodelay=IODELAY" Seconds to delay I/O operations [default: 0.1] .IP "--offset-delta=OFFSET_DELTA" Read/Write offset delta [default: 4k] .SS Path options: .IP "--sudo=SUDO" Full path of binary for sudo [default: '/usr/bin/sudo'] .IP "--kill=KILL" Full path of binary for kill [default: '/usr/bin/kill'] .IP "--nfsstat=NFSSTAT" Full path of binary for nfsstat [default: '/usr/sbin/nfsstat'] .IP "--tcpdump=TCPDUMP" Full path of binary for tcpdump [default: '/usr/sbin/tcpdump'] .IP "--iptables=IPTABLES" Full path of binary for iptables [default: '/usr/sbin/iptables'] .IP "--messages=MESSAGES" Full path of log messages file [default: '/var/log/messages'] .IP "--trcevents=TRCEVENTS" Full path of tracing events directory [default: \t'/sys/kernel/debug/tracing/events'] .IP "--trcpipe=TRCPIPE" Full path of trace pipe file [default: \t'/sys/kernel/debug/tracing/trace_pipe'] .IP "--tmpdir=TMPDIR" Temporary directory [default: '/tmp'] .SS Debug options: .IP "--nocleanup" Do not cleanup created files .IP "--notimestamps" Do not display timestamps in debug messages .IP "--bugmsgs=BUGMSGS" File containing test messages to mark as bugs if they failed .IP "--nomount" Do not mount server and run the tests on local disk space .IP "--basename=BASENAME" Base name for all files and logs [default: automatically generated] .IP "--nfsdebug=NFSDEBUG" Set NFS kernel debug flags and save log messages [default: ''] .IP "--rpcdebug=RPCDEBUG" Set RPC kernel debug flags and save log messages [default: ''] .IP "--tracepoints=TRACEPOINTS" List of trace points modules to enable [default: ''] .IP "--nfsstats" Get NFS stats [default: 'False'] .IP "--pktdisp" Display main packets related to the given test .IP "--nfserrors" Fail every NFS error found in the packet trace .IP "--client-ipaddr=CLIENT_IPADDR" IP address of localhost .SS Reporting options: .IP "--xunit-report" Generate xUnit compatible test report .IP "--xunit-report-file=XUNIT_REPORT_FILE" Path to xout report file .SS Test options: .IP "--runtest=RUNTEST" Comma separated list of tests to run, if list starts with a '^' then all tests are run except the ones listed [default: 'all'] .SH TESTS .SS read .nf Verify basic pNFS functionality on a couple of files opened for reading within the same mount. .fi .SS write .nf 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. .fi .SS read_write .nf 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. .fi .SS write_read .nf 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. .fi .SS read_lock .nf Verify traffic for locked file opened for reading using pNFS. .fi .SS write_lock .nf Verify traffic for locked file opened for writing using pNFS. .fi .SS setattr .nf Verify setattr traffic for file using pNFS. .fi .SS setattr_lock .nf Verify setattr traffic for locked file using pNFS. .fi .SS rw_read .nf Verify traffic for file opened for read and write: reading file first. .fi .SS rw_write .nf Verify traffic for file opened for read and write: writing file first. .fi .SS one_ds .nf Verify client only connects to the DS with I/O. .fi .SS rsize .nf Verify traffic for file using pNFS when mount option rsize < 4096. .fi .SS wsize .nf Verify traffic for file using pNFS when mount option wsize < 4096. .fi .SS rwsize .nf Verify traffic for file using pNFS when mount option rsize < 4096 and wsize < 4096. .fi .SS nfsvers .nf 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 .fi .SS all .nf 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 .fi .SH EXAMPLES The only required option is --server .br $ nfstest_pnfs --server 192.168.0.11 .SH 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. .SH SEE ALSO .BR formatstr(3), .BR nfstest.test_util(3), .BR nfstest_alloc(1), .BR nfstest_cache(1), .BR nfstest_delegation(1), .BR nfstest_dio(1), .BR nfstest_fcmp(1), .BR nfstest_file(1), .BR nfstest_interop(1), .BR nfstest_io(1), .BR nfstest_lock(1), .BR nfstest_pkt(1), .BR nfstest_posix(1), .BR nfstest_rdma(1), .BR nfstest_sparse(1), .BR nfstest_ssc(1), .BR nfstest_xattr(1), .BR nfstest_xid(1), .BR packet.nfs.nfs4_const(3) .SH BUGS No known bugs. .SH AUTHOR Jorge Mora (mora@netapp.com)