1SMBCQUOTAS(1) User Commands SMBCQUOTAS(1)
2
6 smbcquotas - Set or get QUOTAs of NTFS 5 shares
7
9 smbcquotas {//server/share} [-u|--user user] [-L|--list] [-F|--fs]
10 [-S|--set QUOTA_SET_COMMAND] [-n|--numeric] [-t|--test-args]
11 [-v|--verbose] [-d debuglevel] [-s configfile] [-l logdir] [-V]
12 [-U username] [-N] [-k] [-A]
13
15 This tool is part of the samba(7) suite.
16 The smbcquotas program manipulates NT Quotas on SMB file shares.
18
20 The following options are available to the smbcquotas program.
21 -u|--user user
23 Specifies the user of whom the quotas are get or set. By default
24 the current user´s username will be used.
25 -L|--list
27 Lists all quota records of the share.
28 -F|--fs
30 Show the share quota status and default limits.
31 -S|--set QUOTA_SET_COMMAND
33 This command sets/modifies quotas for a user or on the share,
34 depending on the QUOTA_SET_COMMAND parameter which is described
35 later.
36 -n|--numeric
38 This option displays all QUOTA information in numeric format. The
39 default is to convert SIDs to names and QUOTA limits to a readable
40 string format.
41 -t|--test-args
43 Don´t actually do anything, only validate the correctness of the
44 arguments.
45 -v|--verbose
47 Be verbose.
48 -d|--debuglevel=level
50 level is an integer from 0 to 10. The default value if this
51 parameter is not specified is 0.
52 The higher this value, the more detail will be logged to the log
54 files about the activities of the server. At level 0, only critical
55 errors and serious warnings will be logged. Level 1 is a reasonable
56 level for day-to-day running - it generates a small amount of
57 information about operations carried out.
58 Levels above 1 will generate considerable amounts of log data, and
60 should only be used when investigating a problem. Levels above 3
61 are designed for use only by developers and generate HUGE amounts
62 of log data, most of which is extremely cryptic.
63 Note that specifying this parameter here will override the log
65 level parameter in the smb.conf file.
66 -V|--version
68 Prints the program version number.
69 -s|--configfile=<configuration file>
71 The file specified contains the configuration details required by
72 the server. The information in this file includes server-specific
73 information such as what printcap file to use, as well as
74 descriptions of all the services that the server is to provide. See
75 smb.conf for more information. The default configuration file name
76 is determined at compile time.
77 -l|--log-basename=logdirectory
79 Base directory name for log/debug files. The extension ".progname"
80 will be appended (e.g. log.smbclient, log.smbd, etc...). The log
81 file is never removed by the client.
82 --option=<name>=<value>
84 Set the smb.conf(5) option "<name>" to value "<value>" from the
85 command line. This overrides compiled-in defaults and options read
86 from the configuration file.
87 -N|--no-pass
89 If specified, this parameter suppresses the normal password prompt
90 from the client to the user. This is useful when accessing a
91 service that does not require a password.
92 Unless a password is specified on the command line or this
94 parameter is specified, the client will request a password.
95 If a password is specified on the command line and this option is
97 also defined the password on the command line will be silently
98 ingnored and no password will be used.
99 -k|--kerberos
101 Try to authenticate with kerberos. Only useful in an Active
102 Directory environment.
103 -C|--use-ccache
105 Try to use the credentials cached by winbind.
106 -A|--authentication-file=filename
108 This option allows you to specify a file from which to read the
109 username and password used in the connection. The format of the
110 file is
111 username = <value>
113 password = <value>
114 domain = <value>
115 Make certain that the permissions on the file restrict access from
117 unwanted users.
118 -U|--user=username[%password]
120 Sets the SMB username or username and password.
121 If %password is not specified, the user will be prompted. The
123 client will first check the USER environment variable, then the
124 LOGNAME variable and if either exists, the string is uppercased. If
125 these environmental variables are not found, the username GUEST is
126 used.
127 A third option is to use a credentials file which contains the
129 plaintext of the username and password. This option is mainly
130 provided for scripts where the admin does not wish to pass the
131 credentials on the command line or via environment variables. If
132 this method is used, make certain that the permissions on the file
133 restrict access from unwanted users. See the -A for more details.
134 Be cautious about including passwords in scripts. Also, on many
136 systems the command line of a running process may be seen via the
137 ps command. To be safe always allow rpcclient to prompt for a
138 password and type it in directly.
139 -S|--signing on|off|required
141 Set the client signing state.
142 -P|--machine-pass
144 Use stored machine account password.
145 -e|--encrypt
147 This command line parameter requires the remote server support the
148 UNIX extensions or that the SMB3 protocol has been selected.
149 Requests that the connection be encrypted. Negotiates SMB
150 encryption using either SMB3 or POSIX extensions via GSSAPI. Uses
151 the given credentials for the encryption negotiation (either
152 kerberos or NTLMv1/v2 if given domain/username/password triple.
153 Fails the connection if encryption cannot be negotiated.
154 --pw-nt-hash
156 The supplied password is the NT hash.
157 -?|--help
159 Print a summary of command line options.
160 --usage
162 Display brief usage message.
163
165 The format of an the QUOTA_SET_COMMAND is an operation name followed by
166 a set of parameters specific to that operation.
167 To set user quotas for the user specified by -u or for the current
169 username:
170 UQLIM:<username>:<softlimit>/<hardlimit>
172 To set the default quotas for a share:
174 FSQLIM:<softlimit>/<hardlimit>
176 To change the share quota settings:
178 FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT
180 All limits are specified as a number of bytes.
182
184 The smbcquotas program sets the exit status depending on the success or
185 otherwise of the operations performed. The exit status may be one of
186 the following values.
187 If the operation succeeded, smbcquotas returns an exit status of 0. If
189 smbcquotas couldn´t connect to the specified server, or when there was
190 an error getting or setting the quota(s), an exit status of 1 is
191 returned. If there was an error parsing any command line arguments, an
192 exit status of 2 is returned.
193
195 This man page is correct for version 3 of the Samba suite.
196
198 The original Samba software and related utilities were created by
199 Andrew Tridgell. Samba is now developed by the Samba Team as an Open
200 Source project similar to the way the Linux kernel is developed.
201 smbcquotas was written by Stefan Metzmacher.
203Samba 4.2 06/19/2018 SMBCQUOTAS(1)