windows-notes-20050509
[openafs.git] / doc / txt / winnotes / registry.txt
index 07991a3..acf7ad6 100644 (file)
@@ -28,15 +28,15 @@ Variable: LANadapter
   name will be 'AFS'.
 
 Value   : CacheSize
-Type    : QWORD
-Default : 20480 (CM_CONFIGDEFAULT_CACHESIZE)
+Type    : DWORD
+Default : 98304 (CM_CONFIGDEFAULT_CACHESIZE)
 Variable: cm_initParams.cacheSize
 
-  Size of the AFS cache.
+  Size of the AFS cache in 1k blocks.
 
 Value   : ChunkSize
 Type    : DWORD
-Default : 15 (CM_CONFIGDEFAULT_CHUNKSIZE)
+Default : 17 (CM_CONFIGDEFAULT_CHUNKSIZE)
 Variable: cm_logChunkSize (cm_chunkSize = 1 << cm_logChunkSize)
 
   Size of chunk for reading and writing. Actual chunk size is 2^cm_logChunkSize.
@@ -51,15 +51,15 @@ Variable: numBkgD
 
 Value  : ServerThreads
 Type   : DWORD
-Default        : 4 (CM_CONFIGDEFAULT_SVTHREADS)
+Default        : 25 (CM_CONFIGDEFAULT_SVTHREADS)
 Variable: numSvThreads
 
   Number of SMB server threads (number of threads of smb_Server). (see
   smb_Server in smb.c).
 
 Value  : Stats
-Type   : QWORD
-Default : 1000 (CM_CONFIGDEFAULT_STATS)
+Type   : DWORD
+Default : 10000 (CM_CONFIGDEFAULT_STATS)
 Variable: cm_initParams.nStatCaches
 
   Cache configuration.
@@ -76,7 +76,7 @@ Variable: smb_LogoffTokenTransfer
   that the tokens remain valid until the profile save is complete.
 
 Value  : LogoffTokenTransferTimeout
-Type   : QWORD
+Type   : DWORD
 Default : 10
 Variable: smb_LogoffTokenTransferTimeout
 
@@ -103,13 +103,40 @@ Variable: cm_mountRoot
   be relative and suffixed to the reference directory (i.e. directory
   where the symlink exists)
  
+
 Value  : CachePath
-Type   : REG_SZ
-Default : "\AFSCache"
+Type   : REG_SZ or REG_EXPAND_SZ
+Default : "%TEMP%\AFSCache"
 Variable: cm_CachePath
 
-  Location of on-disk cache file.  The default implies the root 
-  directory of the boot disk
+  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.
+
+
+Value   : NonPersistentCaching
+Type    : DWORD [0..1]
+Default : 0
+Variable: buf_CacheType
+
+  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 prevents the use of persistent caching (when available)
+  as well as the ability to alter the size of the cache at runtime
+  using the "fs setcachesize" command.
+
+
+Value   : ValidateCache
+Type    : DWORD [0..2]
+Default : 1
+Variable: buf_CacheType
+
+  This value determines if and when persistent cache validation is 
+  performed.
+    0 - Validation is disabled
+    1 - Validation is performed at startup
+    2 - Validation is performed at shutdown
+
 
 Value  : TrapOnPanic
 Type   : DWORD {1,0}
@@ -152,7 +179,7 @@ Variable: reportSessionStartups
   or various error types to be logged.
 
 Value  : TraceBufferSize
-Type   : QWORD
+Type   : DWORD
 Default : 5000 (CM_CONFIGDEFAULT_TRACEBUFSIZE)
 Variable: traceBufSize
 
@@ -163,7 +190,9 @@ Type        : REG_SZ
 Default : "i386_nt40"
 Variable: cm_sysName
 
-  Self explanatory.
+  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.
 
 Value  : SecurityLevel
 Type   : DWORD {1,0}
@@ -265,10 +294,13 @@ Variable: HardDeadtimeout
 
 
 Value  : TraceOption
-Type   : DWORD {1|0}
+Type   : DWORD {0, 1, 2, 3}
 Default : 0
 
-  Enables trace events for the AFS client and network provider.
+  Enables logging of debug output to the Windows Event Log.
+  Bit 0 enables logging of "Logon Events" processed by the Network Provider
+  and Winlogon Event Notification Handler.  
+  Bit 1 enables logging of events captured by the AFS Client Service.
 
 Value   : AllSubmount
 Type    : DWORD {0, 1}
@@ -309,6 +341,22 @@ Default : 2
     2 = Extended (GSS SPNEGO) authentication required
   The default is Extended authentication
 
+Value   : MaxLogSize
+Type    : DWORD {0 .. MAXDWORD}
+Default : 100K
+
+  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.
+
+Value   : FlushOnHibernate
+Type    : DWORD {0,1}
+Default : 1
+
+  If set, flushes all volumes before the machine goes on hibernate or
+  stand-by.
+
 Regkey:
 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters\GlobalAutoMapper]
 
@@ -319,9 +367,184 @@ Type    : SZ
     to the provided drive letter.
 
 
+Regkey:
+[HKLM\SOFTWARE\OpenAFS\Client]
+
+Value   : CellServDBDir
+Type   : REG_SZ
+Default : <not defined>
+
+  Specifies the directory containing the CellServDB file.
+  When this value is not specified, the AFS Client install
+  directory is used.
+
+
+Value   : VerifyServiceSignature
+Type   : REG_DWORD
+Default : 0x1
+
+  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.
+
+
+Value   : IoctlDebug
+Type   : REG_DWORD
+Default : 0x0
+
+  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. 
+
+
+Value   : MiniDumpType
+Type    : REG_DWORD
+Default : 0x0 (MiniDumpNormal)
+
+  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.
+
+  Valid values are dependent on the version of DbgHelp.dll installed
+  on the machine.  See the Microsoft Developer Library for further
+  information.
+
+  MiniDumpNormal = 0x00000000,
+  MiniDumpWithDataSegs = 0x00000001,
+  MiniDumpWithFullMemory = 0x00000002,
+  MiniDumpWithHandleData = 0x00000004,
+  MiniDumpFilterMemory = 0x00000008,
+  MiniDumpScanMemory = 0x00000010,
+  MiniDumpWithUnloadedModules = 0x00000020,
+  MiniDumpWithIndirectlyReferencedMemory = 0x00000040,
+  MiniDumpFilterModulePaths = 0x00000080,
+  MiniDumpWithProcessThreadData = 0x00000100,
+  MiniDumpWithPrivateReadWriteMemory = 0x00000200,
+  MiniDumpWithoutOptionalData = 0x00000400,
+  MiniDumpWithFullMemoryInfo = 0x00000800,
+  MiniDumpWithThreadInfo = 0x00001000,
+  MiniDumpWithCodeSegs = 0x00002000
+
+
+Value   : StoreAnsiFilenames
+Type    : REG_DWORD
+Default : 0x0
+
+  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.  
+
+  Note: The use of ANSI characters will render access to files
+  with 8-bit OEM file names unaccessible 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.
+
 
 Regkey:
-[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
+[HKLM\SOFTWARE\OpenAFS\Client\CSCPolicy]
+
+Value   : "smb/cifs share name"
+Type    : REG_SZ
+Default : <none>
+
+    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"
+
+    These values used to be stored in afsdsbmt.ini
+
+Regkey:
+[HKLM\SOFTWARE\OpenAFS\Client\Freelance]
+
+Value   : "numeric value"
+Type    : REG_SZ
+Default : <none>
+
+    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.
+
+        "athena.mit.edu#athena.mit.edu:root.cell."
+        ".athena.mit.edu%athena.mit.edu:root.cell."
+
+    These values used to be stored in afs_freelance.ini
+
+
+Regkey:
+[HKLM\SOFTWARE\OpenAFS\Client\Freelance\Symlinks]
+
+Value   : "numeric value"
+Type    : REG_SZ
+Default : <none>
+
+    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.
+
+        "linkname:destination-path."
+        "athena:athena.mit.edu."
+        "home:athena.mit.edu\user\j\a\jaltman."
+        "filename:path\file."
+
+
+Regkey:
+[HKLM\SOFTWARE\OpenAFS\Client\Submounts]
+
+Value   : "submount name"
+Type    : REG_EXPAND_SZ
+Default : <none>
+
+    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.
+
+    These values used to be stored in afsdsbmt.ini
+
+    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.
+
+
+Regkey:
+[HKLM\SOFTWARE\OpenAFS\Client\Server Preferences\VLDB]
+
+Value   : "hostname or ip address"
+Type    : REG_DWORD
+Default : <none>
+
+    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 256 prior to
+    the preference being set.
+
+
+Regkey:
+[HKLM\SOFTWARE\OpenAFS\Client\Server Preferences\File]
+
+Value   : "hostname or ip address"
+Type    : REG_DWORD
+Default : <none>
+
+    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 256 prior to
+    the preference being set.
+
 
 
 2. Network provider parameters
@@ -348,7 +571,7 @@ Default : 0
 
 Value   : AuthentProviderPath
 Type    : REG_SZ
-NSIS    : <install path>\afslogon.dll
+NSIS    : %WINDIR%\SYSTEM32\afslogon.dll
 
   Specifies the install location of the authentication provider dll.
 
@@ -383,12 +606,13 @@ NSIS    : "OpenAFSDaemon"
 
 Value   : ProviderPath
 Type    : REG_SZ
-NSIS    : <install path>\afslogon.dll
+NSIS    : %WINDIR%\SYSTEM32\afslogon.dll
 
   Specifies the DLL to use for the network provider
 
-2.1 Domain specific configuration keys
---------------------------------------
+
+2.1 Domain specific configuration keys for the Network Provider
+---------------------------------------------------------------
 
 The network provider can be configured to have different behavior
 depending on the domain that the user logs into.  These settings are
@@ -484,6 +708,14 @@ in 2.1.1.  The effective values are chosen as described in 2.1.2.
 
      See description of LoginRetryInterval.
 
+  Value   : TheseCells
+  Type    : REG_MULTI_SZ
+  NSIS    : <not set>
+
+    When Kerberos 5 is being used, TheseCells provides a list of additional
+    cells for which tokens should be obtained with the default Kerberos 5 
+    principal.
+
 
 2.1.2  Selection of effective values for domain specific configuration
 ----------------------------------------------------------------------
@@ -574,6 +806,10 @@ Function: InitApp(), Main_OnCheckTerminate()
   This value used to be stored at 
   [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].
 
+  The current user value is checked first; if it does not exist the local 
+  machine value is checked.
+
+
 Value   : EnableKFW
 Type    : DWORD {0, 1}
 Default : 1
@@ -581,7 +817,19 @@ Function: KFW_is_available()
 
   When MIT Kerberos for Windows can be loaded, Kerberos 5 will be used
   to obtain AFS credentials.  By setting this value to 0, the internal
-  Kerberos 4 implementation will be used instead.
+  Kerberos 4 implementation will be used instead.  The current user value 
+  is checked first; if it does not exist the local machine value is checked.
+
+Value   : Use524
+Type    : DWORD {0, 1}
+Default : 0
+Function: KFW_use_krb524()
+
+  When MIT Kerberos for Windows can be loaded, Kerberos 5 will be used
+  to obtain AFS credentials.  By setting this value to 1, the Kerberos 5
+  tickets will be converted to Kerberos 4 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.
 
 Value   : AfscredsShortcutParams
 Type    : REG_SZ
@@ -589,19 +837,12 @@ Default : "-A -M -N -Q"
 Function: Shortcut_FixStartup
 
   This value specifies the command line options which should be set
-  as part of the shortcut to afscreds.exe.
-
-
-Regkey:
-[HKCU\SOFTWARE\OpenAFS\Client]
-
-Value   : Authentication Cell
-Type    : REG_SZ
-Default : <none>
-Function: Afscreds.exe GetDefaultCell()
-
-  This value allows the user to configure a different cell name to
-  be used as the default cell when acquiring tokens in afscreds.exe
+  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.
 
 
 Regkey:
@@ -656,123 +897,6 @@ Default : <none>
   These values used to be stored in the afsdsbmt.ini file.
 
 
-Regkey:
-[HKLM\SOFTWARE\OpenAFS\Client\CSCPolicy]
-
-Value   : "smb/cifs share name"
-Type    : REG_SZ
-Default : <none>
-
-    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"
-
-    These values used to be stored in afsdsbmt.ini
-
-Regkey:
-[HKLM\SOFTWARE\OpenAFS\Client\Freelance]
-
-Value   : "numeric value"
-Type    : REG_SZ
-Default : <none>
-
-    This key is used to store newline terminated mount point strings 
-    for use in constructing the fake root.afs volume when Freelance
-    (dynamic roots) mode is activated.
-
-        "athena.mit.edu#athena.mit.edu:root.cell.\n"
-        ".athena.mit.edu%athena.mit.edu:root.cell.\n"
-
-    These values used to be stored in afs_freelance.ini
-
-
-Regkey:
-[HKLM\SOFTWARE\OpenAFS\Client\Submounts]
-
-Value   : "submount name"
-Type    : REG_SZ
-Default : <none>
-
-    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.
-
-    These values used to be stored in afsdsbmt.ini
-
-
-Regkey:
-[HKCU\SOFTWARE\OpenAFS\Client\Active Maps]
-
-Value   : "upper case drive letter"
-Type    : DWORD {0, 1}
-Default : <none>
-
-  These values are used to store the persistence state of the AFS 
-  drive mappings as listed in the [...\Client\Mappings] key
-
-  These values used to be stored in the afsdsbmt.ini file
-
-Regkey:
-[HKCU\SOFTWARE\OpenAFS\Client\Mappings]
-
-Value   : "upper case drive letter"
-Type    : REG_SZ
-Default : <none>
-
-  These values are used to store the AFS path in Unix notation
-  to which the drive letter is to be mapped.
-
-  These values used to be stored in the afsdsbmt.ini file.
-
-
-Regkey:
-[HKLM\SOFTWARE\OpenAFS\Client\CSCPolicy]
-
-Value   : "smb/cifs share name"
-Type    : REG_SZ
-Default : <none>
-
-    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"
-
-    These values used to be stored in afsdsbmt.ini
-
-Regkey:
-[HKLM\SOFTWARE\OpenAFS\Client\Freelance]
-
-Value   : "numeric value"
-Type    : REG_SZ
-Default : <none>
-
-    This key is used to store newline terminated mount point strings 
-    for use in constructing the fake root.afs volume when Freelance
-    (dynamic roots) mode is activated.
-
-        "athena.mit.edu#athena.mit.edu:root.cell.\n"
-        ".athena.mit.edu%athena.mit.edu:root.cell.\n"
-
-    These values used to be stored in afs_freelance.ini
-
-
-Regkey:
-[HKLM\SOFTWARE\OpenAFS\Client\Submounts]
-
-Value   : "submount name"
-Type    : REG_SZ
-Default : <none>
-
-    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.
-
-    These values used to be stored in afsdsbmt.ini
-
-
 ENVIRONMENT VARIABLES:
 
 Variable: AFS_RPC_ENCRYPT