.\" DO NOT MODIFY THIS FILE!  It was generated by setup.py 1.2.
.TH NFSTEST_CACHE 1 "21 March 2023" "NFStest 3.2" "nfstest_cache 1.0.1"
.SH NAME
nfstest_cache - NFS client side caching tests
.SH SYNOPSIS
nfstest_cache --server <server> --client <client> [options]
.SH DESCRIPTION
Verify consistency of attribute caching by varying acregmin, acregmax,
acdirmin, acdirmax and actimo. Verify consistency of data caching by varying
acregmin, acregmax, acdirmin, acdirmax and actimo.

Valid for any version of NFS.


.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: 32]
.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']
.IP "--client=CLIENT"
Remote NFS client
.IP "--justbefore=JUSTBEFORE"
Time in seconds to test a condition just before it is expected to
come true [default: 2]
.IP "--acmin=ACMIN"
Comma separated values to use for acregmin/acdirmin/actimeo
[default: 10]
.IP "--acmax=ACMAX"
Comma separated values to use for acregmax/acdirmax, first value of
acmin will be used as acregmin/acdirmin [default: 20]
.SH TESTS
.SS acregmin_attr
.nf
Verify consistency of attribute caching by varying the
acregmin NFS option.

The cached information is assumed to be valid for attrtimeo
which starts at acregmin.
.fi
.SS acregmax_attr
.nf
Verify consistency of attribute caching by varying the
acregmax NFS option.

The cached information is assumed to be valid for attrtimeo which
starts at acregmin. An attribute revalidation to the server
that shows no attribute change doubles attrtimeo up to acregmax.
An attribute revalidation to the server that shows a change has
occurred resets it to acregmin.
.fi
.SS acdirmin_attr
.nf
Verify consistency of attribute caching by varying the
acdirmin NFS option.

The cached information is assumed to be valid for attrtimeo
which starts at acdirmin. Test that this is so.
.fi
.SS acdirmax_attr
.nf
Verify consistency of attribute caching by varying the
acdirmax NFS option.

The cached information is assumed to be valid for attrtimeo which
starts at acdirmin. An attribute revalidation to the server
that shows no attribute change doubles attrtimeo up to acdirmax.
An attribute revalidation to the server that shows a change has
occurred resets it to acdirmin.
.fi
.SS actimeo_attr
.nf
Verify consistency of attribute caching by varying the
actimeo NFS option.

The cached information is assumed to be valid for attrtimeo
which starts and ends at actimeo.
.fi
.SS acregmin_data
.nf
Verify consistency of data caching by varying the
acregmin NFS option.
.fi
.SS acregmax_data
.nf
Verify consistency of data caching by varying the
acregmax NFS option.

The cached information is assumed to be valid for attrtimeo which
starts at acregmin. An attribute revalidation to the server
that shows no attribute change doubles attrtimeo up to acregmax.
An attribute revalidation to the server that shows a change has
occurred resets it to acregmin.
.fi
.SS acdirmin_data
.nf
Verify consistency of data caching by varying the
acdirmin NFS option.

The cached information is assumed to be valid for attrtimeo
which starts at acdirmin. Test that this is so.
.fi
.SS acdirmax_data
.nf
Verify consistency of data caching by varying the
acdirmax NFS option.

The cached information is assumed to be valid for attrtimeo which
starts at acdirmin. An attribute revalidation to the server
that shows no attribute change doubles attrtimeo up to acdirmax.
An attribute revalidation to the server that shows a change has
occurred resets it to acdirmin.
.fi
.SS actimeo_data
.nf
Verify consistency of data caching by varying the
actimeo NFS option.

The cached information is assumed to be valid for attrtimeo
which starts and ends at actimeo.
.fi
.SS all
.nf
Run all tests: acregmin_attr, acregmax_attr, acdirmin_attr,
acdirmax_attr, actimeo_attr, acregmin_data, acregmax_data,
acdirmin_data, acdirmax_data, actimeo_data
.fi
.SH EXAMPLES
Required options are --server and --client
.br
$ nfstest_cache --server 192.168.0.11 --client 192.168.0.20

Testing with different values of --acmin and --acmax (this takes a long time)
.br
$ nfstest_cache --server 192.168.0.11 --client 192.168.0.20 --acmin 10,20 --acmax 20,30,60,80
.SH NOTES
The user id in the local host and the host specified by --client must
have access to run commands as root using the 'sudo' command without
the need for a password.

The user id must be able to 'ssh' to remote host without the need for
a password.
.SH SEE ALSO
.BR nfstest.test_util(3),
.BR nfstest_alloc(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_pnfs(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)

.SH BUGS
No known bugs.
.SH AUTHOR
Jorge Mora (mora@netapp.com)