summaryrefslogtreecommitdiff
path: root/docs/htmldocs/smbcquotas.1.html
blob: 334f08bbb97a99390178e370ad0fc32924c80c53 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML
><HEAD
><TITLE
>smbcquotas</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><H1
><A
NAME="SMBCQUOTAS.1"
></A
>smbcquotas</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5"
></A
><H2
>Name</H2
>smbcquotas&nbsp;--&nbsp;Set or get QUOTAs of NTFS 5 shares</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN8"
></A
><H2
>Synopsis</H2
><P
><B
CLASS="COMMAND"
>smbcquotas</B
>  {//server/share} [-u user] [-L] [-F] [-S QUOTA_SET_COMMAND] [-n] [-t] [-v] [-d debuglevel] [-s configfile] [-l logfilebase] [-V] [-U username] [-N] [-k] [-A]</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN27"
></A
><H2
>DESCRIPTION</H2
><P
>This tool is part of the <SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>Samba</SPAN
>(7)</SPAN
> suite.</P
><P
>The <B
CLASS="COMMAND"
>smbcquotas</B
> program manipulates NT Quotas on SMB file shares. </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN35"
></A
><H2
>OPTIONS</H2
><P
>The following options are available to the <B
CLASS="COMMAND"
>smbcquotas</B
> program. </P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>-u user</DT
><DD
><P
> Specifies the user of whom the quotas are get or set.
		By default the current user's username will be used.</P
></DD
><DT
>-L</DT
><DD
><P
>Lists all quota records of the share.</P
></DD
><DT
>-F</DT
><DD
><P
>Show the share quota status and default limits.</P
></DD
><DT
>-S QUOTA_SET_COMMAND</DT
><DD
><P
>This command set/modify quotas for a user or on the share,
		depending on the QUOTA_SET_COMMAND parameter witch is described later</P
></DD
><DT
>-n</DT
><DD
><P
>This option displays all QUOTA information in numeric 
		format.  The default is to convert SIDs to names and QUOTA limits 
		to a readable string format.  </P
></DD
><DT
>-t</DT
><DD
><P
>		Don't actually do anything, only validate the correctness of 
		the arguments.
		</P
></DD
><DT
>-v</DT
><DD
><P
>		Be verbose.
		</P
></DD
><DT
>-h|--help</DT
><DD
><P
>Print a summary of command line options.</P
></DD
><DT
>-V</DT
><DD
><P
>Prints the version number for 
<B
CLASS="COMMAND"
>smbd</B
>.</P
></DD
><DT
>-s &#60;configuration file&#62;</DT
><DD
><P
>The file specified contains the 
configuration details required by the server.  The 
information in this file includes server-specific
information such as what printcap file to use, as well 
as descriptions of all the services that the server is 
to provide. See <A
HREF="smb.conf.5.html"
TARGET="_top"
><TT
CLASS="FILENAME"
>smb.conf(5)</TT
></A
> for more information.
The default configuration file name is determined at 
compile time.</P
></DD
><DT
>-d|--debug=debuglevel</DT
><DD
><P
><VAR
CLASS="REPLACEABLE"
>debuglevel</VAR
> is an integer 
from 0 to 10.  The default value if this parameter is 
not specified is zero.</P
><P
>The higher this value, the more detail will be 
logged to the log files about the activities of the 
server. At level 0, only critical errors and serious 
warnings will be logged. Level 1 is a reasonable level for
day to day running - it generates a small amount of 
information about operations carried out.</P
><P
>Levels above 1 will generate considerable 
amounts of log data, and should only be used when 
investigating a problem. Levels above 3 are designed for 
use only by developers and generate HUGE amounts of log
data, most of which is extremely cryptic.</P
><P
>Note that specifying this parameter here will 
override the <A
HREF="smb.conf.5.html#loglevel"
TARGET="_top"
>log
level</A
> parameter in the <A
HREF="smb.conf.5.html"
TARGET="_top"
><TT
CLASS="FILENAME"
>smb.conf(5)</TT
></A
> file.</P
></DD
><DT
>-l|--logfile=logbasename</DT
><DD
><P
>File name for log/debug files. The extension
<CODE
CLASS="CONSTANT"
>".client"</CODE
> will be appended. The log file is
never removed by the client.</P
></DD
><DT
>-N</DT
><DD
><P
>If specified, this parameter suppresses the normal
password prompt from the client to the user. This is useful when
accessing a service that does not require a password. </P
><P
>Unless a password is specified on the command line or
this parameter is specified, the client will request a
password.</P
></DD
><DT
>-k</DT
><DD
><P
>Try to authenticate with kerberos. Only useful in
an Active Directory environment.</P
></DD
><DT
>-A|--authfile=filename</DT
><DD
><P
>This option allows
you to specify a file from which to read the username and
password used in the connection.  The format of the file is</P
><P
><PRE
CLASS="PROGRAMLISTING"
>username = &#60;value&#62;
password = &#60;value&#62;
domain   = &#60;value&#62;</PRE
></P
><P
>Make certain that the permissions on the file restrict 
access from unwanted users. </P
></DD
><DT
>-U|--user=username[%password]</DT
><DD
><P
>Sets the SMB username or username and password. </P
><P
>If %password is not specified, the user will be prompted. The
client will first check the <VAR
CLASS="ENVAR"
>USER</VAR
> environment variable, then the
<VAR
CLASS="ENVAR"
>LOGNAME</VAR
> variable and if either exists, the
string is uppercased. If these environmental variables are not
found, the username <CODE
CLASS="CONSTANT"
>GUEST</CODE
> is used. </P
><P
>A third option is to use a credentials file which
contains the plaintext of the username and password.  This
option is mainly provided for scripts where the admin does not
wish to pass the credentials on the command line or via environment
variables. If this method is used, make certain that the permissions
on the file restrict access from unwanted users.  See the
<VAR
CLASS="PARAMETER"
>-A</VAR
> for more details. </P
><P
>Be cautious about including passwords in scripts. Also, on
many systems the command line of a running process may be seen
via the <B
CLASS="COMMAND"
>ps</B
> command.  To be safe always allow
<B
CLASS="COMMAND"
>rpcclient</B
> to prompt for a password and type
it in directly. </P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN128"
></A
><H2
>QUOTA_SET_COMAND</H2
><P
>The format of an ACL is one or more ACL entries separated by 
	either commas or newlines.  An ACL entry is one of the following: </P
><P
>	for user setting quotas for the specified by -u or the current username:
	</P
><P
><KBD
CLASS="USERINPUT"
>	UQLIM:&#60;username&#62;&#60;softlimit&#62;&#60;hardlimit&#62;
	</KBD
></P
><P
>	for setting the share quota defaults limits:
	</P
><P
><KBD
CLASS="USERINPUT"
>	FSQLIM:&#60;softlimit&#62;&#60;hardlimit&#62;
	</KBD
></P
><P
>	for changing the share quota settings:
	</P
><P
><KBD
CLASS="USERINPUT"
>	FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT
	</KBD
></P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN140"
></A
><H2
>EXIT STATUS</H2
><P
>The <B
CLASS="COMMAND"
>smbcquotas</B
> program sets the exit status
	depending on the success or otherwise of the operations performed.
	The exit status may be one of the following values. </P
><P
>If the operation succeeded, smbcquotas returns an exit
	status of 0.  If <B
CLASS="COMMAND"
>smbcquotas</B
> couldn't connect to the specified server,
	or when there was an error getting or setting the quota(s), an exit status
	of 1 is returned.  If there was an error parsing any command line
	arguments, an exit status of 2 is returned. </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN146"
></A
><H2
>VERSION</H2
><P
>This man page is correct for version 3.0 of the Samba suite.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN149"
></A
><H2
>AUTHOR</H2
><P
>The original Samba software and related utilities
	were created by Andrew Tridgell. Samba is now developed
	by the Samba Team as an Open Source project similar
	to the way the Linux kernel is developed.</P
><P
><B
CLASS="COMMAND"
>smbcacls</B
> was written by Stefan Metzmacher.</P
></DIV
></BODY
></HTML
>