1VFSTEST(1)                       User Commands                      VFSTEST(1)
2
3
4

NAME

6       vfstest - tool for testing samba VFS modules
7

SYNOPSIS

9       vfstest [-?|--help] [--usage] [-f|--file=STRING] [-c|--command=STRING]
10        [-m|--memreport=INT] [-d|--debuglevel=DEBUGLEVEL] [--debug-stdout]
11        [--configfile=CONFIGFILE] [--option=name=value]
12        [-l|--log-basename=LOGFILEBASE] [--leak-report] [--leak-report-full]
13        [-V|--version]
14

DESCRIPTION

16       This tool is part of the samba(7) suite.
17
18       vfstest is a small command line utility that has the ability to test
19       dso samba VFS modules. It gives the user the ability to call the
20       various VFS functions manually and supports cascaded VFS modules.
21

OPTIONS

23       -c|--command=command
24           Execute the specified (semicolon-separated) commands. See below for
25           the commands that are available.
26
27       -?|--help
28           Print a summary of command line options.
29
30       --usage
31           Display brief usage message.
32
33       -d|--debuglevel=DEBUGLEVEL
34           level is an integer from 0 to 10. The default value if this
35           parameter is not specified is 1 for client applications.
36
37           The higher this value, the more detail will be logged to the log
38           files about the activities of the server. At level 0, only critical
39           errors and serious warnings will be logged. Level 1 is a reasonable
40           level for day-to-day running - it generates a small amount of
41           information about operations carried out.
42
43           Levels above 1 will generate considerable amounts of log data, and
44           should only be used when investigating a problem. Levels above 3
45           are designed for use only by developers and generate HUGE amounts
46           of log data, most of which is extremely cryptic.
47
48           Note that specifying this parameter here will override the log
49           level parameter in the smb.conf file.
50
51       --debug-stdout
52           This will redirect debug output to STDOUT. By default all clients
53           are logging to STDERR.
54
55       --configfile=<configuration file>
56           The file specified contains the configuration details required by
57           the client. The information in this file can be general for client
58           and server or only provide client specific like options such as
59           client smb encrypt. See smb.conf for more information. The default
60           configuration file name is determined at compile time.
61
62       --option=<name>=<value>
63           Set the smb.conf(5) option "<name>" to value "<value>" from the
64           command line. This overrides compiled-in defaults and options read
65           from the configuration file. If a name or a value includes a space,
66           wrap whole --option=name=value into quotes.
67
68       -l|--log-basename=logdirectory
69           Base directory name for log/debug files. The extension ".progname"
70           will be appended (e.g. log.smbclient, log.smbd, etc...). The log
71           file is never removed by the client.
72
73       --leak-report
74           Enable talloc leak reporting on exit.
75
76       --leak-report-full
77           Enable full talloc leak reporting on exit.
78
79       -V|--version
80           Prints the program version number.
81

COMMANDS

83       VFS COMMANDS
84
85              •   load <module.so> - Load specified VFS module
86
87              •   populate <char> <size> - Populate a data buffer with the
88                  specified data
89
90              •   showdata [<offset> <len>] - Show data currently in data
91                  buffer
92
93              •   connect - VFS connect()
94
95              •   disconnect - VFS disconnect()
96
97              •   disk_free - VFS disk_free()
98
99              •   opendir - VFS opendir()
100
101              •   readdir - VFS readdir()
102
103              •   mkdir - VFS mkdir()
104
105              •   rmdir - VFS rmdir()
106
107              •   closedir - VFS closedir()
108
109              •   open - VFS open()
110
111              •   close - VFS close()
112
113              •   read - VFS read()
114
115              •   write - VFS write()
116
117              •   lseek - VFS lseek()
118
119              •   rename - VFS rename()
120
121              •   fsync - VFS fsync()
122
123              •   stat - VFS stat()
124
125              •   fstat - VFS fstat()
126
127              •   lstat - VFS lstat()
128
129              •   unlink - VFS unlink()
130
131              •   chmod - VFS chmod()
132
133              •   fchmod - VFS fchmod()
134
135              •   chown - VFS chown()
136
137              •   fchown - VFS fchown()
138
139              •   chdir - VFS chdir()
140
141              •   getwd - VFS getwd()
142
143              •   utime - VFS utime()
144
145              •   ftruncate - VFS ftruncate()
146
147              •   lock - VFS lock()
148
149              •   symlink - VFS symlink()
150
151              •   readlink - VFS readlink()
152
153              •   link - VFS link()
154
155              •   mknod - VFS mknod()
156
157              •   realpath - VFS realpath()
158
159              •   getxattr - VFS getxattr()
160
161              •   listxattr - VFS listxattr()
162
163              •   setxattr - VFS setxattr()
164
165              •   removexattr - VFS removexattr()
166
167              •   fget_nt_acl - VFS fget_nt_acl()
168
169              •   get_nt_acl - VFS get_nt_acl()
170
171              •   fset_nt_acl - VFS fset_nt_acl()
172
173              •   set_nt_acl - VFS open() and fset_nt_acl()
174
175              •   sys_acl_get_file - VFS sys_acl_get_file()
176
177              •   sys_acl_get_fd - VFS sys_acl_get_fd()
178
179              •   sys_acl_blob_get_file - VFS sys_acl_blob_get_file()
180
181              •   sys_acl_blob_get_fd - VFS sys_acl_blob_get_fd()
182
183              •   sys_acl_delete_def_file - VFS sys_acl_delete_def_file()
184
185              •   test_chain - test chain code
186
187              •   translate_name - VFS translate_name()
188
189
190       GENERAL COMMANDS
191
192              •   conf <smb.conf> - Load a different configuration file
193
194              •   help [<command>] - Get list of commands or info about
195                  specified command
196
197              •   debuglevel <level> - Set debug level
198
199              •   freemem - Free memory currently in use
200
201              •   exit - Exit vfstest
202

VERSION

204       This man page is part of version 4.15.2 of the Samba suite.
205

AUTHOR

207       The original Samba software and related utilities were created by
208       Andrew Tridgell. Samba is now developed by the Samba Team as an Open
209       Source project similar to the way the Linux kernel is developed.
210
211       The vfstest man page was written by Jelmer Vernooij. Updated version by
212       Guenter Kukkukk.
213
214
215
216Samba 4.15.2                      11/13/2021                        VFSTEST(1)