doc: bos != vos
[openafs.git] / doc / man-pages / pod1 / vos.pod
1 =head1 NAME
2
3 vos - Introduction to the vos command suite
4
5 =head1 DESCRIPTION
6
7 The commands in the B<vos> command suite are the administrative interface
8 to the Volume Server and Volume Location (VL) Server. System
9 administrators use B<vos> commands to create, move, delete, replicate,
10 back up and examine volumes, among other operations. The VL Server
11 automatically records in the Volume Location Database (VLDB) changes in
12 volume status and location that result from B<vos> commands.
13
14 The operations invoked by most B<vos> commands are idempotent, meaning
15 that if an operation is interrupted by a network, server machine, or
16 process outage, then a subsequent attempt at the same operation continues
17 from the interruption point, rather than starting over at the beginning of
18 the operation. Before executing a command, the Volume and VL Servers check
19 the current state of the volumes and VLDB records to be altered by the
20 command. If they are already in the desired end state (or a consistent
21 intermediate state), there is no need to repeat the internal steps that
22 brought them there. Idempotency does not apply if the command issuer
23 explicitly interrupts the operation with the Ctrl-C command or another
24 interrupt signal. In that case, the volume is left locked and the
25 administrator must use the L<B<vos unlock>|vos_unlock(1)> command to
26 unlock it before proceeding.
27
28 It is important that the VLDB accurately indicate the status of the
29 volumes on file server machines at all times. L<vldb.DB0(5)> and
30 L<afs_volume_header(5)> describe the information recorded in the VLDB and
31 volume headers, respectively. If a B<vos> command changes volume status,
32 it automatically records the change in the corresponding VLDB entry. The
33 most common cause of discrepancies between the VLDB and volume status on
34 file server machines is interrupted operations; to restore consistency,
35 use the L<B<vos syncserv>|vos_syncserv(1)> and
36 L<B<vos syncvldb>|vos_syncvldb(1)> commands.
37
38 There are several categories of commands in the vos command suite:
39
40 =over 4
41
42 =item *
43
44 Commands to create, move, and rename volumes:
45 L<B<vos backup>|vos_backup(1)>,
46 L<B<vos backupsys>|vos_backupsys(1)>,
47 L<B<vos changeloc>|vos_changeloc(1)>,
48 L<B<vos create>|vos_create(1)>,
49 L<B<vos move>|vos_move(1)>,
50 and L<B<vos rename>|vos_rename(1)>.
51
52 =item *
53
54 Commands to remove VLDB volume records or volumes or both:
55 L<B<vos delentry>|vos_delentry(1)>,
56 L<B<vos remove>|vos_remove(1)>,
57 and L<B<vos zap>|vos_zap(1)>.
58
59 =item *
60
61 Commands to edit or display VLDB server entries:
62 L<B<vos changeaddr>|vos_changeaddr(1)>,
63 L<B<vos listaddrs>|vos_listaddrs(1)>
64 and L<B<vos setaddrs>|vos_setaddrs(1)>.
65
66 =item *
67
68 Commands to create, size, and restore dump files:
69 L<B<vos dump>|vos_dump(1)>,
70 L<B<vos restore>|vos_restore(1)>,
71 and L<B<vos size>|vos_size(1)>.
72
73 =item *
74
75 Commands to administer replicated volumes:
76 L<B<vos addsite>|vos_addsite(1)>,
77 L<B<vos release>|vos_release(1)>,
78 and L<B<vos remsite>|vos_remsite(1)>.
79
80 =item *
81
82 Commands to display VLDB records, volume headers, or both:
83 L<B<vos examine>|vos_examine(1)>,
84 L<B<vos listvldb>|vos_listvldb(1)>,
85 and L<B<vos listvol>|vos_listvol(1)>.
86
87 =item *
88
89 Commands to display information about partitions that house volumes:
90 L<B<vos listpart>|vos_listpart(1)>
91 and L<B<vos partinfo>|vos_partinfo(1)>.
92
93 =item *
94
95 Commands to restore consistency between the VLDB and volume headers:
96 L<B<vos syncserv>|vos_syncserv(1)>
97 and L<B<vos syncvldb>|vos_syncvldb(1)>.
98
99 =item *
100
101 Commands to lock and unlock VLDB entries:
102 L<B<vos lock>|vos_lock(1)>,
103 L<B<vos unlock>|vos_unlock(1)>,
104 and L<B<vos unlockvldb>|vos_unlockvldb(1)>.
105
106 =item *
107
108 A command to report Volume Server status:
109 L<B<vos status>|vos_status(1)>.
110
111 =item *
112
113 A command to end Volume Server transactions:
114 L<B<vos endtrans>|vos_endtrans(1)>.
115
116 =item *
117
118 A command to change volume fields:
119 L<B<vos setfields>|vos_setfields(1)>.
120
121 =item *
122
123 Commands to obtain help:
124 L<B<vos apropos>|vos_apropos(1)>
125 and L<B<vos help>|vos_help(1)>.
126
127 =back
128
129 =head1 CAUTIONS
130
131 Currently, the maximum size of a volume is 2 terabytes (2^31 bytes).
132
133 =head1 OPTIONS
134
135 The following arguments and flags are available on many commands in the
136 B<vos> suite. The reference page for each command also lists them, but
137 they are described here in greater detail.
138
139 =over 4
140
141 =item B<-cell> <I<cell name>>
142
143 Names the cell in which to run the command. It is acceptable to abbreviate
144 the cell name to the shortest form that distinguishes it from the other
145 entries in the F</usr/vice/etc/CellServDB> file on the local machine. If
146 the B<-cell> argument is omitted, the command interpreter determines the
147 name of the local cell by reading the following in order:
148
149 =over 4
150
151 =item *
152
153 The value of the AFSCELL environment variable.
154
155 =item *
156
157 The local F</usr/vice/etc/ThisCell> file.
158
159 =back
160
161 Do not combine the B<-cell> and B<-localauth> options. A command on which
162 the B<-localauth> flag is included always runs in the local cell (as
163 defined in the server machine's local F</usr/afs/etc/ThisCell> file),
164 whereas a command on which the B<-cell> argument is included runs in the
165 specified foreign cell.
166
167 =item B<-help>
168
169 Prints a command's online help message on the standard output stream. Do
170 not combine this flag with any of the command's other options; when it is
171 provided, the command interpreter ignores all other options, and only
172 prints the help message.
173
174 =item B<-localauth>
175
176 Constructs a server ticket using the server encryption key with the
177 highest key version number in the local F</usr/afs/etc/KeyFile> file. The
178 B<vos> command interpreter presents the ticket, which never expires, to
179 the Volume Server and VL Server during mutual authentication.
180
181 Use this flag only when issuing a command on a server machine; client
182 machines do not usually have a F</usr/afs/etc/KeyFile> file.  The issuer
183 of a command that includes this flag must be logged on to the server
184 machine as the local superuser C<root>. The flag is useful for commands
185 invoked by an unattended application program, such as a process controlled
186 by the UNIX B<cron> utility or by a cron entry in the machine's
187 F</usr/afs/local/BosConfig> file. It is also useful if an administrator is
188 unable to authenticate to AFS but is logged in as the local superuser
189 B<root>.
190
191 Do not combine the B<-cell> and B<-localauth> options. A command on which
192 the B<-localauth> flag is included always runs in the local cell (as
193 defined in the server machine's local F</usr/afs/etc/ThisCell> file),
194 whereas a command on which the B<-cell> argument is included runs in the
195 specified foreign cell. Also, do not combine the B<-localauth> and
196 B<-noauth> flags.
197
198 =item B<-noauth>
199
200 Establishes an unauthenticated connection to the Volume Server and VL
201 Server, in which the servers treat the issuer as the unprivileged user
202 C<anonymous>. It is useful only when authorization checking is disabled on
203 the server machine (during the installation of a file server machine or
204 when the L<B<bos setauth>|bos_setauth(8)> command has been used during
205 other unusual circumstances). In normal circumstances, the servers allow
206 only privileged users to issue commands that change the status of a volume
207 or VLDB record, and refuses to perform such an action even if the
208 B<-noauth> flag is provided. Do not combine the B<-noauth> and
209 B<-localauth> flags.
210
211 =item B<-partition> <I<partition name>>
212
213 Identifies the AFS server partition on a file server machine that houses,
214 or is to house, the volumes of interest, or about which to list
215 information. The B<vos> command interpreter accepts any of the following
216 four name formats:
217
218    /vicepa     =     vicepa      =      a      =      0
219    /vicepb     =     vicepb      =      b      =      1
220
221 After /vicepz (for which the index is 25) comes
222
223    /vicepaa    =     vicepaa     =      aa     =      26
224    /vicepab    =     vicepab     =      ab     =      27
225
226 and so on through
227
228    /vicepiv    =     vicepiv     =      iv     =      255
229
230 The B<-frompartition> and B<-topartition> arguments to the
231 L<B<vos move>|vos_move(1)> command also accept this notation.
232
233 =item B<-server> <I<machine name>>
234
235 Identifies the file server machine that houses, or is to house, the
236 volumes or AFS server partitions of interest. Provide the machine's IP
237 address in dotted decimal format, its fully qualified host name (for
238 example, C<fs1.abc.com>), or the shortest abbreviated form of its host
239 name that distinguishes it from other machines. Successful use of an
240 abbreviated form depends on the availability of a name resolution service
241 (such as the Domain Name Service or a local host table) at the time the
242 command is issued.
243
244 The B<-fromserver> and B<-toserver> arguments to the
245 L<B<vos move>|vos_move(1)> command also accept these name formats.
246
247 =item B<-noresolve>
248
249 Shows all servers as IP addresses instead of the DNS name. This is very
250 useful when the server address is registered as 127.0.0.1 or when dealing
251 with multi-homed servers. The B<-noresolve> option is available in OpenAFS
252 versions 1.4.8 or later and 1.5.35 or later.
253
254 =item B<-verbose>
255
256 Produces on the standard output stream a detailed trace of the command's
257 execution. If this argument is omitted, only warnings and error messages
258 appear.
259
260 =back
261
262 =head1 PRIVILEGE REQUIRED
263
264 To issue most vos commands, the issuer must be listed in the
265 F</usr/afs/etc/UserList> file on each server machine that houses or is to
266 house an affected volume, and on each database server machine. The most
267 predictable performance results if all database server and file server
268 machines in the cell share a common F<UserList> file.  Alternatively, if
269 the B<-localauth> flag is included, the issuer must be logged on to a
270 server machine as the local superuser C<root>.
271
272 To issue a vos command that only displays information, no privilege is
273 required.
274
275 =head1 SEE ALSO
276
277 L<vos_addsite(1)>,
278 L<vos_apropos(1)>,
279 L<vos_backup(1)>,
280 L<vos_backupsys(1)>,
281 L<vos_changeaddr(1)>,
282 L<vos_convertROtoRW(1)>,
283 L<vos_clone(1)>,
284 L<vos_copy(1)>,
285 L<vos_create(1)>,
286 L<vos_delentry(1)>,
287 L<vos_dump(1)>,
288 L<vos_endtrans(1)>,
289 L<vos_examine(1)>,
290 L<vos_help(1)>,
291 L<vos_listaddrs(1)>,
292 L<vos_listpart(1)>,
293 L<vos_listvldb(1)>,
294 L<vos_listvol(1)>,
295 L<vos_lock(1)>,
296 L<vos_move(1)>,
297 L<vos_partinfo(1)>,
298 L<vos_release(1)>,
299 L<vos_remove(1)>,
300 L<vos_remsite(1)>,
301 L<vos_rename(1)>,
302 L<vos_restore(1)>,
303 L<vos_setfields(1)>,
304 L<vos_shadow(1)>,
305 L<vos_size(1)>,
306 L<vos_status(1)>,
307 L<vos_syncserv(1)>,
308 L<vos_syncvldb(1)>,
309 L<vos_unlock(1)>,
310 L<vos_unlockvldb(1)>,
311 L<vos_zap(1)>,
312 L<CellServDB(5)>,
313 L<UserList(5)>
314
315 =head1 COPYRIGHT
316
317 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
318
319 This documentation is covered by the IBM Public License Version 1.0.  It was
320 converted from HTML to POD by software written by Chas Williams and Russ
321 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.