1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.3//EN"
3 "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
4 <!ENTITY version SYSTEM "version.xml">
9 <title>OpenAFS for Windows Release Notes</title>
11 <year>2003-2009</year>
12 <holder>Secure Endpoints Inc.</holder>
15 <para>This documentation is covered by the MIT License.</para>
21 <para>This document provides a series of usage notes regarding the OpenAFS for Windows
22 client, supported platforms, contribution information, debugging techniques, and
23 a reference to supported Windows registry values.
28 <title id='Preface'>Preface</title>
29 <para>The Andrew File System (AFS) is a location-independent file system that uses a local cache to increase its performance. An AFS client accesses files anonymously or via a Kerberos authentication. The global AFS is partitioned into cells. The AFS cell is a collection of AFS volumes that are administered by a common entity. AFS cells can be administered by a department even when the Kerberos realm used for local authentication is managed by a much larger organization. AFS clients and servers take advantage of Kerberos cross realm authentication to enable authenticated access by entities located outside the local realm. Authorization is enforced by the use of directory level access control lists which can consist of individual or group identities. </para>
30 <para>The AFS volume is a tree of files and sub-directories. AFS volumes are created by administrators and are joined to an AFS cell via the use of a mount point. Once a volume is created, users can create files and directories as well as mount points and symlinks within the volume without regard for the physical location of the volume. Administrators can move the volume to another server as necessary without the need to notify users. In fact, the volume move can occur while files in the volume are in use. </para>
31 <para>AFS volumes can be replicated to read-only copies. When accessing files from a read-only replica, clients will read all of the data from a single replica. If that replica becomes unavailable, the clients will failover to any replica that is reachable. Users of the data are unaware of where the replicas are stored or which one is being accessed. The contents of the replicas can be updated at any time by
32 <emphasis>releasing</emphasis> the current contents of the source volume.
34 <para>OpenAFS for Windows (OAFW) provides AFS client access Microsoft Windows operating systems. It strives to maintain transparency such that the user is unaware of the distinction between the use of AFS and Microsoft Windows file shares. OAFW can be part of a single sign-on solution by allowing credentials for a Kerberos principal to be obtained at logon and for that principal to be used to obtain AFS tokens for one or more cells. Although OAFW is implemented as a locally installed SMB to AFS gateway, OAFW maintains the portability of file paths by its use of the \\AFS UNC server name.</para>
35 <para>OpenAFS is the product of an open source development effort begun on October 31 2000. OpenAFS is maintained and developed by a group of volunteers with the support of the user community. If you use OpenAFS as part of your computing infrastructure please contribute to its continued growth.
39 <title id='Installer_Options'>Installer Options</title>
40 <para>It can be installed either as a new installation or an upgrade from previous versions of OpenAFS for Windows or IBM AFS for Windows. Installers are provided in two forms:</para>
44 an executable (.exe) that is built using the Nullsoft Scriptable Installation System, or
47 a Windows Installer package (.msi) that is built using WiX and can be customized for organizations via the use of MSI Transforms (see
48 <link linkend='MSI_Deployment_Guide'>MSI Deployment Guide</link>)
54 <title id='System_Requirements'>System Requirements</title>
56 <indexterm><primary>operating system versions, supported</primary></indexterm>
57 <indexterm><primary>system requirements</primary></indexterm>
58 <title id='Supported_Operating_Systems'>2.1 Supported Operating Systems</title>
61 <para>Microsoft Windows 2000 Workstation</para>
64 <para>Microsoft Windows 2000 Server </para>
67 <para>Microsoft Windows XP Home</para>
70 <para>Microsoft Windows XP Professional</para>
73 <para>Microsoft Windows XP 64</para>
76 <para>Microsoft Windows 2003 Server (32-bit and 64-bit Intel)</para>
79 <para>Microsoft Windows 2003 R2 Server (32-bit and 64-bit Intel)</para>
82 <para>Microsoft Windows Vista (32-bit and 64-bit Intel)</para>
85 <para>Microsoft Windows 2008 Server (32-bit and 64-bit Intel)</para>
88 <para>Microsoft Windows 7 (32-bit and 64-bit Intel)</para>
91 <para>Microsoft Windows 2008 Server R2 (32-bit and 64-bit Intel)</para>
96 <indexterm><primary>operating system versions, unsupported</primary></indexterm>
97 <title id='Unsupported_Operating_Systems'>2.1.1 Unsupported Operating Systems</title>
100 <para> Microsoft Windows 95</para>
103 <para>Microsoft Windows 98</para>
106 <para>Microsoft Windows 98 OSR2</para>
109 <para>Microsoft Windows ME</para>
112 <para>Microsoft NT</para>
115 <para>Older releases of OpenAFS are available for download if unsupported operating systems must be used. The last version of OpenAFS with support for Win9x is 1.2.2b. The last version with support for Windows NT 4.0 is 1.2.10.</para>
118 <indexterm><primary>disk space required</primary></indexterm>
119 <title id='Disk_Space'>2.2 Disk Space</title>
120 <para>Up to 60mb required for the OpenAFS binaries plus 100MB for the default AFSCache file. The size of the AFSCache file may be adjusted via the Registry after installation. The maximum cache size for 32-bit Windows is approximately 1.2GB. On 64-bit Windows there is no practical limit on the cache size.</para>
123 <title id='Additional_Software_Packages'>2.3 Additional Software Packages</title>
124 <indexterm><primary>kerberos for windows</primary></indexterm>
126 <ulink url='http://web.mit.edu/kerberos/dist/index.html'>MIT Kerberos for Windows</ulink> 2.6.x or 3.x.x if Kerberos v5 authentication support is desired. The recommended release is version 3.2.2. For 64-bit Windows installations, the 64-bit version of Kerberos for Windows is required. For 32-bit Windows installations, the 32-bit version of Kerberos for Windows is required.
127 See <link linkend='Kerberos_v5_Requirements'>3.2 Kerberos v5 Requirements</link> for additional details.
131 <chapter id='chap_3'>
132 <title id='Operational_Notes'>Operational Notes</title>
134 <indexterm><primary>unicode</primary></indexterm>
135 <indexterm><primary>character sets</primary></indexterm>
136 <indexterm><primary>roaming profiles</primary></indexterm>
137 <indexterm><primary>folder redirection</primary></indexterm>
138 <title id='Unicode_Support'>3.1. Unicode Support</title>
139 <para>Starting with the 1.5.50 release of OpenAFS for Windows, each of the AFS Client Service, the AFS Explorer Shell Extension, and the command-line tools are Unicode enabled. No longer is OpenAFS restricted to accessing file system objects whose names can be represented in the locale specific OEM code page. This has significant benefits for end users. Most importantly it permits non-Western languages to now be used for file system object names in AFS from Microsoft Windows operating systems. Now that Unicode names are supported,
140 <ulink url='http://en.wikipedia.org/wiki/Roaming_user_profile'>Roaming User Profiles</ulink> and
141 <ulink url='http://en.wikipedia.org/wiki/Folder_redirection'>Folder Redirection</ulink> will no longer fail when a user attempts to store an object with a name that cannot be represented in the OEM code page.
143 <para>Unicode names are stored in AFS using UTF-8 encoding. UTF-8 is supported as a locale on MacOS X, Linux, Solaris, and most other operating systems. This permits non-Western object names to be exchanged between Microsoft Windows and other operating systems. The OpenAFS for Windows client also implements
144 <ulink url='http://en.wikipedia.org/wiki/Unicode_normalization'>Unicode Normalization</ulink> as part of the name lookup algorithm. This is necessary because Unicode does not provide a unique representation for each input string. The use of normalization permits a file system object name created on MacOS X to be matched with the same string entered on Microsoft Windows even though the operating system’s choice of representation may be different.
146 <para>It is important to note that AFS file servers are not character set agnostic. All file system object names are stored as octet strings without any character set tagging. If a file system object is created using OEM Code Page 858 and then interpreted as UTF-8 it is likely that the object name will appear to be gibberish. OpenAFS for Windows goes to great lengths to ensure that the object name is converted to a form that will permit the user to rename the object using Unicode. Accessing UTF-8 names on UNIX systems that have the locale set to one of the ISO Latin character sets will result in the UTF-8 strings appearing to be gibberish. </para>
147 <para>Neither UNIX AFS nor Microsoft Windows 2000 systems can perform Unicode Normalization for string comparisons. Although it is possible to store and read Unicode object names, it is possible that a user may not be able to open an object by typing the name of the object at the keyboard. GUI point and click operations should permit any object to be accessed.</para>
150 <indexterm><primary>kerberos for windows</primary></indexterm>
151 <title id='Kerberos_v5_Requirements'>3.2. Requirements for Kerberos v5 Authentication</title>
152 <para>The OpenAFS distribution ships with its own implementation of Kerberos v4 and although it is Kerberos v5 capable, it relies on third party Kerberos v5 libraries. The OpenAFS 1.4 series (and later) integrates with
153 <ulink url='http://web.mit.edu/kerberos/'>MIT Kerberos for Windows</ulink> 2.6.5 and above. OpenAFS Kerberos v5 capable functionality includes integrated logon, the AFS Authentication Tool, the Network Identity Manager AFS provider, and the aklog command. These tools provide support for Kerberos v5 authentication including acquisition and automatic renewal of AFS tokens as well as support for single sign-on via the Microsoft Windows Kerberos Logon Service.
155 <indexterm><primary>network identity manager</primary></indexterm>
156 <para>The recommended version of
157 <ulink url='http://web.mit.edu/kerberos/'>MIT Kerberos for Windows</ulink> is 3.2.2 as distributed by <ulink url='https://www.secure-endpoints.com/'>Secure Endpoints Inc.</ulink>. As of this writing, the Secure Endpoints Inc. distribution provides 64-bit Windows support which is unavailable from MIT. KFW 3.2.2 includes Network Identity Manager 1.3.1 which integrates with the
158 <link linkend='Network_Identity_Manager_Provider'>AFS Provider</link> installed as part of OpenAFS for Windows.
160 <indexterm><primary>transarc afs</primary></indexterm>
161 <para>With Kerberos for Windows installed, the OpenAFS for Windows client can obtain Kerberos v5 service tickets for AFS cells for use as tokens. When a Kerberos v5 derived AFS token is in use, all of the AFS Servers within the authenticated cell must support Kerberos v5 authentication. If a Kerberos v5 based token is presented to an AFS server that does not support them, the server will be unable to communicate with the client. Attempts to access AFS volumes stored on such a server will fail with a "No Kerberos Key" error. Kerberos v5 based tokens are supported by OpenAFS revisions 1.2.8 or later. IBM Transarc servers do not support Kerberos v5.</para>
163 <indexterm><primary>active directory</primary></indexterm>
164 <indexterm><primary>des-cbc-crc encryption type</primary></indexterm>
165 <title id='Active_Directory'>3.2.1. Active Directory</title>
166 <para>Microsoft Windows Active Directory can be used as a Kerberos v5 KDC in conjunction with OpenAFS. There are two things to consider when using an Active Directory as the Kerberos realm that issues the AFS service ticket. First, the Kerberos v5 tickets issued by Active Directory can be quite large when compared to tickets issued by a traditional UNIX KDCs due to the inclusion of Windows specific authorization data (the Microsoft PAC). If the issued tickets are larger than 344 bytes, the OpenAFS 1.2 servers will be unable to process them and will issue a RXKADBADTICKET error. OpenAFS 1.4 (and beyond) servers can support the largest tickets that Active Directory can issue. Second, the Kerberos v5 tickets issued by Windows 2003 Active Directory are encrypted with the DES-CBC-MD5 encryption type (enctype). OpenAFS 1.2 servers only support the DES-CBC-CRC enctype. As a result, OpenAFS 1.2 servers cannot process the resulting Kerberos v5 tokens. Windows 2000 Active Directory issues tickets with the DES-CBC-CRC enctype. Windows Server 2008 R2 Active Directory domain by default disables use of DES-CBC-MD5 and it must be enabled.</para>
167 <para>Microsoft has documented in
168 <ulink url='http://support.microsoft.com/kb/832572/'>Knowledge Base article 832572</ulink> a new NO_AUTH_REQUIRED flag that can be set on the account mapped to the AFS service principal. When this flag is set, the PAC authorization data will not be included in the ticket. Setting this flag is recommended for all accounts that are associated with non-Windows services and that do not understand the authorization data stored in the PAC. This flag cannot be used if AFS service tickets are obtained via cross-realm using an Active Directory user principal.
170 <para>Note that an Active Directory computer object cannot be used for the afs service principal.</para>
173 <indexterm><primary>krb524</primary></indexterm>
174 <indexterm><primary>port, 4444/udp</primary></indexterm>
175 <indexterm><primary>registry value, Use524</primary></indexterm>
176 <title id='Using_krb524_Service'>3.2.2. Using the krb524 Service</title>
177 <para>Before there was native support for Kerberos v5 derived AFS tokens, the krb524 service was used to convert a Kerberos v5 service ticket into a Kerberos v4 service ticket that could in turn be used to construct an AFS authentication token. As of OpenAFS 1.2.8, support was added to allow the immediate use of Kerberos v5 tickets as AFS (2b) tokens. This is the first building block necessary to break away from the limitations of Kerberos v4 with AFS. By using Kerberos v5 directly we avoid the security holes inherent in Kerberos v4 cross-realm. We also gain access to cryptographically stronger algorithms for authentication and encryption.</para>
178 <para>Another reason for using Kerberos v5 directly is because the krb524 service runs on a port (4444/udp) which has increasingly been blocked by ISPs. The port was used to spread a worm which attacked Microsoft Windows in the summer of 2003. When the port is blocked users find that they are unable to authenticate.</para>
180 <para>Replacing the Kerberos v4 ticket with a Kerberos v5 ticket is a win in all situations except when the cell name does not match the realm name and the principal names placed into the ACL’s are not the principal names from the Kerberos v5 ticket. Unfortunately, some organizations have AFS cell names and Kerberos realm names which differ by more then just lower and upper case and rely on a modification to krb524d that maps a Kerberos v5 ticket from realm FOO to a Kerberos v4 ticket in realm BAR. This allows user@FOO to appear to be user@bar for the purposes of accessing the AFS cell.
182 <para>To support this mode of operation OpenAFS for Windows 1.4 supports a registry value,
183 <link linkend='Value_Use524'>Use524</link>, that forces the use of krb524d within the AFS Authentication Tool and integrated logon. This option should only be used by individuals until such time as their organizations can transition away from the krb524 service.
185 <para>Note that the OpenAFS 1.4.x servers permit the use of a secondary realm name that can be treated as equivalent to the cell name for authentication. This functionality can be used to avoid the need for the krb524 service if and only if both realms are managed by the same administrative entity.
189 <indexterm><primary>network identity manager</primary></indexterm>
190 <title id='Network_Identity_Manager_Provider'>3.2.3. Network Identity Manager Provider</title>
191 <para>As of release 1.5.9, OpenAFS for Windows includes a Network Identity Manager Provider for obtaining AFS tokens. This plug-in is a contribution from
192 <ulink url='https://www.secure-endpoints.com/'>Secure Endpoints Inc.</ulink> Network Identity Manager is a multiple identity credential management tool that ships with
193 <ulink url='http://web.mit.edu/kerberos/'>MIT Kerberos for Windows</ulink> version 3.0 and above. The OpenAFS plug-in requires
194 <ulink url='http://web.mit.edu/kerberos/'>MIT Kerberos for Windows</ulink> version 3.1 or above. Version 3.2.2 is recommended for the best user experience.
199 <imagedata format='JPG' fileref='relnotes00.jpg' />
203 <para>The Network Identity Manager replaces the former KFW ticket manager, "Leash", and when combined with the OpenAFS Provider it can be used as a replacement for the AFS Authentication Tool (afscreds.exe). Unlike both Leash and the AFS Authentication Tool, Network Identity Manager with the OpenAFS Provider can easily acquire and renew AFS tokens for multiple cells from one or more Kerberos v5 identities.</para>
207 <imagedata format='JPG' fileref='relnotes01.jpg' />
211 <para>The AFS configuration panel for each Kerberos v5 identity is used to configure which cells credentials should be obtained for and how they should be obtained. If the cell to realm mapping cannot be automatically determined, it can be explicitly specified. If the cell does not support Kerberos v5 tickets as tokens, then a krb524 service can be configured.</para>
215 <imagedata format='JPG' fileref='relnotes02.jpg' />
219 <para>The OpenAFS Provider configuration panel can be used to check the status of the AFS Client Service and its version. An optional checkbox is provided that will prevent the AFS Authentication Tool from being started by Windows after login. A shortcut to the OpenAFS Control Panel is also provided.</para>
220 <para>As of OpenAFS 1.5.66, the Network Identity Manager OpenAFS Provider displays the same AFS Lock notification icon generated by the AFS Authentication Tool. The AFS Lock can be used to determine if:</para>
222 <listitem><para>one or more AFS tokens are valid</para></listitem>
223 <llstitem><para>no AFS tokens are present but the AFS service is running</para></llstitem>
224 <listitem><para>the AFS Service is not running</para></listitem>
225 <listitem><para>the AFS Service is running but there is a communication error</para></listitem>
230 <indexterm><primary>microsoft loopback adapter</primary></indexterm>
231 <title id='Use_of_Microsoft_Loopback'>3.3. Use of the Microsoft Loopback Adapter by the AFS Client Service</title>
232 <para>The Microsoft Loopback Adapter (MLA) is installed with a name "AFS" and a pre-assigned IP address of 10.254.254.253. The MLA is bound to the "Client for Microsoft Networks" service and not bound to the "File and Printer Sharing for Microsoft Networks" service. If the MLA is unbound to "Client Microsoft Networks", the OpenAFS Client Service will become inaccessible when the machine is disconnected from the network. If the MLA is bound to "File and Printer Sharing ..." there will be a service type collision between the "AFS" SMB Service and the local machine's File Sharing Service. This will result in the OpenAFS client service becoming inaccessible and the "NET VIEW \\AFS" command will return a "System Error 52" message. To correct the problem:</para>
235 <para>stop the AFS Client Service</para>
238 <para>bind the "Client for Microsoft Networks" to the MLA</para>
241 <para>unbind "File and Printer Sharing for Microsoft Networks" from the MLA</para>
244 <para>disable and then re-enable the MLA</para>
247 <para>start the AFS Client Service</para>
250 <para>When the MLA is not installedNETBIOS name published by OpenAFS SMB server must be unique because it is published on the public network. The unique name will take the form "<emphasis>MACHINE</emphasis>-AFS". One of the benefits of using the MLA is that the NETBIOS name does not have to be published on any adapter other than the MLA. Therefore the chosen name is no longer required to be globally unique. Instead the NETBIOS name associated with the AFS Client Service is simply "AFS" and portable UNC paths of the form \\AFS\cellname\path can now be used on all machines.
254 <indexterm><primary>freelance mode</primary></indexterm>
255 <indexterm><primary>root.afs volume, fake</primary></indexterm>
256 <indexterm><primary>mount points</primary></indexterm>
257 <indexterm><primary>symlinks</primary></indexterm>
258 <title id='Using_Freelance_Mode'>3.4. Using Freelance (Dynamic Root) Mode to Improve Mobility</title>
259 <para>Traditionally, when the OpenAFS Client Service starts it must be able to access the "root.afs" volume of the default cell. The "root.afs" volume contains the set of mount points to the "root.cell" volumes of various cells the administrator of the default cell believes should be accessible. If the "root.afs" volume is inaccessible when the client service is started, the service will terminate unexpectedly. Since many users now use laptops or otherwise operate in disconnected environments in which a VPN may be required to access the cell's servers, it is often the case that the "root.afs" volume for the default cell is not reachable and the OpenAFS Client Service will not successfully start. </para>
260 <para>To allow the OpenAFS Client Service to operate in these environments, Freelance mode dynamically constructs a fake "root.afs" volume from mount points and symlinks stored in the local registry.</para>
261 <para>The content of the fake "root.afs" volume is dynamically generated as cells are accessed. When the fake "root.afs" volume is initially constructed it will only contain two mount points: a
262 <emphasis>regular path </emphasis>and
263 <emphasis>read-write path </emphasis>mount point used to access the "root.cell" volume of the default AFS cell. Any attempt to access a valid cell name will result in a new mount point being created in the fake "root.afs" volume. If the cellname begins with a "." the mount point will be a
264 <emphasis>read-write path</emphasis>; otherwise the mount point will be a
265 <emphasis>regular path</emphasis>. These mount points are preserved in the registry at key:
268 <link linkend='Regkey_HKLM_SOFTWARE_OpenAFS_Client_Freelance'>HKLM\SOFTWARE\OpenAFS\Client\Freelance</link>
270 <para>Additional mount points may be manually created using the "fs mkmount" command. Mount points may be removed using the "fs rmmount" command.</para>
271 <para>>fs mkmount \\AFS\athena.mit.edu root.cell athena.mit.edu</para>
272 <para>>fs mkmount \\AFS\.athena.mit.edu root.cell athena.mit.edu -rw</para>
273 <para>>fs rmmount \\AFS\athena.mit.edu</para>
274 <para>>fs rmmount \\AFS\.athena.mit.edu</para>
275 <para>Symlinks may also be created within the Freelance "root.afs" volume.</para>
276 <para>>symlink make \\afs\link \\afs\athena.mit.edu\user\j\a\jaltman</para>
277 <para> >symlink list \\afs\link</para>
278 <para> '\\afs\link' is a symlink to 'athena.mit.edu\user\j\a\jaltman'</para>
279 <para>>symlink rm \\afs\link</para>
280 <para>The symlinks are stored in the registry at:</para>
282 <link linkend='Regkey_HKLM_SOFTWARE_OpenAFS_Client_Freelance_Symlinks'>HKLM\SOFTWARE\OpenAFS\Client\Freelance\Symlinks</link>
286 <indexterm><primary>dns, vldb lookups</primary></indexterm>
287 <indexterm><primary>afsdb dns records</primary></indexterm>
288 <title id='Locating_VLDB_via_DNS'>3.5. Locating AFS Volume Database Servers via DNS </title>
289 <para>The OpenAFS for Windows client will use DNS SRV records and AFSDB records to discover the location of AFS Volume Database servers when entries for the cell are not present in the client's CellServDB file (\%PROGRAMFILES%\OpenAFS\Client\CellServDB).
290 Also see <link linkend="Registry_VLDB_Configuration">Registry Configuration for AFS Volume Database Servers</link>.</para>
293 <indexterm><primary>integrated logon</primary></indexterm>
294 <indexterm><primary>single sign-on</primary></indexterm>
295 <indexterm><primary>kerberos for windows</primary></indexterm>
296 <indexterm><primary>afslogon.dll</primary></indexterm>
297 <indexterm><primary>EnableKFW</primary></indexterm>
298 <indexterm><primary>Use524</primary></indexterm>
299 <indexterm><primary>tokens</primary></indexterm>
300 <title id='Integrated_Logon'>3.6. Obtaining AFS Tokens as a Integrated Part of Windows Logon</title>
301 <para>OpenAFS for Windows installs a WinLogon Network Provider to provide Single Sign-On functionality (aka Integrated Logon.) Integrated Logon can be used when the Windows username and password match the username and password associated with the default cell's Kerberos realm. For example, if the Windows username is "jaltman" and the default cell is "athena.mit.edu", then Integrated Logon can be successfully used if the windows password matches the password assigned to the Kerberos principal "jaltman@ATHENA.MIT.EDU". The realm "ATHENA.MIT.EDU" is obtained by performing a domain name to realm mapping on the hostname of one of the cell's Volume Database servers.</para>
302 <para>Integrated Logon is required if you desire the ability to store roaming user profiles within the AFS file system. OpenAFS does not provide tools for synchronizing the Windows and Kerberos user accounts and passwords.</para>
303 <para>When KFW is configured, Integrated Logon will use it to obtain tokens. Use of KFW for Integrated Logon can be disabled via the
304 <link linkend='Value_EnableKFW'>EnableKFW</link> registry value. Use of the krb524 service can be configured via the
305 <link linkend='Value_Use524'>Use524</link> registry value.
307 <para>Integrated Logon will not transfer Kerberos v5 tickets into the user’s logon session credential cache. KFW 3.1 and above provides that functionality on its own.</para>
308 <para>Integrated Logon does not have the ability to cache the user's username and password for the purpose of obtaining tokens if the Kerberos KDC is inaccessible at logon time.</para>
309 <para>Integrated Logon supports the ability to obtain tokens for multiple cells. For further information on how to configure this feature read about the
310 <link linkend='Value_TheseCells'>TheseCells</link> value.
314 <indexterm><primary>afscreds.exe</primary></indexterm>
315 <indexterm><primary>system tray tool</primary></indexterm>
316 <indexterm><primary>network identity manager</primary></indexterm>
317 <title id='AFS_System_Tray'>3.7. AFS Authentication Tool Command Line Options</title>
318 <para>The AFS Authentication Tool (afscreds.exe) has been deprecated in favor of Network Identity Manager. afscreds.exe will be removed from the OpenAFS in a future release.</para>
319 <para>The AFS Authentication Tool (afscreds.exe) supports several command line options: </para>
322 <para>-A = autoinit </para>
325 <para>-E = force existing afscreds to exit</para>
328 <para>-I = install startup shortcut</para>
331 <para>-M = renew drive maps (deprecated)</para>
334 <para>-N = IP address change detection </para>
337 <para>-Q = quiet mode. do not display start service dialog if afsd_service is not already running</para>
340 <para>-S = show tokens dialog on startup</para>
343 <para>-U = uninstall startup shortcut</para>
346 <para>-X = test and do map share (deprecated)</para>
349 <para> -Z = unmap drives (deprecated)</para>
352 <para>autoinit will result in automated attempts to acquire AFS tokens when afscreds.exe is started. afscreds.exe will attempt to utilize tickets stored in the MSLSA credentials cache; any existing CCAPI credentials cache; and finally display an Obtain Tokens dialog to the user. When used in combination with IP address change detection, afscreds.exe will attempt to acquire AFS tokens whenever the IP address list changes and the Kerberos KDC is accessible.</para>
353 <para>The renew drive maps option is used to ensure that the user drive maps constructed via the OpenAFS tools (not NET USE) are re-constructed each time afscreds.exe is started.</para>
354 <para>By default afscreds.exe is configured by the OpenAFS.org installers to use "-A -N -M -Q" as startup options. Currently, there is no user interface to change this selection after install time although these options may be altered via the registry on either per machine or per user basis. See
355 <link linkend='Value_AfscredsShortcutParams'>AfscredsShortcutParams</link> in
356 <link linkend='appendix_a'>Appendix A</link>.
359 Due to conflicts with Vista and Windows 7 User Account Control, the Drive Letter Mount and Advanced tabs of the AFS Authentication Tool were disabled beginning with the 1.5.66 release.
363 <indexterm><primary>AFS client administrator authorization group</primary></indexterm>
364 <indexterm><primary>AFS Client Admins</primary></indexterm>
365 <indexterm><primary>fs checkservers</primary></indexterm>
366 <indexterm><primary>fs setcachesize</primary></indexterm>
367 <indexterm><primary>fs newcell</primary></indexterm>
368 <indexterm><primary>fs sysname</primary></indexterm>
369 <indexterm><primary>fs exportafs</primary></indexterm>
370 <indexterm><primary>fs setcell</primary></indexterm>
371 <indexterm><primary>fs setserverprefs</primary></indexterm>
372 <indexterm><primary>fs storebehind</primary></indexterm>
373 <indexterm><primary>fs setcrypt</primary></indexterm>
374 <indexterm><primary>fs cscpolicy</primary></indexterm>
375 <indexterm><primary>fs trace</primary></indexterm>
376 <indexterm><primary>fs minidump</primary></indexterm>
377 <indexterm><primary>symlink make</primary></indexterm>
378 <indexterm><primary>fs makemount</primary></indexterm>
379 <indexterm><primary>Freelance root.afs volume</primary></indexterm>
380 <title id='AFS_Client_Admin_Group'>3.8. The "AFS Client Admins" Authorization Group</title>
381 <para>The OpenAFS for Windows client supports a local Windows authorization group named "AFS Client Admins". This group is used in place of the "Administrators" group to determine which users are allowed to modify the AFS Client Service configuration via the AFS Control Panel (afs_config.exe) or fs.exe command line tool. The following fs.exe commands are now restricted to members of the "AFS Client Admins" group:</para>
384 <para>checkservers with a non-zero timer value</para>
387 <para>setcachesize</para>
393 <para>sysname with a new sysname list</para>
396 <para>exportafs</para>
402 <para>setserverprefs</para>
405 <para>storebehind</para>
408 <para>setcrypt</para>
411 <para>cscpolicy</para>
417 <para>minidump</para>
420 <para>The creation or removal of mount points and symlinks in the Freelance "root.afs" volume are also restricted to members of the "AFS Client Admins" group.</para>
421 <para>The initial membership of the "AFS Client Admins" group when created by the installer is equivalent to the local "Administrators" group. If a user is added to the "Administrators" group after the creation of the "AFS Client Admin" group, that user will not be an AFS Client Administrator. Only users that are members of the "AFS Client Admins" group are AFS Client Administrators. The local "SYSTEM" account is an implicit member of the "AFS Client Admins" group.</para>
422 <para>Setting the default sysname for a machine should be done via the
423 <link linkend='Value_SysName'>SysName registry value</link> and not via "fs sysname".
427 <indexterm><primary>UNC paths</primary></indexterm>
428 <indexterm><primary>JP Software</primary><secondary>4NT</secondary></indexterm>
429 <indexterm><primary>JP Software</primary><secondary>Take Commands</secondary></indexterm>
430 <indexterm><primary>PowerShell</primary></indexterm>
431 <title id='Support_for_UNC_Paths'>3.9. OpenAFS Support for UNC Paths </title>
432 <para>The OpenAFS client supports UNC paths everywhere. UNC paths provide a canonical name for resources stored within AFS. UNC paths should be used instead of drive letter mappings whenever possible. This is especially true when specifying the location of roaming profiles and redirected folders. </para>
433 <para>Power users that make extensive use of the command line shell, cmd.exe, should consider using JP Software's 4NT or Take Command command processors. Unlike cmd.exe, the JPSoftware shells fully support UNC paths as the current directory. JPSoftware added special recognition for OpenAFS to its command shells, 4NT 7.0 and Take Command 7.0. AFS paths can be entered in UNIX notation (e.g., /afs/openafs.org/software), space utilization reports the output of the volume status for the specified path, and many AFS specific functions and variables have been added to the command language.</para>
434 <para>JPSoftware's web site is
435 <ulink url='http://www.jpsoft.com/'>http://www.jpsoft.com</ulink>.
437 <para>Microsoft PowerShell 1.0 and 2.0 will also support UNC paths as the current directory. </para>
440 <indexterm><primary>aklog.exe</primary></indexterm>
441 <title id='aklog.exe'>3.10. aklog.exe</title>
442 <para>The OpenAFS Client ships with its own version of aklog.exe which should be used in preference to those obtained by other sources. The OpenAFS aklog.exe supports Kerberos v5 as well as the ability to auto-generate AFS IDs within foreign PTS databases.</para>
445 Usage: aklog [-d] [[-cell | -c] cell [-k krb_realm]]
446 [[-p | -path] pathname]
450 -d = output debugging information.
451 cell = zero or more cells for which tokens will be obtained
452 krb_realm = the kerberos realm of the cell.
453 pathname = the directory for which authentication is required
454 -noprdb = don't try to determine AFS ID.
455 -5 or -4 = use Kerberos V (default) or Kerberos IV tickets
456 -m = use krb524d to convert Kerberos V tickets to Kerberos IV
461 <indexterm><primary>OpenAFS Servers on Windows</primary></indexterm>
462 <indexterm><primary>Freelance mode</primary></indexterm>
463 <indexterm><primary>EnableKFW</primary></indexterm>
464 <indexterm><primary>power management</primary></indexterm>
465 <indexterm><primary>kaserver</primary></indexterm>
466 <title id='OpenAFS_Servers_on_Windows'>3.11. OpenAFS Servers on Windows are Unsupported</title>
467 <para>The AFS Server functionality provided as part of the OpenAFS install package might work but should be considered highly experimental. It has not been thoroughly tested. Any data which would cause pain if lost should not be stored in an OpenAFS Server on Windows.</para>
468 <para>Known issues include lack of support for power management and dynamic network configuration. Salvager is also known to crash.</para>
470 <title id='OpenAFS_Server_Installation'>3.11.1. OpenAFS Server Installation</title>
471 <para>When the OpenAFS Server is installed, the TransarcAFSServer service (bosctlsvc.exe) will be installed and configured. The TransarcAFSServer service will auto-start the traditional AFS bos server. The former AFS Server Configuration wizard makes assumptions that no longer hold true and it has therefore been disabled. However, following the instructions for installing the AFS Servers on UNIX it is possible to properly configure the AFS Servers on Microsoft Windows. The AFS Server binaries, configuration files, and log files are installed under %Program Files%\OpenAFS\Server.
472 <ulink url='http://www.openafs.org/no-more-des.html'>kaserver has been deprecated and its use is strongly discouraged.</ulink> Instead, Active Directory or some other Kerberos v5 KDC should be used in its place.
476 <title id='Using_the_AFS_Client_Service_with_OpenAFS_Server'>3.11.2. Using the AFS Client Service when the Server is installed</title>
477 <para>A few notes on the usage of the AFS Client Service if it is going to be used with the OpenAFS AFS Server:</para>
480 <para>Freelance mode should be disabled when the AFS Client Service is installed on the same machine as the AFS Server,. Otherwise, you will be unable to manipulate the contents of the root.afs volume for the hosted cell without constructing an explicit mountpoint to the root.afs volume from another volume.</para>
483 <para>The AFS Server and related tools only support the built in kaserver (Kerberos IV). If kaserver is being used,
484 <ulink url='http://web.mit.edu/kerberos/'>MIT Kerberos for Windows</ulink> should not be installed or must be disabled via the
485 <link linkend='Value_EnableKFW'>EnableKFW</link> registry value.
489 <para>The AFS Servers are not aware of power management events nor are they aware of network configuration changes. It is strongly advised that the AFS servers be installed only on systems that will not be shutdown or suspended unexpectedly. An inadvertent shutdown will corrupt volume data.</para>
495 <indexterm><primary>debug symbols</primary></indexterm>
496 <title id='OpenAFS_Debug_Symbols'>3.12. OpenAFS Debugging Symbol files</title>
497 <para>The OpenAFS for Windows installers include Debugging Symbol files which should be installed if you are experiencing problems and need to send crash reports. This is true for both the release and the debug versions of the installers. The difference between the release and debug versions are:</para>
500 <para>whether or not the binaries were compiled with optimization (release: yes, debug: no)</para>
503 <para>whether or not the debug symbols are installed by default (release: no, debug: yes)</para>
507 <emphasis>fs trace</emphasis> logging is turned on by default (release: no, debug: yes)
511 <para>whether or not additional debug statements were compiled into the binaries (release: no, debug: yes)</para>
516 <indexterm><primary>large file support</primary></indexterm>
517 <indexterm><primary>64-bit file sizes</primary></indexterm>
518 <title id='Large_File_Support'>3.13. Large File (64-bit) Support</title>
519 <para>As of release 1.5.3, OpenAFS for Windows supports files larger than 2GB. The maximum file size is now 16777216 terabytes when the AFS File Server supports large files. If the AFS File Server does not support 64-bit file sizes, then the maximum file size remains 2GB.</para>
522 <indexterm><primary>encryption</primary></indexterm>
523 <indexterm><primary>fs setcrypt</primary></indexterm>
524 <title id='Encrypted_AFS_Network_Communication'>3.14. Encrypted AFS Network Communication</title>
525 <para>The OpenAFS for Windows installer by default activates a weak form of encrypted data transfer between the AFS client and the AFS servers. This is often referred to as "fcrypt" mode. Encrypted data transfer can be turned on or off with the "fs crypt" command. Transitions between "crypt" and "non-crypt" modes are logged to the Windows Application Event Log. </para>
528 <indexterm><primary>SMB authentication</primary></indexterm>
529 <indexterm><primary>NTLM</primary></indexterm>
530 <indexterm><primary>GSS SPNEGO</primary></indexterm>
531 <title id='Authenticated_SMB_Access_to_Client_Service'>3.15. Authenticated SMB Access to the OpenAFS Client Service</title>
532 <para>OpenAFS authenticates SMB connections using either NTLM or GSS SPNEGO (NTLM). In previous versions of OpenAFS, the SMB connections were unauthenticated which opened the door for several attacks which could be used to obtain access to another user's tokens on shared machines. </para>
533 <para>When GSS SPNEGO attempts a Kerberos v5 authentication, the Windows SMB client will attempt to retrieve service tickets for "cifs/afs@REALM" (if the loopback adapter is in use) or "cifs/machine-afs@REALM" (if the loopback adapter is not being used). It is extremely important that this service principal not exist in the KDC database as the Kerberos authentication must fail allowing automatic fallback to NTLM. When NTLM is used a special local authentication mode will be used that does not require access to the user's password. Instead, Windows will internally recognize the request as coming from a local logon session.</para>
536 <indexterm><primary>INI files</primary></indexterm>
537 <indexterm><primary>CellServDB</primary></indexterm>
538 <indexterm><primary>AFSCONF</primary></indexterm>
539 <title id='No_More_INI_Files'>3.16. INI Files Replaced By Windows Registry</title>
540 <para>IBM AFS and OpenAFS 1.2 Windows clients stored configuration data in Windows .INI files. This OpenAFS client does not use Windows .INI files for the storage of configuration data. All settings are stored in the registry (see
541 <link linkend='appendix_a'>Appendix A</link>). The CellServDB file is now stored in either the %ALLUSERSPROFILE%\Application Data\OpenAFS\Client directory (aka \ProgramData\OpenAFS\Client on Vista\Win7\2008) or the %PROGRAMFILES%\OpenAFS\Client directory. The
542 <link linkend='Value_CellServDBDir'>CellServDBDir</link> registry value or the AFSCONF environment variable can be used to specify an alternative location.
544 <para>For users converting from IBM AFS clients, during installation OpenAFS will relocate the contents of the "afsdcell.ini" file to the new CellServDB file. OpenAFS will also import the contents of the "afs_freelance.ini" file to the Windows registry. OpenAFS will not process the contents of the "afsddbmt.ini".</para>
547 <indexterm><primary>Windows Internet Connection Firewall</primary></indexterm>
548 <indexterm><primary>firewall</primary></indexterm>
549 <indexterm><primary>Back Connection</primary></indexterm>
550 <title id='Windows_Internet_Connection_Firewall'>3.17. Microsoft Windows Internet Connection Firewall</title>
551 <para>The OpenAFS Client is compatible with the Internet Connection Firewall that debuted with Windows XP SP2 and Windows 2003 SP1. The Internet Connection Firewall will be automatically adjusted to allow the receipt of incoming callback messages from the AFS file server. In addition, the appropriate
552 <emphasis>Back Connection</emphasis> registry entries are added to allow SMB authentication to be performed across the Microsoft Loopback Adapter.
556 <indexterm><primary>Explorer Shell</primary></indexterm>
557 <indexterm><primary>Microsoft Office</primary></indexterm>
558 <title id='Browsing_AFS_from_Explorer_Shell'>3.18. Browsing AFS from the Explorer Shell and Office</title>
559 <para>The OpenAFS Client Service implements the CIFS Remote Admin Protocol and the Microsoft RPC SVRSVC and WKSSVC services which allows Explorer to browse server and share information. This significantly enhances the interoperability of AFS volumes within the Explorer Shell and Microsoft Office applications.</para>
562 <indexterm><primary>byte range locking</primary></indexterm>
563 <indexterm><primary>Microsoft Office</primary></indexterm>
564 <indexterm><primary>EnableServerLocks</primary></indexterm>
565 <title id='Byte_Range_Locking'>3.19. Byte Range Locking</title>
566 <para>Many applications on Windows (e.g. Microsoft Office) require the use of byte range locks applied to a file either to protect against simultaneous file access or as a signaling mechanism. OpenAFS for Windows release 1.5 (or greater) implements byte range locking within the CIFS-AFS gateway server. This support for byte range locking obtains AFS’ advisory file server locks to simulate Microsoft Windows mandatory locks. When an application opens a file, a lock will be obtained from AFS indicating that the file is in use. If the lock is a write lock, access to the file will be restricted to other applications running on the same machine as the first application to request the lock. Applications running on other machines will see the AFS full file lock and will be unable to access the file.</para>
567 <para>Most Windows applications and Windows itself opens files in shared read mode. When this is done, a read lock is applied to the file. This does not prevent shared read access across multiple machines but is used to ensure that no one writes to the file while it is in use.</para>
568 <para>As the CIFS-AFS gateway server attempts to implement Windows lock semantics on top of AFS lock semantics it is important to understand how AFS file locks work. In Windows there are no special privileges associated with obtaining file locks. If you can read or execute a file, then you can obtain shared and exclusive locks. In general, a Windows shared lock equates to an AFS read lock and a Windows exclusive lock equates to an AFS write lock. In AFS if you can write to a file, then you can obtain a write lock. However, in AFS if you can read a file it does not mean that you can obtain a read lock on it. The ability to obtain read locks is granted only if you have the lock (or ‘k’) privilege. This behavior is required in order to allow anonymous users to read files while preventing them from being able to deny access to the files to other users.
569 <emphasis>OpenAFS 1.4.0 and earlier as well as all IBM AFS file servers have an implementation bug that prevents users with write privileges from being able to obtain locks without the lock privilege.</emphasis> When AFS serves data out of read-only volumes the file server will deny all requests for read and write locks because the contents of the volume cannot be changed by the client.
571 <para>Since Microsoft Windows applications almost always attempt to obtain a temporary exclusive lock when accessing files the OpenAFS Client’s CIFS-AFS gateway implements the following semantics in order to reduce the inconvenience on end users. </para>
572 <itemizedlist mark='bullet'>
574 <para>If the file is located on a read-only volume and the application requests a shared lock, the CIFS-AFS server will grant the lock request without asking the AFS file server.</para>
577 <para>If the file is located on a read-only volume and the application opens the file with write access and requests an exclusive lock, the CIFS-AFS server will refuse the lock request and return a read only error.</para>
580 <para>If the file is located on a read-only volume and the application opens the file with only read access and requests an exclusive lock, the CIFS-AFS server will fulfill the lock request with a read lock.</para>
583 <para>If the file is located on a read-write volume and the application requests an exclusive lock, the CIFS-AFS server will request a write lock from the AFS file server. If granted by the file server, then the CIFS-AFS server will grant the lock request. If the request is denied due to an access denied error and the user has the lookup, read and lock privileges and the file was opened for read only access, then the CIFS-AFS server will request a read lock from the file server. If the request is denied due to an access denied error and the user has the lookup and read privileges but not the lock privilege, then the CIFS-AFS server will grant the request even though the AFS file server said ‘no’. If the user does not have at least those permissions, the CIFS-AFS server will deny the request.</para>
586 <para>If the file is located on a read-write volume and the application requests a shared lock, the CIFS-AFS server will request a read lock from the AFS file server. If granted by the file server, then the CIFS-AFS server grants the lock request. If the request is denied due to an access denied error and the user has the lookup and read privileges but not the lock privilege, then the CIFS-AFS server will grant the request even though the AFS file server said ‘no’. If the user does not have at least those permissions, the CIFS-AFS server will deny the request.</para>
589 <para>If multiple processes on the same machine attempt to access the same file simultaneously, the CIFS-AFS server will locally manage the granted locks and all processes will share a single lock on the AFS file server.</para>
592 <para>If the CIFS-AFS server is unable to renew the AFS file server locks, then it will invalidate the associated file handles. This is the same behavior that an application will experience if it was using a Windows File Share and the connection was broken. Invalidating the file handles prevents subsequent data corruption from taking place.</para>
595 <para>If you wish to disable the acquisition of locks from the file server, this can be performed using the
596 <link linkend='Value_EnableServerLocks'>EnableServerLocks</link> registry value.
600 <indexterm><primary>tokens</primary></indexterm>
601 <indexterm><primary>LogoffPreserveTokens</primary></indexterm>
602 <title id='Automatic_Discarding_of_Tokens_at_Logoff'>3.20. Automatic Discarding of AFS Tokens at Logoff</title>
603 <para>The OpenAFS Client will automatically forget a user's tokens upon Logoff unless the user's profile was loaded from an AFS volume. In this situation there is no mechanism to determine when the profile has been successfully written back to the network. It is therefore unsafe to release the user's tokens. Whether or not the profile has been loaded from the registry can be determined for Local Accounts, Active Directory accounts and NT4 accounts.</para>
604 <para>If there is a need to disable this functionality, the
605 <link linkend='Value_LogoffPreserveTokens'>LogoffPreserveTokens</link> registry value can be used. (see
606 <link linkend='appendix_a'>Appendix A</link>.)
610 <indexterm><primary>Terminal Server</primary></indexterm>
611 <indexterm><primary></primary></indexterm>
612 <title id='Windows_Terminal_Server_Installs'>3.21. Windows Terminal Server installations</title>
613 <para>When installing the NSIS (.exe) installer under Terminal Server, you must execute it from within the Add/Remove Programs Control Panel. Failure to do so will result in AFS not running properly. The AFS Server should not be installed on a machine with Terminal Server installed.</para>
616 <indexterm><primary>HideDotFiles</primary></indexterm>
617 <title id='Hidden_Dot_Files'>3.22. Hidden Dot Files</title>
618 <para>AFS is a UNIX native file system. The OpenAFS client attempts to treat the files stored in AFS as they would be on UNIX. File and directory names beginning with a "." are automatically given the Hidden attribute so they will not normally be displayed. This behavior can be altered via the
619 <link linkend='Value_HideDotFiles'>HideDotFiles</link> registry value.
623 <indexterm><primary>afs_confige.exe</primary></indexterm>
624 <indexterm><primary>AFS Configuration Control Panel</primary></indexterm>
625 <indexterm><primary>cache limits</primary></indexterm>
626 <indexterm><primary>Stats</primary></indexterm>
627 <title id='Status_Cache_Limits'>3.23. Status Cache Limits</title>
628 <para>The Status Cache (AFS Configuration Control Panel: Advanced Page) is defined to have a maximum number of entries. Each entry represents a single file or directory entry accessed within the AFS file system. When the maximum number of entries are allocated, entries will begin to be reused according to a least recently used (LRU) algorithm. If the number of files or directories being accessed repeatedly by your applications is greater then the maximum number of entries, your host will begin to experience thrashing of the Status Cache and all requests will result in network operations.</para>
629 <para>If you are experiencing poor performance try increasing the maximum number of Status Cache entries. Each entry requires approximately 1.2K. The default number of Status Cache entries is 10,000. This can be adjusted using the
630 <link linkend='Value_Stats'>Stats</link> registry value.
634 <indexterm><primary>NETBIOS over TCP</primary></indexterm>
635 <title id='NETBIOS_over_TCP'>3.24. NETBIOS over TCP/IP must be enabled</title>
636 <para>"Netbios over TCP/IP" must be active on the machine in order for communication with the AFS Client Service to succeed. If "Netbios over TCP/IP" is disabled on the machine, then communication with the AFS Client Service will be impossible. If you are using the Microsoft Loopback Adapter, configure the "Netbios over TCP/IP" setting for the adapter.</para>
639 <indexterm><primary>digital signatures</primary></indexterm>
640 <indexterm><primary>Secure Endpoints Inc.</primary></indexterm>
641 <indexterm><primary>VerifyServiceSignature</primary></indexterm>
642 <title id='OpenAFS_binaries_digital_signatures'>3.25. OpenAFS binaries are digitally signed</title>
643 <para>The OpenAFS Client Service and related binaries distributed by OpenAFS.org are digitally signed by "Secure Endpoints Inc.". The OpenAFS Client Service will perform a run-time verification check to ensure that all OpenAFS related DLLs loaded by the service match the same file version number and were signed by the same entity. This check has been added to prevent the stability problems caused by more than one AFS installation present on a machine at the same time. Many hours of support time have been wasted tracking down problems caused by the mixture of files from different releases. </para>
645 <link linkend='appendix_a'>Appendix A</link> documents the "
646 <link linkend='Value_VerifyServiceSignature'>VerifyServiceSignature</link>" registry value which can be used to disable the signature check. The file version check cannot be disabled.
650 <indexterm><primary>cache size</primary></indexterm>
651 <title id='Maximum_Cache_Size'>3.26. Maximum Size of the AFSCache File</title>
652 <para>The maximum cache size on 32-bit Windows is approximately 1.3GB. This is the largest contiguous block of memory in the 2GB process address space which can be used for constructing a memory mapped file. Due to fragmentation of the process space caused by the loading of libraries required by the digital signature verification code, any attempt to specify a cache size greater then 700MB will result in the automatic disabling of the signature check. Significantly larger cache sizes can be used on 64-bit Windows.</para>
653 <para>On 32-bit systems that have Apple Bonjour 1.0.6 installed, the maximum cache size is further constrained due design flaw in the Apple mdnsNSP.dll which is injected into all processes that use network services. On these systems the maximum is approximately 512MB.</para>
656 <indexterm><primary>character sets</primary></indexterm>
657 <indexterm><primary>StoreAnsiFilenames</primary></indexterm>
658 <title id='Filename_Character_Sets'>3.27. Filename Character Sets</title>
659 <para>This section describes functionality and concerns related to pre-1.5.50 releases of OpenAFS for Windows. This release stores all file names on the file servers as Unicode encoded using UTF-8.</para>
660 <para>OpenAFS for Windows implements an SMB server which is used as a gateway to the AFS filesystem. Because of limitations of the SMB implementation in pre-1.5.50 releases, Windows stored all files into AFS using OEM code pages such as CP437 (United States) or CP850 (Western Europe). These code pages are incompatible with the ISO Latin-1 or Unicode (UTF-8) character sets typically used as the default on UNIX systems in both the United States and Western Europe. Filenames stored by OpenAFS for Windows were therefore unreadable on UNIX systems if they include any of the following characters:</para>
661 <informaltable frame='all'>
662 <tgroup rowsep='1' align='left' colsep='1' cols='1'>
663 <colspec colwidth='442pt' colname='c1' />
667 <para> [Ç] 128 08/00 200 80 C cedilla</para>
668 <para> [ü] 129 08/01 201 81 u diaeresis</para>
669 <para> [é] 130 08/02 202 82 e acute</para>
670 <para> [â] 131 08/03 203 83 a circumflex</para>
671 <para> [ä] 132 08/04 204 84 a diaeresis</para>
672 <para> [à] 133 08/05 205 85 a grave</para>
673 <para> [å] 134 08/06 206 86 a ring</para>
674 <para> [ç] 135 08/07 207 87 c cedilla</para>
675 <para> [ê] 136 08/08 210 88 e circumflex</para>
676 <para> [ë] 137 08/09 211 89 e diaeresis</para>
677 <para> [è] 138 08/10 212 8A e grave</para>
678 <para> [ï] 139 08/11 213 8B i diaeresis</para>
679 <para> [î] 140 08/12 214 8C i circumflex</para>
680 <para> [ì] 141 08/13 215 8D i grave</para>
681 <para> [Ä] 142 08/14 216 8E A diaeresis</para>
682 <para> [Å] 143 08/15 217 8F A ring</para>
683 <para> [É] 144 09/00 220 90 E acute</para>
684 <para> [æ] 145 09/01 221 91 ae diphthong</para>
685 <para> [Æ] 146 09/02 222 92 AE diphthong</para>
686 <para> [ô] 147 09/03 223 93 o circumflex</para>
687 <para> [ö] 148 09/04 224 94 o diaeresis</para>
688 <para> [ò] 149 09/05 225 95 o grave</para>
689 <para> [û] 150 09/06 226 96 u circumflex</para>
690 <para> [ù] 151 09/07 227 97 u grave</para>
691 <para> [ÿ] 152 09/08 230 98 y diaeresis</para>
692 <para> [Ö] 153 09/09 231 99 O diaeresis</para>
693 <para> [Ü] 154 09/10 232 9A U diaeresis</para>
694 <para> [ø] 155 09/11 233 9B o slash</para>
695 <para> [£] 156 09/12 234 9C Pound sterling sign</para>
696 <para> [Ø] 157 09/13 235 9D O slash</para>
697 <para> [×] 158 09/14 236 9E Multiplication sign</para>
698 <para> [ƒ] 159 09/15 237 9F Florin sign</para>
705 <para>The pre-1.5.50 OpenAFS Client provided an optional registry value,
706 <link linkend='Value_StoreAnsiFilenames'>StoreAnsiFilenames</link>, that could be set to instruct OpenAFS to store filenames using the ANSI Code Page instead of the OEM Code Page. The ANSI Code Page is a compatible superset of Latin-1. This setting is not the default setting because making this change would prevent OpenAFS for Windows from being able to access filenames containing the above characters which were created without this setting.
708 <para>All versions of OpenAFS for Windows 1.5.50 and above exchange file names with Microsoft Windows using the Unicode character set. All file names are read from and stored to AFS file servers using the UTF-8 encoding of Unicode. As a result the
709 <link linkend='Value_StoreAnsiFilenames'>StoreAnsiFilenames</link> option is no longer supported.
713 <indexterm><primary>character sets</primary></indexterm>
714 <indexterm><primary>roaming profiles</primary></indexterm>
715 <title id='Character_Set_Issues_Roaming_Profiles'>3.28. Character Set Issues with Roaming Profiles</title>
716 <para>This section describes functionality and concerns related to pre-1.5.50 releases of OpenAFS for Windows. This release stores all file names on the file servers as Unicode encoded using UTF-8.</para>
717 <para>There is a known issue with storing Windows Roaming Profiles when the profile contains either directories or files with names which cannot be represented in the local OEM character set. In this case, attempts to write the profile back to AFS will fail during the character set conversion. The pre-1.5.50 OpenAFS Client’s CIFS gateway did not support UNICODE. To avoid this problem some sites run custom logoff scripts (assigned by group policy) which rename all files to use only the supported characters for the locale.</para>
718 <para>Versions of OpenAFS for Windows 1.5.50 and above do not suffer from these issues.</para>
721 <indexterm><primary>AFSCache</primary></indexterm>
722 <indexterm><primary>cache file</primary></indexterm>
723 <indexterm><primary>SysInternals</primary></indexterm>
724 <title id='AFSCache_File'>3.29. The AFSCache File</title>
725 <para>The AFS Cache file is stored by default at %TEMP%\AFSCache in a persistent file marked with the Hidden and System attributes. The persistent nature of the data stored in the cache file improves the performance of OpenAFS by reducing the number of times data must be read from the AFS file servers. </para>
726 <para>The performance of the AFS Client Service is significantly affected by the access times associated with the AFSCache paging file. When given the choice, the AFSCache file should be placed on a fast disk, preferably NTFS, the file should not be compressed and should consist of as few fragments as possible. Significant performance gains can be achieved by defragmenting the AFSCache file with SysInternal's Contig utility while the AFS Client Service is stopped.</para>
729 <indexterm><primary>service start restrictions</primary></indexterm>
730 <indexterm><primary>TransarcAFSDaemon</primary></indexterm>
731 <indexterm><primary>afsdacl.exe</primary></indexterm>
732 <title id='Restricting_OpenAFS_Service_Start_and_Stop'>3.30. Restricting OpenAFS Client Service Start and Stop</title>
733 <para>A new command line tool, afsdacl.exe, can be used to restrict the ability to start and stop the OpenAFS Client Service.</para>
736 afsdacl : Set or reset the DACL to allow starting or stopping
737 the afsd service by any ordinary user.
739 Usage: afsdacl [-set | -reset] [-show]
741 -reset : Reset the DACL
742 -show : Show current DACL (SDSF)
747 <indexterm><primary>@sys</primary></indexterm>
748 <indexterm><primary>fs sysname</primary></indexterm>
749 <indexterm><primary>SysName</primary></indexterm>
750 <title id='SysName_List'>3.31. The @sys Name List</title>
751 <para>The default @sys name list in the OpenAFS Client is set to "x86_win32 i386_w2k i386_nt40" for 32-bit x86 systems. The default is "amd64_win64" for amd 64-bit versions of Windows.</para>
754 <indexterm><primary>UNC paths</primary></indexterm>
755 <indexterm><primary>symlinks</primary></indexterm>
756 <indexterm><primary>path separators</primary></indexterm>
757 <indexterm><primary>symlink.exe</primary></indexterm>
758 <indexterm><primary>symlink make</primary></indexterm>
759 <title id='Symlinks_to_AFS_UNC_Paths'>3.32. Symlinks to AFS UNC Paths</title>
760 <para>In OpenAFS, symlinks to AFS UNC paths, \\AFS[\all]\..., are treated the same as symlinks to /afs/... However, please use /afs/... as the Windows UNC form will not work on UNIX client.</para>
761 <para>The <emphasis>symlink make</emphasis> command will automatically translate \\AFS\... to /afs/... for you.</para>
764 <indexterm><primary>debugging the cache manager</primary></indexterm>
765 <indexterm><primary>cmdebug.exe</primary></indexterm>
766 <title id='Cache_Manager_Debugging'>3.33. Cache Manager Debugging</title>
767 <para>The OpenAFS Client implements the Cache Manager Debugging RPC Interface. The CM debugger can be queried with cmdebug.exe. </para>
770 Usage: cmdebug -servers <server machine> [-port <IP port>] [-long] [-refcounts]
771 [-callbacks] [-ctime] [-addrs] [-cache] [-cellservdb] [-help]
772 Where: -long print all info
773 -refcounts print only cache entries with positive reference counts
774 -callbacks print only cache entries with callbacks
775 -ctime print human readable expiration time
776 -addrs print only host interfaces
777 -cache print only cache configuration
778 -cellservdb print only cellservdb info
783 <indexterm><primary>windows logon caching</primary></indexterm>
784 <indexterm><primary>kerberos</primary></indexterm>
785 <title id='Windows_Logon_Caching_vs_Kerberos_Logons'>3.34. Windows Logon Caching vs. Kerberos Logons</title>
786 <para>If you are a site which utilizes MIT/Heimdal Kerberos principals to logon to Windows via a cross-realm relationship with a multi-domain Windows forest, you must enable Windows logon caching unless the workstation is Windows Vista.</para>
789 <indexterm><primary>server preferences</primary></indexterm>
790 <indexterm><primary>fs setserverprefs</primary></indexterm>
791 <indexterm><primary>setting server preferences</primary></indexterm>
792 <title id='Initial_Server_Preferences'>3.35. Initial Server Preferences</title>
793 <para>VLDB and File Server Preferences can now be provided initial values using registry keys. This is useful for managed machines in a Windows domain which are centrally located (e.g., in a computing lab.) See
794 <link linkend='appendix_a'>Appendix A</link> for details on the "
795 <link linkend='Regkey_HKLM_SOFTWARE_OpenAFS_Client_ServerPreferences_VLDB'>Server Preferences</link>" keys.
799 <indexterm><primary>timestamps</primary></indexterm>
800 <indexterm><primary>DST</primary></indexterm>
801 <indexterm><primary>UTC</primary></indexterm>
802 <title id='File_Timestamps_and_DST'>3.36. File Timestamps and Daylight Saving Time</title>
803 <para>The OpenAFS Client reports timestamps on files stored in AFS in UTC all year round. In locales with daylight savings time, previous versions of AFS for Windows reported the time when DST is active as UTC+1. This was done to preserve the relative local time for the user. A file stored at 11:00am EST in January would be reported as having been stored at 11:00am EDT in June. Unfortunately, this has the negative side effect of changing the reported timestamp from 16:00UTC to 15:00UTC. Since Windows treats all file times in UTC, data synchronization applications which rely on the timestamp would believe that all files stored in AFS had changed.</para>
804 <para>It should be noted that UNIX based operating systems (such as Solaris) do not appear to report file times to applications in UTC. They do preserve the relative local time. This may confuse some users who are used to being able to compare the timestamp in an UNIX shell with the timestamp from the Windows explorer. During DST, these two times will no longer agree even though they are in fact representing the same moment in time.</para>
807 <indexterm><primary>RPC client support</primary></indexterm>
808 <title id='Windows_RPC_client_support'>3.37. Windows RPC client support must be installed </title>
809 <para>If the installer refuses to install and complains about an RPC configuration error, check to ensure that the following registry entries are present and that they refer to the dll "rpcrt4.dll":</para>
810 <para> HKLM "SOFTWARE\Microsoft\RPC\ClientProtocols" "ncacn_np"</para>
811 <para> HKLM "SOFTWARE\Microsoft\RPC\ClientProtocols" "ncacn_ip_tcp"</para>
812 <para> HKLM "SOFTWARE\Microsoft\RPC\ClientProtocols" "ncadg_ip_udp"</para>
813 <para> HKLM "SOFTWARE\Microsoft\RPC\ClientProtocols" "ncacn_http"</para>
816 <indexterm><primary>minidumps</primary></indexterm>
817 <indexterm><primary>fs minidump</primary></indexterm>
818 <title id='Generating_Minidumps'>3.38. Generating Minidumps of the OpenAFS Client Service</title>
819 <para>OpenAFS 1.4 added a new command, "fs minidump". This command can be used at any time to generate a mini dump file containing the current stack of the afsd_service.exe process. This output can be very helpful when debugging the AFS Client Service when it is unresponsive to SMB/CIFS requests.</para>
822 <indexterm><primary>UUIDs</primary></indexterm>
823 <indexterm><primary>system cloning</primary></indexterm>
824 <indexterm><primary>NonPersistentCaching</primary></indexterm>
825 <indexterm><primary>instloop.exe</primary></indexterm>
826 <indexterm><primary>msiexec.exe</primary></indexterm>
827 <title id='AFS_UUIDs_vs_System_Cloning'>3.39. AFS Client Universally Unique Identifiers (UUIDs) vs. System Cloning</title>
828 <para>The OpenAFS Client implements Universally Unique Identifiers (UUIDs). They are used to provide the AFS file server with a method of identifying the client that is independent of IP address. This permits the AFS file server to track mobile clients or those behind Network Address Translators when they move from address to address or port to port. Tracking the client improves client performance by permitting callback state to be maintained across location changes. The UUID is generated when the AFSCache file is created and is maintained as long as the contents of the AFSCache file are valid. The UUID is stored in the AFSCache file. </para>
829 <para>When cloning machines that have Windows AFS client installed it is necessary to generate a new UUID for each client. This will be done automatically if the Windows Machine SID is re-generated using Microsoft SysPrep. If the SID is not being re-generated either the AFSCache file should be deleted or the command
830 <emphasis>fs uuid -generate</emphasis> must be executed after the the clone is created.
831 <emphasis role='bold'>Multiple AFS clients reporting the same UUID will not only result in horrible AFS client performance and cache inconsistencies, but they will also put a tremendous strain on the AFS file servers.</emphasis>
833 <para>For lab environments that wish to erase all cached data on each restart, the
834 <link linkend='Value_NonPersistentCaching'>NonPersistentCaching</link> option will disable the use of the persistent cache file. As a side effect, a new UUID will be generated for the AFS client service on each restart.
836 <para>When a Windows system is cloned, the Microsoft Loopback Adapter will be disabled in the cloned system. Administrators must re-install the Microsoft Loopback Adapter within the cloned environment. This can be automated by using the OpenAFS "
837 <emphasis>instloop.exe</emphasis> –
838 <emphasis>i</emphasis>" command. Instloop.exe can be extracted from the MSI installer by performing an administrative install via
839 <emphasis>msiexec.exe /a</emphasis>.
843 <indexterm><primary>delayed write errors</primary></indexterm>
844 <indexterm><primary>ConnDeadTimeout</primary></indexterm>
845 <indexterm><primary>SMBAsyncStoreSize</primary></indexterm>
846 <indexterm><primary>EnableSMBAsyncStore</primary></indexterm>
847 <indexterm><primary>SMB timeouts</primary></indexterm>
848 <title id='Delayed_Write_Errors'>3.40. Delayed Write Errors with Microsoft Office Applications</title>
849 <para>Microsoft Office makes heavy use of asynchronous input/output methods for reading and writing to file streams. This can result in hundreds of requests being simultaneously queued for service by the CIFS client with a fixed timeout period. As the AFS CIFS server is local to the machine the Windows CIFS client believes that it can respond almost instantaneously to write requests as the actual writing to the AFS file server is performed by a background daemon thread. When the actual network bandwidth to the AFS file server is slow and the file size is large it is possible for the CIFS client to time out the connection. When this happens a "delayed write error" will be reported to the user and the application may crash. The only workaround at the current time is to save first to a local disk and subsequently copy the file to AFS as copying a file with the explorer shell does not use asynchronous i/o. </para>
850 <para>The CIFS session timeout defaults to 45 seconds and can be increased by modifying the
851 <link linkend='Value_ConnDeadTimeout'>ConnDeadTimeout registry value</link>.
853 <para>Beginning with the 1.5.33 release, the performance characteristics of SMB Write Data operations can be adjusted. In prior releases all writes were performed using a restricted asynchronous store model in which only one asynchronous store operation per file can be performed at a time. The reason for this restriction is limit the amount of data the cache manager will accept without it having been written to the file server. If too much unwritten data is accepted, the file close operation will block until all of the unwritten data is output and this could trigger a CIFS client disconnect. </para>
854 <para>Prior to 1.5.33 the size of the asynchronous store was always equal to the chunk size which was often too large for low bandwidth connections. The asynchronous store size now defaults to 32KB and is configurable using the
855 <link linkend='Value_SMBAsyncStoreSize'>SMBAsyncStoreSize</link> registry value. Asynchronous store operations can also be disabled using the
856 <link linkend='Value_EnableSMBAsyncStore'>EnableSMBAsyncStore</link> registry value in which case all writes received by the cache manager block until the Rx StoreData operation completes.
858 <para>During the first quarter of 2009 Microsoft added new functionality to the SMB Redirector which permits an extended timeout period to be used
859 for an enumerated list of Netbios server names. This functionality was distributed in Service Pack 2 for Vista and 2008 and is incorporated
860 into the RTM releases of Windows 7 and Server 2008 R2. Updates to Windows XP (KB916204), XP64 (KB969289), and Server 2003 (KB969289) were
861 made available as hot fixes. When this support is available, the OpenAFS for Windows client 1.5.61 and above will raise the timeout period
862 from 45 seconds to 10 minutes.</para>
865 <indexterm><primary>global drives</primary></indexterm>
866 <indexterm><primary>service drive letters</primary></indexterm>
867 <indexterm><primary>path ioctl failures</primary></indexterm>
868 <title id='Global_Drives'>3.41. Global Drives (aka Service Drive Letters) are no longer supported by Microsoft</title>
869 <para>The Global DriveAuto-mount feature has been deprecated due to the following Microsoft KB article.</para>
871 <ulink url='http://msdn.microsoft.com/library/en-us/dllproc/base/services_and_redirected_drives.asp'>http://msdn.microsoft.com/library/en-us/dllproc/base/services_and_redirected_drives.asp</ulink>
873 <para>The article says that services mounting drive letters are no longer supported by Microsoft and may act unpredictably.
874 The experience other users have had is that if the connection to the OpenAFS CIFS/SMB server is terminated by the
875 Windows CIFS client, the drive mapping may not be re-established until the machine is rebooted.</para>
876 <para>OpenAFS supports UNC paths and whenever possible applications should be modified to use UNC form
877 \\AFS\<cellname>\<path> instead of drive letters.</para>
878 <para>Another problem with service mounted drive letters is that the drives are reported as local disk devices
879 and cannot be resolved as being mapped to the \\AFS name space. As a result, AFS path ioctl operations will
880 fail. The fs.exe and symlink.exe command line tools and the AFS Explorer Shell extension will not operate
881 on service mounted drive letters.</para>
884 <indexterm><primary>64-bit Windows</primary></indexterm>
885 <title id='64-bit_Windows'>3.42. 64-bit Microsoft Windows Installations</title>
886 <para>Although 64-bit Windows platforms support both 64-bit and 32-bit applications, the OpenAFS Service installed on the machine must be 64-bit. The 64-bit installer contains only 64-bit executables. In order to support 32-bit applications that link against OpenAFS libraries it is required that a separate 32-bit OpenAFS Tools set be installed. For example, the 32-bit version of Kerberos for Windows can be used with the 32-bit OpenAFS Tools to manage AFS tokens.</para>
887 <para>OpenAFS on 64-bit Windows benefits from the lifting of the 2GB process memory restriction that is present in 32-bit Windows. Without this restriction the AFS Cache File can become arbitrarily large limited only by available disk space.</para>
890 <indexterm><primary>windows vista</primary></indexterm>
891 <indexterm><primary>windows 2008</primary></indexterm>
892 <indexterm><primary>windows 7</primary></indexterm>
893 <title id='Windows_Vista_Known_Issues'>3.43. Known Issues with Microsoft Windows Vista, Windows 7, and Server 2008 [R2]</title>
894 <para>OpenAFS for Windows works with Microsoft Windows Vista, Windows 7 and Server 2008 [R2] from both the command prompt and the Explorer Shell.
895 When performing an upgrade from earlier versions of Microsoft Windows the Microsoft Loopback Adapter (MSLA) will be uninstalled.
896 OpenAFS should be re-installed after the Windows Upgrade installation to restore the MSLA configuration.</para>
897 <para>Due to a feature change in Windows Vista’s Plug-n-Play network stack, during a standby/hibernate operation the
898 MSLA is disabled just as any other hardware device would be. This causes the OpenAFS Client’s network binding to be lost.
899 As a result, it takes anywhere from 30 to 90 seconds after the operating system is resumed for access to the OpenAFS Client
900 and the AFS file name space to be restored. Until the network bindings have been re-established, ticket managers and other
901 tools will report that the "AFS Client Service may not have been started".</para>
902 <para>Windows Vista, Windows 7, and Server 2008 [R2] implement
903 <ulink url='http://www.microsoft.com/technet/windowsvista/library/0d75f774-8514-4c9e-ac08-4c21f5c6c2d9.mspx'>User Account Control</ulink> (UAC), a new security feature that implements least user privilege. With UAC, applications only run with the minimum required privileges. Even Administrator accounts run applications without the "Administrator" access control credentials. One side effect of this is that existing applications that mix user and system configuration capabilities must be re-written to separate those functions that require "Administrator" privileges into a separate process space. Future updates to OpenAFS will incorporate the necessary privilege separation, until that time some functions such as the Start and Stop Service features of the AFS Authentication Tool and the AFS Control Panel will not work unless they are "Run as Administrator". When a Vista user account that is a member of the "Administrators" group is used to access the AFS Control Panel (afs_config.exe), the process must be "Run as Administrator". Otherwise, attempts to modify the OpenAFS configuration will appear to succeed but in reality will have failed due to Vista’s system file and registry virtualization feature.
905 <para>The help files provided with OpenAFS are in .HLP format.
906 <ulink url='http://support.microsoft.com/kb/917607'>Windows Vista, Windows 7, and Server 2008 [R2] do not include a help engine for this format.</ulink>
910 <indexterm><primary>share names</primary></indexterm>
911 <indexterm><primary>afs volumes - direct access</primary></indexterm>
912 <title id='AFS_Share_Direct_Access_to_Volumes'>3.44. New AFS Share Name Syntax Provides Direct Access to Volumes</title>
913 <para>Starting with the 1.5.21 release of OpenAFS for Windows, the following syntax can be used to access any volume in any cell without requiring the creation of a mount point.</para>
914 <para>\\AFS\<cell><mount point type><volume>\</para>
915 <para>Where <cell> can be either a full cell name or an unambiguous prefix, the <mount point type> is ‘#’ for a normal mount point or ‘%’ to force the use of a read-write volume, and <volume> is either a volume name or its ID number.</para>
916 <para>Examples include:</para>
917 <para> \\AFS\athena.mit.edu#user.jaltman\</para>
918 <para> \\AFS\athena%user.jaltman\</para>
919 <para> \\AFS\athena.mit.edu# 537235559\</para>
922 <indexterm><primary>fs examine</primary></indexterm>
923 <indexterm><primary>fs chown</primary></indexterm>
924 <indexterm><primary>fs chgrp</primary></indexterm>
925 <indexterm><primary>owner information</primary></indexterm>
926 <indexterm><primary>group information</primary></indexterm>
927 <title id='Differences_between_Windows_and_Unix'>3.45. Differences between Windows and UNIX "fs examine"</title>
928 <para>The OpenAFS for Windows version of "fs examine" provide two additional lines of output when compared to the
929 UNIX implementation. These lines include the owner and group information for the file as well as the volume status.
930 The Windows output will also indicate the type of object {File, Directory, Mountpoint, Symlink, ...} that was examined.</para>
931 <para>[C:\]fs examine \\afs\athena#user.jaltman</para>
932 <para>Directory \\afs\athena#user.jaltman (537235559.1.1) contained in cell athena.mit.edu</para>
934 <emphasis role='bold'>Owner jaltman (28180) Group jaltman (28180)</emphasis>
936 <para>Volume status for vid = 537235559 named user.jaltman is</para>
937 <para>Current disk quota is 1500000</para>
938 <para>Current blocks used are 1244184</para>
939 <para>The partition has 151945877 blocks available out of 511163724</para>
940 <para><emphasis role='bold'>Volume is online</emphasis></para>
942 <para>The object owner and group information is not available on Microsoft Windows via any other method.</para>
943 <para>To set the owner use <emphasis>fs chown -owner <user name or id> [-path <dir/file path>+] [-literal]</emphasis></para>
944 <para>To set the group use <emphasis>fs chgrp -group <user name or id> [-path <dir/file path>+] [-literal]</emphasis></para>
947 <indexterm><primary>-literal</primary></indexterm>
948 <indexterm><primary>fs examine</primary></indexterm>
949 <indexterm><primary>fs flush</primary></indexterm>
950 <indexterm><primary>fs whereis</primary></indexterm>
951 <indexterm><primary>fs whichcell</primary></indexterm>
952 <title id='fs_Command_Literal_Option'>3.46. Literal evaluation of AFS objects via fs commands</title>
953 <para>Beginning with the 1.5.31 release, the fs commands
954 <emphasis>examine</emphasis>,
955 <emphasis>flush</emphasis>,
956 <emphasis>whereis</emphasis>, and
957 <emphasis>whichcell</emphasis> provide a new command-line parameter,
958 <emphasis>-literal</emphasis>. When specified, if the evaluated object is a symlink or a mountpoint the resulting output will describe the specified object and not the object that is the target of the symlink or mountpoint.
962 <indexterm><primary>out of quota</primary></indexterm>
963 <indexterm><primary>quotas</primary></indexterm>
964 <title id='Out_of_Quota_Errors'>3.47. Out of Quota errors</title>
965 <para>Prior to the 1.5.31 release, out of quota errors were reported to the calling application as an out of space error. As of 1.5.31, an out of space error will indicate that the partition on which the volume is located is in fact out of space. Whereas an out of quota error indicates that the user does not have permission to allocate additional space.</para>
968 <indexterm><primary>linked cells</primary></indexterm>
969 <indexterm><primary>cell renaming</primary></indexterm>
970 <indexterm><primary>cell splitting</primary></indexterm>
971 <indexterm><primary>cell merging</primary></indexterm>
972 <indexterm><primary>CellServDB</primary></indexterm>
973 <title id='Linked_Cells'>3.48. Linked Cells</title>
974 <para>The 1.5.55 release adds support for linked cells as implemented in the Unix OpenAFS client. When two cells are linked, a volume lookup in one cell that fails is retried in the linked cell. This functionality can be used to implement:</para>
975 <itemizedlist mark='bullet'>
977 <para>a test cell which provides substitutes for a subset of the volumes in the linked production cell</para>
980 <para>a cell renaming</para>
983 <para>a cell splitting</para>
986 <para>a cell merger</para>
989 <para>Two cells are linked in the CellServDB file:</para>
992 >cell-one cell-two #Description
994 >cell-two cell-one #Description
998 <para>aklog and Network Identity Manager will automatically obtain tokens for the linked cell when tokens for the other cell is specified.
1002 <indexterm><primary>vldb server locations</primary></indexterm>
1003 <indexterm><primary>CellServDB</primary></indexterm>
1004 <title id="Registry_VLDB_Configuration">3.49 Registry Configuration for AFS Volume Database Servers</title>
1005 <para>Beginning with the 1.5.60 release, the <link linkend="Regkey_HKLM_SOFTWARE_OpenAFS_Client_CellServDB">[HKLM\SOFTWARE\OpenAFS\Client\CellServDB]</link>
1006 registry key can be used to distribute Volume Database Server location information either as a supplement to the <emphasis>CellServDB file</emphasis> or
1007 as a substitute for it. The precedence order for lookups is: Registry, File, and then DNS.</para>
1010 <indexterm><primary>HTMLHelp</primary></indexterm>
1011 <title id="HTMLHelp_Documentation">3.50 Documentation Converted to Windows HTML Help</title>
1012 <para>Starting with the 1.5.60 release, this document, the OpenAFS Administrator Guide and the OpenAFS User Guide are provided in HTML Help format instead
1013 of raw HTML pages.</para>
1016 <indexterm><primary>Explorer Shell</primary></indexterm>
1017 <indexterm><primary>Microsoft Office</primary></indexterm>
1018 <title id='MSRPC_Services'>3.51. Support for Microsoft RPC Services: WKSSVC and SRVSVC</title>
1019 <para>Beginning with the 1.5.62 release, the OpenAFS SMB Server supports named pipes and the Microsoft RPC Services
1020 WKSSVC and SRVSVC. This permits a significantly improved Netbios Server browsing experience with both the
1021 <emphasis>NET VIEW \\AFS</emphasis> command and the Explorer Shell. No longer will Windows display truncated
1022 cell names as available network shares. The network share properties will also include the object type and
1023 and the target of symlinks and mount points.</para>
1026 <chapter id='chap_4'>
1027 <indexterm><primary>debugging</primary></indexterm>
1028 <title id='How_to_Debug_Problems'>How to Debug Problems with OpenAFS for Windows</title>
1029 <para>OpenAFS for Windows provides a wide range of tools to assist you in debugging problems. The techniques available to you are varied because of the wide range of issues that have been discovered over the years.</para>
1031 <indexterm><primary>IoctlDebug</primary></indexterm>
1032 <indexterm><primary>tokens.exe</primary></indexterm>
1033 <indexterm><primary>aklog.exe</primary></indexterm>
1034 <indexterm><primary>afscreds.exe</primary></indexterm>
1035 <title id='pioctl_debugging'>4.1. pioctl debugging (
1036 <link linkend='Value_IoctlDebug'>IoctlDebug</link> registry key)
1038 <para>pioctl (path-based ioctl) calls are used by various tools to communicate with the AFS Client Service. Some of the operations performed include:</para>
1041 <para>setting/querying tokens (tokens.exe, aklog.exe, afscreds.exe)</para>
1044 <para>setting/querying ACLs </para>
1047 <para>setting/querying cache parameters</para>
1050 <para>flushing files or volumes</para>
1053 <para>setting/querying server preferences</para>
1056 <para>querying path location</para>
1059 <para>checking the status of servers and volumes</para>
1062 <para>setting/querying the sysname list</para>
1065 <para>pioctl calls are implemented by writing to a special UNC path that is processed by the AFS Client Service. If there is a failure to communicate with the AFS Client Service via SMB/CIFS, it will be impossible to perform any of the above operations. </para>
1066 <para>To assist in debugging these problems, the registry value:</para>
1067 <para> [HKLM\SOFTWARE\OpenAFS\Client]</para>
1068 <para> REG_DWORD: IoctlDebug = 0x01</para>
1069 <para>should be set. Then any of the commands that perform pioctl calls should be executed from the command prompt. With this key set the pioctl library will generate debugging output to stderr. The output will contain the Win32 API calls executed along with their most important parameters and their return code. The MSDN Library and the Microsoft KnowledgeBase can be used as a reference to help you determine the configuration probem with your system.</para>
1072 <indexterm><primary>afsd_init.log</primary></indexterm>
1073 <indexterm><primary>MaxLogSize</primary></indexterm>
1074 <title id='afsd_service_init_log'>4.2. afsd_service initialization log (%WinDir%\TEMP\afsd_init.log)</title>
1075 <para>Every time the AFS Client Service starts it appends data about its progress and configuration to a file. This file provides information crucial to determining why the service cannot start when there are problems. When the process terminates due to a panic condition it will write to this file the source code file and line number of the error. In many cases the panic condition is due to a misconfiguration of the machine. In other cases it might be due to a programming error in the software. A quick review of the location in the source code will quickly reveal the reason for the termination.</para>
1077 <link linkend='Value_MaxLogSize'>MaxLogSize</link> registry value determines the maximum size of the %WINDIR%\TEMP\afsd_init.log file. If the file is larger than this value when OpenAFS Client Service starts, the file will be reset to 0 bytes. If value is set to 0, the file will be allowed to grow indefinitely.
1081 <indexterm><primary>afsd.log</primary></indexterm>
1082 <indexterm><primary>fs trace</primary></indexterm>
1083 <indexterm><primary>TraceBufferSize</primary></indexterm>
1084 <title id='afsd_service_debug_log'>4.3. afsd_service debug logs (fs trace {-on, -off, -dump} ->%WinDir%\TEMP\afsd.log)</title>
1085 <para>When attempting to debug the behavior of the SMB/CIFS Server and the Cache Manager it is often useful to examine a log of the operations being performed. While running the AFS Client Service keeps an in memory log of many of its actions. The default number of actions preserved at any one time is 5000. This can be adjusted with the
1086 <link linkend='Value_TraceBufferSize'>TraceBufferSize registry value</link>:
1088 <para> [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
1089 <para> REG_DWORD TraceBufferSize </para>
1090 <para>A restart of the service is necessary when adjusting this value. Execute "fs trace -on" to clear to the log and "fs trace -dump" to output the contents of the log to the file.</para>
1093 <indexterm><primary>SysInternals</primary></indexterm>
1094 <indexterm><primary>dbgview.exe</primary></indexterm>
1095 <indexterm><primary>procmon.exe</primary></indexterm>
1096 <indexterm><primary>TraceOption</primary></indexterm>
1097 <title id='Using_Sysinternals_Tools'>4.4. Using SysInternal’s Debug Viewer, Process Monitor and Process Explorer Tools</title>
1098 <para>An alternatve option to the use of "fs trace -dump" to capture internal OpenAFS Client Service events is to use a tool such as Sysinternal's
1099 <ulink url='http://technet.microsoft.com/en-us/sysinternals/bb896647.aspx'>Debug Viewer</ulink> to capture real-time debugging output. When the OpenAFS Client Service starts and Bit 2 of the
1100 <link linkend='Value_TraceOption'>TraceOption</link> value in the registry is set, all trace log events are output using the Windows Debug Monitor interface (OutputDebugString).
1102 <para> [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
1103 <para>REG_DWORD TraceOption = 0x04</para>
1104 <para>Use "fs trace –on" and "fs trace –off" to toggle the generation of log messages. </para>
1106 <ulink url='http://technet.microsoft.com/en-us/sysinternals/bb896645.aspx'>Process Monitor</ulink> can be use to monitor the file operations requested by applications and their success or failure.
1108 <para>In Process Monitor, set a filter to include only events on file paths that refer to the AFS name space. Be sure to include both the UNC path as well as any drive letters mapped to AFS. </para>
1110 <emphasis>Clock Time</emphasis> and
1111 <emphasis>Show Milliseconds</emphasis> options in both tools to make it easier to synchronize the application requests and the resulting OpenAFS Client Service operations. The captured data can be stored to files for inclusion in
1112 <link linkend='Reporting_Bugs'>bug reports</link>.
1115 <ulink url='http://technet.microsoft.com/en-us/sysinternals/bb896653.aspx'>Process Explorer</ulink> is a replacement for the Windows Task Manager and so much more. Process Explorer can be configured to use the DbgHelp.dll from "
1116 <ulink url='http://www.microsoft.com/whdc/devtools/debugging/default.mspx'>Microsoft Debugging Tools for Windows</ulink>" as well as the debug symbols shipped as an optional component of the OpenAFS for Windows installer. (Options->Configure Symbols) Once configured the "Threads" tab of the process properties dialog will permit the viewing of a fully documented stack for each displayed thread. Hint: If there is a deadlock in the cache manager, two or more of the threads will be stuck in a call to osi_TWait().
1120 <indexterm><primary>minidumps</primary></indexterm>
1121 <indexterm><primary>fs minidump</primary></indexterm>
1122 <indexterm><primary>MiniDumpType</primary></indexterm>
1123 <indexterm><primary>afsd.dmp</primary></indexterm>
1124 <title id='Creating_Microsoft_Minidumps'>4.5. Creating Microsoft MiniDumps
1125 (fs minidump -> %WinDir%\TEMP\afsd.dmp)</title>
1126 <para>If the AFS Client Service become unresponsive to any form of communication there may be a serious error that can only be debugged by someone with access to the source code and a debugger. The "fs minidump" command can be used to force the generation of a MiniDump file containing the state of all of the threads in the AFS Client Service process. The most accurate MiniDump files will be produced after installing "
1127 <ulink url='http://www.microsoft.com/whdc/devtools/debugging/default.mspx'>Microsoft Debugging Tools for Windows</ulink>".
1130 <link linkend='Value_MiniDumpType'>MiniDumpType</link> registry value can be used to adjust the scope of the process information included within the dump file. By default the MiniDump only contains the stacks of all threads and the values of all global variables. A much more useful MiniDump is one that contains the contents of the heap. Be warned, a MiniDump with heap will be as large as the cache file. In addition, it will include all of the data stored within the cache. If there are privacy concerns, do not produce a MiniDump with heap.
1134 <indexterm><primary>integrated logon</primary></indexterm>
1135 <indexterm><primary>TraceOption</primary></indexterm>
1136 <title id='Integrated_Logon_Debugging'>4.6. Single Sign-on (Integrated Logon) debugging</title>
1137 <para>If you are having trouble with the Integrated Logon operations it is often useful to be able to obtain a log of what it is attempting to do. Setting Bit 0 of the
1138 <link linkend='Value_TraceOption'>TraceOption</link> registry value:
1140 <para> [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
1141 <para> REG_DWORD TraceOption = 0x01</para>
1142 <para>will instruct the Integrated Logon Network Provider and Event Handlers to log information to the Windows Event Log: Application under the name "AFS Logon".</para>
1145 <indexterm><primary>rxdebug.exe</primary></indexterm>
1146 <title id='rxdebug_usage'>4.7. RX (AFS RPC) debugging (rxdebug)</title>
1147 <para>The rxdebug.exe tool can be used to query a variety of information about the AFS services installed on a given machine. The port for the AFS Cache Manager is 7001. </para>
1150 Usage: rxdebug -servers <server machine> [-port <IP port>] [-nodally]
1151 [-allconnections] [-rxstats] [-onlyserver] [-onlyclient]
1152 [-onlyport <show only <port>>]
1153 [-onlyhost <show only <host>>]
1154 [-onlyauth <show only <auth level>>] [-version]
1155 [-noconns] [-peers] [-help]
1156 Where: -nodally don't show dallying conns
1157 -allconnections don't filter out uninteresting connections
1158 -rxstats show Rx statistics
1159 -onlyserver only show server conns
1160 -onlyclient only show client conns
1161 -version show AFS version id
1162 -noconns show no connections
1168 <indexterm><primary>cmdebug.exe</primary></indexterm>
1169 <title id='cmdebug_usage'>4.8. Cache Manager debugging (cmdebug)</title>
1170 <para>The cmdebug.exe tool can be used to query the state of the AFS Cache Manager on a given machine.</para>
1173 Usage: cmdebug -servers <server machine> [-port <IP port>] [-long] [-refcounts]
1174 [-callbacks] [-ctime] [-addrs] [-cache] [-cellservdb] [-help]
1175 Where: -long print all info
1176 -refcounts print only cache entries with positive reference counts
1177 -callbacks print only cache entries with callbacks
1178 -ctime print human readable expiration time
1179 -addrs print only host interfaces
1180 -cache print only cache configuration
1181 -cellservdb print only cellservdb info
1186 <indexterm><primary>AFSCache</primary></indexterm>
1187 <indexterm><primary>validate cache file</primary></indexterm>
1188 <title id='Persistent_Cache_Consistency_Check'>4.9. Persistent Cache consistency check</title>
1189 <para>The persistent cache is stored in a Hidden System file at %WinDir%\TEMP\AFSCache. If there is a problem with the persistent cache that prevent the AFS Client Service from being able to start a validation check on the file can be performed.</para>
1190 <para> afsd_service.exe --validate-cache <cache-path></para>
1193 <indexterm><primary>tokens</primary></indexterm>
1194 <indexterm><primary>klog.exe</primary></indexterm>
1195 <indexterm><primary>kinit.exe</primary></indexterm>
1196 <indexterm><primary>aklog.exe</primary></indexterm>
1197 <title id='Token_Acquisition_Debugging'>4.10. Token Acquisition Debugging</title>
1198 <para>If you are having trouble obtaining tokens with the Network Identity Manager AFS credential provider, it is recommended that you verify your ability to obtain tokens using the command-line tools
1199 <emphasis>klog.exe</emphasis> (if you are using kaserver) or
1200 <emphasis>kinit.exe</emphasis> and
1201 <emphasis>aklog.exe</emphasis> (if you are using Kerberos v5.) The aklog.exe
1202 <emphasis>–d</emphasis> option will be quite helpful in diagnosing Kerberos v5 related problems.
1206 <chapter id='chap_5'>
1207 <indexterm><primary>bug reports</primary></indexterm>
1208 <title id='Reporting_Bugs'>Reporting Bugs</title>
1209 <para>Bug reports should be sent to
1210 <ulink url='mailto:openafs-bugs@openafs.org?subject=Bug%20Report'>openafs-bugs@openafs.org</ulink>. Please include as much information as possible about the issue. If you are reporting a crash, please install the debugging symbols by re-running the installer. If a dump file is available for the problem, %WINDIR%\TEMP\afsd.dmp, include it along with the AFS Client Trace file %WINDIR%\TEMP\afsd.log. The AFS Client startup log is %WINDIR%\TEMP\afsd_init.log. Send the last continuous block of log information from this file.
1212 <para>Configuring DrWatson to generate dump files for crashes:</para>
1215 <para>Run drwtsn32.exe to configure or to identify where the log and the crash dump files are created: </para>
1218 <para>click Start > Run... </para>
1221 <para>type drwtsn32 <enter>. </para>
1224 <para>Select either a Crash Dump Type: Mini or Full. </para>
1227 <para>Clear Dump Symbol Table</para>
1230 <para>Clear Append to Existing Log file. </para>
1233 <para>Check Dump All Thread Contexts.</para>
1236 <para>Check Create Crash Dump File</para>
1239 <para>Next run the monitoring module of Dr. Watson: </para>
1242 <para>click Start > Run...</para>
1245 <para>type drwatson <enter>. </para>
1248 <para>Once a crash happens, Dr. Watson generates a dump file and a report in the log file, including the address of the crash and the stack dump.</para>
1251 <para>Once you have the Dr. Watson's logfile and minidump, zip them and attach them to your e-mail.</para>
1252 <para>When reporting a error, please be sure to include the version of OpenAFS.
1255 <chapter id='chap_6'>
1256 <indexterm><primary>contributing to OpenAFS</primary></indexterm>
1257 <title id='Contributing_to_OpenAFS'>How to Contribute to the Development of OpenAFS for Windows</title>
1258 <para>Contributions to the development of OpenAFS for Windows are continuously needed. Contributions may take many forms including cash donations, support contracts, donated developer time, and even donated tech writer time.</para>
1260 <indexterm><primary>USENIX OpenAFS Fund</primary></indexterm>
1261 <title id='USENIX_OpenAFS_Fund'>6.1. The USENIX OpenAFS Fund </title>
1263 <ulink url='http://www.usenix.org/'>USENIX</ulink>, a 501c3 non-profit corporation, has formed the USENIX OpenAFS Fund in order to accept tax deductible donations on behalf of the OpenAFS Elders. The donated funds will be allocated by the OpenAFS Elders to fund OpenAFS development, documentation, project management, and maintaining openafs.org.
1265 <informaltable frame='none'>
1266 <tgroup rowsep='1' align='left' colsep='1' cols='1'>
1267 <colspec colwidth='405pt' colname='c1' />
1275 2560 Ninth St., Suite 215
1284 <para>Donations can be made by sending a check, drawn on a U.S. bank, made out to the USENIX OpenAFS Fund or by making a
1285 <ulink url='https://db.usenix.org/cgi-bin/openafs/openafs.cgi'>donation online</ulink>.
1289 <indexterm><primary>Secure Endpoints Inc.</primary></indexterm>
1290 <title id='Secure_Endpoints_Inc'>6.2. Secure Endpoints Inc. </title>
1292 <ulink url='http://www.secure-endpoints.com/'>Secure Endpoints Inc.</ulink> provides development and support services for OpenAFS for Windows and
1293 <ulink url='http://web.mit.edu/kerberos/'>MIT Kerberos for Windows</ulink>. Donations provided to Secure Endpoints Inc. for the development of OpenAFS are used to cover the OpenAFS gatekeeper responsibilities; providing support to the OpenAFS community via the OpenAFS mailing lists; and furthering development of desired features that are either too small to be financed by development contracts.
1295 <para>Secure Endpoints Inc. accepts software development agreements from organizations who wish to fund a well-defined set of bug fixes or new features. </para>
1296 <para>Secure Endpoints Inc. provides contract based support for the OpenAFS for Windows and the
1297 <ulink url='http://web.mit.edu/kerberos/'>MIT Kerberos for Windows</ulink> products.
1301 <title id='Direct_Code_Contributions'>6.3. Direct contributions of code and/or documentation </title>
1302 <para>Organizations that use OpenAFS in house and have development staffs are encouraged to contribute any code modifications they make to OpenAFS.org via openafs-bugs@openafs.org. Contributions of documentation are highly desired. </para>
1305 <indexterm><primary>mailing lists</primary></indexterm>
1306 <indexterm><primary>openafs-win32-devel</primary></indexterm>
1307 <indexterm><primary>openafs-info</primary></indexterm>
1308 <title id='OAFW_Mailing_Lists'>6.4. OpenAFS for Windows Mailing Lists</title>
1309 <para>If you wish to participate in OpenAFS for Windows development please join the
1310 <ulink url='mailto:openafs-win32-devel@openafs.org?subject=OpenAFS%20for%20Windows%20Development%20Contribution'>openafs-win32-devel@openafs.org</ulink> mailing list.
1313 <emphasis role='bold'>https://lists.openafs.org/mailman/listinfo/openafs-win32-devel</emphasis>
1315 <para>User questions should be sent to the
1316 <ulink url='mailto:openafs-info@openafs.org?subject=OpenAFS%20for%20Windows%20User%20Question'>openafs-info@openafs.org</ulink> mailing list.
1319 <emphasis role='bold'>https://lists.openafs.org/mailman/listinfo/openafs-info</emphasis>
1321 <para>You must join the mailing lists if you wish to post to the list without incurring a moderation delay.</para>
1324 <chapter id='chap_7'>
1325 <indexterm><primary>msi deployment</primary></indexterm>
1326 <indexterm><primary>msi transforms</primary></indexterm>
1327 <title id='MSI_Deployment_Guide'>MSI Deployment Guide</title>
1329 <title id='Introduction_to_MSI_Deployment'>7.1. Introduction</title>
1330 <para>A MSI installer option is available for those who wish to use Windows Installer for installing OpenAFS and for organizations that wish to deploy OpenAFS through Group Policy. The first version of OpenAFS for Windows available as an MSI was 1.3.65.</para>
1331 <para>This document provides a guide for authoring transforms used to customize the MSI package for a particular organization. Although many settings can be deployed via transforms, in an Active Directory environment it is advisable to deploy registry settings and configuration files through group policy and/or startup scripts so that machines where OpenAFS for Windows is already installed will pick up these customizations.</para>
1333 <title id='MSI_Deployment_Requirements'>7.1.1 Requirements</title>
1334 <para>The information in this document applies to MSI packages distributed with OpenAFS for Windows releases from 1.3.65 and onwards or MSI packages built from corresponding source releases. Not all releases support all the configuration options documented here.</para>
1335 <para>Authoring a "Windows Installer" transform requires additional software for editing the MSI database tables and generating the transform from the modified MSI package. ORCA.EXE and MSITRAN.EXE which are included in the Windows Platform SDK ("Windows Installer" SDK) can be used for this purpose.</para>
1336 <para>For reference, the schema for the MSI package is based on SCHEMA.MSI distributed with the Platform SDK.</para>
1337 <para>For general information about "Windows Installer", refer to:</para>
1339 <ulink url='http://msdn.microsoft.com/library/en-us/msi/setup/windows_installer_start_page.asp'>http://msdn.microsoft.com/library/en-us/msi/setup/windows_installer_start_page.asp</ulink>
1341 <para>For general information about authoring MSI transforms, refer to:</para>
1343 <ulink url='http://msdn.microsoft.com/library/en-us/msi/setup/transforms.asp'>http://msdn.microsoft.com/library/en-us/msi/setup/transforms.asp</ulink>
1345 <para>The remainder of this document assumes some familiarity with authoring transforms. While the MSDN documentation for Windows Installer is a bit dense, the guide on MSI transforms found at the second link above is recommended reading. MSDN also includes a step-by-step example for creating a transform at:</para>
1347 <ulink url='http://msdn.microsoft.com/library/en-us/msi/setup/a_customization_transform_example.asp'>http://msdn.microsoft.com/library/en-us/msi/setup/a_customization_transform_example.asp</ulink>
1351 <title id='MSI_Authoring_Transforms'>7.1.2 Authoring a Transform</title>
1352 <para>Transforms describe a set of modifications to be performed on an existing MSI for the purpose of customizing it. This is ordinarily done by making a copy of the MSI to be customized, modifying the copy and then using the old and the new MSI to generate a transform. For example:</para>
1355 <para>copy openafs.msi openafs-modified.msi</para>
1358 <para>(edit the openafs-modified.msi to include the necessary changes)</para>
1361 <para>msitran -g openafs.msi openafs-modified.msi openafs-transform.mst</para>
1364 <para>(generates openafs-transform.mst, which is the transform)</para>
1367 <para>Transforms have an extension of .mst. 'msitran' is a tool distributed as part of the "Windows Installer" SDK (part of the Windows Platform SDK).</para>
1368 <para>You can test a transform by:</para>
1371 <para>copy openafs.msi openafs-test.msi</para>
1374 <para>msitran -a openafs-transform.mst openafs-test.msi</para>
1377 <para>and then checking the resulting openafs-test.msi to see if all changes you have made above to openafs-modified.msi is present in openafs-test.msi. 'msitran' will complain if some modification in the transform can not be successfully applied.</para>
1378 <para>As mentioned above, you can use a tool like ORCA.EXE to edit the MSI databases directly when editing openafs-modified.msi. More details are given below.</para>
1382 <title id='MSI_Configuration_Options'>7.2. Configuration Options</title>
1383 <para>The logic necessary to implement many of the settings described in
1384 <link linkend='appendix_a'>Appendix A</link> are present in the MSI. Most of these can be controlled by setting the corresponding properties to the desired value. Some settings may require modifying existing registry entries (though not recommended) or adding new resources (like files or registry keys). Instructions for performing these tasks are below.
1387 <title id='MSI_Configurable_Properties'>7.2.1 Configurable Properties</title>
1388 <para>Most configurable properties correspond to registry keys or values. Due to the logic invoked based on the existence of these registry keys or values, they are only set if the associated property is defined to have a non null value. If the associated property is not defined in the MSI, the registry key or value will not be touched. By default, the MSI does not contain these properties and hence will not set the registry keys. You will need to add properties as needed to the MSI.</para>
1389 <para>When one of the configurable properties is set, the installer will use the property value to set the corresponding setting in the HKEY_LOCAL_MACHINE registry hive. The HKEY_CURRENT_USER hive is not touched by the installer.</para>
1390 <para>For each property, the associated registry setting is referenced by the same text used in
1391 <link linkend='appendix_a'>Appendix A</link>.
1393 <para>Strings are quoted using single quotes (e.g. 'a string'). An empty string is denoted as ''. Note that you can't author null values into the 'Property' table.</para>
1394 <para>Numeric values should be authored as decimal strings.</para>
1396 <title id='MSI_Setting_Properties'>7.2.1.1 Setting Properties</title>
1397 <para>In order to set a property,</para>
1400 <para>Open the MSI in ORCA.EXE</para>
1403 <para>Select the 'Property' table from the list of tables on the left.</para>
1406 <para>Find the property in the list of properties on the right, double click the value and type the new value.</para>
1409 <para>If the property does not exist in the property list, right click the list and select 'Add Row', type the property name and the desired value.</para>
1414 <title id='MSI_OAFW_Properties'>7.2.1.2 OpenAFS for Windows Properties</title>
1415 <informaltable frame='all'>
1416 <tgroup rowsep='1' align='left' colsep='1' cols='1'>
1417 <colspec colwidth='447pt' colname='c1' />
1422 <emphasis>(Service parameters):</emphasis>
1424 <para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
1430 <emphasis>(Network provider):</emphasis>
1432 <para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]</para>
1438 <emphasis>(OpenAFS Client):</emphasis>
1440 <para>[HKLM\SOFTWARE\OpenAFS\Client]</para>
1447 <title id='MSI_OAFW_Registry_Properties'>7.2.1.2.1 Registry Properties</title>
1448 <para>These properties are used to set the values of registry entries associated with OpenAFS for Windows.</para>
1449 <informaltable frame='all'>
1450 <tgroup rowsep='1' align='left' colsep='1' cols='1'>
1451 <colspec colwidth='447pt' colname='c1' />
1456 <emphasis role='bold'>AFSCACHEPATH</emphasis>
1458 <para>Registry key :
1459 <link linkend='Service_Parameters'>(Service Parameters)</link>
1461 <para>Registry value :
1462 <link linkend='Value_CachePath'>CachePath</link>
1464 <para>Valid values : string .</para>
1470 <emphasis role='bold'>AFSCACHESIZE</emphasis>
1472 <para>Registry key :
1473 <link linkend='Service_Parameters'>(Service Parameters)</link>
1475 <para>Registry value :
1476 <link linkend='Value_CacheSize'>CacheSize</link>
1478 <para>Valid values : numeric</para>
1484 <emphasis role='bold'>AFSCELLNAME</emphasis>
1486 <para>Registry key :
1487 <link linkend='Service_Parameters'>(Service Parameters)</link>
1489 <para>Registry value :
1490 <link linkend='Value_Cell'>Cell</link>
1492 <para>Valid values : string</para>
1498 <emphasis role='bold'>FREELANCEMODE</emphasis>
1500 <para>Registry key :
1501 <link linkend='Service_Parameters'>(Service Parameters)</link>
1503 <para>Registry value :
1504 <link linkend='Value_FreelanceClient'>FreelanceClient</link>
1506 <para>Valid values : '1' or '0'</para>
1512 <emphasis role='bold'>HIDEDOTFILES</emphasis>
1514 <para>Registry key :
1515 <link linkend='Service_Parameters'>(Service Parameters)</link>
1517 <para>Registry value :
1518 <link linkend='Value_HideDotFiles'>HideDotFiles</link>
1520 <para>Valid values : '1' or '0'</para>
1526 <emphasis role='bold'>LOGONOPTIONS</emphasis>
1528 <para>Registry key :
1529 <link linkend='Domain_Specific_Regkeys'>(Network Provider)</link>
1531 <para>Registry value :
1532 <link linkend='Value_LogonOptions'>LogonOptions</link>
1534 <para>Valid values : '0', '1' or '3'</para>
1536 <link linkend='appendix_a'>Appendix A</link>
1537 <link linkend='Domain_Specific_Configuration'>section 2.1 (Domain Specific Configuration keys for Network Provider)</link> for more details.
1547 <emphasis role='bold'>MOUNTROOT</emphasis>
1549 <para>Registry key :
1550 <link linkend='Service_Parameters'>(Service Parameters)</link>
1552 <para>Registry value :
1553 <link linkend='Value_Mountroot'>Mountroot</link>
1555 <para>Valid values : string</para>
1561 <emphasis role='bold'>NETBIOSNAME</emphasis>
1563 <para>Registry key :
1564 <link linkend='Service_Parameters'>(Service Parameters)</link>
1566 <para>Registry value :
1567 <link linkend='Value_NetbiosName'>NetbiosName</link>
1569 <para>Valid values : string (at most 15 characters)</para>
1575 <emphasis role='bold'>NOFINDLANABYNAME</emphasis>
1577 <para>Registry key :
1578 <link linkend='Service_Parameters'>(Service Parameters)</link>
1580 <para>Registry value :
1581 <link linkend='Value_NoFindLanaByName'>NoFindLanaByName</link>
1583 <para>Valid values : '1' or '0'</para>
1589 <emphasis role='bold'>RXMAXMTU</emphasis>
1591 <para>Registry key :
1592 <link linkend='Service_Parameters'>(Service Parameters)</link>
1594 <para>Registry value :
1595 <link linkend='Value_RxMaxMTU'>RxMaxMTU</link>
1597 <para>Valid values : numeric</para>
1603 <emphasis role='bold'>SECURITYLEVEL</emphasis>
1605 <para>Registry key :
1606 <link linkend='Service_Parameters'>(Service Parameters)</link>
1608 <para>Registry value :
1609 <link linkend='Value_SecurityLevel'>SecurityLevel</link>
1611 <para>Valid values : '1' or '0'</para>
1617 <emphasis role='bold'>SMBAUTHTYPE</emphasis>
1619 <para>Registry key :
1620 <link linkend='Service_Parameters'>(Service Parameters)</link>
1622 <para>Registry value :
1623 <link linkend='Value_smbAuthType'>SMBAuthType</link>
1625 <para>Valid values : '0','1' or '2'</para>
1631 <emphasis role='bold'>STOREANSIFILENAMES</emphasis>
1633 <para>Registry key :
1634 <link linkend='Regkey_HKLM_SOFTWARE_OpenAFS_Client'>(OpenAFS Client)</link>
1636 <para>Registry value :
1637 <link linkend='Value_StoreAnsiFilenames'>StoreAnsiFilenames</link>
1639 <para>Valid values : '0' or '1'</para>
1640 <para>This option is no longer supported as of 1.5.50 now that all file names are stored to AFS file servers using the UTF-8 encoding of Unicode.</para>
1646 <emphasis role='bold'>USEDNS</emphasis>
1648 <para>Registry key :
1649 <link linkend='Service_Parameters'>(Service Parameters)</link>
1651 <para>Registry value :
1652 <link linkend='Value_UseDNS'>UseDNS</link>
1654 <para>Valid values : '1' or '0'</para>
1662 <title id='MSI_OAFW_AFSCreds_Properties'>
1663 7.2.1.2.2 AFSCreds.exe Properties
1665 <para>These properties are combined to add a command line option to the shortcut that will be created in the Start:Programs:OpenAFS and Start:Programs:Startup folders (see CREDSSTARTUP). The method of specifying the option was chosen for easy integration with the Windows Installer user interface. Although other methods can be used to specify options to AFSCREDS.EXE, it is advised that they be avoided as transforms including such options may not apply to future releases of OpenAFS.</para>
1666 <informaltable frame='all'>
1667 <tgroup rowsep='1' align='left' colsep='1' cols='1'>
1668 <colspec colwidth='447pt' colname='c1' />
1673 <emphasis role='bold'>CREDSSTARTUP</emphasis>
1675 <para>Valid values : '1' or '0'</para>
1676 <para>Controls whether AFSCreds.exe starts up automatically when the user logs on. When CREDSSTARTUP is '1' a shortcut is added to the 'Startup' folder in the 'Program menu' which starts AFSCREDS.EXE with the options that are determined by the other CREDS* properties.</para>
1682 <emphasis role='bold'>CREDSAUTOINIT</emphasis>
1684 <para>Valid values : '-a' or ''</para>
1685 <para>Enables automatic initialization.</para>
1691 <emphasis role='bold'>CREDSIPCHDET</emphasis>
1693 <para>Valid values : '-n' or ''</para>
1694 <para>Enables IP address change detection.</para>
1700 <emphasis role='bold'>CREDSQUIET</emphasis>
1702 <para>Valid values : '-q' or ''</para>
1703 <para>Enables quiet mode.</para>
1709 <emphasis role='bold'>CREDSRENEWDRMAP</emphasis>
1711 <para>Valid values : '-m' or '’</para>
1712 <para>Enables renewing drive map at startup.</para>
1718 <emphasis role='bold'>CREDSSHOW</emphasis>
1720 <para>Valid values : '-s' or ''</para>
1721 <para>Enables displaying the credential manager window when AFSCREDS starts up.</para>
1731 <title id='MSI_Existing_Registry_Entries'>7.2.2 Existing Registry Entries</title>
1732 <para>You can change existing registry values subject to the restrictions mentioned in the Windows Platform SDK. Pay special attention to component key paths and try to only change the 'Value' column in the 'Registry' table. If you want to add additional registry keys please refer to section 3 (Additional resources).</para>
1735 <title id='MSI_Replacing_Configuration_Files'>7.2.3 Replacing Configuration Files</title>
1736 <para>The OpenAFS configuration files (CellServDB) can be replaced by your own configuration files. These files are contained in separate MSI components so that you can disable them individually.</para>
1737 <para>The recommended method for replacing these files is to first disable the components containing the configuration files that you want to replace, and then add new components for the replacement files. This is outlined below (assuming you are using ORCA.EXE to author the transform).</para>
1738 <para>Note that transforms are not a good way to add a new file as an embedded stream. The method outlined here places the file in the same directory as the MSI for deployment.</para>
1739 <para>The walkthrough below is to add a custom 'CellServDB' file.</para>
1742 <para>Disable the component that contains the configuration file that you want to replace.</para>
1745 <para>Locate and select the 'Component' table in the 'Tables' list.</para>
1748 <para>In the Component table, locate the component you need to change ( Ctrl-F invokes the 'Find' dialog). The component names are listed below in section
1749 <link linkend='MSI_Configuration_File_Components'>7.2.3.1</link>. For this example, the component name is 'elf_CellServDB'.
1753 <para>Go to the 'Condition' column of the component.</para>
1756 <para>Enter a condition that evaluates to false. I.e. 'DONOTINSTALL'. (Note that an undefined property always evaluates to false).</para>
1757 <para>Note that you can also use this step to disable other configuration files without providing replacements.</para>
1762 <para>Add a new component containing the new configuration file.</para>
1765 <para>Select the 'Component' table in the 'Tables' list.</para>
1768 <para>Select 'Tables'->'Add Row' (Ctrl-R).</para>
1771 <para>Enter the following :</para>
1772 <informaltable frame='all'>
1773 <tgroup rowsep='1' align='left' colsep='1' cols='2'>
1774 <colspec colwidth='84pt' colname='c1' />
1775 <colspec colwidth='318pt' colname='c2' />
1779 <para>Component</para>
1782 <para>cmf_my_CellServDB</para>
1787 <para>ComponentID</para>
1790 <para>{7019836F-BB2C-4AF6-9463-0D6EC9035CF1}</para>
1795 <para>Directory_</para>
1798 <para>dirClient</para>
1803 <para>Attributes</para>
1811 <para>Condition</para>
1819 <para>KeyPath</para>
1822 <para>fil_my_CellServDB</para>
1828 <para>Note that the ComponentId is an uppercase GUID. You can generate one using GUIDGEN.EXE or UUIDGEN.EXE, both of which are included in the Platform SDK.</para>
1829 <para>The Attributes value of 144 is a sum of msidbComponentAttributesPermanent (16) and msidbComponentAttributesNeverOverwrite (128). This ensures that local modifications are not overwritten or lost during an installation or uninstallation. These are the same settings used on the default configuration files.</para>
1830 <para> 'fil_my_CellServDB' is a key into the 'File' table which we will fill later.</para>
1835 <para>Add a new feature to hold the new component.</para>
1838 <para>Select the 'Feature' table.</para>
1841 <para>Add a new row (Ctrl-R or 'Tables'->'Add Row') with the following values:</para>
1842 <informaltable frame='all'>
1843 <tgroup rowsep='1' align='left' colsep='1' cols='2'>
1844 <colspec colwidth='94pt' colname='c1' />
1845 <colspec colwidth='307pt' colname='c2' />
1849 <para>Feature</para>
1852 <para>fea_my_CellServDB</para>
1857 <para>Feature_Parent</para>
1860 <para>feaClient</para>
1873 <para>Description</para>
1881 <para>Display</para>
1897 <para>Directory_</para>
1905 <para>Attributes</para>
1914 <para>It is important to create the new feature under the 'feaClient' feature, which will ensure that the configuration file will be installed when the client binaries are installed.</para>
1915 <para>Setting 'Display' to 0 will hide this feature from the feature selection dialog during an interactive installation. A value of 30 for 'Level' allows this feature to be installed by default (on a 'Typical' installation).</para>
1916 <para>The 'Attributes' value is msidbFeatureAttributesDisallowAdvertise (8), which is set on all features in the OpenAFS MSI. The OpenAFS MSI is not designed for an advertised installation.</para>
1921 <para>Join the component and the feature.</para>
1924 <para>Select the 'FeatureComponents' table.</para>
1927 <para>Add a new row with the following values:</para>
1928 <informaltable frame='all'>
1929 <tgroup rowsep='1' align='left' colsep='1' cols='2'>
1930 <colspec colwidth='90pt' colname='c1' />
1931 <colspec colwidth='312pt' colname='c2' />
1935 <para>Feature</para>
1938 <para>fea_my_CellServDB</para>
1943 <para>Component</para>
1946 <para>cmf_my_CellServDB</para>
1956 <para>Add an entry to the 'File' table.</para>
1959 <para>Select the 'File' table.</para>
1962 <para>Add a new row with the following values:</para>
1963 <informaltable frame='all'>
1964 <tgroup rowsep='1' align='left' colsep='1' cols='2'>
1965 <colspec colwidth='91pt' colname='c1' />
1966 <colspec colwidth='311pt' colname='c2' />
1973 <para>fil_my_CellServDB</para>
1978 <para>Component_</para>
1981 <para>cmf_my_CellServDB</para>
1986 <para>FileName</para>
1989 <para>CellServDB</para>
1994 <para>FileSize</para>
1997 <para>(enter file size here)</para>
2002 <para>Attributes</para>
2010 <para>Sequence</para>
2019 <para> (leave other fields blank)</para>
2020 <para>The 'Attributes' value is msidbFileAttributesNonCompressed (8192). This is because we will be placing this file in the same directory as the MSI instead of embedding the file in it. Transforms do not support updating compressed sources or adding new cabinet streams.</para>
2021 <para>Finally, the 'Sequence' value of 1000 will be used later to distinguish the file as being in a separate source location than the other files in the MSI.</para>
2026 <para>Set a media source for the file.</para>
2029 <para>Select the 'Media' table.</para>
2032 <para>Add a row with the following values :</para>
2033 <informaltable frame='all'>
2034 <tgroup rowsep='1' align='left' colsep='1' cols='2'>
2035 <colspec colwidth='93pt' colname='c1' />
2036 <colspec colwidth='309pt' colname='c2' />
2048 <para>LastSequence</para>
2057 <para> (leave other fields blank)</para>
2058 <para>The sequence number of 1000 designates this as the media source for the newly added file.
2065 <title id='MSI_Configuration_File_Components'>7.2.3.1 Components for Configuration Files</title>
2066 <para>CellServDB: 'cpf_CellServDB' (ID {D5BA4C15-DBEC-4292-91FC-B54C30F24F2A})</para>
2070 <title id='MSI_Adding_Domain_Specific_Registry_Keys'>7.2.4 Adding Domain Specific Registry Keys</title>
2071 <para>Following is an example for adding domain specific registry keys.</para>
2073 <link linkend='appendix_a'>Appendix A</link> section 2.1 for more information.
2078 <para> Columns that are unspecified should be left empty.</para>
2079 <para> We create a new feature and component to hold the new registry keys.</para>
2080 <informaltable frame='all'>
2081 <tgroup rowsep='1' align='left' colsep='1' cols='1'>
2082 <colspec colwidth='448pt' colname='c1' />
2086 <para> 'Feature' table:</para>
2092 Feature : 'feaDomainKeys'
2093 Feature Parent : 'feaClient'
2096 Attributes : 10</para>
2101 <para> 'Component' table:</para>
2107 Component : 'rcm_DomainKeys'
2108 ComponentId : '{4E3FCBF4-8BE7-40B2-A108-C47CF743C627}'
2109 Directory : 'TARGETDIR'
2111 KeyPath : 'reg_domkey0'</para>
2116 <para> 'FeatureComponents' table:</para>
2122 Feature : 'feaDomainKeys'
2123 Component : 'rcm_DomainKeys'</para>
2128 <para> 'Registry' table:</para>
2134 Registry : 'reg_domkey0'
2136 Key : 'SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain'
2137 Component : 'rcm_DomainKeys'</para>
2143 Registry : 'reg_domkey1'
2145 Key : 'SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain'
2147 Component : 'rcm_DomainKeys'</para>
2153 Registry : 'reg_domkey2'
2155 Key : 'SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\ATHENA.MIT.EDU'
2157 Component : 'rcm_DomainKeys'</para>
2163 Registry : 'reg_domkey3'
2165 Key : 'SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\ATHENA.MIT.EDU'
2166 Name : 'LogonOptions'
2168 Component : 'rcm_DomainKeys'</para>
2174 Registry : 'reg_domkey4'
2176 Key : SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST'
2178 Component : 'rcm_DomainKeys'</para>
2184 Registry : 'reg_domkey5'
2186 Key : 'SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST'
2187 Name : 'LogonOptions'
2189 Component : 'rcm_DomainKeys'</para>
2195 Registry : 'reg_domkey6'
2197 Key : 'SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST'
2198 Name : 'FailLoginsSilently'
2200 Component : 'rcm_DomainKeys'</para>
2207 <para>The example adds domain specific keys for 'ATHENA.MIT.EDU' (enable integrated logon) and 'LOCALHOST' (disable integrated logon and fail logins silently).</para>
2210 <title id='MSI_Adding_Site_Specific_Freelance_Registry_Keys'>7.2.5 Adding Site Specific Freelance Registry Keys</title>
2211 <para>Following is an example for adding site specific Freelance registry keys to pre-populate the Mountpoints and Symlinks in the fake root.afs volume.</para>
2212 <para> Columns that are unspecified should be left empty.</para>
2213 <para> We create a new feature and component to hold the new registry keys.</para>
2214 <informaltable frame='all'>
2215 <tgroup rowsep='1' align='left' colsep='1' cols='1'>
2216 <colspec colwidth='447pt' colname='c1' />
2220 <para> 'Feature' table:</para>
2226 Feature : 'feaFreelanceKeys'
2227 Feature Parent : 'feaClient'
2230 Attributes : 10</para>
2235 <para> 'Component' table:</para>
2241 Component : 'rcm_FreelanceKeys'
2242 ComponentId : '{4E3B3CBF4-9AE7-40C3-7B09-C48CF842C583}'
2243 Directory : 'TARGETDIR'
2245 KeyPath : 'reg_freekey0'</para>
2250 <para> 'FeatureComponents' table:</para>
2256 Feature : 'feaFreelanceKeys'
2257 Component : 'rcm_FreelanceKeys'</para>
2262 <para> 'Registry' table:</para>
2268 Registry : 'reg_freekey0'
2270 Key : 'SOFTWARE\OpenAFS\Client\Freelance'
2271 Component : 'rcm_FreelanceKeys'</para>
2277 Registry : 'reg_freekey1'
2279 Key : 'SOFTWARE\OpenAFS\Client\Freelance'
2281 Value : 'athena.mit.edu#athena.mit.edu:root.cell.'
2282 Component : 'rcm_FreelanceKeys'</para>
2288 Registry : 'reg_freekey2'
2290 Key : 'SOFTWARE\OpenAFS\Client\Freelance'
2292 Value : '.athena.mit.edu%athena.mit.edu:root.cell.'
2293 Component : 'rcm_FreelanceKeys'</para>
2299 Registry : 'reg_freekey3'
2301 Key : 'SOFTWARE\OpenAFS\Client\Freelance\Symlinks'
2302 Component : 'rcm_FreelanceKeys'</para>
2308 Registry : 'reg_freekey4'
2310 Key : 'SOFTWARE\OpenAFS\Client\Freelance\Symlinks'
2312 Value : 'athena:athena.mit.edu.'
2313 Component : 'rcm_FreelanceKeys'</para>
2319 Registry : 'reg_freekey5'
2321 Key : 'SOFTWARE\OpenAFS\Client\Freelance\Symlinks'
2323 Value : '.athena:.athena.mit.edu.'
2324 Component : 'rcm_FreelanceKeys'</para>
2330 <para>The example adds a read-only mountpoint to the athena.mit.edu cell's root.afs volume as well as a read-write mountpoint. Aliases are also provided using symlinks.
2335 <title id='Additional_Resources'>7.3 Additional Resources</title>
2336 <para>If you want to add registry keys or files you need to create new components and features for those. Refer to the Windows Platform SDK for details.</para>
2337 <para>It is beyond the scope of this document to provide a comprehensive overview of how to add new resources through a transform. Please refer to the "Windows Installer" documentation for details. The relevant section is at :</para>
2338 <para>http://msdn.microsoft.com/library/en-us/msi/setup/using_transforms_to_add_resources.asp</para>
2339 <para>A sample walkthrough of adding a new configuration file is in section 2.3.</para>
2340 <para>Add new features under the 'feaClient' or 'feaServer' as appropriate and set the 'Level' column for those features to equal the 'Level' for their parent features for consistency. Note that none of the features in the OpenAFS for Windows MSI package are designed to be installed to run from 'source' or 'advertised'. It is recommended that you set 'msidbFeatureAttributesFavorLocal' (0), 'msidbFeatureAttributesFollowParent' (2) and 'msidbFeatureAttributesDisallowAdvertise' (8) attributes for new features.</para>
2341 <para>If you are creating new components, retain the same component GUID when creating new transforms against new releases of the OpenAFS MSI package.</para>
2342 <para>After making the adjustments to the MSI database using ORCA.EXE you can generate a transform with MSITRAN.EXE as follows :</para>
2343 <para>(Modified MSI package is 'openafs-en_US_new.msi' and the original MSI package is 'openafs-en_US.msi'. Generates transform 'openafs-transform.mst')</para>
2344 <para> > msitran.exe -g openafs-en_US.msi openafs-en_US_new.msi openafs-transform.mst</para>
2345 <para>See the Platform SDK documentation for information on command line options for MSITRAN.EXE.</para>
2348 <title id='Upgrades'>7.4. Upgrades</title>
2349 <para>The MSI package is designed to uninstall previous versions of OpenAFS for Windows during installation. Note that it doesn't directly upgrade an existing installation. This is intentional and ensures that development releases which do not have strictly increasing version numbers are properly upgraded.</para>
2350 <para>Versions of OpenAFS that are upgraded by the MSI package are:</para>
2353 <para>OpenAFS MSI package</para>
2354 <para>Upgrade code {6823EEDD-84FC-4204-ABB3-A80D25779833}</para>
2355 <para>Up to current release</para>
2358 <para>MIT's Transarc AFS MSI package</para>
2359 <para>Upgrade code {5332B94F-DE38-4927-9EAB-51F4A64193A7}</para>
2360 <para>Up to version 3.6.2</para>
2363 <para>OpenAFS NSIS package</para>
2364 <para>All versions</para>
2367 <para>Note that versions of the OpenAFS NSIS package prior to 1.3.65 had a bug where it couldn't be uninstalled properly in unattended mode. Therefore the MSI package will not try to uninstall an OpenAFS NSIS package if running unattended. This means that group policy based deployments will fail on machines that have the OpenAFS NSIS package installed.</para>
2368 <para>If you have used a different MSI package to install OpenAFS and wish to upgrade it you can author rows into the 'Upgrade' table as described in the Platform SDK.</para>
2369 <para>When performing an upgrade with msiexec.exe execute the MSI with the repair options "vomus".</para>
2372 <chapter id='appendix_a' label='Appendix A'>
2373 <title id='Registry_Values'>Registry Values</title>
2375 <title id='Service_Parameters'>A.1. Service parameters</title>
2376 <para>The service parameters primarily affect the behavior of the AFS client service (afsd_service.exe).</para>
2378 <title id='Regkey_TransarcAFSDaemon_Parameters'>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</title>
2380 <indexterm><primary>LANadapter</primary></indexterm>
2381 <title id='Regkey_TransarcAFSDaemon_Parameters_LanAdapter'>Value: LanAdapter</title>
2382 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2383 <para>Type: DWORD</para>
2384 <para>Default: -1</para>
2385 <para>Variable: LANadapter</para>
2386 <para>LAN adapter number to use. This is the lana number of the LAN adapter that the SMB server should bind to. If unspecified or set to -1, a LAN adapter with named 'AFS' or a loopback adapter will be selected. If neither are present, then all available adapters will be bound to. When binding to a non-loopback adapter, the NetBIOS name hostname%-AFS' will be used (where %hostname% is the NetBIOS name of the host truncated to 11 characters). Otherwise, the NetBIOS name will be 'AFS'.</para>
2389 <indexterm><primary>CacheSize</primary></indexterm>
2390 <title id='Regkey_TransarcAFSDaemon_Parameters_CacheSize'><anchor id='Value_CacheSize' />Value: CacheSize</title>
2391 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2392 <para>Type: DWORD</para>
2393 <para>Default: 98304 (CM_CONFIGDEFAULT_CACHESIZE)</para>
2394 <para>Variable: cm_initParams.cacheSize</para>
2395 <para>Size of the AFS cache in 1k blocks.</para>
2398 <indexterm><primary>ChunkSize</primary></indexterm>
2399 <title id='Regkey_TransarcAFSDaemon_Parameters_ChunkSize'>Value: ChunkSize</title>
2400 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2401 <para>Type: DWORD</para>
2402 <para>Default: 20 (CM_CONFIGDEFAULT_CHUNKSIZE)</para>
2403 <para>Variable: cm_logChunkSize (cm_chunkSize = 1 << cm_logChunkSize)</para>
2404 <para>Size of chunk for reading and writing. Actual chunk size is 2^cm_logChunkSize. The default chunk size is therefore 1 MB.</para>
2407 <title id='Regkey_TransarcAFSDaemon_Parameters_Daemons'>Value: Daemons</title>
2409 <emphasis>Value: Daemons</emphasis>
2411 <para>Type: DWORD</para>
2412 <para>Default: 4 (CM_CONFIGDEFAULT_DAEMONS)</para>
2413 <para>Variable: numBkgD</para>
2414 <para>Number of background daemons (number of threads of cm_BkgDaemon). (see cm_BkgDaemon in cm_daemon.c)</para>
2419 <indexterm><primary>ServerThreads</primary></indexterm>
2420 <title id='Regkey_TransarcAFSDaemon_Parameters_ServerThreads'>Value: ServerThreads</title>
2421 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2422 <para>Type: DWORD</para>
2423 <para>Default: 25 (CM_CONFIGDEFAULT_SVTHREADS)</para>
2424 <para>Variable: numSvThreads</para>
2425 <para>Number of SMB server threads (number of threads of smb_Server). (see smb_Server in smb.c).</para>
2430 <indexterm><primary>Stats</primary></indexterm>
2431 <title id='Regkey_TransarcAFSDaemon_Parameters_Stats'>Value: Stats</title>
2432 <anchor id='Value_Stats' />
2433 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2434 <para>Type: DWORD</para>
2435 <para>Default: 10000 (CM_CONFIGDEFAULT_STATS)</para>
2436 <para>Variable: cm_initParams.nStatCaches</para>
2437 <para>Cache configuration.</para>
2442 <indexterm><primary>Volumes</primary></indexterm>
2443 <title id='Regkey_TransarcAFSDaemon_Parameters_Volumes'>Value: Volumes</title>
2444 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2449 Default: 3333 (CM_CONFIGDEFAULT_STATS/3)
2452 Variable: cm_initParams.nVolumes</para>
2454 <emphasis>Cache configuration.</emphasis>
2460 <indexterm><primary>Cells</primary></indexterm>
2461 <title id='Regkey_TransarcAFSDaemon_Parameters_Cells'>Value: Cells</title>
2462 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2466 Default: 1024 (CM_CONFIGDEFAULT_CELLS)
2469 Variable: cm_initParams.nCells</para>
2471 <emphasis>Cache configuration.</emphasis>
2477 <indexterm><primary>LogoffPreserveTokens</primary></indexterm>
2478 <title id='Regkey_TransarcAFSDaemon_Parameters_LogoffPreserveTokens'>Value: LogoffPreserveTokens</title>
2479 <anchor id='Value_LogoffPreserveTokens' />
2480 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2481 <para>Type: DWORD {1,0}
2485 <para>If enabled (set to 1), the Logoff Event handler will not attempt to delete the user's tokens if the user's profile is stored outside of AFS.</para>
2490 <indexterm><primary>RootVolume</primary></indexterm>
2491 <indexterm><primary>root.afs</primary></indexterm>
2492 <title id='Regkey_TransarcAFSDaemon_Parameters_RootVolume'>Value: RootVolume</title>
2493 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2500 Variable: cm_rootVolumeName</para>
2501 <para>Root volume name.</para>
2506 <indexterm><primary>MountRoot</primary></indexterm>
2507 <indexterm><primary>/afs</primary></indexterm>
2508 <title id='Regkey_TransarcAFSDaemon_Parameters_MountRoot'>Value: MountRoot</title>
2509 <anchor id='Value_Mountroot' />
2510 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2517 Variable: cm_mountRoot</para>
2518 <para>Name of root mount point. In symlinks, if a path starts with cm_mountRoot, it is assumed that the path is absolute (as opposed to relative) and is adjusted accordingly. Eg: if a path is specified as /afs/athena.mit.edu/foo/bar/baz and cm_mountRoot is "/afs", then the path is interpreted as \\afs\all\athena.mit.edu\foo\bar\baz. If a path does not start with with cm_mountRoot, the path is assumed to be relative and suffixed to the reference directory (i.e. directory where the symlink exists)</para>
2523 <indexterm><primary>CachePath</primary></indexterm>
2524 <indexterm><primary>AFSCache</primary></indexterm>
2525 <title id='Regkey_TransarcAFSDaemon_Parameters_CachePath'>Value: CachePath</title>
2526 <anchor id='Value_CachePath' />
2527 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2528 <para>Type: REG_SZ or REG_EXPAND_SZ
2531 Default: "%TEMP%\AFSCache"
2534 Variable: cm_CachePath</para>
2535 <para>Location of on-disk cache file. The default is the SYSTEM account's TEMP directory. The attributes assigned to the file are HIDDEN and SYSTEM.</para>
2540 <indexterm><primary>NonPersistentCaching</primary></indexterm>
2541 <title id='Regkey_TransarcAFSDaemon_Parameters_NonPersistentCaching'>Value: NonPersistentCaching</title>
2542 <anchor id='Value_NonPersistentCaching' />
2543 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2544 <para>Type: DWORD [0..1]
2550 Variable: buf_CacheType</para>
2551 <para>When this registry value is set to a non-zero value, the CachePath value is ignored and the cache data is stored in the windows paging file. This disables the use of persistent caching and the ability to maintain a single UUID for the AFS client service across restarts.</para>
2556 <indexterm><primary>ValidateCache</primary></indexterm>
2557 <title id='Regkey_TransarcAFSDaemon_Parameters_ValidateCache'>Value: ValidateCache</title>
2558 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2559 <para>Type: DWORD [0..2]
2565 Variable: buf_CacheType</para>
2566 <para>This value determines if and when persistent cache validation is performed.</para>
2569 <member>0 - Validation is disabled</member>
2570 <member>1 - Validation is performed at startup</member>
2571 <member>2 - Validation is performed at shutdown</member>
2578 <indexterm><primary>TrapOnPanic</primary></indexterm>
2579 <title id='Regkey_TransarcAFSDaemon_Parameters_TrapOnPanic'>Value: TrapOnPanic</title>
2580 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2581 <para>Type: DWORD {1,0}
2587 Variable: traceOnPanic</para>
2588 <para>Issues a breakpoint in the event of a panic. (breakpoint: _asm int 3).</para>
2593 <indexterm><primary>NetbiosName</primary></indexterm>
2594 <indexterm><primary>SMB Server Name</primary></indexterm>
2595 <indexterm><primary>\\AFS</primary></indexterm>
2596 <title id='Regkey_TransarcAFSDaemon_Parameters_NetbiosName'>Value: NetbiosName</title>
2597 <anchor id='Value_NetbiosName' />
2598 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2599 <para>Type: REG_EXPAND_SZ
2605 Variable: cm_NetbiosName</para>
2606 <para>Specifies the NetBIOS name to be used when binding to a Loopback adapter. To provide the old behavior specify a value of "%COMPUTERNAME%-AFS".</para>
2611 <indexterm><primary>IsGateway</primary></indexterm>
2612 <title id='Regkey_TransarcAFSDaemon_Parameters_IsGateway'>Value: IsGateway</title>
2613 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2614 <para>Type: DWORD {1,0}
2620 Variable: isGateway</para>
2621 <para>Select whether or not this AFS client should act as a gateway. If set and the NetBIOS name hostname-AFS is bound to a physical NIC, other machines in the subnet can access AFS via SMB connections to hostname-AFS.</para>
2622 <para>When IsGateway is non-zero, the LAN adapter detection code will avoid binding to a loopback adapter. This will ensure that the NetBIOS name will be of the form hostname-AFS instead of the value set by the "NetbiosName" registry value.</para>
2627 <indexterm><primary>ReportSessionStartups</primary></indexterm>
2628 <title id='Regkey_TransarcAFSDaemon_Parameters_ReportSessionStartups'>Value: ReportSessionStartups</title>
2629 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2630 <para>Type: DWORD {1,0}
2636 Variable: reportSessionStartups</para>
2637 <para>If enabled, all SMB sessions created are recorded in the Application event log. This also enables other events such as drive mappings or various error types to be logged.</para>
2642 <indexterm><primary>TraceBufferSize</primary></indexterm>
2643 <title id='Regkey_TransarcAFSDaemon_Parameters_TraceBufferSize'>Value: TraceBufferSize</title>
2644 <anchor id='Value_TraceBufferSize' />
2645 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2649 Default: 10000 (CM_CONFIGDEFAULT_TRACEBUFSIZE)
2652 Variable: traceBufSize</para>
2653 <para>Number of entries to keep in trace log.</para>
2658 <indexterm><primary>SysName</primary></indexterm>
2659 <title id='Regkey_TransarcAFSDaemon_Parameters_SysName'>Value: SysName</title>
2660 <anchor id='Value_SysName' />
2661 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2665 Default: "x86_win32 i386_w2k i386_nt40" (X86)
2668 "amd64_win64 x86_win32 i386_w2k" (AMD64)
2671 Variable: cm_sysName</para>
2672 <para>Provides an initial value for "fs sysname". The string can contain one or more replacement values for @sys in order of preference separated by whitespace.</para>
2677 <indexterm><primary>SecurityLevel</primary></indexterm>
2678 <indexterm><primary>fs setcrypt</primary></indexterm>
2679 <title id='Regkey_TransarcAFSDaemon_Parameters_SecurityLevel'>Value: SecurityLevel</title>
2680 <anchor id='Value_SecurityLevel' />
2681 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2682 <para>Type: DWORD {1,0}
2688 Variable: cryptall</para>
2689 <para>Enables encryption on RX calls.</para>
2694 <indexterm><primary>UseDNS</primary></indexterm>
2695 <indexterm><primary>AFSDB DNS records</primary></indexterm>
2696 <indexterm><primary>SRV DNS records</primary></indexterm>
2697 <title id='Regkey_TransarcAFSDaemon_Parameters_UseDNS'>Value: UseDNS</title>
2698 <anchor id='Value_UseDNS' />
2699 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2700 <para>Type: DWORD {1,0}
2706 Variable: cm_dnsEnabled</para>
2707 <para>Enables resolving volservers using AFSDB DNS and SRV DNS queries.</para>
2712 <indexterm><primary>FreelanceClient</primary></indexterm>
2713 <indexterm><primary>dynroot</primary></indexterm>
2714 <title id='Regkey_TransarcAFSDaemon_Parameters_FreelanceClient'>Value: FreelanceClient</title>
2715 <anchor id='Value_FreelanceClient' />
2716 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2717 <para>Type: DWORD {1,0}
2723 Variable: cm_freelanceEnabled</para>
2724 <para>Enables freelance client.</para>
2729 <indexterm><primary>HideDotFiles</primary></indexterm>
2730 <title id='Regkey_TransarcAFSDaemon_Parameters_HideDotFiles'>Value: HideDotFiles</title>
2731 <anchor id='Value_HideDotFiles' />
2732 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2733 <para>Type: DWORD {1,0}
2739 Variable: smb_hideDotFiles</para>
2740 <para>Enables marking dotfiles with the hidden attribute. Dot files are files whose name starts with a period (excluding "." and "..").</para>
2745 <indexterm><primary>MaxMpxRequests</primary></indexterm>
2746 <title id='Regkey_TransarcAFSDaemon_Parameters_MaxMpxRequests'>Value: MaxMpxRequests</title>
2747 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2754 Variable: smb_maxMpxRequests</para>
2755 <para>Maximum number of multiplexed SMB requests that can be made.</para>
2760 <indexterm><primary>MaxVCPerServer</primary></indexterm>
2761 <title id='Regkey_TransarcAFSDaemon_Parameters_MaxVCPerServer'>Value: MaxVCPerServer</title>
2762 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2769 Variable: smb_maxVCPerServer</para>
2770 <para>Maximum number of SMB virtual circuits.</para>
2775 <indexterm><primary>Cell</primary></indexterm>
2776 <indexterm><primary>workstation cell name</primary></indexterm>
2777 <title id='Regkey_TransarcAFSDaemon_Parameters_Cell'>Value: Cell</title>
2778 <anchor id='Value_Cell' />
2779 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2783 Default: <none>
2786 Variable: rootCellName</para>
2787 <para>Name of root cell (the cell from which root.afs should be mounted in \\afs\all).</para>
2792 <indexterm><primary>RxEnablePeerStats</primary></indexterm>
2793 <title id='Regkey_TransarcAFSDaemon_Parameters_RxEnablePeerStats'>Value: RxEnablePeerStats</title>
2794 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2795 <para>Type: DWORD {0, 1}
2801 Variable: rx_enable_peer_stats</para>
2802 <para>When set to 1, the Rx library collects peer statistics.</para>
2808 <indexterm><primary>RxEnableProcessStats</primary></indexterm>
2809 <title id='Regkey_TransarcAFSDaemon_Parameters_RxEnableProcessStats'>Value: RxEnableProcessStats</title>
2810 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2811 <para>Type: DWORD {0, 1}
2817 Variable: rx_extra_process_stats</para>
2818 <para>When set to 1, the Rx library collects process statistics.</para>
2824 <indexterm><primary>RxExtraPackets</primary></indexterm>
2825 <title id='Regkey_TransarcAFSDaemon_Parameters_RxExtraPackets'>Value: RxExtraPackets</title>
2826 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2833 Variable: rx_extraPackets</para>
2834 <para>When set, this number of extra Rx packets are allocated at startup.</para>
2839 <indexterm><primary>RxMaxMTU</primary></indexterm>
2840 <title id='Regkey_TransarcAFSDaemon_Parameters_RxMaxMTU'>Value: RxMaxMTU</title>
2841 <anchor id='Value_RxMaxMTU' />
2842 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2849 Variable: rx_mtu</para>
2850 <para>If set to anything other than 0, that value is used as the maximum send and receive MTU supported by the RX interface.</para>
2851 <para>In order to enable OpenAFS to operate across releases of the Cisco IPSec VPN client prior than 5.0, this value must be set to 1264 or smaller.</para>
2856 <indexterm><primary>RxNoJumbo</primary></indexterm>
2857 <title id='Regkey_TransarcAFSDaemon_Parameters_RxNoJumbo'>Value: RxNoJumbo</title>
2858 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2859 <para>Type: DWORD {0,1}
2865 Variable: rx_nojumbo</para>
2866 <para>If enabled, does not send or indicate that we are able to send or receive RX jumbograms.</para>
2871 <indexterm><primary>ConnDeadTimeout</primary></indexterm>
2872 <title id='Regkey_TransarcAFSDaemon_Parameters_ConnDeadTimeout'>Value: ConnDeadTimeout</title>
2873 <anchor id='Value_ConnDeadTimeout' />
2874 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2878 Default: 0 (seconds)
2881 Variable: ConnDeadtimeout</para>
2882 <para>When the value is 0, this setting is configured to be one-half the HardDeadTimeout value.</para>
2887 <indexterm><primary>HardDeadTimeout</primary></indexterm>
2888 <title id='Regkey_TransarcAFSDaemon_Parameters_HardDeadTimeout'>Value: HardDeadTimeout</title>
2889 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2893 Default: 0 (seconds)
2896 Variable: HardDeadtimeout</para>
2897 <para>The Hard Dead Time is enforced to be at least double the ConnDeadTimeout. The provides an opportunity for at least one retry. </para>
2898 <para>The value 0 seconds means that the real timeout should be set to be equal to the minimum SMB timeout which can be configured in the registry at: </para>
2900 <para> [HKLM\SYSTEM\CurrentControlSet\Services\lanmanworkstation\parameters]</para>
2901 <para> SessTimeout</para>
2903 <para>If the minimum SMB timeout is not specified the value is 45 seconds. See
2904 <ulink url='http://support.microsoft.com/support/kb/articles/Q102/0/67.asp'>http://support.microsoft.com:80/support/kb/articles/Q102/0/67.asp</ulink>
2910 <indexterm><primary>TraceOption</primary></indexterm>
2911 <title id='Regkey_TransarcAFSDaemon_Parameters_TraceOption'>Value: TraceOption</title>
2912 <anchor id='Value_TraceOption' />
2913 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2914 <para>Type: DWORD {0-15}
2918 <para>Enables logging of debug output to the Windows Event Log.</para>
2919 <para>Bit 0 enables logging of "Logon Events" processed by the Network Provider and Winlogon Event Notification Handler. </para>
2920 <para>Bit 1 enables logging of events captured by the AFS Client Service.</para>
2921 <para>Bit 2 enables real-time viewing of "fs trace" logging with DbgView or similar tools.</para>
2922 <para>Bit 3 enables "fs trace" logging on startup.</para>
2927 <indexterm><primary>AllSubmount</primary></indexterm>
2928 <title id='Regkey_TransarcAFSDaemon_Parameters_AllSubmount'>Value: AllSubmount</title>
2929 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2930 <para>Type: DWORD {0, 1}
2934 <para>Variable: allSubmount (smb.c)</para>
2935 <para>By setting this value to 0, the "\\NetbiosName\all" mount point will not be created. This allows the read-write versions of root.afs to be hidden.</para>
2940 <indexterm><primary>NoFindLanaByName</primary></indexterm>
2941 <title id='Regkey_TransarcAFSDaemon_Parameters_NoFindLanaByName'>Value: NoFindLanaByName</title>
2942 <anchor id='Value_NoFindLanaByName' />
2943 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2944 <para>Type: DWORD {0, 1}
2948 <para>Disables the attempt to identity the network adapter to use by looking for an adapter with a display name of "AFS".</para>
2953 <indexterm><primary>MaxCPUs</primary></indexterm>
2954 <title id='Regkey_TransarcAFSDaemon_Parameters_MaxCPUs'>Value: MaxCPUs</title>
2955 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2956 <para>Type: DWORD {1..32} or {1..64} depending on the architecture
2959 Default: <no default></para>
2960 <para>If this value is specified, afsd_service.exe will restrict itself to executing on the specified number of CPUs if there are a greater number installed in the machine. </para>
2965 <indexterm><primary>SMBAuthType</primary></indexterm>
2966 <title id='Regkey_TransarcAFSDaemon_Parameters_SmbAuthType'>Value: SmbAuthType</title>
2967 <anchor id='Value_smbAuthType' />
2968 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2969 <para>Type: DWORD {0..2}
2973 <para>If this value is specified, it defines the type of SMB authentication which must be present in order for the Windows SMB client to connect to the AFS Client Service's SMB server. The values are:</para>
2974 <para>0 = No authentication required
2979 1 = NTLM authentication required
2982 2 = Extended (GSS SPNEGO) authentication required
2987 The default is Extended authentication</para>
2992 <indexterm><primary>MaxLogSize</primary></indexterm>
2993 <title id='Regkey_TransarcAFSDaemon_Parameters_MaxLogSize'>Value: MaxLogSize</title>
2994 <anchor id='Value_MaxLogSize' />
2995 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
2996 <para>Type: DWORD {0 .. MAXDWORD}
2999 Default: 100K</para>
3000 <para>This entry determines the maximum size of the %WINDIR%\TEMP\afsd_init.log file. If the file is larger than this value when afsd_service.exe starts the file will be reset to 0 bytes. If this value is 0, it means the file should be allowed to grow indefinitely.</para>
3005 <indexterm><primary>FlushOnHibernate</primary></indexterm>
3006 <title id='Regkey_TransarcAFSDaemon_Parameters_FlushOnHibernate'>Value: FlushOnHibernate</title>
3007 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
3008 <para>Type: DWORD {0,1}
3012 <para>If set, flushes all volumes before the machine goes on hibernate or stand-by.</para>
3017 <indexterm><primary>DaemonCheckDownInterval</primary></indexterm>
3018 <title id='Regkey_TransarcAFSDaemon_Parameters_DaemonCheckDownInterval'>Value: DaemonCheckDownInterval</title>
3019 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
3020 <para>Type: DWORD (seconds)
3024 <para>This value controls how frequently the AFS cache manager probes servers that are marked as "down".</para>
3029 <indexterm><primary>DaemonCheckUpInterval</primary></indexterm>
3030 <title id='Regkey_TransarcAFSDaemon_Parameters_DaemonCheckUpInterval'>Value: DaemonCheckUpInterval</title>
3031 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
3032 <para>Type: DWORD (seconds)
3036 <para>This value controls how frequently the AFS cache manager probes servers that are marked as "up".</para>
3041 <indexterm><primary>DaemonCheckVolInterval</primary></indexterm>
3042 <title id='Regkey_TransarcAFSDaemon_Parameters_DaemonCheckVolInterval'>Value: DaemonCheckVolInterval</title>
3043 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
3044 <para>Type: DWORD (seconds)
3047 Default: 3600</para>
3048 <para>This value controls how frequently the AFS cache manager forces a reset on the existing volume database information.</para>
3053 <indexterm><primary>DaemonCheckCBInterval</primary></indexterm>
3054 <title id='Regkey_TransarcAFSDaemon_Parameters_DaemonCheckCBInterval'>Value: DaemonCheckCBInterval</title>
3055 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
3056 <para>Type: DWORD (seconds)
3060 <para>This value controls how frequently the AFS cache manager checks for callback invalidation.</para>
3065 <indexterm><primary>DaemonCheckLockInterval</primary></indexterm>
3066 <title id='Regkey_TransarcAFSDaemon_Parameters_DaemonCheckLockInterval'>Value: DaemonCheckLockInterval</title>
3067 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
3068 <para>Type: DWORD (seconds)
3072 <para>This value controls how frequently the AFS cache manager checks for invalid file locks.</para>
3077 <indexterm><primary>DaemonCheckTokenInterval</primary></indexterm>
3078 <title id='Regkey_TransarcAFSDaemon_Parameters_DaemonCheckTokenInterval'>Value: DaemonCheckTokenInterval</title>
3079 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
3080 <para>Type: DWORD (seconds)
3084 <para>This value controls how frequently the AFS cache manager checks for expired tokens.</para>
3089 <indexterm><primary>DaemonCheckOfflineVolInterval</primary></indexterm>
3090 <title id='Regkey_TransarcAFSDaemon_Parameters_DaemonCheckOfflineVolInterval'>Value: DaemonCheckOfflineVolInterval</title>
3091 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
3092 <para>Type: DWORD (seconds)
3096 <para>This value controls how frequently the AFS cache manager checks offline volumes to see if they have come back online. At the same time volumes which were determined to be busy have their state reset to online.</para>
3101 <indexterm><primary>CallBackPort</primary></indexterm>
3102 <indexterm><primary>port 7001/udp</primary></indexterm>
3103 <title id='Regkey_TransarcAFSDaemon_Parameters_CallBackPort'>Value: CallBackPort</title>
3104 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
3108 Default: 7001</para>
3109 <para>This value specifies which port number should be used for receiving callbacks from the file server. The standard AFS Callback port is 7001. Alternative values can be useful if the client is behind a NAT and a permanent port mapping for the client is being configured.</para>
3114 <indexterm><primary>EnableServerLocks</primary></indexterm>
3115 <title id='Regkey_TransarcAFSDaemon_Parameters_EnableServerLocks'>Value: EnableServerLocks</title>
3116 <anchor id='Value_EnableServerLocks' />
3117 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
3118 <para>Type: DWORD {0, 1, 2}
3122 <para>Determines whether or not the AFS file server is contacted for </para>
3123 <para>0: never obtain server locks</para>
3124 <para>1: obtain server locks unless the file server says not to</para>
3125 <para>2: always obtain server locks</para>
3130 <indexterm><primary>DeleteReadOnly</primary></indexterm>
3131 <title id='Regkey_TransarcAFSDaemon_Parameters_DeleteReadOnly'>Value: DeleteReadOnly</title>
3132 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
3133 <para>Type: DWORD {0, 1}
3137 <para>Determines whether or not the AFS Cache Manager will permit files marked with the "Read Only" DOS attribute to be deleted or not. For compatibility with Explorer, the default is ‘no’.</para>
3138 <para>0: do not permit "Read Only" files to be deleted.</para>
3139 <para>1: delete files that have the "Read Only" attribute set without complaint.</para>
3144 <indexterm><primary>BPlusTrees</primary></indexterm>
3145 <title id='Regkey_TransarcAFSDaemon_Parameters_BPlusTrees'>Value: BPlusTrees</title>
3146 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
3147 <para>Type: DWORD {0, 1}
3151 <para>Determines whether or not the AFS Cache Manager uses locally constructed B+ Trees to speed up the performance of directory searches. </para>
3152 <para>0: do not use B+ Trees for directory lookups</para>
3153 <para>1: use B+ Trees for directory lookups</para>
3158 <indexterm><primary>PrefetchExecutableExtensions</primary></indexterm>
3159 <title id='Regkey_TransarcAFSDaemon_Parameters_PrefetchExecutableExtensions'>Value: PrefetchExecutableExtensions</title>
3160 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
3161 <para>Type: MULTI_SZ
3164 Default: none specified</para>
3165 <para>The AFS Cache Manager will pre-fetch the entire contents of any file whose name matches ends with one of the specified extensions. This option is intended for use primarily with executables and dynamic link libraries that should be fully cached prior to a machine losing its connection with the file server.</para>
3170 <indexterm><primary>OfflineReadOnlyIsValid</primary></indexterm>
3171 <title id='Regkey_TransarcAFSDaemon_Parameters_OfflineReadOnlyIsValid'>Value: OfflineReadOnlyIsValid</title>
3172 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
3173 <para>Type: DWORD {0, 1}
3177 <para>Determines whether or not cached data from .readonly volumes is considered valid even if a callback cannot be registered with a file server. This option is meant to be used by organizations for whom .readonly volume content very rarely changes (if ever.)</para>
3178 <para>0: do not treat offline .readonly content as valid</para>
3179 <para>1: treat offline .readonly content as valid</para>
3184 <indexterm><primary>GiveUpAllCallBacks</primary></indexterm>
3185 <title id='Regkey_TransarcAFSDaemon_Parameters_GiveUpAllCallBacks'>Value: GiveUpAllCallBacks</title>
3186 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
3187 <para>Type: DWORD {0, 1}
3191 <para>Determines whether or not the AFS Cache Manager will give up all callbacks prior to the service being suspended or shutdown. Doing so will have significant performance benefits for the file servers. However, file servers older than 1.4.6 can become unstable if the GiveUpAllCallBacks RPC is executed.</para>
3192 <para>0: do not perform GiveUpAllCallBacks RPCs</para>
3193 <para>1: perform GiveUpAllCallBacks RPCs </para>
3198 <indexterm><primary>FollowBackupPath</primary></indexterm>
3199 <title id='Regkey_TransarcAFSDaemon_Parameters_FollowBackupPath'>Value: FollowBackupPath</title>
3200 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
3201 <para>Type: DWORD {0, 1}
3205 <para>Determines whether or not the AFS Cache Manager will give preference to .backup volumes when following mount points that originate in a .backup volume.</para>
3206 <para>0: do not prefer .backup volumes when the mount point originates in a .backup volume.</para>
3207 <para>1: prefer .backup volumes when the mount point originates in a .backup volume.</para>
3212 <indexterm><primary>RxUdpBufSize</primary></indexterm>
3213 <title id='Regkey_TransarcAFSDaemon_Parameters_RxUdpBufSize'>Value: RxUdpBufSize</title>
3214 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
3215 <para>Type: DWORD {bytes}
3218 Default: 262144</para>
3219 <para>Specifies the UDP socket receive and send buffer sizes..</para>
3223 <indexterm><primary>GlobalAutoMapper</primary></indexterm>
3224 <title id='Regkey_TransarcAFSDaemon_Parameters_GlobalAutoMapper'>Regkey:
3225 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters\GlobalAutoMapper]</title>
3227 <title id='Regkey_TransarcAFSDaemon_Parameters_GlobalAutoMapper_DriveLetter'>Value: <DriveLetter></title>
3228 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters\GlobalAutoMapper]</para>
3229 <para>Type: REG_SZ</para>
3230 <para>Specifies the submount name to be mapped by afsd_service.exe at startup to the provided drive letter.</para>
3232 <emphasis>This option is deprecated.</emphasis>
3237 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client'>Regkey: [HKLM\SOFTWARE\OpenAFS\Client]</title>
3239 <indexterm><primary>CellServDB</primary></indexterm>
3240 <indexterm><primary>CellServDBDir</primary></indexterm>
3241 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_CellServDBDir'>Value: CellServDBDir</title>
3242 <anchor id='Value_CellServDBDir' />
3243 <para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client]</para>
3247 Default: <not defined></para>
3248 <para>Specifies the directory containing the CellServDB file. When this value is not specified, the ProgramData directory is searched and if the CellServDB file is not found, the AFS Client install directory is used.</para>
3253 <indexterm><primary>VerifyServiceSignature</primary></indexterm>
3254 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_VerifyServiceSignature'>Value: VerifyServiceSignature</title>
3255 <anchor id='Value_VerifyServiceSignature' />
3256 <para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client]</para>
3257 <para>Type: REG_DWORD
3261 <para>This value can be used to disable the runtime verification of the digital signatures applied to afsd_service.exe and the OpenAFS DLLs it loads. This test is performed to verify that the DLLs which are loaded by afsd_service.exe are from the same distribution as afsd_service.exe. This is to prevent random errors caused when DLLs from one distribution of AFS are loaded by another one. This is not a security test. The reason for disabling this test is to free up additional memory which can be used for a large cache size.</para>
3266 <indexterm><primary>IoctlDebug</primary></indexterm>
3267 <indexterm><primary>path ioctl debugging</primary></indexterm>
3268 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_IoctlDebug'>Value: IoctlDebug</title>
3269 <anchor id='Value_IoctlDebug' />
3270 <para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client]</para>
3271 <para>Type: REG_DWORD
3275 <para>This value can be used to debug the cause of pioctl() failures. Set a non-zero value and the pioctl() library will output status information to stdout. Executing command line tools such as tokens.exe, fs.exe, etc can then be used to determine why the pioctl() call is failing. </para>
3280 <indexterm><primary>minidumps</primary></indexterm>
3281 <indexterm><primary>MiniDumpType</primary></indexterm>
3282 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_MiniDumpType'>Value: MiniDumpType</title>
3283 <anchor id='Value_MiniDumpType' />
3284 <para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client]</para>
3285 <para>Type: REG_DWORD
3288 Default: 0x0 (MiniDumpNormal)</para>
3289 <para>This value is used to specify the type of minidump generated by afsd_service.exe either when the process crashes or when a user initiated is dump file is generated with the "fs.exe minidump" command.</para>
3290 <para>Valid values are dependent on the version of DbgHelp.dll installed on the machine. The best version to use is not the version that comes with the operating system but the version that is included in the most recent release of "
3291 <ulink url='http://www.microsoft.com/whdc/devtools/debugging/default.mspx'>Microsoft Debugging Tools for Windows</ulink>". See the Microsoft Developer Library for further information.
3293 <simplelist type='Vert'>
3295 MiniDumpNormal = 0x00000000
3298 MiniDumpWithDataSegs = 0x00000001
3301 MiniDumpWithFullMemory = 0x00000002
3304 MiniDumpWithHandleData = 0x00000004
3307 MiniDumpFilterMemory = 0x00000008
3310 MiniDumpScanMemory = 0x00000010
3313 MiniDumpWithUnloadedModules = 0x00000020
3316 MiniDumpWithIndirectlyReferencedMemory = 0x00000040
3319 MiniDumpFilterModulePaths = 0x00000080
3322 MiniDumpWithProcessThreadData = 0x00000100
3325 MiniDumpWithPrivateReadWriteMemory = 0x00000200
3328 MiniDumpWithoutOptionalData = 0x00000400
3331 MiniDumpWithFullMemoryInfo = 0x00000800
3334 MiniDumpWithThreadInfo = 0x00001000
3337 MiniDumpWithCodeSegs = 0x00002000
3344 <indexterm><primary>EnableSMBAsyncStore</primary></indexterm>
3345 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_EnableSMBAsyncStore'>Value: EnableSMBAsyncStore</title>
3346 <anchor id='Value_EnableSMBAsyncStore' />
3347 <para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client]</para>
3348 <para>Type: REG_DWORD
3352 <para>This value can be used to disable the use of SMB Asynchronous Store operations. </para>
3357 <indexterm><primary>SMBAsyncStoreSize</primary></indexterm>
3358 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_SMBAsyncStoreSize'>Value: SMBAsyncStoreSize</title>
3359 <anchor id='Value_SMBAsyncStoreSize' />
3360 <para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client]</para>
3361 <para>Type: REG_DWORD
3365 <para>This value determines the size of SMB Asynchronous Store operations. This value can be used to increase the write performance on higher speed networks by increasing the value. The value must be a multiple of the cache buffer block size and cannot be larger than the cache manager chunk size. The specified value will be adjusted to enforce its compliance with these restrictions.</para>
3370 <indexterm><primary>StoreAnsiFilenames</primary></indexterm>
3371 <indexterm><primary>Unicode</primary></indexterm>
3372 <indexterm><primary>character sets</primary></indexterm>
3373 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_StoreAnsiFilenames'>Value: StoreAnsiFilenames</title>
3374 <anchor id='Value_StoreAnsiFilenames' />
3375 <para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client]</para>
3376 <para>Type: REG_DWORD
3380 <para>This value can be used to force the AFS Client Service to store filenames using the Windows system's ANSI character set instead of the OEM Code Page character set which has traditionally been used by SMB file systems. </para>
3381 <para>Note: The use of ANSI characters will render access to files with 8-bit OEM file names inaccessible from Windows. This option is of use primarily when you wish to allow file names produced on Windows to be accessible from Latin-1 UNIX systems and vice versa.</para>
3382 <para>This value is ignored now that all file names are processed as Unicode and stored on the file server as UTF-8.</para>
3387 <indexterm><primary>CSCPolicy</primary></indexterm>
3388 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_CSCPolicy'>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\CSCPolicy]</title>
3390 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_CSCPolicy_'>Value: <smb share name></title>
3391 <para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\CSCPolicy]</para>
3395 Default: <none></para>
3396 <para>This key is used to map SMB/CIFS shares to Client Side Caching (off-line access) policies. For each share one of the following policies may be used: "manual", "programs", "documents", "disable". </para>
3397 <para>These values used to be stored in afsdsbmt.ini</para>
3402 <indexterm><primary>CellServDB</primary></indexterm>
3403 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_CellServDB'>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\CellServDB]</title>
3404 <para>The <emphasis>CellServDB</emphasis> key is an alternative to the <emphasis>CellServDB</emphasis> file that can be used either to supplement
3405 or override its contents. This registry entry is meant to provide organizations that centrally manage their client configurations using
3406 <emphasis>Active Directory Group Policy</emphasis> a means of updating records for individual cells or servers without pushing out a new file.
3408 <para>At the present time the <emphasis>CellServDB</emphasis> key contains no values; only subkeys. Each subkey is the name of a <emphasis>Cell</emphasis>. For example, <emphasis>grand.central.org</emphasis>.
3410 <para>Support for registry <emphasis>CellServDB</emphasis> configuration was added in 1.5.60.</para>
3414 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_CellServDB_Cell'>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\CellServDB\<cellname>]</title>
3415 <para>The actual name of the <emphasis><cellname></emphasis> key is the full name of the cell whose configuration is being specified. The <emphasis><cellname></emphasis> key contains both values and subkeys. Each subkey represents a single host name or IP address. When a host is to be known by more than one name or IP address, a separate subkey should be created for each.
3416 Unlike the <cellname> key name, the <server> key names do not have to be actual host names.</para>
3418 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_CellServDB_Cell_Description'>Value: Description</title>
3419 <para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\CellServDB\<Cell Name>]</para>
3422 <para>Default: <none></para>
3423 <para>This value is used to store a description of the Cell appropriate for display in end user facing tools.</para>
3428 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_CellServDB_Cell_ForceDNS'>Value: ForceDNS</title>
3429 <para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\CellServDB\<Cell Name>]</para>
3430 <para>Type: REG_DWORD</para>
3431 <para>Range: 0 or 1</para>
3432 <para>Default: 0 if <server> subkeys exist; 1 otherwise</para>
3433 <para>When set to 1 all server configuration provided in the registry or the <emphasis>CellServDB file</emphasis> is ignored and DNS AFSDB lookups are used instead.</para>
3438 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_CellServDB_Cell_LinkedCell'>Value: LinkedCell</title>
3439 <para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\CellServDB\<Cell Name>]</para>
3442 <para>Default: <none></para>
3443 <para>This value names an alternative cell to which this cell should be linked. When two cells are linked by the OpenAFS client, volume lookups that fail in the specified cell will be searched for in the linked cell
3444 and when tokens are requested for one of the cells they will be obtained for both.
3445 This functionality can be used for example to develop a test cell that is equivalent to a production cell with the exception that it substitutes test versions of volumes
3446 for the production versions. Another use is to assist in the transition from one cell name to another.</para>
3447 <para>See also: <link linkend="Linked_Cells">Linked Cells</link>.</para>
3453 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_CellServDB_Cell_Server'>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\CellServDB\<cellname>\<server>]</title>
3454 <para>The actual name of the <emphasis><server></emphasis> key may be a fully qualified domain name of the server whose configuration is being specified.
3455 If a domain name is specified as the key name, all values become optional.
3458 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_CellServDB_Cell_Server_HostName'>Value: HostName</title>
3460 <para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\CellServDB\<Cell Name>\<Server>]</para>
3462 <para>Default: <none></para>
3463 <para>This value is used to specify a fully qualified domain name appropriate that matches either a DNS A or DNS CNAME record. If provided, this value supercedes
3464 the name of the <server> key. It is recommended that the value of this field be terminated with a period in order to avoid the use of domain substitution
3465 during the gethostbyname() evaluation.
3471 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_CellServDB_Cell_Server_IPv4Address'>Value: IPv4Address</title>
3472 <para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\CellServDB\<Cell Name>\<Server>]</para>
3473 <para>Type: REG_SZ</para>
3474 <para>Default: <none></para>
3475 <para>If the DNS host name lookup fails this value will be used as the IPv4 address for the server.</para>
3480 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_CellServDB_Cell_Server_Rank'>Value: Rank</title>
3481 <para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\CellServDB\<Cell Name>\<Server>]</para>
3482 <para>Type: REG_DWORD
3484 <para>Range: 0..65535</para>
3485 <para>Default: 0</para>
3486 <para>This value specifies the default server preference. A value of 0 indicates that no preference has been specified. When non-zero values
3487 are specified lower values indicate a stronger preference than higher values.</para>
3492 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_CellServDB_Cell_Server_Comment'>Value: Comment</title>
3493 <para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\CellServDB\<Cell Name>\<Server>]</para>
3494 <para>Type: REG_SZ</para>
3495 <para>Default: <none></para>
3496 <para>A text string that can be displayed to end users to describe the server.</para>
3501 <indexterm><primary>Freelance</primary></indexterm>
3502 <indexterm><primary>Freelance Mount Points</primary></indexterm>
3503 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_Freelance'>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\Freelance]</title>
3505 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_Freelance_NumericValue'>Value: <numeric value></title>
3506 <para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\Freelance]</para>
3510 Default: <none></para>
3511 <para>This key is used to store dot terminated mount point strings for use in constructing the fake root.afs volume when Freelance (dynamic roots) mode is activated.</para>
3512 <para>"athena.mit.edu#athena.mit.edu:root.cell."</para>
3513 <para>".athena.mit.edu%athena.mit.edu:root.cell."</para>
3514 <para>These values used to be stored in afs_freelance.ini</para>
3518 <indexterm><primary>Freelance Symlinks</primary></indexterm>
3519 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_Freelance_Symlinks'>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\Freelance\Symlinks]</title>
3521 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_Freelance_Symlinks_NumericValue'>Value: <numeric value></title>
3522 <para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\Freelance\Symlinks]</para>
3526 Default: <none></para>
3527 <para>This key is used to store a dot terminated symlink strings for use in constructing the fake root.afs volume when Freelance (dynamic roots) mode is activated.</para>
3528 <para>"linkname:destination-path."</para>
3529 <para>"athena:athena.mit.edu."</para>
3530 <para>"home:athena.mit.edu\user\j\a\jaltman."</para>
3531 <para>"filename:path\file."</para>
3535 <indexterm><primary>Realms</primary></indexterm>
3536 <indexterm><primary>network identity manager</primary></indexterm>
3537 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_Realms'>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\Realms]</title>
3538 <para>The Realms key is used to provide initialization data to be used when new identities are added to the Network Identity Manager. The AFS Provider will search for a subkey that matches the realm of the identity. If such a key exists, its values will be used to populate the AFS configuration for the identity.</para>
3541 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_Realms_RealmName'>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\Realms\"Realm Name"]</title>
3542 <para>In addition to the optional values, this key contains one subkey for each cell that is to be added to the AFS Provider configuration. </para>
3544 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_Realms_RealmName_AFSEnabled'>Value: AFSEnabled</title>
3545 <para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\Realms\<Realm Name>]</para>
3546 <para>Type: REG_DWORD
3549 Default: 0x01</para>
3550 <para>This key is used to specify whether the new identity should be configured to obtain AFS credentials. In general, it is only specified when disabling the acquisition of AFS credentials is desired. The default is to obtain AFS credentials.</para>
3554 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_Realms_RealmName_CellName'>Regkey:
3555 [HKLM\SOFTWARE\OpenAFS\Client\Realms\"Realm Name"\"Cell Name"]</title>
3557 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_Realms_RealmName_CellName_MethodName'>Value: MethodName</title>
3558 <para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\Realms\<Realm Name>\<Cell Name>]</para>
3562 Default: <none></para>
3563 <para>This key is used to specify the token acquisition method to be used. When unspecified, the AFS provider will automatically try Kerberos v5 and then Kerberos v5 (if available). As of this writing valid method names include "Auto", "Kerberos5", "Kerberos524", "Kerberos4".</para>
3564 <para>Note: Kerberos524 and Kerberos4 cannot be used with 64-bit Kerberos for Windows.</para>
3569 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_Realms_RealmName_CellName_Realm'>Value: Realm</title>
3570 <para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\Realms\<Realm Name>\<Cell Name>]</para>
3574 Default: <none></para>
3575 <para>This key is used to specify the realm to be used when acquiring AFS tokens. If not specified, the realm will be determined by performing a domain to realm mapping on the domain of a random volume location database server for the cell.</para>
3580 <indexterm><primary>Submounts</primary></indexterm>
3581 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_Submounts'>Regkey:
3582 [HKLM\SOFTWARE\OpenAFS\Client\Submounts]</title>
3584 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_Submounts_SubmountName'>Value: <Submount Name></title>
3585 <para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\Submounts]</para>
3586 <para>Type: REG_EXPAND_SZ
3589 Default: <none></para>
3590 <para>This key is used to store mappings of UNIX style AFS paths to submount names which can be referenced as UNC paths. For example the submount string "/athena.mit.edu/user/j/a/jaltman" can be associated with the submount name "jaltman.home". This can then be referenced as the UNC path \\AFS\jaltman.home.</para>
3591 <para>These values used to be stored in afsdsbmt.ini</para>
3592 <para>NOTE: Submounts should no longer be used with OpenAFS. Use the Windows Explorer to create drive mappings to AFS UNC paths instead of using the AFS Submount mechanism.</para>
3597 <indexterm><primary>Server Preferences</primary></indexterm>
3598 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_ServerPreferences_VLDB'>Regkey:
3599 [HKLM\SOFTWARE\OpenAFS\Client\Server Preferences\VLDB]</title>
3601 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_ServerPreferences_VLDB_HostName'>Value: <hostname or ip address></title>
3602 <para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\Server Preferences\VLDB]</para>
3603 <para>Type: REG_DWORD
3606 Default: <none></para>
3607 <para>This key is used to specify a default set of VLDB server preferences. For each entry the value name will be either the IP address of a server or a fully qualified domain name. The value will be the ranking. The ranking will be adjusted by a random value between 0 and 15 prior to the preference being set.</para>
3611 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_ServerPreferences_File'>Regkey:
3612 [HKLM\SOFTWARE\OpenAFS\Client\Server Preferences\File]</title>
3614 <title id='Regkey_HKLM_SOFTWARE_OpenAFS_Client_ServerPreferences_File_HostName'>Value: <hostname or ip address></title>
3615 <para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\Server Preferences\File]</para>
3616 <para>Type: REG_DWORD
3619 Default: <none></para>
3620 <para>This key is used to specify a default set of File server preferences. For each entry the value name will be either the IP address of a server or a fully qualified domain name. The value will be the ranking. The ranking will be adjusted by a random value between 0 and 15 prior to the preference being set.</para>
3625 <indexterm><primary>integrated logon</primary></indexterm>
3626 <title id='Integrated_Logon_Parameters'>A.2. Integrated Logon Network Provider Parameters</title>
3627 <para>Affects the network provider (afslogon.dll).</para>
3629 <title id='NP_Regkey_TransarcAFSDaemon_Parameters'>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</title>
3631 <indexterm><primary>FailLoginsSilently</primary></indexterm>
3632 <title id='NP_Regkey_TransarcAFSDaemon_Parameters_FailLoginsSilently'>Value: FailLoginsSilently</title>
3633 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
3638 <para>Do not display message boxes if the login fails.</para>
3642 <title id='NP_Regkey_TransarcAFSDaemon_NetworkProvider'>Regkey:
3643 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]</title>
3645 <indexterm><primary>NoWarnings</primary></indexterm>
3646 <title id='NP_Regkey_TransarcAFSDaemon_NetworkProvider_NoWarnings'>Value: NoWarnings</title>
3647 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]</para>
3652 <para>Disables visible warnings during logon.</para>
3657 <indexterm><primary>AuthentProviderPath</primary></indexterm>
3658 <indexterm><primary>afslogon.dll</primary></indexterm>
3659 <title id='NP_Regkey_TransarcAFSDaemon_NetworkProvider_AuthentProviderPath'>Value: AuthentProviderPath</title>
3660 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]</para>
3664 NSIS: %WINDIR%\SYSTEM32\afslogon.dll</para>
3665 <para>Specifies the install location of the authentication provider dll.</para>
3670 <indexterm><primary>Class</primary></indexterm>
3671 <title id='NP_Regkey_TransarcAFSDaemon_NetworkProvider_Class'>Value: Class</title>
3672 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]</para>
3677 <para>Specifies the class of network provider</para>
3682 <indexterm><primary>DependOnGroup</primary></indexterm>
3683 <title id='NP_Regkey_TransarcAFSDaemon_NetworkProvider_DependOnGroup'>Value: DependOnGroup</title>
3684 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]</para>
3685 <para>Type: REG_MULTI_SZ
3688 NSIS: PNP_TDI</para>
3689 <para>Specifies the service groups upon which the AFS Client Service depends. Windows should not attempt to start the AFS Client Service until all of the services within these groups have successfully started.</para>
3694 <indexterm><primary>DependOnService</primary></indexterm>
3695 <title id='NP_Regkey_TransarcAFSDaemon_NetworkProvider_DependOnService'>Value: DependOnService</title>
3696 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]</para>
3697 <para>Type: REG_MULTI_SZ
3700 NSIS: Tcpip NETBIOS RpcSs</para>
3701 <para>Specifies a list of services upon which the AFS Client Service depends. Windows should not attempt to start the AFS Client Service until all of the specified services have successfully started.</para>
3706 <indexterm><primary>Name - network provider</primary></indexterm>
3707 <title id='NP_Regkey_TransarcAFSDaemon_NetworkProvider_Name'>Value: Name</title>
3708 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]</para>
3712 NSIS: "OpenAFSDaemon"</para>
3713 <para>Specifies the display name of the AFS Client Service</para>
3718 <indexterm><primary>ProviderPath</primary></indexterm>
3719 <indexterm><primary>afslogon.dll</primary></indexterm>
3720 <title id='NP_Regkey_TransarcAFSDaemon_NetworkProvider_ProviderPath'>Value: ProviderPath</title>
3721 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]</para>
3725 NSIS: %WINDIR%\SYSTEM32\afslogon.dll</para>
3726 <para>Specifies the DLL to use for the network provider</para>
3732 <indexterm><primary>domain logon configuration</primary></indexterm>
3733 <title id='Domain_Specific_Configuration'>A.2.1 Domain specific configuration keys for the Network Provider</title>
3734 <para>The network provider can be configured to have different behavior depending on the domain that the user logs into. These settings are only relevant when using integrated login. A domain refers to an Active Directory (AD) domain, a trusted Kerberos (non-AD) realm or the local machine (i.e. local account logins). The domain name that is used for selecting the domain would be the domain that is passed into the NPLogonNotify function of the network provider.</para>
3735 <para>Domain specific registry keys are:</para>
3737 <title id='Domain_Regkey_TransarcAFSDaemon_NetworkProvider'>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]</title>
3738 <para> (NP key)</para>
3741 <title id='Domain_Regkey_TransarcAFSDaemon_NetworkProvider_Domain'>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]</title>
3742 <para> (Domains key)</para>
3745 <title id='Domain_Regkey_TransarcAFSDaemon_NetworkProvider_Domain_DomainName'>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\"domain name"]</title>
3746 <para> (Specific domain key. One per domain.)</para>
3749 <title id='Domain_Regkey_TransarcAFSDaemon_NetworkProvider_Domain_LocalHost'>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]</title>
3750 <para> (Localhost key)</para>
3753 <title id='Domain_Example'>Domain Specific Example:</title>
3754 <para> HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider</para>
3756 <para> +- Domain</para>
3757 <para> +-AD1.EXAMPLE.COM</para>
3758 <para> +-AD2.EXAMPLE.NET</para>
3759 <para> +-LOCALHOST</para>
3760 <para>Each of the domain specific keys can have the set of values described in 2.1.1. The effective values are chosen as described in 2.1.2.</para>
3763 <title id='Domain_Specific_Configuration_Values'>A.2.1.1 Domain Specific Configuration Values</title>
3765 <title id='Domain_Specific_Regkeys'>Regkeys: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
3766 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]
3767 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\"domain name"]
3768 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]</title>
3770 <indexterm><primary>LogonOptions</primary></indexterm>
3771 <title id='Domain_Specific_Regkeys_LogonOptions'>Value: LogonOptions</title>
3772 <anchor id='Value_LogonOptions' />
3773 <para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]</para>
3774 <para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\<domain name>]</para>
3775 <para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]</para>
3779 Default: 0x01</para>
3780 <para>NSIS/WiX: depends on user configuration</para>
3783 <member>0x00 - Integrated Logon is not used
3786 0x01 - Integrated Logon is used
3789 0x02 - High Security Mode is used (deprecated)
3792 0x03 - Integrated Logon with High Security Mode is used (deprecated)
3796 <para>High Security Mode generates random SMB names for the creation of Drive Mappings. This mode should not be used without Integrated Logon.</para>
3797 <para>As of 1.3.65 the SMB server supports SMB authentication. The High Security Mode should not be used when using SMB authentication (SMBAuthType setting is non zero).</para>
3802 <indexterm><primary>FailLoginsSilently</primary></indexterm>
3803 <title id='Domain_Specific_Regkeys_FailLoginsSilently'>Value: FailLoginsSilently</title>
3804 <para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]</para>
3805 <para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\<domain name>]</para>
3806 <para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]</para>
3807 <para>Type: DWORD (1|0)
3813 NSIS/WiX: (not set)</para>
3814 <para>If true, does not display any visible warnings in the event of an error during the integrated login process.</para>
3819 <indexterm><primary>LogonScript</primary></indexterm>
3820 <title id='Domain_Specific_Regkeys_LogonScript'>Value: LogonScript</title>
3821 <para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]</para>
3822 <para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\<domain name>]</para>
3823 <para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]</para>
3824 <para>Type: REG_SZ or REG_EXPAND_SZ
3830 NSIS/WiX: (only value under NP key) <install path>\afscreds.exe -:%s -x -a -m -n -q</para>
3831 <para>A logon script that will be scheduled to be run after the profile load is complete. If using the REG_EXPAND_SZ type, you can use any system environment variable as "%varname%" which would be expanded at the time the network provider is run. Optionally using a "%s" in the value would result in it being expanded into the AFS SMB username for the session.</para>
3836 <indexterm><primary>LoginRetryInterval</primary></indexterm>
3837 <title id='Domain_Specific_Regkeys_LoginRetryInterval'>Value: LoginRetryInterval</title>
3838 <para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]</para>
3839 <para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\<domain name>]</para>
3840 <para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]</para>
3847 NSIS/WiX: (not set)</para>
3848 <para>If the OpenAFS client service has not started yet, the network provider will wait for a maximum of "LoginRetryInterval" seconds while retrying every "LoginSleepInterval" seconds to check if the service is up.</para>
3853 <indexterm><primary>LoginSleepInterval</primary></indexterm>
3854 <title id='Domain_Specific_Regkeys_LoginSleepInterval'>Value: LoginSleepInterval</title>
3855 <para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]</para>
3856 <para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\<domain name>]</para>
3857 <para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]</para>
3864 NSIS/WiX: (not set)</para>
3865 <para>See description of LoginRetryInterval.</para>
3870 <indexterm><primary>Realm</primary></indexterm>
3871 <title id='Domain_Specific_Regkeys_Realm'>Value: Realm</title>
3872 <anchor id='Value_Realm' />
3873 <para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]</para>
3874 <para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\<domain name>]</para>
3875 <para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]</para>
3879 NSIS: <not set></para>
3880 <para>When Kerberos v5 is being used, Realm specifies the Kerberos v5 realm that should be appended to the first component of the Domain logon username to construct the Kerberos v5 principal for which AFS tokens should be obtained.</para>
3885 <indexterm><primary>TheseCells</primary></indexterm>
3886 <title id='Domain_Specific_Regkeys_TheseCells'>Value: TheseCells</title>
3887 <anchor id='Value_TheseCells' />
3888 <para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]</para>
3889 <para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\<domain name>]</para>
3890 <para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]</para>
3891 <para>Type: REG_MULTI_SZ
3894 NSIS: <not set></para>
3895 <para>When Kerberos v5 is being used, TheseCells provides a list of additional cells for which tokens should be obtained with the default Kerberos v5 principal.</para>
3901 <title id='Selection_Effective_Values_for_Domain_Specific_Configuration'>A.2.1.2 Selection of effective values for domain specific configuration</title>
3902 <para>During login to domain X, where X is the domain passed into NPLogonNotify as lpAuthentInfo->LogonDomainName or the string 'LOCALHOST' if lpAuthentInfo->LogonDomainName equals the name of the computer, the following keys will be looked up.</para>
3903 <para>1. NP key. ("HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider")</para>
3904 <para>2. Domains key. (NP key\"Domain")</para>
3905 <para>3. Specific domain key. (Domains key\X)</para>
3906 <para>If the specific domain key does not exist, then the domains key will be ignored. All the configuration information in this case will come from the NP key.</para>
3907 <para>If the specific domain key exists, then for each of the values metioned in (2), they will be looked up in the specific domain key, domains key and the NP key successively until the value is found. The first instance of the value found this way will be the effective for the login session. If no such instance can be found, the default will be used. To re-iterate, a value in a more specific key supercedes a value in a less specific key. The exceptions to this rule are stated below.</para>
3910 <title id='Domain_Specific_Configuration_Exceptions'>A.2.1.3 Exceptions to A.2.1.2</title>
3911 <para>To retain backwards compatibility, the following exceptions are made to A.2.1.2.</para>
3913 <indexterm><primary>FailLoginsSilently</primary></indexterm>
3914 <title id='Domain_Specific_Configuration_Exception_FailLoginsSilently'>2.1.3.1 'FailLoginsSilently'</title>
3915 <para>Historically, the 'FailLoginsSilently' value was in HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters key and not in the NP key. Therefore, for backwards compatibility, the value in the Parameters key will supercede all instances of this value in other keys. In the absence of this value in the Parameters key, normal scope rules apply.</para>
3918 <indexterm><primary>LogonScript</primary></indexterm>
3919 <title id='Domain_Specific_Configuration_Exception_LogonScript'>2.1.3.2 'LogonScript'</title>
3920 <para>If a 'LogonScript' is not specified in the specific domain key nor in the domains key, the value in the NP key will only be checked if the effective 'LogonOptions' specify a high security integrated login. If a logon script is specified in the specific domain key or the domains key, it will be used regardless of the high security setting. Please be aware of this when setting this value.</para>
3925 <indexterm><primary>afscreds.exe</primary></indexterm>
3926 <indexterm><primary>System Tray Tool</primary></indexterm>
3927 <title id='AFSCreds_Parameters'>A.3. AFS Credentials System Tray Tool parameters</title>
3928 <para>Affects the behavior of afscreds.exe</para>
3930 <title id='AFSCreds_Regkey_TransarcAFSDaemon_Parameters'>Regkey:
3931 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</title>
3933 <indexterm><primary>Gateway</primary></indexterm>
3934 <title id='AFSCreds_Regkey_TransarcAFSDaemon_Parameters_Gateway'>Value: Gateway</title>
3935 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
3942 Function: GetGatewayName()</para>
3943 <para>If the AFS client is utilizing a gateway to obtain AFS access, the name of the gateway is specified by this value.</para>
3948 <indexterm><primary>Cell</primary></indexterm>
3949 <title id='AFSCreds_Regkey_TransarcAFSDaemon_Parameters_Cell'>Value: Cell</title>
3950 <para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
3954 Default: <none>
3957 Variable: IsServiceConfigured()</para>
3958 <para>The value Cell is used to determine if the AFS Client Service has been properly configured or not.</para>
3962 <title id='AFSCreds_Regkey_Software_OpenAFS_Client'>Regkey:
3963 [HKLM\SOFTWARE\OpenAFS\Client]
3964 [HKCU\SOFTWARE\OpenAFS\Client]</title>
3966 <indexterm><primary>ShowTrayIcon</primary></indexterm>
3967 <title id='AFSCreds_Regkey_Software_OpenAFS_Client_ShowTrayIcon'>Value: ShowTrayIcon</title>
3968 <para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client]</para>
3969 <para>Regkey: [HKCU\SOFTWARE\OpenAFS\Client]</para>
3970 <para>Type: DWORD {0, 1}
3976 Function: InitApp(), Main_OnCheckTerminate()</para>
3977 <para>This value is used to determine whether or not a shortcut should be maintained in the user's Start Menu->Programs->Startup folder. </para>
3978 <para>This value used to be stored at [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].</para>
3979 <para>The current user value is checked first; if it does not exist the local machine value is checked.</para>
3984 <indexterm><primary>EnableKFW</primary></indexterm>
3985 <title id='AFSCreds_Regkey_Software_OpenAFS_Client_EnableKFW'>Value: EnableKFW</title>
3986 <anchor id='Value_EnableKFW' />
3987 <para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client]</para>
3988 <para>Regkey: [HKCU\SOFTWARE\OpenAFS\Client]</para>
3989 <para>Type: DWORD {0, 1}
3995 Function: KFW_is_available()</para>
3996 <para>When MIT Kerberos for Windows can be loaded, Kerberos v5 will be used to obtain AFS credentials. By setting this value to 0, the internal Kerberos v4 implementation will be used instead. The current user value is checked first; if it does not exist the local machine value is checked.</para>
4001 <indexterm><primary>AcceptDottedPrincipalName</primary></indexterm>
4002 <title id='AFSCreds_Regkey_Software_OpenAFS_Client_AcceptDottedPrincipalNames'>Value: AcceptDottedPrincipalNames</title>
4003 <para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client]</para>
4004 <para>Regkey: [HKCU\SOFTWARE\OpenAFS\Client]</para>
4005 <para>Type: DWORD {0, 1}
4011 Function: KFW_accept_dotted_usernames()</para>
4012 <para>Kerberos v5 principal names are traditionally mapped to Kerberos v4 names by the AFS servers before they can be looked up in the Protection database. The mapping algorithm used permits collisions to occur. Both of the Kerberos v5 names, "user.admin@REALM" and "user/admin@REALM" are interpreted as the same user identity within the cell. To enable both names to be sent to the server by AFSCreds or Integrated Logon, set this value to 1.</para>
4017 <indexterm><primary>Use524</primary></indexterm>
4018 <title id='AFSCreds_Regkey_Software_OpenAFS_Client_Use524'>Value: Use524</title>
4019 <anchor id='Value_Use524' />
4020 <para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client]</para>
4021 <para>Regkey: [HKCU\SOFTWARE\OpenAFS\Client]</para>
4022 <para>Type: DWORD {0, 1}
4028 Function: KFW_use_krb524()</para>
4029 <para>When MIT Kerberos for Windows can be loaded, Kerberos v5 will be used to obtain AFS credentials. By setting this value to 1, the Kerberos v5 tickets will be converted to Kerberos v4 tokens via a call to the krb524 daemon. The current user value is checked first; if it does not exist the local machine value is checked.</para>
4034 <indexterm><primary>AfscredsShortcutParams</primary></indexterm>
4035 <title id='AFSCreds_Regkey_Software_OpenAFS_Client_AfscredsShortcutParams'>Value: AfscredsShortcutParams</title>
4036 <anchor id='Value_AfscredsShortcutParams' />
4037 <para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client]</para>
4038 <para>Regkey: [HKCU\SOFTWARE\OpenAFS\Client]</para>
4042 Default: "-A -M -N -Q"
4045 Function: Shortcut_FixStartup</para>
4046 <para>This value specifies the command line options which should be set as part of the shortcut to afscreds.exe. afscreds.exe rewrites the shortcut each time it exits so as to ensure that the shortcut points to the latest version of the program. This value is used to determine which values should be used for command line parameters. The current user value is checked first; if it does not exist the local machine value is checked.</para>
4047 <para>The following subset of the command line options is appropriate for use in this registry setting:</para>
4050 <member>-A = autoinit
4053 -M = renew drive maps
4056 -N = ip address change detection
4059 -Q = quiet mode. do not display start service dialog if afsd_service is not already running
4062 -S = show tokens dialog on startup
4072 <title id='AFSCreds_Regkey_HKCU_Software_OpenAFS_Client'>Regkey:
4073 [HKCU\SOFTWARE\OpenAFS\Client]</title>
4075 <indexterm><primary>Authentication Cell</primary></indexterm>
4076 <title id='AFSCreds_Regkey_HKCU_Software_OpenAFS_Client_AuthenticationCell'>Value: Authentication Cell</title>
4077 <para>Regkey: [HKCU\SOFTWARE\OpenAFS\Client]</para>
4081 Default: <none>
4084 Function: Afscreds.exe GetDefaultCell()</para>
4085 <para>This value allows the user to configure a different cell name to be used as the default cell when acquiring tokens in afscreds.exe.</para>
4090 <indexterm><primary>Reminders</primary></indexterm>
4091 <title id='AFSCreds_Regkey_HKCU_Software_OpenAFS_Client_Reminders'>Regkey:
4092 [HKCU\SOFTWARE\OpenAFS\Client\Reminders]</title>
4094 <title id='AFSCreds_Regkey_HKCU_Software_OpenAFS_Client_Reminders_Cell'>Value: <afs cell name></title>
4095 <para>Regkey: [HKCU\SOFTWARE\OpenAFS\Client\Reminders]</para>
4096 <para>Type: DWORD {0, 1}
4099 Default: <none>
4102 Function: LoadRemind(), SaveRemind()</para>
4103 <para>These values are used to save and restore the state of the reminder flag for each cell for which the user has obtained tokens.</para>
4104 <para>This value used to be stored at [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].</para>
4108 <indexterm><primary>ActiveMaps</primary></indexterm>
4109 <title id='AFSCreds_Regkey_HKCU_Software_OpenAFS_Client_ActiveMaps'>Regkey:
4110 [HKCU\SOFTWARE\OpenAFS\Client\Active Maps]</title>
4112 <title id='AFSCreds_Regkey_HKCU_Software_OpenAFS_Client_ActiveMaps_DriveLetter'>Value: <upper case drive letter></title>
4113 <para>Regkey: [HKCU\SOFTWARE\OpenAFS\Client\ActiveMaps]</para>
4114 <para>Type: DWORD {0, 1}
4117 Default: <none></para>
4118 <para>These values are used to store the persistence state of the AFS drive mappings as listed in the [...\Client\Mappings] key.</para>
4119 <para>These values used to be stored in the afsdsbmt.ini file</para>
4124 <title id='AFSCreds_Regkey_HKCU_Software_OpenAFS_Client_Mappings'>Regkey:
4125 [HKCU\SOFTWARE\OpenAFS\Client\Mappings]</title>
4127 <title id='AFSCreds_Regkey_HKCU_Software_OpenAFS_Client_Mappings_DriveLetter'>Value: <upper case drive letter></title>
4128 <para>Regkey: [HKCU\SOFTWARE\OpenAFS\Client\Mappings]</para>
4132 Default: <none></para>
4133 <para>These values are used to store the AFS path in UNIX notation to which the drive letter is to be mapped.</para>
4134 <para>These values used to be stored in the afsdsbmt.ini file.</para>
4141 <title id='OpenAFS_Service_Environment_Variables'>A.4 OpenAFS Client Service Environment Variables</title>
4143 <indexterm><primary>AFS_RPC_ENCRYPT</primary></indexterm>
4144 <title id='OpenAFS_Service_Environment_Variables_AFS_RPC_ENCRYPT'>Value: AFS_RPC_ENCRYPT</title>
4147 <member> "OFF" disables the use of RPC encryption </member>
4148 <member>any other value allows RPC encryption to be used</member>
4152 Default: RPC encryption is on
4158 <indexterm><primary>AFS_RPC_PROTSEQ</primary></indexterm>
4159 <title id='OpenAFS_Service_Environment_Variables_AFS_RPC_PROTSEQ'>Value: AFS_RPC_PROTSEQ</title>
4163 "ncalrpc" - local RPC
4166 "ncacn_np" - named pipes
4169 "ncacn_ip_tcp" - tcp/ip
4180 <index>Name Index</index>
4182 <!-- Keep this comment at the end of the file
4187 sgml-namecase-general:nil
4188 sgml-general-insert-case:lower
4189 sgml-minimize-attributes:nil
4190 sgml-always-quote-attributes:t
4192 sgml-indent-data:nil
4193 sgml-parent-document:nil
4194 sgml-exposed-tags:nil
4195 sgml-local-catalogs:nil
4196 sgml-local-ecat-files:nil
git://git.openafs.org / openafs.git / blob