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] [-m|--max-protocol LEVEL] [-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 -m|--max-protocol PROTOCOL_NAME
43 This allows the user to select the highest SMB protocol level that
44 smbcquotas will use to connect to the server. By default this is
45 set to NT1, which is the highest available SMB1 protocol. To
46 connect using SMB2 or SMB3 protocol, use the strings SMB2 or SMB3
47 respectively.
48 -t|--test-args
50 Don't actually do anything, only validate the correctness of the
51 arguments.
52 -v|--verbose
54 Be verbose.
55 -d|--debuglevel=level
57 level is an integer from 0 to 10. The default value if this
58 parameter is not specified is 0.
59 The higher this value, the more detail will be logged to the log
61 files about the activities of the server. At level 0, only critical
62 errors and serious warnings will be logged. Level 1 is a reasonable
63 level for day-to-day running - it generates a small amount of
64 information about operations carried out.
65 Levels above 1 will generate considerable amounts of log data, and
67 should only be used when investigating a problem. Levels above 3
68 are designed for use only by developers and generate HUGE amounts
69 of log data, most of which is extremely cryptic.
70 Note that specifying this parameter here will override the log
72 level parameter in the smb.conf file.
73 -V|--version
75 Prints the program version number.
76 -s|--configfile=<configuration file>
78 The file specified contains the configuration details required by
79 the server. The information in this file includes server-specific
80 information such as what printcap file to use, as well as
81 descriptions of all the services that the server is to provide. See
82 smb.conf for more information. The default configuration file name
83 is determined at compile time.
84 -l|--log-basename=logdirectory
86 Base directory name for log/debug files. The extension ".progname"
87 will be appended (e.g. log.smbclient, log.smbd, etc...). The log
88 file is never removed by the client.
89 --option=<name>=<value>
91 Set the smb.conf(5) option "<name>" to value "<value>" from the
92 command line. This overrides compiled-in defaults and options read
93 from the configuration file.
94 -N|--no-pass
96 If specified, this parameter suppresses the normal password prompt
97 from the client to the user. This is useful when accessing a
98 service that does not require a password.
99 Unless a password is specified on the command line or this
101 parameter is specified, the client will request a password.
102 If a password is specified on the command line and this option is
104 also defined the password on the command line will be silently
105 ignored and no password will be used.
106 -k|--kerberos
108 Try to authenticate with kerberos. Only useful in an Active
109 Directory environment.
110 -C|--use-ccache
112 Try to use the credentials cached by winbind.
113 -A|--authentication-file=filename
115 This option allows you to specify a file from which to read the
116 username and password used in the connection. The format of the
117 file is
118 username = <value>
120 password = <value>
121 domain = <value>
122 Make certain that the permissions on the file restrict access from
124 unwanted users.
125 -U|--user=username[%password]
127 Sets the SMB username or username and password.
128 If %password is not specified, the user will be prompted. The
130 client will first check the USER environment variable, then the
131 LOGNAME variable and if either exists, the string is uppercased. If
132 these environmental variables are not found, the username GUEST is
133 used.
134 A third option is to use a credentials file which contains the
136 plaintext of the username and password. This option is mainly
137 provided for scripts where the admin does not wish to pass the
138 credentials on the command line or via environment variables. If
139 this method is used, make certain that the permissions on the file
140 restrict access from unwanted users. See the -A for more details.
141 Be cautious about including passwords in scripts. Also, on many
143 systems the command line of a running process may be seen via the
144 ps command. To be safe always allow rpcclient to prompt for a
145 password and type it in directly.
146 -S|--signing on|off|required
148 Set the client signing state.
149 -P|--machine-pass
151 Use stored machine account password.
152 -e|--encrypt
154 This command line parameter requires the remote server support the
155 UNIX extensions or that the SMB3 protocol has been selected.
156 Requests that the connection be encrypted. Negotiates SMB
157 encryption using either SMB3 or POSIX extensions via GSSAPI. Uses
158 the given credentials for the encryption negotiation (either
159 kerberos or NTLMv1/v2 if given domain/username/password triple.
160 Fails the connection if encryption cannot be negotiated.
161 --pw-nt-hash
163 The supplied password is the NT hash.
164 -?|--help
166 Print a summary of command line options.
167 --usage
169 Display brief usage message.
170
172 The format of an the QUOTA_SET_COMMAND is an operation name followed by
173 a set of parameters specific to that operation.
174 To set user quotas for the user specified by -u or for the current
176 username:
177 UQLIM:<username>:<softlimit>/<hardlimit>
179 To set the default quotas for a share:
181 FSQLIM:<softlimit>/<hardlimit>
183 To change the share quota settings:
185 FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT
187 All limits are specified as a number of bytes.
189
191 The smbcquotas program sets the exit status depending on the success or
192 otherwise of the operations performed. The exit status may be one of
193 the following values.
194 If the operation succeeded, smbcquotas returns an exit status of 0. If
196 smbcquotas couldn't connect to the specified server, or when there was
197 an error getting or setting the quota(s), an exit status of 1 is
198 returned. If there was an error parsing any command line arguments, an
199 exit status of 2 is returned.
200
202 This man page is part of version 4.14.5 of the Samba suite.
203
205 The original Samba software and related utilities were created by
206 Andrew Tridgell. Samba is now developed by the Samba Team as an Open
207 Source project similar to the way the Linux kernel is developed.
208 smbcquotas was written by Stefan Metzmacher.
210Samba 4.14.5 06/01/2021 SMBCQUOTAS(1)