SAMBA-REGEDIT(8)

📦
version 4.24.7 · 27 versions
, in fedora 44

💖 SAMBA-REGEDIT 💖

okay bestie, you found it — the samba-regedit page from the samba(7) suite, the System Administration tools manual, section 8. Sit down, hydrate, we're doing this.

✨ NAME ✨

samba-regedit — the ncurses based tool to manage the Samba registry. yes that's literally it, that's the whole vibe, it's a whole TUI for your registry 💅

🌸 SYNOPSIS 🌸

samba-regedit [-?|--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]

look at all those flags, she's got range fr fr 🌈

🦋 DESCRIPTION 🦋

so. this tool is part of the samba(7) suite. iconic lineage, we love a nepo baby that actually delivers.

samba-regedit is a ncurses based tool to manage the Samba registry. it can be used to show/edit registry keys/subkeys and their values. that's the whole job — showing and editing, keys and subkeys and values, all in a lil terminal UI. lowkey kinda powerful honestly 👑

🎀 OPTIONS 🎀

okay here's the whole menu, no skips, no skimming, we're eating every single one 🍓

  • -?|--help — prints a summary of command line options. baby's first flag 💖
  • --usage — displays a brief usage message. the sparknotes version ✨
  • -d|--debuglevel=level — level is an integer from 0 to 10. the default value if this parameter is not specified is 1 for client applications.

the higher this value, the more detail will be logged to the log files about the activities of the server. at level 0, only critical errors and serious warnings will be 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 will 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 bestie, HUGE. all caps. respect the caps. 💀

note that specifying this parameter here will override the log level parameter in the /etc/samba/smb.conf file.
  • --debug-stdout — this will redirect debug output to STDOUT. by default all clients are logging to STDERR. ✨
  • --configfile=<configuration file> — the file specified contains the configuration details required by the client. the information in this file can be general for client and server or only provide client specific like options such as client smb encrypt. see /etc/samba/smb.conf for more information. the default configuration file name is determined at compile time. 🧚
  • --option=<name>=<value> — set the smb.conf(5) option "<name>" to value "<value>" 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 whole --option=name=value into quotes. quotes are your friend, don't fight them 🫶
  • -l|--log-basename=logdirectory — base directory name for log/debug files. the extension ".progname" will be appended (e.g. log.smbclient, log.smbd, etc...). the log file is never removed by the client. 👑
  • --leak-report — enable talloc leak reporting on exit. 🫧
  • --leak-report-full — enable full talloc leak reporting on exit. the deluxe edition ✨
  • -V|--version — prints the program version number. ⭐
  • -R|--name-resolve=NAME-RESOLVE-ORDER — this option is used to determine what naming services and in what order to resolve host names to IP addresses. the option takes a space-separated string of different name resolution options. the best is to wrap the whole --name-resolve=NAME-RESOLVE-ORDER into quotes.

the options are: "lmhosts", "host", "wins" and "bcast". they cause names to be resolved as follows:

  • 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 as it depends on the target host being on a locally connected subnet.

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.

  • -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.
note that specifying this parameter here will override the client max protocol parameter in the /etc/samba/smb.conf file.
  • -n|--netbiosname=NETBIOSNAME — this option allows you to 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 will take precedence over settings in /etc/samba/smb.conf. command line stays winning, periodt 💅
  • --netbios-scope=SCOPE — this 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. rare drop, treat it like a limited edition 🦋
  • -W|--workgroup=WORKGROUP — set the SMB domain of the username. this overrides the default domain which is the domain defined in smb.conf. if the domain specified is the same as the servers NetBIOS name, it causes the client to log on using the servers 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 — set 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 username and password.

if %PASSWORD is not specified, the user will be prompted. the client will first check the USER environment variable (which is also permitted to also contain the password separated by a %), then the LOGNAME variable (which is not permitted to contain a password) and if either exists, the value is used. if these environmental variables are not found, the username found in a Kerberos Credentials cache may be used.

a third option is to use a credentials file which contains the plaintext of the username and password. this option is mainly provided for scripts where the admin does not wish to pass the credentials on the command line or via environment variables. if this method is used, make certain that 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. bestie please, do not put your password in the process title, the race is real 😭

  • -N|--no-pass — if specified, this parameter suppresses the normal password prompt from the client to the user. this is useful when accessing a service that does not 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. silently. ignored. the audacity 💀
  • --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 will check the PASSWD environment variable, followed by PASSWD_FD which is expected to contain an open file descriptor (FD) number.

finally it will check 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! lock that file 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 — the supplied password is the NT hash. 🔥
  • -A|--authentication-file=filename — this option allows you to specify a file from which to read the username and password used in the connection. the format of the file is:
username = <value>
password = <value>
domain   = <value>
make certain that the permissions on the file restrict access from unwanted users!
  • -P|--machine-pass — use stored machine account password. 🤖
  • --simple-bind-dn=DN — DN to use for a simple bind. 🌸

and that's part one bestie, we are NOT done, keep scrolling, the rest is coming ✨

  • --use-kerberos=desired|required|off — okay so this one decides whether the Samba client tools even bother trying Kerberos to auth. 🎫 Quick heads up tho: for Kerberos auth you gotta use DNS names, not IP addresses, when you're connecting to a service. No IPs, bestie, it's giving "that won't work."

By default the Samba client tools will try to use the default Kerberos credential cache (ccache). But if that ccache doesn't exist, or if the -U|--user option was specified, the clients will ask you to enter a password and will obtain a Kerberos ticket (kinit) for you. so helpful of them honestly ✨

Wanna use an alternative Kerberos credential cache instead? Use the --use-krb5-ccache option. 👑

Note that specifying this parameter here will override the client use kerberos parameter in the /etc/samba/smb.conf file.
  • --use-krb5-ccache=CCACHE — tells it where the credential cache lives for Kerberos authentication. 🎀

This will enforce --use-kerberos=required. Periodt, no negotiating. 💅

  • --use-winbind-ccache — try to use the credential cache by winbind. 🦋
  • --client-protection=sign|encrypt|off — sets the connection protection the client tool should use. 🔥 Choose your fighter: sign, encrypt, or off.
Note that specifying this parameter here will override the client protection parameter in the /etc/samba/smb.conf file.

And if you're the kind of main character who needs more fine grained control, you can use: --option=clientsmbencrypt=OPTION, --option=clientipcsigning=OPTION, --option=clientsigning=OPTION. 🧚

✨ VERSION ✨

This man page is part of version 4.24.7 of the Samba suite. 🏷️

🌸 SEE ALSO 🌸

smbd(8), samba(7) and net(8). Go read those too, they're iconic in their own way. 📚

👑 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. 🌈

The samba-regedit man page was written by Karolin Seeger. 💖

and that's a wrap on the whole page, bestie!! 🫶 This one's living in Samba 4.24.7, dated 09/09/2026, and the footer says SAMBA-REGEDIT(8) if you needed to cite it for your homework or whatever 😭💜 go forth and regedit responsibly, mwah 🎀✨

📦 where this page comes from