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 <debug level>]
10        [-s <configuration file>] [-l <log directory>] [-V]
11        [--option=<parameter>=<value>] [--socket-options=<SOCKETOPTIONS>]
12        [--netbiosname=<NETBIOSNAME>] [--workgroup=<WORKGROUP>]
13        [--scope=<SCOPE>] [--user=<USERNAME>] [-N] [-k]
14        [--authentication-file=<FILE>] [--signing=[on|off|required]] [-P] [-e]
15        [-C] [--pw-nt-hash]
16

DESCRIPTION

18       This tool is part of the samba(7) suite.
19
20       samba-regedit is a ncurses based tool to manage the Samba registry. It
21       can be used to show/edit registry keys/subkeys and their values.
22

OPTIONS

24       -?|--help
25           Print a summary of command line options.
26
27       -d|--debuglevel=level
28           level is an integer from 0 to 10. The default value if this
29           parameter is not specified is 1.
30
31           The higher this value, the more detail will be logged to the log
32           files about the activities of the server. At level 0, only critical
33           errors and serious warnings will be logged. Level 1 is a reasonable
34           level for day-to-day running - it generates a small amount of
35           information about operations carried out.
36
37           Levels above 1 will generate considerable amounts of log data, and
38           should only be used when investigating a problem. Levels above 3
39           are designed for use only by developers and generate HUGE amounts
40           of log data, most of which is extremely cryptic.
41
42           Note that specifying this parameter here will override the log
43           level parameter in the smb.conf file.
44
45       --usage
46           Display brief usage message.
47
48       -V|--version
49           Prints the program version number.
50
51       -s|--configfile=<configuration file>
52           The file specified contains the configuration details required by
53           the server. The information in this file includes server-specific
54           information such as what printcap file to use, as well as
55           descriptions of all the services that the server is to provide. See
56           smb.conf for more information. The default configuration file name
57           is determined at compile time.
58
59       -l|--log-basename=logdirectory
60           Base directory name for log/debug files. The extension ".progname"
61           will be appended (e.g. log.smbclient, log.smbd, etc...). The log
62           file is never removed by the client.
63
64       --option=<name>=<value>
65           Set the smb.conf(5) option "<name>" to value "<value>" from the
66           command line. This overrides compiled-in defaults and options read
67           from the configuration file.
68
69       -n|--netbiosname <primary NetBIOS name>
70           This option allows you to override the NetBIOS name that Samba uses
71           for itself. This is identical to setting the netbios name parameter
72           in the smb.conf file. However, a command line setting will take
73           precedence over settings in smb.conf.
74
75       -i|--scope <scope>
76           This specifies a NetBIOS scope that nmblookup will use to
77           communicate with when generating NetBIOS names. For details on the
78           use of NetBIOS scopes, see rfc1001.txt and rfc1002.txt. NetBIOS
79           scopes are very rarely used, only set this parameter if you are the
80           system administrator in charge of all the NetBIOS systems you
81           communicate with.
82
83       -W|--workgroup=domain
84           Set the SMB domain of the username. This overrides the default
85           domain which is the domain defined in smb.conf. If the domain
86           specified is the same as the servers NetBIOS name, it causes the
87           client to log on using the servers local SAM (as opposed to the
88           Domain SAM).
89
90       -O|--socket-options socket options
91           TCP socket options to set on the client socket. See the socket
92           options parameter in the smb.conf manual page for the list of valid
93           options.
94
95       -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
100           Unless a password is specified on the command line or this
101           parameter is specified, the client will request a password.
102
103           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
107       -k|--kerberos
108           Try to authenticate with kerberos. Only useful in an Active
109           Directory environment.
110
111       -C|--use-ccache
112           Try to use the credentials cached by winbind.
113
114       -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
119               username = <value>
120               password = <value>
121               domain   = <value>
122
123           Make certain that the permissions on the file restrict access from
124           unwanted users.
125
126       -U|--user=username[%password]
127           Sets the SMB username or username and password.
128
129           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
135           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
142           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
147       -S|--signing on|off|required
148           Set the client signing state.
149
150       -P|--machine-pass
151           Use stored machine account password.
152
153       -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
162       --pw-nt-hash
163           The supplied password is the NT hash.
164

VERSION

166       This man page is part of version 4.14.5 of the Samba suite.
167

SEE ALSO

169       smbd(8), samba(7) and net(8).
170

AUTHOR

172       The original Samba software and related utilities were created by
173       Andrew Tridgell. Samba is now developed by the Samba Team as an Open
174       Source project similar to the way the Linux kernel is developed.
175
176       The samba-regedit man page was written by Karolin Seeger.
177
178
179
180Samba 4.14.5                      06/01/2021                  SAMBA-REGEDIT(8)
Impressum