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 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 smb.conf for more information. The default
63           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 ist 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 smb.conf file parameter (name resolve order) will be used.
120
121           The default order is lmhosts, host, wins, bcast. Without this
122           parameter or any entry in the name resolve order parameter of the
123           smb.conf file, the name resolution methods will be attempted in
124           this order.
125
126       -O|--socket-options=SOCKETOPTIONS
127           TCP socket options to set on the client socket. See the socket
128           options parameter in the smb.conf manual page for the list of valid
129           options.
130
131       -m|--max-protocol=MAXPROTOCOL
132           The value of the parameter (a string) is the highest protocol level
133           that will be supported by the client.
134
135           Note that specifying this parameter here will override the client
136           max protocol parameter in the smb.conf file.
137
138       -n|--netbiosname=NETBIOSNAME
139           This option allows you to override the NetBIOS name that Samba uses
140           for itself. This is identical to setting the netbios name parameter
141           in the smb.conf file. However, a command line setting will take
142           precedence over settings in smb.conf.
143
144       --netbios-scope=SCOPE
145           This specifies a NetBIOS scope that nmblookup will use to
146           communicate with when generating NetBIOS names. For details on the
147           use of NetBIOS scopes, see rfc1001.txt and rfc1002.txt. NetBIOS
148           scopes are very rarely used, only set this parameter if you are the
149           system administrator in charge of all the NetBIOS systems you
150           communicate with.
151
152       -W|--workgroup=WORKGROUP
153           Set the SMB domain of the username. This overrides the default
154           domain which is the domain defined in smb.conf. If the domain
155           specified is the same as the servers NetBIOS name, it causes the
156           client to log on using the servers local SAM (as opposed to the
157           Domain SAM).
158
159           Note that specifying this parameter here will override the
160           workgroup parameter in the smb.conf file.
161
162       -r|--realm=REALM
163           Set the realm for the domain.
164
165           Note that specifying this parameter here will override the realm
166           parameter in the smb.conf file.
167
168       -U|--user=[DOMAIN\]USERNAME[%PASSWORD]
169           Sets the SMB username or username and password.
170
171           If %PASSWORD is not specified, the user will be prompted. The
172           client will first check the USER environment variable (which is
173           also permitted to also contain the password seperated by a %), then
174           the LOGNAME variable (which is not permitted to contain a password)
175           and if either exists, the value is used. If these environmental
176           variables are not found, the username found in a Kerberos
177           Credentials cache may be used.
178
179           A third option is to use a credentials file which contains the
180           plaintext of the username and password. This option is mainly
181           provided for scripts where the admin does not wish to pass the
182           credentials on the command line or via environment variables. If
183           this method is used, make certain that the permissions on the file
184           restrict access from unwanted users. See the -A for more details.
185
186           Be cautious about including passwords in scripts or passing
187           user-supplied values onto the command line. For security it is
188           better to let the Samba client tool ask for the password if needed,
189           or obtain the password once with kinit.
190
191           While Samba will attempt to scrub the password from the process
192           title (as seen in ps), this is after startup and so is subject to a
193           race.
194
195       -N|--no-pass
196           If specified, this parameter suppresses the normal password prompt
197           from the client to the user. This is useful when accessing a
198           service that does not require a password.
199
200           Unless a password is specified on the command line or this
201           parameter is specified, the client will request a password.
202
203           If a password is specified on the command line and this option is
204           also defined the password on the command line will be silently
205           ignored and no password will be used.
206
207       --password
208           Specify the password on the commandline.
209
210           Be cautious about including passwords in scripts or passing
211           user-supplied values onto the command line. For security it is
212           better to let the Samba client tool ask for the password if needed,
213           or obtain the password once with kinit.
214
215           If --password is not specified, the tool will check the PASSWD
216           environment variable, followed by PASSWD_FD which is expected to
217           contain an open file descriptor (FD) number.
218
219           Finally it will check PASSWD_FILE (containing a file path to be
220           opened). The file should only contain the password. Make certain
221           that the permissions on the file restrict access from unwanted
222           users!
223
224           While Samba will attempt to scrub the password from the process
225           title (as seen in ps), this is after startup and so is subject to a
226           race.
227
228       --pw-nt-hash
229           The supplied password is the NT hash.
230
231       -A|--authentication-file=filename
232           This option allows you to specify a file from which to read the
233           username and password used in the connection. The format of the
234           file is:
235
236                                   username = <value>
237                                   password = <value>
238                                   domain   = <value>
239
240
241           Make certain that the permissions on the file restrict access from
242           unwanted users!
243
244       -P|--machine-pass
245           Use stored machine account password.
246
247       --simple-bind-dn=DN
248           DN to use for a simple bind.
249
250       --use-kerberos=desired|required|off
251           This parameter determines whether Samba client tools will try to
252           authenticate using Kerberos. For Kerberos authentication you need
253           to use dns names instead of IP addresses when connnecting to a
254           service.
255
256           Note that specifying this parameter here will override the client
257           use kerberos parameter in the smb.conf file.
258
259       --use-krb5-ccache=CCACHE
260           Specifies the credential cache location for Kerberos
261           authentication.
262
263           This will set --use-kerberos=required too.
264
265       --use-winbind-ccache
266           Try to use the credential cache by winbind.
267
268       --client-protection=sign|encrypt|off
269           Sets the connection protection the client tool should use.
270
271           Note that specifying this parameter here will override the client
272           protection parameter in the smb.conf file.
273
274           In case you need more fine grained control you can use:
275           --option=clientsmbencrypt=OPTION, --option=clientipcsigning=OPTION,
276           --option=clientsigning=OPTION.
277

VERSION

279       This man page is part of version 4.16.2 of the Samba suite.
280

SEE ALSO

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

AUTHOR

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