1SMBTREE(1) User Commands SMBTREE(1)
2
6 smbtree - A text based smb network browser
7
9 smbtree [-D|--domains] [-S|--servers] [-?|--help] [--usage]
10 [-d|--debuglevel=DEBUGLEVEL] [--debug-stdout]
11 [--configfile=CONFIGFILE] [--option=name=value]
12 [-l|--log-basename=LOGFILEBASE] [--leak-report] [--leak-report-full]
13 [-U|--user=[DOMAIN/]USERNAME[%PASSWORD]] [-N|--no-pass]
14 [--password=STRING] [--pw-nt-hash] [-A|--authentication-file=FILE]
15 [-P|--machine-pass] [--simple-bind-dn=DN]
16 [--use-kerberos=desired|required|off] [--use-krb5-ccache=CCACHE]
17 [--use-winbind-ccache] [--client-protection=sign|encrypt|off]
18 [-V|--version]
19
21 This tool is part of the samba(7) suite.
22 smbtree is a smb browser program in text mode. It is similar to the
24 "Network Neighborhood" found on Windows computers. It prints a tree
25 with all the known domains, the servers in those domains and the shares
26 on the servers.
27
29 -D|--domains
30 Only print a list of all the domains known on broadcast or by the
31 master browser
32 -S|--servers
34 Only print a list of all the domains and servers responding on
35 broadcast or known by the master browser.
36 -?|--help
38 Print a summary of command line options.
39 --usage
41 Display brief usage message.
42 -d|--debuglevel=DEBUGLEVEL
44 level is an integer from 0 to 10. The default value if this
45 parameter is not specified is 1 for client applications.
46 The higher this value, the more detail will be logged to the log
48 files about the activities of the server. At level 0, only critical
49 errors and serious warnings will be logged. Level 1 is a reasonable
50 level for day-to-day running - it generates a small amount of
51 information about operations carried out.
52 Levels above 1 will generate considerable amounts of log data, and
54 should only be used when investigating a problem. Levels above 3
55 are designed for use only by developers and generate HUGE amounts
56 of log data, most of which is extremely cryptic.
57 Note that specifying this parameter here will override the log
59 level parameter in the /etc/samba/smb.conf file.
60 --debug-stdout
62 This will redirect debug output to STDOUT. By default all clients
63 are logging to STDERR.
64 --configfile=<configuration file>
66 The file specified contains the configuration details required by
67 the client. The information in this file can be general for client
68 and server or only provide client specific like options such as
69 client smb encrypt. See /etc/samba/smb.conf for more information.
70 The default configuration file name is determined at compile time.
71 --option=<name>=<value>
73 Set the smb.conf(5) option "<name>" to value "<value>" from the
74 command line. This overrides compiled-in defaults and options read
75 from the configuration file. If a name or a value includes a space,
76 wrap whole --option=name=value into quotes.
77 -l|--log-basename=logdirectory
79 Base directory name for log/debug files. The extension ".progname"
80 will be appended (e.g. log.smbclient, log.smbd, etc...). The log
81 file is never removed by the client.
82 --leak-report
84 Enable talloc leak reporting on exit.
85 --leak-report-full
87 Enable full talloc leak reporting on exit.
88 -V|--version
90 Prints the program version number.
91 -U|--user=[DOMAIN\]USERNAME[%PASSWORD]
93 Sets the SMB username or username and password.
94 If %PASSWORD is not specified, the user will be prompted. The
96 client will first check the USER environment variable (which is
97 also permitted to also contain the password separated by a %), then
98 the LOGNAME variable (which is not permitted to contain a password)
99 and if either exists, the value is used. If these environmental
100 variables are not found, the username found in a Kerberos
101 Credentials cache may be used.
102 A third option is to use a credentials file which contains the
104 plaintext of the username and password. This option is mainly
105 provided for scripts where the admin does not wish to pass the
106 credentials on the command line or via environment variables. If
107 this method is used, make certain that the permissions on the file
108 restrict access from unwanted users. See the -A for more details.
109 Be cautious about including passwords in scripts or passing
111 user-supplied values onto the command line. For security it is
112 better to let the Samba client tool ask for the password if needed,
113 or obtain the password once with kinit.
114 While Samba will attempt to scrub the password from the process
116 title (as seen in ps), this is after startup and so is subject to a
117 race.
118 -N|--no-pass
120 If specified, this parameter suppresses the normal password prompt
121 from the client to the user. This is useful when accessing a
122 service that does not require a password.
123 Unless a password is specified on the command line or this
125 parameter is specified, the client will request a password.
126 If a password is specified on the command line and this option is
128 also defined the password on the command line will be silently
129 ignored and no password will be used.
130 --password
132 Specify the password on the commandline.
133 Be cautious about including passwords in scripts or passing
135 user-supplied values onto the command line. For security it is
136 better to let the Samba client tool ask for the password if needed,
137 or obtain the password once with kinit.
138 If --password is not specified, the tool will check the PASSWD
140 environment variable, followed by PASSWD_FD which is expected to
141 contain an open file descriptor (FD) number.
142 Finally it will check PASSWD_FILE (containing a file path to be
144 opened). The file should only contain the password. Make certain
145 that the permissions on the file restrict access from unwanted
146 users!
147 While Samba will attempt to scrub the password from the process
149 title (as seen in ps), this is after startup and so is subject to a
150 race.
151 --pw-nt-hash
153 The supplied password is the NT hash.
154 -A|--authentication-file=filename
156 This option allows you to specify a file from which to read the
157 username and password used in the connection. The format of the
158 file is:
159 username = <value>
161 password = <value>
162 domain = <value>
163 Make certain that the permissions on the file restrict access from
166 unwanted users!
167 -P|--machine-pass
169 Use stored machine account password.
170 --simple-bind-dn=DN
172 DN to use for a simple bind.
173 --use-kerberos=desired|required|off
175 This parameter determines whether Samba client tools will try to
176 authenticate using Kerberos. For Kerberos authentication you need
177 to use dns names instead of IP addresses when connecting to a
178 service.
179 Note that specifying this parameter here will override the client
181 use kerberos parameter in the /etc/samba/smb.conf file.
182 --use-krb5-ccache=CCACHE
184 Specifies the credential cache location for Kerberos
185 authentication.
186 This will set --use-kerberos=required too.
188 --use-winbind-ccache
190 Try to use the credential cache by winbind.
191 --client-protection=sign|encrypt|off
193 Sets the connection protection the client tool should use.
194 Note that specifying this parameter here will override the client
196 protection parameter in the /etc/samba/smb.conf file.
197 In case you need more fine grained control you can use:
199 --option=clientsmbencrypt=OPTION, --option=clientipcsigning=OPTION,
200 --option=clientsigning=OPTION.
201
203 This man page is part of version 4.17.5 of the Samba suite.
204
206 The original Samba software and related utilities were created by
207 Andrew Tridgell. Samba is now developed by the Samba Team as an Open
208 Source project similar to the way the Linux kernel is developed.
209 The smbtree man page was written by Jelmer Vernooij.
211Samba 4.17.5 01/26/2023 SMBTREE(1)