1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592
|
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"[
<!ENTITY version SYSTEM "version.xml">
]>
<book>
<bookinfo>
<title>OpenAFS for Windows Release Notes</title>
<copyright>
<year>2003-2013</year>
<holder>Secure Endpoints Inc. and Your File System Inc.</holder>
</copyright>
<legalnotice>
<para>This documentation is covered by the MIT License.</para>
</legalnotice>
<revhistory>
&version;
</revhistory>
<abstract>
<para>This document provides a series of usage notes regarding the OpenAFS for Windows
client, supported platforms, contribution information, debugging techniques, and
a reference to supported Windows registry values.
</para>
</abstract>
</bookinfo>
<preface>
<title id="Preface">Preface</title>
<para>The Andrew File System (AFS) is a globally-accessible location-independent file system
that uses local caching to increase its performance. An AFS client accesses files anonymously
or authenticated via Kerberos. The global AFS is partitioned into cells. Each 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 associated Kerberos authentication realms are
managed by a much larger organization. AFS clients and servers take advantage of Kerberos
cross-realm authentication to permit authenticated access by entities located outside the
local realm. Authorization is enforced by the use of directory level access control lists of
individual or group identities. </para>
<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>
<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
<emphasis>releasing</emphasis> the current contents of the source volume.
</para>
<para>OpenAFS for Windows (OAFW) provides AFS client access on 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. OAFW is implemented as a
native installable file system and maintains the portability of file paths by its use of the
\\AFS UNC server name.</para>
<para>OpenAFS is the product of an open source development effort begun on 1 November 2000.
OpenAFS is maintained and developed by a group of volunteers with the support of the end user
community. When OpenAFS is used as part of your computing infrastructure, please <link linkend="Contributing_to_OpenAFS">contribute</link> to its continued growth. </para>
</preface>
<chapter id="chap_1">
<title id="Installer_Options">Installer Options</title>
<para>OpenAFS can be installed either as a new installation or an upgrade from previous versions of either OpenAFS for Windows or the former IBM AFS 3.6 for Windows.
Installers are provided as <ulink url="http://msdn.microsoft.com/en-us/library/cc185688%28v=vs.85%29.aspx">Windows Installer packages (.msi)</ulink> that are built using the open source
<ulink url="http://wix.sourceforge.net/">WiX Toolkit</ulink>. The MSI can be customized for organizations via the use of <ulink url="http://msdn.microsoft.com/en-us/library/aa367447%28v=vs.85%29.aspx">MSI Transforms</ulink> (see <link linkend="Introduction_to_MSI_Deployment">MSI Deployment Guide</link>)
</para>
</chapter>
<chapter id="chap_2">
<title id="System_Requirements">System Requirements</title>
<section>
<title id="Supported_Operating_Systems">2.1 Supported Operating Systems</title>
<para>
<indexterm significance="normal">
<primary>operating system versions, supported</primary>
</indexterm>
<indexterm significance="normal">
<primary>system requirements</primary>
</indexterm>
<itemizedlist>
<listitem>
<para>Microsoft Windows XP Home SP2 and SP3</para>
</listitem>
<listitem>
<para>Microsoft Windows XP Professional SP2 and SP3</para>
</listitem>
<listitem>
<para>Microsoft Windows XP 64 SP1 and SP2</para>
</listitem>
<listitem>
<para>Microsoft Windows 2003 Server SP1 and SP2 (32-bit and 64-bit Intel)</para>
</listitem>
<listitem>
<para>Microsoft Windows 2003 R2 Server (32-bit and 64-bit Intel)</para>
</listitem>
<listitem>
<para>Microsoft Windows Vista (32-bit and 64-bit Intel)</para>
</listitem>
<listitem>
<para>Microsoft Windows 2008 Server (32-bit and 64-bit Intel)</para>
</listitem>
<listitem>
<para>Microsoft Windows 7 (32-bit and 64-bit Intel)</para>
</listitem>
<listitem>
<para>Microsoft Windows 2008 Server R2 (64-bit Intel)</para>
</listitem>
<listitem>
<para>Microsoft Windows 8 (32-bit and 64-bit Intel)</para>
</listitem>
<listitem>
<para>Microsoft Windows Server 2012 (64-bit Intel)</para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title id="Unsupported_Operating_Systems">2.1.1 Unsupported Operating Systems</title>
<para>
<indexterm significance="normal">
<primary>operating system versions, unsupported</primary>
</indexterm>
<itemizedlist>
<listitem>
<para> Microsoft Windows 95</para>
</listitem>
<listitem>
<para>Microsoft Windows 98</para>
</listitem>
<listitem>
<para>Microsoft Windows 98 OSR2</para>
</listitem>
<listitem>
<para>Microsoft Windows ME</para>
</listitem>
<listitem>
<para>Microsoft NT</para>
</listitem>
<listitem>
<para>Microsoft Windows 2000 Workstation</para>
</listitem>
<listitem>
<para>Microsoft Windows 2000 Server</para>
</listitem>
<listitem>
<para>Microsoft Windows XP Home (pre-SP2)</para>
</listitem>
<listitem>
<para>Microsoft Windows XP Professional (pre-SP2)</para>
</listitem>
<listitem>
<para>Microsoft Windows 8 RT (ARM)</para>
</listitem>
</itemizedlist>
</para>
<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. The last version to support Windows 2000 and XP
SP1 is 1.6.1.</para>
</section>
<section>
<title id="Disk_Space">2.2 Disk Space</title>
<para>
<indexterm significance="normal">
<primary>disk space required</primary>
</indexterm> 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 <link linkend="Regkey_TransarcAFSDaemon_Parameters_CacheSize">the Registry</link> after
installation. The maximum cache size for 32-bit Windows is approximately 1.2GB. On 64-bit
Windows there is no enforced limit on the cache size. </para>
</section>
<section>
<title id="Additional_Software_Packages">2.3 Additional Software Packages</title>
<indexterm significance="normal">
<primary>kerberos for windows</primary>
</indexterm>
<indexterm significance="normal">
<primary>heimdal</primary>
</indexterm>
<para>
<ulink url="https://www.secure-endpoints.com/heimdal">Heimdal</ulink> or <ulink url="http://web.mit.edu/kerberos/dist/index.html">MIT Kerberos for Windows</ulink> 3.2.x if Kerberos v5 authentication support is desired. Heimdal is preferred over MIT Kerberos as it will provide OpenAFS the ability to offer enhanced capabilities in future releases. 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.
See <link linkend="Kerberos_v5_Requirements">3.2 Kerberos v5 Requirements</link> for additional details.
</para>
</section>
</chapter>
<chapter id="chap_3">
<title id="Operational_Notes">Operational Notes</title>
<section>
<title id="Unicode_Support">3.1. Unicode Support</title>
<indexterm significance="normal">
<primary>unicode</primary>
</indexterm>
<indexterm significance="normal">
<primary>character sets</primary>
</indexterm>
<indexterm significance="normal">
<primary>roaming profiles</primary>
</indexterm>
<indexterm significance="normal">
<primary>folder redirection</primary>
</indexterm>
<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,
<ulink url="http://en.wikipedia.org/wiki/Roaming_user_profile">Roaming User Profiles</ulink> and
<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.
</para>
<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
<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.
</para>
<para>It is important to note that AFS file servers are 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>
<para>UNIX AFS can not 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>
<section>
<title>3.1.1. Interoperability with MacOS X</title>
<indexterm>
<primary>MacOS X</primary>
</indexterm>
<para>MacOS X uses UTF-8 Normalization Form D (NFD) whereas Microsoft Windows and most other
applications use UTF-8 Normalization Form C (NFC). The difference is that in NFD Unicode
character sequences containing diacritical marks are decomposed whereas in NFC the Unicode
character sequences use combined characters whenever possible. Whereas Microsoft Windows
can display and manipulate files stored using NFD, MacOS X Finder does have trouble with
filenames that are NFC encoded. All file names stored by the OpenAFS Windows client use
NFC.</para>
</section>
</section>
<section id="Kerberos_v5_Requirements">
<title>3.2. Requirements for Kerberos v5 Authentication</title>
<indexterm significance="normal">
<primary>kerberos for windows</primary>
</indexterm>
<indexterm significance="normal">
<primary>heimdal</primary>
</indexterm>
<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 <ulink url="https://www.secure-endpoints.com/heimdal">Heimdal</ulink> or <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. </para>
<indexterm significance="normal">
<primary>network identity manager</primary>
</indexterm>
<para>The recommended versions of <ulink url="https://www.secure-endpoints.com/heimdal">Heimdal</ulink> and <ulink url="http://web.mit.edu/kerberos/">MIT Kerberos for
Windows</ulink> are 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 <link linkend="Network_Identity_Manager_Provider">AFS Provider</link> installed as part of
OpenAFS for Windows. The most recent version of Network Identity Manager is version 2.1
which is available as an independent upgrade to MIT Kerberos for Windows. Heimdal does not
include a version of Network Identity Manager.</para>
<indexterm significance="normal">
<primary>transarc afs</primary>
</indexterm>
<para>With Heimdal or Kerberos for Windows installed, the OpenAFS for Windows client can
perform authentication to AFS services using Kerberos v5 service tickets as AFS tokens. When
a Kerberos v5 derived AFS token is used, all of the AFS Volume Location and File Servers
within the authenticated cell must support Kerberos v5. If a Kerberos v5 based token is
presented to an AFS server that does not support them, the server will be unable to respond
to the client. Attempts to access AFS volumes stored on such a server will fail with the
Windows STATUS_NO_KERB_KEY (0xC0000322L) error. Kerberos v5 based tokens are supported by
OpenAFS revisions 1.2.8 or later. IBM AFS 3.6 servers do not support Kerberos v5.</para>
<section>
<title id="Active_Directory">3.2.1. Active Directory</title>
<indexterm significance="normal">
<primary>active directory</primary>
</indexterm>
<indexterm significance="normal">
<primary>des-cbc-crc encryption type</primary>
</indexterm>
<para>Microsoft Windows Active Directory can be used as a Kerberos v5 KDC in conjunction
with OpenAFS. <itemizedlist>
<listitem>
<para> 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 traditional
UNIX KDCs due to the inclusion of Windows specific authorization data <ulink url="http://msdn.microsoft.com/en-us/library/cc237917%28v=prot.10%29.aspx">(the
Microsoft PAC)</ulink>. If the issued tickets are larger than 344 bytes, OpenAFS
1.2.x 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. </para>
</listitem>
<listitem>
<para>Second, the Kerberos v5 tickets issued by Windows 2003 Active Directory are
encrypted with the DES-CBC-MD5 encryption type (enctype). OpenAFS 1.2.x servers only
support the DES-CBC-CRC enctype. As a result, OpenAFS 1.2.x 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>
<para>Microsoft has documented in <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. </para>
<para>Note that an Active Directory computer object cannot be used for the afs service
principal. A user object must be used.</para>
</listitem>
<listitem>
<para>Starting with Windows 7 and Windows Server 2008 R2, Microsoft has disabled the
single DES encryption types,<ulink url="http://technet.microsoft.com/en-us/library/dd560670(WS.10).aspx">TechNet:
Changes in Kerberos Authentication</ulink>. DES must be enabled via Group Policy
in order for Active Directory to be used as a KDC for OpenAFS. Enable weak
encryption becuase of AFS... Start > Administrative Tools > Group Policy
Management Expand Forest > Domains > (domain name) > Group Policy Objects
> Default Domain Policy Right-click "Default Domain Policy" and select "Edit"
Expand "Computer Configuration" > "Policies" > "Windows Settings” >
"Security Settings” > "Local Policies” > "Security Options” Double click
"Network security: Configure encryption types allowed for Kerberos” Select "Define
this policy setting", then select "DES_CBC_CRC" and all the others... Press "OK" </para>
</listitem>
</itemizedlist></para>
</section>
<section>
<title id="Using_krb524_Service">3.2.2. The krb524 Service is no longer supported</title>
<indexterm significance="normal">
<primary>krb524</primary>
</indexterm>
<indexterm significance="normal">
<primary>port, 4444/udp</primary>
</indexterm>
<indexterm significance="normal">
<primary>registry value, Use524</primary>
</indexterm>
<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 [14 December 2002], 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 the security holes inherent in Kerberos v4 cross-realm are avoided. Use of cryptographically stronger algorithms for authentication and encryption become a possibility.</para>
<para>Another reason for using Kerberos v5 directly is because the krb524 service runs on port (4444/udp), which has increasingly been blocked by Internet service providers. 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>
<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 typographic case and rely the krb524d service to map the Kerberos v5 client principal name from realm FOO to a Kerberos v4 principal in realm BAR. This allows user@FOO to appear to be user@bar for the purposes of accessing the AFS cell.
</para>
<para>To support this mode of operation OpenAFS for Windows versions 1.4.x through 1.6.x supported a registry value,
<link linkend="Value_Use524">Use524</link>, that forced the use of krb524d within the AFS Authentication Tool and during integrated logon. Previous revisions of this documentation advised that this option should only be used by individuals until such time as their organizations transitioned away from the krb524 service.
</para>
<para>Over the last few years all Kerberos distributions have removed support for Kerberos v4. As a result, OpenAFS can no longer support the krb524d service and the functionality has been removed from the source tree for the 1.7.x release.</para>
<para>As an alternative, sites should be aware 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.
</para>
</section>
<section id="Network_Identity_Manager_Provider">
<title>3.2.3. Network Identity Manager Provider</title>
<indexterm significance="normal">
<primary>network identity manager</primary>
</indexterm>
<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 <ulink url="https://www.secure-endpoints.com/">Secure Endpoints Inc.</ulink> Network Identity
Manager is a multiple identity credential management tool that ships with <ulink url="http://web.mit.edu/kerberos/">MIT Kerberos for Windows</ulink> version 3.0 and
above. The OpenAFS plug-in requires <ulink url="https://www.secure-endpoints.com/heimdal">Heimdal</ulink> or <ulink url="http://web.mit.edu/kerberos/">MIT Kerberos for
Windows</ulink> version 3.1 or above. </para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata format="JPG" fileref="relnotes00.jpg"/>
</imageobject>
</inlinemediaobject>
</para>
<para>The Network Identity Manager replaces the former KFW 2.6.x 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>
<para>
<inlinemediaobject>
<imageobject>
<imagedata format="JPG" fileref="relnotes01.jpg"/>
</imageobject>
</inlinemediaobject>
</para>
<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>
<para>
<inlinemediaobject>
<imageobject>
<imagedata format="JPG" fileref="relnotes02.jpg"/>
</imageobject>
</inlinemediaobject>
</para>
<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>
<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>
<itemizedlist>
<listitem>
<para>one or more AFS tokens are valid</para>
</listitem>
<listitem>
<para>no AFS tokens are present but the AFS service is running</para>
</listitem>
<listitem>
<para>the AFS Service is not running</para>
</listitem>
<listitem>
<para>the AFS Service is running but there is a communication error preventing access to \\AFS</para>
</listitem>
</itemizedlist>
</section>
<section>
<title>3.2.4. Heimdal 1.5, MIT 4.x, and Weak Encryption Types</title>
<para>Just as Microsoft disabled the use of Weak Encryption Types in Windows 7 and Windows
Server 2008 R2, Heimdal and MIT have disabled the use of weak encryption types in their
latest releases. In order to use Heimdal 1.5 or MIT Kerberos 1.9 or later with OpenAFS,
the weak encryption types including DES-CBC-CRC and DES-CBC-MD5 must be enabled. In
Heimdal, this is performed by adding "allow_weak_crypto = true" to the [libdefaults]
section of the %SystemRoot%\ProgramData\Kerberos\krb5.conf file. In MIT KFW 4.x, this is
performed by adding "allow_weak_crypto = true" to the [libdefaults] section of the
%SystemRoot%\ProgramData\MIT\Kerberos5\krb5.ini file.</para>
<para>Futures versions of OpenAFS will not have this requirement.</para>
</section>
</section>
<section>
<title id="Use_of_Microsoft_Loopback">3.3. The Former use of the Microsoft Loopback Adapter by the OpenAFS Client Service</title>
<indexterm significance="normal">
<primary>microsoft loopback adapter</primary>
</indexterm>
<para> This section is preserved for those sites that may want to manually configure the
OpenAFS Client Service to run as an SMB Gateway to AFS instead of using the native IFS file
system redirector driver. When the IFS driver is active, the Microsoft Loopback Adapter is
ignored. The OpenAFS 1.7.x installer will not install a Microsoft Loopback Adapter by
default nor will it remove one if already present on the machine. </para>
<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>
<itemizedlist>
<listitem>
<para>stop the AFS Client Service</para>
</listitem>
<listitem>
<para>bind the "Client for Microsoft Networks" to the MLA</para>
</listitem>
<listitem>
<para>unbind "File and Printer Sharing for Microsoft Networks" from the MLA</para>
</listitem>
<listitem>
<para>disable and then re-enable the MLA</para>
</listitem>
<listitem>
<para>start the AFS Client Service</para>
</listitem>
</itemizedlist>
<para>When the MLA is not installed the NETBIOS name published by the OpenAFS SMB server must be unique in order to avoid name conflicts on 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.
</para>
</section>
<section>
<title id="Using_Freelance_Mode">3.4. Using Freelance (Dynamic Root) Mode to Improve Mobility</title>
<indexterm significance="normal">
<primary>freelance mode</primary>
</indexterm>
<indexterm significance="normal">
<primary>root.afs volume, fake</primary>
</indexterm>
<indexterm significance="normal">
<primary>mount points</primary>
</indexterm>
<indexterm significance="normal">
<primary>symlinks</primary>
</indexterm>
<para>Historically, when the OpenAFS Client Service starts it must mount 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 starts, the
service will terminate unexpectedly. Since many users now use laptops or otherwise operate
in disconnected environments in which a Virtual Private Network (VPN) connection may be
required to access the cell's servers, it is often the case that the "root.afs" volume is
unreachable and the OpenAFS Client Service can not successfully start. </para>
<para>Freelance mode dynamically constructs a fake "root.afs" volume from mount points and
symlinks stored in the local registry. This permits the OpenAFS Client Service to operate
in these environments.</para>
<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
<emphasis>regular path </emphasis>and
<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
<emphasis>read-write path</emphasis>; otherwise the mount point will be a
<emphasis>regular path</emphasis>. These mount points are preserved in the registry at key:
</para>
<para>
<link linkend="Regkey_HKLM_SOFTWARE_OpenAFS_Client_Freelance">HKLM\SOFTWARE\OpenAFS\Client\Freelance</link>
</para>
<para>Additional mount points may be manually created using the "fs mkmount" command. Mount points may be removed using the "fs rmmount" command.</para>
<para>>fs mkmount \\AFS\athena.mit.edu root.cell athena.mit.edu</para>
<para>>fs mkmount \\AFS\.athena.mit.edu root.cell athena.mit.edu -rw</para>
<para>>fs rmmount \\AFS\athena.mit.edu</para>
<para>>fs rmmount \\AFS\.athena.mit.edu</para>
<para>Symlinks may also be created within the Freelance "root.afs" volume.</para>
<para>>symlink make \\afs\link \\afs\athena.mit.edu\user\j\a\jaltman</para>
<para> >symlink list \\afs\link</para>
<para> '\\afs\link' is a symlink to 'athena.mit.edu\user\j\a\jaltman'</para>
<para>>symlink rm \\afs\link</para>
<para>The symlinks are stored in the registry at:</para>
<para>
<link linkend="Regkey_HKLM_SOFTWARE_OpenAFS_Client_Freelance_Symlinks">HKLM\SOFTWARE\OpenAFS\Client\Freelance\Symlinks</link>
</para>
<para><emphasis>NET VIEW \\AFS</emphasis> can be used to browse all of the entries from the command line.</para>
</section>
<section>
<title id="Locating_VLDB_via_DNS">3.5. Locating AFS Volume Database Servers via DNS </title>
<indexterm significance="normal">
<primary>dns, vldb lookups</primary>
</indexterm>
<indexterm significance="normal">
<primary>afsdb dns records</primary>
</indexterm>
<para>The OpenAFS for Windows client will use DNS SRV records and DNS AFSDB records to
discover the location of AFS Volume Database servers when entries for the cell are not
present in either the client's CellServDB registry store or file
(\%ALLUSERSPROFILE%\OpenAFS\Client\CellServDB or \%PROGRAMFILES%\OpenAFS\Client\CellServDB).
Also see <link linkend="Registry_VLDB_Configuration">Registry Configuration for AFS Volume
Database Servers</link>.</para>
</section>
<section>
<title id="Integrated_Logon">3.6. Obtaining AFS Tokens as a Integrated Part of Windows Logon</title>
<indexterm significance="normal">
<primary>integrated logon</primary>
</indexterm>
<indexterm significance="normal">
<primary>single sign-on</primary>
</indexterm>
<indexterm significance="normal">
<primary>kerberos for windows</primary>
</indexterm>
<indexterm significance="normal">
<primary>afslogon.dll</primary>
</indexterm>
<indexterm significance="normal">
<primary>EnableKFW</primary>
</indexterm>
<indexterm significance="normal">
<primary>Use524</primary>
</indexterm>
<indexterm significance="normal">
<primary>tokens</primary>
</indexterm>
<para>OpenAFS for Windows installs a WinLogon Authentication Provider to provide Single
Sign-On functionality (aka Integrated Logon.) Integrated Logon can be used to obtain AFS
tokens 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 "your-file-system.com", then Integrated Logon can be successfully
used if the windows password matches the password assigned to the Kerberos principal
"jaltman@YOUR-FILE-SYSTEM.COM". The realm "YOUR-FILE-SYSTEM.COM" is obtained by performing a
domain name to realm mapping on the hostname of one of the cell's Volume Database
servers.</para>
<para>Integrated Logon is required if roaming user profiles are stored within the AFS file
system. OpenAFS does not provide tools for synchronizing the Windows and Kerberos user
accounts and passwords. Integrated Logon can be enabled or disabled via the <link linkend="Value_LogonOptions">LogonOptions</link> registry value.</para>
<para>When Heimdal or KFW is installed, Integrated Logon will use it to obtain tokens using
Kerberos v5. If you must use the <emphasis role="italic">deprecated</emphasis> kaserver for
authentication instead of Kerberos v5, the use of KFW can be disabled via the <link linkend="Value_EnableKFW">EnableKFW</link> registry value. </para>
<para>Integrated Logon will not transfer Kerberos v5 tickets into the user's logon session credential cache. This is no longer possible on Vista and Windows 7.</para>
<para>Integrated Logon does not have the ability to cache the username and password for the
purpose of obtaining tokens if the Kerberos KDC is inaccessible at logon time.</para>
<para>Integrated Logon supports the ability to obtain tokens for multiple cells. For further
information on how to configure this feature, read about the <link linkend="Value_TheseCells">TheseCells</link> registry value. </para>
<para>Depending on the configuration of the local machine, it is possible for logon
authentication to complete with one of the following user account types:</para>
<para>
<itemizedlist>
<listitem>
<para>Local Machine Account (<emphasis role="italic">LOCALHOST</emphasis> domain)</para>
</listitem>
<listitem>
<para>Domain or Forest Account</para>
</listitem>
<listitem>
<para>Domain or Forest Account NETBIOS-compatible name</para>
</listitem>
<listitem>
<para>Kerberos Principal mapped to a local or domain or forest account</para>
</listitem>
</itemizedlist>
</para>
<para>For each "domain" context, the following properties are configurable:</para>
<itemizedlist>
<listitem>
<para>Obtain AFS Tokens at Logon</para>
<itemizedlist>
<listitem>
<para>Yes</para>
</listitem>
<listitem>
<para>No</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Alternate Kerberos Realm Name - combined with the username to construct a Kerberos
principal</para>
</listitem>
<listitem>
<para>TheseCells - A list of cell names other than the workstation cell for which tokens
should be obtained</para>
</listitem>
<listitem>
<para>Fail Logons Silently</para>
<itemizedlist>
<listitem>
<para>Yes</para>
</listitem>
<listitem>
<para>No</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Logon Script to Execute</para>
</listitem>
<listitem>
<para>Logon Retry Interval</para>
</listitem>
<listitem>
<para>Logon Sleep between Failure Interval</para>
</listitem>
</itemizedlist>
<para>Within a "domain" context it is often desireable to apply alternate rules for a
particular user. The rules can include a username substitution.</para>
<para>
<itemizedlist>
<listitem>
<para>Obtain AFS Tokens at Logon</para>
<itemizedlist>
<listitem>
<para>Yes</para>
</listitem>
<listitem>
<para>No</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Alternate User Name</para>
</listitem>
<listitem>
<para>Alternate Kerberos Realm Name - combined with the username to construct a Kerberos
principal</para>
</listitem>
<listitem>
<para>TheseCells - A list of cell names other than the workstation cell for which tokens
should be obtained</para>
</listitem>
<listitem>
<para>Fail Logons Silently</para>
<itemizedlist>
<listitem>
<para>Yes</para>
</listitem>
<listitem>
<para>No</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Logon Script to Execute</para>
</listitem>
<listitem>
<para>Logon Retry Interval</para>
</listitem>
<listitem>
<para>Logon Sleep between Failure Interval</para>
</listitem>
</itemizedlist>
</para>
<para>The configuration hierarchy is specified in the registry under the
HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain key. For
example:</para>
<para>
<itemizedlist>
<listitem>
<para>...\NetworkProvider\Domain\LOCALHOST\</para>
</listitem>
<listitem>
<para>...\NetworkProvider\Domain\LOCALHOST\Administrator\</para>
</listitem>
<listitem>
<para>...\NetworkProvider\Domain\AD\</para>
</listitem>
<listitem>
<para>...\NetworkProvider\Domain\AD.EXAMPLE.ORG\</para>
</listitem>
</itemizedlist>
</para>
<para> From the perspective of configuration, the Full domain name and the
NETBIOS-compatibility name are separate entities. </para>
</section>
<section>
<title id="AFS_System_Tray">3.7. AFS Authentication Tool Command Line Options</title>
<indexterm significance="normal">
<primary>afscreds.exe</primary>
</indexterm>
<indexterm significance="normal">
<primary>system tray tool</primary>
</indexterm>
<indexterm significance="normal">
<primary>network identity manager</primary>
</indexterm>
<para><emphasis role="italic">The AFS Authentication Tool (afscreds.exe) has been deprecated
in favor of Network Identity Manager. afscreds.exe is no longer installed by default in
the OpenAFS 1.7 release series. The following information is for historical
reference.</emphasis></para>
<para>The AFS Authentication Tool (afscreds.exe) supports several command line options: </para>
<itemizedlist>
<listitem>
<para>-A = autoinit </para>
</listitem>
<listitem>
<para>-E = force existing afscreds to exit</para>
</listitem>
<listitem>
<para>-I = install startup shortcut</para>
</listitem>
<listitem>
<para>-M = renew drive maps (deprecated)</para>
</listitem>
<listitem>
<para>-N = IP address change detection </para>
</listitem>
<listitem>
<para>-Q = quiet mode. do not display start service dialog if afsd_service is not already running</para>
</listitem>
<listitem>
<para>-S = show tokens dialog on startup</para>
</listitem>
<listitem>
<para>-U = uninstall startup shortcut</para>
</listitem>
<listitem>
<para>-X = test and do map share (deprecated)</para>
</listitem>
<listitem>
<para> -Z = unmap drives (deprecated)</para>
</listitem>
</itemizedlist>
<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>
<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>
<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
<link linkend="Value_AfscredsShortcutParams">AfscredsShortcutParams</link> in
<link linkend="appendix_a">Appendix A</link>.
</para>
<para>
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.
</para>
</section>
<section>
<title id="AFS_Client_Admin_Group">3.8. The "AFS Client Admins" Authorization Group</title>
<indexterm significance="normal">
<primary>AFS client administrator authorization group</primary>
</indexterm>
<indexterm significance="normal">
<primary>AFS Client Admins</primary>
</indexterm>
<indexterm significance="normal">
<primary>fs checkservers</primary>
</indexterm>
<indexterm significance="normal">
<primary>fs setcachesize</primary>
</indexterm>
<indexterm significance="normal">
<primary>fs newcell</primary>
</indexterm>
<indexterm significance="normal">
<primary>fs sysname</primary>
</indexterm>
<indexterm significance="normal">
<primary>fs exportafs</primary>
</indexterm>
<indexterm significance="normal">
<primary>fs setcell</primary>
</indexterm>
<indexterm significance="normal">
<primary>fs setserverprefs</primary>
</indexterm>
<indexterm significance="normal">
<primary>fs storebehind</primary>
</indexterm>
<indexterm significance="normal">
<primary>fs setcrypt</primary>
</indexterm>
<indexterm significance="normal">
<primary>fs cscpolicy</primary>
</indexterm>
<indexterm significance="normal">
<primary>fs trace</primary>
</indexterm>
<indexterm significance="normal">
<primary>fs minidump</primary>
</indexterm>
<indexterm significance="normal">
<primary>symlink make</primary>
</indexterm>
<indexterm significance="normal">
<primary>fs makemount</primary>
</indexterm>
<indexterm significance="normal">
<primary>Freelance root.afs volume</primary>
</indexterm>
<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>
<itemizedlist>
<listitem>
<para>checkservers with a non-zero timer value</para>
</listitem>
<listitem>
<para>setcachesize</para>
</listitem>
<listitem>
<para>newcell</para>
</listitem>
<listitem>
<para>sysname with a new sysname list</para>
</listitem>
<listitem>
<para>exportafs</para>
</listitem>
<listitem>
<para>setcell</para>
</listitem>
<listitem>
<para>setserverprefs</para>
</listitem>
<listitem>
<para>storebehind</para>
</listitem>
<listitem>
<para>setcrypt</para>
</listitem>
<listitem>
<para>cscpolicy</para>
</listitem>
<listitem>
<para>trace</para>
</listitem>
<listitem>
<para>minidump</para>
</listitem>
</itemizedlist>
<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>
<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>
<para>Setting the default sysname for a machine should be done via the
<link linkend="Value_SysName">SysName registry value</link> and not via "fs sysname".
</para>
</section>
<section>
<title id="Support_for_UNC_Paths">3.9. OpenAFS Support for UNC Paths </title>
<indexterm significance="normal">
<primary>UNC paths</primary>
</indexterm>
<indexterm significance="normal">
<primary>JP Software</primary>
<secondary>4NT</secondary>
</indexterm>
<indexterm significance="normal">
<primary>JP Software</primary>
<secondary>Take Commands</secondary>
</indexterm>
<indexterm significance="normal">
<primary>PowerShell</primary>
</indexterm>
<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>
<para>Power users that make extensive use of the command line shell, cmd.exe, should consider
using JP Software's Take Command command processor. Unlike cmd.exe, the JPSoftware shells
fully support UNC paths as the current directory. JPSoftware added special recognition for
OpenAFS to its command shells starting in version 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. Take Command 14.03 includes support for OpenAFS IFS
Reparse Points and Hard Links.</para>
<para>JPSoftware's web site is
<ulink url="http://www.jpsoft.com/">http://www.jpsoft.com</ulink>.
</para>
<para>Microsoft PowerShell 1.0, 2.0 and 3.0 also support UNC paths as the current directory. </para>
<para>The Cygwin environment also supports UNC paths as the current directory. Enter AFS paths
with two leading forward slashes: //afs/grand.central.org/software/openafs/. As of Cygwin
1.7.18-1, AFS Symbolic Links are supported natively by the Cygwin environment.</para>
</section>
<section>
<title id="aklog.exe">3.10. aklog.exe</title>
<indexterm significance="normal">
<primary>aklog.exe</primary>
</indexterm>
<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>
<para>
<programlisting format="linespecific">
Usage: aklog [-d] [[-cell | -c] cell [-k krb_realm]]
[[-p | -path] pathname]
[-noprdb] [-force]
[-5]
-d = output debugging information.
cell = zero or more cells for which tokens will be obtained
krb_realm = the kerberos realm of the cell.
pathname = the directory for which authentication is required
-noprdb = don't try to determine AFS ID.
-5 = use Kerberos v5.
(only Kerberos v5 is available)
No commandline arguments means authenticate to the local cell.
</programlisting>
</para>
</section>
<section>
<title id="OpenAFS_Servers_on_Windows">3.11. OpenAFS Servers on Windows are Unsupported</title>
<indexterm significance="normal">
<primary>OpenAFS Servers on Windows</primary>
</indexterm>
<indexterm significance="normal">
<primary>Freelance mode</primary>
</indexterm>
<indexterm significance="normal">
<primary>EnableKFW</primary>
</indexterm>
<indexterm significance="normal">
<primary>power management</primary>
</indexterm>
<indexterm significance="normal">
<primary>kaserver</primary>
</indexterm>
<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>
<para>Known issues include lack of support for power management and dynamic network configuration. Salvager is also known to crash.</para>
<section>
<title id="OpenAFS_Server_Installation">3.11.1. OpenAFS Server Installation</title>
<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.
<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.
</para>
</section>
<section>
<title id="Using_the_AFS_Client_Service_with_OpenAFS_Server">3.11.2. Using the AFS Client Service when the Server is installed</title>
<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>
<itemizedlist>
<listitem>
<para>Freelance mode should be disabled when the AFS Client Service is installed on the same machine as the AFS Server,. Otherwise, it will be impossible 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>
</listitem>
<listitem>
<para>The AFS Server and related tools only support the built in kaserver (Kerberos IV). If kaserver is being used,
<ulink url="http://web.mit.edu/kerberos/">MIT Kerberos for Windows</ulink> should not be installed or must be disabled via the
<link linkend="Value_EnableKFW">EnableKFW</link> registry value.
</para>
</listitem>
<listitem>
<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>
</listitem>
</itemizedlist>
</section>
</section>
<section>
<title id="OpenAFS_Debug_Symbols">3.12. OpenAFS Debugging Symbols and Checked Builds</title>
<indexterm significance="normal">
<primary>debug symbols</primary>
</indexterm>
<indexterm significance="normal">
<primary>checked builds</primary>
</indexterm>
<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 or view OpenAFS
stack traces within Process Explorer or Debug View. This is true for both the release and
the debug versions of the installers. The difference between the release and debug versions
are:</para>
<itemizedlist>
<listitem>
<para>whether or not the binaries were compiled with optimization (release: yes, debug: no)</para>
</listitem>
<listitem>
<para>whether or not the debug symbols are installed by default (release: no, debug: yes)</para>
</listitem>
<listitem>
<para>whether or not
<emphasis>fs trace</emphasis> logging is turned on by default (release: no, debug: yes)
</para>
</listitem>
<listitem>
<para>whether or not additional debug statements were compiled into the binaries (release: no, debug: yes)</para>
</listitem>
</itemizedlist>
</section>
<section>
<title id="Large_File_Support">3.13. Large File (64-bit) Support</title>
<indexterm significance="normal">
<primary>large file support</primary>
</indexterm>
<indexterm significance="normal">
<primary>64-bit file sizes</primary>
</indexterm>
<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 size of files stored on
that server remains 2GB. </para>
</section>
<section>
<title id="Encrypted_AFS_Network_Communication">3.14. Encrypted AFS Network Communication</title>
<indexterm significance="normal">
<primary>encryption</primary>
</indexterm>
<indexterm significance="normal">
<primary>fs setcrypt</primary>
</indexterm>
<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 setcrypt" command. Transitions between "crypt" and "non-crypt" modes are logged to the Windows Application Event Log. </para>
</section>
<section>
<title id="Authenticated_SMB_Access_to_Client_Service">3.15. Authenticated SMB Access to the OpenAFS Client Service</title>
<indexterm significance="normal">
<primary>SMB authentication</primary>
</indexterm>
<indexterm significance="normal">
<primary>NTLM</primary>
</indexterm>
<indexterm significance="normal">
<primary>GSS SPNEGO</primary>
</indexterm>
<para><emphasis>This section is maintained for historical reference and those sites that are manually configuring the OpenAFS Service to act as an SMB gateway. This section does not apply when the OpenAFS IFS redirector driver is in use.</emphasis></para>
<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>
<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>
<para>It should also be noted that because Kerberos v5 authentication cannot be used, it is not possible to digitally sign the SMB communications. On systems that require Digital Signing of SMB Client connections, access to \\AFS will fail with a connection error.</para>
</section>
<section>
<title id="No_More_INI_Files">3.16. IBM AFS INI Files Replaced By Windows Registry Keys</title>
<indexterm significance="normal">
<primary>INI files</primary>
</indexterm>
<indexterm significance="normal">
<primary>CellServDB</primary>
</indexterm>
<indexterm significance="normal">
<primary>AFSCONF</primary>
</indexterm>
<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
<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
<link linkend="Value_CellServDBDir">CellServDBDir</link> registry value or the AFSCONF environment variable can be used to specify an alternative location.
</para>
<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>
</section>
<section>
<title id="Windows_Internet_Connection_Firewall">3.17. Microsoft Windows Internet Connection Firewall</title>
<indexterm significance="normal">
<primary>Windows Internet Connection Firewall</primary>
</indexterm>
<indexterm significance="normal">
<primary>firewall</primary>
</indexterm>
<indexterm significance="normal">
<primary>Back Connection</primary>
</indexterm>
<para>The OpenAFS Client is compatible with the Internet Connection Firewall that debuted with
Windows XP SP2 and Windows 2003 SP1 and the Advanced Firewall that was introduced with
Windows Vista. The Internet Connection Firewall will be automatically configured to allow
the receipt of incoming callback messages from the AFS file server. In addition, if the
OpenAFS Service is manually configured to behave as an SMB Gateway, the appropriate
<emphasis>Back Connection</emphasis> registry entries are added to allow SMB
authentication to be performed across the Microsoft Loopback Adapter. </para>
</section>
<section>
<title id="Browsing_AFS_from_Explorer_Shell">3.18. Browsing AFS from the Explorer Shell and Office</title>
<indexterm significance="normal">
<primary>Explorer Shell</primary>
</indexterm>
<indexterm significance="normal">
<primary>Microsoft Office</primary>
</indexterm>
<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>
</section>
<section>
<title id="Byte_Range_Locking">3.19. Byte Range Locking</title>
<indexterm significance="normal">
<primary>byte range locking</primary>
</indexterm>
<indexterm significance="normal">
<primary>Microsoft Office</primary>
</indexterm>
<indexterm significance="normal">
<primary>EnableServerLocks</primary>
</indexterm>
<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>
<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>
<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.
<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.
</para>
<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>
<itemizedlist mark="bullet">
<listitem>
<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>
</listitem>
<listitem>
<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>
</listitem>
<listitem>
<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>
</listitem>
<listitem>
<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>
</listitem>
<listitem>
<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>
</listitem>
<listitem>
<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>
</listitem>
<listitem>
<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>
</listitem>
</itemizedlist>
<para>If you wish to disable the acquisition of locks from the file server, this can be performed using the
<link linkend="Value_EnableServerLocks">EnableServerLocks</link> registry value.
</para>
</section>
<section>
<title id="Automatic_Discarding_of_Tokens_at_Logoff">3.20. Automatic Discarding of AFS Tokens at Logoff</title>
<indexterm significance="normal">
<primary>tokens</primary>
</indexterm>
<indexterm significance="normal">
<primary>LogoffPreserveTokens</primary>
</indexterm>
<para><emphasis>This section does not apply unless the OpenAFS Service is manually configured as an SMB Gateway.</emphasis></para>
<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>
<para>If there is a need to disable this functionality, the
<link linkend="Value_LogoffPreserveTokens">LogoffPreserveTokens</link> registry value can be used. (see
<link linkend="appendix_a">Appendix A</link>.)
</para>
</section>
<section>
<title id="Windows_Terminal_Server_Installs">3.21. Windows Terminal Server installations</title>
<indexterm significance="normal">
<primary>Terminal Server</primary>
</indexterm>
<indexterm significance="normal">
<primary>Installation</primary>
</indexterm>
<para>The OpenAFS Servers should not be installed on a machine with Terminal Server installed.
The OpenAFS Client is fully compatible with Terminal Services.</para>
</section>
<section>
<title id="Hidden_Dot_Files">3.22. Hidden Dot Files</title>
<indexterm significance="normal">
<primary>HideDotFiles</primary>
</indexterm>
<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
<link linkend="Value_HideDotFiles">HideDotFiles</link> registry value.
</para>
</section>
<section>
<title id="Status_Cache_Limits">3.23. Status Cache Limits</title>
<indexterm significance="normal">
<primary>afs_config.exe</primary>
</indexterm>
<indexterm significance="normal">
<primary>AFS Configuration Control Panel</primary>
</indexterm>
<indexterm significance="normal">
<primary>cache limits</primary>
</indexterm>
<indexterm significance="normal">
<primary>Stats</primary>
</indexterm>
<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>
<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
<link linkend="Value_Stats">Stats</link> registry value.
</para>
</section>
<section>
<title id="NETBIOS_over_TCP">3.24. NETBIOS over TCP/IP must be enabled</title>
<indexterm significance="normal">
<primary>NETBIOS over TCP</primary>
</indexterm>
<para><emphasis role="italic">This section only applies when the IFS client mode is
disabled.</emphasis></para>
<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>
</section>
<section>
<title id="OpenAFS_binaries_digital_signatures">3.25. OpenAFS binaries are digitally signed</title>
<indexterm significance="normal">
<primary>digital signatures</primary>
</indexterm>
<indexterm significance="normal">
<primary>Your File System Inc.</primary>
</indexterm>
<indexterm significance="normal">
<primary>Secure Endpoints Inc.</primary>
</indexterm>
<indexterm significance="normal">
<primary>VerifyServiceSignature</primary>
</indexterm>
<para>The OpenAFS Client Service and related binaries distributed by OpenAFS.org are digitally signed by "Secure Endpoints Inc." or "Your File System 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 when more than one AFS installation is present on a machine simultaneously. Many hours of support time have been wasted tracking down problems caused by the mixture of files from different releases. </para>
<para>
<link linkend="appendix_a">Appendix A</link> documents the "
<link linkend="Value_VerifyServiceSignature">VerifyServiceSignature</link>" registry value which can be used to disable the signature check. The file version check cannot be disabled.
</para>
</section>
<section>
<title id="Maximum_Cache_Size">3.26. Maximum Size of the AFSCache File</title>
<indexterm significance="normal">
<primary>cache size</primary>
</indexterm>
<para>The maximum cache size on 32-bit Windows is approximately 1.2GB. 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>
<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>
</section>
<section>
<title id="Filename_Character_Sets">3.27. Filename Character Sets</title>
<indexterm significance="normal">
<primary>character sets</primary>
</indexterm>
<indexterm significance="normal">
<primary>StoreAnsiFilenames</primary>
</indexterm>
<para><emphasis>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.</emphasis></para>
<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>
<informaltable frame="all">
<tgroup rowsep="1" align="left" colsep="1" cols="1">
<colspec colwidth="442pt" colname="c1"/>
<tbody>
<row>
<entry>
<para> [Ç] 128 08/00 200 80 C cedilla</para>
<para> [ü] 129 08/01 201 81 u diaeresis</para>
<para> [é] 130 08/02 202 82 e acute</para>
<para> [â] 131 08/03 203 83 a circumflex</para>
<para> [ä] 132 08/04 204 84 a diaeresis</para>
<para> [à] 133 08/05 205 85 a grave</para>
<para> [å] 134 08/06 206 86 a ring</para>
<para> [ç] 135 08/07 207 87 c cedilla</para>
<para> [ê] 136 08/08 210 88 e circumflex</para>
<para> [ë] 137 08/09 211 89 e diaeresis</para>
<para> [è] 138 08/10 212 8A e grave</para>
<para> [ï] 139 08/11 213 8B i diaeresis</para>
<para> [î] 140 08/12 214 8C i circumflex</para>
<para> [ì] 141 08/13 215 8D i grave</para>
<para> [Ä] 142 08/14 216 8E A diaeresis</para>
<para> [Å] 143 08/15 217 8F A ring</para>
<para> [É] 144 09/00 220 90 E acute</para>
<para> [æ] 145 09/01 221 91 ae diphthong</para>
<para> [Æ] 146 09/02 222 92 AE diphthong</para>
<para> [ô] 147 09/03 223 93 o circumflex</para>
<para> [ö] 148 09/04 224 94 o diaeresis</para>
<para> [ò] 149 09/05 225 95 o grave</para>
<para> [û] 150 09/06 226 96 u circumflex</para>
<para> [ù] 151 09/07 227 97 u grave</para>
<para> [ÿ] 152 09/08 230 98 y diaeresis</para>
<para> [Ö] 153 09/09 231 99 O diaeresis</para>
<para> [Ü] 154 09/10 232 9A U diaeresis</para>
<para> [ø] 155 09/11 233 9B o slash</para>
<para> [£] 156 09/12 234 9C Pound sterling sign</para>
<para> [Ø] 157 09/13 235 9D O slash</para>
<para> [×] 158 09/14 236 9E Multiplication sign</para>
<para> [ƒ] 159 09/15 237 9F Florin sign</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>The pre-1.5.50 OpenAFS Client provided an optional registry value,
<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.
</para>
<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
<link linkend="Value_StoreAnsiFilenames">StoreAnsiFilenames</link> option is no longer supported.
</para>
</section>
<section>
<title id="Character_Set_Issues_Roaming_Profiles">3.28. Character Set Issues with Roaming Profiles</title>
<indexterm significance="normal">
<primary>character sets</primary>
</indexterm>
<indexterm significance="normal">
<primary>roaming profiles</primary>
</indexterm>
<para><emphasis>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.</emphasis></para>
<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>
<para>Versions of OpenAFS for Windows 1.5.50 and above do not suffer from these issues.</para>
</section>
<section>
<title id="AFSCache_File">3.29. The AFSCache File</title>
<indexterm significance="normal">
<primary>AFSCache</primary>
</indexterm>
<indexterm significance="normal">
<primary>cache file</primary>
</indexterm>
<indexterm significance="normal">
<primary>SysInternals</primary>
</indexterm>
<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>
<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 formatted NTFS and using a Solid State Disk, 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>
</section>
<section>
<title id="Restricting_OpenAFS_Service_Start_and_Stop">3.30. Restricting OpenAFS Client Service Start and Stop</title>
<indexterm significance="normal">
<primary>service start restrictions</primary>
</indexterm>
<indexterm significance="normal">
<primary>TransarcAFSDaemon</primary>
</indexterm>
<indexterm significance="normal">
<primary>afsdacl.exe</primary>
</indexterm>
<para>A command line tool, afsdacl.exe, can be used to restrict the ability to start and stop the OpenAFS Client Service.</para>
<para>
<programlisting format="linespecific">
afsdacl : Set or reset the DACL to allow starting or stopping
the afsd service by any ordinary user.
Usage: afsdacl [-set | -reset] [-show]
-set : Sets the DACL
-reset : Reset the DACL
-show : Show current DACL (SDSF)
</programlisting>
</para>
</section>
<section>
<title id="SysName_List">3.31. The @sys Name List</title>
<indexterm significance="normal">
<primary>@sys</primary>
</indexterm>
<indexterm significance="normal">
<primary>fs sysname</primary>
</indexterm>
<indexterm significance="normal">
<primary>SysName</primary>
</indexterm>
<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>
<para>The IFS redirector driver is aware of the process type. On 64-bit systems, there are two
@sys name lists "SysName" which is used for the WOW64 environment and "SysName64" which is
used for the 64-bit environment. If "SysName64" is not provided, "SysName" is used for all
processes.</para>
</section>
<section>
<title id="Symlinks_to_AFS_UNC_Paths">3.32. Symlinks to AFS UNC Paths</title>
<indexterm significance="normal">
<primary>UNC paths</primary>
</indexterm>
<indexterm significance="normal">
<primary>symlinks</primary>
</indexterm>
<indexterm significance="normal">
<primary>path separators</primary>
</indexterm>
<indexterm significance="normal">
<primary>symlink.exe</primary>
</indexterm>
<indexterm significance="normal">
<primary>symlink make</primary>
</indexterm>
<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>
<para>The <emphasis>symlink make</emphasis> command will automatically translate \\AFS\... to /afs/... for you.</para>
</section>
<section>
<title id="Cache_Manager_Debugging">3.33. Cache Manager Debugging</title>
<indexterm significance="normal">
<primary>debugging the cache manager</primary>
</indexterm>
<indexterm significance="normal">
<primary>cmdebug.exe</primary>
</indexterm>
<para>The OpenAFS Client implements the Cache Manager Debugging RPC Interface. The CM debugger can be queried with <ulink url="http://docs.openafs.org/Reference/1/cmdebug.html">cmdebug.exe</ulink>. </para>
<para>
<programlisting format="linespecific">
Usage: cmdebug -servers <server machine> [-port <IP port>] [-long] [-refcounts]
[-callbacks] [-ctime] [-addrs] [-cache] [-cellservdb] [-help]
Where: -long print all info
-refcounts print only cache entries with positive reference counts
-callbacks print only cache entries with callbacks
-ctime print human readable expiration time
-addrs print only host interfaces
-cache print only cache configuration
-cellservdb print only cellservdb info
</programlisting>
</para>
</section>
<section>
<title id="Windows_Logon_Caching_vs_Kerberos_Logons">3.34. Windows Logon Caching vs. Kerberos Logons</title>
<indexterm significance="normal">
<primary>windows logon caching</primary>
</indexterm>
<indexterm significance="normal">
<primary>kerberos</primary>
</indexterm>
<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 or Windows 7.</para>
</section>
<section>
<title id="Initial_Server_Preferences">3.35. Initial Server Preferences</title>
<indexterm significance="normal">
<primary>server preferences</primary>
</indexterm>
<indexterm significance="normal">
<primary>fs setserverprefs</primary>
</indexterm>
<indexterm significance="normal">
<primary>setting server preferences</primary>
</indexterm>
<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
<link linkend="appendix_a">Appendix A</link> for details on the "
<link linkend="Regkey_HKLM_SOFTWARE_OpenAFS_Client_ServerPreferences_VLDB">Server Preferences</link>" keys.
</para>
</section>
<section>
<title id="File_Timestamps_and_DST">3.36. File Timestamps and Daylight Saving Time</title>
<indexterm significance="normal">
<primary>timestamps</primary>
</indexterm>
<indexterm significance="normal">
<primary>DST</primary>
</indexterm>
<indexterm significance="normal">
<primary>UTC</primary>
</indexterm>
<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>
<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>
</section>
<section>
<title id="Windows_RPC_client_support">3.37. Windows RPC client support must be installed </title>
<indexterm significance="normal">
<primary>RPC client support</primary>
</indexterm>
<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>
<para> HKLM "SOFTWARE\Microsoft\RPC\ClientProtocols" "ncacn_np"</para>
<para> HKLM "SOFTWARE\Microsoft\RPC\ClientProtocols" "ncacn_ip_tcp"</para>
<para> HKLM "SOFTWARE\Microsoft\RPC\ClientProtocols" "ncadg_ip_udp"</para>
<para> HKLM "SOFTWARE\Microsoft\RPC\ClientProtocols" "ncacn_http"</para>
</section>
<section>
<title id="Generating_Minidumps">3.38. Generating Minidumps of the OpenAFS Client Service</title>
<indexterm significance="normal">
<primary>minidumps</primary>
</indexterm>
<indexterm significance="normal">
<primary>fs minidump</primary>
</indexterm>
<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>
</section>
<section>
<title id="AFS_UUIDs_vs_System_Cloning">3.39. AFS Client Universally Unique Identifiers (UUIDs) vs. System Cloning or Virtual Machine Cloning</title>
<indexterm significance="normal">
<primary>UUIDs</primary>
</indexterm>
<indexterm significance="normal">
<primary>system cloning</primary>
</indexterm>
<indexterm significance="normal">
<primary>vm cloning</primary>
</indexterm>
<indexterm significance="normal">
<primary>NonPersistentCaching</primary>
</indexterm>
<indexterm significance="normal">
<primary>instloop.exe</primary>
</indexterm>
<indexterm significance="normal">
<primary>msiexec.exe</primary>
</indexterm>
<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>
<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
<emphasis>fs uuid -generate</emphasis> must be executed after the the clone is created.
<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></para>
<para>For lab environments that wish to erase all cached data on each restart, the
<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.
</para>
<para><emphasis role="italic">[SMB only]</emphasis> 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 " <emphasis>instloop.exe</emphasis> – <emphasis>i</emphasis>"
command. Instloop.exe can be extracted from the MSI installer by performing an
administrative install via <emphasis>msiexec.exe /a</emphasis>. </para>
</section>
<section>
<title id="Delayed_Write_Errors">3.40. Delayed Write Errors with Microsoft Office Applications</title>
<indexterm significance="normal">
<primary>delayed write errors</primary>
</indexterm>
<indexterm significance="normal">
<primary>ConnDeadTimeout</primary>
</indexterm>
<indexterm significance="normal">
<primary>SMBAsyncStoreSize</primary>
</indexterm>
<indexterm significance="normal">
<primary>EnableSMBAsyncStore</primary>
</indexterm>
<indexterm significance="normal">
<primary>SMB timeouts</primary>
</indexterm>
<para><emphasis>This section does not apply unless the OpenAFS Service is manually configured as an SMB Gateway.</emphasis></para>
<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>
<para>The CIFS session timeout defaults to 45 seconds and can be increased by modifying the
<link linkend="Value_ConnDeadTimeout">ConnDeadTimeout registry value</link>.
</para>
<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>
<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
<link linkend="Value_SMBAsyncStoreSize">SMBAsyncStoreSize</link> registry value. Asynchronous store operations can also be disabled using the
<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.
</para>
<para>During the first quarter of 2009 Microsoft added new functionality to the SMB Redirector which permits an extended timeout period to be used
for an enumerated list of Netbios server names. This functionality was distributed in Service Pack 2 for Vista and 2008 and is incorporated
into the RTM releases of Windows 7 and Server 2008 R2. Updates to Windows XP (KB916204), XP64 (KB969289), and Server 2003 (KB969289) were
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
from 45 seconds to 10 minutes.</para>
</section>
<section>
<title id="Global_Drives">3.41. Global Drives (aka Service Drive Letters) are no longer supported by Microsoft</title>
<indexterm significance="normal">
<primary>global drives</primary>
</indexterm>
<indexterm significance="normal">
<primary>service drive letters</primary>
</indexterm>
<indexterm significance="normal">
<primary>path ioctl failures</primary>
</indexterm>
<para>The Global Drive auto-mount feature has been deprecated due to the following Microsoft
KB article.</para>
<para>
<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>
</para>
<para>The article says that services mounting drive letters are no longer supported by Microsoft and may act unpredictably.
The experience other users have had is that if the connection to the OpenAFS CIFS/SMB server is terminated by the
Windows CIFS client, the drive mapping may not be re-established until the machine is rebooted.</para>
<para>OpenAFS supports UNC paths and whenever possible applications should be modified to use UNC form
\\AFS\<cellname>\<path> instead of drive letters.</para>
<para>Another problem with service mounted drive letters is that the drives are reported as local disk devices
and cannot be resolved as being mapped to the \\AFS name space. As a result, AFS path ioctl operations will
fail. The fs.exe and symlink.exe command line tools and the AFS Explorer Shell extension will not operate
on service mounted drive letters.</para>
</section>
<section>
<title id="SixtyFour-bit_Windows">3.42. 64-bit Microsoft Windows Installations</title>
<indexterm significance="normal">
<primary>64-bit Windows</primary>
</indexterm>
<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 it is required that a separate 32-bit OpenAFS Tools set be installed. This is especially true when the IFS redirector is in use as the 32-bit Network Provider DLL must be installed in order for 32-bit applications to access drive letters mapped to \\AFS.</para>
<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>
</section>
<section>
<title id="Windows_Vista_Known_Issues">3.43. Known Issues with Microsoft Windows Vista,
Windows 7, Server 2008 [R2], Windows 8 and Server 2012</title>
<indexterm significance="normal">
<primary>windows vista</primary>
</indexterm>
<indexterm significance="normal">
<primary>windows 2008</primary>
</indexterm>
<indexterm significance="normal">
<primary>windows 7</primary>
</indexterm>
<para>Windows Vista, Windows 7, and Server 2008 [R2] implement
<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.
</para>
<para>The help files provided with OpenAFS are in .HLP format. <ulink
url="http://support.microsoft.com/kb/917607">Windows Vista, Windows 7, Server 2008 [R2],
Windows 8 and Server 2012 do not include a help engine for this format.</ulink>
</para>
<para><emphasis>The following items only apply when the OpenAFS Service is manually configured as an SMB Gateway.</emphasis></para>
<para>OpenAFS for Windows works with Microsoft Windows Vista, Windows 7 and Server 2008 [R2] from both the command prompt and the Explorer Shell.
When performing an upgrade from earlier versions of Microsoft Windows the Microsoft Loopback Adapter (MSLA) will be uninstalled.
OpenAFS should be re-installed after the Windows Upgrade installation to restore the MSLA configuration.</para>
<para>Due to a feature change in Windows Vista's Plug-n-Play network stack, during a standby/hibernate operation the
MSLA is disabled just as any other hardware device would be. This causes the OpenAFS Client's network binding to be lost.
As a result, it takes anywhere from 30 to 90 seconds after the operating system is resumed for access to the OpenAFS Client
and the AFS file name space to be restored. Until the network bindings have been re-established, ticket managers and other
tools will report that the "AFS Client Service may not have been started".</para>
</section>
<section>
<title id="AFS_Share_Direct_Access_to_Volumes">3.44. AFS Share Name Syntax Provides Direct Access to Volumes</title>
<indexterm significance="normal">
<primary>share names</primary>
</indexterm>
<indexterm significance="normal">
<primary>afs volumes - direct access</primary>
</indexterm>
<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>
<para>\\AFS\<cell><mount point type><volume>\</para>
<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>
<para>Examples include:</para>
<para> \\AFS\athena.mit.edu#user.jaltman\</para>
<para> \\AFS\athena%user.jaltman\</para>
<para> \\AFS\athena.mit.edu# 537235559\</para>
</section>
<section>
<title id="Differences_between_Windows_and_Unix">3.45. Differences between Windows and UNIX <emphasis>fs examine</emphasis></title>
<indexterm significance="normal">
<primary>fs examine</primary>
</indexterm>
<indexterm significance="normal">
<primary>fs chown</primary>
</indexterm>
<indexterm significance="normal">
<primary>fs chgrp</primary>
</indexterm>
<indexterm significance="normal">
<primary>fs chmod</primary>
</indexterm>
<indexterm significance="normal">
<primary>owner information</primary>
</indexterm>
<indexterm significance="normal">
<primary>group information</primary>
</indexterm>
<para>The OpenAFS for Windows version of "fs examine" provide two additional lines of output when compared to the
UNIX implementation. These lines include the owner and group information for the file as well as the volume status.
The Windows output will also indicate the type of object {File, Directory, Mountpoint, Symlink, ...} that was examined.</para>
<para>[C:\]fs examine \\afs\athena#user.jaltman</para>
<para>Directory \\afs\athena#user.jaltman (537235559.1.1) contained in cell athena.mit.edu</para>
<para>
<emphasis role="bold">Owner jaltman (28180) Group jaltman (28180)</emphasis>
</para>
<para>Volume status for vid = 537235559 named user.jaltman is</para>
<para>Current disk quota is 1500000</para>
<para>Current blocks used are 1244184</para>
<para>The partition has 151945877 blocks available out of 511163724</para>
<para>
<emphasis role="bold">Volume is online</emphasis>
</para>
<para>
</para>
<para>The object owner and group and UNIX mode information is not available on Microsoft Windows via any other method.</para>
<para>To set the owner use <emphasis>fs chown -owner <user name or id> [-path <dir/file path>+] [-literal]</emphasis></para>
<para>To set the group use <emphasis>fs chgrp -group <user name or id> [-path <dir/file path>+] [-literal]</emphasis></para>
<para>To set the UNIX mode use <emphasis>fs chmod -mode <UNIX mode bits> [-path <dir/file path>+] [-literal]</emphasis></para>
</section>
<section>
<title id="fs_Command_Literal_Option">3.46. Literal evaluation of AFS Symlink and MountPoint objects via fs commands</title>
<indexterm significance="normal">
<primary>-literal</primary>
</indexterm>
<indexterm significance="normal">
<primary>fs examine</primary>
</indexterm>
<indexterm significance="normal">
<primary>fs flush</primary>
</indexterm>
<indexterm significance="normal">
<primary>fs whereis</primary>
</indexterm>
<indexterm significance="normal">
<primary>fs whichcell</primary>
</indexterm>
<para>Beginning with the 1.5.31 release, the fs commands <emphasis>examine</emphasis>,
<emphasis>flush</emphasis>, <emphasis>getuseraccess</emphasis>, <emphasis>whereis</emphasis>, and
<emphasis>whichcell</emphasis> provide a new command-line parameter,
<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 target of the
symlink or mountpoint. </para>
</section>
<section>
<title id="Out_of_Quota_Errors">3.47. Out of Quota errors</title>
<indexterm significance="normal">
<primary>out of quota</primary>
</indexterm>
<indexterm significance="normal">
<primary>quotas</primary>
</indexterm>
<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>
</section>
<section id="Linked_Cells">
<title>3.48. Linked Cells</title>
<indexterm significance="normal">
<primary>linked cells</primary>
</indexterm>
<indexterm significance="normal">
<primary>cell renaming</primary>
</indexterm>
<indexterm significance="normal">
<primary>cell splitting</primary>
</indexterm>
<indexterm significance="normal">
<primary>cell merging</primary>
</indexterm>
<indexterm significance="normal">
<primary>CellServDB</primary>
</indexterm>
<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>
<itemizedlist mark="bullet">
<listitem>
<para>a test cell which provides substitutes for a subset of the volumes in the linked production cell</para>
</listitem>
<listitem>
<para>a cell renaming</para>
</listitem>
<listitem>
<para>a cell splitting</para>
</listitem>
<listitem>
<para>a cell merger</para>
</listitem>
</itemizedlist>
<para>Two cells are linked in the CellServDB file:</para>
<para>
<programlisting format="linespecific">
>cell-one cell-two #Description
...
>cell-two cell-one #Description
...
</programlisting>
</para>
<para>aklog and Network Identity Manager will automatically obtain tokens for the linked cell when tokens for the other cell is specified.
</para>
</section>
<section id="Registry_VLDB_Configuration">
<title>3.49 Registry Alternative to CellServDB File</title>
<indexterm significance="normal">
<primary>vldb server locations</primary>
</indexterm>
<indexterm significance="normal">
<primary>CellServDB</primary>
</indexterm>
<para>Beginning with the 1.5.60 release, the <link linkend="Regkey_HKLM_SOFTWARE_OpenAFS_Client_CellServDB">[HKLM\SOFTWARE\OpenAFS\Client\CellServDB]</link>
registry key can be used to distribute Volume Database Server location information either as a supplement to the <emphasis>CellServDB file</emphasis> or
as a substitute for it. The precedence order for lookups is: Registry, File, and then DNS.</para>
</section>
<section>
<title id="HTMLHelp_Documentation">3.50 Release Notes Converted to Windows HTML Help</title>
<indexterm significance="normal">
<primary>HTMLHelp</primary>
</indexterm>
<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
of raw HTML pages.</para>
</section>
<section>
<title id="MSRPC_Services">3.51. Support for Microsoft RPC Services: WKSSVC and SRVSVC</title>
<indexterm significance="normal">
<primary>Explorer Shell</primary>
</indexterm>
<indexterm significance="normal">
<primary>Microsoft Office</primary>
</indexterm>
<para>Beginning with the 1.5.62 release, the OpenAFS client supports named pipes and the
Microsoft RPC Services WKSSVC and SRVSVC. This permits a significantly improved Netbios
Server browsing experience with both the <emphasis>NET VIEW \\AFS</emphasis> command and the
Explorer Shell. No longer will Windows display truncated cell names as available network
shares. The network share properties will also include the object type and and the target of
symlinks and mount points.</para>
</section>
<section>
<title id="fs_newcell_differences">3.52. Differences between Windows and UNIX <emphasis>fs newcell</emphasis></title>
<indexterm significance="normal">
<primary>fs newcell</primary>
</indexterm>
<para>
The OpenAFS for Windows version of "fs newcell" prior to 1.5.74 behaved quite differently than its UNIX counterpart.
Instead of adding cell server information for a new cell, the command simply caused the cache manager to destroy all of its
cell server information and then reload it the next time the server list for a cell is needed. The UNIX version explicitly
replaces the server list for a cell with a new list.
</para>
<para>
Beginning with the 1.5.75 release, the Windows version will continue to behave as prior versions did when no parameters
are specified but will accept an extended UNIX command-line syntax as well. In addition to the UNIX parameters,
the Windows "fs newcell" command accepts four new ones:
</para>
<itemizedlist>
<listitem>
<para>[-fsport <cell's fileserver port>]</para>
<para>Specifies an alternate port number at which the cell's file servers are listening</para>
</listitem>
<listitem>
<para>[-vlport <cell's vldb server port>]</para>
<para>Specifies an alternate port number at which the cell's volume location database servers are listening</para>
</listitem>
<listitem>
<para>[-registry]</para>
<para>Instructs the cache manager to save the cell server information to the registry database</para>
</listitem>
<listitem>
<para>[-dns]</para>
<para>Indicates that the cell server information should be obtained via DNS SRV or DNS AFSDB records</para>
</listitem>
</itemizedlist>
</section>
<section>
<title id="openafs_reparse_points">3.53. AFS Mount Points and Symlinks are Reparse Points</title>
<indexterm significance="normal">
<primary>reparse points</primary>
</indexterm>
<indexterm significance="normal">
<primary>mount points</primary>
</indexterm>
<indexterm significance="normal">
<primary>symlinks</primary>
</indexterm>
<para> The AFS redirector driver represents all AFS mount points and AFS symlinks as reparse
points within the file system name space using a Microsoft assigned tag value. Tools that
are OpenAFS reparse point aware can create, query and remove AFS symlinks and mount points
without requiring knowledge of AFS pioctls. The explorer shell will be able to delete a
mount point or symlink as part of a recursive directory tree removal without crossing into
the reparse point target. </para>
<para>The Explorer Shell displays Symlinks and Mount Points using overlay icons.</para>
<para><inlinegraphic fileref="relnotes03.jpg" align="center" arch=""/></para>
<para>Beginning with 1.7.22, AFS Symlinks are represented as Microsoft Symlink reparse points
instead of an OpenAFS specific reparse point. Symlinks can now be created using the Win32
<ulink
url="http://msdn.microsoft.com/en-us/library/windows/desktop/aa363866%28v=vs.85%29.aspx"
>CreateSymbolicLink</ulink> API and follow all of the behaviors of Microsoft Windows'
<ulink
url="http://msdn.microsoft.com/en-us/library/windows/desktop/aa365680%28v=vs.85%29.aspx"
>Symbolic Links</ulink>. Any tool capable of creating symbolic links on NTFS can now do
so within AFS.</para>
<para>Symbolic Links to Files are not supported by all Microsoft Windows applications because
directory enumerations, GetFileAttributes and GetFileAttributesEx return the attributes and
size of the Symbolic Link and not that of the target file. Applications that treat the
size of the Symbolic Link as the size of the target file will misbehave. All Java releases
1.6.x and earlier and all .NET applications as of this writing use the Symbolic Link size as
the size of the target file. Java 1.7 correctly processes Symbolic Links.</para>
</section>
<section>
<title id="authentication_groups">3.54. AFS Authentication Groups</title>
<indexterm significance="normal">
<primary>authentication groups</primary>
</indexterm>
<indexterm significance="normal">
<primary>PAG</primary>
</indexterm>
<indexterm significance="normal">
<primary>tokens</primary>
</indexterm>
<para>
When the OpenAFS Service is configured as an SMB Gateway, all AFS Tokens are associated with Windows user names.
With the IFS redirector driver, tokens are associated with Authentication Groups.
By default, an authentication group is allocated for each User SID
and Logon Session Id combination. In addition, it is possible for
processes to create additional Authentication Groups. Each thread in
a process can select an Authentication Group within the process as the
active Authentication Group.
</para>
<para>
One of the significant benefits of Authentication Groups within the
Windows environment is that Windows services (svchost.exe, csrss.exe,
etc.) which impersonate user processes will seamlessly gain access
to the user's AFS credentials for the lifetime of the impersonation.
</para>
</section>
<section>
<title id="ifs_known_issues">3.55. Known IFS redirector driver limitations</title>
<indexterm significance="normal">
<primary>IFS redirector</primary>
</indexterm>
<indexterm significance="normal">
<primary>known issues</primary>
</indexterm>
<para>
The following is a list of known issues when using the IFS redirector driver:
<itemizedlist>
<listitem>
<para>Adobe Reader Protected Mode prevents saving PDF documents to AFS. </para>
<para>
In Acrobat Reader 9.3.2 Adobe added a new security feature "Protected
Mode" which is enabled by default. Protected mode runs AcroRd32.exe in
a sandbox and prevents undesirable network access. The release notes
with all versions of Reader since 9.3.2 indicate that DFS and NFS
network paths are inaccessible when Protected Mode is on.
</para>
</listitem>
<listitem>
<para>Command Prompt .LNK files do not behave properly when stored within AFS <itemizedlist>
<listitem>
<para>Custom properties will be ignored.</para>
</listitem>
<listitem>
<para>It is not possible to make changes to the LNK properties.</para>
</listitem>
</itemizedlist> These issues are the result of the <emphasis role="italic">Console
Window Host</emphasis> process (conhost.exe) running outside the logon session's
authentication group. While conhost.exe impersonates the Windows user, it does not
impersonate a logon session process. As a result, it has no tokens and cannot access
the LNK file.</para>
</listitem>
<listitem>
<para>The Windows File System <ulink url="http://msdn.microsoft.com/en-us/library/ff549293%28v=vs.85%29.aspx">Volume Query Quota Interface</ulink> is not implemented. As a result, AFS quota information is not available to application processes or end users via Windows dialogs.</para>
</listitem>
<listitem>
<para>The Windows <ulink url="https://secure.wikimedia.org/wikipedia/en/wiki/Shadow_Copy">Volume Shadow Copy Service</ulink> is not implemented. As a result, AFS backup volumes are not accessible via the Explorer Shell.</para>
</listitem>
<listitem>
<para>There is no support for storing DOS attributes such as Hidden, System, or Archive. </para>
</listitem>
<listitem>
<para>There is no support for Alternate Data Streams as required by Windows User Account
Control to store Zone Identity data. </para>
</listitem>
<listitem>
<para>There is no support for Extended Attributes. </para>
</listitem>
<listitem>
<para>There is no support for <ulink
url="https://blogs.technet.com/b/hugofe/archive/2010/06/21/windows-2008-access-based-enumeration-abe.aspx"
>Access Based Enumeration</ulink>. </para>
</listitem>
<listitem>
<para>There is no support for <ulink
url="https://secure.wikimedia.org/wikipedia/en/wiki/Windows_Management_Instrumentation"
>Windows Management Instrumentation</ulink>
</para>
</listitem>
<listitem>
<para>There is no support for <ulink
url="http://msdn.microsoft.com/en-us/library/aa363997%28v=vs.85%29.aspx">Distributed
Link Tracking and Object Identifiers</ulink>
</para>
</listitem>
<listitem>
<para>There is no support for storing <ulink
url="http://msdn.microsoft.com/en-us/magazine/cc982153.aspx">Windows Access Control
Lists</ulink>. Only the AFS ACLs are enforced. </para>
</listitem>
<listitem>
<para>There is a bug in the Explorer Shell which can result in the Shell responding to a
Ctrl-V (Paste) operation with an out of space error. The bug is that the Shell
queries the root directory of the UNC Path or Drive Letter for free space instead of
the path in which the Paste is being performed. To work around the bug, select a
directory in another volume under the same root and then return to the target
directory before initiating the Paste. Performing the Paste using the Context Menu
instead of Ctrl-V will avoid triggering the bug.</para>
</listitem>
<listitem>
<para>Windows file systems support a maximum of 31 reparse points (mount points or
symbolic links) within a path.</para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title id="windows8_changes">3.56. Changes for Windows 8 and Server 2012</title>
<indexterm significance="normal">
<primary>Windows 8</primary>
</indexterm>
<indexterm significance="normal">
<primary>Server 2012</primary>
</indexterm>
<para>
In Windows 8 and Server 2012 Microsoft has introduced a new file system, ReFS, and has begun the process of transitioning away from several legacy file system properties including 8.3 compatible short names for all file system objects.
The OpenAFS file system has followed suit and is disabling automatic generation of 8.3 compatible names on Windows 8 and Server 2012.
</para>
</section>
<section>
<title id="explorer_read_only_volume_bug">3.57. The Explorer Shell, Drive Letter Mappings, and Read Only Volumes</title>
<indexterm significance="normal">
<primary>explorer shell</primary>
</indexterm>
<indexterm significance="normal">
<primary>drive letter mappings</primary>
</indexterm>
<indexterm significance="normal">
<primary>.readonly volumes</primary>
</indexterm>
<para>File systems can expose a variety of information about the underlying volumes they serve
to applications. All AFS volumes are described as supporting Case Preservation, Hard Links,
Reparse Points and Unicode characters. For .readonly volumes the file system can indicate
that the volume is a Read Only Volume. The benefit of doing so is that applications such as
the Explorer Shell can alter their behavior to improve the user experience. For example,
when the volume is reported as read-only the Explorer Shell can remove the Rename, Delete,
and other file modifying operations from the user interface. Unfortunately, the Windows 7
Explorer Shell is broken with regards to Volume Information queries when issued on Network
Mapped Drive Letters. Instead of performing a volume information query on the current
directory, the Explorer Shell only queries the root directory of the mapped drive letter.
As a result, if the drive letter is mapped to a .readonly volume, all paths accessed via the
drive letter are considered to be read-only even when they are not. This behavior is fixed
in Windows 8 and Server 2012.</para>
<para>Due to this bug, OpenAFS on Windows 7 and below does not report the
<ulink url="http://msdn.microsoft.com/en-us/library/windows/desktop/aa964920%28v=vs.85%29.aspx">FILE_READ_ONLY_VOLUME</ulink>
flag as part of the volume information. The Explorer Shell properly
queries the volume information for UNC paths. If network mapped drive letters are not used,
it is often convenient if the FILE_READ_ONLY_VOLUME flag is reported. This can be
configured using the <link linkend="Regkey_TransarcAFSDaemon_Parameters_VolumeInfoReadOnlyFlag">VolumeInfoReadOnlyFlag</link> registry value.</para>
</section>
</chapter>
<chapter id="chap_4">
<title id="How_to_Debug_Problems">How to Troubleshoot Problems with OpenAFS for Windows</title>
<para>
<indexterm significance="normal">
<primary>debugging</primary>
</indexterm>
<indexterm significance="normal">
<primary>troubleshooting</primary>
</indexterm>
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>
<section>
<title id="pioctl_debugging">4.1. pioctl debugging (
<link linkend="Value_IoctlDebug">IoctlDebug</link> registry key)
</title>
<indexterm significance="normal">
<primary>IoctlDebug</primary>
</indexterm>
<indexterm significance="normal">
<primary>tokens.exe</primary>
</indexterm>
<indexterm significance="normal">
<primary>aklog.exe</primary>
</indexterm>
<indexterm significance="normal">
<primary>afscreds.exe</primary>
</indexterm>
<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>
<itemizedlist>
<listitem>
<para>setting/querying tokens (tokens.exe, aklog.exe, afscreds.exe)</para>
</listitem>
<listitem>
<para>setting/querying ACLs </para>
</listitem>
<listitem>
<para>setting/querying cache parameters</para>
</listitem>
<listitem>
<para>flushing files or volumes</para>
</listitem>
<listitem>
<para>setting/querying server preferences</para>
</listitem>
<listitem>
<para>querying path location</para>
</listitem>
<listitem>
<para>checking the status of servers and volumes</para>
</listitem>
<listitem>
<para>setting/querying the sysname list</para>
</listitem>
</itemizedlist>
<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>
<para>To assist in debugging these problems, the registry value:</para>
<para> [HKLM\SOFTWARE\OpenAFS\Client]</para>
<para> REG_DWORD: IoctlDebug = 0x01</para>
<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>
</section>
<section>
<title id="afsd_service_init_log">4.2. afsd_service initialization log (%WinDir%\TEMP\afsd_init.log)</title>
<indexterm significance="normal">
<primary>afsd_init.log</primary>
</indexterm>
<indexterm significance="normal">
<primary>MaxLogSize</primary>
</indexterm>
<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>
<para>The
<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.
</para>
</section>
<section>
<title id="afsd_service_debug_log">4.3. afsd_service debug logs (fs trace {-on, -off, -dump} ->%WinDir%\TEMP\afsd.log)</title>
<indexterm significance="normal">
<primary>afsd.log</primary>
</indexterm>
<indexterm significance="normal">
<primary>fs trace</primary>
</indexterm>
<indexterm significance="normal">
<primary>TraceBufferSize</primary>
</indexterm>
<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
<link linkend="Value_TraceBufferSize">TraceBufferSize registry value</link>:
</para>
<para> [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para> REG_DWORD TraceBufferSize </para>
<para>A restart of the service is necessary when adjusting this value. Execute "fs trace -on -reset" to begin the logging and "fs trace -dump" to output the contents of the log to the file.</para>
</section>
<section>
<title id="Using_Sysinternals_Tools">4.4. Using SysInternal's Debug Viewer, Process Monitor,
Process Explorer and Process Dump Tools</title>
<indexterm significance="normal">
<primary>SysInternals</primary>
</indexterm>
<indexterm significance="normal">
<primary>dbgview.exe</primary>
</indexterm>
<indexterm significance="normal">
<primary>procmon.exe</primary>
</indexterm>
<indexterm significance="normal">
<primary>TraceOption</primary>
</indexterm>
<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
<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
<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).
</para>
<para> [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>REG_DWORD TraceOption = 0x04</para>
<para>Use "fs trace –on" and "fs trace –off" to toggle the generation of log messages. </para>
<para>Sysinternal's
<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.
</para>
<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>
<para>Turn on the
<emphasis>Clock Time</emphasis> and
<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
<link linkend="Reporting_Bugs">bug reports</link>.
</para>
<para>Sysinternal's
<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 "
<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().
</para>
</section>
<section>
<title id="Creating_Microsoft_Minidumps">4.5. Creating Microsoft MiniDumps
(fs minidump -> %WinDir%\TEMP\afsd.dmp)</title>
<indexterm significance="normal">
<primary>minidumps</primary>
</indexterm>
<indexterm significance="normal">
<primary>fs minidump</primary>
</indexterm>
<indexterm significance="normal">
<primary>MiniDumpType</primary>
</indexterm>
<indexterm significance="normal">
<primary>afsd.dmp</primary>
</indexterm>
<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 "
<ulink url="http://www.microsoft.com/whdc/devtools/debugging/default.mspx">Microsoft Debugging Tools for Windows</ulink>".
</para>
<para>The
<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.
</para>
</section>
<section>
<title id="Integrated_Logon_Debugging">4.6. Single Sign-on (Integrated Logon) debugging</title>
<indexterm significance="normal">
<primary>integrated logon</primary>
</indexterm>
<indexterm significance="normal">
<primary>TraceOption</primary>
</indexterm>
<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 the <link linkend="Value_AFSLogon_Debug">Debug</link> registry value: </para>
<para> [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]</para>
<para> REG_DWORD Debug = 0x01</para>
<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>
</section>
<section>
<title id="rxdebug_usage">4.7. RX (AFS RPC) debugging (rxdebug)</title>
<indexterm significance="normal">
<primary>rxdebug.exe</primary>
</indexterm>
<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>
<para>
<programlisting format="linespecific">
Usage: rxdebug -servers <server machine> [-port <IP port>] [-nodally]
[-allconnections] [-rxstats] [-onlyserver] [-onlyclient]
[-onlyport <show only <port>>]
[-onlyhost <show only <host>>]
[-onlyauth <show only <auth level>>] [-version]
[-noconns] [-peers] [-help]
Where: -nodally don't show dallying conns
-allconnections don't filter out uninteresting connections
-rxstats show Rx statistics
-onlyserver only show server conns
-onlyclient only show client conns
-version show AFS version id
-noconns show no connections
-peers show peers
</programlisting>
</para>
</section>
<section>
<title id="cmdebug_usage">4.8. Cache Manager RPC debugging (cmdebug)</title>
<indexterm significance="normal">
<primary>cmdebug.exe</primary>
</indexterm>
<para>The cmdebug.exe tool can be used to query the state of the AFS Cache Manager over the network.</para>
<para>
<programlisting format="linespecific">
Usage: cmdebug -servers <server machine> [-port <IP port>] [-long] [-refcounts]
[-callbacks] [-ctime] [-addrs] [-cache] [-cellservdb] [-help]
Where: -long print all info
-refcounts print only cache entries with positive reference counts
-callbacks print only cache entries with callbacks
-ctime print human readable expiration time
-addrs print only host interfaces
-cache print only cache configuration
-cellservdb print only cellservdb info
</programlisting>
</para>
</section>
<section>
<title id="Persistent_Cache_Consistency_Check">4.9. Persistent Cache consistency check</title>
<indexterm significance="normal">
<primary>AFSCache</primary>
</indexterm>
<indexterm significance="normal">
<primary>validate cache file</primary>
</indexterm>
<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>
<para> afsd_service.exe --validate-cache <cache-path></para>
</section>
<section>
<title id="Token_Acquisition_Debugging">4.10. Token Acquisition Debugging</title>
<indexterm significance="normal">
<primary>tokens</primary>
</indexterm>
<indexterm significance="normal">
<primary>klog.exe</primary>
</indexterm>
<indexterm significance="normal">
<primary>kinit.exe</primary>
</indexterm>
<indexterm significance="normal">
<primary>aklog.exe</primary>
</indexterm>
<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
<emphasis>klog.exe</emphasis> (if you are using kaserver) or
<emphasis>kinit.exe</emphasis> and
<emphasis>aklog.exe</emphasis> (if you are using Kerberos v5.) The aklog.exe
<emphasis>–d</emphasis> option will be quite helpful in diagnosing Kerberos v5 related problems.
</para>
</section>
</chapter>
<chapter id="Reporting_Bugs">
<title>Reporting Bugs</title>
<para>
<indexterm significance="normal">
<primary>bug reports</primary>
</indexterm>
Bug reports should be sent to
<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.
</para>
<para>Configuring DrWatson to generate dump files for crashes:</para>
<orderedlist inheritnum="ignore" continuation="restarts">
<listitem>
<para>Run drwtsn32.exe to configure or to identify where the log and the crash dump files are created: </para>
</listitem>
<listitem>
<para>click Start > Run... </para>
</listitem>
<listitem>
<para>type drwtsn32 <enter>. </para>
</listitem>
<listitem>
<para>Select either a Crash Dump Type: Mini or Full. </para>
</listitem>
<listitem>
<para>Clear Dump Symbol Table</para>
</listitem>
<listitem>
<para>Clear Append to Existing Log file. </para>
</listitem>
<listitem>
<para>Check Dump All Thread Contexts.</para>
</listitem>
<listitem>
<para>Check Create Crash Dump File</para>
</listitem>
<listitem>
<para>Next run the monitoring module of Dr. Watson: </para>
</listitem>
<listitem>
<para>click Start > Run...</para>
</listitem>
<listitem>
<para>type drwatson <enter>. </para>
</listitem>
<listitem>
<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>
</listitem>
</orderedlist>
<para>Once you have the Dr. Watson's logfile and minidump, zip them and attach them to your e-mail.</para>
<para>When reporting a error, please be sure to include the version of OpenAFS.
</para>
</chapter>
<chapter id="chap_6">
<title id="Contributing_to_OpenAFS">How to Contribute to the Development of OpenAFS for Windows</title>
<para>
<indexterm significance="normal">
<primary>contributing to OpenAFS</primary>
</indexterm>
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>
<section>
<title id="USENIX_OpenAFS_Fund">6.1. The USENIX OpenAFS Fund </title>
<para>
<indexterm significance="normal">
<primary>USENIX OpenAFS Fund</primary>
</indexterm>
<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.
</para>
<informaltable frame="none">
<tgroup rowsep="1" align="left" colsep="1" cols="1">
<colspec colwidth="405pt" colname="c1"/>
<tbody>
<row>
<entry>
<para>
<programlisting format="linespecific">
USENIX OpenAFS Fund
USENIX Association
2560 Ninth St., Suite 215
Berkeley, CA 94710
</programlisting>
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<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
<ulink url="https://db.usenix.org/cgi-bin/openafs/openafs.cgi">donation online</ulink>.
</para>
</section>
<section>
<title id="Secure_Endpoints_Inc">6.2. Secure Endpoints Inc. </title>
<para>
<indexterm significance="normal">
<primary>Secure Endpoints Inc.</primary>
</indexterm>
<ulink url="http://www.secure-endpoints.com/">Secure Endpoints Inc.</ulink> provides development and support services for OpenAFS for Windows and
<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.
</para>
<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>
<para>Secure Endpoints Inc. provides contract based support for the OpenAFS for Windows and the
<ulink url="http://web.mit.edu/kerberos/">MIT Kerberos for Windows</ulink> products.
</para>
</section>
<section>
<title id="Your_File_System_Inc">6.3. Your File System Inc. </title>
<para>
<indexterm significance="normal">
<primary>Your File System Inc.</primary>
</indexterm>
<ulink url="http://www.your-file-system.com/">Your File System Inc.</ulink> provides development and support services for OpenAFS for Windows.
Donations provided to Your File System 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.
</para>
<para>Your File System Inc. accepts software development agreements from organizations who wish to fund a well-defined set of bug fixes or new features. </para>
<para>Your File System Inc. provides contract based support for OpenAFS on all platforms.
</para>
</section>
<section>
<title id="Direct_Code_Contributions">6.4. Direct contributions of code and/or documentation </title>
<para>Organizations that use OpenAFS in house and have development staffs are encouraged to
contribute code and documentation modifications to OpenAFS.org via
<emphasis>>http://gerrit.openafs.org/</emphasis>.</para>
</section>
<section>
<title id="OAFW_Mailing_Lists">6.5. OpenAFS for Windows Mailing Lists</title>
<indexterm significance="normal">
<primary>mailing lists</primary>
</indexterm>
<indexterm significance="normal">
<primary>openafs-win32-devel</primary>
</indexterm>
<indexterm significance="normal">
<primary>openafs-info</primary>
</indexterm>
<para>If you wish to participate in OpenAFS for Windows development, please join the <ulink url="mailto:openafs-win32-devel@openafs.org?subject=OpenAFS%20for%20Windows%20Development%20Contribution">openafs-win32-devel@openafs.org</ulink> mailing list. </para>
<para>
<emphasis role="bold">https://lists.openafs.org/mailman/listinfo/openafs-win32-devel</emphasis>
</para>
<para>User questions should be sent to the
<ulink url="mailto:openafs-info@openafs.org?subject=OpenAFS%20for%20Windows%20User%20Question">openafs-info@openafs.org</ulink> mailing list.
</para>
<para>
<emphasis role="bold">https://lists.openafs.org/mailman/listinfo/openafs-info</emphasis>
</para>
<para>You must join the mailing lists if you wish to post to the list without incurring a moderation delay.</para>
</section>
</chapter>
<chapter id="chap_7">
<title id="MSI_Deployment_Guide">MSI Deployment Guide</title>
<section>
<title>7.1. Introduction</title>
<indexterm significance="normal">
<primary>msi deployment</primary>
</indexterm>
<indexterm significance="normal">
<primary>msi transforms</primary>
</indexterm>
<para id="Introduction_to_MSI_Deployment">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>
<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>
<section>
<title id="MSI_Deployment_Requirements">7.1.1 Requirements</title>
<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>
<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>
<para>For reference, the schema for the MSI package is based on SCHEMA.MSI distributed with the Platform SDK.</para>
<para>For general information about "Windows Installer", refer to:</para>
<para>
<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></para>
<para>For general information about authoring MSI transforms, refer to:</para>
<para>
<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></para>
<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>
<para>
<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></para>
</section>
<section>
<title id="MSI_Authoring_Transforms">7.1.2 Authoring a Transform</title>
<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>
<orderedlist inheritnum="ignore" continuation="restarts">
<listitem>
<para>copy openafs.msi openafs-modified.msi</para>
</listitem>
<listitem>
<para>(edit the openafs-modified.msi to include the necessary changes)</para>
</listitem>
<listitem>
<para>msitran -g openafs.msi openafs-modified.msi openafs-transform.mst</para>
</listitem>
<listitem>
<para>(generates openafs-transform.mst, which is the transform)</para>
</listitem>
</orderedlist>
<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>
<para>You can test a transform by:</para>
<orderedlist inheritnum="ignore" continuation="restarts">
<listitem>
<para>copy openafs.msi openafs-test.msi</para>
</listitem>
<listitem>
<para>msitran -a openafs-transform.mst openafs-test.msi</para>
</listitem>
</orderedlist>
<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>
<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>
</section>
</section>
<section>
<title id="MSI_Configuration_Options">7.2. Configuration Options</title>
<para>The logic necessary to implement many of the settings described in
<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.
</para>
<section>
<title id="MSI_Configurable_Properties">7.2.1 Configurable Properties</title>
<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>
<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>
<para>For each property, the associated registry setting is referenced by the same text used in
<link linkend="appendix_a">Appendix A</link>.
</para>
<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>
<para>Numeric values should be authored as decimal strings.</para>
<section>
<title id="MSI_Setting_Properties">7.2.1.1 Setting Properties</title>
<para>In order to set a property,</para>
<orderedlist inheritnum="ignore" continuation="restarts">
<listitem>
<para>Open the MSI in ORCA.EXE</para>
</listitem>
<listitem>
<para>Select the 'Property' table from the list of tables on the left.</para>
</listitem>
<listitem>
<para>Find the property in the list of properties on the right, double click the value and type the new value.</para>
</listitem>
<listitem>
<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>
</listitem>
</orderedlist>
</section>
<section>
<title id="MSI_OAFW_Properties">7.2.1.2 OpenAFS for Windows Properties</title>
<informaltable frame="all">
<tgroup rowsep="1" align="left" colsep="1" cols="1">
<colspec colwidth="447pt" colname="c1"/>
<tbody>
<row>
<entry>
<para>
<emphasis>(Service parameters):</emphasis>
</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
</entry>
</row>
<row>
<entry>
<para>
<emphasis>(Network provider):</emphasis>
</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]</para>
</entry>
</row>
<row>
<entry>
<para>
<emphasis>(OpenAFS Client):</emphasis>
</para>
<para>[HKLM\SOFTWARE\OpenAFS\Client]</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<section>
<title id="MSI_OAFW_Registry_Properties">7.2.1.2.1 Registry Properties</title>
<para>These properties are used to set the values of registry entries associated with OpenAFS for Windows.</para>
<informaltable frame="all">
<tgroup rowsep="1" align="left" colsep="1" cols="1">
<colspec colwidth="447pt" colname="c1"/>
<tbody>
<row>
<entry>
<para>
<emphasis role="bold">AFSCACHEPATH</emphasis>
</para>
<para>Registry key :
<link linkend="Service_Parameters">(Service Parameters)</link></para>
<para>Registry value :
<link linkend="Value_CachePath">CachePath</link></para>
<para>Valid values : string .</para>
</entry>
</row>
<row>
<entry>
<para>
<emphasis role="bold">AFSCACHESIZE</emphasis>
</para>
<para>Registry key :
<link linkend="Service_Parameters">(Service Parameters)</link></para>
<para>Registry value :
<link linkend="Value_CacheSize">CacheSize</link></para>
<para>Valid values : numeric</para>
</entry>
</row>
<row>
<entry>
<para>
<emphasis role="bold">AFSCELLNAME</emphasis>
</para>
<para>Registry key :
<link linkend="Service_Parameters">(Service Parameters)</link></para>
<para>Registry value :
<link linkend="Value_Cell">Cell</link></para>
<para>Valid values : string</para>
</entry>
</row>
<row>
<entry>
<para>
<emphasis role="bold">FREELANCEMODE</emphasis>
</para>
<para>Registry key :
<link linkend="Service_Parameters">(Service Parameters)</link></para>
<para>Registry value :
<link linkend="Value_FreelanceClient">FreelanceClient</link></para>
<para>Valid values : '1' or '0'</para>
</entry>
</row>
<row>
<entry>
<para>
<emphasis role="bold">HIDEDOTFILES</emphasis>
</para>
<para>Registry key :
<link linkend="Service_Parameters">(Service Parameters)</link></para>
<para>Registry value :
<link linkend="Value_HideDotFiles">HideDotFiles</link></para>
<para>Valid values : '1' or '0'</para>
</entry>
</row>
<row>
<entry>
<para>
<emphasis role="bold">LOGONOPTIONS</emphasis>
</para>
<para>Registry key :
<link linkend="Domain_Specific_Regkeys">(Network Provider)</link></para>
<para>Registry value :
<link linkend="Value_LogonOptions">LogonOptions</link></para>
<para>Valid values : '0', '1' or '3'</para>
<para>See
<link linkend="appendix_a">Appendix A</link><link linkend="Domain_Specific_Configuration">section 2.1 (Domain Specific Configuration keys for Network Provider)</link> for more details.
</para>
</entry>
</row>
<row>
<entry>
<para>
<emphasis role="bold">MOUNTROOT</emphasis>
</para>
<para>Registry key :
<link linkend="Service_Parameters">(Service Parameters)</link></para>
<para>Registry value :
<link linkend="Value_Mountroot">Mountroot</link></para>
<para>Valid values : string</para>
</entry>
</row>
<row>
<entry>
<para>
<emphasis role="bold">NETBIOSNAME</emphasis>
</para>
<para>Registry key :
<link linkend="Service_Parameters">(Service Parameters)</link></para>
<para>Registry value :
<link linkend="Value_NetbiosName">NetbiosName</link></para>
<para>Valid values : string (at most 15 characters)</para>
</entry>
</row>
<row>
<entry>
<para>
<emphasis role="bold">NOFINDLANABYNAME</emphasis>
</para>
<para>Registry key :
<link linkend="Service_Parameters">(Service Parameters)</link></para>
<para>Registry value :
<link linkend="Value_NoFindLanaByName">NoFindLanaByName</link></para>
<para>Valid values : '1' or '0'</para>
</entry>
</row>
<row>
<entry>
<para>
<emphasis role="bold">RXMAXMTU</emphasis>
</para>
<para>Registry key :
<link linkend="Service_Parameters">(Service Parameters)</link></para>
<para>Registry value :
<link linkend="Value_RxMaxMTU">RxMaxMTU</link></para>
<para>Valid values : numeric</para>
</entry>
</row>
<row>
<entry>
<para>
<emphasis role="bold">SECURITYLEVEL</emphasis>
</para>
<para>Registry key :
<link linkend="Service_Parameters">(Service Parameters)</link></para>
<para>Registry value :
<link linkend="Value_SecurityLevel">SecurityLevel</link></para>
<para>Valid values : '1' or '0'</para>
</entry>
</row>
<row>
<entry>
<para>
<emphasis role="bold">SMBAUTHTYPE</emphasis>
</para>
<para>Registry key :
<link linkend="Service_Parameters">(Service Parameters)</link></para>
<para>Registry value :
<link linkend="Value_smbAuthType">SMBAuthType</link></para>
<para>Valid values : '0','1' or '2'</para>
</entry>
</row>
<row>
<entry>
<para>
<emphasis role="bold">STOREANSIFILENAMES</emphasis>
</para>
<para>Registry key :
<link linkend="Regkey_HKLM_SOFTWARE_OpenAFS_Client">(OpenAFS Client)</link></para>
<para>Registry value :
<link linkend="Value_StoreAnsiFilenames">StoreAnsiFilenames</link></para>
<para>Valid values : '0' or '1'</para>
<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>
</entry>
</row>
<row>
<entry>
<para>
<emphasis role="bold">USEDNS</emphasis>
</para>
<para>Registry key :
<link linkend="Service_Parameters">(Service Parameters)</link></para>
<para>Registry value :
<link linkend="Value_UseDNS">UseDNS</link></para>
<para>Valid values : '1' or '0'</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>
<section>
<title id="MSI_OAFW_AFSCreds_Properties">
7.2.1.2.2 AFSCreds.exe Properties
</title>
<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>
<informaltable frame="all">
<tgroup rowsep="1" align="left" colsep="1" cols="1">
<colspec colwidth="447pt" colname="c1"/>
<tbody>
<row>
<entry>
<para>
<emphasis role="bold">CREDSSTARTUP</emphasis>
</para>
<para>Valid values : '1' or '0'</para>
<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>
</entry>
</row>
<row>
<entry>
<para>
<emphasis role="bold">CREDSAUTOINIT</emphasis>
</para>
<para>Valid values : '-a' or ''</para>
<para>Enables automatic initialization.</para>
</entry>
</row>
<row>
<entry>
<para>
<emphasis role="bold">CREDSIPCHDET</emphasis>
</para>
<para>Valid values : '-n' or ''</para>
<para>Enables IP address change detection.</para>
</entry>
</row>
<row>
<entry>
<para>
<emphasis role="bold">CREDSQUIET</emphasis>
</para>
<para>Valid values : '-q' or ''</para>
<para>Enables quiet mode.</para>
</entry>
</row>
<row>
<entry>
<para>
<emphasis role="bold">CREDSRENEWDRMAP</emphasis>
</para>
<para>Valid values : '-m' or ''</para>
<para>Enables renewing drive map at startup.</para>
</entry>
</row>
<row>
<entry>
<para>
<emphasis role="bold">CREDSSHOW</emphasis>
</para>
<para>Valid values : '-s' or ''</para>
<para>Enables displaying the credential manager window when AFSCREDS starts up.</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>
</section>
</section>
<section>
<title id="MSI_Existing_Registry_Entries">7.2.2 Existing Registry Entries</title>
<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>
</section>
<section>
<title id="MSI_Replacing_Configuration_Files">7.2.3 Replacing Configuration Files</title>
<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>
<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>
<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>
<para>The walkthrough below is to add a custom 'CellServDB' file.</para>
<orderedlist inheritnum="ignore" continuation="restarts">
<listitem>
<para>Disable the component that contains the configuration file that you want to replace.</para>
<orderedlist inheritnum="ignore" continuation="restarts">
<listitem>
<para>Locate and select the 'Component' table in the 'Tables' list.</para>
</listitem>
<listitem>
<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
<link linkend="MSI_Configuration_File_Components">7.2.3.1</link>. For this example, the component name is 'elf_CellServDB'.
</para>
</listitem>
<listitem>
<para>Go to the 'Condition' column of the component.</para>
</listitem>
<listitem>
<para>Enter a condition that evaluates to false. I.e. 'DONOTINSTALL'. (Note that an undefined property always evaluates to false).</para>
<para>Note that you can also use this step to disable other configuration files without providing replacements.</para>
</listitem>
</orderedlist>
</listitem>
<listitem>
<para>Add a new component containing the new configuration file.</para>
<orderedlist inheritnum="ignore" continuation="restarts">
<listitem>
<para>Select the 'Component' table in the 'Tables' list.</para>
</listitem>
<listitem>
<para>Select 'Tables'->'Add Row' (Ctrl-R).</para>
</listitem>
<listitem>
<para>Enter the following :</para>
<informaltable frame="all">
<tgroup rowsep="1" align="left" colsep="1" cols="2">
<colspec colwidth="84pt" colname="c1"/>
<colspec colwidth="318pt" colname="c2"/>
<tbody>
<row>
<entry>
<para>Component</para>
</entry>
<entry>
<para>cmf_my_CellServDB</para>
</entry>
</row>
<row>
<entry>
<para>ComponentID</para>
</entry>
<entry>
<para>{7019836F-BB2C-4AF6-9463-0D6EC9035CF1}</para>
</entry>
</row>
<row>
<entry>
<para>Directory_</para>
</entry>
<entry>
<para>dirClient</para>
</entry>
</row>
<row>
<entry>
<para>Attributes</para>
</entry>
<entry>
<para>144</para>
</entry>
</row>
<row>
<entry>
<para>Condition</para>
</entry>
<entry>
<para/>
</entry>
</row>
<row>
<entry>
<para>KeyPath</para>
</entry>
<entry>
<para>fil_my_CellServDB</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<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>
<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>
<para> 'fil_my_CellServDB' is a key into the 'File' table which we will fill later.</para>
</listitem>
</orderedlist>
</listitem>
<listitem>
<para>Add a new feature to hold the new component.</para>
<orderedlist inheritnum="ignore" continuation="restarts">
<listitem>
<para>Select the 'Feature' table.</para>
</listitem>
<listitem>
<para>Add a new row (Ctrl-R or 'Tables'->'Add Row') with the following values:</para>
<informaltable frame="all">
<tgroup rowsep="1" align="left" colsep="1" cols="2">
<colspec colwidth="94pt" colname="c1"/>
<colspec colwidth="307pt" colname="c2"/>
<tbody>
<row>
<entry>
<para>Feature</para>
</entry>
<entry>
<para>fea_my_CellServDB</para>
</entry>
</row>
<row>
<entry>
<para>Feature_Parent</para>
</entry>
<entry>
<para>feaClient</para>
</entry>
</row>
<row>
<entry>
<para>Title</para>
</entry>
<entry>
<para/>
</entry>
</row>
<row>
<entry>
<para>Description</para>
</entry>
<entry>
<para/>
</entry>
</row>
<row>
<entry>
<para>Display</para>
</entry>
<entry>
<para>0</para>
</entry>
</row>
<row>
<entry>
<para>Level</para>
</entry>
<entry>
<para>30</para>
</entry>
</row>
<row>
<entry>
<para>Directory_</para>
</entry>
<entry>
<para/>
</entry>
</row>
<row>
<entry>
<para>Attributes</para>
</entry>
<entry>
<para>8</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<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>
<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>
<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>
</listitem>
</orderedlist>
</listitem>
<listitem>
<para>Join the component and the feature.</para>
<orderedlist inheritnum="ignore" continuation="restarts">
<listitem>
<para>Select the 'FeatureComponents' table.</para>
</listitem>
<listitem>
<para>Add a new row with the following values:</para>
<informaltable frame="all">
<tgroup rowsep="1" align="left" colsep="1" cols="2">
<colspec colwidth="90pt" colname="c1"/>
<colspec colwidth="312pt" colname="c2"/>
<tbody>
<row>
<entry>
<para>Feature</para>
</entry>
<entry>
<para>fea_my_CellServDB</para>
</entry>
</row>
<row>
<entry>
<para>Component</para>
</entry>
<entry>
<para>cmf_my_CellServDB</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</orderedlist>
</listitem>
<listitem>
<para>Add an entry to the 'File' table.</para>
<orderedlist inheritnum="ignore" continuation="restarts">
<listitem>
<para>Select the 'File' table.</para>
</listitem>
<listitem>
<para>Add a new row with the following values:</para>
<informaltable frame="all">
<tgroup rowsep="1" align="left" colsep="1" cols="2">
<colspec colwidth="91pt" colname="c1"/>
<colspec colwidth="311pt" colname="c2"/>
<tbody>
<row>
<entry>
<para>File</para>
</entry>
<entry>
<para>fil_my_CellServDB</para>
</entry>
</row>
<row>
<entry>
<para>Component_</para>
</entry>
<entry>
<para>cmf_my_CellServDB</para>
</entry>
</row>
<row>
<entry>
<para>FileName</para>
</entry>
<entry>
<para>CellServDB</para>
</entry>
</row>
<row>
<entry>
<para>FileSize</para>
</entry>
<entry>
<para>(enter file size here)</para>
</entry>
</row>
<row>
<entry>
<para>Attributes</para>
</entry>
<entry>
<para>8192</para>
</entry>
</row>
<row>
<entry>
<para>Sequence</para>
</entry>
<entry>
<para>1000</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para> (leave other fields blank)</para>
<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>
<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>
</listitem>
</orderedlist>
</listitem>
<listitem>
<para>Set a media source for the file.</para>
<orderedlist inheritnum="ignore" continuation="restarts">
<listitem>
<para>Select the 'Media' table.</para>
</listitem>
<listitem>
<para>Add a row with the following values :</para>
<informaltable frame="all">
<tgroup rowsep="1" align="left" colsep="1" cols="2">
<colspec colwidth="93pt" colname="c1"/>
<colspec colwidth="309pt" colname="c2"/>
<tbody>
<row>
<entry>
<para>DiskId</para>
</entry>
<entry>
<para>2</para>
</entry>
</row>
<row>
<entry>
<para>LastSequence</para>
</entry>
<entry>
<para>1000</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para> (leave other fields blank)</para>
<para>The sequence number of 1000 designates this as the media source for the newly added file.
</para>
</listitem>
</orderedlist>
</listitem>
</orderedlist>
<section id="MSI_Configuration_File_Components">
<title>7.2.3.1 Components for Configuration Files</title>
<para>CellServDB: 'cpf_CellServDB' (ID {D5BA4C15-DBEC-4292-91FC-B54C30F24F2A})</para>
</section>
</section>
<section>
<title id="MSI_Adding_Domain_Specific_Registry_Keys">7.2.4 Adding Domain Specific Registry Keys</title>
<para>Following is an example for adding domain specific registry keys.</para>
<para> Refer to
<link linkend="appendix_a">Appendix A</link> section 2.1 for more information.
</para>
<para> Columns that are unspecified should be left empty.</para>
<para> We create a new feature and component to hold the new registry keys.</para>
<informaltable frame="all">
<tgroup rowsep="1" align="left" colsep="1" cols="1">
<colspec colwidth="448pt" colname="c1"/>
<tbody>
<row>
<entry>
<para> 'Feature' table:</para>
</entry>
</row>
<row>
<entry>
<para> (new row)
Feature : 'feaDomainKeys'
Feature Parent : 'feaClient'
Display : 0
Level : 30
Attributes : 10</para>
</entry>
</row>
<row>
<entry>
<para> 'Component' table:</para>
</entry>
</row>
<row>
<entry>
<para> (new row)
Component : 'rcm_DomainKeys'
ComponentId : '{4E3FCBF4-8BE7-40B2-A108-C47CF743C627}'
Directory : 'TARGETDIR'
Attributes : 4
KeyPath : 'reg_domkey0'</para>
</entry>
</row>
<row>
<entry>
<para> 'FeatureComponents' table:</para>
</entry>
</row>
<row>
<entry>
<para> (new row)
Feature : 'feaDomainKeys'
Component : 'rcm_DomainKeys'</para>
</entry>
</row>
<row>
<entry>
<para> 'Registry' table:</para>
</entry>
</row>
<row>
<entry>
<para> (new row)
Registry : 'reg_domkey0'
Root : 2
Key : 'SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain'
Component : 'rcm_DomainKeys'</para>
</entry>
</row>
<row>
<entry>
<para> (new row)
Registry : 'reg_domkey1'
Root : 2
Key : 'SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain'
Name : '*'
Component : 'rcm_DomainKeys'</para>
</entry>
</row>
<row>
<entry>
<para> (new row)
Registry : 'reg_domkey2'
Root : 2
Key : 'SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\ATHENA.MIT.EDU'
Name : '*'
Component : 'rcm_DomainKeys'</para>
</entry>
</row>
<row>
<entry>
<para> (new row)
Registry : 'reg_domkey3'
Root : 2
Key : 'SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\ATHENA.MIT.EDU'
Name : 'LogonOptions'
Value : 1
Component : 'rcm_DomainKeys'</para>
</entry>
</row>
<row>
<entry>
<para> (new row)
Registry : 'reg_domkey4'
Root : 2
Key : SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST'
Name : '*'
Component : 'rcm_DomainKeys'</para>
</entry>
</row>
<row>
<entry>
<para> (new row)
Registry : 'reg_domkey5'
Root : 2
Key : 'SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST'
Name : 'LogonOptions'
Value : 0
Component : 'rcm_DomainKeys'</para>
</entry>
</row>
<row>
<entry>
<para> (new row)
Registry : 'reg_domkey6'
Root : 2
Key : 'SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST'
Name : 'FailLoginsSilently'
Value : 1
Component : 'rcm_DomainKeys'</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>The example adds domain specific keys for 'ATHENA.MIT.EDU' (enable integrated logon) and 'LOCALHOST' (disable integrated logon and fail logins silently).</para>
</section>
<section>
<title id="MSI_Adding_Site_Specific_Freelance_Registry_Keys">7.2.5 Adding Site Specific Freelance Registry Keys</title>
<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>
<para> Columns that are unspecified should be left empty.</para>
<para> We create a new feature and component to hold the new registry keys.</para>
<informaltable frame="all">
<tgroup rowsep="1" align="left" colsep="1" cols="1">
<colspec colwidth="447pt" colname="c1"/>
<tbody>
<row>
<entry>
<para> 'Feature' table:</para>
</entry>
</row>
<row>
<entry>
<para> (new row)
Feature : 'feaFreelanceKeys'
Feature Parent : 'feaClient'
Display : 0
Level : 30
Attributes : 10</para>
</entry>
</row>
<row>
<entry>
<para> 'Component' table:</para>
</entry>
</row>
<row>
<entry>
<para> (new row)
Component : 'rcm_FreelanceKeys'
ComponentId : '{4E3B3CBF4-9AE7-40C3-7B09-C48CF842C583}'
Directory : 'TARGETDIR'
Attributes : 4
KeyPath : 'reg_freekey0'</para>
</entry>
</row>
<row>
<entry>
<para> 'FeatureComponents' table:</para>
</entry>
</row>
<row>
<entry>
<para> (new row)
Feature : 'feaFreelanceKeys'
Component : 'rcm_FreelanceKeys'</para>
</entry>
</row>
<row>
<entry>
<para> 'Registry' table:</para>
</entry>
</row>
<row>
<entry>
<para> (new row)
Registry : 'reg_freekey0'
Root : 2
Key : 'SOFTWARE\OpenAFS\Client\Freelance'
Component : 'rcm_FreelanceKeys'</para>
</entry>
</row>
<row>
<entry>
<para> (new row)
Registry : 'reg_freekey1'
Root : 2
Key : 'SOFTWARE\OpenAFS\Client\Freelance'
Name : '0'
Value : 'athena.mit.edu#athena.mit.edu:root.cell.'
Component : 'rcm_FreelanceKeys'</para>
</entry>
</row>
<row>
<entry>
<para> (new row)
Registry : 'reg_freekey2'
Root : 2
Key : 'SOFTWARE\OpenAFS\Client\Freelance'
Name : '1'
Value : '.athena.mit.edu%athena.mit.edu:root.cell.'
Component : 'rcm_FreelanceKeys'</para>
</entry>
</row>
<row>
<entry>
<para> (new row)
Registry : 'reg_freekey3'
Root : 2
Key : 'SOFTWARE\OpenAFS\Client\Freelance\Symlinks'
Component : 'rcm_FreelanceKeys'</para>
</entry>
</row>
<row>
<entry>
<para> (new row)
Registry : 'reg_freekey4'
Root : 2
Key : 'SOFTWARE\OpenAFS\Client\Freelance\Symlinks'
Name : '0'
Value : 'athena:athena.mit.edu.'
Component : 'rcm_FreelanceKeys'</para>
</entry>
</row>
<row>
<entry>
<para> (new row)
Registry : 'reg_freekey5'
Root : 2
Key : 'SOFTWARE\OpenAFS\Client\Freelance\Symlinks'
Name : '1'
Value : '.athena:.athena.mit.edu.'
Component : 'rcm_FreelanceKeys'</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<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.
</para>
</section>
</section>
<section>
<title id="Additional_Resources">7.3 Additional Resources</title>
<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>
<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>
<para>http://msdn.microsoft.com/library/en-us/msi/setup/using_transforms_to_add_resources.asp</para>
<para>A sample walkthrough of adding a new configuration file is in section 2.3.</para>
<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>
<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>
<para>After making the adjustments to the MSI database using ORCA.EXE you can generate a transform with MSITRAN.EXE as follows :</para>
<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>
<para> > msitran.exe -g openafs-en_US.msi openafs-en_US_new.msi openafs-transform.mst</para>
<para>See the Platform SDK documentation for information on command line options for MSITRAN.EXE.</para>
</section>
<section>
<title id="Upgrades">7.4. Upgrades</title>
<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>
<para>Versions of OpenAFS that are upgraded by the MSI package are:</para>
<orderedlist inheritnum="ignore" continuation="restarts">
<listitem>
<para>OpenAFS MSI package</para>
<para>Upgrade code {6823EEDD-84FC-4204-ABB3-A80D25779833}</para>
<para>Up to current release</para>
</listitem>
<listitem>
<para>MIT's Transarc AFS MSI package</para>
<para>Upgrade code {5332B94F-DE38-4927-9EAB-51F4A64193A7}</para>
<para>Up to version 3.6.2</para>
</listitem>
<listitem>
<para>OpenAFS NSIS package</para>
<para>All versions</para>
</listitem>
</orderedlist>
<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>
<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>
<para>When performing an upgrade with msiexec.exe execute the MSI with the repair options "vomus".</para>
</section>
</chapter>
<chapter id="appendix_a" label="Appendix A">
<title id="Registry_Values">Registry Values</title>
<section id="Service_Parameters">
<title>A.1. Service parameters</title>
<para>The service parameters primarily affect the behavior of the AFS client service (afsd_service.exe).</para>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters">Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</title>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_LanAdapter">Value: LanAdapter</title>
<indexterm significance="normal">
<primary>LANadapter</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD</para>
<para>Default: -1</para>
<para>Variable: LANadapter</para>
<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>
<para>[This parameter is ignored unless SMB mode is active.]</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_CacheSize">Value: CacheSize</title>
<indexterm significance="normal">
<primary>CacheSize</primary>
</indexterm>
<para id="Value_CacheSize">Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD</para>
<para>Default: 98304 (CM_CONFIGDEFAULT_CACHESIZE)</para>
<para>Variable: cm_initParams.cacheSize</para>
<para>Size of the AFS data cache specified in 1k blocks.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_ChunkSize">Value: ChunkSize</title>
<indexterm significance="normal">
<primary>ChunkSize</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD</para>
<para>Default: 20 (CM_CONFIGDEFAULT_CHUNKSIZE)</para>
<para>Variable: cm_logChunkSize (cm_chunkSize = 1 << cm_logChunkSize)</para>
<para>Maximum size of chunk for reading and writing. Actual chunk size is
2^cm_logChunkSize. The default chunk size is therefore 1 MB.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_BlockSize">Value: BlockSize</title>
<indexterm>
<primary>BlockSize</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD</para>
<para>Default: 4096 (CM_CONFIGDEFAULT_BLOCKSIZE)</para>
<para>Size of buffer allocation. Must be an even multiple of 1024 and (2^cm_logChuckSize
mod BlockSize) must equal zero.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_Daemons">Value: Daemons</title>
<para>
<emphasis>Value: Daemons</emphasis>
</para>
<para>Type: DWORD</para>
<para>Default: 16 (CM_CONFIGDEFAULT_DAEMONS)</para>
<para>Variable: numBkgD</para>
<para>Number of background daemon threads used to fetch data from and store data to the
file servers.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_ServerThreads">Value: ServerThreads</title>
<indexterm significance="normal">
<primary>ServerThreads</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD</para>
<para>Default: 25 (CM_CONFIGDEFAULT_SVTHREADS)</para>
<para>Variable: numSvThreads</para>
<para>Number of SMB server or AFS Redirector worker threads used to process application
file system requests..</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_Stats">Value: Stats</title>
<indexterm significance="normal">
<primary>Stats</primary>
</indexterm>
<para id="Value_Stats">Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD</para>
<para>Default: 10000 (CM_CONFIGDEFAULT_STATS)</para>
<para>Variable: cm_initParams.nStatCaches</para>
<para>The number of file system status objects. One status object is required for each
directory entry (file, directory, mount point, symlink).</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_Volumes">Value: Volumes</title>
<indexterm significance="normal">
<primary>Volumes</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD</para>
<para>
Default: 3333 (CM_CONFIGDEFAULT_STATS/3)
</para>
<para>
Variable: cm_initParams.nVolumes</para>
<para> The number of volume group objects. One volume group object is required for each
set of volume, volume.readonly and volume.backup. </para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_Cells">Value: Cells</title>
<indexterm significance="normal">
<primary>Cells</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD</para>
<para>
Default: 1024 (CM_CONFIGDEFAULT_CELLS)
</para>
<para>
Variable: cm_initParams.nCells</para>
<para> The number of cell objects. One cell object is required for each cell accessed by
the AFS cache manager.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_LogoffPreserveTokens">Value: LogoffPreserveTokens</title>
<indexterm significance="normal">
<primary>LogoffPreserveTokens</primary>
</indexterm>
<para id="Value_LogoffPreserveTokens">Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {1,0}
</para>
<para>
Default : 0</para>
<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. This option only applies
when the AFS SMB gateway interface is in use.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_RootVolume">Value: RootVolume</title>
<indexterm significance="normal">
<primary>RootVolume</primary>
</indexterm>
<indexterm significance="normal">
<primary>root.afs</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: REG_SZ
</para>
<para>
Default: "root.afs"
</para>
<para>
Variable: cm_rootVolumeName</para>
<para>Root volume name.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_MountRoot">Value: MountRoot</title>
<indexterm significance="normal">
<primary>MountRoot</primary>
</indexterm>
<indexterm significance="normal">
<primary>/afs</primary>
</indexterm>
<para id="Value_Mountroot">Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: REG_SZ
</para>
<para>
Default: "/afs"
</para>
<para>
Variable: cm_mountRoot</para>
<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>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_CachePath">Value: CachePath</title>
<indexterm significance="normal">
<primary>CachePath</primary>
</indexterm>
<indexterm significance="normal">
<primary>AFSCache</primary>
</indexterm>
<para id="Value_CachePath">Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: Use REG_SZ if the path contains no expansion variables or REG_EXPAND_SZ if it
does.</para>
<para> Default: "%TEMP%\AFSCache" (REG_EXPAND_SZ)</para>
<para>
Variable: cm_CachePath</para>
<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>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_NonPersistentCaching">Value: NonPersistentCaching</title>
<indexterm significance="normal">
<primary>NonPersistentCaching</primary>
</indexterm>
<para id="Value_NonPersistentCaching">Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD [0..1]
</para>
<para>
Default: 0
</para>
<para>
Variable: buf_CacheType</para>
<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>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_ValidateCache">Value: ValidateCache</title>
<indexterm significance="normal">
<primary>ValidateCache</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD [0..2]
</para>
<para>
Default: 1
</para>
<para>
Variable: buf_CacheType</para>
<para>This value determines if and when persistent cache validation is performed.</para>
<para>
<simplelist type="vert">
<member>0 - Validation is disabled</member>
<member>1 - Validation is performed at startup</member>
<member>2 - Validation is performed at shutdown</member>
</simplelist>
</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_TrapOnPanic">Value: TrapOnPanic</title>
<indexterm significance="normal">
<primary>TrapOnPanic</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {1,0}
</para>
<para>
Default: 0
</para>
<para>
Variable: traceOnPanic</para>
<para>Issues a breakpoint in the event of a panic. (breakpoint: _asm int 3).</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_NetbiosName">Value: NetbiosName</title>
<indexterm significance="normal">
<primary>NetbiosName</primary>
</indexterm>
<indexterm significance="normal">
<primary>SMB Server Name</primary>
</indexterm>
<indexterm significance="normal">
<primary>\\AFS</primary>
</indexterm>
<para id="Value_NetbiosName">Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: REG_EXPAND_SZ
</para>
<para>
Default: "AFS"
</para>
<para>
Variable: cm_NetbiosName</para>
<para>Specifies the NetBIOS name (or SMB Server Name) to be used when binding to a
Loopback adapter. To provide the old behavior specify a value of "%COMPUTERNAME%-AFS".
When the AFS Redirector interface is in use, this value specifies the UNC server name
registered with the Windows Multiple UNC Provider.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_IsGateway">Value: IsGateway</title>
<indexterm significance="normal">
<primary>IsGateway</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {1,0}
</para>
<para>
Default: 0
</para>
<para>
Variable: isGateway</para>
<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>
<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>
<para>This setting only applies when the AFS SMB interface is in use.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_ReportSessionStartups">Value: ReportSessionStartups</title>
<indexterm significance="normal">
<primary>ReportSessionStartups</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {1,0}
</para>
<para>
Default: 0
</para>
<para>
Variable: reportSessionStartups</para>
<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>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_TraceBufferSize">Value: TraceBufferSize</title>
<indexterm significance="normal">
<primary>TraceBufferSize</primary>
</indexterm>
<para id="Value_TraceBufferSize">Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD
</para>
<para>
Default: 10000 (CM_CONFIGDEFAULT_TRACEBUFSIZE)
</para>
<para>
Variable: traceBufSize</para>
<para>Number of entries to store in trace log.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_SysName">Value: SysName</title>
<indexterm significance="normal">
<primary>SysName</primary>
</indexterm>
<para id="Value_SysName">Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: REG_SZ
</para>
<para>
Default: "x86_win32 i386_w2k i386_nt40" (X86)
</para>
<para>
"amd64_win64 x86_win32 i386_w2k" (AMD64)
</para>
<para>
Variable: cm_sysName</para>
<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>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_SecurityLevel">Value: SecurityLevel</title>
<indexterm significance="normal">
<primary>SecurityLevel</primary>
</indexterm>
<indexterm significance="normal">
<primary>fs setcrypt</primary>
</indexterm>
<para id="Value_SecurityLevel">Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {1,0}
</para>
<para>
Default: 0
</para>
<para>
Variable: cryptall</para>
<para>Enables encryption on RX calls.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_UseDNS">Value: UseDNS</title>
<indexterm significance="normal">
<primary>UseDNS</primary>
</indexterm>
<indexterm significance="normal">
<primary>AFSDB DNS records</primary>
</indexterm>
<indexterm significance="normal">
<primary>SRV DNS records</primary>
</indexterm>
<para id="Value_UseDNS">Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {1,0}
</para>
<para>
Default: 1
</para>
<para>
Variable: cm_dnsEnabled</para>
<para>Enables resolving volservers using AFSDB DNS and SRV DNS queries.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_FreelanceClient">Value: FreelanceClient</title>
<indexterm significance="normal">
<primary>FreelanceClient</primary>
</indexterm>
<indexterm significance="normal">
<primary>dynroot</primary>
</indexterm>
<para id="Value_FreelanceClient">Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {1,0}
</para>
<para>
Default: 0
</para>
<para>
Variable: cm_freelanceEnabled</para>
<para>Enables freelance client.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_FreelanceImportCellServDB">Value: FreelanceImportCellServDB</title>
<indexterm significance="normal">
<primary>FreelanceImportCellServDB</primary>
</indexterm>
<indexterm significance="normal">
<primary>dynroot</primary>
</indexterm>
<para id="Value_FreelanceImportCellServDB">Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {1,0}
</para>
<para>
Default: 0
</para>
<para>
Variable: cm_freelanceImportCellServDB</para>
<para>Creates Freelance Mount Points for each cell listed in the CellServDB during startup.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_FreelanceDiscovery">Value: FreelanceDiscovery</title>
<indexterm significance="normal">
<primary>FreelanceDiscovery</primary>
</indexterm>
<indexterm significance="normal">
<primary>dynroot</primary>
</indexterm>
<para id="Value_FreelanceDiscovery">Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {1,0}
</para>
<para>
Default: 1
</para>
<para>
Variable: cm_freelanceDiscovery</para>
<para>Enables automatic discovery of cell mount points within the Freelance root.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_HideDotFiles">Value: HideDotFiles</title>
<indexterm significance="normal">
<primary>HideDotFiles</primary>
</indexterm>
<para id="Value_HideDotFiles">Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {1,0}
</para>
<para>
Default: 1
</para>
<para>
Variable: smb_hideDotFiles</para>
<para>Enables marking dotfiles with the hidden attribute. Dot files are files whose name starts with a period (excluding "." and "..").</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_MaxMpxRequests">Value: MaxMpxRequests</title>
<indexterm significance="normal">
<primary>MaxMpxRequests</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD
</para>
<para>
Default: 50
</para>
<para>
Variable: smb_maxMpxRequests</para>
<para>Maximum number of multiplexed SMB requests that can be made.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_MaxVCPerServer">Value: MaxVCPerServer</title>
<indexterm significance="normal">
<primary>MaxVCPerServer</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD
</para>
<para>
Default: 100
</para>
<para>
Variable: smb_maxVCPerServer</para>
<para>Maximum number of SMB virtual circuits.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_Cell">Value: Cell</title>
<indexterm significance="normal">
<primary>Cell</primary>
</indexterm>
<indexterm significance="normal">
<primary>workstation cell name</primary>
</indexterm>
<para id="Value_Cell">Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: REG_SZ
</para>
<para>
Default: <none>
</para>
<para>
Variable: rootCellName</para>
<para>Name of root cell (the cell from which the RootVolume, root.afs, should be mounted in \\afs\all).</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_RxEnablePeerStats">Value: RxEnablePeerStats</title>
<indexterm significance="normal">
<primary>RxEnablePeerStats</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {0, 1}
</para>
<para>
Default: 1
</para>
<para>
Variable: rx_enable_peer_stats</para>
<para>When set to 1, the Rx library collects peer statistics.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_RxEnableProcessStats">Value: RxEnableProcessStats</title>
<indexterm significance="normal">
<primary>RxEnableProcessStats</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {0, 1}
</para>
<para>
Default: 1
</para>
<para>
Variable: rx_extra_process_stats</para>
<para>When set to 1, the Rx library collects process statistics.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_RxExtraPackets">Value: RxExtraPackets</title>
<indexterm significance="normal">
<primary>RxExtraPackets</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD
</para>
<para>
Default: 120
</para>
<para>
Variable: rx_extraPackets</para>
<para>When set, this number of extra Rx packets are allocated at startup.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_RxMaxMTU">Value: RxMaxMTU</title>
<indexterm significance="normal">
<primary>RxMaxMTU</primary>
</indexterm>
<para id="Value_RxMaxMTU">Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD
</para>
<para>
Default: 0
</para>
<para>
Variable: rx_mtu</para>
<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>
<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>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_RxNoJumbo">Value: RxNoJumbo</title>
<indexterm significance="normal">
<primary>RxNoJumbo</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {0,1}
</para>
<para>
Default: 0
</para>
<para>
Variable: rx_nojumbo</para>
<para>If enabled, does not send or indicate that we are able to send or receive RX jumbograms.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_ConnDeadTimeout">Value: ConnDeadTimeout</title>
<indexterm significance="normal">
<primary>ConnDeadTimeout</primary>
</indexterm>
<para id="Value_ConnDeadTimeout">Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>
Type: DWORD
</para>
<para>
Default: 0 (seconds)
</para>
<para>
Variable: ConnDeadtimeout</para>
<para>When the value is 0, this setting is configured to be one-half the HardDeadTimeout value.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_HardDeadTimeout">Value: HardDeadTimeout</title>
<indexterm significance="normal">
<primary>HardDeadTimeout</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>
Type: DWORD
</para>
<para>
Default: 0 (seconds)
</para>
<para>
Variable: HardDeadtimeout</para>
<para>The Hard Dead Time is enforced to be at least double the ConnDeadTimeout. The provides an opportunity for at least one retry. </para>
<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>
<para>
</para>
<para> [HKLM\SYSTEM\CurrentControlSet\Services\lanmanworkstation\parameters]</para>
<para> SessTimeout</para>
<para>
</para>
<para>If the minimum SMB timeout is not specified the value is 45 seconds. See
<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></para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_IdleDeadTimeout">Value: IdleDeadTimeout</title>
<indexterm significance="normal">
<primary>IdleDeadTimeout</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD </para>
<para>Default: 1200 (seconds) </para>
<para>Variable: IdleDeadtimeout </para>
<para>The Idle Dead Time determines how long the cache manager will wait for an RPC on a
non-replicated volume to complete when the service is responding only with keep alive
messages. When there is no replica available there is no other file server to try. An
idle dead timeout in this case is fatal. This option is intended to protect a client
against a file server that never responds. This value must be larger that the file
server hard dead timeout of 120 seconds.</para>
</section>
<section>
<title>Value: ReplicaIdleDeadTimeout</title>
<indexterm>
<primary>ReplicaIdleDeadTimeout</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD</para>
<para>Default: 180 (seconds)</para>
<para>Variable: ReplicaIdleDeadtimeout</para>
<para>The Replica Idle Dead Time determines how long the cache manager will wait for an
RPC on a replicated volume to complete when the service is responding only with keep
alive messages. When a volume is replicated the cache manager can choose to retry the
request against a file server hosting one of the replicas. This value must be larger
that the file server hard dead timeout of 120 seconds.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_NATPingInterval">Value: NATPingInterval</title>
<indexterm significance="normal">
<primary>NATPingInterval</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>
Type: DWORD
</para>
<para>
Default: 0 (seconds)
</para>
<para>
Variable: NatPingInterval
</para>
<para>
The NAT Ping Interval determines how frequently a low-level Rx ping packet is sent to
every file server using an anonymous connection. The value 0 seconds disables the
functionality. A non-zero value activates the NAT ping behavior. This option can be
enabled on clients that access AFS file servers from behind a NAT or port mapping
firewall that maintains a short timeout on UDP port mappings. In this case the AFS
cache manager may not receive AFS callbacks from the file server. This registry value
should be set to a number of seconds shorter than the port mapping timeout period.
When there is no other information to go on, a value of 20 seconds can be used.
</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_TraceOption">Value: TraceOption</title>
<indexterm significance="normal">
<primary>TraceOption</primary>
</indexterm>
<para id="Value_TraceOption">Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {0-15}
</para>
<para>
Default: 0</para>
<para>Enables logging of debug output to the Windows Event Log.</para>
<para>Bit 0 enables logging of "Logon Events" processed by the Network Provider and Winlogon Event Notification Handler. </para>
<para>Bit 1 enables logging of events captured by the AFS Client Service.</para>
<para>Bit 2 enables real-time viewing of "fs trace" logging with DbgView or similar tools.</para>
<para>Bit 3 enables "fs trace" logging on startup.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_AllSubmount">Value: AllSubmount</title>
<indexterm significance="normal">
<primary>AllSubmount</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {0, 1}
</para>
<para>
Default: 1</para>
<para>Variable: allSubmount (smb.c)</para>
<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>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_NoFindLanaByName">Value: NoFindLanaByName</title>
<indexterm significance="normal">
<primary>NoFindLanaByName</primary>
</indexterm>
<para id="Value_NoFindLanaByName">Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {0, 1}
</para>
<para>
Default: 0</para>
<para>Disables the attempt to identity the network adapter to use by looking for an adapter with a display name of "AFS".</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_MaxCPUs">Value: MaxCPUs</title>
<indexterm significance="normal">
<primary>MaxCPUs</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {1..32} or {1..64} depending on the architecture
</para>
<para> Default: 2</para>
<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.
Performance profiling shows that overall system performance degrades when the
afsd_service.exe is permitted to execute on more than two cores.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_SmbAuthType">Value: SmbAuthType</title>
<indexterm significance="normal">
<primary>SMBAuthType</primary>
</indexterm>
<para id="Value_smbAuthType">Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {0..2}
</para>
<para>
Default: 2</para>
<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>
<para>0 = No authentication required
</para>
<para>
<simplelist type="vert">
<member>
1 = NTLM authentication required
</member>
<member>
2 = Extended (GSS SPNEGO) authentication required
</member>
</simplelist>
</para>
<para> The default is Extended authentication This value only applies when the SMB server
interface is in use.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_MaxLogSize">Value: MaxLogSize</title>
<indexterm significance="normal">
<primary>MaxLogSize</primary>
</indexterm>
<para id="Value_MaxLogSize">Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {0 .. MAXDWORD}
</para>
<para>
Default: 100K</para>
<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>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_FlushOnHibernate">Value: FlushOnHibernate</title>
<indexterm significance="normal">
<primary>FlushOnHibernate</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {0,1}
</para>
<para>
Default: 1</para>
<para>If set, flushes all volumes before the machine goes on hibernate or stand-by.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_DaemonCheckDownInterval">Value: DaemonCheckDownInterval</title>
<indexterm significance="normal">
<primary>DaemonCheckDownInterval</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD (seconds)
</para>
<para>
Default: 180</para>
<para>This value controls how frequently the AFS cache manager probes servers that are marked as "down".</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_DaemonCheckUpInterval">Value: DaemonCheckUpInterval</title>
<indexterm significance="normal">
<primary>DaemonCheckUpInterval</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD (seconds)
</para>
<para>
Default: 600</para>
<para>This value controls how frequently the AFS cache manager probes servers that are marked as "up".</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_DaemonCheckVolInterval">Value: DaemonCheckVolInterval</title>
<indexterm significance="normal">
<primary>DaemonCheckVolInterval</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD (seconds)
</para>
<para>
Default: 3600</para>
<para>This value controls how frequently the AFS cache manager forces a reset on the existing volume database information.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_DaemonCheckCBInterval">Value: DaemonCheckCBInterval</title>
<indexterm significance="normal">
<primary>DaemonCheckCBInterval</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD (seconds)
</para>
<para>
Default: 60</para>
<para>This value controls how frequently the AFS cache manager checks for callback invalidation.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_DaemonCheckLockInterval">Value: DaemonCheckLockInterval</title>
<indexterm significance="normal">
<primary>DaemonCheckLockInterval</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD (seconds)
</para>
<para>
Default: 60</para>
<para>This value controls how frequently the AFS cache manager checks for invalid file locks.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_DaemonCheckTokenInterval">Value: DaemonCheckTokenInterval</title>
<indexterm significance="normal">
<primary>DaemonCheckTokenInterval</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD (seconds)
</para>
<para>
Default: 180</para>
<para>This value controls how frequently the AFS cache manager checks for expired tokens.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_DaemonCheckOfflineVolInterval">Value: DaemonCheckOfflineVolInterval</title>
<indexterm significance="normal">
<primary>DaemonCheckOfflineVolInterval</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD (seconds)
</para>
<para>
Default: 600</para>
<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>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_CallBackPort">Value: CallBackPort</title>
<indexterm significance="normal">
<primary>CallBackPort</primary>
</indexterm>
<indexterm significance="normal">
<primary>port 7001/udp</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD
</para>
<para>
Default: 7001</para>
<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>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_EnableServerLocks">Value: EnableServerLocks</title>
<indexterm significance="normal">
<primary>EnableServerLocks</primary>
</indexterm>
<para id="Value_EnableServerLocks">Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {0, 1, 2}
</para>
<para>
Default: 1</para>
<para>Determines whether or not the AFS file server is contacted for </para>
<para>0: never obtain server locks</para>
<para>1: obtain server locks unless the file server says not to</para>
<para>2: always obtain server locks</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_DeleteReadOnly">Value: DeleteReadOnly</title>
<indexterm significance="normal">
<primary>DeleteReadOnly</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {0, 1}
</para>
<para>
Default: 0</para>
<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>
<para>0: do not permit "Read Only" files to be deleted.</para>
<para>1: delete files that have the "Read Only" attribute set without complaint.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_BPlusTrees">Value: BPlusTrees</title>
<indexterm significance="normal">
<primary>BPlusTrees</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {0, 1}
</para>
<para>
Default: 1</para>
<para>Determines whether or not the AFS Cache Manager uses locally constructed B+ Trees to speed up the performance of directory searches. </para>
<para>0: do not use B+ Trees for directory lookups</para>
<para>1: use B+ Trees for directory lookups</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_PrefetchExecutableExtensions">Value: PrefetchExecutableExtensions</title>
<indexterm significance="normal">
<primary>PrefetchExecutableExtensions</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: MULTI_SZ
</para>
<para>
Default: none specified</para>
<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>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_OfflineReadOnlyIsValid">Value: OfflineReadOnlyIsValid</title>
<indexterm significance="normal">
<primary>OfflineReadOnlyIsValid</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {0, 1}
</para>
<para>
Default: 0</para>
<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>
<para>0: do not treat offline .readonly content as valid</para>
<para>1: treat offline .readonly content as valid</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_GiveUpAllCallBacks">Value: GiveUpAllCallBacks</title>
<indexterm significance="normal">
<primary>GiveUpAllCallBacks</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {0, 1}
</para>
<para> Default: 1</para>
<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>
<para>0: do not perform GiveUpAllCallBacks RPCs</para>
<para>1: perform GiveUpAllCallBacks RPCs </para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_ReadOnlyVolumeVersioning">Value: ReadOnlyVolumeVersioning</title>
<indexterm significance="normal">
<primary>ReadOnlyVolumeVersioning</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {0, 1}
</para>
<para>Default: 0</para>
<para>Determines whether or not the AFS Cache Manager will will make use of the volume
version information reported by the file server as part of the AFSVolSync data
structure. Use of volume version information can significantly reduce the number of
FetchStatus RPCs issued on objects stored in read-only volumes. This functionality is
disabled by default because all OpenAFS file servers older than OpenAFS 1.4.10 failed to
include valid volume version information as part of the BulkStatus and InlineBulkStatus
RPCs. </para>
<para>0: do not make use of volume version information</para>
<para>1: make use of volume version information</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_FollowBackupPath">Value: FollowBackupPath</title>
<indexterm significance="normal">
<primary>FollowBackupPath</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {0, 1}
</para>
<para>Default: 0</para>
<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>
<para>0: do not prefer .backup volumes when the mount point originates in a .backup volume.</para>
<para>1: prefer .backup volumes when the mount point originates in a .backup volume.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_RxUdpBufSize">Value: RxUdpBufSize</title>
<indexterm significance="normal">
<primary>RxUdpBufSize</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {bytes}
</para>
<para>Default: 262144</para>
<para>Specifies the UDP socket receive and send buffer sizes..</para>
</section>
<section>
<title>Value: VerifyData</title>
<indexterm>
<primary>VerifyData</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {0, 1}</para>
<para>Default: 0</para>
<para>1: after every RXAFS_StoreData RPC immediately perform an RXAFS_FetchData RPC and
verify that the data was correctly stored on the file server. If the data does not
match, retry the store operation until it does.</para>
<para>The "fs getverify" and "fs setverify {on, off}" commands can be used to query and
set this value at runtime.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_ShortNames">Value: ShortNames</title>
<indexterm significance="normal">
<primary>ShortNames</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {0, 1}
</para>
<para> Default: 0 on Windows 7, Windows 8, Server 2008 R2 and Server 2012, 1
otherwise</para>
<para>Determines whether or not the AFS Cache Manager will generate 8.3 compatible shortnames for all objects stored in AFS. Short names are disabled by default on Windows 8 and Server 2012. All prior operating systems enable short names by default.</para>
<para>0: do not generate 8.3 compatible short names.</para>
<para>1: generate 8.3 compatible short names.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_DirectIO">Value: DirectIO</title>
<indexterm significance="normal">
<primary>DirectIO</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {0, 1}
</para>
<para>
Default: 1</para>
<para>The AFS redirector as of 1.7.22 supports two I/O processing mechanisms. The new
implementation is referred to as Direct I/O. Direct I/O provides two benefits over the
prior implementation. First, it is faster. Second, it provides support for
CreateFile(FILE_FLAG_NO_BUFFERING). When a file is opened with the
FILE_FLAG_NO_BUFFERING flag set, the AFSCache is bypassed and all I/O operations on the
file are performed directly to and from the file server.</para>
<para>0: use the older I/O processing mechanism.</para>
<para>1: use the new Direct I/O processing mechanism.</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_VolumeInfoReadOnlyFlag">Value: VolumeInfoReadOnlyFlag</title>
<indexterm significance="normal">
<primary>VolumeInfoReadOnlyFlag</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {0, 1}
</para>
<para>
Default: 1</para>
<para>The Win32 GetVolumeInformation and GetVolumeInformationByHandle APIs permit
applications to query volume attributes such as Case Preserving, Case Insensitive
lookups, support for hard links, support for reparse points, support for Unicode and
whether or not the volume is read only. The FILE_READ_ONLY_VOLUME flag when set permits
applications such as the Explorer Shell to disable the "Delete" and "Rename" options and
prevent copying files into the volume without issuing the request to the file system.
Unfortunately, the Windows 7 explorer shell has a bug when a drive letter is mapped to a
UNC path. If the mapped path refers to a read only volume, then all volumes accessible
via the drive letter are also treated as read only. This bug is fixed in Windows 8 and
Server 2012. To improve application compatibility the setting of the
FILE_READ_ONLY_VOLUME flag is disabled by default on Windows 7 and below and enabled on
Windows 8 and above.</para>
<para>0: prevent setting the FILE_READ_ONLY_VOLUME flag. (default on Win7 and below).</para>
<para>1: permit setting the FILE_READ_ONLY_VOLUME flag. (default on Win8 and above)</para>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_ReparsePointPolicy">Value: ReparsePointPolicy</title>
<indexterm significance="normal">
<primary>ReparsePointPolicy</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD {0, 1}
</para>
<para>
Default: 0</para>
<para>Windows file systems use <ulink
url="http://msdn.microsoft.com/en-us/library/windows/desktop/aa365503%28v=vs.85%29.aspx"
>reparse points</ulink> to represent special file system objects such as NTFS
Junctions, Symbolic Links and AFS Mount Points. Windows applications must be designed
to work with <ulink
url="http://msdn.microsoft.com/en-us/library/windows/desktop/aa365680%28v=vs.85%29.aspx"
>Symbolic Links</ulink> because <ulink
url="http://msdn.microsoft.com/en-us/library/windows/desktop/aa365682%28v=vs.85%29.aspx"
>several standard file system functions</ulink> behave differently when the provided
path specifies a reparse point. Although there is not a significant impact for Symbolic
Links to Directories and Mount Points to volume root directories, Symbolic Links to
Files can result in applications misinterpreting the file size and attributes.</para>
<para>The ReparsePointPolicy value permits alternate behaviors for reparse point objects
on a global basis. In this version, there is only one policy option which permits
Symbolic Links to Files to be represented with the target file's size and attributes in
the output of FindFirstFile, GetFileAttributes, and GetFileAttributesEx
operations.</para>
<para>0: All Reparse Points are treated as reparse points.</para>
<para>1: Reparse Points to Files treated as the target File.</para>
</section>
</section>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_GlobalAutoMapper">Regkey:
[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters\GlobalAutoMapper]</title>
<indexterm significance="normal">
<primary>GlobalAutoMapper</primary>
</indexterm>
<section>
<title id="Regkey_TransarcAFSDaemon_Parameters_GlobalAutoMapper_DriveLetter">Value: <DriveLetter></title>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters\GlobalAutoMapper]</para>
<para>Type: REG_SZ</para>
<para>Specifies the submount name to be mapped by afsd_service.exe at startup to the provided drive letter.</para>
<para>
<emphasis>This option is deprecated.</emphasis>
</para>
</section>
</section>
<section id="Regkey_HKLM_SOFTWARE_OpenAFS_Client">
<title>Regkey: [HKLM\SOFTWARE\OpenAFS\Client]</title>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_CellServDBDir">Value: CellServDBDir</title>
<indexterm significance="normal">
<primary>CellServDB</primary>
</indexterm>
<indexterm significance="normal">
<primary>CellServDBDir</primary>
</indexterm>
<para id="Value_CellServDBDir">Regkey: [HKLM\SOFTWARE\OpenAFS\Client]</para>
<para>Type: REG_SZ
</para>
<para>
Default: <not defined></para>
<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>
</section>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_VerifyServiceSignature">Value: VerifyServiceSignature</title>
<indexterm significance="normal">
<primary>VerifyServiceSignature</primary>
</indexterm>
<para id="Value_VerifyServiceSignature">Regkey: [HKLM\SOFTWARE\OpenAFS\Client]</para>
<para>Type: REG_DWORD
</para>
<para>
Default: 0x1</para>
<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>
</section>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_IoctlDebug">Value: IoctlDebug</title>
<indexterm significance="normal">
<primary>IoctlDebug</primary>
</indexterm>
<indexterm significance="normal">
<primary>path ioctl debugging</primary>
</indexterm>
<para id="Value_IoctlDebug">Regkey: [HKLM\SOFTWARE\OpenAFS\Client]</para>
<para>Type: REG_DWORD
</para>
<para>
Default: 0x0</para>
<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>
</section>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_MiniDumpType">Value: MiniDumpType</title>
<indexterm significance="normal">
<primary>minidumps</primary>
</indexterm>
<indexterm significance="normal">
<primary>MiniDumpType</primary>
</indexterm>
<para id="Value_MiniDumpType">Regkey: [HKLM\SOFTWARE\OpenAFS\Client]</para>
<para>Type: REG_DWORD
</para>
<para>
Default: 0x0 (MiniDumpNormal)</para>
<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>
<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 "
<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.
</para>
<simplelist type="vert">
<member>
MiniDumpNormal = 0x00000000
</member>
<member>
MiniDumpWithDataSegs = 0x00000001
</member>
<member>
MiniDumpWithFullMemory = 0x00000002
</member>
<member>
MiniDumpWithHandleData = 0x00000004
</member>
<member>
MiniDumpFilterMemory = 0x00000008
</member>
<member>
MiniDumpScanMemory = 0x00000010
</member>
<member>
MiniDumpWithUnloadedModules = 0x00000020
</member>
<member>
MiniDumpWithIndirectlyReferencedMemory = 0x00000040
</member>
<member>
MiniDumpFilterModulePaths = 0x00000080
</member>
<member>
MiniDumpWithProcessThreadData = 0x00000100
</member>
<member>
MiniDumpWithPrivateReadWriteMemory = 0x00000200
</member>
<member>
MiniDumpWithoutOptionalData = 0x00000400
</member>
<member>
MiniDumpWithFullMemoryInfo = 0x00000800
</member>
<member>
MiniDumpWithThreadInfo = 0x00001000
</member>
<member>
MiniDumpWithCodeSegs = 0x00002000
</member>
</simplelist>
</section>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_EnableSMBAsyncStore">Value: EnableSMBAsyncStore</title>
<indexterm significance="normal">
<primary>EnableSMBAsyncStore</primary>
</indexterm>
<para id="Value_EnableSMBAsyncStore">Regkey: [HKLM\SOFTWARE\OpenAFS\Client]</para>
<para>Type: REG_DWORD
</para>
<para>
Default: 0x1</para>
<para>This value can be used to disable the use of SMB Asynchronous Store operations.</para>
</section>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_SMBAsyncStoreSize">Value: SMBAsyncStoreSize</title>
<indexterm significance="normal">
<primary>SMBAsyncStoreSize</primary>
</indexterm>
<para id="Value_SMBAsyncStoreSize">Regkey: [HKLM\SOFTWARE\OpenAFS\Client]</para>
<para>Type: REG_DWORD
</para>
<para>
Default: 32</para>
<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>
</section>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_StoreAnsiFilenames">Value: StoreAnsiFilenames</title>
<indexterm significance="normal">
<primary>StoreAnsiFilenames</primary>
</indexterm>
<indexterm significance="normal">
<primary>Unicode</primary>
</indexterm>
<indexterm significance="normal">
<primary>character sets</primary>
</indexterm>
<para id="Value_StoreAnsiFilenames">Regkey: [HKLM\SOFTWARE\OpenAFS\Client]</para>
<para>Type: REG_DWORD
</para>
<para>
Default: 0x0</para>
<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>
<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>
<para>This value is ignored now that all file names are processed as Unicode and stored on the file server as UTF-8.</para>
</section>
</section>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_CSCPolicy">Regkey: [HKLM\SOFTWARE\OpenAFS\Client\CSCPolicy]</title>
<indexterm significance="normal">
<primary>CSCPolicy</primary>
</indexterm>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_CSCPolicy_">Value: <smb share name></title>
<para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\CSCPolicy]</para>
<para>Type: REG_SZ
</para>
<para>
Default: <none></para>
<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>
<para>These values used to be stored in afsdsbmt.ini</para>
</section>
</section>
<section id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_CellServDB">
<title>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\CellServDB]</title>
<indexterm significance="normal">
<primary>CellServDB</primary>
</indexterm>
<para>The <emphasis>CellServDB</emphasis> key is an alternative to the <emphasis>CellServDB</emphasis> file that can be used either to supplement
or override its contents. This registry entry is meant to provide organizations that centrally manage their client configurations using
<emphasis>Active Directory Group Policy</emphasis> a means of updating records for individual cells or servers without pushing out a new file.
</para>
<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>.
</para>
<para>Support for registry <emphasis>CellServDB</emphasis> configuration was added in 1.5.60.</para>
</section>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_CellServDB_Cell">Regkey: [HKLM\SOFTWARE\OpenAFS\Client\CellServDB\<cellname>]</title>
<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.
Unlike the <cellname> key name, the <server> key names do not have to be actual host names.</para>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_CellServDB_Cell_Description">Value: Description</title>
<para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\CellServDB\<Cell Name>]</para>
<para>Type: REG_SZ
</para>
<para>Default: <none></para>
<para>This value is used to store a description of the Cell appropriate for display in end user facing tools.</para>
</section>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_CellServDB_Cell_ForceDNS">Value: ForceDNS</title>
<para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\CellServDB\<Cell Name>]</para>
<para>Type: REG_DWORD</para>
<para>Range: 0 or 1</para>
<para>Default: 0 if <server> subkeys exist; 1 otherwise</para>
<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>
</section>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_CellServDB_Cell_LinkedCell">Value: LinkedCell</title>
<para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\CellServDB\<Cell Name>]</para>
<para>Type: REG_SZ
</para>
<para>Default: <none></para>
<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
and when tokens are requested for one of the cells they will be obtained for both.
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
for the production versions. Another use is to assist in the transition from one cell name to another.</para>
<para>See also: <link linkend="Linked_Cells">Linked Cells</link>.</para>
</section>
</section>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_CellServDB_Cell_Server">Regkey: [HKLM\SOFTWARE\OpenAFS\Client\CellServDB\<cellname>\<server>]</title>
<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.
If a domain name is specified as the key name, all values become optional.
</para>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_CellServDB_Cell_Server_HostName">Value: HostName</title>
<para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\CellServDB\<Cell Name>\<Server>]</para>
<para>Type: REG_SZ</para>
<para>Default: <none></para>
<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
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
during the gethostbyname() evaluation.
</para>
</section>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_CellServDB_Cell_Server_IPv4Address">Value: IPv4Address</title>
<para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\CellServDB\<Cell Name>\<Server>]</para>
<para>Type: REG_SZ</para>
<para>Default: <none></para>
<para>If the DNS host name lookup fails this value will be used as the IPv4 address for the server.</para>
</section>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_CellServDB_Cell_Server_Rank">Value: Rank</title>
<para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\CellServDB\<Cell Name>\<Server>]</para>
<para>Type: REG_DWORD
</para>
<para>Range: 0..65535</para>
<para>Default: 0</para>
<para>This value specifies the default server preference. A value of 0 indicates that no preference has been specified. When non-zero values
are specified lower values indicate a stronger preference than higher values.</para>
</section>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_CellServDB_Cell_Server_Comment">Value: Comment</title>
<para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\CellServDB\<Cell Name>\<Server>]</para>
<para>Type: REG_SZ</para>
<para>Default: <none></para>
<para>A text string that can be displayed to end users to describe the server.</para>
</section>
</section>
<section id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_Freelance">
<title>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\Freelance]</title>
<indexterm significance="normal">
<primary>Freelance</primary>
</indexterm>
<indexterm significance="normal">
<primary>Freelance Mount Points</primary>
</indexterm>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_Freelance_NumericValue">Value: <numeric value></title>
<para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\Freelance]</para>
<para>Type: REG_SZ
</para>
<para>
Default: <none></para>
<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>
<para>"athena.mit.edu#athena.mit.edu:root.cell."</para>
<para>".athena.mit.edu%athena.mit.edu:root.cell."</para>
<para>These values used to be stored in afs_freelance.ini</para>
</section>
</section>
<section id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_Freelance_Symlinks">
<title>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\Freelance\Symlinks]</title>
<indexterm significance="normal">
<primary>Freelance Symlinks</primary>
</indexterm>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_Freelance_Symlinks_NumericValue">Value: <numeric value></title>
<para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\Freelance\Symlinks]</para>
<para>Type: REG_SZ
</para>
<para>
Default: <none></para>
<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>
<para>"linkname:destination-path."</para>
<para>"athena:athena.mit.edu."</para>
<para>"home:athena.mit.edu\user\j\a\jaltman."</para>
<para>"filename:path\file."</para>
</section>
</section>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_Realms">Regkey: [HKLM\SOFTWARE\OpenAFS\Client\Realms]</title>
<indexterm significance="normal">
<primary>Realms</primary>
</indexterm>
<indexterm significance="normal">
<primary>network identity manager</primary>
</indexterm>
<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>
</section>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_Realms_RealmName">Regkey: [HKLM\SOFTWARE\OpenAFS\Client\Realms\<Realm Name>]</title>
<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>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_Realms_RealmName_AFSEnabled">Value: AFSEnabled</title>
<para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\Realms\<Realm Name>]</para>
<para>Type: REG_DWORD
</para>
<para>
Default: 0x01</para>
<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>
</section>
</section>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_Realms_RealmName_CellName">Regkey:
[HKLM\SOFTWARE\OpenAFS\Client\Realms\<Realm Name>\<Cell Name>]</title>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_Realms_RealmName_CellName_MethodName">Value: MethodName</title>
<para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\Realms\<Realm Name>\<Cell Name>]</para>
<para>Type: REG_SZ
</para>
<para>
Default: <none></para>
<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>
<para>Note: Kerberos524 and Kerberos4 cannot be used with 64-bit Kerberos for Windows.</para>
</section>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_Realms_RealmName_CellName_Realm">Value: Realm</title>
<para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\Realms\<Realm Name>\<Cell Name>]</para>
<para>Type: REG_SZ
</para>
<para>
Default: <none></para>
<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>
</section>
</section>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_Submounts">Regkey:
[HKLM\SOFTWARE\OpenAFS\Client\Submounts]</title>
<indexterm significance="normal">
<primary>Submounts</primary>
</indexterm>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_Submounts_SubmountName">Value: <Submount Name></title>
<para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\Submounts]</para>
<para>Type: REG_EXPAND_SZ
</para>
<para>
Default: <none></para>
<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>
<para>These values used to be stored in afsdsbmt.ini</para>
<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>
</section>
</section>
<section id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_ServerPreferences_VLDB">
<title>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\Server Preferences\VLDB]</title>
<indexterm significance="normal">
<primary>Server Preferences</primary>
</indexterm>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_ServerPreferences_VLDB_HostName">Value: <hostname or ip address></title>
<para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\Server Preferences\VLDB]</para>
<para>Type: REG_DWORD
</para>
<para>
Default: <none></para>
<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>
</section>
</section>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_ServerPreferences_File">Regkey:
[HKLM\SOFTWARE\OpenAFS\Client\Server Preferences\File]</title>
<section>
<title id="Regkey_HKLM_SOFTWARE_OpenAFS_Client_ServerPreferences_File_HostName">Value: <hostname or ip address></title>
<para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client\Server Preferences\File]</para>
<para>Type: REG_DWORD
</para>
<para>
Default: <none></para>
<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>
</section>
</section>
</section>
<section>
<title id="Integrated_Logon_Parameters">A.2. Integrated Logon Network Provider Parameters</title>
<indexterm significance="normal">
<primary>integrated logon</primary>
</indexterm>
<para>Affects the network provider (afslogon.dll).</para>
<section>
<title id="NP_Regkey_TransarcAFSDaemon_Parameters">Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</title>
<section>
<title id="NP_Regkey_TransarcAFSDaemon_Parameters_FailLoginsSilently">Value: FailLoginsSilently</title>
<indexterm significance="normal">
<primary>FailLoginsSilently</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: DWORD
</para>
<para>Default: 0</para>
<para>Do not display message boxes if the login fails.</para>
</section>
</section>
<section>
<title id="NP_Regkey_TransarcAFSDaemon_NetworkProvider">Regkey:
[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]</title>
<section>
<title id="NP_Regkey_TransarcAFSDaemon_NetworkProvider_NoWarnings">Value: NoWarnings</title>
<indexterm significance="normal">
<primary>NoWarnings</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]</para>
<para>Type: DWORD
</para>
<para>Default: 0</para>
<para>Disables visible warnings during logon.</para>
</section>
<section>
<title id="Value_AFSLogon_Debug">Value: Debug</title>
<para>Regkey:
[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]</para>
<para>Type: DWORD</para>
<para>Default: 0</para>
<para>Set to 1 to turn on "AFS Logon" event logging to the Windows Event Log.</para>
</section>
<section>
<title id="NP_Regkey_TransarcAFSDaemon_NetworkProvider_AuthentProviderPath">Value: AuthentProviderPath</title>
<indexterm significance="normal">
<primary>AuthentProviderPath</primary>
</indexterm>
<indexterm significance="normal">
<primary>afslogon.dll</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]</para>
<para>Type: REG_SZ
</para>
<para>
NSIS: %WINDIR%\SYSTEM32\afslogon.dll</para>
<para>Specifies the install location of the authentication provider dll.</para>
</section>
<section>
<title id="NP_Regkey_TransarcAFSDaemon_NetworkProvider_Class">Value: Class</title>
<indexterm significance="normal">
<primary>Class</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]</para>
<para>Type: DWORD
</para>
<para>
NSIS: 0x02</para>
<para>Specifies the class of network provider</para>
</section>
<section>
<title id="NP_Regkey_TransarcAFSDaemon_NetworkProvider_DependOnGroup">Value: DependOnGroup</title>
<indexterm significance="normal">
<primary>DependOnGroup</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]</para>
<para>Type: REG_MULTI_SZ
</para>
<para>
NSIS: PNP_TDI</para>
<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>
</section>
<section>
<title id="NP_Regkey_TransarcAFSDaemon_NetworkProvider_DependOnService">Value: DependOnService</title>
<indexterm significance="normal">
<primary>DependOnService</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]</para>
<para>Type: REG_MULTI_SZ
</para>
<para>
NSIS: Tcpip NETBIOS RpcSs</para>
<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>
</section>
<section>
<title id="NP_Regkey_TransarcAFSDaemon_NetworkProvider_Name">Value: Name</title>
<indexterm significance="normal">
<primary>Name - network provider</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]</para>
<para>Type: REG_SZ
</para>
<para>
NSIS: "OpenAFSDaemon"</para>
<para>Specifies the display name of the AFS Client Service</para>
</section>
<section>
<title id="NP_Regkey_TransarcAFSDaemon_NetworkProvider_ProviderPath">Value: ProviderPath</title>
<indexterm significance="normal">
<primary>ProviderPath</primary>
</indexterm>
<indexterm significance="normal">
<primary>afslogon.dll</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]</para>
<para>Type: REG_SZ
</para>
<para>
NSIS: %WINDIR%\SYSTEM32\afslogon.dll</para>
<para>Specifies the DLL to use for the network provider</para>
</section>
</section>
<section id="Domain_Specific_Configuration">
<title>A.2.1 Domain specific configuration keys for the Network Provider</title>
<indexterm significance="normal">
<primary>domain logon configuration</primary>
</indexterm>
<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>
<para>Domain specific registry keys are:</para>
<section>
<title id="Domain_Regkey_TransarcAFSDaemon_NetworkProvider">Regkey:
[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]</title>
<para> (NP key)</para>
</section>
<section>
<title id="Domain_Regkey_TransarcAFSDaemon_NetworkProvider_Domain">Regkey:
[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]</title>
<para> (Domains key)</para>
</section>
<section>
<title id="Domain_Regkey_TransarcAFSDaemon_NetworkProvider_Domain_DomainName">Regkey:
[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\<Domain
Name>]</title>
<para> (Specific domain key. One per domain.)</para>
</section>
<section>
<title id="Domain_Regkey_TransarcAFSDaemon_NetworkProvider_Domain_LocalHost">Regkey:
[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]</title>
<para> (Localhost key)</para>
</section>
<section>
<title id="Domain_Example">Domain Specific Example:</title>
<para>HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider</para>
<para> |</para>
<para> +- Domain</para>
<para> +-AD1.EXAMPLE.COM</para>
<para> +-AD1</para>
<para> +-AD2.EXAMPLE.NET</para>
<para> +-AD2</para>
<para> +-LOCALHOST</para>
<para> +-Administrator</para>
<para> +-Other User</para>
<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>
</section>
<section>
<title id="Domain_Specific_Configuration_Values">A.2.1.1 Domain Specific Configuration
Values</title>
<section id="Domain_Specific_Regkeys">
<title>Regkeys:
[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider]
[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]
[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\"domain
name"]
[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\"domain
name"]["user name"]
[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]
[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST\"user name"]
</title>
<section>
<title id="Domain_Specific_Regkeys_LogonOptions">Value: LogonOptions</title>
<indexterm significance="normal">
<primary>LogonOptions</primary>
</indexterm>
<para id="Value_LogonOptions">[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\<domain
name>]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\<domain
name>\<user name>]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST\<user name>]</para>
<para>Type: DWORD </para>
<para> Default: 0x01</para>
<para>NSIS/WiX: depends on user configuration</para>
<para>
<simplelist type="vert">
<member>0x00 - Integrated Logon is not used </member>
<member> 0x01 - Integrated Logon is used </member>
</simplelist>
</para>
</section>
<section>
<title id="Domain_Specific_Regkeys_FailLoginsSilently">Value:
FailLoginsSilently</title>
<indexterm significance="normal">
<primary>FailLoginsSilently</primary>
</indexterm>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\<domain
name>]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\<domain
name>\<user name>]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST\<user name>]</para>
<para>Type: DWORD (1|0) </para>
<para> Default: 0 </para>
<para> NSIS/WiX: (not set)</para>
<para>If true, does not display any visible warnings in the event of an error during
the integrated login process.</para>
</section>
<section>
<title id="Domain_Specific_Regkeys_LogonScript">Value: LogonScript</title>
<indexterm significance="normal">
<primary>LogonScript</primary>
</indexterm>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\<domain
name>]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\<domain
name>\<user name>]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST\<user name>]</para>
<para>Type: REG_SZ or REG_EXPAND_SZ </para>
<para> Default: (null) </para>
<para> NSIS/WiX: (only value under NP key) <install path>\afscreds.exe -:%s -x
-a -m -n -q</para>
<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>
</section>
<section>
<title id="Domain_Specific_Regkeys_LoginRetryInterval">Value:
LoginRetryInterval</title>
<indexterm significance="normal">
<primary>LoginRetryInterval</primary>
</indexterm>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\<domain
name>]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\<domain
name>\<user name>]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST\<user name>]</para>
<para>Type: DWORD </para>
<para> Default: 30 </para>
<para> NSIS/WiX: (not set)</para>
<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>
</section>
<section>
<title id="Domain_Specific_Regkeys_LoginSleepInterval">Value:
LoginSleepInterval</title>
<indexterm significance="normal">
<primary>LoginSleepInterval</primary>
</indexterm>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\<domain
name>]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\<domain
name>\<user name>]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST\<user name>]</para>
<para>Type: DWORD </para>
<para> Default: 5 </para>
<para> NSIS/WiX: (not set)</para>
<para>See description of LoginRetryInterval.</para>
</section>
<section>
<title id="Domain_Specific_Regkeys_Realm">Value: Realm</title>
<indexterm significance="normal">
<primary>Realm</primary>
</indexterm>
<para id="Value_Realm">[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\<domain
name>]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\<domain
name>\<user name>]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST\<user name>]</para>
<para>Type: REG_SZ </para>
<para> NSIS: <not set></para>
<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>
</section>
<section>
<title id="Domain_Specific_Regkeys_TheseCells">Value: TheseCells</title>
<indexterm significance="normal">
<primary>TheseCells</primary>
</indexterm>
<para id="Value_TheseCells">[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\<domain
name>]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\<domain
name>\<user name>]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST\<user name>]</para>
<para>Type: REG_MULTI_SZ </para>
<para> NSIS: <not set></para>
<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>
</section>
<section>
<title id="Domain_User_Specific_Regkeys_Username">Value: Username</title>
<indexterm significance="normal">
<primary>Username</primary>
</indexterm>
<para id="Value_Username">[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\<domain
name>\<user name>]</para>
<para>[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider\Domain\LOCALHOST\<user name>]</para>
<para>Type: REG_SZ </para>
<para> NSIS: <not set></para>
<para>Username specifies an alternate username to be combined with the Realm when constructing
the Kerberos v5 principal for which AFS tokens should be obtained.</para>
</section>
</section>
</section>
<section>
<title id="Selection_Effective_Values_for_Domain_Specific_Configuration">A.2.1.2 Selection
of effective values for domain specific configuration</title>
<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>
<para>1. NP key.
("HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\NetworkProvider")</para>
<para>2. Domains key. (NP key\"Domain")</para>
<para>3. Specific domain key. (Domains key\X)</para>
<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>
<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>
</section>
<section>
<title id="Domain_Specific_Configuration_Exceptions">A.2.1.3 Exceptions to A.2.1.2</title>
<para>To retain backwards compatibility, the following exceptions are made to
A.2.1.2.</para>
<section>
<title id="Domain_Specific_Configuration_Exception_FailLoginsSilently">2.1.3.1
'FailLoginsSilently'</title>
<indexterm significance="normal">
<primary>FailLoginsSilently</primary>
</indexterm>
<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>
</section>
<section>
<title id="Domain_Specific_Configuration_Exception_LogonScript">2.1.3.2
'LogonScript'</title>
<indexterm significance="normal">
<primary>LogonScript</primary>
</indexterm>
<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>
</section>
</section>
</section>
</section>
<section>
<title id="AFSCreds_Parameters">A.3. AFS Credentials System Tray Tool parameters</title>
<indexterm significance="normal">
<primary>afscreds.exe</primary>
</indexterm>
<indexterm significance="normal">
<primary>System Tray Tool</primary>
</indexterm>
<para>Affects the behavior of afscreds.exe</para>
<section>
<title id="AFSCreds_Regkey_TransarcAFSDaemon_Parameters">Regkey:
[HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</title>
<section>
<title id="AFSCreds_Regkey_TransarcAFSDaemon_Parameters_Gateway">Value: Gateway</title>
<indexterm significance="normal">
<primary>Gateway</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: REG_SZ
</para>
<para>
Default: ""
</para>
<para>
Function: GetGatewayName()</para>
<para>If the AFS client is utilizing a gateway to obtain AFS access, the name of the gateway is specified by this value.</para>
</section>
<section>
<title id="AFSCreds_Regkey_TransarcAFSDaemon_Parameters_Cell">Value: Cell</title>
<indexterm significance="normal">
<primary>Cell</primary>
</indexterm>
<para>Regkey: [HKLM\SYSTEM\CurrentControlSet\Services\TransarcAFSDaemon\Parameters]</para>
<para>Type: REG_SZ
</para>
<para>
Default: <none>
</para>
<para>
Variable: IsServiceConfigured()</para>
<para>The value Cell is used to determine if the AFS Client Service has been properly configured or not.</para>
</section>
</section>
<section>
<title id="AFSCreds_Regkey_Software_OpenAFS_Client">Regkey:
[HKLM\SOFTWARE\OpenAFS\Client]
[HKCU\SOFTWARE\OpenAFS\Client]</title>
<section>
<title id="AFSCreds_Regkey_Software_OpenAFS_Client_ShowTrayIcon">Value: ShowTrayIcon</title>
<indexterm significance="normal">
<primary>ShowTrayIcon</primary>
</indexterm>
<para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client]</para>
<para>Regkey: [HKCU\SOFTWARE\OpenAFS\Client]</para>
<para>Type: DWORD {0, 1}
</para>
<para>
Default: 1
</para>
<para>
Function: InitApp(), Main_OnCheckTerminate()</para>
<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>
<para>This value used to be stored at [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].</para>
<para>The current user value is checked first; if it does not exist the local machine value is checked.</para>
</section>
<section>
<title id="AFSCreds_Regkey_Software_OpenAFS_Client_EnableKFW">Value: EnableKFW</title>
<indexterm significance="normal">
<primary>EnableKFW</primary>
</indexterm>
<para id="Value_EnableKFW">Regkey: [HKLM\SOFTWARE\OpenAFS\Client]</para>
<para>Regkey: [HKCU\SOFTWARE\OpenAFS\Client]</para>
<para>Type: DWORD {0, 1}
</para>
<para>
Default: 1
</para>
<para>
Function: KFW_is_available()</para>
<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>
</section>
<section>
<title id="AFSCreds_Regkey_Software_OpenAFS_Client_AcceptDottedPrincipalNames">Value: AcceptDottedPrincipalNames</title>
<indexterm significance="normal">
<primary>AcceptDottedPrincipalName</primary>
</indexterm>
<para>Regkey: [HKLM\SOFTWARE\OpenAFS\Client]</para>
<para>Regkey: [HKCU\SOFTWARE\OpenAFS\Client]</para>
<para>Type: DWORD {0, 1}
</para>
<para>
Default: 1
</para>
<para>
Function: KFW_accept_dotted_usernames()</para>
<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>
</section>
<section>
<title id="AFSCreds_Regkey_Software_OpenAFS_Client_Use524">Value: Use524</title>
<indexterm significance="normal">
<primary>Use524</primary>
</indexterm>
<para id="Value_Use524">Regkey: [HKLM\SOFTWARE\OpenAFS\Client]</para>
<para>Regkey: [HKCU\SOFTWARE\OpenAFS\Client]</para>
<para>Type: DWORD {0, 1}
</para>
<para>
Default: 0
</para>
<para>
Function: KFW_use_krb524()</para>
<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>
</section>
<section>
<title id="AFSCreds_Regkey_Software_OpenAFS_Client_AfscredsShortcutParams">Value: AfscredsShortcutParams</title>
<indexterm significance="normal">
<primary>AfscredsShortcutParams</primary>
</indexterm>
<para id="Value_AfscredsShortcutParams">Regkey: [HKLM\SOFTWARE\OpenAFS\Client]</para>
<para>Regkey: [HKCU\SOFTWARE\OpenAFS\Client]</para>
<para>Type: REG_SZ
</para>
<para>
Default: "-A -M -N -Q"
</para>
<para>
Function: Shortcut_FixStartup</para>
<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>
<para>The following subset of the command line options is appropriate for use in this registry setting:</para>
<para>
<simplelist type="vert">
<member>-A = autoinit
</member>
<member>
-M = renew drive maps
</member>
<member>
-N = ip address change detection
</member>
<member>
-Q = quiet mode. do not display start service dialog if afsd_service is not already running
</member>
<member>
-S = show tokens dialog on startup
</member>
<member>
-Z = unmap drives
</member>
</simplelist>
</para>
</section>
</section>
<section>
<title id="AFSCreds_Regkey_HKCU_Software_OpenAFS_Client">Regkey:
[HKCU\SOFTWARE\OpenAFS\Client]</title>
<section>
<title id="AFSCreds_Regkey_HKCU_Software_OpenAFS_Client_AuthenticationCell">Value: Authentication Cell</title>
<indexterm significance="normal">
<primary>Authentication Cell</primary>
</indexterm>
<para>Regkey: [HKCU\SOFTWARE\OpenAFS\Client]</para>
<para>Type: REG_SZ
</para>
<para>
Default: <none>
</para>
<para>
Function: Afscreds.exe GetDefaultCell()</para>
<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>
</section>
</section>
<section>
<title id="AFSCreds_Regkey_HKCU_Software_OpenAFS_Client_Reminders">Regkey:
[HKCU\SOFTWARE\OpenAFS\Client\Reminders]</title>
<indexterm significance="normal">
<primary>Reminders</primary>
</indexterm>
<section>
<title id="AFSCreds_Regkey_HKCU_Software_OpenAFS_Client_Reminders_Cell">Value: <afs cell name></title>
<para>Regkey: [HKCU\SOFTWARE\OpenAFS\Client\Reminders]</para>
<para>Type: DWORD {0, 1}
</para>
<para>
Default: <none>
</para>
<para>
Function: LoadRemind(), SaveRemind()</para>
<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>
<para>This value used to be stored at [HKLM\Software\TransarcCorporation\AFS Client\AfsCreds].</para>
</section>
</section>
<section>
<title id="AFSCreds_Regkey_HKCU_Software_OpenAFS_Client_ActiveMaps">Regkey:
[HKCU\SOFTWARE\OpenAFS\Client\Active Maps]</title>
<indexterm significance="normal">
<primary>ActiveMaps</primary>
</indexterm>
<section>
<title id="AFSCreds_Regkey_HKCU_Software_OpenAFS_Client_ActiveMaps_DriveLetter">Value: <upper case drive letter></title>
<para>Regkey: [HKCU\SOFTWARE\OpenAFS\Client\ActiveMaps]</para>
<para>Type: DWORD {0, 1}
</para>
<para>
Default: <none></para>
<para>These values are used to store the persistence state of the AFS drive mappings as listed in the [...\Client\Mappings] key.</para>
<para>These values used to be stored in the afsdsbmt.ini file</para>
</section>
</section>
<section>
<title id="AFSCreds_Regkey_HKCU_Software_OpenAFS_Client_Mappings">Regkey:
[HKCU\SOFTWARE\OpenAFS\Client\Mappings]</title>
<section>
<title id="AFSCreds_Regkey_HKCU_Software_OpenAFS_Client_Mappings_DriveLetter">Value: <upper case drive letter></title>
<para>Regkey: [HKCU\SOFTWARE\OpenAFS\Client\Mappings]</para>
<para>Type: REG_SZ
</para>
<para>Default: <none></para>
<para>These values are used to store the AFS path in UNIX notation to which the drive letter is to be mapped.</para>
<para>These values used to be stored in the afsdsbmt.ini file.</para>
</section>
</section>
</section>
<section>
<title id="OpenAFS_Service_Environment_Variables">A.4 OpenAFS Client Service Environment Variables</title>
<section>
<title id="OpenAFS_Service_Environment_Variables_AFS_RPC_ENCRYPT">Value: AFS_RPC_ENCRYPT</title>
<indexterm significance="normal">
<primary>AFS_RPC_ENCRYPT</primary>
</indexterm>
<para>Values:
<simplelist type="vert"><member> "OFF" disables the use of RPC encryption </member><member>any other value allows RPC encryption to be used</member></simplelist></para>
<para>
Default: RPC encryption is on
</para>
</section>
<section>
<title id="OpenAFS_Service_Environment_Variables_AFS_RPC_PROTSEQ">Value: AFS_RPC_PROTSEQ</title>
<indexterm significance="normal">
<primary>AFS_RPC_PROTSEQ</primary>
</indexterm>
<para>Values:
<simplelist type="vert"><member>
"ncalrpc" - local RPC
</member><member>
"ncacn_np" - named pipes
</member><member>
"ncacn_ip_tcp" - tcp/ip
</member></simplelist></para>
<para>
Default: local RPC
</para>
</section>
</section>
<section>
<title>A.5 AFS Redirector Parameters</title>
<indexterm>
<primary>afsredir.sys</primary>
</indexterm>
<indexterm>
<primary>afsredirlib.sys</primary>
</indexterm>
<para>The AFS Redirector is implemented with three components:
%windir%\system32\drivers\AFSRedir.sys, %windir%\system32\drivers\AFSRedirLib.sys and
%windir%\system32\AFSRDFSProvider.dll. These components provide the interface between the
Windows Installable File System interface and the WNet application interface and the AFS
file system. The </para>
<section>
<title>[HKLM\SYSTEM\CurrentControlSet\Services\AFSRedirector\Parameters]</title>
<para/>
<section>
<title>Value: DebugFlags</title>
<para>RegKey: [HKLM\SYSTEM\CurrentControlSet\Services\AFSRedirector\Parameters]</para>
<para>Type: REG_DWORD</para>
<para>Default: 0</para>
<para>Bit 0 (0x1): Trigger Debug Break on AFSRedir.sys start. Used for kernel
debugging.</para>
<para>Bit 1 (0x2): Output trace logging to Kernel Debugger. Used for kernel
debugging.</para>
<para>Bit 2 (0x4): Enable Force Crash Ioctl. Checked builds only. Used for force a
BSOD.</para>
<para>Bit 3 (0x8): Enable Bug Check on all exceptions. Normally exceptions are caught by
handlers. Used during testing.</para>
<para>Bit 4 (0x10): Reserved.</para>
<para>Bit 5 (0x20): Do not start the AFS Redirector if Windows did not perform a clean
shutdown.</para>
</section>
<section>
<title>Value: TraceBufferSize</title>
<para>RegKey: [HKLM\SYSTEM\CurrentControlSet\Services\AFSRedirector\Parameters]</para>
<para>Type: REG_DWORD</para>
<para>Default: 0 {0 .. 10000} (KBs)</para>
<para>Specifies the size of the circular trace log buffer allocated within kernel memory.
0 disables trace logging.</para>
</section>
<section>
<title>Value: TraceLevel</title>
<para>RegKey: [HKLM\SYSTEM\CurrentControlSet\Services\AFSRedirector\Parameters]</para>
<para>Type: REG_DWORD</para>
<para>Default: 0 {0..4}</para>
<para>0: No logging; 1: Error; 2: Warning; 3: Verbose; 4: Maximum Verbosity</para>
</section>
<section>
<title>Value: TraceSubsystem</title>
<para>RegKey: [HKLM\SYSTEM\CurrentControlSet\Services\AFSRedirector\Parameters]</para>
<para>Type: REG_DWORD</para>
<para>Default: 0</para>
<para>Bit 0 (0x1): I/O Subsystem</para>
<para>Bit 1 (0x2): File Control Blocks and Name Processing</para>
<para>Bit 2 (0x4): Lock Processing (requires Verbose or higher level)</para>
<para>Bit 3 (0x8): Extent Processing</para>
<para>Bit 4 (0x10): Worker Thread Processing</para>
<para>Bit 5 (0x20): Reference counting of directory entries</para>
<para>Bit 6 (0x40): Reference counting of objects</para>
<para>Bit 7 (0x80): Reference counting of volumes</para>
<para>Bit 8 (0x100): Reference counting of file control blocks</para>
<para>Bit 9 (0x200): Garbage Collection</para>
<para>Bit 10 (0x400): Pipe and share processing</para>
<para>Bit 11 (0x800): Directory notification interface</para>
<para>Bit 12 (0x1000): Network Provider support processing</para>
<para>Bit 13 (0x2000): Directory node count processing</para>
<para>Bit 14 (0x4000): PIOCTL processing</para>
<para>Bit 15 (0x8000): Authentication Group creation and assignment</para>
<para>Bit 16 (0x10000): Library load and unload, task queuing</para>
<para>Bit 17 (0x20000): Process creation and destruction</para>
<para>Bit 18 (0x40000): Extent Active counting</para>
<para>Bit 19 (0x80000): Redirector initialization</para>
<para>Bit 20 (0x100000): Name Array processing</para>
</section>
</section>
<section>
<title>[HKLM\SYSTEM\CurrentControlSet\Services\AFSRedirector\NetworkProvider]</title>
<para/>
<section>
<title>Value: Debug</title>
<para>RegKey:
[HKLM\SYSTEM\CurrentControlSet\Services\AFSRedirector\NetworkProvider]</para>
<para>Type: REG_DWORD</para>
<para>Default: 0</para>
<para>Set to 1 to log all AFSRDFSProvider Network Provider requests to
C:\TEMP\AFSRDFSProvider.log. The C:\TEMP directory cannot be changed and must
exist.</para>
</section>
<section>
<title>Value: Name</title>
<para>RegKey:
[HKLM\SYSTEM\CurrentControlSet\Services\AFSRedirector\NetworkProvider]</para>
<para>Type: REG_SZ</para>
<para>Default: "OpenAFS Network"</para>
<para>This value defines the name displayed in the Explorer Shell and to which network
drive mappings are made.</para>
</section>
</section>
</section>
</chapter>
<index>
<para>
</para>
</index>
</book>
<!-- Keep this comment at the end of the file
Local variables:
mode: xml
sgml-omittag:nil
sgml-shorttag:nil
sgml-namecase-general:nil
sgml-general-insert-case:lower
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:nil
sgml-parent-document:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
|