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 =for html
   8 <div class="synopsis">
   9
  10 B<vos addsite> S<<< B<-server> <I<machine name for new site>> >>>
  11     S<<< B<-partition> <I<partition name for new site>> >>>
  12     S<<< B<-id> <I<volume name or ID>> >>>
  13     S<<< [B<-roid> <I<readonly volume name or ID>>] >>>
  14     [B<-valid>] S<<< [B<-cell> <I<cell name>>] >>>
  15     [B<-noauth>] [B<-localauth>]
  16     [B<-verbose>] [B<-help>]
  17
  18 B<vos ad> S<<< B<-s> <I<machine name for new site>> >>>
  19     S<<< B<-p> <I<partition name for new site>> >>>
  20     S<<< B<-i> <I<volume name or ID>> >>>
  21     S<<< [B<-r> <I<readonly volume name or ID>>] >>>
  22     [B<-va>] [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-v>] [B<-h>]
  23
  24 =for html
  25 </div>
  26
  27 =head1 DESCRIPTION
  28
  29 The B<vos addsite> command defines a new read-only site (partition on a
  30 file server machine, specified by the B<-server> and B<-partition>
  31 arguments) in the Volume Location Database (VLDB) entry of the read/write
  32 volume named by the B<-id> argument. When the B<vos release> command is
  33 next issued against the read/write volume, a read-only copy of it is
  34 distributed to all of the read-only sites, including the newly defined
  35 one.
  36
  37 =head1 CAUTIONS
  38
  39 A volume's VLDB entry accommodates a maximum number of site definitions,
  40 as defined in the I<IBM AFS Release Notes>. The site housing the
  41 read/write and backup versions of the volume counts as one site, and each
  42 read-only site counts as an additional site (even the read-only site
  43 defined on the same file server machine and partition as the read/write
  44 site counts as a separate site). The limit in the VLDB entry effectively
  45 determines the maximum number of copies of the volume that are available
  46 to AFS clients.
  47
  48 Attempts to create additional sites by using this command fail with an
  49 error.
  50
  51 =head1 OPTIONS
  52
  53 =over 4
  54
  55 =item B<-server> <I<machine name>>
  56
  57 Identifies the file server machine where the read-only volume is to
  58 reside. Provide the machine's IP address or its host name (either fully
  59 qualified or using an unambiguous abbreviation). For details, see
  60 L<vos(1)>.
  61
  62 =item B<-partition> <I<partition name>>
  63
  64 Identifies the partition where the read-only volume is to reside, on the
  65 file server machine named by the B<-server> argument. Provide the
  66 partition's complete name with preceding slash (for example, C</vicepa>)
  67 or use one of the three acceptable abbreviated forms. For details, see
  68 L<vos(1)>.
  69
  70 =item B<-id> <I<volume name or ID>>
  71
  72 Specifies either the complete name or volume ID number of the read/write
  73 source volume.
  74
  75 =item B<-roid> <I<readonly volume name or ID>>
  76
  77 Specifies either the complete name or volume ID number of the readonly
  78 volume. This will only be honored if the source read/write volume does not
  79 already have a readonly volume ID associated with it. If the source
  80 read/write volume already has a readonly volume ID, the specified ID will
  81 be ignored, and a warning will be printed.
  82
  83 If this is not specified and the source read/write volume does not already
  84 have a readonly volume ID, a volume ID for the readonly volume will be
  85 allocated for it when the B<vos release> command is run.
  86
  87 The automatically allocated readonly volume IDs should be fine for almost
  88 all cases, so you should almost never need to specify this option.
  89
  90 =item B<-valid>
  91
  92 Marks the site as up-to-date in the VLDB. You should only do this if the
  93 new site already has a current readonly replica of the volume, but for
  94 some reason it is not in the VLDB as a replica site. This is useful when
  95 an existing read-only volume is dumped and restored with the B<-readonly>
  96 flag at the new site. This option is available in OpenAFS clients 1.4.7 or
  97 later and 1.5.31 and later. This option can be used with OpenAFS server
  98 versions later than 1.4.1 or 1.5.0.
  99
 100 =item B<-cell> <I<cell name>>
 101
 102 Names the cell in which to run the command. Do not combine this argument
 103 with the B<-localauth> flag. For more details, see L<vos(1)>.
 104
 105 =item B<-noauth>
 106
 107 Assigns the unprivileged identity anonymous to the issuer. Do not combine
 108 this flag with the B<-localauth> flag. For more details, see L<vos(1)>.
 109
 110 =item B<-localauth>
 111
 112 Constructs a server ticket using a key from the local
 113 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
 114 to the Volume Server and Volume Location Server during mutual
 115 authentication. Do not combine this flag with the B<-cell> argument or
 116 B<-noauth> flag. For more details, see L<vos(1)>.
 117
 118 =item B<-verbose>
 119
 120 Produces on the standard output stream a detailed trace of the command's
 121 execution. If this argument is omitted, only warnings and error messages
 122 appear.
 123
 124 =item B<-help>
 125
 126 Prints the online help for this command. All other valid options are
 127 ignored.
 128
 129 =back
 130
 131 =head1 EXAMPLES
 132
 133 The following example, appropriate in the State University cell, defines a
 134 read-only site for the cell's C<root.afs> volume.
 135
 136    % vos addsite -server sv7.stateu.edu -partition /vicepb -id root.afs
 137
 138 =head1 PRIVILEGE REQUIRED
 139
 140 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
 141 machine specified with the B<-server> argument and on each database server
 142 machine. If the B<-localauth> flag is included, the issuer must instead be
 143 logged on to a server machine as the local superuser C<root>.
 144
 145 =head1 SEE ALSO
 146
 147 L<vos(1)>,
 148 L<vos_examine(1)>,
 149 L<vos_release(1)>
 150
 151 =head1 COPYRIGHT
 152
 153 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 154
 155 This documentation is covered by the IBM Public License Version 1.0.  It was
 156 converted from HTML to POD by software written by Chas Williams and Russ
 157 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.