service-dependencies-20040315
[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_LogofTokenTransferTimeout 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.
112
113 Value   : TrapOnPanic
114 Type    : DWORD {1,0}
115 Default : 0
116 Variable: traceOnPanic
117
118   Issues a breakpoint in the event of a panic. (breakpoint: _asm int 3).
119
120 Value   : IsGateway
121 Type    : DWORD {1,0}
122 Default : 0
123 Variable: isGateway
124
125   Select whether or not this AFS client should act as a gateway.  If
126   set and the NetBIOS name hostname-AFS is bound to a physical NIC,
127   other machines in the subnet can access AFS via SMB connections to
128   hostname-AFS .
129
130 Value   : ReportSessionStartups
131 Type    : DWORD {1,0}
132 Default : 0
133 Variable: reportSessionStartups
134
135   If enabled, all SMB sessions created are recorded in the Application
136   event log.
137
138 Value   : TraceBufferSize
139 Type    : QWORD
140 Default : 5000 (CM_CONFIGDEFAULT_TRACEBUFSIZE)
141 Variable: traceBufSize
142
143   Number of entries to keep in trace log.
144
145 Value   : SysName
146 Type    : REG_SZ
147 Default : "i386_nt40"
148 Variable: cm_sysName
149
150   Self explanatory.
151
152 Value   : SecurityLevel
153 Type    : DWORD {1,0}
154 Default : 0
155 Variable: cryptall
156
157   Enables encryption on RX calls.
158
159 Value   : UseDNS
160 Type    : DWORD {1,0}
161 Default : 1
162 Variable: cm_dnsEnabled
163
164   Enables resolving volservers using AFSDB DNS queries. (see
165   afsdb-freelance-notes)
166
167 Value   : FreelanceClient
168 Type    : DWORD {1,0}
169 Default : 0
170 Variable: cm_freelanceEnabled
171
172   Enables freelance client. (see afsdb-freelance-notes)
173
174 Value   : HideDotFiles
175 Type    : DWORD {1,0}
176 Default : 1
177 Variable: smb_hideDotFiles
178
179   Enables marking dotfiles with the hidden attribute.  Dot files are
180   files whose name starts with a period (excluding "." and "..").
181
182 Value   : MaxMpxRequests
183 Type    : DWORD
184 Default : 50
185 Variable: smb_maxMpxRequests
186
187   Maximum number of multiplexed SMB requests that can be made.
188
189 Value   : MaxVCPerServer
190 Type    : DWORD
191 Default : 100
192 Variable: smb_maxVCPerServer
193
194   Maximum number of SMB virtual circuits.
195
196 Value   : Cell
197 Type    : REG_SZ
198 Default : <none>
199 Variable: rootCellName
200
201   Name of root cell (the cell from which root.afs should be mounted in
202   \\afs\all).
203
204 Value   : RxNoJumbo
205 Type    : DWORD {0,1}
206 Default : 0
207 Variable: rx_nojumbo
208
209   If enabled, does not send or indicate that we are able to send or
210   receive RX jumbograms.
211
212 Value   : RxMaxMTU
213 Type    : DWORD
214 Default : -1
215 Variable: rx_mtu
216
217   If set to anything other than -1, uses that value as the maximum MTU
218   supported by the RX interface.
219
220 2. Network provider parameters
221 ------------------------------
222 Affects the network provider (aklogon.dll).
223
224 Regkey:
225 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
226
227 Value   : FailLoginsSilently
228 Type    : DWORD
229 Default : 0
230
231 Do not display message boxes if the login fails.
232
233 Regkey:
234 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
235
236 Value   : NoWarnings
237 Type    : DWORD
238 Default : 0
239
240 Disables visible warnings during logon.
241