docs/htmldocs/smbcquotas.1.html

   1 <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.60.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><div></div></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 class="command">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"><span class="citerefentry"><span class="refentrytitle">Samba</span>(7)</span></a> suite.</p><p>The <b class="command">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 class="command">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.
   2                 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,
   3                 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
   4                 format.  The default is to convert SIDs to names and QUOTA limits
   5                 to a readable string format.  </p></dd><dt><span class="term">-t</span></dt><dd><p>
   6                 Don't actually do anything, only validate the correctness of
   7                 the arguments.
   8                 </p></dd><dt><span class="term">-v</span></dt><dd><p>
   9                 Be verbose.
  10                 </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options.
  11 </p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the version number for
  12 <b class="command">smbd</b>.</p></dd><dt><span class="term">-s &lt;configuration file&gt;</span></dt><dd><p>The file specified contains the
  13 configuration details required by the server.  The
  14 information in this file includes server-specific
  15 information such as what printcap file to use, as well
  16 as descriptions of all the services that the server is
  17 to provide. See <a href="smb.conf.5.html" target="_top"><tt class="filename">
  18 smb.conf(5)</tt></a> for more information.
  19 The default configuration file name is determined at
  20 compile time.</p></dd><dt><span class="term">-d|--debug=debuglevel</span></dt><dd><p><i class="replaceable"><tt>debuglevel</tt></i> is an integer
  21 from 0 to 10.  The default value if this parameter is
  22 not specified is zero.</p><p>The higher this value, the more detail will be
  23 logged to the log files about the activities of the
  24 server. At level 0, only critical errors and serious
  25 warnings will be logged. Level 1 is a reasonable level for
  26 day to day running - it generates a small amount of
  27 information about operations carried out.</p><p>Levels above 1 will generate considerable
  28 amounts of log data, and should only be used when
  29 investigating a problem. Levels above 3 are designed for
  30 use only by developers and generate HUGE amounts of log
  31 data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will
  32 override the <a href="smb.conf.5.html#loglevel" target="_top">log
  33 level</a> parameter in the <a href="smb.conf.5.html" target="_top">
  34 <tt class="filename">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
  35 <tt class="constant">&quot;.client&quot;</tt> will be appended. The log file is
  36 never removed by the client.
  37 </p></dd><dt><span class="term">-N</span></dt><dd><p>If specified, this parameter suppresses the normal
  38 password prompt from the client to the user. This is useful when
  39 accessing a service that does not require a password. </p><p>Unless a password is specified on the command line or
  40 this parameter is specified, the client will request a
  41 password.</p></dd><dt><span class="term">-k</span></dt><dd><p>
  42 Try to authenticate with kerberos. Only useful in
  43 an Active Directory environment.
  44 </p></dd><dt><span class="term">-A|--authfile=filename</span></dt><dd><p>This option allows
  45 you to specify a file from which to read the username and
  46 password used in the connection.  The format of the file is
  47 </p><pre class="programlisting">
  48 username = &lt;value&gt;
  49 password = &lt;value&gt;
  50 domain   = &lt;value&gt;
  51 </pre><p>Make certain that the permissions on the file restrict
  52 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
  53 client will first check the <tt class="envar">USER</tt> environment variable, then the
  54 <tt class="envar">LOGNAME</tt> variable and if either exists, the
  55 string is uppercased. If these environmental variables are not
  56 found, the username <tt class="constant">GUEST</tt> is used. </p><p>A third option is to use a credentials file which
  57 contains the plaintext of the username and password.  This
  58 option is mainly provided for scripts where the admin does not
  59 wish to pass the credentials on the command line or via environment
  60 variables. If this method is used, make certain that the permissions
  61 on the file restrict access from unwanted users.  See the
  62 <i class="parameter"><tt>-A</tt></i> for more details. </p><p>Be cautious about including passwords in scripts. Also, on
  63 many systems the command line of a running process may be seen
  64 via the <b class="command">ps</b> command.  To be safe always allow
  65 <b class="command">rpcclient</b> to prompt for a password and type
  66 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
  67         either commas or newlines.  An ACL entry is one of the following: </p><p>
  68         for user setting quotas for the specified by -u or the current username:
  69         </p><p><b class="userinput"><tt>
  70         UQLIM:&lt;username&gt;&lt;softlimit&gt;&lt;hardlimit&gt;
  71         </tt></b></p><p>
  72         for setting the share quota defaults limits:
  73         </p><p><b class="userinput"><tt>
  74         FSQLIM:&lt;softlimit&gt;&lt;hardlimit&gt;
  75         </tt></b></p><p>
  76         for changing the share quota settings:
  77         </p><p><b class="userinput"><tt>
  78         FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT
  79         </tt></b></p></div><div class="refsect1" lang="en"><h2>EXIT STATUS</h2><p>The <b class="command">smbcquotas</b> program sets the exit status
  80         depending on the success or otherwise of the operations performed.
  81         The exit status may be one of the following values. </p><p>If the operation succeeded, smbcquotas returns an exit
  82         status of 0.  If <b class="command">smbcquotas</b> couldn't connect to the specified server,
  83         or when there was an error getting or setting the quota(s), an exit status
  84         of 1 is returned.  If there was an error parsing any command line
  85         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
  86         were created by Andrew Tridgell. Samba is now developed
  87         by the Samba Team as an Open Source project similar
  88         to the way the Linux kernel is developed.</p><p><b class="command">smbcacls</b> was written by Stefan Metzmacher.</p></div></div></body></html>