docs-ticket-104110-20080713
[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 B<vos unlock> command to unlock it before
26 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 B<vos syncserv> and B<vos syncvldb> commands.
36
37 There are several categories of commands in the vos command suite:
38
39 =over 4
40
41 =item *
42
43 Commands to create, move, and rename volumes: B<vos backup>, B<vos
44 backupsys>, B<vos changeloc>, B<vos create>, B<vos move>, and B<vos
45 rename>.
46
47 =item *
48
49 Commands to remove VLDB volume records or volumes or both: B<vos
50 delentry>, B<vos remove>, and B<vos zap>.
51
52 =item *
53
54 Commands to edit or display VLDB server entries: B<vos changeaddr> and
55 B<vos listaddrs>.
56
57 =item *
58
59 Commands to create, size, and restore dump files: B<vos dump>, B<vos
60 restore>, and B<vos size>.
61
62 =item *
63
64 Commands to administer replicated volumes: B<vos addsite>, B<vos release>,
65 and B<vos remsite>.
66
67 =item *
68
69 Commands to display VLDB records, volume headers, or both: B<vos examine>,
70 B<vos listvldb>, and B<vos listvol>.
71
72 =item *
73
74 Commands to display information about partitions that house volumes: B<vos
75 listpart> and B<vos partinfo>.
76
77 =item *
78
79 Commands to restore consistency between the VLDB and volume headers: B<vos
80 syncserv> and B<vos syncvldb>.
81
82 =item *
83
84 Commands to lock and unlock VLDB entries: B<vos lock>, B<vos unlock>, and
85 B<vos unlockvldb>.
86
87 =item *
88
89 A command to report Volume Server status: B<vos status>.
90
91 =item *
92
93 Commands to obtain help: B<vos apropos> and B<vos help>.
94
95 =back
96
97 =head1 CAUTIONS
98
99 Currently, the maximum size of a volume is 2 terabytes (2^31 bytes).
100
101 =head1 OPTIONS
102
103 The following arguments and flags are available on many commands in the
104 B<bos> suite. The reference page for each command also lists them, but
105 they are described here in greater detail.
106
107 =over 4
108
109 =item B<-cell> <I<cell name>>
110
111 Names the cell in which to run the command. It is acceptable to abbreviate
112 the cell name to the shortest form that distinguishes it from the other
113 entries in the F</usr/vice/etc/CellServDB> file on the local machine. If
114 the B<-cell> argument is omitted, the command interpreter determines the
115 name of the local cell by reading the following in order:
116
117 =over 4
118
119 =item *
120
121 The value of the AFSCELL environment variable.
122
123 =item *
124
125 The local F</usr/vice/etc/ThisCell> file.
126
127 =back
128
129 Do not combine the B<-cell> and B<-localauth> options. A command on which
130 the B<-localauth> flag is included always runs in the local cell (as
131 defined in the server machine's local F</usr/afs/etc/ThisCell> file),
132 whereas a command on which the B<-cell> argument is included runs in the
133 specified foreign cell.
134
135 =item B<-help>
136
137 Prints a command's online help message on the standard output stream. Do
138 not combine this flag with any of the command's other options; when it is
139 provided, the command interpreter ignores all other options, and only
140 prints the help message.
141
142 =item B<-localauth>
143
144 Constructs a server ticket using the server encryption key with the
145 highest key version number in the local F</usr/afs/etc/KeyFile> file. The
146 B<vos> command interpreter presents the ticket, which never expires, to
147 the Volume Server and VL Server during mutual authentication.
148
149 Use this flag only when issuing a command on a server machine; client
150 machines do not usually have a F</usr/afs/etc/KeyFile> file.  The issuer
151 of a command that includes this flag must be logged on to the server
152 machine as the local superuser C<root>. The flag is useful for commands
153 invoked by an unattended application program, such as a process controlled
154 by the UNIX B<cron> utility or by a cron entry in the machine's
155 F</usr/afs/local/BosConfig> file. It is also useful if an administrator is
156 unable to authenticate to AFS but is logged in as the local superuser
157 B<root>.
158
159 Do not combine the B<-cell> and B<-localauth> options. A command on which
160 the B<-localauth> flag is included always runs in the local cell (as
161 defined in the server machine's local F</usr/afs/etc/ThisCell> file),
162 whereas a command on which the B<-cell> argument is included runs in the
163 specified foreign cell. Also, do not combine the B<-localauth> and
164 B<-noauth> flags.
165
166 =item B<-noauth>
167
168 Establishes an unauthenticated connection to the Volume Server and VL
169 Server, in which the servers treat the issuer as the unprivileged user
170 C<anonymous>. It is useful only when authorization checking is disabled on
171 the server machine (during the installation of a file server machine or
172 when the B<bos setauth> command has been used during other unusual
173 circumstances). In normal circumstances, the servers allow only privileged
174 users to issue commands that change the status of a volume or VLDB record,
175 and refuses to perform such an action even if the B<-noauth> flag is
176 provided. Do not combine the B<-noauth> and B<-localauth> flags.
177
178 =item B<-partition> <I<partition name>>
179
180 Identifies the AFS server partition on a file server machine that houses,
181 or is to house, the volumes of interest, or about which to list
182 information. The B<vos> command interpreter accepts any of the following
183 four name formats:
184
185    /vicepa     =     vicepa      =      a      =      0
186    /vicepb     =     vicepb      =      b      =      1
187
188 After /vicepz (for which the index is 25) comes
189
190    /vicepaa    =     vicepaa     =      aa     =      26
191    /vicepab    =     vicepab     =      ab     =      27
192
193 and so on through
194
195    /vicepiv    =     vicepiv     =      iv     =      255
196
197 The B<-frompartition> and B<-topartition> arguments to the B<vos move>
198 command also accept this notation.
199
200 =item B<-server> <I<machine name>>
201
202 Identifies the file server machine that houses, or is to house, the
203 volumes or AFS server partitions of interest. Provide the machine's IP
204 address in dotted decimal format, its fully qualified host name (for
205 example, C<fs1.abc.com>), or the shortest abbreviated form of its host
206 name that distinguishes it from other machines. Successful use of an
207 abbreviated form depends on the availability of a name resolution service
208 (such as the Domain Name Service or a local host table) at the time the
209 command is issued.
210
211 The B<-fromserver> and B<-toserver> arguments to the B<vos move> command
212 also accept these name formats.
213
214 =item B<-verbose>
215
216 Produces on the standard output stream a detailed trace of the command's
217 execution. If this argument is omitted, only warnings and error messages
218 appear.
219
220 =back
221
222 =head1 PRIVILEGE REQUIRED
223
224 To issue most vos commands, the issuer must be listed in the
225 F</usr/afs/etc/UserList> file on each server machine that houses or is to
226 house an affected volume, and on each database server machine. The most
227 predictable performance results if all database server and file server
228 machines in the cell share a common F<UserList> file.  Alternatively, if
229 the B<-localauth> flag is included, the issuer must be logged on to a
230 server machine as the local superuser C<root>.
231
232 To issue a vos command that only displays information, no privilege is
233 required.
234
235 =head1 SEE ALSO
236
237 L<CellServDB(5)>,
238 L<UserList(5)>,
239 L<vos_addsite(1)>,
240 L<vos_apropos(1)>,
241 L<vos_backup(1)>,
242 L<vos_backupsys(1)>,
243 L<vos_changeaddr(1)>,
244 L<vos_convertROtoRW(1)>,
245 L<vos_clone(1)>,
246 L<vos_copy(1)>,
247 L<vos_create(1)>,
248 L<vos_delentry(1)>,
249 L<vos_dump(1)>,
250 L<vos_examine(1)>,
251 L<vos_help(1)>,
252 L<vos_listaddrs(1)>,
253 L<vos_listpart(1)>,
254 L<vos_listvldb(1)>,
255 L<vos_listvol(1)>,
256 L<vos_lock(1)>,
257 L<vos_move(1)>,
258 L<vos_partinfo(1)>,
259 L<vos_release(1)>,
260 L<vos_remove(1)>,
261 L<vos_remsite(1)>,
262 L<vos_rename(1)>,
263 L<vos_restore(1)>,
264 L<vos_shadow(1)>,
265 L<vos_size(1)>,
266 L<vos_status(1)>,
267 L<vos_syncserv(1)>,
268 L<vos_syncvldb(1)>,
269 L<vos_unlock(1)>,
270 L<vos_unlockvldb(1)>,
271 L<vos_zap(1)>
272
273 =head1 COPYRIGHT
274
275 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
276
277 This documentation is covered by the IBM Public License Version 1.0.  It was
278 converted from HTML to POD by software written by Chas Williams and Russ
279 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.