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