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