1 <samba:parameter name="get quota command"
4 advanced="1" developer="1"
5 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
7 <para>The <command>get quota command</command> should only be used
8 whenever there is no operating system API available from the OS that
11 <para>This option is only available with <command>./configure --with-sys-quotas</command>.
12 Or on linux when <command>./configure --with-quotas</command> was used and a working quota api
13 was found in the system.</para>
15 <para>This parameter should specify the path to a script that
16 queries the quota information for the specified
17 user/group for the partition that
18 the specified directory is on.</para>
20 <para>Such a script should take 3 arguments:</para>
23 <listitem><para>directory</para></listitem>
24 <listitem><para>type of query</para></listitem>
25 <listitem><para>uid of user or gid of group</para></listitem>
28 <para>The type of query can be one of :</para>
31 <listitem><para>1 - user quotas</para></listitem>
32 <listitem><para>2 - user default quotas (uid = -1)</para></listitem>
33 <listitem><para>3 - group quotas</para></listitem>
34 <listitem><para>4 - group default quotas (gid = -1)</para></listitem>
37 <para>This script should print one line as output with spaces between the arguments. The arguments are:
41 <listitem><para>Arg 1 - quota flags (0 = no quotas, 1 = quotas enabled, 2 = quotas enabled and enforced)</para></listitem>
42 <listitem><para>Arg 2 - number of currently used blocks</para></listitem>
43 <listitem><para>Arg 3 - the softlimit number of blocks</para></listitem>
44 <listitem><para>Arg 4 - the hardlimit number of blocks</para></listitem>
45 <listitem><para>Arg 5 - currently used number of inodes</para></listitem>
46 <listitem><para>Arg 6 - the softlimit number of inodes</para></listitem>
47 <listitem><para>Arg 7 - the hardlimit number of inodes</para></listitem>
48 <listitem><para>Arg 8(optional) - the number of bytes in a block(default is 1024)</para></listitem>
52 <related>set quote command</related>
53 <value type="default"></value>
54 <value type="example">/usr/local/sbin/query_quota</value>