winnotes-20040715
[openafs.git] / doc / txt / winnotes / registry.txt
index 34d6a81..0a8a50f 100644 (file)
@@ -1,8 +1,8 @@
 
-Registry keys used in the Windows AFS Client
---------------------------------------------
+Registry keys and Environment Variables used in the Windows AFS Client
+----------------------------------------------------------------------
 
-This file describes the registry keys used in the Windows AFS clients.
+REGISTRY KEYS:
 
 1. Service parameters
 ---------------------
@@ -240,6 +240,30 @@ Variable: rx_mtu
   In order to enable OpenAFS to operate across the Cisco IPSec VPN
   client, this value must be set to 1264 or smaller.
 
+Value  : ConnDeadTimeout
+Type   : DWORD
+Default : 60 (seconds)
+Variable: ConnDeadtimeout
+
+  The Connection Dead Time is enforced to be at a minimum 15 seconds 
+  longer than the minimum SMB timeout as specified by 
+
+  HKLM\SYSTEM\CurrentControlSet\Services\lanmanworkstation\parameters
+    SessTimeout
+
+  If the minimum SMB timeout is not specified the value is 45 seconds.
+  See http://support.microsoft.com:80/support/kb/articles/Q102/0/67.asp
+
+
+Value  : HardDeadTimeout
+Type   : DWORD
+Default : 120 (seconds)
+Variable: HardDeadtimeout
+
+  The Hard Dead Time is enforced to be at least double the ConnDeadTimeout.
+  The provides an opportunity for at least one retry.
+
+
 Value   : AllSubmount
 Type    : DWORD {0, 1}
 Default : 1
@@ -249,6 +273,46 @@ Variable: allSubmount (smb.c)
   will not be created.  This allows the read-write versions of 
   root.afs to be hidden.
 
+Value   : NoFindLanaByName
+Type    : DWORD {0, 1}
+Default : 0
+
+  Disables the attempt to identity the network adapter to use by 
+  looking for an adapter with a display name of "AFS".
+
+Value   : MaxCPUs
+Type    : DWORD {1..32} or {1..64} depending on the architecture
+Default : <no default>
+
+  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.  
+
+  NOTE: Setting this entry to "1" may be required on hyperthreaded 
+  systems to avoid crashes in the RX library.
+
+Value   : smbAuthType
+Type    : DWORD {0..2} 
+Default : 2
+
+  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:
+    0 = No authentication required
+    1 = NTLM authentication required
+    2 = Extended (GSS SPNEGO) authentication required
+  The default is Extended authentication
+
+Regkey:
+[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters\GlobalAutoMapper]
+
+Value   : <Drive Letter:> for example "G:"
+Type    : SZ
+
+    Specifies the submount name to be mapped by afsd_service.exe at startup
+    to the provided drive letter.
+
+
 
 Regkey:
 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
@@ -335,6 +399,12 @@ NSIS    : <install path>\afslogon.dll
 
   Specifies the DLL to use for the network provider
 
+Value  : TraceOption
+Type   : DWORD {1|0}
+Default : 0
+
+  Enables trace events for the network provider.
+
 Value   : VerboseLogging
 Type    : DWORD
 NSIS    : 0x0a
@@ -400,6 +470,18 @@ Function: Shortcut_FixStartup
 
 
 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
+
+
+Regkey:
 [HKCU\SOFTWARE\OpenAFS\Client\Reminders]
 
 Value   : "afs cell name"
@@ -414,3 +496,88 @@ Function: LoadRemind(), SaveRemind()
   [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].
 
 
+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 
+Values:   "OFF" disables the use of RPC encryption
+          any other value allows RPC encryption to be used
+Default:  RPC encryption is on
+
+
+Variable: AFS_RPC_PROTSEQ
+Values:   "ncalrpc"  - local RPC 
+          "ncacn_np" - named pipes
+          "ncacn_ip_tcp" - tcp/ip
+Default:  local RPC
+