doc/man-pages/pod1/vos_remsite.pod

   1 =head1 NAME
   2
   3 vos_remsite - Removes a read-only site definition from a VLDB entry
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<vos remsite> S<<< B<-server> <I<machine name>> >>>
  11     S<<< B<-partition> <I<partition name>> >>>
  12     S<<< B<-id> <I<volume name or ID>> >>>
  13     S<<< [B<-cell> <I<cell name>>] >>>
  14     [B<-noauth>] [B<-localauth>]
  15     [B<-verbose>] [B<-encrypt>] [B<-noresolve>] [B<-help>]
  16
  17 B<vos rems> S<<< B<-s> <I<machine name>> >>>
  18     S<<< B<-p> <I<partition name>> >>>
  19     S<<< B<-i> <I<volume name or ID>> >>>
  20     S<<< [B<-c> <I<cell name>>] >>>
  21     [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>] [B<-h>]
  22
  23 =for html
  24 </div>
  25
  26 =head1 DESCRIPTION
  27
  28 The B<vos remsite> command removes the read-only replication site
  29 specified by the B<-machine> and B<-partition> arguments from the Volume
  30 Location Database (VLDB) entry for the indicated volume, which is
  31 read/write.
  32
  33 This command is useful for removing read-only sites that were mistakenly
  34 created with the B<vos addsite> command, before the B<vos release> command
  35 actually releases them. If a read-only copy already exists at the site, it
  36 is not affected. However, if this read-only site was the last site housing
  37 any version of the volume, then the entire VLDB entry is removed, even if
  38 a copy of the read-only version still actually exists at the site. The VL
  39 Server does not correct the discrepancy until the B<vos syncserv> and
  40 B<vos syncvldb> commands are run.
  41
  42 =head1 CAUTIONS
  43
  44 Do not use this command as the standard way to remove a read-only volume,
  45 because it can create a discrepancy between the VLDB and the volumes on
  46 file server machines. Use the B<vos remove> command instead.
  47
  48 =head1 OPTIONS
  49
  50 =over 4
  51
  52 =item B<-server> <I<server name>>
  53
  54 Specifies the file server machine portion of the site definition to
  55 remove. Provide the machine's IP address or its host name (either fully
  56 qualified or using an unambiguous abbreviation). For details, see
  57 L<vos(1)>.
  58
  59 =item B<-partition> <I<partition name>>
  60
  61 Specifies the partition name portion of the site definition to
  62 remove. Provide the partition's complete name with preceding slash (for
  63 example, C</vicepa>) or use one of the three acceptable abbreviated
  64 forms. For details, see L<vos(1)>.
  65
  66 =item B<-id> <I<volume name or id>>
  67
  68 Specifies either the complete name or volume ID number of the read/write
  69 volume to remove.
  70
  71 =item B<-cell> <I<cell name>>
  72
  73 Names the cell in which to run the command. Do not combine this argument
  74 with the B<-localauth> flag. For more details, see L<vos(1)>.
  75
  76 =item B<-noauth>
  77
  78 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
  79 combine this flag with the B<-localauth> flag. For more details, see
  80 L<vos(1)>.
  81
  82 =item B<-localauth>
  83
  84 Constructs a server ticket using a key from the local
  85 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
  86 to the Volume Server and Volume Location Server during mutual
  87 authentication. Do not combine this flag with the B<-cell> argument or
  88 B<-noauth> flag. For more details, see L<vos(1)>.
  89
  90 =item B<-verbose>
  91
  92 Produces on the standard output stream a detailed trace of the command's
  93 execution. If this argument is omitted, only warnings and error messages
  94 appear.
  95
  96 =item B<-encrypt>
  97
  98 Encrypts the command so that the operation's results are not transmitted
  99 across the network in clear text. This option is available in OpenAFS
 100 versions 1.4.11 or later and 1.5.60 or later.
 101
 102 =item B<-noresolve>
 103
 104 Shows all servers as IP addresses instead of the DNS name. This is very
 105 useful when the server address is registered as 127.0.0.1 or when dealing
 106 with multi-homed servers. This option is available in OpenAFS
 107 versions 1.4.8 or later and 1.5.35 or later.
 108
 109 =item B<-help>
 110
 111 Prints the online help for this command. All other valid options are
 112 ignored.
 113
 114 =back
 115
 116 =head1 EXAMPLES
 117
 118 The following command removes the mistakenly defined read-only site
 119 F</viceph> on the file server machine C<fs5.example.com> from the VLDB entry
 120 for the volume C<root.cell>.
 121
 122    % vos remsite -server fs5.example.com -partition h -id root.cell
 123
 124 =head1 PRIVILEGE REQUIRED
 125
 126 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
 127 machine specified with the B<-server> argument and on each database server
 128 machine. If the B<-localauth> flag is included, the issuer must instead be
 129 logged on to a server machine as the local superuser C<root>.
 130
 131 =head1 SEE ALSO
 132
 133 L<vos(1)>,
 134 L<vos_delentry(1)>,
 135 L<vos_remove(1)>,
 136 L<vos_zap(1)>
 137
 138 =head1 COPYRIGHT
 139
 140 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 141
 142 This documentation is covered by the IBM Public License Version 1.0.  It was
 143 converted from HTML to POD by software written by Chas Williams and Russ
 144 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.