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

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