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