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