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