2 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 : 20480 (CM_CONFIGDEFAULT_CACHESIZE)
33 Variable: cm_initParams.cacheSize
35 Size of the AFS cache in 1k blocks.
39 Default : 15 (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 : 4 (CM_CONFIGDEFAULT_SVTHREADS)
55 Variable: numSvThreads
57 Number of SMB server threads (number of threads of smb_Server). (see
62 Default : 1000 (CM_CONFIGDEFAULT_STATS)
63 Variable: cm_initParams.nStatCaches
67 Value : LogoffTokenTransfer
70 Variable: smb_LogoffTokenTransfer
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.
78 Value : LogoffTokenTransferTimeout
81 Variable: smb_LogoffTokenTransferTimeout
83 See LogoffTokenTransfer above.
88 Variable: cm_rootVolumeName
95 Variable: cm_mountRoot
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)
107 Type : REG_SZ or REG_EXPAND_SZ
108 Default : "%SYSTEMDRIVE%\AFSCache"
109 Variable: cm_CachePath
111 Location of on-disk cache file. The default implies the root
112 directory of the boot disk
115 Value : NonPersistentCaching
118 Variable: buf_CacheType
120 When this registry value is set to a non-zero value, the CachePath
121 value is ignored and the cache data is stored in the windows paging
122 file. This prevents the use of persistent caching (when available)
123 as well as the ability to alter the size of the cache at runtime
124 using the "fs setcachesize" command.
130 Variable: traceOnPanic
132 Issues a breakpoint in the event of a panic. (breakpoint: _asm int 3).
137 Variable: cm_NetbiosName
139 Specifies the NetBIOS name to be used when binding to a Loopback
140 adapter. To provide the old behavior specify a value of
148 Select whether or not this AFS client should act as a gateway. If
149 set and the NetBIOS name hostname-AFS is bound to a physical NIC,
150 other machines in the subnet can access AFS via SMB connections to
153 When IsGateway is non-zero, the LAN adapter detection code will
154 avoid binding to a loopback adapter. This will ensure that the
155 NetBIOS name will be of the form hostname-AFS instead of the value
156 set by the "NetbiosName" registry value.
158 Value : ReportSessionStartups
161 Variable: reportSessionStartups
163 If enabled, all SMB sessions created are recorded in the Application
164 event log. This also enables other events such as drive mappings
165 or various error types to be logged.
167 Value : TraceBufferSize
169 Default : 5000 (CM_CONFIGDEFAULT_TRACEBUFSIZE)
170 Variable: traceBufSize
172 Number of entries to keep in trace log.
176 Default : "i386_nt40"
179 Provides an initial value for "fs sysname". The string can contain
180 one or more replacement values for @sys in order of preference separated
183 Value : SecurityLevel
188 Enables encryption on RX calls.
193 Variable: cm_dnsEnabled
195 Enables resolving volservers using AFSDB DNS queries. (see
196 afsdb-freelance-notes).
198 As of 1.3.60, this value is ignored as the DNS query support
199 utilizes the Win32 DNSQuery API which is available on Win2000
202 Value : FreelanceClient
205 Variable: cm_freelanceEnabled
207 Enables freelance client. (see afsdb-freelance-notes)
212 Variable: smb_hideDotFiles
214 Enables marking dotfiles with the hidden attribute. Dot files are
215 files whose name starts with a period (excluding "." and "..").
217 Value : MaxMpxRequests
220 Variable: smb_maxMpxRequests
222 Maximum number of multiplexed SMB requests that can be made.
224 Value : MaxVCPerServer
227 Variable: smb_maxVCPerServer
229 Maximum number of SMB virtual circuits.
234 Variable: rootCellName
236 Name of root cell (the cell from which root.afs should be mounted in
244 If enabled, does not send or indicate that we are able to send or
245 receive RX jumbograms.
252 If set to anything other than -1, uses that value as the maximum MTU
253 supported by the RX interface.
255 In order to enable OpenAFS to operate across the Cisco IPSec VPN
256 client, this value must be set to 1264 or smaller.
258 Value : ConnDeadTimeout
260 Default : 60 (seconds)
261 Variable: ConnDeadtimeout
263 The Connection Dead Time is enforced to be at a minimum 15 seconds
264 longer than the minimum SMB timeout as specified by
266 HKLM\SYSTEM\CurrentControlSet\Services\lanmanworkstation\parameters
269 If the minimum SMB timeout is not specified the value is 45 seconds.
270 See http://support.microsoft.com:80/support/kb/articles/Q102/0/67.asp
273 Value : HardDeadTimeout
275 Default : 120 (seconds)
276 Variable: HardDeadtimeout
278 The Hard Dead Time is enforced to be at least double the ConnDeadTimeout.
279 The provides an opportunity for at least one retry.
283 Type : DWORD {0, 1, 2, 3}
286 Enables logging of debug output to the Windows Event Log.
287 Bit 0 enables logging of "Logon Events" processed by the Network Provider
288 and Winlogon Event Notification Handler.
289 Bit 1 enables logging of events captured by the AFS Client Service.
294 Variable: allSubmount (smb.c)
296 By setting this value to 0, the "\\NetbiosName\all" mount point
297 will not be created. This allows the read-write versions of
298 root.afs to be hidden.
300 Value : NoFindLanaByName
304 Disables the attempt to identity the network adapter to use by
305 looking for an adapter with a display name of "AFS".
308 Type : DWORD {1..32} or {1..64} depending on the architecture
309 Default : <no default>
311 If this value is specified, afsd_service.exe will restrict itself
312 to executing on the specified number of CPUs if there are a greater
313 number installed in the machine.
315 NOTE: Setting this entry to "1" may be required on hyperthreaded
316 systems to avoid crashes in the RX library.
322 If this value is specified, it defines the type of SMB authentication
323 which must be present in order for the Windows SMB client to connect
324 to the AFS Client Service's SMB server. The values are:
325 0 = No authentication required
326 1 = NTLM authentication required
327 2 = Extended (GSS SPNEGO) authentication required
328 The default is Extended authentication
331 Type : DWORD {0 .. MAXDWORD}
334 This entry determines the maximum size of the %WINDIR%\TEMP\afsd_init.log
335 file. If the file is larger than this value when afsd_service.exe starts
336 the file will be reset to 0 bytes. If this value is 0, it means the file
337 should be allowed to grow indefinitely.
341 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters\GlobalAutoMapper]
343 Value : <Drive Letter:> for example "G:"
346 Specifies the submount name to be mapped by afsd_service.exe at startup
347 to the provided drive letter.
352 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
355 2. Network provider parameters
356 ------------------------------
357 Affects the network provider (afslogon.dll).
360 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
362 Value : FailLoginsSilently
366 Do not display message boxes if the login fails.
369 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
375 Disables visible warnings during logon.
377 Value : AuthentProviderPath
379 NSIS : %WINDIR%\SYSTEM32\afslogon.dll
381 Specifies the install location of the authentication provider dll.
387 Specifies the class of network provider
389 Value : DependOnGroup
393 Specifies the service groups upon which the AFS Client Service
394 depends. Windows should not attempt to start the AFS Client Service
395 until all of the services within these groups have successfully
398 Value : DependOnService
400 NSIS : Tcpip NETBIOS RpcSs
402 Specifies a list of services upon which the AFS Client Service
403 depends. Windows should not attempt to start the AFS Client Service
404 until all of the specified services have successfully started.
408 NSIS : "OpenAFSDaemon"
410 Specifies the display name of the AFS Client Service
414 NSIS : %WINDIR%\SYSTEM32\afslogon.dll
416 Specifies the DLL to use for the network provider
420 [HKLM\SOFTWARE\OpenAFS\Client]
422 Value : CellServDBDir
424 Default : <not defined>
426 Specifies the directory containing the CellServDB file.
427 When this value is not specified, the AFS Client install
432 2.1 Domain specific configuration keys for the Network Provider
433 ---------------------------------------------------------------
435 The network provider can be configured to have different behavior
436 depending on the domain that the user logs into. These settings are
437 only relevant when using integrated login. A domain refers to an
438 Active Directory (AD) domain, a trusted Kerberos (non-AD) realm or the
439 local machine (i.e. local account logins). The domain name that is
440 used for selecting the domain would be the domain that is passed into
441 the NPLogonNotify function of the network provider.
443 Domain specific registry keys are :
445 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
448 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]
451 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\"domain name"]
452 (Specific domain key. One per domain.)
454 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]
458 HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider
465 Each of the domain specific keys can have the set of values described
466 in 2.1.1. The effective values are chosen as described in 2.1.2.
468 2.1.1 Domain specific configuration values
469 -------------------------------------------
470 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
471 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]
472 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\"domain name"]
473 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]
478 NSIS/WiX: depends on user configuration
480 0x00 - Integrated Logon is not used
481 0x01 - Integrated Logon is used
482 0x02 - High Security Mode is used
483 0x03 - Integrated Logon with High Security Mode is used
485 High Security Mode generates random SMB names for the creation of
486 Drive Mappings. This mode should not be used without Integrated Logon.
488 As of 1.3.65 the SMB server supports SMB authentication. The High
489 Security Mode should not be used when using SMB authentication
490 (SMBAuthType setting is non zero).
492 Value : FailLoginsSilently
497 If true, does not display any visible warnings in the event of an
498 error during the integrated login process.
501 Type : REG_SZ or REG_EXPAND_SZ
503 NSIS/WiX: (only value under NP key) <install path>\afscreds.exe -:%s -x -a -m -n -q
505 A logon script that will be scheduled to be run after the profile
506 load is complete. If using the REG_EXPAND_SZ type, you can use
507 any system environment variable as "%varname%" which would be
508 expanded at the time the network provider is run. Optionally
509 using a "%s" in the value would result in it being expanded into
510 the AFS SMB username for the session.
512 Value : LoginRetryInterval
517 If the OpenAFS client service has not started yet, the network
518 provider will wait for a maximum of "LoginRetryInterval" seconds
519 while retrying every "LoginSleepInterval" seconds to check if the
522 Value : LoginSleepInterval
527 See description of LoginRetryInterval.
530 2.1.2 Selection of effective values for domain specific configuration
531 ----------------------------------------------------------------------
533 During login to domain X, where X is the domain passed into
534 NPLogonNotify as lpAuthentInfo->LogonDomainName or the string
535 'LOCALHOST' if lpAuthentInfo->LogonDomainName equals the name of the
536 computer, the following keys will be looked up.
538 1. NP key. ("HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider")
539 2. Domains key. (NP key\"Domain")
540 3. Specific domain key. (Domains key\X)
542 If the specific domain key does not exist, then the domains key will
543 be ignored. All the configuration information in this case will
544 come from the NP key.
546 If the specific domain key exists, then for each of the values
547 metioned in (2), they will be looked up in the specific domain key,
548 domains key and the NP key successively until the value is found.
549 The first instance of the value found this way will be the effective
550 for the login session. If no such instance can be found, the
551 default will be used. To re-iterate, a value in a more specific key
552 supercedes a value in a less specific key. The exceptions to this
553 rule are stated below.
555 2.1.3 Exceptions to 2.1.2
556 --------------------------
558 To retain backwards compatibility, the following exceptions are made
561 2.1.3.1 'FailLoginsSilently'
563 Historically, the 'FailLoginsSilently' value was in
564 HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters
565 key and not in the NP key. Therefore, for backwards compatibility,
566 the value in the Parameters key will supercede all instances of this
567 value in other keys. In the absence of this value in the Parameters
568 key, normal scope rules apply.
570 2.1.3.2 'LogonScript'
572 If a 'LogonScript' is not specified in the specific domain key nor
573 in the domains key, the value in the NP key will only be checked if
574 the effective 'LogonOptions' specify a high security integrated
575 login. If a logon script is specified in the specific domain key or
576 the domains key, it will be used regardless of the high security
577 setting. Please be aware of this when setting this value.
580 3. AFS Credentials System Tray Tool parameters
581 ----------------------------------------------
582 Affects the behavior of afscreds.exe
585 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
590 Function: GetGatewayName()
592 If the AFS client is utilizing a gateway to obtain AFS access,
593 the name of the gateway is specified by this value.
598 Variable: IsServiceConfigured()
600 The value Cell is used to determine if the AFS Client Service has
601 been properly configured or not.
605 [HKLM\SOFTWARE\OpenAFS\Client]
606 [HKCU\SOFTWARE\OpenAFS\Client]
611 Function: InitApp(), Main_OnCheckTerminate()
613 This value is used to determine whether or not a shortcut should be
614 maintained in the user's Start Menu->Programs->Startup folder.
616 This value used to be stored at
617 [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].
619 The current user value is checked first; if it does not exist the local
620 machine value is checked.
626 Function: KFW_is_available()
628 When MIT Kerberos for Windows can be loaded, Kerberos 5 will be used
629 to obtain AFS credentials. By setting this value to 0, the internal
630 Kerberos 4 implementation will be used instead. The current user value
631 is checked first; if it does not exist the local machine value is checked.
636 Function: KFW_use_krb524()
638 When MIT Kerberos for Windows can be loaded, Kerberos 5 will be used
639 to obtain AFS credentials. By setting this value to 1, the Kerberos 5
640 tickets will be converted to Kerberos 4 tokens via a call to the krb524
641 daemon. The current user value is checked first; if it does not exist
642 the local machine value is checked.
644 Value : AfscredsShortcutParams
646 Default : "-A -M -N -Q"
647 Function: Shortcut_FixStartup
649 This value specifies the command line options which should be set
650 as part of the shortcut to afscreds.exe. afscreds.exe rewrites the
651 shortcut each time it exits so as to ensure that the shortcut points
652 to the latest version of the program. This value is used to determine
653 which values should be used for command line parameters. The current
654 user value is checked first; if it does not exist the local machine
659 [HKCU\SOFTWARE\OpenAFS\Client]
661 Value : Authentication Cell
664 Function: Afscreds.exe GetDefaultCell()
666 This value allows the user to configure a different cell name to
667 be used as the default cell when acquiring tokens in afscreds.exe
671 [HKCU\SOFTWARE\OpenAFS\Client\Reminders]
673 Value : "afs cell name"
676 Function: LoadRemind(), SaveRemind()
678 These values are used to save and restore the state of the reminder
679 flag for each cell for which the user has obtained tokens.
681 This value used to be stored at
682 [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].
686 [HKCU\SOFTWARE\OpenAFS\Client\Active Maps]
688 Value : "upper case drive letter"
692 These values are used to store the persistence state of the AFS
693 drive mappings as listed in the [...\Client\Mappings] key
695 These values used to be stored in the afsdsbmt.ini file
698 [HKCU\SOFTWARE\OpenAFS\Client\Mappings]
700 Value : "upper case drive letter"
704 These values are used to store the AFS path in Unix notation
705 to which the drive letter is to be mapped.
707 These values used to be stored in the afsdsbmt.ini file.
711 [HKLM\SOFTWARE\OpenAFS\Client\CSCPolicy]
713 Value : "smb/cifs share name"
717 This key is used to map SMB/CIFS shares to Client Side Caching
718 (off-line access) policies. For each share one of the following
719 policies may be used: "manual", "programs", "documents", "disable"
721 These values used to be stored in afsdsbmt.ini
724 [HKLM\SOFTWARE\OpenAFS\Client\Freelance]
726 Value : "numeric value"
730 This key is used to store newline terminated mount point strings
731 for use in constructing the fake root.afs volume when Freelance
732 (dynamic roots) mode is activated.
734 "athena.mit.edu#athena.mit.edu:root.cell.\n"
735 ".athena.mit.edu%athena.mit.edu:root.cell.\n"
737 These values used to be stored in afs_freelance.ini
741 [HKLM\SOFTWARE\OpenAFS\Client\Submounts]
743 Value : "submount name"
747 This key is used to store mappings of unix style AFS paths
748 to submount names which can be referenced as UNC paths.
749 For example the submount string "/athena.mit.edu/user/j/a/jaltman"
750 can be associated with the submount name "jaltman.home".
751 This can then be referenced as the UNC path \\AFS\jaltman.home.
753 These values used to be stored in afsdsbmt.ini
756 ENVIRONMENT VARIABLES:
758 Variable: AFS_RPC_ENCRYPT
759 Values: "OFF" disables the use of RPC encryption
760 any other value allows RPC encryption to be used
761 Default: RPC encryption is on
764 Variable: AFS_RPC_PROTSEQ
765 Values: "ncalrpc" - local RPC
766 "ncacn_np" - named pipes
767 "ncacn_ip_tcp" - tcp/ip