registry-notes-20040316
[openafs.git] / doc / txt / winnotes / registry.txt
1
2 Registry keys used in the Windows AFS Client
3 --------------------------------------------
4
5 This file describes the registry keys used in the Windows AFS clients.
6
7 1. Service parameters
8 ---------------------
9
10 The service parameters primarily affect the behavior of the AFS client
11 service (afsd_service.exe).
12
13 Regkey:
14 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
15
16 Value   : LANadapter
17 Type    : DWORD
18 Default : -1
19 Variable: LANadapter
20
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
28   name will be 'AFS'.
29
30 Value   : CacheSize
31 Type    : QWORD
32 Default : 20480 (CM_CONFIGDEFAULT_CACHESIZE)
33 Variable: cm_initParams.cacheSize
34
35   Size of the AFS cache.
36
37 Value   : ChunkSize
38 Type    : DWORD
39 Default : 15 (CM_CONFIGDEFAULT_CHUNKSIZE)
40 Variable: cm_logChunkSize (cm_chunkSize = 1 << cm_logChunkSize)
41
42   Size of chunk for reading and writing. Actual chunk size is 2^cm_logChunkSize.
43
44 Value   : Daemons
45 Type    : DWORD
46 Default : 2 (CM_CONFIGDEFAULT_DAEMONS)
47 Variable: numBkgD
48
49   Number of background daemons (number of threads of
50   cm_BkgDaemon). (see cm_BkgDaemon in cm_daemon.c)
51
52 Value   : ServerThreads
53 Type    : DWORD
54 Default : 4 (CM_CONFIGDEFAULT_SVTHREADS)
55 Variable: numSvThreads
56
57   Number of SMB server threads (number of threads of smb_Server). (see
58   smb_Server in smb.c).
59
60 Value   : Stats
61 Type    : QWORD
62 Default : 1000 (CM_CONFIGDEFAULT_STATS)
63 Variable: cm_initParams.nStatCaches
64
65   Cache configuration.
66
67 Value   : LogoffTokenTransfer
68 Type    : DWORD {1,0}
69 Default : 1
70 Variable: smb_LogoffTokenTransfer
71
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.
77
78 Value   : LogoffTokenTransferTimeout
79 Type    : QWORD
80 Default : 10
81 Variable: smb_LogoffTokenTransferTimeout
82
83   See LogoffTokenTransfer above.
84
85 Value   : RootVolume
86 Type    : REG_SZ
87 Default : "root.afs"
88 Variable: cm_rootVolumeName
89
90   Root volume name.
91
92 Value   : Mountroot
93 Type    : REG_SZ
94 Default : "/afs"
95 Variable: cm_mountRoot
96
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)
105  
106 Value   : CachePath
107 Type    : REG_SZ
108 Default : "\AFSCache"
109 Variable: cm_CachePath
110
111   Location of on-disk cache file.  The default implies the root 
112   directory of the boot disk
113
114 Value   : TrapOnPanic
115 Type    : DWORD {1,0}
116 Default : 0
117 Variable: traceOnPanic
118
119   Issues a breakpoint in the event of a panic. (breakpoint: _asm int 3).
120
121 Value   : NetbiosName
122 Type    : REG_SZ
123 Default : "AFS"
124 Variable: cm_NetbiosName
125
126   Specifies the NetBIOS name to be used when binding to a Loopback
127   adapter.
128
129 Value   : IsGateway
130 Type    : DWORD {1,0}
131 Default : 0
132 Variable: isGateway
133
134   Select whether or not this AFS client should act as a gateway.  If
135   set and the NetBIOS name hostname-AFS is bound to a physical NIC,
136   other machines in the subnet can access AFS via SMB connections to
137   hostname-AFS.
138
139   When IsGateway is non-zero, the LAN adapter detection code will
140   avoid binding to a loopback adapter.  This will ensure that the
141   NetBIOS name will be of the form hostname-AFS instead of the value
142   set by the "NetbiosName" registry value.
143
144 Value   : ReportSessionStartups
145 Type    : DWORD {1,0}
146 Default : 0
147 Variable: reportSessionStartups
148
149   If enabled, all SMB sessions created are recorded in the Application
150   event log.  This also enables other events such as drive mappings
151   or various error types to be logged.
152
153 Value   : TraceBufferSize
154 Type    : QWORD
155 Default : 5000 (CM_CONFIGDEFAULT_TRACEBUFSIZE)
156 Variable: traceBufSize
157
158   Number of entries to keep in trace log.
159
160 Value   : SysName
161 Type    : REG_SZ
162 Default : "i386_nt40"
163 Variable: cm_sysName
164
165   Self explanatory.
166
167 Value   : SecurityLevel
168 Type    : DWORD {1,0}
169 Default : 0
170 Variable: cryptall
171
172   Enables encryption on RX calls.
173
174 Value   : UseDNS
175 Type    : DWORD {1,0}
176 Default : 1
177 Variable: cm_dnsEnabled
178
179   Enables resolving volservers using AFSDB DNS queries. (see
180   afsdb-freelance-notes).
181
182   As of 1.3.60, this value is ignored as the DNS query support
183   utilizes the Win32 DNSQuery API which is available on Win2000
184   and above.
185
186 Value   : FreelanceClient
187 Type    : DWORD {1,0}
188 Default : 0
189 Variable: cm_freelanceEnabled
190
191   Enables freelance client. (see afsdb-freelance-notes)
192
193 Value   : HideDotFiles
194 Type    : DWORD {1,0}
195 Default : 1
196 Variable: smb_hideDotFiles
197
198   Enables marking dotfiles with the hidden attribute.  Dot files are
199   files whose name starts with a period (excluding "." and "..").
200
201 Value   : MaxMpxRequests
202 Type    : DWORD
203 Default : 50
204 Variable: smb_maxMpxRequests
205
206   Maximum number of multiplexed SMB requests that can be made.
207
208 Value   : MaxVCPerServer
209 Type    : DWORD
210 Default : 100
211 Variable: smb_maxVCPerServer
212
213   Maximum number of SMB virtual circuits.
214
215 Value   : Cell
216 Type    : REG_SZ
217 Default : <none>
218 Variable: rootCellName
219
220   Name of root cell (the cell from which root.afs should be mounted in
221   \\afs\all).
222
223 Value   : RxNoJumbo
224 Type    : DWORD {0,1}
225 Default : 0
226 Variable: rx_nojumbo
227
228   If enabled, does not send or indicate that we are able to send or
229   receive RX jumbograms.
230
231 Value   : RxMaxMTU
232 Type    : DWORD
233 Default : -1
234 Variable: rx_mtu
235
236   If set to anything other than -1, uses that value as the maximum MTU
237   supported by the RX interface.
238
239   In order to enable OpenAFS to operate across the Cisco IPSec VPN
240   client, this value must be set to 1264 or smaller.
241
242 Value   : AllSubmount
243 Type    : DWORD {0, 1}
244 Default : 1
245 Variable: allSubmount (smb.c)
246
247   By setting this value to 0, the "\\NetbiosName\all" mount point 
248   will not be created.  This allows the read-write versions of 
249   root.afs to be hidden.
250
251
252 Regkey:
253 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
254
255
256 2. Network provider parameters
257 ------------------------------
258 Affects the network provider (aklogon.dll).
259
260 Regkey:
261 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
262
263 Value   : FailLoginsSilently
264 Type    : DWORD
265 Default : 0
266
267   Do not display message boxes if the login fails.
268
269 Regkey:
270 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
271
272 Value   : NoWarnings
273 Type    : DWORD
274 Default : 0
275
276   Disables visible warnings during logon.
277
278 Value   : AuthentProviderPath
279 Type    : REG_SZ
280 NSIS    : <install path>\afslogon.dll
281
282   Specifies the install location of the authentication provider dll.
283
284 Value   : Class
285 Type    : DWORD
286 NSIS    : 0x02
287
288   Specifies the class of network provider
289
290 Value   : DependOnGroup
291 Type    : REG_MULTI_SZ
292 NSIS    : PNP_TDI
293
294   Specifies the service groups upon which the AFS Client Service 
295   depends.  Windows should not attempt to start the AFS Client Service
296   until all of the services within these groups have successfully 
297   started.
298
299 Value   : DependOnService
300 Type    : REG_MULTI_SZ
301 NSIS    : Tcpip NETBIOS RpcSs
302
303   Specifies a list of services upon which the AFS Client Service 
304   depends.  Windows should not attempt to start the AFS Client Service
305   until all of the specified services have successfully started.
306   
307 Value   : LogonOptions
308 Type    : DWORD
309 NSIS    : depends on user configuration
310
311   0x00 - Integrated Logon is not used
312   0x01 - Integrated Logon is used
313   0x02 - High Security Mode is used
314   0x03 - Integrated Logon with High Security Mode is used
315
316   High Security Mode generates random SMB names for the creation of
317   Drive Mappings.  This mode should not be used without Integrated Logon.
318
319 Value   : LogonScript
320 Type    : REG_SZ
321 NSIS    : <install path>\afscreds.exe -:%s -x
322
323   Specifies the command to be executed at the end of successful logon.
324
325 Value   : Name
326 Type    : REG_SZ
327 NSIS    : "OpenAFSDaemon"
328
329   Specifies the display name of the AFS Client Service
330
331 Value   : ProviderPath
332 Type    : REG_SZ
333 NSIS    : <install path>\afslogon.dll
334
335   Specifies the DLL to use for the network provider
336
337 Value   : VerboseLogging
338 Type    : DWORD
339 NSIS    : 0x0a
340
341   Determines the level of logging to be enabled
342
343
344 3. AFS Credentials System Tray Tool parameters
345 ----------------------------------------------
346 Affects the behavior of afscreds.exe
347
348 Regkey:
349 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
350
351 Value   : Gateway
352 Type    : REG_SZ
353 Default : ""
354 Function: GetGatewayName()
355
356   If the AFS client is utilizing a gateway to obtain AFS access, 
357   the name of the gateway is specified by this value.
358
359 Value   : Cell
360 Type    : REG_SZ
361 Default : <none>
362 Variable: IsServiceConfigured()
363
364   The value Cell is used to determine if the AFS Client Service has
365   been properly configured or not.
366
367
368 Regkey:
369 [HKLM\SOFTWARE\OpenAFS\Client]
370 [HKCU\SOFTWARE\OpenAFS\Client]
371
372 Value   : ShowTrayIcon
373 Type    : DWORD {0, 1}
374 Default : 1
375 Function: InitApp(), Main_OnCheckTerminate()
376
377   This value is used to determine whether or not a shortcut should be
378   maintained in the user's Start Menu->Programs->Startup folder. 
379
380   This value used to be stored at 
381   [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].
382
383 Value   : EnableKFW
384 Type    : DWORD {0, 1}
385 Default : 1
386 Function: KFW_is_available()
387
388   When MIT Kerberos for Windows can be loaded, Kerberos 5 will be used
389   to obtain AFS credentials.  By setting this value to 0, the internal
390   Kerberos 4 implementation will be used instead.
391
392 Value   : AfscredsShortcutParams
393 Type    : REG_SZ
394 Default : "-A -M -N -Q"
395 Function: Shortcut_FixStartup
396
397   This value specifies the command line options which should be set
398   as part of the shortcut to afscreds.exe.
399
400
401 Regkey:
402 [HKCU\SOFTWARE\OpenAFS\Client\Reminders]
403
404 Value   : "afs cell name"
405 Type    : DWORD {0, 1}
406 Default : <none>
407 Function: LoadRemind(), SaveRemind()
408
409   These values are used to save and restore the state of the reminder
410   flag for each cell for which the user has obtained tokens.
411
412   This value used to be stored at 
413   [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].
414
415