SMBCQUOTAS(1)

📦
version 4.24.7 · 27 versions
, in fedora 44

✨ SMBCQUOTAS ✨ (aka smbcquotas, section 1, User Commands — hi bestie 💖)

🌸 NAME 🌸

smbcquotas — Set or get QUOTAs of NTFS 5 shares. That's the whole vibe, no cap.

🦋 SYNOPSIS 🦋

smbcquotas {//server/share} [-u|--quota-user=USER] [-L|--list] [-F|--fs]
 [-S|--set=SETSTRING] [-n|--numeric] [-v|--verbose] [-t|--test-args]
 [-?|--help] [--usage] [-d|--debuglevel=DEBUGLEVEL] [--debug-stdout]
 [--configfile=CONFIGFILE] [--option=name=value]
 [-l|--log-basename=LOGFILEBASE] [--leak-report] [--leak-report-full]
 [-R|--name-resolve=NAME-RESOLVE-ORDER]
 [-O|--socket-options=SOCKETOPTIONS] [-m|--max-protocol=MAXPROTOCOL]
 [-n|--netbiosname=NETBIOSNAME] [--netbios-scope=SCOPE]
 [-W|--workgroup=WORKGROUP] [--realm=REALM]
 [-U|--user=[DOMAIN/]USERNAME[%PASSWORD]] [-N|--no-pass]
 [--password=STRING] [--pw-nt-hash] [-A|--authentication-file=FILE]
 [-P|--machine-pass] [--simple-bind-dn=DN]
 [--use-kerberos=desired|required|off] [--use-krb5-ccache=CCACHE]
 [--use-winbind-ccache] [--client-protection=sign|encrypt|off]
 [-V|--version]

💅 DESCRIPTION 💅

Okay so, first thing: this tool is part of the samba(7) suite. You already knew that though, iykyk.

The smbcquotas program manipulates NT Quotas on SMB file shares. That's the mission. Quotas. NT quotas. SMB shares. Slay.

👑 OPTIONS 👑

The following options are available to the smbcquotas program. Buckle up, there's a lot, and honestly? Every single one is here. We don't skip. Periodt.

  • -u|--quota-user user — Says which user we're getting or setting the quotas for. Don't say anything and it just defaults to the current user's username. Comfy.
  • -L|--list — Lists all the quota records of the share. Full roster, no crumbs.
  • -F|--fs — Shows you the share quota status plus the default limits. The big picture, the lore.
  • -S|--set QUOTA_SET_COMMAND — This one sets/modifies quotas for a user or on the share, depending on the QUOTA_SET_COMMAND parameter — which gets described later in this page. Stay tuned bestie, it's giving ✨sequel✨.
  • -n|--numeric — Displays all QUOTA info in numeric format. By default it converts SIDs to names and QUOTA limits into a readable string format instead. So if you want raw numbers, this is your girl.
  • -t|--test-args — Does absolutely nothing, it just validates whether your arguments are correct. A dry run. A dress rehearsal. Iconic behaviour honestly.
  • -v|--verbose — Be verbose. Talk more. Spill.
  • -?|--help — Prints a summary of the command line options. The lil cheat sheet.
  • --usage — Displays a brief usage message. Short and sweet.
  • -d|--debuglevel=level — level is an integer from 0 to 10. If you don't specify this parameter, the default value is 1 for client applications.

The higher the value, the more detail gets logged to the log files about what the server is doing. At level 0, only critical errors and serious warnings get logged. Level 1 is a reasonable level for day-to-day running — it generates a small amount of information about operations carried out.

Levels above 1 generate considerable amounts of log data, and should only be used when investigating a problem. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic. Like, we're talking 💀 levels of text.

Note that specifying this parameter here will override the log level parameter in the /etc/samba/smb.conf file.
  • --debug-stdout — This redirects debug output to STDOUT. By default all clients are logging to STDERR. Little glow-up for your logs.
  • --configfile=<configuration file> — The file you name here contains the configuration details the client needs. The info in this file can be general for client and server, or it can only provide client-specific stuff like options such as client smb encrypt. See /etc/samba/smb.conf for more info. The default configuration file name is determined at compile time.
  • --option=<name>=<value> — Sets the smb.conf(5) option "<name>" to value "<value>" straight from the command line. This overrides compiled-in defaults and options read from the configuration file. If a name or a value includes a space, wrap the whole --option=name=value into quotes. Quote it, bestie, or it will not eat.
  • -l|--log-basename=logdirectory — Base directory name for log/debug files. The extension ".progname" gets appended (e.g. log.smbclient, log.smbd, etc...). The log file is never removed by the client. It simply persists. Main character energy.
  • --leak-report — Enables talloc leak reporting on exit. Snitching on the memory, but make it polite.
  • --leak-report-full — Enables full talloc leak reporting on exit. The director's cut.
  • -V|--version — Prints the program version number. The birth certificate.
  • -R|--name-resolve=NAME-RESOLVE-ORDER — This option determines what naming services are used, and in what order, to resolve host names to IP addresses. It takes a space-separated string of different name resolution options. Best practice: wrap the whole --name-resolve=NAME-RESOLVE-ORDER into quotes.

The options are: "lmhosts", "host", "wins" and "bcast". Here's what each one does, no gatekeeping:

  • lmhosts: Lookup an IP address in the Samba lmhosts file. If the line in lmhosts has no name type attached to the NetBIOS name (see the lmhosts(5) for details) then any name type matches for lookup.
  • host: Do a standard host name to IP address resolution, using the system /etc/hosts, NIS, or DNS lookups. This method of name resolution is operating system dependent — for instance on IRIX or Solaris this may be controlled by the /etc/nsswitch.conf file). Note that this method is only used if the NetBIOS name type being queried is the 0x20 (server) name type, otherwise it is ignored.
  • wins: Query a name with the IP address listed in the wins server parameter. If no WINS server has been specified this method will be ignored.
  • bcast: Do a broadcast on each of the known local interfaces listed in the interfaces parameter. This is the least reliable of the name resolution methods, because it depends on the target host being on a locally connected subnet. Fragile. Delicate. We still love her.

If this parameter is not set, then the name resolve order defined in the /etc/samba/smb.conf file parameter (name resolve order) will be used.

The default order is lmhosts, host, wins, bcast. Without this parameter, or any entry in the name resolve order parameter of the /etc/samba/smb.conf file, the name resolution methods will be attempted in this order. Defaults stay winning ✨

  • -O|--socket-options=SOCKETOPTIONS — TCP socket options to set on the client socket. See the socket options parameter in the /etc/samba/smb.conf manual page for the list of valid options.
  • -m|--max-protocol=MAXPROTOCOL — The value of the parameter (a string) is the highest protocol level that will be supported by the client. A ceiling. A limit. A boundary.
Note that specifying this parameter here will override the client max protocol parameter in the /etc/samba/smb.conf file.
  • -n|--netbiosname=NETBIOSNAME — Lets you override the NetBIOS name that Samba uses for itself. This is identical to setting the netbios name parameter in the /etc/samba/smb.conf file. However, a command line setting takes precedence over settings in /etc/samba/smb.conf. Command line stays undefeated 💅
  • --netbios-scope=SCOPE — Specifies a NetBIOS scope that nmblookup will use to communicate with when generating NetBIOS names. For details on the use of NetBIOS scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are very rarely used — only set this parameter if you are the system administrator in charge of all the NetBIOS systems you communicate with. Like, all of them. The whole kingdom. 👑
  • -W|--workgroup=WORKGROUP — Sets the SMB domain of the username. This overrides the default domain, which is the domain defined in smb.conf. If the domain you specify is the same as the server's NetBIOS name, it causes the client to log on using the server's local SAM (as opposed to the Domain SAM).
Note that specifying this parameter here will override the workgroup parameter in the /etc/samba/smb.conf file.
  • -r|--realm=REALM — Sets the realm for the domain.
Note that specifying this parameter here will override the realm parameter in the /etc/samba/smb.conf file.
  • -U|--user=[DOMAIN\]USERNAME[%PASSWORD] — Sets the SMB username, or the username and password.

If %PASSWORD is not specified, the user gets prompted. The client first checks the USER environment variable (which is also permitted to contain the password, separated by a %), then the LOGNAME variable (which is not permitted to contain a password) — and if either exists, that value is used. If those environmental variables aren't found, the username found in a Kerberos Credentials cache may be used.

A third option is a credentials file containing the plaintext of the username and password. This is mainly provided for scripts where the admin doesn't want to pass the credentials on the command line or via environment variables. If you use this method, make certain the permissions on the file restrict access from unwanted users. See the -A for more details.

Be cautious about including passwords in scripts or passing user-supplied values onto the command line. For security it is better to let the Samba client tool ask for the password if needed, or obtain the password once with kinit.
While Samba will attempt to scrub the password from the process title (as seen in ps), this is after startup and so is subject to a race. 😭
  • -N|--no-pass — If specified, this parameter suppresses the normal password prompt from the client to the user. Super useful when you're accessing a service that doesn't require a password.

Unless a password is specified on the command line, or this parameter is specified, the client will request a password.

If a password is specified on the command line and this option is also defined, the password on the command line will be silently ignored and no password will be used. Yeah. Silently. It just ghosts it.

  • --password — Specify the password on the commandline.
Be cautious about including passwords in scripts or passing user-supplied values onto the command line. For security it is better to let the Samba client tool ask for the password if needed, or obtain the password once with kinit.

If --password is not specified, the tool checks the PASSWD environment variable, followed by PASSWD_FD — which is expected to contain an open file descriptor (FD) number.

Finally it checks PASSWD_FILE (containing a file path to be opened). The file should only contain the password. Make certain that the permissions on the file restrict access from unwanted users! Fr fr, lock it down 🔒

While Samba will attempt to scrub the password from the process title (as seen in ps), this is after startup and so is subject to a race.
  • --pw-nt-hash — okay so the password you handed over? bestie, that's the NT hash. not the plaintext, the hash. 💅
  • -A|--authentication-file=filename — this one lets you point at a file to read the username and password for the connection out of. the file format is:
                        username = <value>
                        password = <value>
                        domain   = <value>
⚠️ no cap: make certain the permissions on that file lock out anyone you don't want in there. unwanted users stay OUT. 🔒
  • -P|--machine-pass — uses the stored machine account password. that's it, that's the vibe. 🎀
  • --simple-bind-dn=DN — the DN to use for a simple bind. ✨
  • --use-kerberos=desired|required|off — this decides whether the Samba client tools are gonna try to authenticate with Kerberos. for Kerberos auth you should be using DNS names, not IP addresses, when you connect to a service. by default Samba client tools try the default Kerberos credential cache (ccache). and if that ccache doesn't exist, or if the -U|--user option got specified, the clients will ask you to enter a password and will obtain a Kerberos ticket (kinit) for you. 🎟️ if you want an alternative Kerberos credential cache, that's what the --use-krb5-ccache option is for.

heads up: specifying this parameter here will override the client use kerberos parameter in the /etc/samba/smb.conf file.

  • --use-krb5-ccache=CCACHE — specifies the credential cache location for Kerberos authentication.

this will enforce --use-kerberos=required. periodt.

  • --use-winbind-ccache — tries to use the credential cache by winbind. 🦋
  • --client-protection=sign|encrypt|off — sets the connection protection the client tool should use.

also, specifying this parameter here overrides the client protection parameter in the /etc/samba/smb.conf file.

and if you need more fine-grained control, you can use: --option=clientsmbencrypt=OPTION, --option=clientipcsigning=OPTION, --option=clientsigning=OPTION.

🎀 QUOTA_SET_COMMAND 🎀

the format of a QUOTA_SET_COMMAND is an operation name followed by a set of parameters specific to that operation. simple as. 💖

to set user quotas for the user specified by -u, or for the current username:

 UQLIM:<username>:<softlimit>/<hardlimit>

to set the default quotas for a share:

 FSQLIM:<softlimit>/<hardlimit>

to change the share quota settings:

 FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT

all limits are specified as a number of bytes. 🔢

💀 EXIT STATUS 💀

the smbcquotas program sets its exit status based on whether the operations performed succeeded or... didn't. 😭 the exit status may be one of these values:

  1. if the operation succeeded, smbcquotas returns an exit status of 0. slay. ✨
  2. if smbcquotas couldn't connect to the specified server, or when there was an error getting or setting the quota(s), an exit status of 1 is returned. 🙈
  3. if there was an error parsing any command line arguments, an exit status of 2 is returned. 💅

🌈 VERSION 🌈

this man page is part of version 4.24.7 of the Samba suite. 👑

🫶 AUTHOR 🫶

the original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.

smbcquotas was written by Stefan Metzmacher. iconic behaviour, honestly. 💜

and that's the whole page bestie!! 💖 this was Samba 4.24.7, dated 09/09/2026, and you just read SMBCQUOTAS(1). go forth and quota responsibly 🌸✨

📦 where this page comes from