2 Registry keys used in the Windows AFS Client
3 --------------------------------------------
5 This file describes the registry keys used in the Windows AFS clients.
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.
246 Variable: allSubmount (smb.c)
248 By setting this value to 0, the "\\NetbiosName\all" mount point
249 will not be created. This allows the read-write versions of
250 root.afs to be hidden.
252 Value : NoFindLanaByName
256 Disables the attempt to identity the network adapter to use by
257 looking for an adapter with a display name of "AFS".
262 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
265 2. Network provider parameters
266 ------------------------------
267 Affects the network provider (aklogon.dll).
270 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
272 Value : FailLoginsSilently
276 Do not display message boxes if the login fails.
279 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
285 Disables visible warnings during logon.
287 Value : AuthentProviderPath
289 NSIS : <install path>\afslogon.dll
291 Specifies the install location of the authentication provider dll.
297 Specifies the class of network provider
299 Value : DependOnGroup
303 Specifies the service groups upon which the AFS Client Service
304 depends. Windows should not attempt to start the AFS Client Service
305 until all of the services within these groups have successfully
308 Value : DependOnService
310 NSIS : Tcpip NETBIOS RpcSs
312 Specifies a list of services upon which the AFS Client Service
313 depends. Windows should not attempt to start the AFS Client Service
314 until all of the specified services have successfully started.
318 NSIS : depends on user configuration
320 0x00 - Integrated Logon is not used
321 0x01 - Integrated Logon is used
322 0x02 - High Security Mode is used
323 0x03 - Integrated Logon with High Security Mode is used
325 High Security Mode generates random SMB names for the creation of
326 Drive Mappings. This mode should not be used without Integrated Logon.
330 NSIS : <install path>\afscreds.exe -:%s -x
332 Specifies the command to be executed at the end of successful logon.
336 NSIS : "OpenAFSDaemon"
338 Specifies the display name of the AFS Client Service
342 NSIS : <install path>\afslogon.dll
344 Specifies the DLL to use for the network provider
346 Value : VerboseLogging
350 Determines the level of logging to be enabled
353 3. AFS Credentials System Tray Tool parameters
354 ----------------------------------------------
355 Affects the behavior of afscreds.exe
358 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
363 Function: GetGatewayName()
365 If the AFS client is utilizing a gateway to obtain AFS access,
366 the name of the gateway is specified by this value.
371 Variable: IsServiceConfigured()
373 The value Cell is used to determine if the AFS Client Service has
374 been properly configured or not.
378 [HKLM\SOFTWARE\OpenAFS\Client]
379 [HKCU\SOFTWARE\OpenAFS\Client]
384 Function: InitApp(), Main_OnCheckTerminate()
386 This value is used to determine whether or not a shortcut should be
387 maintained in the user's Start Menu->Programs->Startup folder.
389 This value used to be stored at
390 [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].
395 Function: KFW_is_available()
397 When MIT Kerberos for Windows can be loaded, Kerberos 5 will be used
398 to obtain AFS credentials. By setting this value to 0, the internal
399 Kerberos 4 implementation will be used instead.
401 Value : AfscredsShortcutParams
403 Default : "-A -M -N -Q"
404 Function: Shortcut_FixStartup
406 This value specifies the command line options which should be set
407 as part of the shortcut to afscreds.exe.
411 [HKCU\SOFTWARE\OpenAFS\Client\Reminders]
413 Value : "afs cell name"
416 Function: LoadRemind(), SaveRemind()
418 These values are used to save and restore the state of the reminder
419 flag for each cell for which the user has obtained tokens.
421 This value used to be stored at
422 [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].