doc: add Windows section to fs newcell
[openafs.git] / doc / man-pages / pod1 / fs_newcell.pod
1 =head1 NAME
2
3 fs_newcell - Changes the kernel-resident list of a cell's database servers
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<fs newcell> S<<< B<-name> <I<cell name>> >>> -servers <I<primary servers>>+
11     S<<< [B<-linkedcell> <I<linked cell name>>] >>> [B<-help>]
12
13 B<fs n> S<<< B<-n> <I<cell name>> >>> S<<< B<-s> <I<primary servers>>+ >>>
14     S<<< [B<-l> <I<linked cell name>>] >>> [B<-h>]
15
16 =for html
17 </div>
18
19 =head1 DESCRIPTION
20
21 The B<fs newcell> command removes the Cache Manager's kernel-resident list
22 of database server machines for the cell specified by the B<-name>
23 argument and replaces it with the database server machines named by the
24 B<-servers> argument.
25
26 Each time the machine reboots, the Cache Manager constructs the kernel
27 list of cells and database server machines by reading the local
28 F</usr/vice/etc/CellServDB> file. This command does not change the
29 F<CellServDB> file, so any changes made with it persist only until the
30 next reboot, unless the issuer also edits the file. The output of the B<fs
31 listcells> command reflects changes made with this command, because that
32 command consults the kernel-resident list rather than the F<CellServDB>
33 file.
34
35 This command can introduce a completely new cell into the kernel-resident
36 list, but cannot make a cell inaccessible (it is not possible to remove a
37 cell's entry from the kernel-resident list by providing no values for the
38 B<-server> argument). To make a cell inaccessible, remove its entry from
39 the F<CellServDB> file and reboot the machine.
40
41 If the B<-name> argument names a DCE cell, then the B<-servers> argument
42 names DFS Fileset Location (FL) Server machines. The B<-linkedcell>
43 argument specifies the name of the AFS cell to link to a DCE cell for the
44 purpose of DFS fileset location.
45
46 =head1 CAUTIONS
47
48 Some commands, such as the B<aklog> or B<klog.krb5> commands, work correctly
49 only when the information is accurate for a cell in both the F<CellServDB> file
50 and the kernel-resident list.
51
52 =head1 OPTIONS
53
54 =over 4
55
56 =item B<-name> <I<cell name>>
57
58 Specifies the fully-qualified cell name of the AFS or DCE cell.
59
60 =item B<-servers> <I<primary servers>>+
61
62 Specifies the fully-qualified hostnames of all AFS database server
63 machines or DFS Fileset Location (FL) Server machines for the cell named
64 by the B<-name> argument. If FL Server machines are specified, the local
65 machine must be running the AFS/DFS Migration Toolkit Protocol Translator.
66
67 =item B<-linkedcell> <I<linked cell name>>
68
69 Specifies the name of the AFS cell to link to a DCE cell for the purpose
70 of DFS fileset location.
71
72 =item B<-help>
73
74 Prints the online help for this command. All other valid options are
75 ignored.
76
77 =back
78
79 =head1 WINDOWS
80
81 The B<fs newcell> command on Windows differs from the Unix version in a few ways.
82
83 B<fs newcell> with no arguments discards the existing cell information.
84 The Windows client will reload a cell's information the next time it
85 needs the server list for a cell.
86
87 Secondly, in addition to accepting the Unix options, B<fs newcell> on
88 Windows accepts the following options:
89
90 =over 4
91
92 =item B<-dns>
93
94 Adds the new cell to the cache manager, and obtains the VLDB server
95 information from DNS.
96
97 =item B<-registry>
98
99 Adds the new cell to the cache manager, and also saves the cell
100 configuration data in the registry for use the next time the service
101 restarts.
102
103 =item B<-vlport> <I<cell VLDB server port>>
104
105 Specifies an alternate port number at which the cell's volume location
106 database servers are listening.
107
108 =item B<-fsport> <I<cell fileserver port>>
109
110 Specifies an alternate port number at which the cell's file servers are
111 listening.
112
113 =back
114
115 =head1 EXAMPLES
116
117 The following example changes the machine's kernel-resident list of
118 database server machines for the Example Corporation cell to include the
119 machines C<db1.example.com> and C<db2.example.com>:
120
121    % fs newcell -name example.com -servers db1.example.com db2.example.com
122
123 The following example links the DCE cell C<dce.example.com> to the AFS cell
124 C<example.com>. The AFS client contacts the Fileset Location (FL) servers
125 C<db1.dce.example.com> and C<db2.dce.example.com> for fileset location
126 information as it interprets a DFS pathname.
127
128    % fs newcell -name dce.example.com \
129        -servers db1.dce.example.com db2.dce.example.com \
130        -linkedcell example.com
131
132 =head1 PRIVILEGE REQUIRED
133
134 The issuer must be logged in as the local superuser root.
135
136 =head1 SEE ALSO
137
138 L<CellServDB(5)>,
139 L<fs_listcells(1)>
140
141 =head1 COPYRIGHT
142
143 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
144
145 This documentation is covered by the IBM Public License Version 1.0.  It was
146 converted from HTML to POD by software written by Chas Williams and Russ
147 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.