afslogon-wix-cleanup-20040715
[openafs.git] / doc / txt / winnotes / registry.txt
1
2 Registry keys and Environment Variables used in the Windows AFS Client
3 ----------------------------------------------------------------------
4
5 REGISTRY KEYS:
6
7 1. Service parameters
8 ---------------------
9
10 The service parameters primarily affect the behavior of the AFS client
11 service (afsd_service.exe).
12
13 Regkey:
14 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
15
16 Value   : LANadapter
17 Type    : DWORD
18 Default : -1
19 Variable: LANadapter
20
21   LAN adapter number to use.  This is the lana number of the LAN
22   adapter that the SMB server should bind to.  If unspecified or set
23   to -1, a LAN adapter with named 'AFS' or a loopback adapter will be
24   selected.  If neither are present, then all available adapters will
25   be bound to.  When binding to a non-loopback adapter, the NetBIOS
26   name '%hostname%-AFS' will be used (where %hostname% is the NetBIOS
27   name of the host truncated to 11 characters). Otherwise, the NetBIOS
28   name will be 'AFS'.
29
30 Value   : CacheSize
31 Type    : QWORD
32 Default : 20480 (CM_CONFIGDEFAULT_CACHESIZE)
33 Variable: cm_initParams.cacheSize
34
35   Size of the AFS cache.
36
37 Value   : ChunkSize
38 Type    : DWORD
39 Default : 15 (CM_CONFIGDEFAULT_CHUNKSIZE)
40 Variable: cm_logChunkSize (cm_chunkSize = 1 << cm_logChunkSize)
41
42   Size of chunk for reading and writing. Actual chunk size is 2^cm_logChunkSize.
43
44 Value   : Daemons
45 Type    : DWORD
46 Default : 2 (CM_CONFIGDEFAULT_DAEMONS)
47 Variable: numBkgD
48
49   Number of background daemons (number of threads of
50   cm_BkgDaemon). (see cm_BkgDaemon in cm_daemon.c)
51
52 Value   : ServerThreads
53 Type    : DWORD
54 Default : 4 (CM_CONFIGDEFAULT_SVTHREADS)
55 Variable: numSvThreads
56
57   Number of SMB server threads (number of threads of smb_Server). (see
58   smb_Server in smb.c).
59
60 Value   : Stats
61 Type    : QWORD
62 Default : 1000 (CM_CONFIGDEFAULT_STATS)
63 Variable: cm_initParams.nStatCaches
64
65   Cache configuration.
66
67 Value   : LogoffTokenTransfer
68 Type    : DWORD {1,0}
69 Default : 1
70 Variable: smb_LogoffTokenTransfer
71
72   If enabled (set to 1), activates functionality where the user's
73   tokens are kept intact until smb_LogoffTokenTransferTimeout seconds
74   elapse after user logs off.  If roaming profiles are used and the
75   roaming profile takes a long time to be written back, this ensures
76   that the tokens remain valid until the profile save is complete.
77
78 Value   : LogoffTokenTransferTimeout
79 Type    : QWORD
80 Default : 10
81 Variable: smb_LogoffTokenTransferTimeout
82
83   See LogoffTokenTransfer above.
84
85 Value   : RootVolume
86 Type    : REG_SZ
87 Default : "root.afs"
88 Variable: cm_rootVolumeName
89
90   Root volume name.
91
92 Value   : Mountroot
93 Type    : REG_SZ
94 Default : "/afs"
95 Variable: cm_mountRoot
96
97   Name of root mount point.  In symlinks, if a path starts with
98   cm_mountRoot, it is assumed that the path is absolute (as opposed to
99   relative) and is adjusted accordingly. Eg: if a path is specified as
100   /afs/athena.mit.edu/foo/bar/baz and cm_mountRoot is "/afs", then the
101   path is interpreted as \\afs\all\athena.mit.edu\foo\bar\baz.  If a
102   path does not start with with cm_mountRoot, the path is assumed to
103   be relative and suffixed to the reference directory (i.e. directory
104   where the symlink exists)
105  
106 Value   : CachePath
107 Type    : REG_SZ
108 Default : "\AFSCache"
109 Variable: cm_CachePath
110
111   Location of on-disk cache file.  The default implies the root 
112   directory of the boot disk
113
114 Value   : TrapOnPanic
115 Type    : DWORD {1,0}
116 Default : 0
117 Variable: traceOnPanic
118
119   Issues a breakpoint in the event of a panic. (breakpoint: _asm int 3).
120
121 Value   : NetbiosName
122 Type    : REG_EXPAND_SZ
123 Default : "AFS"
124 Variable: cm_NetbiosName
125
126   Specifies the NetBIOS name to be used when binding to a Loopback
127   adapter.  To provide the old behavior specify a value of 
128   "%COMPUTERNAME%-AFS"
129
130 Value   : IsGateway
131 Type    : DWORD {1,0}
132 Default : 0
133 Variable: isGateway
134
135   Select whether or not this AFS client should act as a gateway.  If
136   set and the NetBIOS name hostname-AFS is bound to a physical NIC,
137   other machines in the subnet can access AFS via SMB connections to
138   hostname-AFS.
139
140   When IsGateway is non-zero, the LAN adapter detection code will
141   avoid binding to a loopback adapter.  This will ensure that the
142   NetBIOS name will be of the form hostname-AFS instead of the value
143   set by the "NetbiosName" registry value.
144
145 Value   : ReportSessionStartups
146 Type    : DWORD {1,0}
147 Default : 0
148 Variable: reportSessionStartups
149
150   If enabled, all SMB sessions created are recorded in the Application
151   event log.  This also enables other events such as drive mappings
152   or various error types to be logged.
153
154 Value   : TraceBufferSize
155 Type    : QWORD
156 Default : 5000 (CM_CONFIGDEFAULT_TRACEBUFSIZE)
157 Variable: traceBufSize
158
159   Number of entries to keep in trace log.
160
161 Value   : SysName
162 Type    : REG_SZ
163 Default : "i386_nt40"
164 Variable: cm_sysName
165
166   Self explanatory.
167
168 Value   : SecurityLevel
169 Type    : DWORD {1,0}
170 Default : 0
171 Variable: cryptall
172
173   Enables encryption on RX calls.
174
175 Value   : UseDNS
176 Type    : DWORD {1,0}
177 Default : 1
178 Variable: cm_dnsEnabled
179
180   Enables resolving volservers using AFSDB DNS queries. (see
181   afsdb-freelance-notes).
182
183   As of 1.3.60, this value is ignored as the DNS query support
184   utilizes the Win32 DNSQuery API which is available on Win2000
185   and above.
186
187 Value   : FreelanceClient
188 Type    : DWORD {1,0}
189 Default : 0
190 Variable: cm_freelanceEnabled
191
192   Enables freelance client. (see afsdb-freelance-notes)
193
194 Value   : HideDotFiles
195 Type    : DWORD {1,0}
196 Default : 1
197 Variable: smb_hideDotFiles
198
199   Enables marking dotfiles with the hidden attribute.  Dot files are
200   files whose name starts with a period (excluding "." and "..").
201
202 Value   : MaxMpxRequests
203 Type    : DWORD
204 Default : 50
205 Variable: smb_maxMpxRequests
206
207   Maximum number of multiplexed SMB requests that can be made.
208
209 Value   : MaxVCPerServer
210 Type    : DWORD
211 Default : 100
212 Variable: smb_maxVCPerServer
213
214   Maximum number of SMB virtual circuits.
215
216 Value   : Cell
217 Type    : REG_SZ
218 Default : <none>
219 Variable: rootCellName
220
221   Name of root cell (the cell from which root.afs should be mounted in
222   \\afs\all).
223
224 Value   : RxNoJumbo
225 Type    : DWORD {0,1}
226 Default : 0
227 Variable: rx_nojumbo
228
229   If enabled, does not send or indicate that we are able to send or
230   receive RX jumbograms.
231
232 Value   : RxMaxMTU
233 Type    : DWORD
234 Default : -1
235 Variable: rx_mtu
236
237   If set to anything other than -1, uses that value as the maximum MTU
238   supported by the RX interface.
239
240   In order to enable OpenAFS to operate across the Cisco IPSec VPN
241   client, this value must be set to 1264 or smaller.
242
243 Value   : ConnDeadTimeout
244 Type    : DWORD
245 Default : 60 (seconds)
246 Variable: ConnDeadtimeout
247
248   The Connection Dead Time is enforced to be at a minimum 15 seconds 
249   longer than the minimum SMB timeout as specified by 
250
251   HKLM\SYSTEM\CurrentControlSet\Services\lanmanworkstation\parameters
252     SessTimeout
253
254   If the minimum SMB timeout is not specified the value is 45 seconds.
255   See http://support.microsoft.com:80/support/kb/articles/Q102/0/67.asp
256
257
258 Value   : HardDeadTimeout
259 Type    : DWORD
260 Default : 120 (seconds)
261 Variable: HardDeadtimeout
262
263   The Hard Dead Time is enforced to be at least double the ConnDeadTimeout.
264   The provides an opportunity for at least one retry.
265
266
267 Value   : AllSubmount
268 Type    : DWORD {0, 1}
269 Default : 1
270 Variable: allSubmount (smb.c)
271
272   By setting this value to 0, the "\\NetbiosName\all" mount point 
273   will not be created.  This allows the read-write versions of 
274   root.afs to be hidden.
275
276 Value   : NoFindLanaByName
277 Type    : DWORD {0, 1}
278 Default : 0
279
280   Disables the attempt to identity the network adapter to use by 
281   looking for an adapter with a display name of "AFS".
282
283 Value   : MaxCPUs
284 Type    : DWORD {1..32} or {1..64} depending on the architecture
285 Default : <no default>
286
287   If this value is specified, afsd_service.exe will restrict itself
288   to executing on the specified number of CPUs if there are a greater
289   number installed in the machine.  
290
291   NOTE: Setting this entry to "1" may be required on hyperthreaded 
292   systems to avoid crashes in the RX library.
293
294 Value   : smbAuthType
295 Type    : DWORD {0..2} 
296 Default : 2
297
298   If this value is specified, it defines the type of SMB authentication    
299   which must be present in order for the Windows SMB client to connect
300   to the AFS Client Service's SMB server.  The values are:
301     0 = No authentication required
302     1 = NTLM authentication required
303     2 = Extended (GSS SPNEGO) authentication required
304   The default is Extended authentication
305
306 Regkey:
307 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters\GlobalAutoMapper]
308
309 Value   : <Drive Letter:> for example "G:"
310 Type    : SZ
311
312     Specifies the submount name to be mapped by afsd_service.exe at startup
313     to the provided drive letter.
314
315
316
317 Regkey:
318 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
319
320
321 2. Network provider parameters
322 ------------------------------
323 Affects the network provider (aklogon.dll).
324
325 Regkey:
326 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
327
328 Value   : FailLoginsSilently
329 Type    : DWORD
330 Default : 0
331
332   Do not display message boxes if the login fails.
333
334 Regkey:
335 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
336
337 Value   : NoWarnings
338 Type    : DWORD
339 Default : 0
340
341   Disables visible warnings during logon.
342
343 Value   : AuthentProviderPath
344 Type    : REG_SZ
345 NSIS    : <install path>\afslogon.dll
346
347   Specifies the install location of the authentication provider dll.
348
349 Value   : Class
350 Type    : DWORD
351 NSIS    : 0x02
352
353   Specifies the class of network provider
354
355 Value   : DependOnGroup
356 Type    : REG_MULTI_SZ
357 NSIS    : PNP_TDI
358
359   Specifies the service groups upon which the AFS Client Service 
360   depends.  Windows should not attempt to start the AFS Client Service
361   until all of the services within these groups have successfully 
362   started.
363
364 Value   : DependOnService
365 Type    : REG_MULTI_SZ
366 NSIS    : Tcpip NETBIOS RpcSs
367
368   Specifies a list of services upon which the AFS Client Service 
369   depends.  Windows should not attempt to start the AFS Client Service
370   until all of the specified services have successfully started.
371   
372 Value   : LogonOptions
373 Type    : DWORD
374 NSIS    : depends on user configuration
375
376   0x00 - Integrated Logon is not used
377   0x01 - Integrated Logon is used
378   0x02 - High Security Mode is used
379   0x03 - Integrated Logon with High Security Mode is used
380
381   High Security Mode generates random SMB names for the creation of
382   Drive Mappings.  This mode should not be used without Integrated Logon.
383
384 Value   : LogonScript
385 Type    : REG_SZ
386 NSIS    : <install path>\afscreds.exe -:%s -x
387
388   Specifies the command to be executed at the end of successful logon.
389
390 Value   : Name
391 Type    : REG_SZ
392 NSIS    : "OpenAFSDaemon"
393
394   Specifies the display name of the AFS Client Service
395
396 Value   : ProviderPath
397 Type    : REG_SZ
398 NSIS    : <install path>\afslogon.dll
399
400   Specifies the DLL to use for the network provider
401
402 Value  : TraceOption
403 Type   : DWORD {1|0}
404 Default : 0
405
406   Enables trace events for the network provider.
407
408 Value   : VerboseLogging
409 Type    : DWORD
410 NSIS    : 0x0a
411
412   Determines the level of logging to be enabled
413
414
415 3. AFS Credentials System Tray Tool parameters
416 ----------------------------------------------
417 Affects the behavior of afscreds.exe
418
419 Regkey:
420 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
421
422 Value   : Gateway
423 Type    : REG_SZ
424 Default : ""
425 Function: GetGatewayName()
426
427   If the AFS client is utilizing a gateway to obtain AFS access, 
428   the name of the gateway is specified by this value.
429
430 Value   : Cell
431 Type    : REG_SZ
432 Default : <none>
433 Variable: IsServiceConfigured()
434
435   The value Cell is used to determine if the AFS Client Service has
436   been properly configured or not.
437
438
439 Regkey:
440 [HKLM\SOFTWARE\OpenAFS\Client]
441 [HKCU\SOFTWARE\OpenAFS\Client]
442
443 Value   : ShowTrayIcon
444 Type    : DWORD {0, 1}
445 Default : 1
446 Function: InitApp(), Main_OnCheckTerminate()
447
448   This value is used to determine whether or not a shortcut should be
449   maintained in the user's Start Menu->Programs->Startup folder. 
450
451   This value used to be stored at 
452   [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].
453
454 Value   : EnableKFW
455 Type    : DWORD {0, 1}
456 Default : 1
457 Function: KFW_is_available()
458
459   When MIT Kerberos for Windows can be loaded, Kerberos 5 will be used
460   to obtain AFS credentials.  By setting this value to 0, the internal
461   Kerberos 4 implementation will be used instead.
462
463 Value   : AfscredsShortcutParams
464 Type    : REG_SZ
465 Default : "-A -M -N -Q"
466 Function: Shortcut_FixStartup
467
468   This value specifies the command line options which should be set
469   as part of the shortcut to afscreds.exe.
470
471
472 Regkey:
473 [HKCU\SOFTWARE\OpenAFS\Client]
474
475 Value   : Authentication Cell
476 Type    : REG_SZ
477 Default : <none>
478 Function: Afscreds.exe GetDefaultCell()
479
480   This value allows the user to configure a different cell name to
481   be used as the default cell when acquiring tokens in afscreds.exe
482
483
484 Regkey:
485 [HKCU\SOFTWARE\OpenAFS\Client]
486
487 Value   : Authentication Cell
488 Type    : REG_SZ
489 Default : <none>
490 Function: Afscreds.exe GetDefaultCell()
491
492   This value allows the user to configure a different cell name to
493   be used as the default cell when acquiring tokens in afscreds.exe
494
495
496 Regkey:
497 [HKCU\SOFTWARE\OpenAFS\Client\Reminders]
498
499 Value   : "afs cell name"
500 Type    : DWORD {0, 1}
501 Default : <none>
502 Function: LoadRemind(), SaveRemind()
503
504   These values are used to save and restore the state of the reminder
505   flag for each cell for which the user has obtained tokens.
506
507   This value used to be stored at 
508   [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].
509
510
511 Regkey:
512 [HKCU\SOFTWARE\OpenAFS\Client\Active Maps]
513
514 Value   : "upper case drive letter"
515 Type    : DWORD {0, 1}
516 Default : <none>
517
518   These values are used to store the persistence state of the AFS 
519   drive mappings as listed in the [...\Client\Mappings] key
520
521   These values used to be stored in the afsdsbmt.ini file
522
523 Regkey:
524 [HKCU\SOFTWARE\OpenAFS\Client\Mappings]
525
526 Value   : "upper case drive letter"
527 Type    : REG_SZ
528 Default : <none>
529
530   These values are used to store the AFS path in Unix notation
531   to which the drive letter is to be mapped.
532
533   These values used to be stored in the afsdsbmt.ini file.
534
535
536 Regkey:
537 [HKLM\SOFTWARE\OpenAFS\Client\CSCPolicy]
538
539 Value   : "smb/cifs share name"
540 Type    : REG_SZ
541 Default : <none>
542
543     This key is used to map SMB/CIFS shares to Client Side Caching 
544     (off-line access) policies. For each share one of the following
545     policies may be used: "manual", "programs", "documents", "disable"
546
547     These values used to be stored in afsdsbmt.ini
548
549 Regkey:
550 [HKLM\SOFTWARE\OpenAFS\Client\Freelance]
551
552 Value   : "numeric value"
553 Type    : REG_SZ
554 Default : <none>
555
556     This key is used to store newline terminated mount point strings 
557     for use in constructing the fake root.afs volume when Freelance
558     (dynamic roots) mode is activated.
559
560         "athena.mit.edu#athena.mit.edu:root.cell.\n"
561         ".athena.mit.edu%athena.mit.edu:root.cell.\n"
562
563     These values used to be stored in afs_freelance.ini
564
565
566 Regkey:
567 [HKLM\SOFTWARE\OpenAFS\Client\Submounts]
568
569 Value   : "submount name"
570 Type    : REG_SZ
571 Default : <none>
572
573     This key is used to store mappings of unix style AFS paths
574     to submount names which can be referenced as UNC paths.
575     For example the submount string "/athena.mit.edu/user/j/a/jaltman"
576     can be associated with the submount name "jaltman.home".
577     This can then be referenced as the UNC path \\AFS\jaltman.home.
578
579     These values used to be stored in afsdsbmt.ini
580
581
582 Regkey:
583 [HKCU\SOFTWARE\OpenAFS\Client\Active Maps]
584
585 Value   : "upper case drive letter"
586 Type    : DWORD {0, 1}
587 Default : <none>
588
589   These values are used to store the persistence state of the AFS 
590   drive mappings as listed in the [...\Client\Mappings] key
591
592   These values used to be stored in the afsdsbmt.ini file
593
594 Regkey:
595 [HKCU\SOFTWARE\OpenAFS\Client\Mappings]
596
597 Value   : "upper case drive letter"
598 Type    : REG_SZ
599 Default : <none>
600
601   These values are used to store the AFS path in Unix notation
602   to which the drive letter is to be mapped.
603
604   These values used to be stored in the afsdsbmt.ini file.
605
606
607 Regkey:
608 [HKLM\SOFTWARE\OpenAFS\Client\CSCPolicy]
609
610 Value   : "smb/cifs share name"
611 Type    : REG_SZ
612 Default : <none>
613
614     This key is used to map SMB/CIFS shares to Client Side Caching 
615     (off-line access) policies. For each share one of the following
616     policies may be used: "manual", "programs", "documents", "disable"
617
618     These values used to be stored in afsdsbmt.ini
619
620 Regkey:
621 [HKLM\SOFTWARE\OpenAFS\Client\Freelance]
622
623 Value   : "numeric value"
624 Type    : REG_SZ
625 Default : <none>
626
627     This key is used to store newline terminated mount point strings 
628     for use in constructing the fake root.afs volume when Freelance
629     (dynamic roots) mode is activated.
630
631         "athena.mit.edu#athena.mit.edu:root.cell.\n"
632         ".athena.mit.edu%athena.mit.edu:root.cell.\n"
633
634     These values used to be stored in afs_freelance.ini
635
636
637 Regkey:
638 [HKLM\SOFTWARE\OpenAFS\Client\Submounts]
639
640 Value   : "submount name"
641 Type    : REG_SZ
642 Default : <none>
643
644     This key is used to store mappings of unix style AFS paths
645     to submount names which can be referenced as UNC paths.
646     For example the submount string "/athena.mit.edu/user/j/a/jaltman"
647     can be associated with the submount name "jaltman.home".
648     This can then be referenced as the UNC path \\AFS\jaltman.home.
649
650     These values used to be stored in afsdsbmt.ini
651
652
653 ENVIRONMENT VARIABLES:
654
655 Variable: AFS_RPC_ENCRYPT 
656 Values:   "OFF" disables the use of RPC encryption
657           any other value allows RPC encryption to be used
658 Default:  RPC encryption is on
659
660
661 Variable: AFS_RPC_PROTSEQ
662 Values:   "ncalrpc"  - local RPC 
663           "ncacn_np" - named pipes
664           "ncacn_ip_tcp" - tcp/ip
665 Default:  local RPC
666