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.
339 Value : FlushOnHibernate
343 If set, flushes all volumes before the machine goes on hibernate or
347 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters\GlobalAutoMapper]
349 Value : <Drive Letter:> for example "G:"
352 Specifies the submount name to be mapped by afsd_service.exe at startup
353 to the provided drive letter.
358 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
361 2. Network provider parameters
362 ------------------------------
363 Affects the network provider (afslogon.dll).
366 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
368 Value : FailLoginsSilently
372 Do not display message boxes if the login fails.
375 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
381 Disables visible warnings during logon.
383 Value : AuthentProviderPath
385 NSIS : %WINDIR%\SYSTEM32\afslogon.dll
387 Specifies the install location of the authentication provider dll.
393 Specifies the class of network provider
395 Value : DependOnGroup
399 Specifies the service groups upon which the AFS Client Service
400 depends. Windows should not attempt to start the AFS Client Service
401 until all of the services within these groups have successfully
404 Value : DependOnService
406 NSIS : Tcpip NETBIOS RpcSs
408 Specifies a list of services upon which the AFS Client Service
409 depends. Windows should not attempt to start the AFS Client Service
410 until all of the specified services have successfully started.
414 NSIS : "OpenAFSDaemon"
416 Specifies the display name of the AFS Client Service
420 NSIS : %WINDIR%\SYSTEM32\afslogon.dll
422 Specifies the DLL to use for the network provider
426 [HKLM\SOFTWARE\OpenAFS\Client]
428 Value : CellServDBDir
430 Default : <not defined>
432 Specifies the directory containing the CellServDB file.
433 When this value is not specified, the AFS Client install
437 Value : VerifyServiceSignature
441 This value can be used to disable the runtime verification of
442 the digital signatures applied to afsd_service.exe and the
443 OpenAFS DLLs it loads. This test is performed to verify that
444 the DLLs which are loaded by afsd_service.exe are from the
445 same distribution as afsd_service.exe. This is to prevent
446 random errors caused when DLLs from one distribution of AFS
447 are loaded by another one. This is not a security test. The
448 reason for disabling this test is to free up additional memory
449 which can be used for a large cache size.
456 This value can be used to debug the cause of pioctl() failures.
457 Set a non-zero value and the pioctl() library will output status
458 information to stdout. Executing command line tools such as
459 tokens.exe, fs.exe, etc can then be used to determine why the
460 pioctl() call is failing.
464 2.1 Domain specific configuration keys for the Network Provider
465 ---------------------------------------------------------------
467 The network provider can be configured to have different behavior
468 depending on the domain that the user logs into. These settings are
469 only relevant when using integrated login. A domain refers to an
470 Active Directory (AD) domain, a trusted Kerberos (non-AD) realm or the
471 local machine (i.e. local account logins). The domain name that is
472 used for selecting the domain would be the domain that is passed into
473 the NPLogonNotify function of the network provider.
475 Domain specific registry keys are :
477 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
480 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]
483 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\"domain name"]
484 (Specific domain key. One per domain.)
486 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]
490 HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider
497 Each of the domain specific keys can have the set of values described
498 in 2.1.1. The effective values are chosen as described in 2.1.2.
500 2.1.1 Domain specific configuration values
501 -------------------------------------------
502 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
503 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]
504 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\"domain name"]
505 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]
510 NSIS/WiX: depends on user configuration
512 0x00 - Integrated Logon is not used
513 0x01 - Integrated Logon is used
514 0x02 - High Security Mode is used
515 0x03 - Integrated Logon with High Security Mode is used
517 High Security Mode generates random SMB names for the creation of
518 Drive Mappings. This mode should not be used without Integrated Logon.
520 As of 1.3.65 the SMB server supports SMB authentication. The High
521 Security Mode should not be used when using SMB authentication
522 (SMBAuthType setting is non zero).
524 Value : FailLoginsSilently
529 If true, does not display any visible warnings in the event of an
530 error during the integrated login process.
533 Type : REG_SZ or REG_EXPAND_SZ
535 NSIS/WiX: (only value under NP key) <install path>\afscreds.exe -:%s -x -a -m -n -q
537 A logon script that will be scheduled to be run after the profile
538 load is complete. If using the REG_EXPAND_SZ type, you can use
539 any system environment variable as "%varname%" which would be
540 expanded at the time the network provider is run. Optionally
541 using a "%s" in the value would result in it being expanded into
542 the AFS SMB username for the session.
544 Value : LoginRetryInterval
549 If the OpenAFS client service has not started yet, the network
550 provider will wait for a maximum of "LoginRetryInterval" seconds
551 while retrying every "LoginSleepInterval" seconds to check if the
554 Value : LoginSleepInterval
559 See description of LoginRetryInterval.
562 2.1.2 Selection of effective values for domain specific configuration
563 ----------------------------------------------------------------------
565 During login to domain X, where X is the domain passed into
566 NPLogonNotify as lpAuthentInfo->LogonDomainName or the string
567 'LOCALHOST' if lpAuthentInfo->LogonDomainName equals the name of the
568 computer, the following keys will be looked up.
570 1. NP key. ("HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider")
571 2. Domains key. (NP key\"Domain")
572 3. Specific domain key. (Domains key\X)
574 If the specific domain key does not exist, then the domains key will
575 be ignored. All the configuration information in this case will
576 come from the NP key.
578 If the specific domain key exists, then for each of the values
579 metioned in (2), they will be looked up in the specific domain key,
580 domains key and the NP key successively until the value is found.
581 The first instance of the value found this way will be the effective
582 for the login session. If no such instance can be found, the
583 default will be used. To re-iterate, a value in a more specific key
584 supercedes a value in a less specific key. The exceptions to this
585 rule are stated below.
587 2.1.3 Exceptions to 2.1.2
588 --------------------------
590 To retain backwards compatibility, the following exceptions are made
593 2.1.3.1 'FailLoginsSilently'
595 Historically, the 'FailLoginsSilently' value was in
596 HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters
597 key and not in the NP key. Therefore, for backwards compatibility,
598 the value in the Parameters key will supercede all instances of this
599 value in other keys. In the absence of this value in the Parameters
600 key, normal scope rules apply.
602 2.1.3.2 'LogonScript'
604 If a 'LogonScript' is not specified in the specific domain key nor
605 in the domains key, the value in the NP key will only be checked if
606 the effective 'LogonOptions' specify a high security integrated
607 login. If a logon script is specified in the specific domain key or
608 the domains key, it will be used regardless of the high security
609 setting. Please be aware of this when setting this value.
612 3. AFS Credentials System Tray Tool parameters
613 ----------------------------------------------
614 Affects the behavior of afscreds.exe
617 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
622 Function: GetGatewayName()
624 If the AFS client is utilizing a gateway to obtain AFS access,
625 the name of the gateway is specified by this value.
630 Variable: IsServiceConfigured()
632 The value Cell is used to determine if the AFS Client Service has
633 been properly configured or not.
637 [HKLM\SOFTWARE\OpenAFS\Client]
638 [HKCU\SOFTWARE\OpenAFS\Client]
643 Function: InitApp(), Main_OnCheckTerminate()
645 This value is used to determine whether or not a shortcut should be
646 maintained in the user's Start Menu->Programs->Startup folder.
648 This value used to be stored at
649 [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].
651 The current user value is checked first; if it does not exist the local
652 machine value is checked.
658 Function: KFW_is_available()
660 When MIT Kerberos for Windows can be loaded, Kerberos 5 will be used
661 to obtain AFS credentials. By setting this value to 0, the internal
662 Kerberos 4 implementation will be used instead. The current user value
663 is checked first; if it does not exist the local machine value is checked.
668 Function: KFW_use_krb524()
670 When MIT Kerberos for Windows can be loaded, Kerberos 5 will be used
671 to obtain AFS credentials. By setting this value to 1, the Kerberos 5
672 tickets will be converted to Kerberos 4 tokens via a call to the krb524
673 daemon. The current user value is checked first; if it does not exist
674 the local machine value is checked.
676 Value : AfscredsShortcutParams
678 Default : "-A -M -N -Q"
679 Function: Shortcut_FixStartup
681 This value specifies the command line options which should be set
682 as part of the shortcut to afscreds.exe. afscreds.exe rewrites the
683 shortcut each time it exits so as to ensure that the shortcut points
684 to the latest version of the program. This value is used to determine
685 which values should be used for command line parameters. The current
686 user value is checked first; if it does not exist the local machine
691 [HKCU\SOFTWARE\OpenAFS\Client]
693 Value : Authentication Cell
696 Function: Afscreds.exe GetDefaultCell()
698 This value allows the user to configure a different cell name to
699 be used as the default cell when acquiring tokens in afscreds.exe
703 [HKCU\SOFTWARE\OpenAFS\Client\Reminders]
705 Value : "afs cell name"
708 Function: LoadRemind(), SaveRemind()
710 These values are used to save and restore the state of the reminder
711 flag for each cell for which the user has obtained tokens.
713 This value used to be stored at
714 [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].
718 [HKCU\SOFTWARE\OpenAFS\Client\Active Maps]
720 Value : "upper case drive letter"
724 These values are used to store the persistence state of the AFS
725 drive mappings as listed in the [...\Client\Mappings] key
727 These values used to be stored in the afsdsbmt.ini file
730 [HKCU\SOFTWARE\OpenAFS\Client\Mappings]
732 Value : "upper case drive letter"
736 These values are used to store the AFS path in Unix notation
737 to which the drive letter is to be mapped.
739 These values used to be stored in the afsdsbmt.ini file.
743 [HKLM\SOFTWARE\OpenAFS\Client\CSCPolicy]
745 Value : "smb/cifs share name"
749 This key is used to map SMB/CIFS shares to Client Side Caching
750 (off-line access) policies. For each share one of the following
751 policies may be used: "manual", "programs", "documents", "disable"
753 These values used to be stored in afsdsbmt.ini
756 [HKLM\SOFTWARE\OpenAFS\Client\Freelance]
758 Value : "numeric value"
762 This key is used to store dot terminated mount point strings
763 for use in constructing the fake root.afs volume when Freelance
764 (dynamic roots) mode is activated.
766 "athena.mit.edu#athena.mit.edu:root.cell."
767 ".athena.mit.edu%athena.mit.edu:root.cell."
769 These values used to be stored in afs_freelance.ini
773 [HKLM\SOFTWARE\OpenAFS\Client\Freelance\Symlinks]
775 Value : "numeric value"
779 This key is used to store a dot terminated symlink strings
780 for use in constructing the fake root.afs volume when Freelance
781 (dynamic roots) mode is activated.
783 "linkname:destination-path."
784 "athena:athena.mit.edu."
785 "home:athena.mit.edu\user\j\a\jaltman."
786 "filename:path\file."
790 [HKLM\SOFTWARE\OpenAFS\Client\Submounts]
792 Value : "submount name"
796 This key is used to store mappings of unix style AFS paths
797 to submount names which can be referenced as UNC paths.
798 For example the submount string "/athena.mit.edu/user/j/a/jaltman"
799 can be associated with the submount name "jaltman.home".
800 This can then be referenced as the UNC path \\AFS\jaltman.home.
802 These values used to be stored in afsdsbmt.ini
805 ENVIRONMENT VARIABLES:
807 Variable: AFS_RPC_ENCRYPT
808 Values: "OFF" disables the use of RPC encryption
809 any other value allows RPC encryption to be used
810 Default: RPC encryption is on
813 Variable: AFS_RPC_PROTSEQ
814 Values: "ncalrpc" - local RPC
815 "ncacn_np" - named pipes
816 "ncacn_ip_tcp" - tcp/ip