1 Registry keys and Environment Variables used in the Windows AFS Client
3 ======================================================================
10 The service parameters primarily affect the behavior of the AFS client
11 service (afsd_service.exe).
14 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
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
32 Default : 98304 (CM_CONFIGDEFAULT_CACHESIZE)
33 Variable: cm_initParams.cacheSize
35 Size of the AFS cache in 1k blocks.
39 Default : 17 (CM_CONFIGDEFAULT_CHUNKSIZE)
40 Variable: cm_logChunkSize (cm_chunkSize = 1 << cm_logChunkSize)
42 Size of chunk for reading and writing. Actual chunk size is 2^cm_logChunkSize.
46 Default : 2 (CM_CONFIGDEFAULT_DAEMONS)
49 Number of background daemons (number of threads of
50 cm_BkgDaemon). (see cm_BkgDaemon in cm_daemon.c)
54 Default : 25 (CM_CONFIGDEFAULT_SVTHREADS)
55 Variable: numSvThreads
57 Number of SMB server threads (number of threads of smb_Server). (see
62 Default : 10000 (CM_CONFIGDEFAULT_STATS)
63 Variable: cm_initParams.nStatCaches
67 Value : LogoffPreserveTokens
71 If enabled (set to 1), the Logoff Event handler will not attempt
72 to delete the user's tokens if the user's profile is stored outside
78 Variable: cm_rootVolumeName
85 Variable: cm_mountRoot
87 Name of root mount point. In symlinks, if a path starts with
88 cm_mountRoot, it is assumed that the path is absolute (as opposed to
89 relative) and is adjusted accordingly. Eg: if a path is specified as
90 /afs/athena.mit.edu/foo/bar/baz and cm_mountRoot is "/afs", then the
91 path is interpreted as \\afs\all\athena.mit.edu\foo\bar\baz. If a
92 path does not start with with cm_mountRoot, the path is assumed to
93 be relative and suffixed to the reference directory (i.e. directory
94 where the symlink exists)
98 Type : REG_SZ or REG_EXPAND_SZ
99 Default : "%TEMP%\AFSCache"
100 Variable: cm_CachePath
102 Location of on-disk cache file. The default is the SYSTEM account's
103 TEMP directory. The attributes assigned to the file are HIDDEN and
107 Value : NonPersistentCaching
110 Variable: buf_CacheType
112 When this registry value is set to a non-zero value, the CachePath
113 value is ignored and the cache data is stored in the windows paging
114 file. This prevents the use of persistent caching (when available)
115 as well as the ability to alter the size of the cache at runtime
116 using the "fs setcachesize" command.
119 Value : ValidateCache
122 Variable: buf_CacheType
124 This value determines if and when persistent cache validation is
126 0 - Validation is disabled
127 1 - Validation is performed at startup
128 2 - Validation is performed at shutdown
134 Variable: traceOnPanic
136 Issues a breakpoint in the event of a panic. (breakpoint: _asm int 3).
141 Variable: cm_NetbiosName
143 Specifies the NetBIOS name to be used when binding to a Loopback
144 adapter. To provide the old behavior specify a value of
152 Select whether or not this AFS client should act as a gateway. If
153 set and the NetBIOS name hostname-AFS is bound to a physical NIC,
154 other machines in the subnet can access AFS via SMB connections to
157 When IsGateway is non-zero, the LAN adapter detection code will
158 avoid binding to a loopback adapter. This will ensure that the
159 NetBIOS name will be of the form hostname-AFS instead of the value
160 set by the "NetbiosName" registry value.
162 Value : ReportSessionStartups
165 Variable: reportSessionStartups
167 If enabled, all SMB sessions created are recorded in the Application
168 event log. This also enables other events such as drive mappings
169 or various error types to be logged.
171 Value : TraceBufferSize
173 Default : 5000 (CM_CONFIGDEFAULT_TRACEBUFSIZE)
174 Variable: traceBufSize
176 Number of entries to keep in trace log.
180 Default : "i386_nt40"
183 Provides an initial value for "fs sysname". The string can contain
184 one or more replacement values for @sys in order of preference separated
187 Value : SecurityLevel
192 Enables encryption on RX calls.
197 Variable: cm_dnsEnabled
199 Enables resolving volservers using AFSDB DNS queries. (see
200 afsdb-freelance-notes).
202 As of 1.3.60, this value is ignored as the DNS query support
203 utilizes the Win32 DNSQuery API which is available on Win2000
206 Value : FreelanceClient
209 Variable: cm_freelanceEnabled
211 Enables freelance client. (see afsdb-freelance-notes)
216 Variable: smb_hideDotFiles
218 Enables marking dotfiles with the hidden attribute. Dot files are
219 files whose name starts with a period (excluding "." and "..").
221 Value : MaxMpxRequests
224 Variable: smb_maxMpxRequests
226 Maximum number of multiplexed SMB requests that can be made.
228 Value : MaxVCPerServer
231 Variable: smb_maxVCPerServer
233 Maximum number of SMB virtual circuits.
238 Variable: rootCellName
240 Name of root cell (the cell from which root.afs should be mounted in
248 If enabled, does not send or indicate that we are able to send or
249 receive RX jumbograms.
256 If set to anything other than -1, uses that value as the maximum MTU
257 supported by the RX interface.
259 In order to enable OpenAFS to operate across the Cisco IPSec VPN
260 client, this value must be set to 1264 or smaller.
262 Value : ConnDeadTimeout
264 Default : 60 (seconds)
265 Variable: ConnDeadtimeout
267 The Connection Dead Time is enforced to be at a minimum 15 seconds
268 longer than the minimum SMB timeout as specified by
270 HKLM\SYSTEM\CurrentControlSet\Services\lanmanworkstation\parameters
273 If the minimum SMB timeout is not specified the value is 45 seconds.
274 See http://support.microsoft.com:80/support/kb/articles/Q102/0/67.asp
277 Value : HardDeadTimeout
279 Default : 120 (seconds)
280 Variable: HardDeadtimeout
282 The Hard Dead Time is enforced to be at least double the ConnDeadTimeout.
283 The provides an opportunity for at least one retry.
287 Type : DWORD {0, 1, 2, 3}
290 Enables logging of debug output to the Windows Event Log.
291 Bit 0 enables logging of "Logon Events" processed by the Network Provider
292 and Winlogon Event Notification Handler.
293 Bit 1 enables logging of events captured by the AFS Client Service.
298 Variable: allSubmount (smb.c)
300 By setting this value to 0, the "\\NetbiosName\all" mount point
301 will not be created. This allows the read-write versions of
302 root.afs to be hidden.
304 Value : NoFindLanaByName
308 Disables the attempt to identity the network adapter to use by
309 looking for an adapter with a display name of "AFS".
312 Type : DWORD {1..32} or {1..64} depending on the architecture
313 Default : <no default>
315 If this value is specified, afsd_service.exe will restrict itself
316 to executing on the specified number of CPUs if there are a greater
317 number installed in the machine.
319 NOTE: Setting this entry to "1" may be required on hyperthreaded
320 systems to avoid crashes in the RX library.
326 If this value is specified, it defines the type of SMB authentication
327 which must be present in order for the Windows SMB client to connect
328 to the AFS Client Service's SMB server. The values are:
329 0 = No authentication required
330 1 = NTLM authentication required
331 2 = Extended (GSS SPNEGO) authentication required
332 The default is Extended authentication
335 Type : DWORD {0 .. MAXDWORD}
338 This entry determines the maximum size of the %WINDIR%\TEMP\afsd_init.log
339 file. If the file is larger than this value when afsd_service.exe starts
340 the file will be reset to 0 bytes. If this value is 0, it means the file
341 should be allowed to grow indefinitely.
343 Value : FlushOnHibernate
347 If set, flushes all volumes before the machine goes on hibernate or
351 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters\GlobalAutoMapper]
353 Value : <Drive Letter:> for example "G:"
356 Specifies the submount name to be mapped by afsd_service.exe at startup
357 to the provided drive letter.
361 [HKLM\SOFTWARE\OpenAFS\Client]
363 Value : CellServDBDir
365 Default : <not defined>
367 Specifies the directory containing the CellServDB file.
368 When this value is not specified, the AFS Client install
372 Value : VerifyServiceSignature
376 This value can be used to disable the runtime verification of
377 the digital signatures applied to afsd_service.exe and the
378 OpenAFS DLLs it loads. This test is performed to verify that
379 the DLLs which are loaded by afsd_service.exe are from the
380 same distribution as afsd_service.exe. This is to prevent
381 random errors caused when DLLs from one distribution of AFS
382 are loaded by another one. This is not a security test. The
383 reason for disabling this test is to free up additional memory
384 which can be used for a large cache size.
391 This value can be used to debug the cause of pioctl() failures.
392 Set a non-zero value and the pioctl() library will output status
393 information to stdout. Executing command line tools such as
394 tokens.exe, fs.exe, etc can then be used to determine why the
395 pioctl() call is failing.
400 Default : 0x0 (MiniDumpNormal)
402 This value is used to specify the type of minidump generated by
403 afsd_service.exe either when the process crashes or when a user
404 initiated is dump file is generated with the "fs.exe minidump"
407 Valid values are dependent on the version of DbgHelp.dll installed
408 on the machine. See the Microsoft Developer Library for further
411 MiniDumpNormal = 0x00000000,
412 MiniDumpWithDataSegs = 0x00000001,
413 MiniDumpWithFullMemory = 0x00000002,
414 MiniDumpWithHandleData = 0x00000004,
415 MiniDumpFilterMemory = 0x00000008,
416 MiniDumpScanMemory = 0x00000010,
417 MiniDumpWithUnloadedModules = 0x00000020,
418 MiniDumpWithIndirectlyReferencedMemory = 0x00000040,
419 MiniDumpFilterModulePaths = 0x00000080,
420 MiniDumpWithProcessThreadData = 0x00000100,
421 MiniDumpWithPrivateReadWriteMemory = 0x00000200,
422 MiniDumpWithoutOptionalData = 0x00000400,
423 MiniDumpWithFullMemoryInfo = 0x00000800,
424 MiniDumpWithThreadInfo = 0x00001000,
425 MiniDumpWithCodeSegs = 0x00002000
428 Value : StoreAnsiFilenames
432 This value can be used to force the AFS Client Service to
433 store filenames using the Windows system's ANSI character set
434 instead of the OEM Code Page character set which has traditionally
435 been used by SMB file systems.
437 Note: The use of ANSI characters will render access to files
438 with 8-bit OEM file names unaccessible from Windows. This option
439 is of use primarily when you wish to allow file names produced
440 on Windows to be accessible from Latin-1 Unix systems and vice
445 [HKLM\SOFTWARE\OpenAFS\Client\CSCPolicy]
447 Value : "smb/cifs share name"
451 This key is used to map SMB/CIFS shares to Client Side Caching
452 (off-line access) policies. For each share one of the following
453 policies may be used: "manual", "programs", "documents", "disable"
455 These values used to be stored in afsdsbmt.ini
458 [HKLM\SOFTWARE\OpenAFS\Client\Freelance]
460 Value : "numeric value"
464 This key is used to store dot terminated mount point strings
465 for use in constructing the fake root.afs volume when Freelance
466 (dynamic roots) mode is activated.
468 "athena.mit.edu#athena.mit.edu:root.cell."
469 ".athena.mit.edu%athena.mit.edu:root.cell."
471 These values used to be stored in afs_freelance.ini
475 [HKLM\SOFTWARE\OpenAFS\Client\Freelance\Symlinks]
477 Value : "numeric value"
481 This key is used to store a dot terminated symlink strings
482 for use in constructing the fake root.afs volume when Freelance
483 (dynamic roots) mode is activated.
485 "linkname:destination-path."
486 "athena:athena.mit.edu."
487 "home:athena.mit.edu\user\j\a\jaltman."
488 "filename:path\file."
492 [HKLM\SOFTWARE\OpenAFS\Client\Submounts]
494 Value : "submount name"
498 This key is used to store mappings of unix style AFS paths
499 to submount names which can be referenced as UNC paths.
500 For example the submount string "/athena.mit.edu/user/j/a/jaltman"
501 can be associated with the submount name "jaltman.home".
502 This can then be referenced as the UNC path \\AFS\jaltman.home.
504 These values used to be stored in afsdsbmt.ini
506 NOTE: Submounts should no longer be used with OpenAFS.
507 Use the Windows Explorer to create drive mappings to AFS UNC
508 paths instead of using the AFS Submount mechanism.
512 [HKLM\SOFTWARE\OpenAFS\Client\Server Preferences\VLDB]
514 Value : "hostname or ip address"
518 This key is used to specify a default set of VLDB server preferences.
519 For each entry the value name will be either the IP address of a server
520 or a fully qualified domain name. The value will be the ranking. The
521 ranking will be adjusted by a random value between 0 and 256 prior to
522 the preference being set.
526 [HKLM\SOFTWARE\OpenAFS\Client\Server Preferences\File]
528 Value : "hostname or ip address"
532 This key is used to specify a default set of File server preferences.
533 For each entry the value name will be either the IP address of a server
534 or a fully qualified domain name. The value will be the ranking. The
535 ranking will be adjusted by a random value between 0 and 256 prior to
536 the preference being set.
540 2. Network provider parameters
541 ------------------------------
542 Affects the network provider (afslogon.dll).
545 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
547 Value : FailLoginsSilently
551 Do not display message boxes if the login fails.
554 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
560 Disables visible warnings during logon.
562 Value : AuthentProviderPath
564 NSIS : %WINDIR%\SYSTEM32\afslogon.dll
566 Specifies the install location of the authentication provider dll.
572 Specifies the class of network provider
574 Value : DependOnGroup
578 Specifies the service groups upon which the AFS Client Service
579 depends. Windows should not attempt to start the AFS Client Service
580 until all of the services within these groups have successfully
583 Value : DependOnService
585 NSIS : Tcpip NETBIOS RpcSs
587 Specifies a list of services upon which the AFS Client Service
588 depends. Windows should not attempt to start the AFS Client Service
589 until all of the specified services have successfully started.
593 NSIS : "OpenAFSDaemon"
595 Specifies the display name of the AFS Client Service
599 NSIS : %WINDIR%\SYSTEM32\afslogon.dll
601 Specifies the DLL to use for the network provider
604 2.1 Domain specific configuration keys for the Network Provider
605 ---------------------------------------------------------------
607 The network provider can be configured to have different behavior
608 depending on the domain that the user logs into. These settings are
609 only relevant when using integrated login. A domain refers to an
610 Active Directory (AD) domain, a trusted Kerberos (non-AD) realm or the
611 local machine (i.e. local account logins). The domain name that is
612 used for selecting the domain would be the domain that is passed into
613 the NPLogonNotify function of the network provider.
615 Domain specific registry keys are :
617 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
620 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]
623 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\"domain name"]
624 (Specific domain key. One per domain.)
626 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]
630 HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider
637 Each of the domain specific keys can have the set of values described
638 in 2.1.1. The effective values are chosen as described in 2.1.2.
640 2.1.1 Domain specific configuration values
641 -------------------------------------------
642 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
643 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]
644 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\"domain name"]
645 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]
650 NSIS/WiX: depends on user configuration
652 0x00 - Integrated Logon is not used
653 0x01 - Integrated Logon is used
654 0x02 - High Security Mode is used
655 0x03 - Integrated Logon with High Security Mode is used
657 High Security Mode generates random SMB names for the creation of
658 Drive Mappings. This mode should not be used without Integrated Logon.
660 As of 1.3.65 the SMB server supports SMB authentication. The High
661 Security Mode should not be used when using SMB authentication
662 (SMBAuthType setting is non zero).
664 Value : FailLoginsSilently
669 If true, does not display any visible warnings in the event of an
670 error during the integrated login process.
673 Type : REG_SZ or REG_EXPAND_SZ
675 NSIS/WiX: (only value under NP key) <install path>\afscreds.exe -:%s -x -a -m -n -q
677 A logon script that will be scheduled to be run after the profile
678 load is complete. If using the REG_EXPAND_SZ type, you can use
679 any system environment variable as "%varname%" which would be
680 expanded at the time the network provider is run. Optionally
681 using a "%s" in the value would result in it being expanded into
682 the AFS SMB username for the session.
684 Value : LoginRetryInterval
689 If the OpenAFS client service has not started yet, the network
690 provider will wait for a maximum of "LoginRetryInterval" seconds
691 while retrying every "LoginSleepInterval" seconds to check if the
694 Value : LoginSleepInterval
699 See description of LoginRetryInterval.
705 When Kerberos 5 is being used, TheseCells provides a list of additional
706 cells for which tokens should be obtained with the default Kerberos 5
710 2.1.2 Selection of effective values for domain specific configuration
711 ----------------------------------------------------------------------
713 During login to domain X, where X is the domain passed into
714 NPLogonNotify as lpAuthentInfo->LogonDomainName or the string
715 'LOCALHOST' if lpAuthentInfo->LogonDomainName equals the name of the
716 computer, the following keys will be looked up.
718 1. NP key. ("HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider")
719 2. Domains key. (NP key\"Domain")
720 3. Specific domain key. (Domains key\X)
722 If the specific domain key does not exist, then the domains key will
723 be ignored. All the configuration information in this case will
724 come from the NP key.
726 If the specific domain key exists, then for each of the values
727 metioned in (2), they will be looked up in the specific domain key,
728 domains key and the NP key successively until the value is found.
729 The first instance of the value found this way will be the effective
730 for the login session. If no such instance can be found, the
731 default will be used. To re-iterate, a value in a more specific key
732 supercedes a value in a less specific key. The exceptions to this
733 rule are stated below.
735 2.1.3 Exceptions to 2.1.2
736 --------------------------
738 To retain backwards compatibility, the following exceptions are made
741 2.1.3.1 'FailLoginsSilently'
743 Historically, the 'FailLoginsSilently' value was in
744 HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters
745 key and not in the NP key. Therefore, for backwards compatibility,
746 the value in the Parameters key will supercede all instances of this
747 value in other keys. In the absence of this value in the Parameters
748 key, normal scope rules apply.
750 2.1.3.2 'LogonScript'
752 If a 'LogonScript' is not specified in the specific domain key nor
753 in the domains key, the value in the NP key will only be checked if
754 the effective 'LogonOptions' specify a high security integrated
755 login. If a logon script is specified in the specific domain key or
756 the domains key, it will be used regardless of the high security
757 setting. Please be aware of this when setting this value.
760 3. AFS Credentials System Tray Tool parameters
761 ----------------------------------------------
762 Affects the behavior of afscreds.exe
765 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
770 Function: GetGatewayName()
772 If the AFS client is utilizing a gateway to obtain AFS access,
773 the name of the gateway is specified by this value.
778 Variable: IsServiceConfigured()
780 The value Cell is used to determine if the AFS Client Service has
781 been properly configured or not.
785 [HKLM\SOFTWARE\OpenAFS\Client]
786 [HKCU\SOFTWARE\OpenAFS\Client]
791 Function: InitApp(), Main_OnCheckTerminate()
793 This value is used to determine whether or not a shortcut should be
794 maintained in the user's Start Menu->Programs->Startup folder.
796 This value used to be stored at
797 [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].
799 The current user value is checked first; if it does not exist the local
800 machine value is checked.
806 Function: KFW_is_available()
808 When MIT Kerberos for Windows can be loaded, Kerberos 5 will be used
809 to obtain AFS credentials. By setting this value to 0, the internal
810 Kerberos 4 implementation will be used instead. The current user value
811 is checked first; if it does not exist the local machine value is checked.
816 Function: KFW_use_krb524()
818 When MIT Kerberos for Windows can be loaded, Kerberos 5 will be used
819 to obtain AFS credentials. By setting this value to 1, the Kerberos 5
820 tickets will be converted to Kerberos 4 tokens via a call to the krb524
821 daemon. The current user value is checked first; if it does not exist
822 the local machine value is checked.
824 Value : AfscredsShortcutParams
826 Default : "-A -M -N -Q"
827 Function: Shortcut_FixStartup
829 This value specifies the command line options which should be set
830 as part of the shortcut to afscreds.exe. afscreds.exe rewrites the
831 shortcut each time it exits so as to ensure that the shortcut points
832 to the latest version of the program. This value is used to determine
833 which values should be used for command line parameters. The current
834 user value is checked first; if it does not exist the local machine
837 The following subset of the command line options are appropriate for
838 use in this registry setting:
841 -M = renew drive maps
842 -N = ip address change detection
843 -Q = quiet mode. do not display start service dialog
844 if afsd_service is not already running
845 -S = show tokens dialog on startup
850 [HKCU\SOFTWARE\OpenAFS\Client]
852 Value : Authentication Cell
855 Function: Afscreds.exe GetDefaultCell()
857 This value allows the user to configure a different cell name to
858 be used as the default cell when acquiring tokens in afscreds.exe
862 [HKCU\SOFTWARE\OpenAFS\Client\Reminders]
864 Value : "afs cell name"
867 Function: LoadRemind(), SaveRemind()
869 These values are used to save and restore the state of the reminder
870 flag for each cell for which the user has obtained tokens.
872 This value used to be stored at
873 [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].
877 [HKCU\SOFTWARE\OpenAFS\Client\Active Maps]
879 Value : "upper case drive letter"
883 These values are used to store the persistence state of the AFS
884 drive mappings as listed in the [...\Client\Mappings] key
886 These values used to be stored in the afsdsbmt.ini file
889 [HKCU\SOFTWARE\OpenAFS\Client\Mappings]
891 Value : "upper case drive letter"
895 These values are used to store the AFS path in Unix notation
896 to which the drive letter is to be mapped.
898 These values used to be stored in the afsdsbmt.ini file.
901 ENVIRONMENT VARIABLES:
903 Variable: AFS_RPC_ENCRYPT
904 Values: "OFF" disables the use of RPC encryption
905 any other value allows RPC encryption to be used
906 Default: RPC encryption is on
909 Variable: AFS_RPC_PROTSEQ
910 Values: "ncalrpc" - local RPC
911 "ncacn_np" - named pipes
912 "ncacn_ip_tcp" - tcp/ip