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