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

NAME

6       smbcquotas - Set or get QUOTAs of NTFS 5 shares
7

SYNOPSIS

9       smbcquotas {//server/share} [-u|--quota-user=USER] [-L|--list]
10        [-F|--fs] [-S|--set=SETSTRING] [-n|--numeric] [-v|--verbose]
11        [-t|--test-args] [-?|--help] [--usage] [-d|--debuglevel=DEBUGLEVEL]
12        [--debug-stdout] [--configfile=CONFIGFILE] [--option=name=value]
13        [-l|--log-basename=LOGFILEBASE] [--leak-report] [--leak-report-full]
14        [-R|--name-resolve=NAME-RESOLVE-ORDER]
15        [-O|--socket-options=SOCKETOPTIONS] [-m|--max-protocol=MAXPROTOCOL]
16        [-n|--netbiosname=NETBIOSNAME] [--netbios-scope=SCOPE]
17        [-W|--workgroup=WORKGROUP] [--realm=REALM]
18        [-U|--user=[DOMAIN/]USERNAME[%PASSWORD]] [-N|--no-pass]
19        [--password=STRING] [--pw-nt-hash] [-A|--authentication-file=FILE]
20        [-P|--machine-pass] [--simple-bind-dn=DN]
21        [--use-kerberos=desired|required|off] [--use-krb5-ccache=CCACHE]
22        [--use-winbind-ccache] [--client-protection=sign|encrypt|off]
23        [-V|--version]
24

DESCRIPTION

26       This tool is part of the samba(7) suite.
27
28       The smbcquotas program manipulates NT Quotas on SMB file shares.
29

OPTIONS

31       The following options are available to the smbcquotas program.
32
33       -u|--quota-user user
34           Specifies the user of whom the quotas are get or set. By default
35           the current user's username will be used.
36
37       -L|--list
38           Lists all quota records of the share.
39
40       -F|--fs
41           Show the share quota status and default limits.
42
43       -S|--set QUOTA_SET_COMMAND
44           This command sets/modifies quotas for a user or on the share,
45           depending on the QUOTA_SET_COMMAND parameter which is described
46           later.
47
48       -n|--numeric
49           This option displays all QUOTA information in numeric format. The
50           default is to convert SIDs to names and QUOTA limits to a readable
51           string format.
52
53       -t|--test-args
54           Don't actually do anything, only validate the correctness of the
55           arguments.
56
57       -v|--verbose
58           Be verbose.
59
60       -?|--help
61           Print a summary of command line options.
62
63       --usage
64           Display brief usage message.
65
66       -d|--debuglevel=DEBUGLEVEL
67           level is an integer from 0 to 10. The default value if this
68           parameter is not specified is 1 for client applications.
69
70           The higher this value, the more detail will be logged to the log
71           files about the activities of the server. At level 0, only critical
72           errors and serious warnings will be logged. Level 1 is a reasonable
73           level for day-to-day running - it generates a small amount of
74           information about operations carried out.
75
76           Levels above 1 will generate considerable amounts of log data, and
77           should only be used when investigating a problem. Levels above 3
78           are designed for use only by developers and generate HUGE amounts
79           of log data, most of which is extremely cryptic.
80
81           Note that specifying this parameter here will override the log
82           level parameter in the smb.conf file.
83
84       --debug-stdout
85           This will redirect debug output to STDOUT. By default all clients
86           are logging to STDERR.
87
88       --configfile=<configuration file>
89           The file specified contains the configuration details required by
90           the client. The information in this file can be general for client
91           and server or only provide client specific like options such as
92           client smb encrypt. See smb.conf for more information. The default
93           configuration file name is determined at compile time.
94
95       --option=<name>=<value>
96           Set the smb.conf(5) option "<name>" to value "<value>" from the
97           command line. This overrides compiled-in defaults and options read
98           from the configuration file. If a name or a value includes a space,
99           wrap whole --option=name=value into quotes.
100
101       -l|--log-basename=logdirectory
102           Base directory name for log/debug files. The extension ".progname"
103           will be appended (e.g. log.smbclient, log.smbd, etc...). The log
104           file is never removed by the client.
105
106       --leak-report
107           Enable talloc leak reporting on exit.
108
109       --leak-report-full
110           Enable full talloc leak reporting on exit.
111
112       -V|--version
113           Prints the program version number.
114
115       -R|--name-resolve=NAME-RESOLVE-ORDER
116           This option is used to determine what naming services and in what
117           order to resolve host names to IP addresses. The option takes a
118           space-separated string of different name resolution options. The
119           best ist to wrap the whole --name-resolve=NAME-RESOLVE-ORDER into
120           quotes.
121
122           The options are: "lmhosts", "host", "wins" and "bcast". They cause
123           names to be resolved as follows:
124
125lmhosts: Lookup an IP address in the Samba lmhosts file.
126                      If the line in lmhosts has no name type attached to the
127                      NetBIOS name (see the lmhosts(5) for details) then any
128                      name type matches for lookup.
129
130host: Do a standard host name to IP address resolution,
131                      using the system /etc/hosts, NIS, or DNS lookups. This
132                      method of name resolution is operating system dependent,
133                      for instance on IRIX or Solaris this may be controlled
134                      by the /etc/nsswitch.conf file). Note that this method
135                      is only used if the NetBIOS name type being queried is
136                      the 0x20 (server) name type, otherwise it is ignored.
137
138wins: Query a name with the IP address listed in the
139                      wins server parameter. If no WINS server has been
140                      specified this method will be ignored.
141
142bcast: Do a broadcast on each of the known local
143                      interfaces listed in the interfaces parameter. This is
144                      the least reliable of the name resolution methods as it
145                      depends on the target host being on a locally connected
146                      subnet.
147
148           If this parameter is not set then the name resolve order defined in
149           the smb.conf file parameter (name resolve order) will be used.
150
151           The default order is lmhosts, host, wins, bcast. Without this
152           parameter or any entry in the name resolve order parameter of the
153           smb.conf file, the name resolution methods will be attempted in
154           this order.
155
156       -O|--socket-options=SOCKETOPTIONS
157           TCP socket options to set on the client socket. See the socket
158           options parameter in the smb.conf manual page for the list of valid
159           options.
160
161       -m|--max-protocol=MAXPROTOCOL
162           The value of the parameter (a string) is the highest protocol level
163           that will be supported by the client.
164
165           Note that specifying this parameter here will override the client
166           max protocol parameter in the smb.conf file.
167
168       -n|--netbiosname=NETBIOSNAME
169           This option allows you to override the NetBIOS name that Samba uses
170           for itself. This is identical to setting the netbios name parameter
171           in the smb.conf file. However, a command line setting will take
172           precedence over settings in smb.conf.
173
174       --netbios-scope=SCOPE
175           This specifies a NetBIOS scope that nmblookup will use to
176           communicate with when generating NetBIOS names. For details on the
177           use of NetBIOS scopes, see rfc1001.txt and rfc1002.txt. NetBIOS
178           scopes are very rarely used, only set this parameter if you are the
179           system administrator in charge of all the NetBIOS systems you
180           communicate with.
181
182       -W|--workgroup=WORKGROUP
183           Set the SMB domain of the username. This overrides the default
184           domain which is the domain defined in smb.conf. If the domain
185           specified is the same as the servers NetBIOS name, it causes the
186           client to log on using the servers local SAM (as opposed to the
187           Domain SAM).
188
189           Note that specifying this parameter here will override the
190           workgroup parameter in the smb.conf file.
191
192       -r|--realm=REALM
193           Set the realm for the domain.
194
195           Note that specifying this parameter here will override the realm
196           parameter in the smb.conf file.
197
198       -U|--user=[DOMAIN\]USERNAME[%PASSWORD]
199           Sets the SMB username or username and password.
200
201           If %PASSWORD is not specified, the user will be prompted. The
202           client will first check the USER environment variable (which is
203           also permitted to also contain the password seperated by a %), then
204           the LOGNAME variable (which is not permitted to contain a password)
205           and if either exists, the value is used. If these environmental
206           variables are not found, the username found in a Kerberos
207           Credentials cache may be used.
208
209           A third option is to use a credentials file which contains the
210           plaintext of the username and password. This option is mainly
211           provided for scripts where the admin does not wish to pass the
212           credentials on the command line or via environment variables. If
213           this method is used, make certain that the permissions on the file
214           restrict access from unwanted users. See the -A for more details.
215
216           Be cautious about including passwords in scripts or passing
217           user-supplied values onto the command line. For security it is
218           better to let the Samba client tool ask for the password if needed,
219           or obtain the password once with kinit.
220
221           While Samba will attempt to scrub the password from the process
222           title (as seen in ps), this is after startup and so is subject to a
223           race.
224
225       -N|--no-pass
226           If specified, this parameter suppresses the normal password prompt
227           from the client to the user. This is useful when accessing a
228           service that does not require a password.
229
230           Unless a password is specified on the command line or this
231           parameter is specified, the client will request a password.
232
233           If a password is specified on the command line and this option is
234           also defined the password on the command line will be silently
235           ignored and no password will be used.
236
237       --password
238           Specify the password on the commandline.
239
240           Be cautious about including passwords in scripts or passing
241           user-supplied values onto the command line. For security it is
242           better to let the Samba client tool ask for the password if needed,
243           or obtain the password once with kinit.
244
245           If --password is not specified, the tool will check the PASSWD
246           environment variable, followed by PASSWD_FD which is expected to
247           contain an open file descriptor (FD) number.
248
249           Finally it will check PASSWD_FILE (containing a file path to be
250           opened). The file should only contain the password. Make certain
251           that the permissions on the file restrict access from unwanted
252           users!
253
254           While Samba will attempt to scrub the password from the process
255           title (as seen in ps), this is after startup and so is subject to a
256           race.
257
258       --pw-nt-hash
259           The supplied password is the NT hash.
260
261       -A|--authentication-file=filename
262           This option allows you to specify a file from which to read the
263           username and password used in the connection. The format of the
264           file is:
265
266                                   username = <value>
267                                   password = <value>
268                                   domain   = <value>
269
270
271           Make certain that the permissions on the file restrict access from
272           unwanted users!
273
274       -P|--machine-pass
275           Use stored machine account password.
276
277       --simple-bind-dn=DN
278           DN to use for a simple bind.
279
280       --use-kerberos=desired|required|off
281           This parameter determines whether Samba client tools will try to
282           authenticate using Kerberos. For Kerberos authentication you need
283           to use dns names instead of IP addresses when connnecting to a
284           service.
285
286           Note that specifying this parameter here will override the client
287           use kerberos parameter in the smb.conf file.
288
289       --use-krb5-ccache=CCACHE
290           Specifies the credential cache location for Kerberos
291           authentication.
292
293           This will set --use-kerberos=required too.
294
295       --use-winbind-ccache
296           Try to use the credential cache by winbind.
297
298       --client-protection=sign|encrypt|off
299           Sets the connection protection the client tool should use.
300
301           Note that specifying this parameter here will override the client
302           protection parameter in the smb.conf file.
303
304           In case you need more fine grained control you can use:
305           --option=clientsmbencrypt=OPTION, --option=clientipcsigning=OPTION,
306           --option=clientsigning=OPTION.
307

QUOTA_SET_COMMAND

309       The format of an the QUOTA_SET_COMMAND is an operation name followed by
310       a set of parameters specific to that operation.
311
312       To set user quotas for the user specified by -u or for the current
313       username:
314
315        UQLIM:<username>:<softlimit>/<hardlimit>
316
317       To set the default quotas for a share:
318
319        FSQLIM:<softlimit>/<hardlimit>
320
321       To change the share quota settings:
322
323        FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT
324
325       All limits are specified as a number of bytes.
326

EXIT STATUS

328       The smbcquotas program sets the exit status depending on the success or
329       otherwise of the operations performed. The exit status may be one of
330       the following values.
331
332       If the operation succeeded, smbcquotas returns an exit status of 0. If
333       smbcquotas couldn't connect to the specified server, or when there was
334       an error getting or setting the quota(s), an exit status of 1 is
335       returned. If there was an error parsing any command line arguments, an
336       exit status of 2 is returned.
337

VERSION

339       This man page is part of version 4.15.2 of the Samba suite.
340

AUTHOR

342       The original Samba software and related utilities were created by
343       Andrew Tridgell. Samba is now developed by the Samba Team as an Open
344       Source project similar to the way the Linux kernel is developed.
345
346       smbcquotas was written by Stefan Metzmacher.
347
348
349
350Samba 4.15.2                      11/13/2021                     SMBCQUOTAS(1)
Impressum