corrected paragraph giving the impression that samba can be a domain master
[kai/samba.git] / docs / textdocs / BROWSING.txt
1 Author/s:       Many (Thanks to Luke, Jeremy, Andrew, etc.)
2 Updated:        June 29, 1997
3 Status:         Current - For VERY Advanced Users ONLY
4
5 Summary: This describes how to configure Samba for improved browsing.
6 =====================================================================
7
8 OVERVIEW:
9 =========
10 SMB networking provides a mechanism by which clients can access a list
11 of machines that are available within the network.  This list is called
12 the browse list and is heavily used by all SMB clients.  Configuration
13 of SMB browsing has been problematic for some Samba users, hence this
14 document.
15
16 =====================================================================
17
18 BROWSING
19 ========
20 Samba now fully supports browsing.  The browsing is supported by nmbd
21 and is also controlled by options in the smb.conf file (see smb.conf(5)).
22
23 Samba can act as a local browse master for a workgroup and the ability
24 for samba to support domain logons and scripts is now available.  See
25 DOMAIN.txt for more information on domain logons.
26
27 Samba can also act as a domain master browser for a workgroup.  This
28 means that it will collate lists from local browse masters into a
29 wide area network server list.  In order for browse clients to
30 resolve the names they may find in this list, it is recommended that
31 both samba and your clients use a WINS server.
32
33 Note that you should NOT set Samba to be the domain master for a
34 workgroup that has the same name as an NT Domain: on each wide area
35 network, you must only ever have one domain master browser per workgroup,
36 regardless of whether it is NT, Samba or any other type of domain master
37 that is providing this service.
38
39 [Note that nmbd can be configured as a WINS server, but it is not
40 necessary to specifically use samba as your WINS server.  NTAS can
41 be configured as your WINS server.  In a mixed NT server and
42 samba environment on a Wide Area Network, it is recommended that
43 you use the NT server's WINS server capabilities.  In a samba-only
44 environment, it is recommended that you use one and only one nmbd
45 as your WINS server].
46
47 To get browsing to work you need to run nmbd as usual, but will need
48 to use the "workgroup" option in smb.conf to control what workgroup
49 Samba becomes a part of.
50
51 Samba also has a useful option for a Samba server to offer itself for
52 browsing on another subnet.  It is recommended that this option is only
53 used for 'unusual' purposes: announcements over the internet, for
54 example.  See "remote announce" in the smb.conf man page.  
55
56 If something doesn't work then hopefully the log.nmb file will
57 help you track down the problem.  Try a debug level of 2 or 3 for
58 finding problems.
59
60 Note that if it doesn't work for you, then you should still be able to
61 type the server name as \\SERVER in filemanager then hit enter and
62 filemanager should display the list of available shares.
63
64 Some people find browsing fails because they don't have the global
65 "guest account" set to a valid account.  Remember that the IPC$
66 connection that lists the shares is done as guest, and thus you must
67 have a valid guest account.
68
69 Also, a lot of people are getting bitten by the problem of too many
70 parameters on the command line of nmbd in inetd.conf.  This trick is to
71 not use spaces between the option and the parameter (eg: -d2 instead
72 of -d 2), and to not use the -B and -N options.  New versions of nmbd
73 are now far more likely to correctly find your broadcast and network
74 addess, so in most cases these aren't needed.
75
76 The other big problem people have is that their broadcast address,
77 netmask or IP address is wrong (specified with the "interfaces" option
78 in smb.conf)
79
80
81 BROWSING ACROSS SUBNETS
82 =======================
83
84 With the release of Samba 1.9.17(alpha1 and above) Samba has been
85 updated to enable it to support the replication of browse lists
86 across subnet boundaries.  New code and options have been added to
87 achieve this.  This section describes how to set this feature up
88 in different settings.
89
90 To see browse lists that span TCP/IP subnets (ie.  networks separated
91 by routers that don't pass broadcast traffic) you must set up at least
92 one WINS server.  The WINS server acts as a DNS for NetBIOS names, allowing
93 NetBIOS name to IP address translation to be done by doing a direct
94 query of the WINS server.  This is done via a directed UDP packet on
95 port 137 to the WINS server machine.  The reason for a WINS server is
96 that by default, all NetBIOS name to IP address translation is done
97 by broadcasts from the querying machine.  This means that machines
98 on one subnet will not be able to resolve the names of machines on
99 another subnet without using a WINS server.
100
101 Remember, for browsing across subnets to work correctly, all machines,
102 be they Windows 95, Windows NT, or Samba servers must have the IP address
103 of a WINS server given to them by a DHCP server, or by manual configuration 
104 (for Win95 and WinNT, this is in the TCP/IP Properties, under Network 
105 settings) for Samba this is in the smb.conf file.
106
107 How does cross subnet browsing work ?
108 =====================================
109
110 Cross subnet browsing is a complicated dance, containing multiple
111 moving parts.  It has taken Microsoft several years to get the code
112 that achieves this correct, and Samba lags behind in some areas.
113 However, with the 1.9.17 release, Samba is capable of cross subnet
114 browsing when configured correctly.
115
116 Consider a network set up as follows :
117
118                                    (DMB)
119              N1_A      N1_B        N1_C       N1_D        N1_E
120               |          |           |          |           |
121           -------------------------------------------------------
122             |          subnet 1                       |
123           +---+                                      +---+
124           |R1 | Router 1                  Router 2   |R2 |
125           +---+                                      +---+
126             |                                          |
127             |  subnet 2              subnet 3          |
128   --------------------------       ------------------------------------
129   |     |     |      |               |        |         |           |
130  N2_A  N2_B  N2_C   N2_D           N3_A     N3_B      N3_C        N3_D 
131                     (WINS)
132
133 Consisting of 3 subnets (1, 2, 3) conneted by two routers
134 (R1, R2) - these do not pass broadcasts.  Subnet 1 has 5 machines
135 on it, subnet 2 has 4 machines, subnet 3 has 4 machines.  Assume
136 for the moment that all these machines are configured to be in the
137 same workgroup (for simplicities sake).  Machine N1_C on subnet 1
138 is configured as Domain Master Browser (ie.  it will collate the
139 browse lists for the workgroup).  Machine N2_D is configured as
140 WINS server and all the other machines are configured to register
141 their NetBIOS names with it.
142
143 As all these machines are booted up, elections for master browsers
144 will take place on each of the three subnets.  Assume that machine
145 N1_C wins on subnet 1, N2_B wins on subnet 2, and N3_D wins on
146 subnet 3 - these machines are known as local master browsers for
147 their particular subnet.  N1_C has an advantage in winning as the
148 local master browser on subnet 1 as it is set up as Domain Master
149 Browser.
150
151 On each of the three networks, machines that are configured to 
152 offer sharing services will broadcast that they are offering
153 these services.  The local master browser on each subnet will
154 receive these broadcasts and keep a record of the fact that
155 the machine is offering a service.  This list of records is
156 the basis of the browse list.  For this case, assume that
157 all the machines are configured to offer services so all machines
158 will be on the browse list.
159
160 For each network, the local master browser on that network is
161 considered 'authoritative' for all the names it receives via
162 local broadcast.  This is because a machine seen by the local
163 master browser via a local broadcast must be on the same 
164 network as the local master browser and thus is a 'trusted'
165 and 'verifiable' resource.  Machines on other networks that
166 the local master browsers learn about when collating their
167 browse lists have not been directly seen - these records are
168 called 'non-authoritative'.
169
170 At this point the browse lists look as follows (these are 
171 the machines you would see in your network neighborhood if
172 you looked in it on a particular network right now).
173
174 Subnet           Browse Master   List
175 ------           -------------   ----
176 Subnet1          N1_C            N1_A, N1_B, N1_C, N1_D, N1_E
177
178 Subnet2          N2_B            N2_A, N2_B, N2_C, N2_D
179
180 Subnet3          N3_D            N3_A, N3_B, N3_C, N3_D
181
182 Note that at this point all the subnets are separate, no
183 machine is seen across any of the subnets.
184
185 Now examine subnet 2.  As soon as N2_B has become the local
186 master browser it looks for a Domain master browser to synchronize
187 its browse list with.  It does this by querying the WINS server
188 (N2_D) for the IP address associated with the NetBIOS name 
189 WORKGROUP<1B>.  This name was registerd by the Domain master
190 browser (N1_C) with the WINS server as soon as it was booted.
191
192 Once N2_B knows the address of the Domain master browser it
193 tells it that is the local master browser for subnet 2 by
194 sending a MasterAnnouncement packet as a UDP port 138 packet.
195 It then synchronizes with it by doing a NetServerEnum2 call.  This
196 tells the Domain Master Browser to send it all the server
197 names it knows about.  Once the domain master browser receives
198 the MasterAnnouncement packet it schedules a synchronization
199 request to the sender of that packet.  After both synchronizations
200 are done the browse lists look like :
201
202 Subnet           Browse Master   List
203 ------           -------------   ----
204 Subnet1          N1_C            N1_A, N1_B, N1_C, N1_D, N1_E, 
205                                  N2_A(*), N2_B(*), N2_C(*), N2_D(*)
206
207 Subnet2          N2_B            N2_A, N2_B, N2_C, N2_D
208                                  N1_A(*), N1_B(*), N1_C(*), N1_D(*), N1_E(*)
209
210 Subnet3          N3_D            N3_A, N3_B, N3_C, N3_D
211
212 Servers with a (*) after them are non-authoritative names.
213
214 At this point users looking in their network neighborhood on
215 subnets 1 or 2 will see all the servers on both, users on
216 subnet 3 will still only see the servers on their own subnet.
217
218 The same sequence of events that occured for N2_B now occurs
219 for the local master browser on subnet 3 (N3_D).  When it
220 synchronizes browse lists with the domain master browser (N1_A)
221 it gets both the server entries on subnet 1, and those on
222 subnet 2.  After N3_D has synchronized with N1_C and vica-versa
223 the browse lists look like.
224
225 Subnet           Browse Master   List
226 ------           -------------   ----
227 Subnet1          N1_C            N1_A, N1_B, N1_C, N1_D, N1_E, 
228                                  N2_A(*), N2_B(*), N2_C(*), N2_D(*),
229                                  N3_A(*), N3_B(*), N3_C(*), N3_D(*)
230
231 Subnet2          N2_B            N2_A, N2_B, N2_C, N2_D
232                                  N1_A(*), N1_B(*), N1_C(*), N1_D(*), N1_E(*)
233
234 Subnet3          N3_D            N3_A, N3_B, N3_C, N3_D
235                                  N1_A(*), N1_B(*), N1_C(*), N1_D(*), N1_E(*),
236                                  N2_A(*), N2_B(*), N2_C(*), N2_D(*)
237
238 Servers with a (*) after them are non-authoritative names.
239
240 At this point users looking in their network neighborhood on
241 subnets 1 or 3 will see all the servers on all sunbets, users on
242 subnet 2 will still only see the servers on subnets 1 and 2, but not 3.
243
244 Finally, the local master browser for subnet 2 (N2_B) will sync again
245 with the domain master browser (N1_C) and will recieve the missing
246 server entries.  Finally - and as a steady state (if no machines
247 are removed or shut off) the browse lists will look like :
248
249 Subnet           Browse Master   List
250 ------           -------------   ----
251 Subnet1          N1_C            N1_A, N1_B, N1_C, N1_D, N1_E, 
252                                  N2_A(*), N2_B(*), N2_C(*), N2_D(*),
253                                  N3_A(*), N3_B(*), N3_C(*), N3_D(*)
254
255 Subnet2          N2_B            N2_A, N2_B, N2_C, N2_D
256                                  N1_A(*), N1_B(*), N1_C(*), N1_D(*), N1_E(*)
257                                  N3_A(*), N3_B(*), N3_C(*), N3_D(*)
258
259 Subnet3          N3_D            N3_A, N3_B, N3_C, N3_D
260                                  N1_A(*), N1_B(*), N1_C(*), N1_D(*), N1_E(*),
261                                  N2_A(*), N2_B(*), N2_C(*), N2_D(*)
262
263 Servers with a (*) after them are non-authoritative names.
264
265 Synchronizations between the domain master browser and local
266 master browsers will continue to occur, but this should be a
267 steady state situation.
268
269 If either router R1 or R2 fails the following will occur:
270
271 1) Names of computers on each side of the inaccessible network fragments
272 will be maintained for as long as 36 minutes, in the network neighbourhood
273 lists.
274
275 2) Attempts to connect to these inaccessible computers will fail, but the
276 names will not be removed from the network neighbourhood lists.
277
278 3) If one of the fragments is cut off from the WINS server, it will only
279 be able to access servers on its local subnet, by using subnet-isolated
280 broadcast NetBIOS name resolution.  The effects are similar to that of
281 losing access to a DNS server.
282
283 Setting up a WINS server
284 ========================
285
286 Either a Samba machine or a Windows NT Server machine may be set up
287 as a WINS server.  To set a Samba machine to be a WINS server you must
288 add the following option to the smb.conf file on the selected machine :
289 in the [globals] section add the line 
290
291         wins support = yes
292
293 Versions of Samba previous to 1.9.17 had this parameter default to
294 yes.  If you have any older versions of Samba on your network it is
295 strongly suggested you upgrade to 1.9.17 or above, or at the very
296 least set the parameter to 'no' on all these machines.
297
298 Machines with "wins support = yes" will keep a list of all NetBIOS
299 names registered with them, acting as a DNS for NetBIOS names.
300
301 You should set up only ONE wins server.  Do NOT set the
302 "wins support = yes" option on more than one Samba server.
303
304 To set up a Windows NT Server as a WINS server you need to set up
305 the WINS service - see your NT documentation for details.  Note that
306 Windows NT WINS Servers can replicate to each other, allowing more
307 than one to be set up in a complex subnet environment.  As Microsoft
308 refuse to document these replication protocols Samba cannot currently
309 participate in these replications.  It is possible in the future that
310 a Samba->Samba WINS replication protocol may be defined, in which
311 case more than one Samba machine could be set up as a WINS server
312 but currently only one Samba server should have the "wins support = yes"
313 parameter set.
314
315 After the WINS server has been configured you must ensure that all
316 machines participating on the network are configured with the address
317 of this WINS server.  If your WINS server is a Samba machine, fill in
318 the Samba machine IP address in the "Primary WINS Server" field of
319 the "Control Panel->Network->Protocols->TCP->WINS Server" dialogs
320 in Windows 95 or Windows NT.  To tell a Samba server the IP address
321 of the WINS server add the following line to the [global] section of
322 all smb.conf files :
323
324         wins server = <name or IP address>
325
326 where <name or IP address> is either the DNS name of the WINS server
327 machine or its IP address.
328
329 Note that this line MUST NOT BE SET in the smb.conf file of the Samba
330 server acting as the WINS server itself.  If you set both the
331 "wins support = yes" option and the "wins server = <name>" option then
332 nmbd will fail to start.
333
334 There are two possible scenarios for setting up cross subnet browsing.
335 The first details setting up cross subnet browsing on a network containing
336 Windows 95, Samba and Windows NT machines that are not configured as
337 part of a Windows NT Domain.  The second details setting up cross subnet
338 browsing on networks that contain NT Domains.
339
340 Setting up Browsing in a WORKGROUP
341 ==================================
342
343 To set up cross subnet browsing on a network containing machines
344 in up to be in a WORKGROUP, not an NT Domain you need to set up one
345 Samba server to be the Domain Master Browser (note that this is *NOT*
346 the same as a Primary Domain Controller, although in an NT Domain the
347 same machine plays both roles).  The role of a Domain master browser is
348 to collate the browse lists from local master browsers on all the
349 subnets that have a machine participating in the workgroup.  Without
350 one machine configured as a domain master browser each subnet would
351 be an isolated workgroup, unable to see any machines on any other
352 subnet.  It is the presense of a domain master browser that makes
353 cross subnet browsing possible for a workgroup.
354
355 In an WORKGROUP environment the domain master browser must be a
356 Samba server, and there must only be one domain master browser per
357 workgroup name.  To set up a Samba server as a domain master browser,
358 set the following option in the [global] section of the smb.conf file :
359
360         domain master = yes
361
362 The domain master browser should also preferrably be the local master
363 browser for its own subnet.  In order to achieve this set the following
364 options in the [global] section of the smb.conf file :
365
366         domain master = yes
367         local master = yes
368         preferred master = yes
369         os level = 65
370
371 The domain master browser may be the same machine as the WINS
372 server, if you require.
373
374 Next, you should ensure that each of the subnets contains a
375 machine that can act as a local master browser for the
376 workgroup.  Any NT machine should be able to do this, as will
377 Windows 95 machines (although these tend to get rebooted more
378 often, so it's not such a good idea to use these).  To make a 
379 Samba server a local master browser set the following
380 options in the [global] section of the smb.conf file :
381
382         domain master = no
383         local master = yes
384         preferred master = yes
385         os level = 65
386
387 Do not do this for more than one Samba server on each subnet,
388 or they will war with each other over which is to be the local
389 master browser.
390
391 The "local master" parameter allows Samba to act as a local master
392 browser.  The "preferred master" causes nmbd to force a browser
393 election on startup and the "os level" parameter sets Samba high
394 enough so that it should win any browser elections.
395
396 If you have an NT machine on the subnet that you wish to
397 be the local master browser then you can disable Samba from
398 becoming a local master browser by setting the following
399 options in the [global] section of the smb.conf file :
400
401         domain master = no
402         local master = no
403         preferred master = no
404         os level = 0
405
406 Setting up Browsing in a DOMAIN
407 ===============================
408
409 If you are adding Samba servers to a Windows NT Domain then
410 you must not set up a Samba server as a domain master browser.
411 By default, a Windows NT Primary Domain Controller for a Domain
412 name is also the Domain master browser for that name, and many
413 things will break if a Samba server registers the Domain master
414 browser NetBIOS name (DOMAIN<1B>) with WINS instead of the PDC.
415
416 For subnets other than the one containing the Windows NT PDC
417 you may set up Samba servers as local master browsers as
418 described.  To make a Samba server a local master browser set 
419 the following options in the [global] section of the smb.conf 
420 file :
421
422         domain master = no
423         local master = yes
424         preferred master = yes
425         os level = 65
426
427 If you wish to have a Samba server fight the election with machines
428 on the same subnet you may set the "os level" parameter to lower
429 levels.  By doing this you can tune the order of machines that
430 will become local master browsers if they are running.  For
431 more details on this see the section "FORCING SAMBA TO BE THE MASTER"
432 below.
433
434 If you have Windows NT machines that are members of the domain
435 on all subnets, and you are sure they will always be running then
436 you can disable Samba from taking part in browser elections and
437 ever becoming a local master browser by setting following options 
438 in the [global] section of the smb.conf file :
439  
440         domain master = no
441         local master = no
442         preferred master = no
443         os level = 0
444
445 FORCING SAMBA TO BE THE MASTER
446 ==============================
447
448 Who becomes the "master browser" is determined by an election process
449 using broadcasts.  Each election packet contains a number of parameters
450 which determine what precedence (bias) a host should have in the
451 election.  By default Samba uses a very low precedence and thus loses
452 elections to just about anyone else.
453
454 If you want Samba to win elections then just set the "os level" global
455 option in smb.conf to a higher number.  It defaults to 0.  Using 34
456 would make it win all elections over every other system (except other
457 samba systems!)
458
459 A "os level" of 2 would make it beat WfWg and Win95, but not NTAS.  A
460 NTAS domain controller uses level 32.
461
462 The maximum os level is 255
463
464 If you want samba to force an election on startup, then set the
465 "preferred master" global option in smb.conf to "yes".  Samba will
466 then have a slight advantage over other potential master browsers
467 that are not preferred master browsers.  Use this parameter with
468 care, as if you have two hosts (whether they are windows 95 or NT or
469 samba) on the same local subnet both set with "preferred master" to
470 "yes", then periodically and continually they will force an election
471 in order to become the local master browser.
472
473 If you want samba to be a "domain master browser", then it is
474 recommended that you also set "preferred master" to "yes", because
475 samba will not become a domain master browser for the whole of your
476 LAN or WAN if it is not also a local master browser on its own
477 broadcast isolated subnet.
478
479 It is possible to configure two samba servers to attempt to become
480 the domain master browser for a domain.  The first server that comes
481 up will be the domain master browser.  All other samba servers will
482 attempt to become the domain master browser every 5 minutes.  They
483 will find that another samba server is already the domain master
484 browser and will fail.  This provides automatic redundancy, should
485 the current domain master browser fail.
486  
487
488 MAKING SAMBA THE DOMAIN MASTER
489 ==============================
490
491 The domain master is responsible for collating the browse lists of
492 multiple subnets so that browsing can occur between subnets.  You can
493 make samba act as the domain master by setting "domain master = yes"
494 in smb.conf.  By default it will not be a domain master.
495
496 Note that you should NOT set Samba to be the domain master for a
497 workgroup that has the same name as an NT Domain.
498
499 When samba is the domain master and the master browser it will listen
500 for master announcements (made roughly every twelve minutes) from local
501 master browsers on other subnets and then contact them to synchronise
502 browse lists.
503
504 If you want samba to be the domain master then I suggest you also set
505 the "os level" high enough to make sure it wins elections, and set
506 "preferred master" to "yes", to get samba to force an election on
507 startup.
508
509 Note that all your servers (including samba) and clients should be
510 using a WINS server to resolve NetBIOS names.  If your clients are only
511 using broadcasting to resolve NetBIOS names, then two things will occur:
512
513 a) your local master browsers will be unable to find a domain master
514    browser, as it will only be looking on the local subnet.
515
516 b) if a client happens to get hold of a domain-wide browse list, and
517    a user attempts to access a host in that list, it will be unable to
518    resolve the NetBIOS name of that host.
519
520 If, however, both samba and your clients are using a WINS server, then:
521
522 a) your local master browsers will contact the WINS server and, as long as
523    samba has registered that it is a domain master browser with the WINS
524    server, your local master browser will receive samba's ip address
525    as its domain master browser.
526
527 b) when a client receives a domain-wide browse list, and a user attempts
528    to access a host in that list, it will contact the WINS server to
529    resolve the NetBIOS name of that host.  as long as that host has
530    registered its NetBIOS name with the same WINS server, the user will
531    be able to see that host.  
532
533 NOTE ABOUT BROADCAST ADDRESSES
534 ==============================
535
536 If your network uses a "0" based broadcast address (for example if it
537 ends in a 0) then you will strike problems.  Windows for Workgroups
538 does not seem to support a 0's broadcast and you will probably find
539 that browsing and name lookups won't work.
540
541
542 MULTIPLE INTERFACES
543 ===================
544
545 Samba now supports machines with multiple network interfaces.  If you
546 have multiple interfaces then you will need to use the "interfaces"
547 option in smb.conf to configure them.  See smb.conf(5) for details.
548