1SAMBA-REGEDIT(8)          System Administration tools         SAMBA-REGEDIT(8)
2
3
4

NAME

6       samba-regedit - ncurses based tool to manage the Samba registry
7

SYNOPSIS

9       samba-regedit [-?|--help] [--usage] [-d|--debuglevel=DEBUGLEVEL]
10        [--debug-stdout] [--configfile=CONFIGFILE] [--option=name=value]
11        [-l|--log-basename=LOGFILEBASE] [--leak-report] [--leak-report-full]
12        [-R|--name-resolve=NAME-RESOLVE-ORDER]
13        [-O|--socket-options=SOCKETOPTIONS] [-m|--max-protocol=MAXPROTOCOL]
14        [-n|--netbiosname=NETBIOSNAME] [--netbios-scope=SCOPE]
15        [-W|--workgroup=WORKGROUP] [--realm=REALM]
16        [-U|--user=[DOMAIN/]USERNAME[%PASSWORD]] [-N|--no-pass]
17        [--password=STRING] [--pw-nt-hash] [-A|--authentication-file=FILE]
18        [-P|--machine-pass] [--simple-bind-dn=DN]
19        [--use-kerberos=desired|required|off] [--use-krb5-ccache=CCACHE]
20        [--use-winbind-ccache] [--client-protection=sign|encrypt|off]
21        [-V|--version]
22

DESCRIPTION

24       This tool is part of the samba(7) suite.
25
26       samba-regedit is a ncurses based tool to manage the Samba registry. It
27       can be used to show/edit registry keys/subkeys and their values.
28

OPTIONS

30       -?|--help
31           Print a summary of command line options.
32
33       --usage
34           Display brief usage message.
35
36       -d|--debuglevel=DEBUGLEVEL
37           level is an integer from 0 to 10. The default value if this
38           parameter is not specified is 1 for client applications.
39
40           The higher this value, the more detail will be logged to the log
41           files about the activities of the server. At level 0, only critical
42           errors and serious warnings will be logged. Level 1 is a reasonable
43           level for day-to-day running - it generates a small amount of
44           information about operations carried out.
45
46           Levels above 1 will generate considerable amounts of log data, and
47           should only be used when investigating a problem. Levels above 3
48           are designed for use only by developers and generate HUGE amounts
49           of log data, most of which is extremely cryptic.
50
51           Note that specifying this parameter here will override the log
52           level parameter in the /etc/samba/smb.conf file.
53
54       --debug-stdout
55           This will redirect debug output to STDOUT. By default all clients
56           are logging to STDERR.
57
58       --configfile=<configuration file>
59           The file specified contains the configuration details required by
60           the client. The information in this file can be general for client
61           and server or only provide client specific like options such as
62           client smb encrypt. See /etc/samba/smb.conf for more information.
63           The default configuration file name is determined at compile time.
64
65       --option=<name>=<value>
66           Set the smb.conf(5) option "<name>" to value "<value>" from the
67           command line. This overrides compiled-in defaults and options read
68           from the configuration file. If a name or a value includes a space,
69           wrap whole --option=name=value into quotes.
70
71       -l|--log-basename=logdirectory
72           Base directory name for log/debug files. The extension ".progname"
73           will be appended (e.g. log.smbclient, log.smbd, etc...). The log
74           file is never removed by the client.
75
76       --leak-report
77           Enable talloc leak reporting on exit.
78
79       --leak-report-full
80           Enable full talloc leak reporting on exit.
81
82       -V|--version
83           Prints the program version number.
84
85       -R|--name-resolve=NAME-RESOLVE-ORDER
86           This option is used to determine what naming services and in what
87           order to resolve host names to IP addresses. The option takes a
88           space-separated string of different name resolution options. The
89           best is to wrap the whole --name-resolve=NAME-RESOLVE-ORDER into
90           quotes.
91
92           The options are: "lmhosts", "host", "wins" and "bcast". They cause
93           names to be resolved as follows:
94
95lmhosts: Lookup an IP address in the Samba lmhosts file.
96                      If the line in lmhosts has no name type attached to the
97                      NetBIOS name (see the lmhosts(5) for details) then any
98                      name type matches for lookup.
99
100host: Do a standard host name to IP address resolution,
101                      using the system /etc/hosts, NIS, or DNS lookups. This
102                      method of name resolution is operating system dependent,
103                      for instance on IRIX or Solaris this may be controlled
104                      by the /etc/nsswitch.conf file). Note that this method
105                      is only used if the NetBIOS name type being queried is
106                      the 0x20 (server) name type, otherwise it is ignored.
107
108wins: Query a name with the IP address listed in the
109                      wins server parameter. If no WINS server has been
110                      specified this method will be ignored.
111
112bcast: Do a broadcast on each of the known local
113                      interfaces listed in the interfaces parameter. This is
114                      the least reliable of the name resolution methods as it
115                      depends on the target host being on a locally connected
116                      subnet.
117
118           If this parameter is not set then the name resolve order defined in
119           the /etc/samba/smb.conf file parameter (name resolve order) will be
120           used.
121
122           The default order is lmhosts, host, wins, bcast. Without this
123           parameter or any entry in the name resolve order parameter of the
124           /etc/samba/smb.conf file, the name resolution methods will be
125           attempted in this order.
126
127       -O|--socket-options=SOCKETOPTIONS
128           TCP socket options to set on the client socket. See the socket
129           options parameter in the /etc/samba/smb.conf manual page for the
130           list of valid options.
131
132       -m|--max-protocol=MAXPROTOCOL
133           The value of the parameter (a string) is the highest protocol level
134           that will be supported by the client.
135
136           Note that specifying this parameter here will override the client
137           max protocol parameter in the /etc/samba/smb.conf file.
138
139       -n|--netbiosname=NETBIOSNAME
140           This option allows you to override the NetBIOS name that Samba uses
141           for itself. This is identical to setting the netbios name parameter
142           in the /etc/samba/smb.conf file. However, a command line setting
143           will take precedence over settings in /etc/samba/smb.conf.
144
145       --netbios-scope=SCOPE
146           This specifies a NetBIOS scope that nmblookup will use to
147           communicate with when generating NetBIOS names. For details on the
148           use of NetBIOS scopes, see rfc1001.txt and rfc1002.txt. NetBIOS
149           scopes are very rarely used, only set this parameter if you are the
150           system administrator in charge of all the NetBIOS systems you
151           communicate with.
152
153       -W|--workgroup=WORKGROUP
154           Set the SMB domain of the username. This overrides the default
155           domain which is the domain defined in smb.conf. If the domain
156           specified is the same as the servers NetBIOS name, it causes the
157           client to log on using the servers local SAM (as opposed to the
158           Domain SAM).
159
160           Note that specifying this parameter here will override the
161           workgroup parameter in the /etc/samba/smb.conf file.
162
163       -r|--realm=REALM
164           Set the realm for the domain.
165
166           Note that specifying this parameter here will override the realm
167           parameter in the /etc/samba/smb.conf file.
168
169       -U|--user=[DOMAIN\]USERNAME[%PASSWORD]
170           Sets the SMB username or username and password.
171
172           If %PASSWORD is not specified, the user will be prompted. The
173           client will first check the USER environment variable (which is
174           also permitted to also contain the password separated by a %), then
175           the LOGNAME variable (which is not permitted to contain a password)
176           and if either exists, the value is used. If these environmental
177           variables are not found, the username found in a Kerberos
178           Credentials cache may be used.
179
180           A third option is to use a credentials file which contains the
181           plaintext of the username and password. This option is mainly
182           provided for scripts where the admin does not wish to pass the
183           credentials on the command line or via environment variables. If
184           this method is used, make certain that the permissions on the file
185           restrict access from unwanted users. See the -A for more details.
186
187           Be cautious about including passwords in scripts or passing
188           user-supplied values onto the command line. For security it is
189           better to let the Samba client tool ask for the password if needed,
190           or obtain the password once with kinit.
191
192           While Samba will attempt to scrub the password from the process
193           title (as seen in ps), this is after startup and so is subject to a
194           race.
195
196       -N|--no-pass
197           If specified, this parameter suppresses the normal password prompt
198           from the client to the user. This is useful when accessing a
199           service that does not require a password.
200
201           Unless a password is specified on the command line or this
202           parameter is specified, the client will request a password.
203
204           If a password is specified on the command line and this option is
205           also defined the password on the command line will be silently
206           ignored and no password will be used.
207
208       --password
209           Specify the password on the commandline.
210
211           Be cautious about including passwords in scripts or passing
212           user-supplied values onto the command line. For security it is
213           better to let the Samba client tool ask for the password if needed,
214           or obtain the password once with kinit.
215
216           If --password is not specified, the tool will check the PASSWD
217           environment variable, followed by PASSWD_FD which is expected to
218           contain an open file descriptor (FD) number.
219
220           Finally it will check PASSWD_FILE (containing a file path to be
221           opened). The file should only contain the password. Make certain
222           that the permissions on the file restrict access from unwanted
223           users!
224
225           While Samba will attempt to scrub the password from the process
226           title (as seen in ps), this is after startup and so is subject to a
227           race.
228
229       --pw-nt-hash
230           The supplied password is the NT hash.
231
232       -A|--authentication-file=filename
233           This option allows you to specify a file from which to read the
234           username and password used in the connection. The format of the
235           file is:
236
237                                   username = <value>
238                                   password = <value>
239                                   domain   = <value>
240
241
242           Make certain that the permissions on the file restrict access from
243           unwanted users!
244
245       -P|--machine-pass
246           Use stored machine account password.
247
248       --simple-bind-dn=DN
249           DN to use for a simple bind.
250
251       --use-kerberos=desired|required|off
252           This parameter determines whether Samba client tools will try to
253           authenticate using Kerberos. For Kerberos authentication you need
254           to use dns names instead of IP addresses when connecting to a
255           service.
256
257           Note that specifying this parameter here will override the client
258           use kerberos parameter in the /etc/samba/smb.conf file.
259
260       --use-krb5-ccache=CCACHE
261           Specifies the credential cache location for Kerberos
262           authentication.
263
264           This will set --use-kerberos=required too.
265
266       --use-winbind-ccache
267           Try to use the credential cache by winbind.
268
269       --client-protection=sign|encrypt|off
270           Sets the connection protection the client tool should use.
271
272           Note that specifying this parameter here will override the client
273           protection parameter in the /etc/samba/smb.conf file.
274
275           In case you need more fine grained control you can use:
276           --option=clientsmbencrypt=OPTION, --option=clientipcsigning=OPTION,
277           --option=clientsigning=OPTION.
278

VERSION

280       This man page is part of version 4.19.3 of the Samba suite.
281

SEE ALSO

283       smbd(8), samba(7) and net(8).
284

AUTHOR

286       The original Samba software and related utilities were created by
287       Andrew Tridgell. Samba is now developed by the Samba Team as an Open
288       Source project similar to the way the Linux kernel is developed.
289
290       The samba-regedit man page was written by Karolin Seeger.
291
292
293
294Samba 4.19.3                      11/27/2023                  SAMBA-REGEDIT(8)
Impressum