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.
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)
108 Default : "\AFSCache"
109 Variable: cm_CachePath
111 Location of on-disk cache file. The default implies the root
112 directory of the boot disk
117 Variable: traceOnPanic
119 Issues a breakpoint in the event of a panic. (breakpoint: _asm int 3).
124 Variable: cm_NetbiosName
126 Specifies the NetBIOS name to be used when binding to a Loopback
127 adapter. To provide the old behavior specify a value of
135 Select whether or not this AFS client should act as a gateway. If
136 set and the NetBIOS name hostname-AFS is bound to a physical NIC,
137 other machines in the subnet can access AFS via SMB connections to
140 When IsGateway is non-zero, the LAN adapter detection code will
141 avoid binding to a loopback adapter. This will ensure that the
142 NetBIOS name will be of the form hostname-AFS instead of the value
143 set by the "NetbiosName" registry value.
145 Value : ReportSessionStartups
148 Variable: reportSessionStartups
150 If enabled, all SMB sessions created are recorded in the Application
151 event log. This also enables other events such as drive mappings
152 or various error types to be logged.
154 Value : TraceBufferSize
156 Default : 5000 (CM_CONFIGDEFAULT_TRACEBUFSIZE)
157 Variable: traceBufSize
159 Number of entries to keep in trace log.
163 Default : "i386_nt40"
168 Value : SecurityLevel
173 Enables encryption on RX calls.
178 Variable: cm_dnsEnabled
180 Enables resolving volservers using AFSDB DNS queries. (see
181 afsdb-freelance-notes).
183 As of 1.3.60, this value is ignored as the DNS query support
184 utilizes the Win32 DNSQuery API which is available on Win2000
187 Value : FreelanceClient
190 Variable: cm_freelanceEnabled
192 Enables freelance client. (see afsdb-freelance-notes)
197 Variable: smb_hideDotFiles
199 Enables marking dotfiles with the hidden attribute. Dot files are
200 files whose name starts with a period (excluding "." and "..").
202 Value : MaxMpxRequests
205 Variable: smb_maxMpxRequests
207 Maximum number of multiplexed SMB requests that can be made.
209 Value : MaxVCPerServer
212 Variable: smb_maxVCPerServer
214 Maximum number of SMB virtual circuits.
219 Variable: rootCellName
221 Name of root cell (the cell from which root.afs should be mounted in
229 If enabled, does not send or indicate that we are able to send or
230 receive RX jumbograms.
237 If set to anything other than -1, uses that value as the maximum MTU
238 supported by the RX interface.
240 In order to enable OpenAFS to operate across the Cisco IPSec VPN
241 client, this value must be set to 1264 or smaller.
243 Value : ConnDeadTimeout
245 Default : 60 (seconds)
246 Variable: ConnDeadtimeout
248 The Connection Dead Time is enforced to be at a minimum 15 seconds
249 longer than the minimum SMB timeout as specified by
251 HKLM\SYSTEM\CurrentControlSet\Services\lanmanworkstation\parameters
254 If the minimum SMB timeout is not specified the value is 45 seconds.
255 See http://support.microsoft.com:80/support/kb/articles/Q102/0/67.asp
258 Value : HardDeadTimeout
260 Default : 120 (seconds)
261 Variable: HardDeadtimeout
263 The Hard Dead Time is enforced to be at least double the ConnDeadTimeout.
264 The provides an opportunity for at least one retry.
271 Enables trace events for the AFS client and network provider.
276 Variable: allSubmount (smb.c)
278 By setting this value to 0, the "\\NetbiosName\all" mount point
279 will not be created. This allows the read-write versions of
280 root.afs to be hidden.
282 Value : NoFindLanaByName
286 Disables the attempt to identity the network adapter to use by
287 looking for an adapter with a display name of "AFS".
290 Type : DWORD {1..32} or {1..64} depending on the architecture
291 Default : <no default>
293 If this value is specified, afsd_service.exe will restrict itself
294 to executing on the specified number of CPUs if there are a greater
295 number installed in the machine.
297 NOTE: Setting this entry to "1" may be required on hyperthreaded
298 systems to avoid crashes in the RX library.
304 If this value is specified, it defines the type of SMB authentication
305 which must be present in order for the Windows SMB client to connect
306 to the AFS Client Service's SMB server. The values are:
307 0 = No authentication required
308 1 = NTLM authentication required
309 2 = Extended (GSS SPNEGO) authentication required
310 The default is Extended authentication
313 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters\GlobalAutoMapper]
315 Value : <Drive Letter:> for example "G:"
318 Specifies the submount name to be mapped by afsd_service.exe at startup
319 to the provided drive letter.
324 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
327 2. Network provider parameters
328 ------------------------------
329 Affects the network provider (afslogon.dll).
332 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
334 Value : FailLoginsSilently
338 Do not display message boxes if the login fails.
341 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
347 Disables visible warnings during logon.
349 Value : AuthentProviderPath
351 NSIS : %WINDIR%\SYSTEM32\afslogon.dll
353 Specifies the install location of the authentication provider dll.
359 Specifies the class of network provider
361 Value : DependOnGroup
365 Specifies the service groups upon which the AFS Client Service
366 depends. Windows should not attempt to start the AFS Client Service
367 until all of the services within these groups have successfully
370 Value : DependOnService
372 NSIS : Tcpip NETBIOS RpcSs
374 Specifies a list of services upon which the AFS Client Service
375 depends. Windows should not attempt to start the AFS Client Service
376 until all of the specified services have successfully started.
380 NSIS : "OpenAFSDaemon"
382 Specifies the display name of the AFS Client Service
386 NSIS : %WINDIR%\SYSTEM32\afslogon.dll
388 Specifies the DLL to use for the network provider
392 [HKLM\SOFTWARE\OpenAFS\Client]
394 Value : CellServDBDir
396 Default : <not defined>
398 Specifies the directory containing the CellServDB file.
399 When this value is not specified, the AFS Client install
404 2.1 Domain specific configuration keys for the Network Provider
405 ---------------------------------------------------------------
407 The network provider can be configured to have different behavior
408 depending on the domain that the user logs into. These settings are
409 only relevant when using integrated login. A domain refers to an
410 Active Directory (AD) domain, a trusted Kerberos (non-AD) realm or the
411 local machine (i.e. local account logins). The domain name that is
412 used for selecting the domain would be the domain that is passed into
413 the NPLogonNotify function of the network provider.
415 Domain specific registry keys are :
417 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
420 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]
423 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\"domain name"]
424 (Specific domain key. One per domain.)
426 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]
430 HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider
437 Each of the domain specific keys can have the set of values described
438 in 2.1.1. The effective values are chosen as described in 2.1.2.
440 2.1.1 Domain specific configuration values
441 -------------------------------------------
442 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
443 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]
444 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\"domain name"]
445 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]
450 NSIS/WiX: depends on user configuration
452 0x00 - Integrated Logon is not used
453 0x01 - Integrated Logon is used
454 0x02 - High Security Mode is used
455 0x03 - Integrated Logon with High Security Mode is used
457 High Security Mode generates random SMB names for the creation of
458 Drive Mappings. This mode should not be used without Integrated Logon.
460 As of 1.3.65 the SMB server supports SMB authentication. The High
461 Security Mode should not be used when using SMB authentication
462 (SMBAuthType setting is non zero).
464 Value : FailLoginsSilently
469 If true, does not display any visible warnings in the event of an
470 error during the integrated login process.
473 Type : REG_SZ or REG_EXPAND_SZ
475 NSIS/WiX: (only value under NP key) <install path>\afscreds.exe -:%s -x -a -m -n -q
477 A logon script that will be scheduled to be run after the profile
478 load is complete. If using the REG_EXPAND_SZ type, you can use
479 any system environment variable as "%varname%" which would be
480 expanded at the time the network provider is run. Optionally
481 using a "%s" in the value would result in it being expanded into
482 the AFS SMB username for the session.
484 Value : LoginRetryInterval
489 If the OpenAFS client service has not started yet, the network
490 provider will wait for a maximum of "LoginRetryInterval" seconds
491 while retrying every "LoginSleepInterval" seconds to check if the
494 Value : LoginSleepInterval
499 See description of LoginRetryInterval.
502 2.1.2 Selection of effective values for domain specific configuration
503 ----------------------------------------------------------------------
505 During login to domain X, where X is the domain passed into
506 NPLogonNotify as lpAuthentInfo->LogonDomainName or the string
507 'LOCALHOST' if lpAuthentInfo->LogonDomainName equals the name of the
508 computer, the following keys will be looked up.
510 1. NP key. ("HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider")
511 2. Domains key. (NP key\"Domain")
512 3. Specific domain key. (Domains key\X)
514 If the specific domain key does not exist, then the domains key will
515 be ignored. All the configuration information in this case will
516 come from the NP key.
518 If the specific domain key exists, then for each of the values
519 metioned in (2), they will be looked up in the specific domain key,
520 domains key and the NP key successively until the value is found.
521 The first instance of the value found this way will be the effective
522 for the login session. If no such instance can be found, the
523 default will be used. To re-iterate, a value in a more specific key
524 supercedes a value in a less specific key. The exceptions to this
525 rule are stated below.
527 2.1.3 Exceptions to 2.1.2
528 --------------------------
530 To retain backwards compatibility, the following exceptions are made
533 2.1.3.1 'FailLoginsSilently'
535 Historically, the 'FailLoginsSilently' value was in
536 HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters
537 key and not in the NP key. Therefore, for backwards compatibility,
538 the value in the Parameters key will supercede all instances of this
539 value in other keys. In the absence of this value in the Parameters
540 key, normal scope rules apply.
542 2.1.3.2 'LogonScript'
544 If a 'LogonScript' is not specified in the specific domain key nor
545 in the domains key, the value in the NP key will only be checked if
546 the effective 'LogonOptions' specify a high security integrated
547 login. If a logon script is specified in the specific domain key or
548 the domains key, it will be used regardless of the high security
549 setting. Please be aware of this when setting this value.
552 3. AFS Credentials System Tray Tool parameters
553 ----------------------------------------------
554 Affects the behavior of afscreds.exe
557 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
562 Function: GetGatewayName()
564 If the AFS client is utilizing a gateway to obtain AFS access,
565 the name of the gateway is specified by this value.
570 Variable: IsServiceConfigured()
572 The value Cell is used to determine if the AFS Client Service has
573 been properly configured or not.
577 [HKLM\SOFTWARE\OpenAFS\Client]
578 [HKCU\SOFTWARE\OpenAFS\Client]
583 Function: InitApp(), Main_OnCheckTerminate()
585 This value is used to determine whether or not a shortcut should be
586 maintained in the user's Start Menu->Programs->Startup folder.
588 This value used to be stored at
589 [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].
594 Function: KFW_is_available()
596 When MIT Kerberos for Windows can be loaded, Kerberos 5 will be used
597 to obtain AFS credentials. By setting this value to 0, the internal
598 Kerberos 4 implementation will be used instead.
600 Value : AfscredsShortcutParams
602 Default : "-A -M -N -Q"
603 Function: Shortcut_FixStartup
605 This value specifies the command line options which should be set
606 as part of the shortcut to afscreds.exe.
610 [HKCU\SOFTWARE\OpenAFS\Client]
612 Value : Authentication Cell
615 Function: Afscreds.exe GetDefaultCell()
617 This value allows the user to configure a different cell name to
618 be used as the default cell when acquiring tokens in afscreds.exe
622 [HKCU\SOFTWARE\OpenAFS\Client]
624 Value : Authentication Cell
627 Function: Afscreds.exe GetDefaultCell()
629 This value allows the user to configure a different cell name to
630 be used as the default cell when acquiring tokens in afscreds.exe
634 [HKCU\SOFTWARE\OpenAFS\Client\Reminders]
636 Value : "afs cell name"
639 Function: LoadRemind(), SaveRemind()
641 These values are used to save and restore the state of the reminder
642 flag for each cell for which the user has obtained tokens.
644 This value used to be stored at
645 [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].
649 [HKCU\SOFTWARE\OpenAFS\Client\Active Maps]
651 Value : "upper case drive letter"
655 These values are used to store the persistence state of the AFS
656 drive mappings as listed in the [...\Client\Mappings] key
658 These values used to be stored in the afsdsbmt.ini file
661 [HKCU\SOFTWARE\OpenAFS\Client\Mappings]
663 Value : "upper case drive letter"
667 These values are used to store the AFS path in Unix notation
668 to which the drive letter is to be mapped.
670 These values used to be stored in the afsdsbmt.ini file.
674 [HKLM\SOFTWARE\OpenAFS\Client\CSCPolicy]
676 Value : "smb/cifs share name"
680 This key is used to map SMB/CIFS shares to Client Side Caching
681 (off-line access) policies. For each share one of the following
682 policies may be used: "manual", "programs", "documents", "disable"
684 These values used to be stored in afsdsbmt.ini
687 [HKLM\SOFTWARE\OpenAFS\Client\Freelance]
689 Value : "numeric value"
693 This key is used to store newline terminated mount point strings
694 for use in constructing the fake root.afs volume when Freelance
695 (dynamic roots) mode is activated.
697 "athena.mit.edu#athena.mit.edu:root.cell.\n"
698 ".athena.mit.edu%athena.mit.edu:root.cell.\n"
700 These values used to be stored in afs_freelance.ini
704 [HKLM\SOFTWARE\OpenAFS\Client\Submounts]
706 Value : "submount name"
710 This key is used to store mappings of unix style AFS paths
711 to submount names which can be referenced as UNC paths.
712 For example the submount string "/athena.mit.edu/user/j/a/jaltman"
713 can be associated with the submount name "jaltman.home".
714 This can then be referenced as the UNC path \\AFS\jaltman.home.
716 These values used to be stored in afsdsbmt.ini
720 [HKCU\SOFTWARE\OpenAFS\Client\Active Maps]
722 Value : "upper case drive letter"
726 These values are used to store the persistence state of the AFS
727 drive mappings as listed in the [...\Client\Mappings] key
729 These values used to be stored in the afsdsbmt.ini file
732 [HKCU\SOFTWARE\OpenAFS\Client\Mappings]
734 Value : "upper case drive letter"
738 These values are used to store the AFS path in Unix notation
739 to which the drive letter is to be mapped.
741 These values used to be stored in the afsdsbmt.ini file.
745 [HKLM\SOFTWARE\OpenAFS\Client\CSCPolicy]
747 Value : "smb/cifs share name"
751 This key is used to map SMB/CIFS shares to Client Side Caching
752 (off-line access) policies. For each share one of the following
753 policies may be used: "manual", "programs", "documents", "disable"
755 These values used to be stored in afsdsbmt.ini
758 [HKLM\SOFTWARE\OpenAFS\Client\Freelance]
760 Value : "numeric value"
764 This key is used to store newline terminated mount point strings
765 for use in constructing the fake root.afs volume when Freelance
766 (dynamic roots) mode is activated.
768 "athena.mit.edu#athena.mit.edu:root.cell.\n"
769 ".athena.mit.edu%athena.mit.edu:root.cell.\n"
771 These values used to be stored in afs_freelance.ini
775 [HKLM\SOFTWARE\OpenAFS\Client\Submounts]
777 Value : "submount name"
781 This key is used to store mappings of unix style AFS paths
782 to submount names which can be referenced as UNC paths.
783 For example the submount string "/athena.mit.edu/user/j/a/jaltman"
784 can be associated with the submount name "jaltman.home".
785 This can then be referenced as the UNC path \\AFS\jaltman.home.
787 These values used to be stored in afsdsbmt.ini
790 ENVIRONMENT VARIABLES:
792 Variable: AFS_RPC_ENCRYPT
793 Values: "OFF" disables the use of RPC encryption
794 any other value allows RPC encryption to be used
795 Default: RPC encryption is on
798 Variable: AFS_RPC_PROTSEQ
799 Values: "ncalrpc" - local RPC
800 "ncacn_np" - named pipes
801 "ncacn_ip_tcp" - tcp/ip