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