doc/txt/winnotes/registry.txt

   1
   2 Registry keys and Environment Variables used in the Windows AFS Client
   3 ----------------------------------------------------------------------
   4
   5 REGISTRY KEYS:
   6
   7 1. Service parameters
   8 ---------------------
   9
  10 The service parameters primarily affect the behavior of the AFS client
  11 service (afsd_service.exe).
  12
  13 Regkey:
  14 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
  15
  16 Value   : LANadapter
  17 Type    : DWORD
  18 Default : -1
  19 Variable: LANadapter
  20
  21   LAN adapter number to use.  This is the lana number of the LAN
  22   adapter that the SMB server should bind to.  If unspecified or set
  23   to -1, a LAN adapter with named 'AFS' or a loopback adapter will be
  24   selected.  If neither are present, then all available adapters will
  25   be bound to.  When binding to a non-loopback adapter, the NetBIOS
  26   name '%hostname%-AFS' will be used (where %hostname% is the NetBIOS
  27   name of the host truncated to 11 characters). Otherwise, the NetBIOS
  28   name will be 'AFS'.
  29
  30 Value   : CacheSize
  31 Type    : QWORD
  32 Default : 20480 (CM_CONFIGDEFAULT_CACHESIZE)
  33 Variable: cm_initParams.cacheSize
  34
  35   Size of the AFS cache.
  36
  37 Value   : ChunkSize
  38 Type    : DWORD
  39 Default : 15 (CM_CONFIGDEFAULT_CHUNKSIZE)
  40 Variable: cm_logChunkSize (cm_chunkSize = 1 << cm_logChunkSize)
  41
  42   Size of chunk for reading and writing. Actual chunk size is 2^cm_logChunkSize.
  43
  44 Value   : Daemons
  45 Type    : DWORD
  46 Default : 2 (CM_CONFIGDEFAULT_DAEMONS)
  47 Variable: numBkgD
  48
  49   Number of background daemons (number of threads of
  50   cm_BkgDaemon). (see cm_BkgDaemon in cm_daemon.c)
  51
  52 Value   : ServerThreads
  53 Type    : DWORD
  54 Default : 4 (CM_CONFIGDEFAULT_SVTHREADS)
  55 Variable: numSvThreads
  56
  57   Number of SMB server threads (number of threads of smb_Server). (see
  58   smb_Server in smb.c).
  59
  60 Value   : Stats
  61 Type    : QWORD
  62 Default : 1000 (CM_CONFIGDEFAULT_STATS)
  63 Variable: cm_initParams.nStatCaches
  64
  65   Cache configuration.
  66
  67 Value   : LogoffTokenTransfer
  68 Type    : DWORD {1,0}
  69 Default : 1
  70 Variable: smb_LogoffTokenTransfer
  71
  72   If enabled (set to 1), activates functionality where the user's
  73   tokens are kept intact until smb_LogoffTokenTransferTimeout seconds
  74   elapse after user logs off.  If roaming profiles are used and the
  75   roaming profile takes a long time to be written back, this ensures
  76   that the tokens remain valid until the profile save is complete.
  77
  78 Value   : LogoffTokenTransferTimeout
  79 Type    : QWORD
  80 Default : 10
  81 Variable: smb_LogoffTokenTransferTimeout
  82
  83   See LogoffTokenTransfer above.
  84
  85 Value   : RootVolume
  86 Type    : REG_SZ
  87 Default : "root.afs"
  88 Variable: cm_rootVolumeName
  89
  90   Root volume name.
  91
  92 Value   : Mountroot
  93 Type    : REG_SZ
  94 Default : "/afs"
  95 Variable: cm_mountRoot
  96
  97   Name of root mount point.  In symlinks, if a path starts with
  98   cm_mountRoot, it is assumed that the path is absolute (as opposed to
  99   relative) and is adjusted accordingly. Eg: if a path is specified as
 100   /afs/athena.mit.edu/foo/bar/baz and cm_mountRoot is "/afs", then the
 101   path is interpreted as \\afs\all\athena.mit.edu\foo\bar\baz.  If a
 102   path does not start with with cm_mountRoot, the path is assumed to
 103   be relative and suffixed to the reference directory (i.e. directory
 104   where the symlink exists)
 105
 106 Value   : CachePath
 107 Type    : REG_SZ
 108 Default : "\AFSCache"
 109 Variable: cm_CachePath
 110
 111   Location of on-disk cache file.  The default implies the root
 112   directory of the boot disk
 113
 114 Value   : TrapOnPanic
 115 Type    : DWORD {1,0}
 116 Default : 0
 117 Variable: traceOnPanic
 118
 119   Issues a breakpoint in the event of a panic. (breakpoint: _asm int 3).
 120
 121 Value   : NetbiosName
 122 Type    : REG_EXPAND_SZ
 123 Default : "AFS"
 124 Variable: cm_NetbiosName
 125
 126   Specifies the NetBIOS name to be used when binding to a Loopback
 127   adapter.  To provide the old behavior specify a value of
 128   "%COMPUTERNAME%-AFS"
 129
 130 Value   : IsGateway
 131 Type    : DWORD {1,0}
 132 Default : 0
 133 Variable: isGateway
 134
 135   Select whether or not this AFS client should act as a gateway.  If
 136   set and the NetBIOS name hostname-AFS is bound to a physical NIC,
 137   other machines in the subnet can access AFS via SMB connections to
 138   hostname-AFS.
 139
 140   When IsGateway is non-zero, the LAN adapter detection code will
 141   avoid binding to a loopback adapter.  This will ensure that the
 142   NetBIOS name will be of the form hostname-AFS instead of the value
 143   set by the "NetbiosName" registry value.
 144
 145 Value   : ReportSessionStartups
 146 Type    : DWORD {1,0}
 147 Default : 0
 148 Variable: reportSessionStartups
 149
 150   If enabled, all SMB sessions created are recorded in the Application
 151   event log.  This also enables other events such as drive mappings
 152   or various error types to be logged.
 153
 154 Value   : TraceBufferSize
 155 Type    : QWORD
 156 Default : 5000 (CM_CONFIGDEFAULT_TRACEBUFSIZE)
 157 Variable: traceBufSize
 158
 159   Number of entries to keep in trace log.
 160
 161 Value   : SysName
 162 Type    : REG_SZ
 163 Default : "i386_nt40"
 164 Variable: cm_sysName
 165
 166   Self explanatory.
 167
 168 Value   : SecurityLevel
 169 Type    : DWORD {1,0}
 170 Default : 0
 171 Variable: cryptall
 172
 173   Enables encryption on RX calls.
 174
 175 Value   : UseDNS
 176 Type    : DWORD {1,0}
 177 Default : 1
 178 Variable: cm_dnsEnabled
 179
 180   Enables resolving volservers using AFSDB DNS queries. (see
 181   afsdb-freelance-notes).
 182
 183   As of 1.3.60, this value is ignored as the DNS query support
 184   utilizes the Win32 DNSQuery API which is available on Win2000
 185   and above.
 186
 187 Value   : FreelanceClient
 188 Type    : DWORD {1,0}
 189 Default : 0
 190 Variable: cm_freelanceEnabled
 191
 192   Enables freelance client. (see afsdb-freelance-notes)
 193
 194 Value   : HideDotFiles
 195 Type    : DWORD {1,0}
 196 Default : 1
 197 Variable: smb_hideDotFiles
 198
 199   Enables marking dotfiles with the hidden attribute.  Dot files are
 200   files whose name starts with a period (excluding "." and "..").
 201
 202 Value   : MaxMpxRequests
 203 Type    : DWORD
 204 Default : 50
 205 Variable: smb_maxMpxRequests
 206
 207   Maximum number of multiplexed SMB requests that can be made.
 208
 209 Value   : MaxVCPerServer
 210 Type    : DWORD
 211 Default : 100
 212 Variable: smb_maxVCPerServer
 213
 214   Maximum number of SMB virtual circuits.
 215
 216 Value   : Cell
 217 Type    : REG_SZ
 218 Default : <none>
 219 Variable: rootCellName
 220
 221   Name of root cell (the cell from which root.afs should be mounted in
 222   \\afs\all).
 223
 224 Value   : RxNoJumbo
 225 Type    : DWORD {0,1}
 226 Default : 0
 227 Variable: rx_nojumbo
 228
 229   If enabled, does not send or indicate that we are able to send or
 230   receive RX jumbograms.
 231
 232 Value   : RxMaxMTU
 233 Type    : DWORD
 234 Default : -1
 235 Variable: rx_mtu
 236
 237   If set to anything other than -1, uses that value as the maximum MTU
 238   supported by the RX interface.
 239
 240   In order to enable OpenAFS to operate across the Cisco IPSec VPN
 241   client, this value must be set to 1264 or smaller.
 242
 243 Value   : ConnDeadTimeout
 244 Type    : DWORD
 245 Default : 60 (seconds)
 246 Variable: ConnDeadtimeout
 247
 248   The Connection Dead Time is enforced to be at a minimum 15 seconds
 249   longer than the minimum SMB timeout as specified by
 250
 251   HKLM\SYSTEM\CurrentControlSet\Services\lanmanworkstation\parameters
 252     SessTimeout
 253
 254   If the minimum SMB timeout is not specified the value is 45 seconds.
 255   See http://support.microsoft.com:80/support/kb/articles/Q102/0/67.asp
 256
 257
 258 Value   : HardDeadTimeout
 259 Type    : DWORD
 260 Default : 120 (seconds)
 261 Variable: HardDeadtimeout
 262
 263   The Hard Dead Time is enforced to be at least double the ConnDeadTimeout.
 264   The provides an opportunity for at least one retry.
 265
 266
 267 Value   : AllSubmount
 268 Type    : DWORD {0, 1}
 269 Default : 1
 270 Variable: allSubmount (smb.c)
 271
 272   By setting this value to 0, the "\\NetbiosName\all" mount point
 273   will not be created.  This allows the read-write versions of
 274   root.afs to be hidden.
 275
 276 Value   : NoFindLanaByName
 277 Type    : DWORD {0, 1}
 278 Default : 0
 279
 280   Disables the attempt to identity the network adapter to use by
 281   looking for an adapter with a display name of "AFS".
 282
 283 Value   : MaxCPUs
 284 Type    : DWORD {1..32} or {1..64} depending on the architecture
 285 Default : <no default>
 286
 287   If this value is specified, afsd_service.exe will restrict itself
 288   to executing on the specified number of CPUs if there are a greater
 289   number installed in the machine.
 290
 291   NOTE: Setting this entry to "1" may be required on hyperthreaded
 292   systems to avoid crashes in the RX library.
 293
 294
 295 Regkey:
 296 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters\GlobalAutoMapper]
 297
 298 Value   : <Drive Letter:> for example "G:"
 299 Type    : SZ
 300
 301     Specifies the submount name to be mapped by afsd_service.exe at startup
 302     to the provided drive letter.
 303
 304
 305
 306 Regkey:
 307 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
 308
 309
 310 2. Network provider parameters
 311 ------------------------------
 312 Affects the network provider (aklogon.dll).
 313
 314 Regkey:
 315 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
 316
 317 Value   : FailLoginsSilently
 318 Type    : DWORD
 319 Default : 0
 320
 321   Do not display message boxes if the login fails.
 322
 323 Regkey:
 324 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
 325
 326 Value   : NoWarnings
 327 Type    : DWORD
 328 Default : 0
 329
 330   Disables visible warnings during logon.
 331
 332 Value   : AuthentProviderPath
 333 Type    : REG_SZ
 334 NSIS    : <install path>\afslogon.dll
 335
 336   Specifies the install location of the authentication provider dll.
 337
 338 Value   : Class
 339 Type    : DWORD
 340 NSIS    : 0x02
 341
 342   Specifies the class of network provider
 343
 344 Value   : DependOnGroup
 345 Type    : REG_MULTI_SZ
 346 NSIS    : PNP_TDI
 347
 348   Specifies the service groups upon which the AFS Client Service
 349   depends.  Windows should not attempt to start the AFS Client Service
 350   until all of the services within these groups have successfully
 351   started.
 352
 353 Value   : DependOnService
 354 Type    : REG_MULTI_SZ
 355 NSIS    : Tcpip NETBIOS RpcSs
 356
 357   Specifies a list of services upon which the AFS Client Service
 358   depends.  Windows should not attempt to start the AFS Client Service
 359   until all of the specified services have successfully started.
 360
 361 Value   : LogonOptions
 362 Type    : DWORD
 363 NSIS    : depends on user configuration
 364
 365   0x00 - Integrated Logon is not used
 366   0x01 - Integrated Logon is used
 367   0x02 - High Security Mode is used
 368   0x03 - Integrated Logon with High Security Mode is used
 369
 370   High Security Mode generates random SMB names for the creation of
 371   Drive Mappings.  This mode should not be used without Integrated Logon.
 372
 373 Value   : LogonScript
 374 Type    : REG_SZ
 375 NSIS    : <install path>\afscreds.exe -:%s -x
 376
 377   Specifies the command to be executed at the end of successful logon.
 378
 379 Value   : Name
 380 Type    : REG_SZ
 381 NSIS    : "OpenAFSDaemon"
 382
 383   Specifies the display name of the AFS Client Service
 384
 385 Value   : ProviderPath
 386 Type    : REG_SZ
 387 NSIS    : <install path>\afslogon.dll
 388
 389   Specifies the DLL to use for the network provider
 390
 391 Value   : VerboseLogging
 392 Type    : DWORD
 393 NSIS    : 0x0a
 394
 395   Determines the level of logging to be enabled
 396
 397
 398 3. AFS Credentials System Tray Tool parameters
 399 ----------------------------------------------
 400 Affects the behavior of afscreds.exe
 401
 402 Regkey:
 403 [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]
 404
 405 Value   : Gateway
 406 Type    : REG_SZ
 407 Default : ""
 408 Function: GetGatewayName()
 409
 410   If the AFS client is utilizing a gateway to obtain AFS access,
 411   the name of the gateway is specified by this value.
 412
 413 Value   : Cell
 414 Type    : REG_SZ
 415 Default : <none>
 416 Variable: IsServiceConfigured()
 417
 418   The value Cell is used to determine if the AFS Client Service has
 419   been properly configured or not.
 420
 421
 422 Regkey:
 423 [HKLM\SOFTWARE\OpenAFS\Client]
 424 [HKCU\SOFTWARE\OpenAFS\Client]
 425
 426 Value   : ShowTrayIcon
 427 Type    : DWORD {0, 1}
 428 Default : 1
 429 Function: InitApp(), Main_OnCheckTerminate()
 430
 431   This value is used to determine whether or not a shortcut should be
 432   maintained in the user's Start Menu->Programs->Startup folder.
 433
 434   This value used to be stored at
 435   [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].
 436
 437 Value   : EnableKFW
 438 Type    : DWORD {0, 1}
 439 Default : 1
 440 Function: KFW_is_available()
 441
 442   When MIT Kerberos for Windows can be loaded, Kerberos 5 will be used
 443   to obtain AFS credentials.  By setting this value to 0, the internal
 444   Kerberos 4 implementation will be used instead.
 445
 446 Value   : AfscredsShortcutParams
 447 Type    : REG_SZ
 448 Default : "-A -M -N -Q"
 449 Function: Shortcut_FixStartup
 450
 451   This value specifies the command line options which should be set
 452   as part of the shortcut to afscreds.exe.
 453
 454
 455 Regkey:
 456 [HKCU\SOFTWARE\OpenAFS\Client\Reminders]
 457
 458 Value   : "afs cell name"
 459 Type    : DWORD {0, 1}
 460 Default : <none>
 461 Function: LoadRemind(), SaveRemind()
 462
 463   These values are used to save and restore the state of the reminder
 464   flag for each cell for which the user has obtained tokens.
 465
 466   This value used to be stored at
 467   [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].
 468
 469
 470 ENVIRONMENT VARIABLES:
 471
 472 Variable: AFS_RPC_ENCRYPT
 473 Values:   "OFF" disables the use of RPC encryption
 474           any other value allows RPC encryption to be used
 475 Default:  RPC encryption is on
 476
 477
 478 Variable: AFS_RPC_PROTSEQ
 479 Values:   "ncalrpc"  - local RPC
 480           "ncacn_np" - named pipes
 481           "ncacn_ip_tcp" - tcp/ip
 482 Default:  local RPC
 483