doc/man-pages/pod1/vos_zap.pod

   1 =head1 NAME
   2
   3 vos_zap - Removes a volume from its site without writing to the VLDB
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<vos zap> S<<< B<-server> <I<machine name>> >>> S<<< B<-partition> <I<partition name>> >>>
  11     S<<< B<-id> <I<volume ID>> >>> [B<-force>] [B<-backup>]
  12     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-verbose>]
  13     [B<-help>]
  14
  15 B<vos z> S<<< B<-s> <I<machine name>> >>> S<<< B<-p> <I<partition name>> >>>
  16     S<<< B<-i> <I<volume ID>> >>> [B<-f>] [B<-b>] S<<< [B<-c> <I<cell name>>] >>> [B<-n>]
  17     [B<-l>] [B<-v>] [B<-h>]
  18
  19 =for html
  20 </div>
  21
  22 =head1 DESCRIPTION
  23
  24 The B<vos zap> command removes the volume with the specified I<volume ID>
  25 from the site defined by the B<-server> and B<-partition> arguments,
  26 without attempting to change the corresponding Volume Location Database
  27 (VLDB) entry. If removing the volume can possibly result in incorrect data
  28 in the VLDB, a warning message is displayed.
  29
  30 The B<-force> flag removes a volume even if it cannot be "attached"
  31 (brought online), which can happen either because the volume is extremely
  32 damaged or because the Salvager functioned abnormally. Without this flag,
  33 this command cannot remove volumes that are not attachable. See also
  34 L<CAUTIONS>.
  35
  36 To remove the specified read/write volume's backup version at the same
  37 time, include the B<-backup> flag.
  38
  39 =head1 CAUTIONS
  40
  41 Do not use this command as the standard way to remove a volume, as it is
  42 likely to put the VLDB out of sync with the volumes on servers. Use the
  43 B<vos remove> command instead.
  44
  45 This command is useful in situations where it is important to delete the
  46 volume, but for some reason the VLDB is unreachable -- for example,
  47 because s the Volume Location Server is unavailable. The issuer can remove
  48 the VLDB entry later with the B<vos remove> or B<vos delentry> command, or
  49 it is removed automatically when the B<vos syncserv> and B<vos syncvldb>
  50 commands run.
  51
  52 To remove a read-only site defined in the VLDB by mistake, before a copy
  53 actually exists at the site, use the B<vos remsite> command. To remove an
  54 entire VLDB entry without affecting volumes at their sites, use the B<vos
  55 delentry> command.
  56
  57 Do not use the B<-force> flag if the volume is online, but only when
  58 attempts to remove the volume with the B<vos remove> or the B<vos zap>
  59 command have failed, or the volume definitely cannot be attached. After
  60 using the B<-force> flag, make sure that the volume's VLDB entry is also
  61 removed (issue the B<vos delentry> command if necessary).
  62
  63 Adding the B<-force> flag makes the command take considerably longer --
  64 about as long as a salvage of the relevant partition -- since the Volume
  65 Server examines all inodes on the partition for traces of the volume.
  66
  67 =head1 OPTIONS
  68
  69 =over 4
  70
  71 =item B<-server> <I<server name>>
  72
  73 Identifies the file server machine from which to remove the volume.
  74 Provide the machine's IP address or its host name (either fully qualified
  75 or using an unambiguous abbreviation). For details, see L<vos(1)>.
  76
  77 =item B<-partition> <I<partition name>>
  78
  79 Identifies the partition (on the file server machine specified by the
  80 B<-server> argument) from which to remove the volume. Provide the
  81 partition's complete name with preceding slash (for example, C</vicepa>)
  82 or use one of the three acceptable abbreviated forms. For details, see
  83 L<vos(1)>.
  84
  85 =item B<-id> <I<volume ID>>
  86
  87 Specifies the volume ID number of the volume to remove, which can be of
  88 any of the three types. The volume name is not acceptable.
  89
  90 =item B<-force>
  91
  92 Removes the volume even though it cannot be attached (brought online). Use
  93 only after the failure of previous attempts to remove the volume by using
  94 the B<vos remove> command or the B<vos zap> command without this flag.
  95
  96 =item B<-backup>
  97
  98 Removes the backup version of the read/write volume specified by the
  99 B<-id> argument. Do not use this flag if the B<-id> argument identifies a
 100 read-only or backup volume.
 101
 102 =item B<-cell> <I<cell name>>
 103
 104 Names the cell in which to run the command. Do not combine this argument
 105 with the B<-localauth> flag. For more details, see L<vos(1)>.
 106
 107 =item B<-noauth>
 108
 109 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
 110 combine this flag with the B<-localauth> flag. For more details, see
 111 L<vos(1)>.
 112
 113 =item B<-localauth>
 114
 115 Constructs a server ticket using a key from the local
 116 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
 117 to the Volume Server and Volume Location Server during mutual
 118 authentication. Do not combine this flag with the B<-cell> argument or
 119 B<-noauth> flag. For more details, see L<vos(1)>.
 120
 121 =item B<-verbose>
 122
 123 Produces on the standard output stream a detailed trace of the command's
 124 execution. If this argument is omitted, only warnings and error messages
 125 appear.
 126
 127 =item B<-help>
 128
 129 Prints the online help for this command. All other valid options are
 130 ignored.
 131
 132 =back
 133
 134 =head1 EXAMPLES
 135
 136 The following example removes the volume with volume ID 536870988 from the
 137 F</vicepf> partition of the file server machine C<fs6.abc.com>, without
 138 noting the change in the VLDB.
 139
 140    % vos zap -server fs6.abc.com -partition f -id 536870988
 141
 142 =head1 PRIVILEGE REQUIRED
 143
 144 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
 145 machine specified with the B<-server> argument and on each database server
 146 machine. If the B<-localauth> flag is included, the issuer must instead be
 147 logged on to a server machine as the local superuser C<root>.
 148
 149 =head1 SEE ALSO
 150
 151 L<vos(1)>,
 152 L<vos_delentry(1)>,
 153 L<vos_remove(1)>,
 154 L<vos_remsite(1)>
 155
 156 =head1 COPYRIGHT
 157
 158 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 159
 160 This documentation is covered by the IBM Public License Version 1.0.  It was
 161 converted from HTML to POD by software written by Chas Williams and Russ
 162 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.