doc/man-pages/pod1/vos_addsite.pod.in

   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<-encrypt>] [B<-noresolve>] [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<-noa>] [B<-l>]
  23     [B<-ve>] [B<-e>] [B<-nor>] [B<-h>]
  24
  25 =for html
  26 </div>
  27
  28 =head1 DESCRIPTION
  29
  30 The B<vos addsite> command defines a new read-only site (partition on a
  31 file server machine, specified by the B<-server> and B<-partition>
  32 arguments) in the Volume Location Database (VLDB) entry of the read/write
  33 volume named by the B<-id> argument. When the B<vos release> command is
  34 next issued against the read/write volume, a read-only copy of it is
  35 distributed to all of the read-only sites, including the newly defined
  36 one.
  37
  38 =head1 CAUTIONS
  39
  40 A volume's VLDB entry accommodates a maximum number of 16 site
  41 definitions. The site housing the read/write and backup versions of the
  42 volume counts as one site, the backup snapshot counts as one site, and one
  43 site should be reserved for a transient clone for volume moves and similar
  44 operations. Each read-only site counts as an additional site (even the
  45 read-only site defined on the same file server machine and partition as
  46 the read/write site counts as a separate site). The limit in the VLDB
  47 entry effectively determines the maximum number of copies of the volume
  48 that are available to AFS clients.
  49
  50 Attempts to create additional sites by using this command fail with an
  51 error.
  52
  53 =head1 OPTIONS
  54
  55 =over 4
  56
  57 =item B<-server> <I<machine name>>
  58
  59 Identifies the file server machine where the read-only volume is to
  60 reside. Provide the machine's IP address or its host name (either fully
  61 qualified or using an unambiguous abbreviation). For details, see
  62 L<vos(1)>.
  63
  64 =item B<-partition> <I<partition name>>
  65
  66 Identifies the partition where the read-only volume is to reside, on the
  67 file server machine named by the B<-server> argument. Provide the
  68 partition's complete name with preceding slash (for example, C</vicepa>)
  69 or use one of the three acceptable abbreviated forms. For details, see
  70 L<vos(1)>.
  71
  72 =item B<-id> <I<volume name or ID>>
  73
  74 Specifies either the complete name or volume ID number of the read/write
  75 source volume.
  76
  77 =item B<-roid> <I<readonly volume name or ID>>
  78
  79 Specifies either the complete name or volume ID number of the readonly
  80 volume. This will only be honored if the source read/write volume does not
  81 already have a readonly volume ID associated with it. If the source
  82 read/write volume already has a readonly volume ID, the specified ID will
  83 be ignored, and a warning will be printed.
  84
  85 If this is not specified and the source read/write volume does not already
  86 have a readonly volume ID, a volume ID for the readonly volume will be
  87 allocated for it when the B<vos release> command is run.
  88
  89 The automatically allocated readonly volume IDs should be fine for almost
  90 all cases, so you should almost never need to specify them explicitly.
  91 This option is available in OpenAFS versions 1.5.61 or later.
  92
  93 =item B<-valid>
  94
  95 Marks the site as up-to-date in the VLDB. You should only do this if the
  96 new site already has a current readonly replica of the volume, but for
  97 some reason it is not in the VLDB as a replica site. This is useful when
  98 an existing read-only volume is dumped and restored with the B<-readonly>
  99 flag at the new site. This option is available in OpenAFS clients 1.4.7 or
 100 later and 1.5.31 or later. This option can be used with OpenAFS server
 101 versions later than 1.4.1 or 1.5.0.
 102
 103 =include fragments/vos-common.pod
 104
 105 =back
 106
 107 =head1 EXAMPLES
 108
 109 The following example, appropriate in the Example Organization cell, defines a
 110 read-only site for the cell's C<root.afs> volume.
 111
 112    % vos addsite -server sv7.example.org -partition /vicepb -id root.afs
 113
 114 =head1 PRIVILEGE REQUIRED
 115
 116 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
 117 machine specified with the B<-server> argument and on each database server
 118 machine. If the B<-localauth> flag is included, the issuer must instead be
 119 logged on to a server machine as the local superuser C<root>.
 120
 121 =head1 SEE ALSO
 122
 123 L<vos(1)>,
 124 L<vos_examine(1)>,
 125 L<vos_release(1)>
 126
 127 =head1 COPYRIGHT
 128
 129 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 130
 131 This documentation is covered by the IBM Public License Version 1.0.  It was
 132 converted from HTML to POD by software written by Chas Williams and Russ
 133 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.