summaryrefslogtreecommitdiff
path: root/docs/htmldocs/smbcquotas.1.html
blob: 478c03cdaab189175f8335145aa57aeb93290b47 (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
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbcquotas</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbcquotas.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smbcquotas &#8212; Set or get QUOTAs of NTFS 5 shares</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt>smbcquotas</tt>  {//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><div class="refsect1" lang="en"><h2>DESCRIPTION</h2><p>This tool is part of the <a href="Samba.7.html">Samba(7)</a> suite.</p><p>The <b>smbcquotas</b> program manipulates NT Quotas on SMB file shares. </p></div><div class="refsect1" lang="en"><h2>OPTIONS</h2><p>The following options are available to the <b>smbcquotas</b> program. </p><div class="variablelist"><dl><dt><span class="term">-u user</span></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><span class="term">-L</span></dt><dd><p>Lists all quota records of the share.</p></dd><dt><span class="term">-F</span></dt><dd><p>Show the share quota status and default limits.</p></dd><dt><span class="term">-S QUOTA_SET_COMMAND</span></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><span class="term">-n</span></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><span class="term">-t</span></dt><dd><p>
		Don't actually do anything, only validate the correctness of 
		the arguments.
		</p></dd><dt><span class="term">-v</span></dt><dd><p>
		Be verbose.
		</p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options.
</p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the version number for 
<b>smbd</b>.</p></dd><dt><span class="term">-s &lt;configuration file&gt;</span></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>
smb.conf(5)</tt></a> for more information.
The default configuration file name is determined at 
compile time.</p></dd><dt><span class="term">-d|--debug=debuglevel</span></dt><dd><p><i><tt>debuglevel</tt></i> 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>smb.conf(5)</tt></a> file.</p></dd><dt><span class="term">-l|--logfile=logbasename</span></dt><dd><p>File name for log/debug files. The extension
<tt>&quot;.client&quot;</tt> will be appended. The log file is
never removed by the client.
</p></dd><dt><span class="term">-N</span></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><span class="term">-k</span></dt><dd><p>
Try to authenticate with kerberos. Only useful in
an Active Directory environment.
</p></dd><dt><span class="term">-A|--authfile=filename</span></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><pre class="programlisting">
username = &lt;value&gt;
password = &lt;value&gt;
domain   = &lt;value&gt;
</pre><p>Make certain that the permissions on the file restrict 
access from unwanted users. </p></dd><dt><span class="term">-U|--user=username[%password]</span></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 <tt>USER</tt> environment variable, then the
<tt>LOGNAME</tt> variable and if either exists, the
string is uppercased. If these environmental variables are not
found, the username <tt>GUEST</tt> 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
<i><tt>-A</tt></i> 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>ps</b> command.  To be safe always allow
<b>rpcclient</b> to prompt for a password and type
it in directly. </p></dd></dl></div></div><div class="refsect1" lang="en"><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><b><tt>
	UQLIM:&lt;username&gt;&lt;softlimit&gt;&lt;hardlimit&gt;
	</tt></b></p><p>
	for setting the share quota defaults limits:
	</p><p><b><tt>
	FSQLIM:&lt;softlimit&gt;&lt;hardlimit&gt;
	</tt></b></p><p>
	for changing the share quota settings:
	</p><p><b><tt>
	FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT
	</tt></b></p></div><div class="refsect1" lang="en"><h2>EXIT STATUS</h2><p>The <b>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>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" lang="en"><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba suite.</p></div><div class="refsect1" lang="en"><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>smbcacls</b> was written by Stefan Metzmacher.</p></div></div></body></html>