1SMBCQUOTAS(1)                                                    SMBCQUOTAS(1)
2
3
4

NAME

6       smbcquotas - Set or get QUOTAs of NTFS 5 shares
7

SYNOPSIS

9       smbcquotas  {//server/share} [-u user] [-L] [-F] [-S QUOTA_SET_COMMAND]
10        [-n]  [-t]  [-v]  [-d debuglevel]  [-s configfile]  [-l logdir]   [-V]
11        [-U username] [-N] [-k] [-A]
12

DESCRIPTION

14       This tool is part of the samba(7) suite.
15
16       The smbcquotas program manipulates NT Quotas on SMB file shares.
17

OPTIONS

19       The following options are available to the smbcquotas program.
20
21       -u user
22          Specifies the user of whom the quotas are get or set. By default the
23          current user's username will be used.
24
25       -L
26          Lists all quota records of the share.
27
28       -F
29          Show the share quota status and default limits.
30
31       -S QUOTA_SET_COMMAND
32          This command sets/modifies quotas  for  a  user  or  on  the  share,
33          depending  on  the  QUOTA_SET_COMMAND  parameter  which is described
34          later.
35
36       -n
37          This option displays all QUOTA information in  numeric  format.  The
38          default  is  to convert SIDs to names and QUOTA limits to a readable
39          string format.
40
41       -t
42          Don't actually do anything, only validate  the  correctness  of  the
43          arguments.
44
45       -v
46          Be verbose.
47
48       -h|--help
49          Print a summary of command line options.
50
51       -V
52          Prints the program version number.
53
54       -s <configuration file>
55          The  file  specified  contains the configuration details required by
56          the server. The information in this  file  includes  server-specific
57          information  such  as what printcap file to use, as well as descrip‐
58          tions of all the  services  that  the  server  is  to  provide.  See
59          smb.conf  for  more information. The default configuration file name
60          is determined at compile time.
61
62       -d|--debuglevel=level
63          level is an integer from 0 to 10. The default value if this  parame‐
64          ter is not specified is zero.
65
66          The  higher  this  value,  the more detail will be logged to the log
67          files about the activities of the server. At level 0, only  critical
68          errors  and serious warnings will be logged. Level 1 is a reasonable
69          level for day-to-day running - it generates a small amount of infor‐
70          mation about operations carried out.
71
72          Levels  above  1 will generate considerable amounts of log data, and
73          should only be used when investigating a problem. Levels above 3 are
74          designed for use only by developers and generate HUGE amounts of log
75          data, most of which is extremely cryptic.
76
77          Note that specifying this parameter here will override the
78
79          parameter in the smb.conf file.
80
81       -l|--logfile=logdirectory
82          Base directory name for log/debug files. The  extension  ".progname"
83          will  be  appended  (e.g.  log.smbclient, log.smbd, etc...). The log
84          file is never removed by the client.
85
86       -N
87          If specified, this parameter suppresses the normal  password  prompt
88          from the client to the user. This is useful when accessing a service
89          that does not require a password.
90
91          Unless a password is specified on the command line or this parameter
92          is specified, the client will request a password.
93
94          If  a  password  is specified on the command line and this option is
95          also defined the password on the command line will be silently  ing‐
96          nored and no password will be used.
97
98       -k
99          Try  to  authenticate with kerberos. Only useful in an Active Direc‐
100          tory environment.
101
102       -A|--authentication-file=filename
103          This option allows you to specify a file  from  which  to  read  the
104          username and password used in the connection. The format of the file
105          is
106
107
108
109
110
111          username = <value>
112          password = <value>
113          domain   = <value>
114
115
116
117          Make certain that the permissions on the file restrict  access  from
118          unwanted users.
119
120       -U|--user=username[%password]
121          Sets the SMB username or username and password.
122
123          If %password is not specified, the user will be prompted. The client
124          will first check the USER environment  variable,  then  the  LOGNAME
125          variable  and  if  either exists, the string is uppercased. If these
126          environmental variables are not found, the username GUEST is used.
127
128          A third option is to use  a  credentials  file  which  contains  the
129          plaintext  of  the username and password. This option is mainly pro‐
130          vided for scripts where the admin does not wish to pass the  creden‐
131          tials  on  the  command  line  or via environment variables. If this
132          method is used, make  certain  that  the  permissions  on  the  file
133          restrict access from unwanted users. See the -A for more details.
134
135          Be cautious about including passwords in scripts. Also, on many sys‐
136          tems the command line of a running process may be seen  via  the  ps
137          command.  To be safe always allow rpcclient to prompt for a password
138          and type it in directly.
139

QUOTA_SET_COMAND

141       The format of an the QUOTA_SET_COMMAND is an operation name followed by
142       a set of parameters specific to that operation.
143
144       To  set  user  quotas  for  the user specified by -u or for the current
145       username:
146
147        UQLIM:<username>:<softlimit>/<hardlimit>
148
149       To set the default quotas for a share:
150
151        FSQLIM:<softlimit>/<hardlimit>
152
153       To change the share quota settings:
154
155        FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT
156
157       All limits are specified as a number of bytes.
158

EXIT STATUS

160       The smbcquotas program sets the exit status depending on the success or
161       otherwise  of  the  operations performed. The exit status may be one of
162       the following values.
163
164       If the operation succeeded, smbcquotas returns an exit status of 0.  If
165       smbcquotas  couldn't connect to the specified server, or when there was
166       an error getting or setting the  quota(s),  an  exit  status  of  1  is
167       returned.  If there was an error parsing any command line arguments, an
168       exit status of 2 is returned.
169

VERSION

171       This man page is correct for version 3.0 of the Samba suite.
172

AUTHOR

174       The original Samba software  and  related  utilities  were  created  by
175       Andrew  Tridgell.  Samba  is now developed by the Samba Team as an Open
176       Source project similar to the way the Linux kernel is developed.
177
178       smbcquotas was written by Stefan Metzmacher.
179
180
181
182
183                                                                 SMBCQUOTAS(1)
Impressum