windows-notes-20050529
[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    : DWORD
32 Default : 98304 (CM_CONFIGDEFAULT_CACHESIZE)
33 Variable: cm_initParams.cacheSize
34
35   Size of the AFS cache in 1k blocks.
36
37 Value   : ChunkSize
38 Type    : DWORD
39 Default : 17 (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 : 25 (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    : DWORD
62 Default : 10000 (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    : DWORD
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
107 Value   : CachePath
108 Type    : REG_SZ or REG_EXPAND_SZ
109 Default : "%TEMP%\AFSCache"
110 Variable: cm_CachePath
111
112   Location of on-disk cache file.  The default is the SYSTEM account's
113   TEMP directory.  The attributes assigned to the file are HIDDEN and
114   SYSTEM.
115
116
117 Value   : NonPersistentCaching
118 Type    : DWORD [0..1]
119 Default : 0
120 Variable: buf_CacheType
121
122   When this registry value is set to a non-zero value, the CachePath
123   value is ignored and the cache data is stored in the windows paging
124   file.  This prevents the use of persistent caching (when available)
125   as well as the ability to alter the size of the cache at runtime
126   using the "fs setcachesize" command.
127
128
129 Value   : ValidateCache
130 Type    : DWORD [0..2]
131 Default : 1
132 Variable: buf_CacheType
133
134   This value determines if and when persistent cache validation is 
135   performed.
136     0 - Validation is disabled
137     1 - Validation is performed at startup
138     2 - Validation is performed at shutdown
139
140
141 Value   : TrapOnPanic
142 Type    : DWORD {1,0}
143 Default : 0
144 Variable: traceOnPanic
145
146   Issues a breakpoint in the event of a panic. (breakpoint: _asm int 3).
147
148 Value   : NetbiosName
149 Type    : REG_EXPAND_SZ
150 Default : "AFS"
151 Variable: cm_NetbiosName
152
153   Specifies the NetBIOS name to be used when binding to a Loopback
154   adapter.  To provide the old behavior specify a value of 
155   "%COMPUTERNAME%-AFS"
156
157 Value   : IsGateway
158 Type    : DWORD {1,0}
159 Default : 0
160 Variable: isGateway
161
162   Select whether or not this AFS client should act as a gateway.  If
163   set and the NetBIOS name hostname-AFS is bound to a physical NIC,
164   other machines in the subnet can access AFS via SMB connections to
165   hostname-AFS.
166
167   When IsGateway is non-zero, the LAN adapter detection code will
168   avoid binding to a loopback adapter.  This will ensure that the
169   NetBIOS name will be of the form hostname-AFS instead of the value
170   set by the "NetbiosName" registry value.
171
172 Value   : ReportSessionStartups
173 Type    : DWORD {1,0}
174 Default : 0
175 Variable: reportSessionStartups
176
177   If enabled, all SMB sessions created are recorded in the Application
178   event log.  This also enables other events such as drive mappings
179   or various error types to be logged.
180
181 Value   : TraceBufferSize
182 Type    : DWORD
183 Default : 5000 (CM_CONFIGDEFAULT_TRACEBUFSIZE)
184 Variable: traceBufSize
185
186   Number of entries to keep in trace log.
187
188 Value   : SysName
189 Type    : REG_SZ
190 Default : "i386_nt40"
191 Variable: cm_sysName
192
193   Provides an initial value for "fs sysname".  The string can contain
194   one or more replacement values for @sys in order of preference separated 
195   by whitespace.
196
197 Value   : SecurityLevel
198 Type    : DWORD {1,0}
199 Default : 0
200 Variable: cryptall
201
202   Enables encryption on RX calls.
203
204 Value   : UseDNS
205 Type    : DWORD {1,0}
206 Default : 1
207 Variable: cm_dnsEnabled
208
209   Enables resolving volservers using AFSDB DNS queries. (see
210   afsdb-freelance-notes).
211
212   As of 1.3.60, this value is ignored as the DNS query support
213   utilizes the Win32 DNSQuery API which is available on Win2000
214   and above.
215
216 Value   : FreelanceClient
217 Type    : DWORD {1,0}
218 Default : 0
219 Variable: cm_freelanceEnabled
220
221   Enables freelance client. (see afsdb-freelance-notes)
222
223 Value   : HideDotFiles
224 Type    : DWORD {1,0}
225 Default : 1
226 Variable: smb_hideDotFiles
227
228   Enables marking dotfiles with the hidden attribute.  Dot files are
229   files whose name starts with a period (excluding "." and "..").
230
231 Value   : MaxMpxRequests
232 Type    : DWORD
233 Default : 50
234 Variable: smb_maxMpxRequests
235
236   Maximum number of multiplexed SMB requests that can be made.
237
238 Value   : MaxVCPerServer
239 Type    : DWORD
240 Default : 100
241 Variable: smb_maxVCPerServer
242
243   Maximum number of SMB virtual circuits.
244
245 Value   : Cell
246 Type    : REG_SZ
247 Default : <none>
248 Variable: rootCellName
249
250   Name of root cell (the cell from which root.afs should be mounted in
251   \\afs\all).
252
253 Value   : RxNoJumbo
254 Type    : DWORD {0,1}
255 Default : 0
256 Variable: rx_nojumbo
257
258   If enabled, does not send or indicate that we are able to send or
259   receive RX jumbograms.
260
261 Value   : RxMaxMTU
262 Type    : DWORD
263 Default : -1
264 Variable: rx_mtu
265
266   If set to anything other than -1, uses that value as the maximum MTU
267   supported by the RX interface.
268
269   In order to enable OpenAFS to operate across the Cisco IPSec VPN
270   client, this value must be set to 1264 or smaller.
271
272 Value   : ConnDeadTimeout
273 Type    : DWORD
274 Default : 60 (seconds)
275 Variable: ConnDeadtimeout
276
277   The Connection Dead Time is enforced to be at a minimum 15 seconds 
278   longer than the minimum SMB timeout as specified by 
279
280   HKLM\SYSTEM\CurrentControlSet\Services\lanmanworkstation\parameters
281     SessTimeout
282
283   If the minimum SMB timeout is not specified the value is 45 seconds.
284   See http://support.microsoft.com:80/support/kb/articles/Q102/0/67.asp
285
286
287 Value   : HardDeadTimeout
288 Type    : DWORD
289 Default : 120 (seconds)
290 Variable: HardDeadtimeout
291
292   The Hard Dead Time is enforced to be at least double the ConnDeadTimeout.
293   The provides an opportunity for at least one retry.
294
295
296 Value  : TraceOption
297 Type   : DWORD {0, 1, 2, 3}
298 Default : 0
299
300   Enables logging of debug output to the Windows Event Log.
301   Bit 0 enables logging of "Logon Events" processed by the Network Provider
302   and Winlogon Event Notification Handler.  
303   Bit 1 enables logging of events captured by the AFS Client Service.
304
305 Value   : AllSubmount
306 Type    : DWORD {0, 1}
307 Default : 1
308 Variable: allSubmount (smb.c)
309
310   By setting this value to 0, the "\\NetbiosName\all" mount point 
311   will not be created.  This allows the read-write versions of 
312   root.afs to be hidden.
313
314 Value   : NoFindLanaByName
315 Type    : DWORD {0, 1}
316 Default : 0
317
318   Disables the attempt to identity the network adapter to use by 
319   looking for an adapter with a display name of "AFS".
320
321 Value   : MaxCPUs
322 Type    : DWORD {1..32} or {1..64} depending on the architecture
323 Default : <no default>
324
325   If this value is specified, afsd_service.exe will restrict itself
326   to executing on the specified number of CPUs if there are a greater
327   number installed in the machine.  
328
329   NOTE: Setting this entry to "1" may be required on hyperthreaded 
330   systems to avoid crashes in the RX library.
331
332 Value   : smbAuthType
333 Type    : DWORD {0..2} 
334 Default : 2
335
336   If this value is specified, it defines the type of SMB authentication    
337   which must be present in order for the Windows SMB client to connect
338   to the AFS Client Service's SMB server.  The values are:
339     0 = No authentication required
340     1 = NTLM authentication required
341     2 = Extended (GSS SPNEGO) authentication required
342   The default is Extended authentication
343
344 Value   : MaxLogSize
345 Type    : DWORD {0 .. MAXDWORD}
346 Default : 100K
347
348   This entry determines the maximum size of the %WINDIR%\TEMP\afsd_init.log 
349   file.  If the file is larger than this value when afsd_service.exe starts
350   the file will be reset to 0 bytes.  If this value is 0, it means the file
351   should be allowed to grow indefinitely.
352
353 Value   : FlushOnHibernate
354 Type    : DWORD {0,1}
355 Default : 1
356
357   If set, flushes all volumes before the machine goes on hibernate or
358   stand-by.
359
360 Regkey:
361 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters\GlobalAutoMapper]
362
363 Value   : <Drive Letter:> for example "G:"
364 Type    : SZ
365
366     Specifies the submount name to be mapped by afsd_service.exe at startup
367     to the provided drive letter.
368
369
370 Regkey:
371 [HKLM\SOFTWARE\OpenAFS\Client]
372
373 Value   : CellServDBDir
374 Type    : REG_SZ
375 Default : <not defined>
376
377   Specifies the directory containing the CellServDB file.
378   When this value is not specified, the AFS Client install
379   directory is used.
380
381
382 Value   : VerifyServiceSignature
383 Type    : REG_DWORD
384 Default : 0x1
385
386   This value can be used to disable the runtime verification of 
387   the digital signatures applied to afsd_service.exe and the 
388   OpenAFS DLLs it loads.  This test is performed to verify that 
389   the DLLs which are loaded by afsd_service.exe are from the 
390   same distribution as afsd_service.exe.  This is to prevent
391   random errors caused when DLLs from one distribution of AFS
392   are loaded by another one.  This is not a security test.  The
393   reason for disabling this test is to free up additional memory
394   which can be used for a large cache size.
395
396
397 Value   : IoctlDebug
398 Type    : REG_DWORD
399 Default : 0x0
400
401   This value can be used to debug the cause of pioctl() failures.
402   Set a non-zero value and the pioctl() library will output status
403   information to stdout.  Executing command line tools such as
404   tokens.exe, fs.exe, etc can then be used to determine why the
405   pioctl() call is failing. 
406
407
408 Value   : MiniDumpType
409 Type    : REG_DWORD
410 Default : 0x0 (MiniDumpNormal)
411
412   This value is used to specify the type of minidump generated by
413   afsd_service.exe either when the process crashes or when a user
414   initiated is dump file is generated with the "fs.exe minidump"
415   command.
416
417   Valid values are dependent on the version of DbgHelp.dll installed
418   on the machine.  See the Microsoft Developer Library for further
419   information.
420
421   MiniDumpNormal = 0x00000000,
422   MiniDumpWithDataSegs = 0x00000001,
423   MiniDumpWithFullMemory = 0x00000002,
424   MiniDumpWithHandleData = 0x00000004,
425   MiniDumpFilterMemory = 0x00000008,
426   MiniDumpScanMemory = 0x00000010,
427   MiniDumpWithUnloadedModules = 0x00000020,
428   MiniDumpWithIndirectlyReferencedMemory = 0x00000040,
429   MiniDumpFilterModulePaths = 0x00000080,
430   MiniDumpWithProcessThreadData = 0x00000100,
431   MiniDumpWithPrivateReadWriteMemory = 0x00000200,
432   MiniDumpWithoutOptionalData = 0x00000400,
433   MiniDumpWithFullMemoryInfo = 0x00000800,
434   MiniDumpWithThreadInfo = 0x00001000,
435   MiniDumpWithCodeSegs = 0x00002000
436
437
438 Value   : StoreAnsiFilenames
439 Type    : REG_DWORD
440 Default : 0x0
441
442   This value can be used to force the AFS Client Service to
443   store filenames using the Windows system's ANSI character set
444   instead of the OEM Code Page character set which has traditionally
445   been used by SMB file systems.  
446
447   Note: The use of ANSI characters will render access to files
448   with 8-bit OEM file names unaccessible from Windows.  This option
449   is of use primarily when you wish to allow file names produced
450   on Windows to be accessible from Latin-1 Unix systems and vice
451   versa.
452
453
454 Regkey:
455 [HKLM\SOFTWARE\OpenAFS\Client\CSCPolicy]
456
457 Value   : "smb/cifs share name"
458 Type    : REG_SZ
459 Default : <none>
460
461     This key is used to map SMB/CIFS shares to Client Side Caching 
462     (off-line access) policies. For each share one of the following
463     policies may be used: "manual", "programs", "documents", "disable"
464
465     These values used to be stored in afsdsbmt.ini
466
467 Regkey:
468 [HKLM\SOFTWARE\OpenAFS\Client\Freelance]
469
470 Value   : "numeric value"
471 Type    : REG_SZ
472 Default : <none>
473
474     This key is used to store dot terminated mount point strings 
475     for use in constructing the fake root.afs volume when Freelance
476     (dynamic roots) mode is activated.
477
478         "athena.mit.edu#athena.mit.edu:root.cell."
479         ".athena.mit.edu%athena.mit.edu:root.cell."
480
481     These values used to be stored in afs_freelance.ini
482
483
484 Regkey:
485 [HKLM\SOFTWARE\OpenAFS\Client\Freelance\Symlinks]
486
487 Value   : "numeric value"
488 Type    : REG_SZ
489 Default : <none>
490
491     This key is used to store a dot terminated symlink strings 
492     for use in constructing the fake root.afs volume when Freelance
493     (dynamic roots) mode is activated.
494
495         "linkname:destination-path."
496         "athena:athena.mit.edu."
497         "home:athena.mit.edu\user\j\a\jaltman."
498         "filename:path\file."
499
500
501 Regkey:
502 [HKLM\SOFTWARE\OpenAFS\Client\Submounts]
503
504 Value   : "submount name"
505 Type    : REG_EXPAND_SZ
506 Default : <none>
507
508     This key is used to store mappings of unix style AFS paths
509     to submount names which can be referenced as UNC paths.
510     For example the submount string "/athena.mit.edu/user/j/a/jaltman"
511     can be associated with the submount name "jaltman.home".
512     This can then be referenced as the UNC path \\AFS\jaltman.home.
513
514     These values used to be stored in afsdsbmt.ini
515
516     NOTE: Submounts should no longer be used with OpenAFS.
517     Use the Windows Explorer to create drive mappings to AFS UNC
518     paths instead of using the AFS Submount mechanism.
519
520
521 Regkey:
522 [HKLM\SOFTWARE\OpenAFS\Client\Server Preferences\VLDB]
523
524 Value   : "hostname or ip address"
525 Type    : REG_DWORD
526 Default : <none>
527
528     This key is used to specify a default set of VLDB server preferences.
529     For each entry the value name will be either the IP address of a server
530     or a fully qualified domain name.  The value will be the ranking.  The
531     ranking will be adjusted by a random value between 0 and 256 prior to
532     the preference being set.
533
534
535 Regkey:
536 [HKLM\SOFTWARE\OpenAFS\Client\Server Preferences\File]
537
538 Value   : "hostname or ip address"
539 Type    : REG_DWORD
540 Default : <none>
541
542     This key is used to specify a default set of File server preferences.
543     For each entry the value name will be either the IP address of a server
544     or a fully qualified domain name.  The value will be the ranking.  The
545     ranking will be adjusted by a random value between 0 and 256 prior to
546     the preference being set.
547
548
549
550 2. Network provider parameters
551 ------------------------------
552 Affects the network provider (afslogon.dll).
553
554 Regkey:
555 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
556
557 Value   : FailLoginsSilently
558 Type    : DWORD
559 Default : 0
560
561   Do not display message boxes if the login fails.
562
563 Regkey:
564 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
565
566 Value   : NoWarnings
567 Type    : DWORD
568 Default : 0
569
570   Disables visible warnings during logon.
571
572 Value   : AuthentProviderPath
573 Type    : REG_SZ
574 NSIS    : %WINDIR%\SYSTEM32\afslogon.dll
575
576   Specifies the install location of the authentication provider dll.
577
578 Value   : Class
579 Type    : DWORD
580 NSIS    : 0x02
581
582   Specifies the class of network provider
583
584 Value   : DependOnGroup
585 Type    : REG_MULTI_SZ
586 NSIS    : PNP_TDI
587
588   Specifies the service groups upon which the AFS Client Service 
589   depends.  Windows should not attempt to start the AFS Client Service
590   until all of the services within these groups have successfully 
591   started.
592
593 Value   : DependOnService
594 Type    : REG_MULTI_SZ
595 NSIS    : Tcpip NETBIOS RpcSs
596
597   Specifies a list of services upon which the AFS Client Service 
598   depends.  Windows should not attempt to start the AFS Client Service
599   until all of the specified services have successfully started.
600   
601 Value   : Name
602 Type    : REG_SZ
603 NSIS    : "OpenAFSDaemon"
604
605   Specifies the display name of the AFS Client Service
606
607 Value   : ProviderPath
608 Type    : REG_SZ
609 NSIS    : %WINDIR%\SYSTEM32\afslogon.dll
610
611   Specifies the DLL to use for the network provider
612
613
614 2.1 Domain specific configuration keys for the Network Provider
615 ---------------------------------------------------------------
616
617 The network provider can be configured to have different behavior
618 depending on the domain that the user logs into.  These settings are
619 only relevant when using integrated login.  A domain refers to an
620 Active Directory (AD) domain, a trusted Kerberos (non-AD) realm or the
621 local machine (i.e. local account logins).  The domain name that is
622 used for selecting the domain would be the domain that is passed into
623 the NPLogonNotify function of the network provider.
624
625 Domain specific registry keys are :
626
627 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
628   (NP key)
629
630 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]
631   (Domains key)
632
633 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\"domain name"]
634   (Specific domain key. One per domain.)
635
636 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]
637   (Localhost key)
638
639 eg:
640  HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider
641   |
642   +- Domain
643      +-AD1.EXAMPLE.COM
644      +-AD2.EXAMPLE.NET
645      +-LOCALHOST
646
647 Each of the domain specific keys can have the set of values described
648 in 2.1.1.  The effective values are chosen as described in 2.1.2.
649
650 2.1.1  Domain specific configuration values
651 -------------------------------------------
652 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
653 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]
654 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\"domain name"]
655 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]
656
657   Value   : LogonOptions
658   Type    : DWORD
659   Default : 0x01
660   NSIS/WiX: depends on user configuration
661
662   0x00 - Integrated Logon is not used
663   0x01 - Integrated Logon is used
664   0x02 - High Security Mode is used
665   0x03 - Integrated Logon with High Security Mode is used
666
667   High Security Mode generates random SMB names for the creation of
668   Drive Mappings.  This mode should not be used without Integrated Logon.
669
670   As of 1.3.65 the SMB server supports SMB authentication.  The High
671   Security Mode should not be used when using SMB authentication
672   (SMBAuthType setting is non zero).
673
674   Value   : FailLoginsSilently
675   Type    : DWORD (1|0)
676   Default : 0
677   NSIS/WiX: (not set)
678
679      If true, does not display any visible warnings in the event of an
680      error during the integrated login process.
681
682   Value   : LogonScript
683   Type    : REG_SZ or REG_EXPAND_SZ
684   Default : (null)
685   NSIS/WiX: (only value under NP key) <install path>\afscreds.exe -:%s -x -a -m -n -q
686
687      A logon script that will be scheduled to be run after the profile
688      load is complete.  If using the REG_EXPAND_SZ type, you can use
689      any system environment variable as "%varname%" which would be
690      expanded at the time the network provider is run.  Optionally
691      using a "%s" in the value would result in it being expanded into
692      the AFS SMB username for the session.
693
694   Value   : LoginRetryInterval
695   Type    : DWORD
696   Default : 30
697   NSIS/WiX: (not set)
698
699      If the OpenAFS client service has not started yet, the network
700      provider will wait for a maximum of "LoginRetryInterval" seconds
701      while retrying every "LoginSleepInterval" seconds to check if the
702      service is up.
703
704   Value   : LoginSleepInterval
705   Type    : DWORD
706   Default : 5
707   NSIS/WiX: (not set)
708
709      See description of LoginRetryInterval.
710
711   Value   : TheseCells
712   Type    : REG_MULTI_SZ
713   NSIS    : <not set>
714
715     When Kerberos 5 is being used, TheseCells provides a list of additional
716     cells for which tokens should be obtained with the default Kerberos 5 
717     principal.
718
719
720 2.1.2  Selection of effective values for domain specific configuration
721 ----------------------------------------------------------------------
722
723   During login to domain X, where X is the domain passed into
724   NPLogonNotify as lpAuthentInfo->LogonDomainName or the string
725   'LOCALHOST' if lpAuthentInfo->LogonDomainName equals the name of the
726   computer, the following keys will be looked up.
727
728     1. NP key. ("HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider")
729     2. Domains key. (NP key\"Domain")
730     3. Specific domain key. (Domains key\X)
731
732   If the specific domain key does not exist, then the domains key will
733   be ignored.  All the configuration information in this case will
734   come from the NP key.
735
736   If the specific domain key exists, then for each of the values
737   metioned in (2), they will be looked up in the specific domain key,
738   domains key and the NP key successively until the value is found.
739   The first instance of the value found this way will be the effective
740   for the login session.  If no such instance can be found, the
741   default will be used.  To re-iterate, a value in a more specific key
742   supercedes a value in a less specific key.  The exceptions to this
743   rule are stated below.
744
745 2.1.3  Exceptions to 2.1.2
746 --------------------------
747
748   To retain backwards compatibility, the following exceptions are made
749   to 2.1.2.
750
751 2.1.3.1 'FailLoginsSilently'
752
753   Historically, the 'FailLoginsSilently' value was in
754   HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters
755   key and not in the NP key.  Therefore, for backwards compatibility,
756   the value in the Parameters key will supercede all instances of this
757   value in other keys.  In the absence of this value in the Parameters
758   key, normal scope rules apply.
759
760 2.1.3.2 'LogonScript'
761
762   If a 'LogonScript' is not specified in the specific domain key nor
763   in the domains key, the value in the NP key will only be checked if
764   the effective 'LogonOptions' specify a high security integrated
765   login.  If a logon script is specified in the specific domain key or
766   the domains key, it will be used regardless of the high security
767   setting.  Please be aware of this when setting this value.
768
769
770 3. AFS Credentials System Tray Tool parameters
771 ----------------------------------------------
772 Affects the behavior of afscreds.exe
773
774 Regkey:
775 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
776
777 Value   : Gateway
778 Type    : REG_SZ
779 Default : ""
780 Function: GetGatewayName()
781
782   If the AFS client is utilizing a gateway to obtain AFS access, 
783   the name of the gateway is specified by this value.
784
785 Value   : Cell
786 Type    : REG_SZ
787 Default : <none>
788 Variable: IsServiceConfigured()
789
790   The value Cell is used to determine if the AFS Client Service has
791   been properly configured or not.
792
793
794 Regkey:
795 [HKLM\SOFTWARE\OpenAFS\Client]
796 [HKCU\SOFTWARE\OpenAFS\Client]
797
798 Value   : ShowTrayIcon
799 Type    : DWORD {0, 1}
800 Default : 1
801 Function: InitApp(), Main_OnCheckTerminate()
802
803   This value is used to determine whether or not a shortcut should be
804   maintained in the user's Start Menu->Programs->Startup folder. 
805
806   This value used to be stored at 
807   [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].
808
809   The current user value is checked first; if it does not exist the local 
810   machine value is checked.
811
812
813 Value   : EnableKFW
814 Type    : DWORD {0, 1}
815 Default : 1
816 Function: KFW_is_available()
817
818   When MIT Kerberos for Windows can be loaded, Kerberos 5 will be used
819   to obtain AFS credentials.  By setting this value to 0, the internal
820   Kerberos 4 implementation will be used instead.  The current user value 
821   is checked first; if it does not exist the local machine value is checked.
822
823 Value   : Use524
824 Type    : DWORD {0, 1}
825 Default : 0
826 Function: KFW_use_krb524()
827
828   When MIT Kerberos for Windows can be loaded, Kerberos 5 will be used
829   to obtain AFS credentials.  By setting this value to 1, the Kerberos 5
830   tickets will be converted to Kerberos 4 tokens via a call to the krb524
831   daemon.  The current user value is checked first; if it does not exist 
832   the local machine value is checked.
833
834 Value   : AfscredsShortcutParams
835 Type    : REG_SZ
836 Default : "-A -M -N -Q"
837 Function: Shortcut_FixStartup
838
839   This value specifies the command line options which should be set
840   as part of the shortcut to afscreds.exe.  afscreds.exe rewrites the 
841   shortcut each time it exits so as to ensure that the shortcut points
842   to the latest version of the program.  This value is used to determine
843   which values should be used for command line parameters.  The current
844   user value is checked first; if it does not exist the local machine
845   value is checked.
846
847   The following subset of the command line options are appropriate for
848   use in this registry setting:
849
850     -A = autoinit 
851     -M = renew drive maps 
852     -N = ip address change detection 
853     -Q = quiet mode.  do not display start service dialog
854          if afsd_service is not already running
855     -S = show tokens dialog on startup
856     -Z = unmap drives
857
858
859 Regkey:
860 [HKCU\SOFTWARE\OpenAFS\Client]
861
862 Value   : Authentication Cell
863 Type    : REG_SZ
864 Default : <none>
865 Function: Afscreds.exe GetDefaultCell()
866
867   This value allows the user to configure a different cell name to
868   be used as the default cell when acquiring tokens in afscreds.exe
869
870
871 Regkey:
872 [HKCU\SOFTWARE\OpenAFS\Client\Reminders]
873
874 Value   : "afs cell name"
875 Type    : DWORD {0, 1}
876 Default : <none>
877 Function: LoadRemind(), SaveRemind()
878
879   These values are used to save and restore the state of the reminder
880   flag for each cell for which the user has obtained tokens.
881
882   This value used to be stored at 
883   [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].
884
885
886 Regkey:
887 [HKCU\SOFTWARE\OpenAFS\Client\Active Maps]
888
889 Value   : "upper case drive letter"
890 Type    : DWORD {0, 1}
891 Default : <none>
892
893   These values are used to store the persistence state of the AFS 
894   drive mappings as listed in the [...\Client\Mappings] key
895
896   These values used to be stored in the afsdsbmt.ini file
897
898 Regkey:
899 [HKCU\SOFTWARE\OpenAFS\Client\Mappings]
900
901 Value   : "upper case drive letter"
902 Type    : REG_SZ
903 Default : <none>
904
905   These values are used to store the AFS path in Unix notation
906   to which the drive letter is to be mapped.
907
908   These values used to be stored in the afsdsbmt.ini file.
909
910
911 ENVIRONMENT VARIABLES:
912
913 Variable: AFS_RPC_ENCRYPT 
914 Values:   "OFF" disables the use of RPC encryption
915           any other value allows RPC encryption to be used
916 Default:  RPC encryption is on
917
918
919 Variable: AFS_RPC_PROTSEQ
920 Values:   "ncalrpc"  - local RPC 
921           "ncacn_np" - named pipes
922           "ncacn_ip_tcp" - tcp/ip
923 Default:  local RPC
924