doc/man-pages/pod1/vos_listvldb.pod

   1 =head1 NAME
   2
   3 vos listvldb - Displays a volume's VLDB entry
   4
   5 =head1 SYNOPSIS
   6
   7 B<vos listvldb> [B<-name> <I<volume name or ID>>]
   8     [B<-server> <I<machine name>>] [B<-partition> <I<partition name>>]
   9     [B<-locked>] [B<-quiet>] [B<-nosort>] [B<-cell> <I<cell name>>]
  10     [B<-noauth>] [B<-localauth>] [B<-verbose>] [B<-help>]
  11
  12 B<vos listvl> [B<-na> <I<volume name or ID>>] [B<-s> <I<machine name>>]
  13     [B<-p> <I<partition name>>] [B<-lock>] [B<-q>] [B<-nos>]
  14     [B<-c> <I<cell name>>] [B<-noa>] [B<-loca>] [B<-v>] [B<-h>]
  15
  16 =head1 DESCRIPTION
  17
  18 The B<vos listvldb> command formats and displays information from the
  19 Volume Location Database (VLDB) entry for each volume specified.  The
  20 output depends on the combination of options supplied on the command
  21 line. Combine options as indicated to display the desired type of VLDB
  22 entries:
  23
  24 =over 4
  25
  26 =item *
  27
  28 Every entry in the VLDB: provide no options.
  29
  30 =item *
  31
  32 Every VLDB entry that mentions a certain file server machine as the site
  33 for a volume: specify the machine's name as the B<-server> argument.
  34
  35 =item *
  36
  37 Every VLDB entry that mentions a certain partition on any file server
  38 machine as the site for a volume: specify the partition name as the
  39 B<-partition> argument.
  40
  41 =item *
  42
  43 Every VLDB entry that mentions a certain partition on a certain file
  44 server machine as the site for a volume: combine the B<-server> and
  45 B<-partition> arguments.
  46
  47 =item *
  48
  49 A single VLDB entry: specify a volume name or ID number with the B<-name>
  50 argument.
  51
  52 =item *
  53
  54 The VLDB entry only for the volumes with locked VLDB entries found at a
  55 certain site: combine the B<-locked> flag with any of arguments that
  56 define sites.
  57
  58 =back
  59
  60 =head1 OPTIONS
  61
  62 =over 4
  63
  64 =item B<-name> <I<volume name or ID>>
  65
  66 Specifies either the complete name or volume ID number of a volume of any
  67 of the three types.
  68
  69 =item B<-server> <I<server name>>
  70
  71 Identifies the file server machine listed as a site in each VLDB entry to
  72 display. Provide the machine's IP address or its host name (either fully
  73 qualified or using an unambiguous abbreviation). For details, see
  74 L<vos(1)>.
  75
  76 This argument can be combined with the B<-partition> argument, the
  77 B<-locked> flag, or both.
  78
  79 =item B<-partition> <I<partition name>>
  80
  81 Identifies the partition (on the file server machine specified by the
  82 B<-server> argument) listed as a site in each VLDB entry to
  83 display. Provide the partition's complete name with preceding slash (for
  84 example, C</vicepa>) or use one of the three acceptable abbreviated
  85 forms. For details, see L<vos(1)>.
  86
  87 This argument can be combined with the B<-server> argument, the B<-locked>
  88 flag, or both.
  89
  90 =item B<-locked>
  91
  92 Displays only locked VLDB entries. This flag can be combined with the
  93 B<-server> argument, the B<-partition> argument, or both.
  94
  95 =item B<-quiet>
  96
  97 Suppresses the lines that summarize the number of volumes listed and their
  98 status, which otherwise appear at the beginning and end of the output when
  99 the output includes more than one volume.
 100
 101 =item B<-nosort>
 102
 103 Suppresses the default sorting of volume entries alphabetically by volume
 104 name.
 105
 106 =item B<-cell> <I<cell name>>
 107
 108 Names the cell in which to run the command. Do not combine this argument
 109 with the B<-localauth> flag. For more details, see L<vos(1)>.
 110
 111 =item B<-noauth>
 112
 113 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
 114 combine this flag with the B<-localauth> flag. For more details, see
 115 L<vos(1)>.
 116
 117 =item B<-localauth>
 118
 119 Constructs a server ticket using a key from the local
 120 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
 121 to the Volume Server and Volume Location Server during mutual
 122 authentication. Do not combine this flag with the B<-cell> argument or
 123 B<-noauth> flag. For more details, see L<vos(1)>.
 124
 125 =item B<-verbose>
 126
 127 Produces on the standard output stream a detailed trace of the command's
 128 execution. If this argument is omitted, only warnings and error messages
 129 appear.
 130
 131 =item B<-help>
 132
 133 Prints the online help for this command. All other valid options are
 134 ignored.
 135
 136 =back
 137
 138 =head1 OUTPUT
 139
 140 If the output includes more than one VLDB entry, by default the first line
 141 reports which file server machine, partition, or both, houses the
 142 volumes. The final line of output reports the total number of entries
 143 displayed. Including the B<-quiet> flag suppresses these lines.
 144
 145 By default, volumes are sorted alphabetically by volume name.  Including
 146 the B<-nosort> flag skips the sorting step, which can speed up the
 147 production of output if there are a large number of entries.
 148
 149 The VLDB entry for each volume includes the following information:
 150
 151 =over 4
 152
 153 =item *
 154
 155 The base (read/write) volume name. The read-only and backup versions have
 156 the same name with a C<.readonly> and C<.backup> extension, respectively.
 157
 158 =item *
 159
 160 The volume ID numbers allocated to the versions of the volume that
 161 actually exist, in fields labeled C<RWrite> for the read/write, C<ROnly>
 162 for the read-only, C<Backup> for the backup, and C<RClone> for the
 163 ReleaseClone. (If a field does not appear, the corresponding version of
 164 the volume does not exist.) The appearance of the C<RClone> field normally
 165 indicates that a release operation did not complete successfully; the
 166 C<Old release> and C<New release> flags often also appear on one or more
 167 of the site definition lines described just following.
 168
 169 =item *
 170
 171 The number of sites that house a read/write or read-only copy of the
 172 volume, following the string C<< number of sites -> >>.
 173
 174 =item *
 175
 176 A line for each site that houses a read/write or read-only copy of the
 177 volume, specifying the file server machine, partition, and type of volume
 178 (C<RW> for read/write or C<RO> for read-only). If a backup version exists,
 179 it is understood to share the read/write site.  Several flags can appear
 180 with a site definition:
 181
 182 =over 4
 183
 184 =item Not released
 185
 186 Indicates that the vos release command has not been issued since the B<vos
 187 addsite> command was used to define the read-only site.
 188
 189 =item Old release
 190
 191 Indicates that a vos release command did not complete successfully,
 192 leaving the previous, obsolete version of the volume at this site.
 193
 194 =item New release
 195
 196 Indicates that a vos release command did not complete successfully, but
 197 that this site did receive the correct new version of the volume.
 198
 199 =back
 200
 201 =item *
 202
 203 If the VLDB entry is locked, the string C<Volume is currently LOCKED>.
 204
 205 =back
 206
 207 For further discussion of the C<New release> and C<Old release> flags, see
 208 L<vos_release(1)>.
 209
 210 =head1 EXAMPLES
 211
 212 The following command displays VLDB information for the ABC Corporation
 213 volume called C<usr>, which has two read-only replication sites:
 214
 215    % vos listvldb -name usr
 216    usr
 217     RWrite: 5360870981   ROnly: 536870982   Backup: 536870983
 218     number of sites -> 3
 219        server fs1.abc.com partition /vicepa RO Site
 220        server fs3.abc.com partition /vicepa RO Site
 221        server fs2.abc.com partition /vicepb RW Site
 222
 223 The following example shows entries for two of the volumes that reside on
 224 the file server machine C<fs4.abc.com>. The first VLDB entry is currently
 225 locked. There are 508 entries that mention the machine as a volume site.
 226
 227    % vos listvldb -server fs4.abc.com
 228    VLDB entries for server fs4.abc.com
 229        .       .           .        .
 230        .       .           .        .
 231    user.smith
 232     RWrite: 278541326   ROnly: 278541327   Backup: 278542328
 233     number of sites -> 1
 234       server fs4.abc.com partition /vicepg RW Site
 235     Volume is currently LOCKED
 236       user.terry
 237     RWrite 354287190   ROnly 354287191   Backup 354287192
 238     number of sites -> 1
 239       server fs4.abc.com partition /vicepc RW Site
 240       .       .           .        .
 241       .       .           .        .
 242    Total entries: 508
 243
 244 =head1 PRIVILEGE REQUIRED
 245
 246 None
 247
 248 =head1 SEE ALSO
 249
 250 L<vos(1)>,
 251 L<vos_examine(1)>,
 252 L<vos_listvol(1)>,
 253 L<vos_lock(1)>,
 254 L<vos_unlock(1)>,
 255 L<vos_unlockvldb(1)>
 256
 257 =head1 COPYRIGHT
 258
 259 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 260
 261 This documentation is covered by the IBM Public License Version 1.0.  It was
 262 converted from HTML to POD by software written by Chas Williams and Russ
 263 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.