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 /etc/samba/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 /etc/samba/smb.conf for more information.
93           The default 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 /etc/samba/smb.conf file parameter (name resolve order) will be
150           used.
151
152           The default order is lmhosts, host, wins, bcast. Without this
153           parameter or any entry in the name resolve order parameter of the
154           /etc/samba/smb.conf file, the name resolution methods will be
155           attempted in this order.
156
157       -O|--socket-options=SOCKETOPTIONS
158           TCP socket options to set on the client socket. See the socket
159           options parameter in the /etc/samba/smb.conf manual page for the
160           list of valid options.
161
162       -m|--max-protocol=MAXPROTOCOL
163           The value of the parameter (a string) is the highest protocol level
164           that will be supported by the client.
165
166           Note that specifying this parameter here will override the client
167           max protocol parameter in the /etc/samba/smb.conf file.
168
169       -n|--netbiosname=NETBIOSNAME
170           This option allows you to override the NetBIOS name that Samba uses
171           for itself. This is identical to setting the netbios name parameter
172           in the /etc/samba/smb.conf file. However, a command line setting
173           will take precedence over settings in /etc/samba/smb.conf.
174
175       --netbios-scope=SCOPE
176           This specifies a NetBIOS scope that nmblookup will use to
177           communicate with when generating NetBIOS names. For details on the
178           use of NetBIOS scopes, see rfc1001.txt and rfc1002.txt. NetBIOS
179           scopes are very rarely used, only set this parameter if you are the
180           system administrator in charge of all the NetBIOS systems you
181           communicate with.
182
183       -W|--workgroup=WORKGROUP
184           Set the SMB domain of the username. This overrides the default
185           domain which is the domain defined in smb.conf. If the domain
186           specified is the same as the servers NetBIOS name, it causes the
187           client to log on using the servers local SAM (as opposed to the
188           Domain SAM).
189
190           Note that specifying this parameter here will override the
191           workgroup parameter in the /etc/samba/smb.conf file.
192
193       -r|--realm=REALM
194           Set the realm for the domain.
195
196           Note that specifying this parameter here will override the realm
197           parameter in the /etc/samba/smb.conf file.
198
199       -U|--user=[DOMAIN\]USERNAME[%PASSWORD]
200           Sets the SMB username or username and password.
201
202           If %PASSWORD is not specified, the user will be prompted. The
203           client will first check the USER environment variable (which is
204           also permitted to also contain the password separated by a %), then
205           the LOGNAME variable (which is not permitted to contain a password)
206           and if either exists, the value is used. If these environmental
207           variables are not found, the username found in a Kerberos
208           Credentials cache may be used.
209
210           A third option is to use a credentials file which contains the
211           plaintext of the username and password. This option is mainly
212           provided for scripts where the admin does not wish to pass the
213           credentials on the command line or via environment variables. If
214           this method is used, make certain that the permissions on the file
215           restrict access from unwanted users. See the -A for more details.
216
217           Be cautious about including passwords in scripts or passing
218           user-supplied values onto the command line. For security it is
219           better to let the Samba client tool ask for the password if needed,
220           or obtain the password once with kinit.
221
222           While Samba will attempt to scrub the password from the process
223           title (as seen in ps), this is after startup and so is subject to a
224           race.
225
226       -N|--no-pass
227           If specified, this parameter suppresses the normal password prompt
228           from the client to the user. This is useful when accessing a
229           service that does not require a password.
230
231           Unless a password is specified on the command line or this
232           parameter is specified, the client will request a password.
233
234           If a password is specified on the command line and this option is
235           also defined the password on the command line will be silently
236           ignored and no password will be used.
237
238       --password
239           Specify the password on the commandline.
240
241           Be cautious about including passwords in scripts or passing
242           user-supplied values onto the command line. For security it is
243           better to let the Samba client tool ask for the password if needed,
244           or obtain the password once with kinit.
245
246           If --password is not specified, the tool will check the PASSWD
247           environment variable, followed by PASSWD_FD which is expected to
248           contain an open file descriptor (FD) number.
249
250           Finally it will check PASSWD_FILE (containing a file path to be
251           opened). The file should only contain the password. Make certain
252           that the permissions on the file restrict access from unwanted
253           users!
254
255           While Samba will attempt to scrub the password from the process
256           title (as seen in ps), this is after startup and so is subject to a
257           race.
258
259       --pw-nt-hash
260           The supplied password is the NT hash.
261
262       -A|--authentication-file=filename
263           This option allows you to specify a file from which to read the
264           username and password used in the connection. The format of the
265           file is:
266
267                                   username = <value>
268                                   password = <value>
269                                   domain   = <value>
270
271
272           Make certain that the permissions on the file restrict access from
273           unwanted users!
274
275       -P|--machine-pass
276           Use stored machine account password.
277
278       --simple-bind-dn=DN
279           DN to use for a simple bind.
280
281       --use-kerberos=desired|required|off
282           This parameter determines whether Samba client tools will try to
283           authenticate using Kerberos. For Kerberos authentication you need
284           to use dns names instead of IP addresses when connecting to a
285           service.
286
287           Note that specifying this parameter here will override the client
288           use kerberos parameter in the /etc/samba/smb.conf file.
289
290       --use-krb5-ccache=CCACHE
291           Specifies the credential cache location for Kerberos
292           authentication.
293
294           This will set --use-kerberos=required too.
295
296       --use-winbind-ccache
297           Try to use the credential cache by winbind.
298
299       --client-protection=sign|encrypt|off
300           Sets the connection protection the client tool should use.
301
302           Note that specifying this parameter here will override the client
303           protection parameter in the /etc/samba/smb.conf file.
304
305           In case you need more fine grained control you can use:
306           --option=clientsmbencrypt=OPTION, --option=clientipcsigning=OPTION,
307           --option=clientsigning=OPTION.
308

QUOTA_SET_COMMAND

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

EXIT STATUS

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

VERSION

340       This man page is part of version 4.17.5 of the Samba suite.
341

AUTHOR

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