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