doc/man-pages/pod1/vos_delentry.pod

   1 =head1 NAME
   2
   3 vos_delentry - Removes a volume entry from the VLDB.
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<vos delentry> S<<< [B<-id> <I<volume name or ID>>+] >>>
  11    S<<< [B<-prefix> <I<prefix of volume whose VLDB entry is to be deleted>>] >>>
  12     S<<< [B<-server> <I<machine name>>] >>>
  13     S<<< [B<-partition> <I<partition name>>] >>>
  14     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>]
  15     [B<-dryrun>] [B<-verbose>] [B<-encrypt>] [B<-noresolve>] [B<-help>]
  16
  17 B<vos de> S<<< [B<-i> <I<volume name or ID>>+] >>>
  18     S<<< [B<-pr> <I<prefix of volume whose VLDB entry is to be deleted>>] >>>
  19     S<<< [B<-s> <I<machine name>>] >>> S<<< [B<-pa> <I<partition name>>] >>>
  20     S<<< [B<-c> <I<cell name>>] >>> [B<-noa>] [B<-l>]
  21     [B<-d>] [B<-v>] [B<-e>] [B<-nor>] [B<-h>]
  22
  23 =for html
  24 </div>
  25
  26 =head1 DESCRIPTION
  27
  28 The B<vos delentry> command removes the Volume Location Database (VLDB)
  29 entry for each specified volume. A specified volume can be any of the
  30 three types (read/write, read-only, or backup), but the entire entry is
  31 removed no matter which type is provided. The command has no effect on the
  32 actual volumes on file server machines, if they exist.
  33
  34 This command is useful if a volume removal operation did not update the
  35 VLDB (perhaps because the B<vos zap> command was used), but the system
  36 administrator does not feel it is necessary to use the B<vos syncserv> and
  37 B<vos syncvldb> commands to synchronize an entire file server machine.
  38
  39 To remove the VLDB entry for a single volume, use the B<-id> argument. To
  40 remove groups of volumes, combine the B<-prefix>, B<-server>, and
  41 B<-partition> arguments. The following list describes how to remove the
  42 VLDB entry for the indicated group of volumes:
  43
  44 =over 4
  45
  46 =item *
  47
  48 For every volume whose name begins with a certain character string (for
  49 example, C<sys.> or C<user.>): use the B<-prefix> argument.
  50
  51 =item *
  52
  53 Every volume for which the VLDB lists a site on a certain file server
  54 machine: specify the file server name with the B<-server> argument.
  55
  56 =item *
  57
  58 Every volume for which the VLDB lists a site on a partition of the same
  59 name (for instance, on the F</vicepa> partition on any file server
  60 machine): specify the partition name with the B<-partition> argument.
  61
  62 =item *
  63
  64 Every volume for which the VLDB lists a site one a specific partition of a
  65 file server machine: specify both the B<-server> and B<-partition>
  66 arguments.
  67
  68 =item *
  69
  70 Every volume whose name begins with a certain prefix and for which the
  71 VLDB lists a site on a file server machine: combine the B<-prefix> and
  72 B<-server> arguments. Combine the B<-prefix> argument with the
  73 B<-partition> argument, or both the B<-server> and B<-partition>
  74 arguments, to remove a more specific group of volumes.
  75
  76 =back
  77
  78 =head1 CAUTIONS
  79
  80 Do not use this command to remove a volume in normal circumstances; it
  81 does not remove a volume from the file server machine, and so is likely to
  82 make the VLDB inconsistent with state of the volumes on server
  83 machines. Use the B<vos remove> command to remove both the volume and its
  84 VLDB entry.
  85
  86 =head1 OPTIONS
  87
  88 =over 4
  89
  90 =item B<-id> <I<volume name or ID>>+
  91
  92 Specifies the complete name or the volume ID number of each volume for
  93 which to remove the VLDB entry. The entire entry is removed, regardless of
  94 whether the read/write, read-only, or backup version is indicated.
  95 Provide this argument or some combination of the B<-prefix>, B<-server>,
  96 and B<-partition> arguments.
  97
  98 =item B<-prefix> <I<prefix of volume entry>
  99
 100 Specifies a character string of any length; the VLDB entry for a volume
 101 whose name begins with the string is removed. Include field separators
 102 (such as periods) if appropriate. Combine this argument with the
 103 B<-server> argument, B<-partition> argument, or both.
 104
 105 =item B<-server> <I<server name>>
 106
 107 Identifies a file server machine; if a volume's VLDB entry lists a site on
 108 the machine, the entry is removed. Provide the machine's IP address or its
 109 host name (either fully qualified or using an unambiguous
 110 abbreviation). For details, see L<vos(1)>.
 111
 112 Combine this argument with the B<-prefix> argument, the B<-partition>
 113 argument, or both.
 114
 115 =item B<-partition> <I<partition name>>
 116
 117 Identifies a partition; if a volume's VLDB entry lists a site on the
 118 partition, the entry is removed. Provide the partition's complete name
 119 with preceding slash (for example, F</vicepa>) or use one of the three
 120 acceptable abbreviated forms. For details, see L<vos(1)>.
 121
 122 Combine this argument with the B<-prefix> argument, the B<-server>
 123 argument, or both.
 124
 125 =item B<-cell> <I<cell name>>
 126
 127 Names the cell in which to run the command. Do not combine this argument
 128 with the B<-localauth> flag. For more details, see L<vos(1)>.
 129
 130 =item B<-noauth>
 131
 132 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
 133 combine this flag with the B<-localauth> flag. For more details, see
 134 L<vos(1)>.
 135
 136 =item B<-localauth>
 137
 138 Constructs a server ticket using a key from the local
 139 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
 140 to the Volume Server and Volume Location Server during mutual
 141 authentication. Do not combine this flag with the B<-cell> argument or
 142 B<-noauth> flag. For more details, see L<vos(1)>.
 143
 144 =item B<-dryrun>
 145
 146 Show the actions which would be taken, but do not make changes.
 147
 148 =item B<-verbose>
 149
 150 Produces on the standard output stream a detailed trace of the command's
 151 execution. If this argument is omitted, only warnings and error messages
 152 appear.
 153
 154 =item B<-encrypt>
 155
 156 Encrypts the command so that the operation's results are not transmitted
 157 across the network in clear text. This option is available in OpenAFS
 158 versions 1.4.11 or later and 1.5.60 or later.
 159
 160 =item B<-noresolve>
 161
 162 Shows all servers as IP addresses instead of the DNS name. This is very
 163 useful when the server address is registered as 127.0.0.1 or when dealing
 164 with multi-homed servers. This option is available in OpenAFS
 165 versions 1.4.8 or later and 1.5.35 or later.
 166
 167 =item B<-help>
 168
 169 Prints the online help for this command. All other valid options are
 170 ignored.
 171
 172 =back
 173
 174 =head1 OUTPUT
 175
 176 The following message confirms the success of the command by indicating
 177 how many VLDB entries were removed.
 178
 179    Deleted <number> VLDB entries
 180
 181 =head1 EXAMPLES
 182
 183 The following command removes the VLDB entry for the volume C<user.temp>.
 184
 185    % vos delentry user.temp
 186
 187 The following command removes the VLDB entry for every volume whose name
 188 begins with the string C<test> and for which the VLDB lists a site on the
 189 file server machine C<fs3.example.com>.
 190
 191    % vos delentry -prefix test -server fs3.example.com
 192
 193 =head1 PRIVILEGE REQUIRED
 194
 195 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
 196 machine specified with the B<-server> argument and on each database server
 197 machine. If the B<-localauth> flag is included, the issuer must instead be
 198 logged on to a server machine as the local superuser C<root>.
 199
 200 =head1 SEE ALSO
 201
 202 L<vos(1)>,
 203 L<vos_remove(1)>,
 204 L<vos_syncserv(1)>,
 205 L<vos_syncvldb(1)>,
 206 L<vos_zap(1)>
 207
 208 =head1 COPYRIGHT
 209
 210 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 211
 212 This documentation is covered by the IBM Public License Version 1.0.  It was
 213 converted from HTML to POD by software written by Chas Williams and Russ
 214 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.