doc/man-pages/pod1/vos_addsite.pod

   1 =head1 NAME
   2
   3 vos addsite - Adds a read-only site definition to a volume's VLDB entry
   4
   5 =head1 SYNOPSIS
   6
   7 B<vos addsite> B<-server> <I<machine name for new site>>
   8     B<-partition> <I<partition name for new site>>
   9     B<-id> <I<volume name or ID>> [B<-cell> <I<cell name>>]
  10     [B<-noauth>] [B<-localauth>] [B<-verbose>] [B<-help>]
  11
  12 B<vos ad> B<-s> <I<machine name for new site>>
  13     B<-p> <I<partition name for new site>>
  14     B<-i> <I<volume name or ID>> [B<-c> <I<cell name>>]
  15     [B<-n>] [B<-l>] [B<-v>] [B<-h>]
  16
  17 =head1 DESCRIPTION
  18
  19 The B<vos addsite> command defines a new read-only site (partition on a
  20 file server machine, specified by the B<-server> and B<-partition>
  21 arguments) in the Volume Location Database (VLDB) entry of the read/write
  22 volume named by the B<-id> argument. When the B<vos release> command is
  23 next issued against the read/write volume, a read-only copy of it is
  24 distributed to all of the read-only sites, including the newly defined
  25 one.
  26
  27 =head1 CAUTIONS
  28
  29 A volume's VLDB entry accommodates a maximum number of site definitions,
  30 as defined in the I<IBM AFS Release Notes>. The site housing the
  31 read/write and backup versions of the volume counts as one site, and each
  32 read-only site counts as an additional site (even the read-only site
  33 defined on the same file server machine and partition as the read/write
  34 site counts as a separate site). The limit in the VLDB entry effectively
  35 determines the maximum number of copies of the volume that are available
  36 to AFS clients.
  37
  38 Attempts to create additional sites by using this command fail with an
  39 error.
  40
  41 =head1 OPTIONS
  42
  43 =over 4
  44
  45 =item B<-server> <I<machine name>>
  46
  47 Identifies the file server machine where the read-only volume is to
  48 reside. Provide the machine's IP address or its host name (either fully
  49 qualified or using an unambiguous abbreviation). For details, see
  50 L<vos(1)>.
  51
  52 =item B<-partition> <I<partition name>>
  53
  54 Identifies the partition where the read-only volume is to reside, on the
  55 file server machine named by the B<-server> argument. Provide the
  56 partition's complete name with preceding slash (for example, C</vicepa>)
  57 or use one of the three acceptable abbreviated forms. For details, see
  58 L<vos(1)>.
  59
  60 =item B<-id> <I<volume name or ID>>
  61
  62 Specifies either the complete name or volume ID number of the read/write
  63 source volume.
  64
  65 =item B<-cell> <I<cell name>>
  66
  67 Names the cell in which to run the command. Do not combine this argument
  68 with the B<-localauth> flag. For more details, see L<vos(1)>.
  69
  70 =item B<-noauth>
  71
  72 Assigns the unprivileged identity anonymous to the issuer. Do not combine
  73 this flag with the B<-localauth> flag. For more details, see L<vos(1)>.
  74
  75 =item -localauth
  76
  77 Constructs a server ticket using a key from the local
  78 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
  79 to the Volume Server and Volume Location Server during mutual
  80 authentication. Do not combine this flag with the B<-cell> argument or
  81 B<-noauth> flag. For more details, see L<vos(1)>.
  82
  83 =item B<-verbose>
  84
  85 Produces on the standard output stream a detailed trace of the command's
  86 execution. If this argument is omitted, only warnings and error messages
  87 appear.
  88
  89 =item B<-help>
  90
  91 Prints the online help for this command. All other valid options are
  92 ignored.
  93
  94 =back
  95
  96 =head1 EXAMPLES
  97
  98 The following example, appropriate in the State University cell, defines a
  99 read-only site for the cell's C<root.afs> volume.
 100
 101    % vos addsite -server sv7.stateu.edu -partition /vicepb -id root.afs
 102
 103 =head1 PRIVILEGE REQUIRED
 104
 105 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
 106 machine specified with the B<-server> argument and on each database server
 107 machine. If the B<-localauth> flag is included, the issuer must instead be
 108 logged on to a server machine as the local superuser C<root>.
 109
 110 =head1 SEE ALSO
 111
 112 L<vos(1)>,
 113 L<vos_examine(1)>,
 114 L<vos_release(1)>
 115
 116 =head1 COPYRIGHT
 117
 118 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 119
 120 This documentation is covered by the IBM Public License Version 1.0.  It was
 121 converted from HTML to POD by software written by Chas Williams and Russ
 122 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.